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

Class: SpectralDensity


    Spectral density for a pair of resonances at a given frequency.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link derivation to class SpectralDensityDerivation
Main key: serial
Mandatory Attributes: resonances
Known Subclasses: None
Children: None
Constructor: newObj = SpectralDensity( derivation,resonances=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
error Float 0..1 Uncertainty (standard deviation) of value  
figOfMerit FloatRatio 1..1 Figure of merit, describing the reliability of the value. Between 0.0 (useless) and 1.0 (fully reliable, also the default).  
frequency Float 0..1 The frequency that the spectral density refers to (in MHz).  
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  
value Float 0..1 Value of derived measurement.  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
derivation SpectralDensityDerivation 1..1 (Parent link). parent link  
parent SpectralDensityDerivation 1..1 link to parent object - synonym for derivation  
resonances Resonance 2..2 Resonances to which spectral density is ascribed.  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
error
getError Float -
setError - Float
figOfMerit
getFigOfMerit FloatRatio -
setFigOfMerit - FloatRatio
frequency
getFrequency Float -
setFrequency - Float
serial
getSerial Int -
setSerial - Int
value
getValue Float -
setValue - Float

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
derivation
getDerivation SpectralDensityDerivation -
parent
getParent SpectralDensityDerivation -
resonances
getResonances Resonance Set -
setResonances - Resonance Set
sortedResonances Resonance List -
findFirstResonance Resonance keyword=value pairs
findAllResonances Resonance Set keyword=value pairs

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey SpectralDensity 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:48_00011

isImplicit:

False

Tag

Value
repositoryId $Id: SpectralDensity.xml,v 1.48 2011-01-13 14:40:35 rhfogh Exp $

Tag

Value
repositoryTag $Name: not supported by cvs2svn $

Special constructor code:

None

Special destructor code:

None

Constraints:

None
Known inward one-way links: None
  Data Model Version 2.0.6
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Wed Aug 7 15:06:49 2013    from data model package  ccp.api.nmr.Nmr.SpectralDensity   revision 1.48  
  Work done by the CCPN team.
www.ccpn.ac.uk