Data Model version 2.1.2
Acknowledgements
Diagram | Class Map | Attribute Map | Method Map | Help | License
Home | Package | Class: { prev | next } | Attribute | Method

Class: Peak

The Peak constructor includes non-standard actions.
    Crosspeak at a specific position in a specific spectrum.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link peakList to class PeakList
Main key: serial
Mandatory Attributes: None
Partitions Children: True
Known Subclasses: None
Children:
link peakContribs to class PeakContrib
link peakDims to class PeakDim
link peakIntensities to class PeakIntensity
Constructor: newObj = Peak( peakList, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
annotation Line 0..1 Descriptive text string, intended for annotation of Peaks on graphics displays. Long comments belong in the (non-displayed) details attribute.  
componentNumbers NonNegativeInt 0..* Numbers for the Components where the peak appears. Only relevant for DataSources that are composed of components ShapeMatrix data). If empty corresponds to 'unknown'.  
constraintWeight NonNegativeFloat 1..1 Weighting factor for constraint arising from peak. Serves to increase or decrease importance attached to peak, without having to repeat the assignment for every new constraint list generated. In the simple case this number will be used for Constraint.weight  
details Text 0..1 Free text, for notes, explanatory comments, etc.  
figOfMerit FloatRatio 1..1 Figure of merit for peak, describing its quality (i.e. the likelihood that it is a peak rather than noise). Must be a number between zero and one (inclusive).  
height Float 0..1 Peak height - as determined by whichever program set it last. Peak heights with associated measurement methods and uncertainties are set using the PeakIntensity class.  
serial Int 1..1 Serial number of object. Serves as object main key. Serial numbers of deleted objects are not re-used. Serial numbers can only be set by the implementation. Values are in practice always positive, since negative values are interpreted as a signal to set the next free serial  
volume Float 0..1 Peak volume - as determined by whichever program set it last. Peak volumes with associated measurement methods and uncertainties are set using the PeakIntensity class.  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
analysisLayouts ccpnmr.api.AnalysisV3.AnalysisLayout 0..* AnalysisLayouts referring to Peaks  
analysisPanels ccpnmr.api.AnalysisV3.AnalysisPanel 0..* AnalysisPanels referring to Peaks  
dataDerivations AbstractDataDerivation 0..* DataDerivation calculated using Peak  
fitMethod ccp.api.general.Method.Method 0..1 Peak fitting method for this particular peak.  
measurements AbstractMeasurement 0..* Measurements derived from Peak.  
parent PeakList 1..1 link to parent object - synonym for peakList  
peakClusters PeakCluster 0..* PeakClusters to which peak belongs. A Peak can belong only to one cluster of a given type. NBNB TBD A constraint must be added to enforce this constraint.  
peakContribs PeakContrib 0..* (Child link). child link to class PeakContrib  
peakDims PeakDim 0..* (Child link). child link to class PeakDim  
peakIntensities PeakIntensity 0..* (Child link). child link to class PeakIntensity  
peakList PeakList 1..1 (Parent link). parent link  
peakValidations ccp.api.molecule.Validation.PeakValidation 0..* Validation results that include Peak  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
annotation
getAnnotation Line -
setAnnotation - Line
componentNumbers
getComponentNumbers NonNegativeInt Set -
setComponentNumbers - NonNegativeInt Set
addComponentNumber - NonNegativeInt
removeComponentNumber - NonNegativeInt
constraintWeight
getConstraintWeight NonNegativeFloat -
setConstraintWeight - NonNegativeFloat
details
getDetails Text -
setDetails - Text
figOfMerit
getFigOfMerit FloatRatio -
setFigOfMerit - FloatRatio
height
getHeight Float -
setHeight - Float
serial
getSerial Int -
setSerial - Int
volume
getVolume Float -
setVolume - Float

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
analysisLayouts
getAnalysisLayouts ccpnmr.api.AnalysisV3.AnalysisLayout Set -
setAnalysisLayouts - ccpnmr.api.AnalysisV3.AnalysisLayout Set
sortedAnalysisLayouts ccpnmr.api.AnalysisV3.AnalysisLayout List -
addAnalysisLayout - ccpnmr.api.AnalysisV3.AnalysisLayout
removeAnalysisLayout - ccpnmr.api.AnalysisV3.AnalysisLayout
findFirstAnalysisLayout ccpnmr.api.AnalysisV3.AnalysisLayout keyword=value pairs
findAllAnalysisLayouts ccpnmr.api.AnalysisV3.AnalysisLayout Set keyword=value pairs
analysisPanels
getAnalysisPanels ccpnmr.api.AnalysisV3.AnalysisPanel Set -
setAnalysisPanels - ccpnmr.api.AnalysisV3.AnalysisPanel Set
sortedAnalysisPanels ccpnmr.api.AnalysisV3.AnalysisPanel List -
addAnalysisPanel - ccpnmr.api.AnalysisV3.AnalysisPanel
removeAnalysisPanel - ccpnmr.api.AnalysisV3.AnalysisPanel
findFirstAnalysisPanel ccpnmr.api.AnalysisV3.AnalysisPanel keyword=value pairs
findAllAnalysisPanels ccpnmr.api.AnalysisV3.AnalysisPanel Set keyword=value pairs
dataDerivations
getDataDerivations AbstractDataDerivation Set -
setDataDerivations - AbstractDataDerivation Set
sortedDataDerivations AbstractDataDerivation List -
addDataDerivation - AbstractDataDerivation
removeDataDerivation - AbstractDataDerivation
findFirstDataDerivation AbstractDataDerivation keyword=value pairs
findAllDataDerivations AbstractDataDerivation Set keyword=value pairs
fitMethod
getFitMethod ccp.api.general.Method.Method -
setFitMethod - ccp.api.general.Method.Method
measurements
getMeasurements AbstractMeasurement Set -
setMeasurements - AbstractMeasurement Set
sortedMeasurements AbstractMeasurement List -
addMeasurement - AbstractMeasurement
removeMeasurement - AbstractMeasurement
findFirstMeasurement AbstractMeasurement keyword=value pairs
findAllMeasurements AbstractMeasurement Set keyword=value pairs
parent
getParent PeakList -
peakClusters
getPeakClusters PeakCluster Set -
setPeakClusters - PeakCluster Set
sortedPeakClusters PeakCluster List -
addPeakCluster - PeakCluster
removePeakCluster - PeakCluster
findFirstPeakCluster PeakCluster keyword=value pairs
findAllPeakClusters PeakCluster Set keyword=value pairs
peakContribs
getPeakContribs PeakContrib Set -
sortedPeakContribs PeakContrib List -
findFirstPeakContrib PeakContrib keyword=value pairs
findAllPeakContribs PeakContrib Set keyword=value pairs
peakDims
getPeakDims PeakDim Set -
sortedPeakDims PeakDim List -
findFirstPeakDim PeakDim keyword=value pairs
findAllPeakDims PeakDim Set keyword=value pairs
peakIntensities
getPeakIntensities PeakIntensity Set -
sortedPeakIntensities PeakIntensity List -
findFirstPeakIntensity PeakIntensity keyword=value pairs
findAllPeakIntensities PeakIntensity Set keyword=value pairs
peakList
getPeakList PeakList -
peakValidations
getPeakValidations ccp.api.molecule.Validation.PeakValidation Set -
setPeakValidations - ccp.api.molecule.Validation.PeakValidation Set
sortedPeakValidations ccp.api.molecule.Validation.PeakValidation List -
addPeakValidation - ccp.api.molecule.Validation.PeakValidation
removePeakValidation - ccp.api.molecule.Validation.PeakValidation
findFirstPeakValidation ccp.api.molecule.Validation.PeakValidation keyword=value pairs
findAllPeakValidations ccp.api.molecule.Validation.PeakValidation Set keyword=value pairs

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey Peak memops.api.Implementation.MemopsObject, Any List static
getFullKey Any List Boolean
getLocalKey Any -
get Any String
set - String, Any

Factory Methods (in package)

Go to Top
Method Return Parameters
newPeakContrib PeakContrib ...
newPeakDim PeakDim dim, ...
newPeakIntensity PeakIntensity method, ...

Other Methods (in package)

Go to Top
Method Return Parameters Comment
None

Appendix

Go to Top

guid:

www.ccpn.ac.uk_Fogh_2006-08-16-14:22:46_00011

isImplicit:

False

Tag

Value
repositoryId $Id: $

Tag

Value
repositoryTag $Name: $

Special constructor code:

for xx in self.getByNavigation('peakList', 'dataSource', 'dataDims'):
  PeakDim(self, dim=xx.dim)

Special destructor code:

None

Special postDestructor code:

None

Constraint name:

number_of_peakDims_eq_datasource_numDim
Constraint code: len(self.peakDims) == self.getByNavigation('peakList', 'dataSource', 'numDim')
Known inward one-way links: ccp.api.nmr.NmrConstraint.AbstractConstraint.peaksccp.api.nmr.NmrConstraint.ConstraintPeakContrib.peak
  Data Model Version 2.1.2
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Mon Mar 2 17:24:57 2015    from data model package  ccp.api.nmr.Nmr.Peak   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk