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 BackgroundOffsetPercent

An AnyTypeArrayParameter to represent the background offset in percent.

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

Methods summary

public
# __construct( )

BackgroundOffsetPercent constructor.

BackgroundOffsetPercent constructor.

Overrides

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

Checks whether the Parameter is a Task Parameter

Checks whether the Parameter is a Task Parameter

Returns

boolean
Always true.

Overrides

hrm\param\base\Parameter::isTaskParameter
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 BackgroundOffsetPercent parameter.

Returns the string representation of the BackgroundOffsetPercent parameter.

Parameters

$numberOfChannels
Number of channels.

Returns

string
String representation of the BackgroundOffsetPercent Parameter.

Overrides

hrm\param\base\NumericalArrayParameter::displayString

Methods inherited from hrm\param\base\AnyTypeArrayParameter

internalValue(), possibleValues()

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

Constants summary

Constants inherited from hrm\param\base\Parameter

PADSIZE

Huygens Remote Manager API documentation generated by ApiGen