Class NumericalParameter

Class for a Parameter that has a scalar number as possible value.

hrm\param\base\Parameter

Extended by

hrm\param\base\NumericalParameter

Direct known subclasses

hrm\param\base\NumericalArrayParameter, hrm\param\base\NumericalVectorParameter, hrm\param\TimeInterval, hrm\param\TubeFactor, hrm\param\ZStepSize, hrm\param\CCDCaptorSize, hrm\param\CCDCaptorSizeX, hrm\param\CMount, hrm\param\NumberOfIterations, hrm\param\NumericalAperture, hrm\param\PinholeSpacing, hrm\param\PSFGenerationDepth, hrm\param\QualityChangeStoppingCriterion

Indirect known subclasses

hrm\param\BackgroundOffsetPercent, hrm\param\base\AnyTypeArrayParameter, 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\StedDepletionMode, hrm\param\StedImmunity, hrm\param\ColocChannel, hrm\param\StedSaturationFactor, hrm\param\StedWavelength, hrm\param\ColocCoefficient, hrm\param\ColocThreshold, hrm\param\EmissionWavelength, hrm\param\ExcitationWavelength, hrm\param\PinholeSize, hrm\param\PSF, hrm\param\SignalNoiseRatio

Namespace: hrm\param\base
Package: hrm
Located at param/base/NumericalParameter.php

Methods summary

`public`	# `__construct( string $name )` Constructor: creates an empty NumericalParameter Constructor: creates an empty NumericalParameter Parameters `$name` Name of the new NumericalParameter.
`public`	# `setMin( integer\|float $value )` Set the minimum allowed value for the NumericalParameter. Set the minimum allowed value for the NumericalParameter. The value itself may be allowed or not. Parameters `$value` Minimum value.
`public`	# `setMax( integer\|float $value )` Set the maximum allowed value for the NumericalParameter. Set the maximum allowed value for the NumericalParameter. The value itself may be allowed or not. Parameters `$value` Maximum value.
`public boolean`	# `checkMin( )` Checks whether the NumericalParameter value should be checked against its minimum value. Checks whether the NumericalParameter value should be checked against its minimum value. Returns boolean True if the value has to be checked against its minimum value, false otherwise.
`public boolean`	# `checkMax( )` Checks whether the NumericalParameter value should be checked against its maximum value. Checks whether the NumericalParameter value should be checked against its maximum value. Returns boolean True if the value has to be checked against its maximum value, false otherwise.
`public integer\|float\|null`	# `min( )` Returns the minimum allowed value for the NumericalParameter. Returns the minimum allowed value for the NumericalParameter. Returns integer\|float\|null The minimum allowed value.
`public integer\|float\|null`	# `max( )` Returns the maximum allowed value for the NumericalParameter. Returns the maximum allowed value for the NumericalParameter. Returns integer\|float\|null The maximum allowed value.
`public boolean`	# `check( )` Checks whether the NumericalParameter is valid. Checks whether the NumericalParameter is valid. Returns boolean True if the NumericalParameter is valid, false otherwise.
`public`	# `setValue( integer\|float $value )` Sets the value of the NumericalParameter. Sets the value of the NumericalParameter. The value must be a scalar. Parameters `$value` Value for the NumericalParameter. Overrides `hrm\param\base\Parameter::setValue`
`public string`	# `displayString( integer $numberOfChannels = 0 )` Returns the string representation of the NumericalParameter. Returns the string representation of the NumericalParameter. Parameters `$numberOfChannels` Number of channels. Returns string String representation of the NumericalParameter.

Methods inherited from hrm\param\base\Parameter

confidenceLevel(), defaultValue(), getJsonData(), internalPossibleValues(), internalValue(), isBoolean(), isForCapture(), isForCorrection(), isForImage(), isForMicroscope(), isForPixelSizeCalculation(), isForSpim(), isForSted(), isTaskParameter(), isVariableChannel(), message(), mustProvide(), name(), notSet(), possibleValues(), reset(), setConfidenceLevel(), translatedValue(), translatedValueFor(), value()

Constants summary

Constants inherited from hrm\param\base\Parameter