Class ImageFileFormat

A SingleOrMultiChannelParameter to represent the image file format.

hrm\param\base\Parameter

Extended by

hrm\param\base\ChoiceParameter

Extended by

hrm\param\base\SingleOrMultiChannelParameter

Extended by

hrm\param\ImageFileFormat

Namespace: hrm\param
Package: hrm
Located at param/ImageFileFormat.php

Methods summary

`public`	# `__construct( )` ImageFileFormat constructor. ImageFileFormat constructor.
`public boolean`	# `isForImage( )` Confirms that this is an Image Parameter. Confirms that this is an Image Parameter. Returns boolean Always true. Overrides `hrm\param\base\Parameter::isForImage`
`public array`	# `fileExtensions( string $value = NULL )` Returns all image file extensions for current or given format. Returns all image file extensions for current or given format. Parameters `$value` Set to null to get the extensions for current format. Returns array Array of file extensions.
`public string`	# `displayString( integer $numberOfChannels = 0 )` Returns the string representation of the ImageFileFormat Parameter. Returns the string representation of the ImageFileFormat Parameter. Parameters `$numberOfChannels` Number of channels (default 0). Returns string String representation of the ImageFileFormat Parameter. Overrides `hrm\param\base\ChoiceParameter::displayString`

Methods inherited from hrm\param\base\SingleOrMultiChannelParameter

beMultiChannel(), beSingleChannel(), internalPossibleValues(), internalValue(), isMultiChannel(), isSingleChannel(), prefix(), setValue()

Methods inherited from hrm\param\base\ChoiceParameter

check(), defaultValue(), possibleValues(), possibleValuesString()

Methods inherited from hrm\param\base\Parameter

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

Constants summary

Constants inherited from hrm\param\base\Parameter