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 CCDCaptorSize

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\CCDCaptorSize
Namespace: hrm\param
Package: hrm
Located at param/CCDCaptorSize.php

Methods summary

public
# __construct( )

CCDCaptorSize constructor.

CCDCaptorSize constructor.

This is use to calculate the pixel size (i.e. CCDCaptorSizeX) from the camera and magnification of the microscope)

Overrides

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

Confirms that this is a Calculation Parameter.

Confirms that this is a Calculation Parameter.

Returns

boolean
Always true.

Overrides

hrm\param\base\Parameter::isForPixelSizeCalculation
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\NumericalParameter::check
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\NumericalParameter::displayString

Methods inherited from hrm\param\base\NumericalParameter

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

Methods inherited from hrm\param\base\Parameter

confidenceLevel(), defaultValue(), getJsonData(), internalPossibleValues(), internalValue(), isBoolean(), isForCapture(), isForCorrection(), isForImage(), isForMicroscope(), 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