Class SpimExcMode

An AnyTypeArrayParameter to represent the SPIM excitation mode.

hrm\param\base\Parameter

Extended by

hrm\param\base\NumericalParameter

Extended by

hrm\param\base\NumericalArrayParameter

Extended by

hrm\param\base\AnyTypeArrayParameter

Extended by

hrm\param\SpimExcMode

Namespace: hrm\param
Package: hrm
Located at param/SpimExcMode.php

Methods summary

`public`	# `__construct( )` SpimExcMode constructor. SpimExcMode constructor. Overrides `hrm\param\base\AnyTypeArrayParameter::__construct`
`public boolean`	# `isForMicroscope( )` Confirms that this is NOT a Microscope Parameter. Confirms that this is NOT a Microscope Parameter. We make a distinction between SPIM parameters and microscope parameters. Returns boolean Always false. Overrides `hrm\param\base\Parameter::isForMicroscope`
`public boolean`	# `isForSpim( )` Confirms that this is a SPIM Parameter. Confirms that this is a SPIM Parameter. We make a distinction between SPIM parameters and microscope parameters. Returns boolean Always true. Overrides `hrm\param\base\Parameter::isForSpim`
`public string`	# `translatedValue( )` Returns the Parameter translated value Returns the Parameter translated value The translated form of the Parameter value is then one used in the Tcl script. Returns string Translated value. Overrides `hrm\param\base\Parameter::translatedValue`
`public boolean`	# `check( )` Checks whether the Parameter is valid. Checks whether the Parameter is valid. Returns boolean True if the Parameter is valid, false otherwise. Overrides `hrm\param\base\NumericalArrayParameter::check`
`public string`	# `displayString( integer $numberOfChannels = 0 )` Returns the string representation of the Parameter. Returns the string representation of the Parameter. Parameters `$numberOfChannels` Number of channels (ignored). Returns string String representation of the Parameter. Overrides `hrm\param\base\NumericalArrayParameter::displayString`

Methods inherited from hrm\param\base\AnyTypeArrayParameter

internalValue(), possibleValues()

Methods inherited from hrm\param\base\NumericalArrayParameter

isVariableChannel(), numberOfChannels(), reset(), setNumberOfChannels(), setValue()

Methods inherited from hrm\param\base\NumericalParameter

checkMax(), checkMin(), max(), min(), setMax(), setMin()

Methods inherited from hrm\param\base\Parameter

confidenceLevel(), defaultValue(), getJsonData(), internalPossibleValues(), isBoolean(), isForCapture(), isForCorrection(), isForImage(), isForPixelSizeCalculation(), isForSted(), isTaskParameter(), message(), mustProvide(), name(), notSet(), setConfidenceLevel(), translatedValueFor(), value()

Constants summary

Constants inherited from hrm\param\base\Parameter