Class NumericalArrayParameter

Class for a Parameter that has an array of numbers as possible value, where each entry represents a channel.

hrm\param\base\NumericalArrayParameter

Direct known subclasses

hrm\param\base\AnyTypeArrayParameter, hrm\param\ColocChannel, hrm\param\SpimNA, hrm\param\Sted3D, hrm\param\StedImmunity, hrm\param\StedSaturationFactor, hrm\param\StedWavelength, hrm\param\EmissionWavelength, hrm\param\ExcitationWavelength, hrm\param\PinholeSize, hrm\param\SignalNoiseRatio, hrm\param\SpimCenterOffset, hrm\param\SpimFill, hrm\param\SpimFocusOffset, hrm\param\SpimGaussWidth

Indirect known subclasses

hrm\param\BackgroundOffsetPercent, hrm\param\ColocCoefficient, hrm\param\ColocThreshold, hrm\param\PSF, hrm\param\SpimDir, hrm\param\SpimExcMode, hrm\param\StedDepletionMode

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

Methods summary

`public`	# `__construct( string $name )` NumericalArrayParameter constructor: creates an empty NumericalArrayParameter. NumericalArrayParameter constructor: creates an empty NumericalArrayParameter. Parameters `$name` Name of the new NumericalArrayParameter. Overrides `hrm\param\base\NumericalParameter::__construct`
`public boolean`	# `isVariableChannel( )` Confirms that the Parameter can have a variable number of channels. Confirms that the Parameter can have a variable number of channels. This overloads the base function Returns boolean Always true. Overrides `hrm\param\base\Parameter::isVariableChannel`
`public`	# `reset( )` Sets the Parameter value(s) to empty. Sets the Parameter value(s) to empty. Overrides `hrm\param\base\Parameter::reset`
`public`	# `setNumberOfChannels( integer $number )` Sets the number of channels. Sets the number of channels. Parameters `$number` Number of channels.
`public integer`	# `numberOfChannels( )` Returns the number of channels Returns the number of channels Returns integer The umber of channels.
`public boolean`	# `check( )` Checks whether all values in the NumericalArrayParameter are valid. Checks whether all values in the NumericalArrayParameter are valid. Each value in the NumericalArrayParameter must be a number and might optionally have to be larger than or equal to a given minum value and smaller than or equal to a given maximum. Returns boolean True if all values are valid, false otherwise. Overrides `hrm\param\base\NumericalParameter::check`
`public`	# `setValue( array $value )` Sets the value of the NumericalArrayParameter. Sets the value of the NumericalArrayParameter. The value must be an array with 'maxChanCnt' values (those who refer to non-existing channels should be null). Parameters `$value` Array of values for the NumericalArrayParameter. Todo Notice that right now we do not force the input argument to be an array, since this requires a large refactoring that will be done in a later stage. Overrides `hrm\param\base\NumericalParameter::setValue`
`public string`	# `displayString( integer $numberOfChannels = 0 )` Returns the string representation of the NumericalArrayParameter. Returns the string representation of the NumericalArrayParameter. Parameters `$numberOfChannels` Number of channels. Returns string String representation of the NumericalArrayParameter. Overrides `hrm\param\base\NumericalParameter::displayString`