Huygens Remote Manager
  • Namespace
  • Class
  • Tree
  • Todo

Namespaces

  • hrm
    • job
    • param
      • base
    • setting
      • base
    • shell
    • stats
    • user
      • proxy

Classes

  • AberrationCorrectionMode
  • AberrationCorrectionNecessary
  • AdvancedCorrectionOptions
  • Autocrop
  • BackgroundOffsetPercent
  • Binning
  • CCDCaptorSize
  • CCDCaptorSizeX
  • ChromaticAberration
  • CMount
  • ColocAnalysis
  • ColocChannel
  • ColocCoefficient
  • ColocMap
  • ColocThreshold
  • CoverslipRelativePosition
  • DeconvolutionAlgorithm
  • EmissionWavelength
  • ExcitationWavelength
  • ImageFileFormat
  • IsMultiChannel
  • MicroscopeType
  • MultiChannelOutput
  • NumberOfChannels
  • NumberOfIterations
  • NumericalAperture
  • ObjectiveMagnification
  • ObjectiveType
  • OutputFileFormat
  • PerformAberrationCorrection
  • PinholeSize
  • PinholeSpacing
  • PointSpreadFunction
  • PSF
  • PSFGenerationDepth
  • QualityChangeStoppingCriterion
  • SampleMedium
  • SignalNoiseRatio
  • SpimCenterOffset
  • SpimDir
  • SpimExcMode
  • SpimFill
  • SpimFocusOffset
  • SpimGaussWidth
  • SpimNA
  • Sted3D
  • StedDepletionMode
  • StedImmunity
  • StedSaturationFactor
  • StedWavelength
  • TimeInterval
  • TubeFactor
  • ZStabilization
  • ZStepSize

Class OutputFileFormat

A ChoiceParameter to represent the output file format.

hrm\param\base\Parameter
Extended by hrm\param\base\ChoiceParameter
Extended by hrm\param\OutputFileFormat
Namespace: hrm\param
Package: hrm
Located at param/OutputFileFormat.php

Methods summary

public
# __construct( )

OutputFileFormat constructor.

OutputFileFormat constructor.

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 string
# translatedValue( )

Returns the Parameter translated value.

Returns the Parameter translated value.

The translated form of the Parameter value is then one used in the Tcl script. The translation of the output file format is read from the database.

Returns

string
Translated value.

Overrides

hrm\param\base\Parameter::translatedValue
public string
# extension( )

Returns the file extension associated with a given output format translated value.

Returns the file extension associated with a given output format translated value.

Returns

string
The file extension

Todo

This information is partially in the database.

Methods inherited from hrm\param\base\ChoiceParameter

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

Methods inherited from hrm\param\base\Parameter

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

Constants summary

Constants inherited from hrm\param\base\Parameter

PADSIZE

Huygens Remote Manager API documentation generated by ApiGen