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 SampleMedium

A ChoiceParameter to represent the sample medium.

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

Methods summary

public
# __construct( )

SampleMedium constructor.

SampleMedium constructor.

public boolean
# isForMicroscope( )

Confirms that this is a Microscope Parameter.

Confirms that this is a Microscope Parameter.

Returns

boolean
Always true.

Overrides

hrm\param\base\Parameter::isForMicroscope
public mixed
# 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 sample medium is read from the database.

Returns

mixed
Translated value.

Overrides

hrm\param\base\Parameter::translatedValue
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\ChoiceParameter::check

Methods inherited from hrm\param\base\ChoiceParameter

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

Methods inherited from hrm\param\base\Parameter

confidenceLevel(), getJsonData(), internalPossibleValues(), internalValue(), isBoolean(), isForCapture(), isForCorrection(), isForImage(), isForPixelSizeCalculation(), isForSpim(), isForSted(), isTaskParameter(), 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