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

Class: DataDimRef


    Referencing information for a dimension of a DataSource ('spectrum'). A given dimension can have several alternative referencings.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link dataDim to class FreqDataDim
Main key: expDimRef
Mandatory Attributes: expDimRef
Known Subclasses: None
Children: None
Constructor: newObj = DataDimRef( dataDim,expDimRef=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
localValuePerPoint Float 0..1 DataDimRef-specific equivalent of DataDim.valuePerPoint. Overrides the DataDimRef value if set. Corresponds to the SW in Hz for a normal spectrum, and is used where different DataDimRef have different SW in Hz.  
refPoint Float 1..1 Point number (in floating point rather than integer) to which referencing value applies  
refValue Float 1..1 Referencing value at refPoint, in expDimRef unit  
spectralWidth Float 0..1 Derived. Current spectral width in ExpDimRef unit (e.g. ppm). Includes correction for scaling etc.  
spectralWidthOrig Float 0..1 Derived. Original spectral width, before any removal of points, in ExpDimRef units (e.g. ppm). Includes correction for scaling etc.  
valuePerPoint Float 1..1 Derived. Conversion factor from point numbers to referenced value. This includes a scaling constant defined by the experiment, so that e.g. a J-coupling splitting in Hz may not corrspond to the actual difference in Hz between the points. By definition valuePerPoint = FreqDataDim.valuePerPoint/ExpDimRef.sf  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
dataDim FreqDataDim 1..1 (Parent link). parent link  
expDimRef ExpDimRef 1..1 ExpDimRef corresponding to DataDimRef  
parent FreqDataDim 1..1 link to parent object - synonym for dataDim  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
localValuePerPoint
getLocalValuePerPoint Float -
setLocalValuePerPoint - Float
refPoint
getRefPoint Float -
setRefPoint - Float
refValue
getRefValue Float -
setRefValue - Float
spectralWidth
getSpectralWidth Float - non-std.
spectralWidthOrig
getSpectralWidthOrig Float - non-std.
valuePerPoint
getValuePerPoint Float - non-std.

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
dataDim
getDataDim FreqDataDim -
expDimRef
getExpDimRef ExpDimRef -
setExpDimRef - ExpDimRef
parent
getParent FreqDataDim -

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey DataDimRef 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
pointToValue Float Float non-std. Converts input point value to output value in units of ExpDimRef.unit, correcting for referencing.
valueToPoint Float Float non-std. Convert input value in units of ExpDimRef.unit to output point value, correcting for referencing.

Appendix

Go to Top

guid:

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

isImplicit:

False

Tag

Value
repositoryId $Id: DataDimRef.xml,v 1.56 2011-01-13 14:40:34 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: ccp.api.nmr.Nmr.PeakDim.dataDimRefccp.api.nmr.Nmr.PeakDimComponent.dataDimRef
  Data Model Version 2.0.6
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Wed Aug 7 15:06:42 2013    from data model package  ccp.api.nmr.Nmr.DataDimRef   revision 1.56  
  Work done by the CCPN team.
www.ccpn.ac.uk