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

Class: AxisType


    This determines how spectrum dimensions can be mapped onto a SpectrumWindow.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link analysisProject to class AnalysisProject
Main key: name
Mandatory Attributes: name
Known Subclasses: None
Children: None
Constructor: newObj = AxisType( analysisProject,name=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
diagonalExclusion NonNegativeFloat 1..1 The amount (in ppm) by which two dimensions with same axisType must differ by in order to be considered as a peak, in peak finding.  
isSampled Boolean 1..1 if true then this type is not linear but sampled  
isotopeCodes Word 0..* The isotope codes (e.g. '13C') which are mapped onto this axis type.  
measurementType ccp.api.nmr.NmrExpPrototype.ExpMeasurementType 1..1 Measurement type.  
name Word 1..1 e.g. '1H', '13C', '15N', 'T', 'Ca', 'CO', 'Hc', ''JHH', 'DQCH', but any word will do.  
numDecimals Int 1..1 Number of decimal places to be shown.  
peakSize Float 1..1 Size of peak symbol in appropriate unit.  
region Float 2..2 maximum (or world) region  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
analysisProject AnalysisProject 1..1 (Parent link). parent link  
axisUnits AxisUnit 0..* the AxisUnit of the AxisType  
isotopes ccp.api.molecule.ChemElement.Isotope 0..* Derived. Derived. Isotopes mapped on the Axis. NB in the case of e.g coupling constants or multiple quantum coherences there may be more than one.  
parent AnalysisProject 1..1 link to parent object - synonym for analysisProject  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
diagonalExclusion
getDiagonalExclusion NonNegativeFloat -
setDiagonalExclusion - NonNegativeFloat
isSampled
getIsSampled Boolean -
setIsSampled - Boolean
isotopeCodes
getIsotopeCodes Word Tuple -
setIsotopeCodes - Word List
measurementType
getMeasurementType ccp.api.nmr.NmrExpPrototype.ExpMeasurementType -
setMeasurementType - ccp.api.nmr.NmrExpPrototype.ExpMeasurementType
name
getName Word -
setName - Word
numDecimals
getNumDecimals Int -
setNumDecimals - Int
peakSize
getPeakSize Float -
setPeakSize - Float
region
getRegion Float Tuple -
setRegion - Float List

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
analysisProject
getAnalysisProject AnalysisProject -
axisUnits
getAxisUnits AxisUnit Set -
setAxisUnits - AxisUnit Set
sortedAxisUnits AxisUnit List -
addAxisUnit - AxisUnit
removeAxisUnit - AxisUnit
findFirstAxisUnit AxisUnit keyword=value pairs
findAllAxisUnits AxisUnit Set keyword=value pairs
isotopes
getIsotopes ccp.api.molecule.ChemElement.Isotope Tuple - non-std.
findFirstIsotope ccp.api.molecule.ChemElement.Isotope keyword=value pairs
findAllIsotopes ccp.api.molecule.ChemElement.Isotope List keyword=value pairs
parent
getParent AnalysisProject -

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey AxisType 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_2006-08-17-14:16:22_00011

isImplicit:

False

Tag

Value
repositoryId $Id: AxisType.xml,v 1.50 2011-01-13 14:40:36 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: ccpnmr.api.Analysis.AxisPanel.axisTypeccpnmr.api.Analysis.MarkDim.axisTypeccpnmr.api.Analysis.PanelType.axisType
  Data Model Version 2.0.6
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Wed Aug 7 15:06:56 2013    from data model package  ccpnmr.api.Analysis.AxisType   revision 1.50  
  Work done by the CCPN team.
www.ccpn.ac.uk