Class ChromaticAberration

A multi-channel, vector parameter to characterize the chromatic aberration.

hrm\param\ChromaticAberration

Namespace: hrm\param
Package: hrm
Todo:

This did not inherit from any base class. Now it inherits from Parameter. Make sure that it still works as expected!

Located at param/ChromaticAberration.php

Methods summary

`public`	# `__construct( )` ChromaticAberration constructor. ChromaticAberration constructor. This method does NOT call the parent constructor! Todo: Provide an input argument $chanCnt with the number of channels of the data set.
`public integer`	# `componentCnt( )` A function for retrieving the number of elements of the vector. A function for retrieving the number of elements of the vector. Returns integer The number of vector elements.
`public boolean`	# `isTaskParameter( )` Checks whether the Parameter is a Task Parameter. Checks whether the Parameter is a Task Parameter. Returns boolean Always true. Overrides `hrm\param\base\Parameter::isTaskParameter`
`public boolean`	# `isVariableChannel( )` Confirms that the Parameter can have a variable number of channels. This overloads the base function. 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 string`	# `displayString( integer $chanCnt )` The string representation of the Parameter. The string representation of the Parameter. Parameters `$chanCnt` The number of channels. Returns string String representation of the Parameter.
`public`	# `setValue( string $values )` A function to set the parameter value (this is taken from the browser session or from the database). A function to set the parameter value (this is taken from the browser session or from the database). Parameters `$values` A '#' formatted string or an array with the CA components. Overrides `hrm\param\base\Parameter::setValue`
`public array`	# `value( )` A function for retrieving the parameter value for all channels. A function for retrieving the parameter value for all channels. Returns array An array with one component per channel and vector element. Overrides `hrm\param\base\Parameter::value`
`public array`	# `chanValue( integer $chan )` A function for retrieving the parameter value for a specific channel A function for retrieving the parameter value for a specific channel Parameters `$chan` The requested channel. Returns array An array with one component per vector element.
`public`	# `setNumberOfChannels( integer $chanCnt )` A function to set the number of channels for the correction. A function to set the number of channels for the correction. Parameters `$chanCnt` The number of channels.
`public mixed`	# `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. Returns mixed The default value or null Overrides `hrm\param\base\Parameter::defaultValue`
`public string`	# `internalValue( )` Returns the internal value of the ChromaticAberration. Returns the internal value of the ChromaticAberration. Returns string The internal value of the Parameter: a # formatted string. Overrides `hrm\param\base\Parameter::internalValue`
`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.

Methods inherited from hrm\param\base\Parameter

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

Constants summary

Constants inherited from hrm\param\base\Parameter

PADSIZE

Properties summary

`public array`	`$value` The aberration value. An array with one element per channel and vector component. The aberration value. An array with one element per channel and vector component.	#
`public integer`	`$chanCnt` The number of channels for which a vector is needed. The number of channels for which a vector is needed.	#
`public integer`	`$componentCnt` The numer of vector components used to describe the CA. Currently 5. The numer of vector components used to describe the CA. Currently 5.	#

Namespaces

Classes

Class ChromaticAberration

Methods summary

Todo:

Returns

Returns

Overrides

Returns

Overrides

Parameters

Returns

Parameters

Overrides

Returns

Overrides

Parameters

Returns

Parameters

Returns

Overrides

Returns

Overrides

Returns

Methods inherited from hrm\param\base\Parameter

Constants summary

Constants inherited from hrm\param\base\Parameter

Properties summary