Class Parameter

(Abstract) base class for all Parameter types in the HRM.

Direct known subclasses

hrm\param\base\ChoiceParameter, hrm\param\base\NumericalParameter, hrm\param\ChromaticAberration

Indirect known subclasses

hrm\param\AberrationCorrectionMode, hrm\param\AberrationCorrectionNecessary, hrm\param\Binning, hrm\param\CCDCaptorSize, hrm\param\CCDCaptorSizeX, hrm\param\CMount, hrm\param\ColocAnalysis, hrm\param\ColocChannel, hrm\param\ColocCoefficient, hrm\param\ColocMap, hrm\param\ColocThreshold, hrm\param\CoverslipRelativePosition, hrm\param\AdvancedCorrectionOptions, hrm\param\DeconvolutionAlgorithm, hrm\param\EmissionWavelength, hrm\param\ExcitationWavelength, hrm\param\ImageFileFormat, hrm\param\IsMultiChannel, hrm\param\MicroscopeType, hrm\param\MultiChannelOutput, hrm\param\NumberOfChannels, hrm\param\NumberOfIterations, hrm\param\NumericalAperture, hrm\param\Autocrop, hrm\param\ObjectiveMagnification, hrm\param\ObjectiveType, hrm\param\OutputFileFormat, hrm\param\PerformAberrationCorrection, hrm\param\PinholeSize, hrm\param\PinholeSpacing, hrm\param\PointSpreadFunction, hrm\param\PSF, hrm\param\PSFGenerationDepth, hrm\param\QualityChangeStoppingCriterion, hrm\param\BackgroundOffsetPercent, hrm\param\SampleMedium, hrm\param\SignalNoiseRatio, hrm\param\SpimCenterOffset, hrm\param\SpimDir, hrm\param\SpimExcMode, hrm\param\SpimFill, hrm\param\SpimFocusOffset, hrm\param\SpimGaussWidth, hrm\param\SpimNA, hrm\param\Sted3D, hrm\param\base\AnyTypeArrayParameter, hrm\param\StedDepletionMode, hrm\param\StedImmunity, hrm\param\StedSaturationFactor, hrm\param\StedWavelength, hrm\param\TimeInterval, hrm\param\TubeFactor, hrm\param\ZStabilization, hrm\param\ZStepSize, hrm\param\base\BooleanParameter, hrm\param\base\NumericalArrayParameter, hrm\param\base\NumericalVectorParameter, hrm\param\base\SingleOrMultiChannelParameter

Abstract
Namespace: hrm\param\base
Located at param/base/Parameter.php

Methods summary

