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

Class: FreqDataDim

The FreqDataDim constructor includes non-standard actions.
    A frequency domain dimension in the data source file, i.e. a regularly sampled dimension that is in the Fourier transform domain relative to the original data.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link dataSource to class DataSource
Main key: dim
Mandatory Attributes: dim, isComplex, numPoints, numPointsOrig, valuePerPoint, expDim
Known Subclasses: None
Children:
link dataDimRefs to class DataDimRef
link dimensionScalings to class DimensionScaling
Constructor: newObj = FreqDataDim( dataSource,dim=value, isComplex=value, numPoints=value, numPointsOrig=value, valuePerPoint=value, expDim=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
dim PositiveInt 1..1 Dimension number. Dimensions go from 1 to numDim. For projections that means the numDim of the dataSource, not of the experiment. dim for an AbstractDataDim can be set independently of the dim for the corresponding ExpDim, although it is recommended that the acquisition dimension (if present) be given dim 1. The dim values correspond to the storage order in the corresponding file, 1 being the fastest varying dim.  
fileDim NonNegativeInt 0..1 Corresponding dimension in the dataSource (an integer, starting at zero).  
isComplex Boolean 1..1 Defines whether the underlying data are complex, i.e. whether both real and imaginary values are stored.  
numPoints NonNegativeInt 1..1 Number of points. When isComplex is True, numPoints is the number of complex points (i.e. the number of time values for an FID), not the number of real numbers stored, so that 1024 complex points take up the same pace as 2048 real points. numPoints measures the size of the stored file, whether or not all storage slots contain meaningful data. For a SampledDataDim numPoints must be equal to the length of the pointValues array. For sparse sampling this described the grid sampled on, not the number of actual points.  
numPointsOrig Int 1..1 Original number of points, i.e. number of points before points were removed. The spectalWidthOrig is by definition numPointsOrig * valuePerPoint. Serves to account for cases where points were removed after Fourier transformation.  
phase0 Float 0..1 Zero order phase correction (in degrees) applied after Fourier transformation.  
phase1 Float 0..1 First order phase correction (in degrees) applied after Fourier transformation. By definition the point fo no effect of the first order phase correction is point number one (before removal of points, if any).  
pointOffset Int 1..1 Offset of first point, in point numbers relative to original number of points. To account for cases where points have been removed after Fourier transformation. The current point number 1 corresponds to the original point number 1+pointOffset.  
shapeSerial PositiveInt 0..1 Serial number of corresponding DataSourceShape, if any. Note that several AbstractDataDims may correspond to the same DataSourceShape.  
spectralWidth Float 0..1 Derived. Current spectral width (not including deleted points), in unit of the FreqDataDim, typically in Hz. Defined as numPoints * valuePerPoint  
spectralWidthOrig Float 0..1 Derived. Spectral width in unit of FreqDataDim(typically in Hz) of original spectrum (before removal of points) This is the value that serves for calculation of folding etc. Defined as numPointsOrig*valuePerPoint.  
unit Word 0..1 unit for values on dimension axis. Typically seconds for a normal FID. For a frequency dimension unit is Herz, *not* ppm. Note that values in ppm (and equivalent) require referencing, and that referencing belongs to the DataDimRef, not to the DataDim.  
valuePerPoint Float 1..1 Conversion between point number and frequency - in the normal case conversion between point number and Herz. Does *not* include any corrections for scaling etc.  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
analysisDataDim ccpnmr.api.Analysis.AnalysisDataDim 0..1 AnalysisDataDim associated with DataDim  
analysisDataDims ccpnmr.api.AnalysisV3.AnalysisDataDim 0..* Analysis.AnalysisDataDims referring to AbstractDataDim  
dataDimRefs DataDimRef 0..* (Child link). child link to class DataDimRef  
dataSource DataSource 1..1 (Parent link). parent link  
dimensionScalings DimensionScaling 0..* (Child link). child link to class DimensionScaling  
expDim ExpDim 1..1 ExpDim corresponding to DataDim  
parent DataSource 1..1 link to parent object - synonym for dataSource  
predictMethod ccp.api.general.Method.Method 0..1 Linear prediction method.  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
dim
getDim PositiveInt -
setDim - PositiveInt
fileDim
getFileDim NonNegativeInt -
setFileDim - NonNegativeInt
isComplex
getIsComplex Boolean -
setIsComplex - Boolean
numPoints
getNumPoints NonNegativeInt -
setNumPoints - NonNegativeInt
numPointsOrig
getNumPointsOrig Int -
setNumPointsOrig - Int
phase0
getPhase0 Float -
setPhase0 - Float
phase1
getPhase1 Float -
setPhase1 - Float
pointOffset
getPointOffset Int -
setPointOffset - Int
shapeSerial
getShapeSerial PositiveInt -
setShapeSerial - PositiveInt
spectralWidth
getSpectralWidth Float - non-std.
spectralWidthOrig
getSpectralWidthOrig Float - non-std.
unit
getUnit Word -
setUnit - Word
valuePerPoint
getValuePerPoint Float -
setValuePerPoint - Float

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
analysisDataDim
getAnalysisDataDim ccpnmr.api.Analysis.AnalysisDataDim -
setAnalysisDataDim - ccpnmr.api.Analysis.AnalysisDataDim
analysisDataDims
getAnalysisDataDims ccpnmr.api.AnalysisV3.AnalysisDataDim Set -
setAnalysisDataDims - ccpnmr.api.AnalysisV3.AnalysisDataDim Set
sortedAnalysisDataDims ccpnmr.api.AnalysisV3.AnalysisDataDim List -
findFirstAnalysisDataDim ccpnmr.api.AnalysisV3.AnalysisDataDim keyword=value pairs
findAllAnalysisDataDims ccpnmr.api.AnalysisV3.AnalysisDataDim Set keyword=value pairs
dataDimRefs
getDataDimRefs DataDimRef Set -
sortedDataDimRefs DataDimRef List -
findFirstDataDimRef DataDimRef keyword=value pairs
findAllDataDimRefs DataDimRef Set keyword=value pairs
dataSource
getDataSource DataSource -
dimensionScalings
getDimensionScalings DimensionScaling Set -
sortedDimensionScalings DimensionScaling List -
findFirstDimensionScaling DimensionScaling keyword=value pairs
findAllDimensionScalings DimensionScaling Set keyword=value pairs
expDim
getExpDim ExpDim -
setExpDim - ExpDim
parent
getParent DataSource -
predictMethod
getPredictMethod ccp.api.general.Method.Method -
setPredictMethod - ccp.api.general.Method.Method

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey FreqDataDim 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
newDataDimRef DataDimRef expDimRef, ...
newDimensionScaling DimensionScaling expDimRef, ...

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:46_00033

isImplicit:

False

Tag

Value
repositoryId $Id: $

Tag

Value
repositoryTag $Name: $

Special constructor code:

foundRefData = False
expDimRefs = self.expDim.sortedExpDimRefs()
for expDimRef in expDimRefs:
  refExpDimRef = expDimRef.refExpDimRef
  if refExpDimRef is not None:
    foundRefData = True
    scalingFactors = refExpDimRef.validScalingFactors
    self.newDimensionScaling(expDimRef=expDimRef, scalingFactors=scalingFactors)
if not foundRefData:
  if len(expDimRefs) != 1:
    expDimRefs = list(self.expDim.findAllExpDimRefs(measurementType='Shift'))
  if len(expDimRefs) == 1:
    self.newDimensionScaling(expDimRef=expDimRefs[0], scalingFactors=(1.0,))

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:56 2015    from data model package  ccp.api.nmr.Nmr.FreqDataDim   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk