Attribute
|
Type
|
Multiplicity
|
Description
|
annotation
|
Line
|
0..1
|
Descriptive text string, designed for annotation of Xpks on graphics displays. Long annotations should be avoided.
|
boxWidth
|
Float
|
0..1
|
The full width of the peak footprint in points, i.e. the width of the area that should be considered for integration, fitting, etc. It is not a very precise definition, but this is an input parameter rather than an output parameter.
|
decayRate
|
Float
|
0..1
|
Fitted decay rate in the time domain (raw-data domain). If the raw data domain unit is seconds, the unit of decayRate is Hz. If an exponential decay is fitted to the function exp(-piRt), the decayrate is R. For a true Lorenzian decayRate is equal to the full-width-half-height.
|
decayRateError
|
Float
|
0..1
|
Uncertainty (standard deviation) of peak decayRate.
|
dim
|
PositiveInt
|
1..1
|
Dimension number, from 1 to nuber of dimensions - used as key to get the corresponding DataDim
|
lineWidth
|
Float
|
0..1
|
Full-width-half-height of peak/multiplet in this dimension. Unit is DataDimRef.unit (typically Hz). Do NOT use this attribute if your data are better described by one of the alternatives :
positionError - standard deviation of measured position
boxWidth - footprint width of peak for integration limits etc.
decayRate - fitted decay rate (in Hz)
|
numAliasing
|
Int
|
1..1
|
number of aliasings. The real peak position is defined as positionPoints + numAliasing*dataDimRef.dataDim.numPointsOri
|
phase
|
Float
|
0..1
|
Phase (in degrees) of peak
|
phaseError
|
Float
|
0..1
|
Uncertainty (standard deviation) of peak phase.
|
position
|
Float
|
0..1
|
Peak position in *point numbers*. Positions must be between 1.0 and npoints+1. The peak position in the appropriate unit (typically ppm), is given in the derived attribute 'value'.
|
positionError
|
Float
|
0..1
|
Uncertainty (standard deviation) of peak position (in point numbers).
|
realValue
|
Float
|
0..1
|
Derived. Peak position in units of ExpDimRef.unit, corresponding to the main DataDimRef. Derived but settable, with special behaviour. If set to an explicit value this will be the value returned later (case 1). If not set / set to None (case 2) self.value will be returned when there are no PeakDimComponents. Ifset to None and there are PeakDimComponents, None is returned. Peak.realValue always gives the best value for the quantity described in the main DataDimRef. The organisation of this parameter lets you store values for the central chemical shift of multiplets (e.g. DQF-COSY), while you still get the peak value in the simple case.
|
realValueImpl
|
Float
|
0..1
|
Underlying attribute used to store realValue. For technical reasons realValue must be derived, so the value, when set, is stored here instead. It is recommended to read and set realValue and ignore this attribute.
|
value
|
Float
|
0..1
|
Derived. Real peak position in units of ExpDimRef.unit, after correcting for numAliasing, calculated using the directly linked (main component) DataDimRef. If the DataDimRef is ambiguous or absent, the value is None. If there are PeakDimComponents present the value you get will not reflect the measurement that corresponds to the dataDimRef. If you want either correct values or 'None', use realValue instead.
value can be set, provided there is one unique DataDimRef. The effect will be to update position and numAliasing to reflect the value.
|
valueError
|
Float
|
0..1
|
Derived. Uncertainty (standard deviation) on value, in units of ExpDimRef.unit. Derived from positionError. Depends on the presence of one unambiguous DataDimRef, and returns None if no such is found. valueError can also be set if there is an unambiguous DataDimRef - the effect will be to update positionError.
|