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

Class: SpectrumWindow


    This is for the multi-dimensional display of one or more spectra simultaneously.
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: serial
Mandatory Attributes: name
Known Subclasses: None
Children:
link spectrumWindowPanes to class SpectrumWindowPane
Constructor: newObj = SpectrumWindow( analysisProject,name=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
isCanvasLabelShown Boolean 1..1 Is canvas label shown?  
isCanvasMidpointShown Boolean 1..1 Is canvas midpoint shown?  
isIconified Boolean 1..1 Whether or not the window is iconified.  
isXSliceDrawn Boolean 1..1 Whether a 1D horizontal slice is drawn at the cursor position  
isXTickShown Boolean 1..1 Show ticks on x axis?  
isYSliceDrawn Boolean 1..1 Whether a 1D vertical slice is drawn at the cursor position  
isYTickShown Boolean 1..1 Show tick marks on y axis?  
isZeroLineShown Boolean 0..1 Show line for intensity == 0?  
location Int 2..2 Location in pixel numbers of the Spectrum Window (x then y).  
name Line 1..1 An arbitrary user-defined name for the window.  
serial Int 1..1 Serial number of object. Serves as object main key. Serial numbers of deleted objects are not re-used. Serial numbers can only be set by the implementation. Values are in practice always positive, since negative values are interpreted as a signal to set the next free serial  
stripAxis AxisXyLabel 1..1 Strip axis direction (either 'x' or 'y')  
useMultiplePeakLists Boolean 1..1 Use all active peaklists in peak selection, picking, etc.. If False use only one PeakList  
useOverrideRegion Boolean 1..1 Should override region be used for printing etc.?  

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  
parent AnalysisProject 1..1 link to parent object - synonym for analysisProject  
spectrumWindowGroups SpectrumWindowGroup 0..* the SpectrumWindowGroups of the SpectrumWindow  
spectrumWindowPanes SpectrumWindowPane 0..* (Child link). child link to class SpectrumWindowPane  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
isCanvasLabelShown
getIsCanvasLabelShown Boolean -
setIsCanvasLabelShown - Boolean
isCanvasMidpointShown
getIsCanvasMidpointShown Boolean -
setIsCanvasMidpointShown - Boolean
isIconified
getIsIconified Boolean -
setIsIconified - Boolean
isXSliceDrawn
getIsXSliceDrawn Boolean -
setIsXSliceDrawn - Boolean
isXTickShown
getIsXTickShown Boolean -
setIsXTickShown - Boolean
isYSliceDrawn
getIsYSliceDrawn Boolean -
setIsYSliceDrawn - Boolean
isYTickShown
getIsYTickShown Boolean -
setIsYTickShown - Boolean
isZeroLineShown
getIsZeroLineShown Boolean -
setIsZeroLineShown - Boolean
location
getLocation Int Tuple -
setLocation - Int List
name
getName Line -
setName - Line
serial
getSerial Int -
setSerial - Int
stripAxis
getStripAxis AxisXyLabel -
setStripAxis - AxisXyLabel
useMultiplePeakLists
getUseMultiplePeakLists Boolean -
setUseMultiplePeakLists - Boolean
useOverrideRegion
getUseOverrideRegion Boolean -
setUseOverrideRegion - Boolean

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
analysisProject
getAnalysisProject AnalysisProject -
parent
getParent AnalysisProject -
spectrumWindowGroups
getSpectrumWindowGroups SpectrumWindowGroup Set -
setSpectrumWindowGroups - SpectrumWindowGroup Set
sortedSpectrumWindowGroups SpectrumWindowGroup List -
addSpectrumWindowGroup - SpectrumWindowGroup
removeSpectrumWindowGroup - SpectrumWindowGroup
findFirstSpectrumWindowGroup SpectrumWindowGroup keyword=value pairs
findAllSpectrumWindowGroups SpectrumWindowGroup Set keyword=value pairs
spectrumWindowPanes
getSpectrumWindowPanes SpectrumWindowPane Set -
sortedSpectrumWindowPanes SpectrumWindowPane List -
findFirstSpectrumWindowPane SpectrumWindowPane keyword=value pairs
findAllSpectrumWindowPanes SpectrumWindowPane Set keyword=value pairs

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey SpectrumWindow 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
newSpectrumWindowPane SpectrumWindowPane ...

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_00002

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  Fri Mar 28 11:18:45 2014    from data model package  ccpnmr.api.Analysis.SpectrumWindow   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk