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

Class: AnalysisSpectrum

Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link analysisProject to class AnalysisProjectV3
Main key: dataSource
Mandatory Attributes: dataSource
Partitions Children: True
Known Subclasses: None
Children:
link analysisDataDims to class AnalysisDataDim
link analysisPeakLists to class AnalysisPeakList
link spectrumMappings to class SpectrumMapping
link storedContours to class StoredContour
Constructor: newObj = AnalysisSpectrum( analysisProject,dataSource=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
contourDir Url 0..1 Directory for contour files  
font Line 0..1 Display font  
negColors RgbaColor 0..* Colors for negative contours  
negLevelBase Float 1..1 Base level for negative counturs drawing  
negLevelChanger Float 1..1 Level change constant for negative countour drawing  
negLevelMode ccpnmr.api.Analysis.AutoLevelMode 1..1 Level selection mode for negative countour drawing  
negLevelNum PositiveInt 1..1 Number of coutour levels for negative countour drawing  
pickThreshold Float 0..1 Peak picking threshold  
posColors RgbaColor 0..* Colors for positive contours  
posLevelBase Float 1..1 Base level for positive countour drawing  
posLevelChanger Float 1..1 Level change constantl for positive countour drawing  
posLevelMode ccpnmr.api.Analysis.AutoLevelMode 1..1 Level selection mode for positive countour drawing  
posLevelNum PositiveInt 1..1 Number of levels for positive countour drawing  
rank PositiveInt 1..1 Priority order for spectra (contours) in displays  
shortcut Word 0..1 Keyboard shortcut for toggling contours on/off.  
sliceColor RgbaColor 1..1 Color for slice display  
useBoundingBox Boolean 1..1 Use bounding box for display?  
useCompression Boolean 1..1 Use spectrum compression?  
usePeakArrow Boolean 1..1 Use arrows for peak annotations?  
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 AnalysisProjectV3 1..1 (Parent link). parent link  
dataSource ccp.api.nmr.Nmr.DataSource 1..1  
parent AnalysisProjectV3 1..1 link to parent object - synonym for analysisProject  
spectrumMappings SpectrumMapping 0..* (Child link). child link to class SpectrumMapping  
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
contourDir
getContourDir Url -
setContourDir - Url
font
getFont Line -
setFont - Line
negColors
getNegColors RgbaColor Tuple -
setNegColors - RgbaColor List
addNegColor - RgbaColor
removeNegColor - RgbaColor
negLevelBase
getNegLevelBase Float -
setNegLevelBase - Float
negLevelChanger
getNegLevelChanger Float -
setNegLevelChanger - Float
negLevelMode
getNegLevelMode ccpnmr.api.Analysis.AutoLevelMode -
setNegLevelMode - ccpnmr.api.Analysis.AutoLevelMode
negLevelNum
getNegLevelNum PositiveInt -
setNegLevelNum - PositiveInt
pickThreshold
getPickThreshold Float -
setPickThreshold - Float
posColors
getPosColors RgbaColor Tuple -
setPosColors - RgbaColor List
addPosColor - RgbaColor
removePosColor - RgbaColor
posLevelBase
getPosLevelBase Float -
setPosLevelBase - Float
posLevelChanger
getPosLevelChanger Float -
setPosLevelChanger - Float
posLevelMode
getPosLevelMode ccpnmr.api.Analysis.AutoLevelMode -
setPosLevelMode - ccpnmr.api.Analysis.AutoLevelMode
posLevelNum
getPosLevelNum PositiveInt -
setPosLevelNum - PositiveInt
rank
getRank PositiveInt -
setRank - PositiveInt
shortcut
getShortcut Word -
setShortcut - Word
sliceColor
getSliceColor RgbaColor -
setSliceColor - RgbaColor
useBoundingBox
getUseBoundingBox Boolean -
setUseBoundingBox - Boolean
useCompression
getUseCompression Boolean -
setUseCompression - 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 AnalysisProjectV3 -
dataSource
getDataSource ccp.api.nmr.Nmr.DataSource -
setDataSource - ccp.api.nmr.Nmr.DataSource
parent
getParent AnalysisProjectV3 -
spectrumMappings
getSpectrumMappings SpectrumMapping Set -
sortedSpectrumMappings SpectrumMapping List -
findFirstSpectrumMapping SpectrumMapping keyword=value pairs
findAllSpectrumMappings SpectrumMapping 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, ...
newSpectrumMapping SpectrumMapping window, ...
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_2011-11-16-17:07:14_00006

isImplicit:

False

Tag

Value
repositoryId $Id: $

Tag

Value
repositoryTag $Name: $

Special constructor code:

None

Special destructor code:

None

Special postDestructor code:

None

Constraints:

None
Known inward one-way links: None
  Data Model Version 2.1.2
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Mon Mar 2 17:25:16 2015    from data model package  ccpnmr.api.AnalysisV3.AnalysisSpectrum   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk