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

Package: Analysis


    Data for the CcpNmr Analysis program, mainly about screen graphics and program state.
Classes
Data Types
Data Obj Types

Imported Packages:

AnalysisProfile,   ccp.api.general.DataLocation,   ccp.api.general.Template,   ccp.api.molecule.ChemComp,   ccp.api.molecule.ChemElement,   ccp.api.molecule.MolSystem,   ccp.api.molecule.Molecule,   ccp.api.nmr.Nmr,   ccp.api.nmr.NmrExpPrototype,   memops.api.AccessControl,   memops.api.Implementation

Packages Importing ccpnmr.api.Analysis:

None

Classes:

Class Description
AbstractMark Graphical mark comprised of lines, either Ruler or Mark
AnalysisDataDim Analysis information for DataDim
AnalysisPeakList
AnalysisPopup Analysis popup information
AnalysisProject grouping for related Analysis data
AnalysisSpectrum Analysis information for Spectra/DataSources
AtomSetMapping Stores (pseudo)atom and residue name to use for display, graphical user interfaces etc., and links to appropriate Residue, AtomSets, and ChemAtomSet.

NB the various links are not independent, and the API does *not* guarantee consistency. It is up to CcpNmr Analysis to make sure the information is up-to-date. This behaviour is only tolerated because this is a program-specific part of the model.
AxisMapping Mapping of AxisLabel to AnalysisDataDim
AxisPanel This corresponds to one axis of a SpectrumWindow.
AxisRegion This corresponds to one region of an AxisPanel.
AxisRegionGroup Group of axis regions which are tied together. Used e.g. for strip plots.
AxisType This determines how spectrum dimensions can be mapped onto a SpectrumWindow.
AxisUnit This is one possible unit for an AxisType.
ChainMapping ChainMaping - serves to organise AtomSetMappings
Mark Multidimensional graphical mark.
MarkDim One dimension of a mark.
PanelType This is a way of distinguishing between axes with the same AxisType.
PopupOption Popup option setting
ResidueMapping ResidueMapping - serves to organise AtomSetMappings
Ruler One-dimensional, PanelType-mapped graphical mark.
SidePanel Graphical objects which correspond to one dimension, e.g. the scrollbars and 1D slices.
SlicePanel This is for the display of a 1D slice of a spectrum.
SpectrumWindow This is for the multi-dimensional display of one or more spectra simultaneously.
SpectrumWindowGroup A group of spectrum windows.  Only one group may be active at any one time, and only windows in the active group are displayed.
SpectrumWindowPane Spectrum display area within window. Normal contour SpectrumWindows only have one.
SpectrumWindowView Used for properties of spectra which depend on the particular SpectrumWindow being considered.
StoredContour Set of stored contours for a spectrum (dataSource)
WindowPeakList Used for properties of peak lists which depend on the particular SpectrumWindow being considered.

Data Obj Types:

Type Description
None

Data Types:

Type Description
AutoLevelMode Auto contour level changing mode ('multiply', 'add')
AxisLabel Axis labels used in Analysis. 'x' and 'y' are horizontal and vertical screen dimensions. 'z1', 'z2', etc. are orthogonal dimensions.
AxisXyLabel Axis label (limited to 'x' or 'y')
MappingType Enumeration for AtomSetMapping types. Specifies whether ambiguous or stereochemical type.
PeakDrawMethod Enumeration for peak draw mehtods
PeakFindVolumeMethod Enumeration for Peak FindVolume methods
SpectrumFileType File type enumeration for spectra
SymbolStyle Peak symbol style enumeration ('+', 'x')

Package guid:

www.ccpn.ac.uk_Fogh_2006-08-17-14:16:20_00002
  Data Model Version 2.0.5
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Mon Mar 26 16:58:38 2012    from data model package  ccpnmr.api.Analysis   revision 1.52  
  Work done by the CCPN team.
www.ccpn.ac.uk