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

Class: PeakSetting

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: serial
Mandatory Attributes: name, pickNonadjacent
Known Subclasses: None
Children: None
Constructor: newObj = PeakSetting( analysisProject,name=value, pickNonadjacent=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
drawMethod ccpnmr.api.Analysis.PeakDrawMethod 0..1  
intensityScale PositiveFloat 1..1  
name Line 1..1 Peak setting name  
pickBuffer NonNegativeInt 1..1 Peak finding buffer extra width in pixels  
pickDrop FloatRatio 1..1 The fraction of the maximum height that the data must drop by in all directions in order to be considered a peak, in peak finding.  
pickMax Boolean 1..1 Pick peak maxima?  
pickMin Boolean 1..1 Pick peak minima  
pickNonadjacent Boolean 1..1 ???  
pickScale PositiveFloat 1..1  
pickThickness NonNegativeInt 1..1  
pickVolumeMethod ccpnmr.api.Analysis.PeakFindVolumeMethod 0..1  
pixelSize PositiveInt 1..1  
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  
volumeScale PositiveFloat 1..1  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
analysisProject AnalysisProjectV3 1..1 (Parent link). parent link  
parent AnalysisProjectV3 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
drawMethod
getDrawMethod ccpnmr.api.Analysis.PeakDrawMethod -
setDrawMethod - ccpnmr.api.Analysis.PeakDrawMethod
intensityScale
getIntensityScale PositiveFloat -
setIntensityScale - PositiveFloat
name
getName Line -
setName - Line
pickBuffer
getPickBuffer NonNegativeInt -
setPickBuffer - NonNegativeInt
pickDrop
getPickDrop FloatRatio -
setPickDrop - FloatRatio
pickMax
getPickMax Boolean -
setPickMax - Boolean
pickMin
getPickMin Boolean -
setPickMin - Boolean
pickNonadjacent
getPickNonadjacent Boolean -
setPickNonadjacent - Boolean
pickScale
getPickScale PositiveFloat -
setPickScale - PositiveFloat
pickThickness
getPickThickness NonNegativeInt -
setPickThickness - NonNegativeInt
pickVolumeMethod
getPickVolumeMethod ccpnmr.api.Analysis.PeakFindVolumeMethod -
setPickVolumeMethod - ccpnmr.api.Analysis.PeakFindVolumeMethod
pixelSize
getPixelSize PositiveInt -
setPixelSize - PositiveInt
serial
getSerial Int -
setSerial - Int
volumeScale
getVolumeScale PositiveFloat -
setVolumeScale - PositiveFloat

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
analysisProject
getAnalysisProject AnalysisProjectV3 -
parent
getParent AnalysisProjectV3 -

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey PeakSetting 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_2011-11-16-17:07:14_00004

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: ccpnmr.api.AnalysisV3.AnalysisProjectV3.currentPeakSetting
  Data Model Version 2.1.2
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Mon Mar 2 17:25:17 2015    from data model package  ccpnmr.api.AnalysisV3.PeakSetting   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk