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

Class: DimensionScaling


    Scaling factors used for various ExpDimRefs in this particular DataSource.
    Note: If there is no DimensionScaling connecting a DataDim with an ExpDimRef (both belonging to the same ExpDim) this means that the ExpDimRef is not used. Note that a DimensionScaling with scalingFactors == (1.0,) is created automatically when a FreqDataDim or FidDataDim is created and 1) for each relevant ExpDimRef that has a refExpDimRef, 2) if nothing is created under 1) but there is only one relevant ExpDimRef, 3) if nothing is created above but there is ony one relevant ExpDimRef  with measurementType == 'Shift'
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

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

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
scalingFactors Float 0..* Scaling factors that may appear on relevant PeakDimComponents of peaks in the DataSource. The order of scaling factors is not significant, but the attribute is kept ordered to make it simpler to get hold of the data in the most common case where there is only one scalingFactor.  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
dataDim AbstractDataDim 1..1 (Parent link). parent link  
expDimRef ExpDimRef 1..1 ExpDimRef to which the scaling factor applies  
parent AbstractDataDim 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
scalingFactors
getScalingFactors Float Tuple -
setScalingFactors - Float List
addScalingFactor - Float
removeScalingFactor - Float

Link Attribute Methods (in package)

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

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey DimensionScaling 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_2008-04-10-18:39:10_00002

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  Fri Mar 28 11:18:25 2014    from data model package  ccp.api.nmr.Nmr.DimensionScaling   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk