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

Class: PeakContrib


    Crosspeak contribution.  PeakContribs serve two slightly different purposes. They describe a Peak as a sum of different contributions (e.g. ovelapped peaks), whose relative values is determined by their relative weights. They also serve simply as a way of describing mutually exclusive sets of assignment possibilities, without any implication about the peak arising from multiple contributions. The two aspects are almost identical in practice. If all PeakContrib weights are 0.0, as is the default, it can be assumed that the Contribs are only describing assignment possibilities.

    Each PeakContrib may have any number (including zero) peakDimContrib for every dim. The set of possible complete assignments for a PeakContrib is found as follows:
    For each dimension all PeakDimContribs belonging to the dimension are potential assignments. If there are say 3, 2, and 5 possibilities in the three dimensions (of a 3D peak) there will be a total of 3*2*5=30 possible assignment states belonging to the PeakContrib. If there are no possibilities for one dimension (say 3, 0, and 5 for the three dimensions), there will be 3*5=15 alternative (partial) assignment states.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link peak to class Peak
Main key: serial
Mandatory Attributes: None
Known Subclasses: None
Children: None
Constructor: newObj = PeakContrib( peak, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
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  
weight Float 1..1 Weight (relative probability or relative contribution) of PeakContrib for a given Peak. If the division in PeakContribs is not significant, but simply a way of describing alternative assignments, all weights may be set to zero.  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
parent Peak 1..1 link to parent object - synonym for peak  
peak Peak 1..1 (Parent link). parent link  
peakDimContribs AbstractPeakDimContrib 0..* peakDimContribs that are possible assignments for the peak within a given PeakContrib. May belong to different dimensions `  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
serial
getSerial Int -
setSerial - Int
weight
getWeight Float -
setWeight - Float

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
parent
getParent Peak -
peak
getPeak Peak -
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 PeakContrib 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-08-16-14:22:47_00017

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.PeakContrib   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk