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 ColocChannel

A NumericalArrayParameter to represent the colocalization channel choice.

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

Methods summary

public
# __construct( )

ColocChannel constructor.

ColocChannel constructor.

Overrides

hrm\param\base\NumericalArrayParameter::__construct
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
public string
# displayString( integer $numberOfChannels = 0 )

Returns the string representation of the Parameter

Returns the string representation of the Parameter

Parameters

$numberOfChannels
Numbeor of channels (ignored).

Returns

string
String representation of the Parameter.

Overrides

hrm\param\base\NumericalArrayParameter::displayString

Methods inherited from hrm\param\base\NumericalArrayParameter

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

Constants summary

Constants inherited from hrm\param\base\Parameter

PADSIZE

Huygens Remote Manager API documentation generated by ApiGen