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 MultiChannelOutput

A BooleanParameter to indicate whether the output is multi-channel.

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

Methods summary

public
# __construct( )

MultiChannelOutput constructor.

MultiChannelOutput constructor.

Overrides

hrm\param\base\BooleanParameter::__construct
public boolean
# isTaskParameter( )

Checks whether the Parameter is a Task Parameter. return bool Always true.

Checks whether the Parameter is a Task Parameter. return bool Always true.

Returns

boolean

True if the Parameter is a Task Parameter, false otherwise.

Overrides

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

This Parameter should not display anything.

This Parameter should not display anything.

Parameters

$numberOfChannels
Number of channels (ignored).

Returns

string
Empty string.

Overrides

hrm\param\base\BooleanParameter::displayString

Methods inherited from hrm\param\base\BooleanParameter

check(), isBoolean(), isTrue()

Methods inherited from hrm\param\base\ChoiceParameter

defaultValue(), possibleValues(), possibleValuesString()

Methods inherited from hrm\param\base\Parameter

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