Class SignalNoiseRatio

A NumericalArrayParameter to represent the SNR per channel.

hrm\param\base\Parameter

Extended by

hrm\param\base\NumericalParameter

Extended by

hrm\param\base\NumericalArrayParameter

Extended by

hrm\param\SignalNoiseRatio

Namespace: hrm\param
Package: hrm@param
Located at param/SignalNoiseRatio.php

Methods summary

`public`	# `__construct( )` SignalNoiseRatio constructor. SignalNoiseRatio constructor. Overrides `hrm\param\base\NumericalArrayParameter::__construct`
`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`	# `check( )` Checks whether the Parameter is valid Checks whether the Parameter is valid Returns boolean True if the Parameter is valid, false otherwise. Overrides `hrm\param\base\NumericalArrayParameter::check`
`public`	# `setAlgorithm( string $algorithm )` Sets the deconvolution algorithm. Sets the deconvolution algorithm. Parameters `$algorithm` Sets the algorithm, either 'cmle' or 'qmle'.
`public string`	# `displayString( integer $numberOfChannels = 0 )` Returns the string representation of the Parameter for the cmle or qmle algorithm Returns the string representation of the Parameter for the cmle or qmle algorithm The algorithm is stored internally in the Parameter and is either 'cmle' (default, set when the Parameter is instantiated),or 'qmle'. Parameters `$numberOfChannels` Number of channels (default 0) Returns string String representation of the Parameter for the cmle or qmle algorithm. Overrides `hrm\param\base\NumericalArrayParameter::displayString`

Methods inherited from hrm\param\base\NumericalArrayParameter

isVariableChannel(), numberOfChannels(), reset(), setNumberOfChannels(), setValue()

Methods inherited from hrm\param\base\NumericalParameter

checkMax(), checkMin(), max(), min(), setMax(), setMin()

Methods inherited from hrm\param\base\Parameter

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

Constants summary

Constants inherited from hrm\param\base\Parameter