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

Class: AnalysisSpectrum


    Analysis information for Spectra/DataSources
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: dataSource
Mandatory Attributes: dataSource
Known Subclasses: None
Children:
link analysisDataDims to class AnalysisDataDim
link analysisPeakLists to class AnalysisPeakList
link storedContours to class StoredContour
Constructor: newObj = AnalysisSpectrum( analysisProject,dataSource=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
autoBaseLevel Float 1..1 Base contour level for automatic contour level setting  
autoLevelChanger Float 1..1 Level change constant for automatic contour level setting  
autoLevelMode AutoLevelMode 1..1 Auto contour level setting mode  
autoNumLevels PositiveInt 1..1 Number of contour levels for automatic setting.  
contourDir Url 0..1 Contour file directory  
font Line 0..1 font for use in spectrum display (and printing?).  
multipletPattern Word 0..1 Multiplet pattern of spectrum  
negColors RgbColor 0..* Colors for negative contours - in order  
negLevels NegativeFloat 0..* Negative contour levels  
posColors RgbColor 0..* Colors for positive contours - in order  
posLevels PositiveFloat 0..* Positive contour levels  
rank Int 1..1 Priority order for spectra (contours) in displays  
shortcut Word 0..1 Keyboard Shortcut  
sliceColor RgbColor 1..1 Spectrum slice color  
useBoundingBox Boolean 1..1 Use bounding box in display  
usePeakArrow Boolean 1..1 Use arrows for peak anotations  
usePrecalculated Boolean 1..1 Use pre-calculated contours  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
analysisDataDims AnalysisDataDim 0..* (Child link). child link to class AnalysisDataDim  
analysisPeakLists AnalysisPeakList 0..* (Child link). child link to class AnalysisPeakList  
analysisProject AnalysisProject 1..1 (Parent link). parent link  
dataSource ccp.api.nmr.Nmr.DataSource 1..1 DataSource that AnalysisSPectrum refers to - key to class  
parent AnalysisProject 1..1 link to parent object - synonym for analysisProject  
spectrumWindowViews SpectrumWindowView 0..* SpectrumWIndowViews viewing this Spectrum  
storedContours StoredContour 0..* (Child link). child link to class StoredContour  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
autoBaseLevel
getAutoBaseLevel Float -
setAutoBaseLevel - Float
autoLevelChanger
getAutoLevelChanger Float -
setAutoLevelChanger - Float
autoLevelMode
getAutoLevelMode AutoLevelMode -
setAutoLevelMode - AutoLevelMode
autoNumLevels
getAutoNumLevels PositiveInt -
setAutoNumLevels - PositiveInt
contourDir
getContourDir Url -
setContourDir - Url
font
getFont Line -
setFont - Line
multipletPattern
getMultipletPattern Word -
setMultipletPattern - Word
negColors
getNegColors RgbColor Tuple -
setNegColors - RgbColor List
addNegColor - RgbColor
removeNegColor - RgbColor
negLevels
getNegLevels NegativeFloat Tuple -
setNegLevels - NegativeFloat List
addNegLevel - NegativeFloat
removeNegLevel - NegativeFloat
posColors
getPosColors RgbColor Tuple -
setPosColors - RgbColor List
addPosColor - RgbColor
removePosColor - RgbColor
posLevels
getPosLevels PositiveFloat Tuple -
setPosLevels - PositiveFloat List
addPosLevel - PositiveFloat
removePosLevel - PositiveFloat
rank
getRank Int -
setRank - Int
shortcut
getShortcut Word -
setShortcut - Word
sliceColor
getSliceColor RgbColor -
setSliceColor - RgbColor
useBoundingBox
getUseBoundingBox Boolean -
setUseBoundingBox - Boolean
usePeakArrow
getUsePeakArrow Boolean -
setUsePeakArrow - Boolean
usePrecalculated
getUsePrecalculated Boolean -
setUsePrecalculated - Boolean

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
analysisDataDims
getAnalysisDataDims AnalysisDataDim Set -
sortedAnalysisDataDims AnalysisDataDim List -
findFirstAnalysisDataDim AnalysisDataDim keyword=value pairs
findAllAnalysisDataDims AnalysisDataDim Set keyword=value pairs
analysisPeakLists
getAnalysisPeakLists AnalysisPeakList Set -
sortedAnalysisPeakLists AnalysisPeakList List -
findFirstAnalysisPeakList AnalysisPeakList keyword=value pairs
findAllAnalysisPeakLists AnalysisPeakList Set keyword=value pairs
analysisProject
getAnalysisProject AnalysisProject -
dataSource
getDataSource ccp.api.nmr.Nmr.DataSource -
setDataSource - ccp.api.nmr.Nmr.DataSource
parent
getParent AnalysisProject -
spectrumWindowViews
getSpectrumWindowViews SpectrumWindowView Set -
setSpectrumWindowViews - SpectrumWindowView Set
sortedSpectrumWindowViews SpectrumWindowView List -
findFirstSpectrumWindowView SpectrumWindowView keyword=value pairs
findAllSpectrumWindowViews SpectrumWindowView Set keyword=value pairs
storedContours
getStoredContours StoredContour Set -
sortedStoredContours StoredContour List -
findFirstStoredContour StoredContour keyword=value pairs
findAllStoredContours StoredContour Set keyword=value pairs

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey AnalysisSpectrum 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
newAnalysisDataDim AnalysisDataDim dataDim, ...
newAnalysisPeakList AnalysisPeakList peakList, ...
newStoredContour StoredContour dims, path, ...

Other Methods (in package)

Go to Top
Method Return Parameters Comment
None

Appendix

Go to Top

guid:

www.ccpn.ac.uk_Fogh_2008-05-05-17:24:12_00001

isImplicit:

False

Tag

Value
repositoryId $Id: AnalysisSpectrum.xml,v 1.16 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: None
  Data Model Version 2.0.6
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Wed Aug 7 15:06:55 2013    from data model package  ccpnmr.api.Analysis.AnalysisSpectrum   revision 1.16  
  Work done by the CCPN team.
www.ccpn.ac.uk