`abstract 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.
`public string`	# `message( )` Returns the error message that was set by check() Returns the error message that was set by check() Returns string
`public string`	# `confidenceLevel( )` Returns the confidence level for the Parameter. Returns the confidence level for the Parameter. Returns string Confidence level for the Parameter.
`public`	# `setConfidenceLevel( string $confidenceLevel )` Sets the confidence level for the Parameter. Sets the confidence level for the Parameter. Parameters `$confidenceLevel`
`public boolean`	# `mustProvide( )` Checks whether the Parameter must have a (valid) value. Checks whether the Parameter must have a (valid) value. Returns boolean True if the confidence level is lower than 'reported', false otherwise.
`public`	# `reset( )` Sets the Parameter value(s) to empty. Sets the Parameter value(s) to empty.
`public boolean`	# `notSet( )` Return true of the value is not set. Return true of the value is not set. Returns boolean True if the value is not set (i.e. null), false otherwise.
`public null`	# `defaultValue( )` Returns the default value for the Parameters that have a default value or NULL for those that don't. Returns the default value for the Parameters that have a default value or NULL for those that don't. This function should be overloaded by the subclasses Returns null
`public boolean`	# `isForImage( )` Checks whether the Parameter is an Image Parameter. Checks whether the Parameter is an Image Parameter. This function should be overloaded by the subclasses. Returns boolean True if the Parameter is an Image Parameter, false otherwise.
`public boolean`	# `isForMicroscope( )` Checks whether the Parameter is a Microscope Parameter. Checks whether the Parameter is a Microscope Parameter. This function should be overloaded by the subclasses. Returns boolean True if the Parameter is a Microscope Parameter, false otherwise.
`public boolean`	# `isForCapture( )` Checks whether the Parameter is a Capture Parameter. Checks whether the Parameter is a Capture Parameter. This function should be overloaded by the subclasses. Returns boolean True if the Parameter is a Capture Parameter, false otherwise.
`public boolean`	# `isForSted( )` Checks whether the Parameter is a Sted Parameter. Checks whether the Parameter is a Sted Parameter. This function should be overloaded by the subclasses. Returns boolean True if the Parameter is a Sted Parameter, false otherwise.
`public boolean`	# `isForSpim( )` Checks whether the Parameter is a Spim Parameter. Checks whether the Parameter is a Spim Parameter. This function should be overloaded by the subclasses. Returns boolean True if the Parameter is a Spim Parameter, false otherwise.
`public boolean`	# `isVariableChannel( )` Checks whether the Parameter is a Variable Channel Parameter. Checks whether the Parameter is a Variable Channel Parameter. This function should be overloaded by the subclasses. Returns boolean True if the Parameter is a Variable Channel Parameter, false otherwise.
`public boolean`	# `isForCorrection( )` Checks whether the Parameter is a Correction Parameter. Checks whether the Parameter is a Correction Parameter. This function should be overloaded by the subclasses. Returns boolean True if the Parameter is a Correction Parameter, false otherwise.
`public boolean`	# `isForPixelSizeCalculation( )` Checks whether the Parameter is used for calculating the Pixel Size from the CCD pixel size and the total microscope magnification. Checks whether the Parameter is used for calculating the Pixel Size from the CCD pixel size and the total microscope magnification. This function should be overloaded by the subclasses. Returns boolean True if the Parameter is a Calculation Parameter, false otherwise.
`public boolean`	# `isTaskParameter( )` Checks whether the Parameter is a Task Parameter. Checks whether the Parameter is a Task Parameter. This function should be overloaded by the subclasses. Returns boolean True if the Parameter is a Task Parameter, false otherwise.
`public string`	# `name( )` Returns the name of the Parameter. Returns the name of the Parameter. Returns string The name of the Parameter.
`public mixed`	# `value( )` Returns the value of the Parameter. Returns the value of the Parameter. Returns mixed The value of the Parameter.
`public mixed`	# `internalValue( )` Returns the internal value of the Parameter. Returns the internal value of the Parameter. This function should be overloaded by the subclasses if the internal and external representations differ. Returns mixed The internal value of the Parameter
`public array`	# `possibleValues( )` Returns the possible values for the Parameter. Returns the possible values for the Parameter. This function should be overloaded by the subclasses if the internal and external representations differ. Returns array The possibles values of the Parameter in their internal representation.
`public array`	# `internalPossibleValues( )` Returns the possible values for the Parameter in their internal representation. Returns the possible values for the Parameter in their internal representation. This function should be overloaded by the subclasses if the internal and external representations differ. Returns array The possibles values of the Parameter in their internal representation.
`public`	# `setValue( mixed $value )` Sets the value of the Parameter Sets the value of the Parameter Parameters `$value` Value for the Parameter.
`public boolean`	# `isBoolean( )` Returns true if boolean. Returns true if boolean. This function should be overloaded by the subclasses. Returns boolean always false for a base Parameter.
`public mixed`	# `translatedValue( )` Returns the value of the Parameter in the translated form that is used in the Tcl script. Returns the value of the Parameter in the translated form that is used in the Tcl script. By default the translated value is just the value, but this can be changed in subclasses when necessary. Returns mixed The translated value.
`public mixed`	# `translatedValueFor( mixed $possibleValue )` Returns the translated value for a given possible value. Returns the translated value for a given possible value. Parameters `$possibleValue` The possible value for which a translation is needed. Returns mixed Translated possible value.
`public string`	# `getJsonData( )` Serialized, JSON-encoded Parameter. Serialized, JSON-encoded Parameter. Returns string JSON-encoded Parameter string.

Constants summary

`integer`	`PADSIZE` The pad size for the Parameter names. const int The pad size for the Parameter names. const int	# `38`

Namespaces

Classes

Class Parameter

Direct known subclasses

Indirect known subclasses

Methods summary

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Constants summary