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

Class: PeakDimComponent


    Additional assignment component of peak. In many cases (TROSY, reduced-dimensionality experiments, multiplet components), the position of a peak reflects the sum of more than one NMR parameter. In those cases the additional NMR parameters are assigned through PeakDimComponents. E.g. a DQF-COSY multiplet component would have a main contribution from the shift, and one or more PeakDimComponents for the various couplings that contribute to the peak position.

    NOTE: To calculate the value corresponding to the PeakDimComponent, you yourself must calculate xPoints, the (signed) number of points that are due to the PeakDimComponent. The desired value is then self.scalingFactor*self.dataDimRef.pointToValue(xPoints)
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link peakDim to class PeakDim
Main key: serial
Mandatory Attributes: None
Known Subclasses: None
Children: None
Constructor: newObj = PeakDimComponent( peakDim, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
annotation Line 0..1 Descriptive text string, designed for annotation of Xpks on graphics displays. Long annotations should be avoided.  
scalingFactor Float 1..1 Scaling factor for PeakDimComponent. Is multiplied by the value that comes out of the dataDimRef to get the actual contribution from this PeakDimComponent to the position of the peak. E.g. a 1D NMR quartet might have scalingFactors -3., -1., 1., 3. on its four subpeaks. NOTE: To calculate the value corresponding to the PeakDimComponent, you yourself must calculate xPoints, the (signed) number of points that are due to the PeakDimComponent. The desired value is then self.scalingFactor*self.dataDimRef.pointToValue(xPoints)  
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  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
dataDimRef DataDimRef 0..1 DataDimRef that describes reference and measurement for PeakDimComponent.  
parent PeakDim 1..1 link to parent object - synonym for peakDim  
peakDim PeakDim 1..1 (Parent link). parent link  
peakDimContribs AbstractPeakDimContrib 0..* PeakDimContribs attached to this PeakDimComponent.  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
annotation
getAnnotation Line -
setAnnotation - Line
scalingFactor
getScalingFactor Float -
setScalingFactor - Float
serial
getSerial Int -
setSerial - Int

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
dataDimRef
getDataDimRef DataDimRef -
setDataDimRef - DataDimRef
parent
getParent PeakDim -
peakDim
getPeakDim PeakDim -
peakDimContribs
getPeakDimContribs AbstractPeakDimContrib Set -
setPeakDimContribs - AbstractPeakDimContrib Set
sortedPeakDimContribs AbstractPeakDimContrib List -
addPeakDimContrib - AbstractPeakDimContrib
removePeakDimContrib - AbstractPeakDimContrib
findFirstPeakDimContrib AbstractPeakDimContrib keyword=value pairs
findAllPeakDimContribs AbstractPeakDimContrib Set keyword=value pairs

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey PeakDimComponent 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
None

Other Methods (in package)

Go to Top
Method Return Parameters Comment
None

Appendix

Go to Top

guid:

www.ccpn.ac.uk_Fogh_2006-10-25-11:29:42_00001

isImplicit:

False

Tag

Value
repositoryId $Id: $

Tag

Value
repositoryTag $Name: $

Special constructor code:

None

Special destructor code:

None

Special postDestructor code:

None

Constraints:

None
Known inward one-way links: None
  Data Model Version 2.1.2
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Mon Mar 2 17:24:58 2015    from data model package  ccp.api.nmr.Nmr.PeakDimComponent   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk