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

Class: AnalysisProject


    grouping for related Analysis data
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link memopsRoot to class memops.api.Implementation.MemopsRoot
Main key: name
Mandatory Attributes: name, nmrProject
Partitions Children: True
Known Subclasses: None
Children:
link analysisPopups to class AnalysisPopup
link analysisSpectra to class AnalysisSpectrum
link axisRegionGroups to class AxisRegionGroup
link axisTypes to class AxisType
link axisUnits to class AxisUnit
link chainMappings to class ChainMapping
link marks to class Mark
link panelTypes to class PanelType
link rulers to class Ruler
link spectrumWindowGroups to class SpectrumWindowGroup
link spectrumWindows to class SpectrumWindow
Constructor: newObj = AnalysisProject( memopsRoot,name=value, nmrProject=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
autoBackupFreq PositiveInt 1..1 NIterval between automatic backup (in minutes)  
contourToUnaliased Boolean 1..1 Contour unaliased parts of spectrum?  
defaultSpectrumFileType SpectrumFileType 1..1 Default spectrum file type  
doAssignmentAnnotations Boolean 1..1 Do peak annotations: Assignment?  
doAutoBackup Boolean 1..1 Do automatic backup.  
doChainAnnotations Boolean 1..1 Do peak annotations: Chains?  
doDetailAnnotations Boolean 1..1 Do peak annotations: Details?  
doMeritAnnotations Boolean 1..1 Do peak annotations: Merit  
doMinimalAnnotations Boolean 1..1 Should minimal annotations be used?  
doMolSysAnnotations Boolean 1..1 Do peak annotations: MolSystems?  
doSpinSystemAnnotations Boolean 1..1 Do peak annotations: Spin Systems?  
globalContourScale PositiveFloat 1..1 Global contouring scale  
isThreadingAllowed Boolean 1..1 May program be run as multiple threads?  
linkPeakListsData String 0..1 Input data for linkPeakLists  
linkSeqSpinSystemsData String 0..1 input dat for linkSeqSpinSystems  
maxMarks PositiveInt 1..1 Maxc no. of marks  
maxRulers PositiveInt 1..1 Max no. of rulers  
meritAnnotationBad Word 0..1 Annotation for merit=bad  
meritAnnotationGood Word 0..1 Annotation for merit=good  
meritAnnotationMediocre Word 0..1 Annotation for merit=mediocre  
name Line 1..1 name of AnalysisProject  
peakDrawMethod PeakDrawMethod 1..1 Peak mark drawing method  
peakFindBuffer NonNegativeInt 1..1 Peak finding buffer extra width in pixels  
peakFindDrop 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.  
peakFindHaveHigh Boolean 1..1 Find positive extrema in peak finding?  
peakFindHaveLow Boolean 1..1 Find negative extrema in peak finding?  
peakFindNonadjacent Boolean 1..1 Consider positions that differ in more than one coordinate (by +-1), and not just in one coordinate, in peak finding?  
peakFindScale PositiveFloat 1..1 Peak finding scale  
peakFindThickness NonNegativeInt 1..1 Peak finding thickness  
peakFindVolumeMethod PeakFindVolumeMethod 1..1 Volume integration method for peak find  
peakIntensityScale PositiveFloat 1..1 Peak Intensity scale  
peakPixelSize PositiveInt 1..1 Peak size in pixels  
peakVolumeScale PositiveFloat 1..1 Peak volume scale  
printWinFileName PathString 0..1 Window file name to print to.  
printWinInColor Boolean 1..1 Should windows be printed in color  
printWinOrientation PaperOrientation 1..1 Print WIndow in orientation  
printWinOtherHeight PositiveFloat 0..1 Paper height for 'other' paper print sizes  
printWinOtherUnit PaperUnit 1..1 Printer measurement unit for 'other' paper sizes  
printWinOtherWidth PositiveFloat 0..1 Paper width for 'other' paper print sizes  
printWinOutputFormat PrintFormat 1..1 Format for window printing  
printWinPaperSize PaperFormat 1..1 Paper size for window printing  
printWinScaling PositiveFloat 1..1 window print scaling  
printWinShowsDateTime Boolean 1..1 Show data and time on window print  
printWinShowsFileName Boolean 1..1 Show file name on window print  
printWinTickOutside Boolean 0..1 Print window ticks outside (True), inside (Falsde) or not at all (not set).  
printWinTickPlacement Word 0..1 Which sides (n, s, e, w) to print ticks on for window printing.  
printWinTitle Line 0..1 Title for window printing  
spectrumFont Line 0..1 Font to use for spectrum (annotations)  
useBootstrap Boolean 1..1 Use bootstrap error estimation in fitting?  

Inherited Attributes (not in package): applicationDataclassNamecreatedByfieldNamesguidinConstructorisDeletedisLoadedisModifiableisModifiedisReadinglastUnlockedBymetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
activeWindowGroup SpectrumWindowGroup 0..1 Window group currently active  
analysisPopups AnalysisPopup 0..* (Child link). child link to class AnalysisPopup  
analysisSpectra AnalysisSpectrum 0..* (Child link). child link to class AnalysisSpectrum  
axisRegionGroups AxisRegionGroup 0..* (Child link). child link to class AxisRegionGroup  
axisTypes AxisType 0..* (Child link). child link to class AxisType  
axisUnits AxisUnit 0..* (Child link). child link to class AxisUnit  
chainMappings ChainMapping 0..* (Child link). child link to class ChainMapping  
marks Mark 0..* (Child link). child link to class Mark  
memopsRoot memops.api.Implementation.MemopsRoot 1..1 (Parent link). parent link  
nmrProject ccp.api.nmr.Nmr.NmrProject 1..1 Nmr project to which AnalysisProject refers  
panelTypes PanelType 0..* (Child link). child link to class PanelType  
parent memops.api.Implementation.MemopsRoot 1..1 link to parent object - synonym for memopsRoot  
rulers Ruler 0..* (Child link). child link to class Ruler  
spectrumWindowGroups SpectrumWindowGroup 0..* (Child link). child link to class SpectrumWindowGroup  
spectrumWindows SpectrumWindow 0..* (Child link). child link to class SpectrumWindow  

Inherited Attributes (not in package): accessactiveAccessactiveRepositoriespackageLocatorroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
autoBackupFreq
getAutoBackupFreq PositiveInt -
setAutoBackupFreq - PositiveInt
contourToUnaliased
getContourToUnaliased Boolean -
setContourToUnaliased - Boolean
defaultSpectrumFileType
getDefaultSpectrumFileType SpectrumFileType -
setDefaultSpectrumFileType - SpectrumFileType
doAssignmentAnnotations
getDoAssignmentAnnotations Boolean -
setDoAssignmentAnnotations - Boolean
doAutoBackup
getDoAutoBackup Boolean -
setDoAutoBackup - Boolean
doChainAnnotations
getDoChainAnnotations Boolean -
setDoChainAnnotations - Boolean
doDetailAnnotations
getDoDetailAnnotations Boolean -
setDoDetailAnnotations - Boolean
doMeritAnnotations
getDoMeritAnnotations Boolean -
setDoMeritAnnotations - Boolean
doMinimalAnnotations
getDoMinimalAnnotations Boolean -
setDoMinimalAnnotations - Boolean
doMolSysAnnotations
getDoMolSysAnnotations Boolean -
setDoMolSysAnnotations - Boolean
doSpinSystemAnnotations
getDoSpinSystemAnnotations Boolean -
setDoSpinSystemAnnotations - Boolean
globalContourScale
getGlobalContourScale PositiveFloat -
setGlobalContourScale - PositiveFloat
isThreadingAllowed
getIsThreadingAllowed Boolean -
setIsThreadingAllowed - Boolean
linkPeakListsData
getLinkPeakListsData String -
setLinkPeakListsData - String
linkSeqSpinSystemsData
getLinkSeqSpinSystemsData String -
setLinkSeqSpinSystemsData - String
maxMarks
getMaxMarks PositiveInt -
setMaxMarks - PositiveInt
maxRulers
getMaxRulers PositiveInt -
setMaxRulers - PositiveInt
meritAnnotationBad
getMeritAnnotationBad Word -
setMeritAnnotationBad - Word
meritAnnotationGood
getMeritAnnotationGood Word -
setMeritAnnotationGood - Word
meritAnnotationMediocre
getMeritAnnotationMediocre Word -
setMeritAnnotationMediocre - Word
name
getName Line -
setName - Line
peakDrawMethod
getPeakDrawMethod PeakDrawMethod -
setPeakDrawMethod - PeakDrawMethod
peakFindBuffer
getPeakFindBuffer NonNegativeInt -
setPeakFindBuffer - NonNegativeInt
peakFindDrop
getPeakFindDrop FloatRatio -
setPeakFindDrop - FloatRatio
peakFindHaveHigh
getPeakFindHaveHigh Boolean -
setPeakFindHaveHigh - Boolean
peakFindHaveLow
getPeakFindHaveLow Boolean -
setPeakFindHaveLow - Boolean
peakFindNonadjacent
getPeakFindNonadjacent Boolean -
setPeakFindNonadjacent - Boolean
peakFindScale
getPeakFindScale PositiveFloat -
setPeakFindScale - PositiveFloat
peakFindThickness
getPeakFindThickness NonNegativeInt -
setPeakFindThickness - NonNegativeInt
peakFindVolumeMethod
getPeakFindVolumeMethod PeakFindVolumeMethod -
setPeakFindVolumeMethod - PeakFindVolumeMethod
peakIntensityScale
getPeakIntensityScale PositiveFloat -
setPeakIntensityScale - PositiveFloat
peakPixelSize
getPeakPixelSize PositiveInt -
setPeakPixelSize - PositiveInt
peakVolumeScale
getPeakVolumeScale PositiveFloat -
setPeakVolumeScale - PositiveFloat
printWinFileName
getPrintWinFileName PathString -
setPrintWinFileName - PathString
printWinInColor
getPrintWinInColor Boolean -
setPrintWinInColor - Boolean
printWinOrientation
getPrintWinOrientation PaperOrientation -
setPrintWinOrientation - PaperOrientation
printWinOtherHeight
getPrintWinOtherHeight PositiveFloat -
setPrintWinOtherHeight - PositiveFloat
printWinOtherUnit
getPrintWinOtherUnit PaperUnit -
setPrintWinOtherUnit - PaperUnit
printWinOtherWidth
getPrintWinOtherWidth PositiveFloat -
setPrintWinOtherWidth - PositiveFloat
printWinOutputFormat
getPrintWinOutputFormat PrintFormat -
setPrintWinOutputFormat - PrintFormat
printWinPaperSize
getPrintWinPaperSize PaperFormat -
setPrintWinPaperSize - PaperFormat
printWinScaling
getPrintWinScaling PositiveFloat -
setPrintWinScaling - PositiveFloat
printWinShowsDateTime
getPrintWinShowsDateTime Boolean -
setPrintWinShowsDateTime - Boolean
printWinShowsFileName
getPrintWinShowsFileName Boolean -
setPrintWinShowsFileName - Boolean
printWinTickOutside
getPrintWinTickOutside Boolean -
setPrintWinTickOutside - Boolean
printWinTickPlacement
getPrintWinTickPlacement Word -
setPrintWinTickPlacement - Word
printWinTitle
getPrintWinTitle Line -
setPrintWinTitle - Line
spectrumFont
getSpectrumFont Line -
setSpectrumFont - Line
useBootstrap
getUseBootstrap Boolean -
setUseBootstrap - Boolean

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
activeWindowGroup
getActiveWindowGroup SpectrumWindowGroup -
setActiveWindowGroup - SpectrumWindowGroup
analysisPopups
getAnalysisPopups AnalysisPopup Set -
sortedAnalysisPopups AnalysisPopup List -
findFirstAnalysisPopup AnalysisPopup keyword=value pairs
findAllAnalysisPopups AnalysisPopup Set keyword=value pairs
analysisSpectra
getAnalysisSpectra AnalysisSpectrum Set -
sortedAnalysisSpectra AnalysisSpectrum List -
findFirstAnalysisSpectrum AnalysisSpectrum keyword=value pairs
findAllAnalysisSpectra AnalysisSpectrum Set keyword=value pairs
axisRegionGroups
getAxisRegionGroups AxisRegionGroup Set -
sortedAxisRegionGroups AxisRegionGroup List -
findFirstAxisRegionGroup AxisRegionGroup keyword=value pairs
findAllAxisRegionGroups AxisRegionGroup Set keyword=value pairs
axisTypes
getAxisTypes AxisType Set -
sortedAxisTypes AxisType List -
findFirstAxisType AxisType keyword=value pairs
findAllAxisTypes AxisType Set keyword=value pairs
axisUnits
getAxisUnits AxisUnit Set -
sortedAxisUnits AxisUnit List -
findFirstAxisUnit AxisUnit keyword=value pairs
findAllAxisUnits AxisUnit Set keyword=value pairs
chainMappings
getChainMappings ChainMapping Set -
sortedChainMappings ChainMapping List -
findFirstChainMapping ChainMapping keyword=value pairs
findAllChainMappings ChainMapping Set keyword=value pairs
marks
getMarks Mark Set -
sortedMarks Mark List -
findFirstMark Mark keyword=value pairs
findAllMarks Mark Set keyword=value pairs
memopsRoot
getMemopsRoot memops.api.Implementation.MemopsRoot -
nmrProject
getNmrProject ccp.api.nmr.Nmr.NmrProject -
setNmrProject - ccp.api.nmr.Nmr.NmrProject
panelTypes
getPanelTypes PanelType Set -
sortedPanelTypes PanelType List -
findFirstPanelType PanelType keyword=value pairs
findAllPanelTypes PanelType Set keyword=value pairs
parent
getParent memops.api.Implementation.MemopsRoot -
rulers
getRulers Ruler Set -
sortedRulers Ruler List -
findFirstRuler Ruler keyword=value pairs
findAllRulers Ruler Set keyword=value pairs
spectrumWindowGroups
getSpectrumWindowGroups SpectrumWindowGroup Set -
sortedSpectrumWindowGroups SpectrumWindowGroup List -
findFirstSpectrumWindowGroup SpectrumWindowGroup keyword=value pairs
findAllSpectrumWindowGroups SpectrumWindowGroup Set keyword=value pairs
spectrumWindows
getSpectrumWindows SpectrumWindow Set -
sortedSpectrumWindows SpectrumWindow List -
findFirstSpectrumWindow SpectrumWindow keyword=value pairs
findAllSpectrumWindows SpectrumWindow Set keyword=value pairs

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey AnalysisProject memops.api.Implementation.MemopsRoot, 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
newAnalysisPopup AnalysisPopup name, ...
newAnalysisSpectrum AnalysisSpectrum dataSource, ...
newAxisRegionGroup AxisRegionGroup name, ...
newAxisType AxisType name, ...
newAxisUnit AxisUnit unit, ...
newChainMapping ChainMapping chainCode, molSystemCode, ...
newMark Mark ...
newPanelType PanelType name, axisType, ...
newRuler Ruler position, panelType, ...
newSpectrumWindow SpectrumWindow name, ...
newSpectrumWindowGroup SpectrumWindowGroup name, ...

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:23_00003

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: memops.api.Implementation.MemopsRoot.currentAnalysisProject
  Data Model Version 2.1.2
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Fri Mar 28 11:18:42 2014    from data model package  ccpnmr.api.Analysis.AnalysisProject   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk