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 CCDCaptorSizeX

A NumericalParameter to represent the x-size of the CCD pixel.

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

Methods summary

public
# __construct( )

CCDCaptorSizeX constructor.

CCDCaptorSizeX constructor.

Overrides

hrm\param\base\NumericalParameter::__construct
public boolean
# isForCapture( )

Confirms that this is a Capture Parameter.

Confirms that this is a Capture Parameter.

Returns

boolean
Always true.

Overrides

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

Returns the string representation of the CCDCaptorSizeX Parameter.

Returns the string representation of the CCDCaptorSizeX Parameter.

Parameters

$numberOfChannels
Number of channels (ignored).

Returns

string
String representation of the CCDCaptorSizeX Parameter.

Overrides

hrm\param\base\NumericalParameter::displayString

Methods inherited from hrm\param\base\NumericalParameter

check(), checkMax(), checkMin(), max(), min(), setMax(), setMin(), setValue()

Methods inherited from hrm\param\base\Parameter

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

Constants summary

Constants inherited from hrm\param\base\Parameter

PADSIZE

Huygens Remote Manager API documentation generated by ApiGen