MarkBasic

ccpnmr.analysis.core.MarkBasic.createNonPeakMark(positions, axisTypes, lineWidth=1, dashLength=2, gapLength=2, color=None, remove=True)

Create a mark at a general (i.e. non-peak) position.

Input

List of Floats (Analysis.Mark.positions), List of Analysis.AxisTypes, Int, Int, Int, Word (Analysis.Color.name)

Output

Analysis.Mark

ccpnmr.analysis.core.MarkBasic.createPeakDimRuler(peakDim, windowPane, lineWidth=1, dashLength=3, gapLength=1, color=None, remove=True)

Create an Analysis ruler at a peakDim position given a window

Input

Nmr.Peak, Analysis.SpectrumWindowPane, Int, Int, Int, Analysis.Color, Boolean

Output

Analysis.Ruler

ccpnmr.analysis.core.MarkBasic.createPeakMark(peak, lineWidth=1, dashLength=2, gapLength=2, remove=True, axisTypeDict=None)

Create a mark positioned at a given peak

Input

Nmr.Peak, Int, Int, Int, Boolean

Output

Analysis.Mark

ccpnmr.analysis.core.MarkBasic.createRuler(position, panelType, lineWidth=1, dashLength=4, gapLength=2, color=None, remove=True)

Create an Analysis ruler

Input

Float (Analysis.Ruler.position), Analysis.PanelType, Int, Int, Int, Word (Analysis.Color.name)

Output

Analysis.Ruler

ccpnmr.analysis.core.MarkBasic.removeAllMarksAndRulers(argServer)

Macro to remove all marks and rulers in a project.

Input

ArgumentServer

Output

None

ccpnmr.analysis.core.MarkBasic.removeMarks(project, removeAll=False)

Remove marks in a project. If removeAll = True then remove all marks. Otherwise remove only marks above the user-specified limit maxMarks.

Input

Project, Boolean

Output

None

ccpnmr.analysis.core.MarkBasic.removeRulers(project, removeAll=False)

Remove rulers in a project. If removeAll = True then remove all rulers. Otherwise remove only rulers above the user-specified limit maxRulers.

Input

Project, Boolean

Output

None

ccpnmr.analysis.core.MarkBasic.setNonPeakMarkColor(project)

Set the colour of general marks (i.e. not positioned on peaks).

Input

Project, Word (Analysis.Color.name)

Output

None

ccpnmr.analysis.core.MarkBasic.setPeakMarkColor(peakList)

Set the colour of marks positioned on peaks.

Input

Nmr.PeakList

Output

None

ccpnmr.analysis.core.MarkBasic.setRulerColor(project)

Set the colour of rulers.

Input

Project, Word (Analysis.Color.name)

Output

None

Previous topic

ExperimentBasic

Next topic

MergeObjects

This Page