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 PerformAberrationCorrection

A ChoiceParameter to indicate whether aberration correction should be performed.

hrm\param\base\Parameter
Extended by hrm\param\base\ChoiceParameter
Extended by hrm\param\PerformAberrationCorrection
Namespace: hrm\param
Package: hrm
Todo: Why not a BooleanParameter?
Located at param/PerformAberrationCorrection.php

Methods summary

public
# __construct( )

PerformAberrationCorrection constructor.

PerformAberrationCorrection constructor.

public boolean
# isForCorrection( )

Confirms that this is a Correction Parameter

Confirms that this is a Correction Parameter

Returns

boolean
Always true.

Overrides

hrm\param\base\Parameter::isForCorrection
public string
# displayString( integer $numberOfChannels = 0 )

Returns the string representation of the Parameter

Returns the string representation of the Parameter

Parameters

$numberOfChannels
Number of channels (ignored).

Returns

string
String representation of the Parameter.

Overrides

hrm\param\base\ChoiceParameter::displayString

Methods inherited from hrm\param\base\ChoiceParameter

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

Methods inherited from hrm\param\base\Parameter

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

Constants summary

Constants inherited from hrm\param\base\Parameter

PADSIZE

Huygens Remote Manager API documentation generated by ApiGen