Class ChoiceParameter
The ChoiceParameter can assume a limited number of possible values.
- hrm\param\base\Parameter
- hrm\param\base\ChoiceParameter
Direct known subclasses
hrm\param\AberrationCorrectionMode
,
hrm\param\AdvancedCorrectionOptions
,
hrm\param\MicroscopeType
,
hrm\param\NumberOfChannels
,
hrm\param\ObjectiveMagnification
,
hrm\param\ObjectiveType
,
hrm\param\OutputFileFormat
,
hrm\param\PerformAberrationCorrection
,
hrm\param\PointSpreadFunction
,
hrm\param\SampleMedium
,
hrm\param\ZStabilization
,
hrm\param\Autocrop
,
hrm\param\base\BooleanParameter
,
hrm\param\base\SingleOrMultiChannelParameter
,
hrm\param\Binning
,
hrm\param\ColocAnalysis
,
hrm\param\ColocMap
,
hrm\param\CoverslipRelativePosition
,
hrm\param\DeconvolutionAlgorithm
Indirect known subclasses
hrm\param\AberrationCorrectionNecessary
,
hrm\param\ImageFileFormat
,
hrm\param\IsMultiChannel
,
hrm\param\MultiChannelOutput
Methods summary
public
array
|
|
public
string
|
#
possibleValuesString( )
Returns the possible values for the Parameter as a comma-separated string. |
public
boolean
|
|
public
string
|
#
displayString( integer $numberOfChannels = 0 )
Returns the string representation of the Parameter. |
public
mixed
|
#
defaultValue( )
Returns the default value for the Parameters that have a default value ot NULL for those that don't. |
Methods inherited from hrm\param\base\Parameter
confidenceLevel()
,
getJsonData()
,
internalPossibleValues()
,
internalValue()
,
isBoolean()
,
isForCapture()
,
isForCorrection()
,
isForImage()
,
isForMicroscope()
,
isForPixelSizeCalculation()
,
isForSpim()
,
isForSted()
,
isTaskParameter()
,
isVariableChannel()
,
message()
,
mustProvide()
,
name()
,
notSet()
,
reset()
,
setConfidenceLevel()
,
setValue()
,
translatedValue()
,
translatedValueFor()
,
value()