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

Class: FidDataDim

The FidDataDim constructor includes non-standard actions.
    An FID dimension or any other dimension with a regular grid of values. A FidDataDim can contain any kind of regularly sampled data subjected to any kind of processing, except that data in the Fourier transformed domain relative to the originally acquired data must be put in a FreqDataDim.
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, numPointsValid, valuePerPoint, expDim
Known Subclasses: None
Children:
link dimensionScalings to class DimensionScaling
Constructor: newObj = FidDataDim( dataSource,dim=value, isComplex=value, numPoints=value, numPointsValid=value, valuePerPoint=value, expDim=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
alternateSign Boolean 1..1 Default is 'False'. If true means that every second (real or complex) point should have its sign changed before further processing, as for classical TPPI or States-TPPI.  
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).  
firstValue Float 1..1 Value of first point.  
isComplex Boolean 1..1 Defines whether the underlying data are complex, i.e. whether both real and imaginary values are stored.  
maxValue Float 0..1 Derived. Maximum value for points containing meaningful data, corresponding to the acquisition time in a normal FID. NB calculated from numPointsValid, the number of usable points, *not* from numPoints, the total number of points. By definition maxValue - firstValue = (numPointsValid - 1) * valuePerPoint  
negateImaginary Boolean 1..1 Default is 'False'. If true the imaginary part of complex numbers should be negated before further processing.  
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.  
numPointsValid NonNegativeInt 1..1 Number of points containing valid data. Assumed to start at point one. Must be smaller or equal than numPoints. To account for experiments stopped early or that otherwise have not filled all storage slots with valid data. The valid data points will be those from pointOffset+1 to pointOffset+numPointsValid (inclusive).  
oversamplingInfo Text 0..1 Text field describing oversampling of data, if any.  
phase0 Float 0..1 (Approximate) zero order phase correction in degrees to be applied after Fourier transformation  
phase1 Float 0..1 (Approximate) first order phase correction in degrees to be applied after Fourier transformation. By definition the point of no effect of the first order correction is point number one (before removal of points).  
pointOffset Int 1..1 Number of points at beginning of FID to ignore. Default zero. The first point with valid data will always be point 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. Spectral width after Fourier transformation. Unit is the reciprocal of the unit used for the value (e.g. Hz for values in seconds). For complex points defined as 1.0/valuePerPoint. For real points defined as 0.5/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 Value per point. Corresponds to the difference between successive time (e.g.) values whether or not the points are complex.  

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  
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
alternateSign
getAlternateSign Boolean -
setAlternateSign - Boolean
dim
getDim PositiveInt -
setDim - PositiveInt
fileDim
getFileDim NonNegativeInt -
setFileDim - NonNegativeInt
firstValue
getFirstValue Float -
setFirstValue - Float
isComplex
getIsComplex Boolean -
setIsComplex - Boolean
maxValue
getMaxValue Float - non-std.
negateImaginary
getNegateImaginary Boolean -
setNegateImaginary - Boolean
numPoints
getNumPoints NonNegativeInt -
setNumPoints - NonNegativeInt
numPointsValid
getNumPointsValid NonNegativeInt -
setNumPointsValid - NonNegativeInt
oversamplingInfo
getOversamplingInfo Text -
setOversamplingInfo - Text
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.
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
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 FidDataDim 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
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_00032

isImplicit:

False

Tag

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

Tag

Value
repositoryTag $Name: not supported by cvs2svn $

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

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:44 2013    from data model package  ccp.api.nmr.Nmr.FidDataDim   revision 1.58  
  Work done by the CCPN team.
www.ccpn.ac.uk