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 StedDepletionMode

An AnyTypeArrayParameter to represent the STED depletion mode.

hrm\param\base\Parameter
Extended by hrm\param\base\NumericalParameter
Extended by hrm\param\base\NumericalArrayParameter
Extended by hrm\param\base\AnyTypeArrayParameter
Extended by hrm\param\StedDepletionMode
Namespace: hrm\param
Package: hrm
Located at param/StedDepletionMode.php

Methods summary

public
# __construct( )

StedDepletionMode constructor.

StedDepletionMode constructor.

Overrides

hrm\param\base\AnyTypeArrayParameter::__construct
public boolean
# isForMicroscope( )

Confirms that this is NOT a Microscope Parameter.

Confirms that this is NOT a Microscope Parameter.

We make a distinction between STED parameters and microscope parameters.

Returns

boolean
Always false.

Overrides

hrm\param\base\Parameter::isForMicroscope
public boolean
# isForSted( )

Confirms that this is a Sted Parameter.

Confirms that this is a Sted Parameter.

We make a distinction between STED parameters and microscope parameters.

Returns

boolean
Always true.

Overrides

hrm\param\base\Parameter::isForSted
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 sted depletion mode 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\NumericalArrayParameter::check

Methods inherited from hrm\param\base\AnyTypeArrayParameter

internalValue(), possibleValues()

Methods inherited from hrm\param\base\NumericalArrayParameter

displayString(), 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(), isBoolean(), isForCapture(), isForCorrection(), isForImage(), isForPixelSizeCalculation(), isForSpim(), isTaskParameter(), message(), mustProvide(), name(), notSet(), setConfidenceLevel(), translatedValueFor(), value()

Constants summary

Constants inherited from hrm\param\base\Parameter

PADSIZE

Huygens Remote Manager API documentation generated by ApiGen