Class IDimensionChannelDetectorSettings

• Defined in File libCZI_Metadata2.h

Class Documentation

class IDimensionChannelDetectorSettings

The detector settings.

Public Functions

virtual bool TryGetDetectorRef(std::wstring *detectorRef) = 0

Try to get reference to detector

Parameters:

detectorRef – [inout] If non-null and successful, the detector reference is placed here.

Returns:

{bool} True if it succeeds, false if it fails.

virtual bool TryGetBinning(ChannelDetectorSettingsBinning *binning) = 0

Try to get the binning mode.

Parameters:

binning – [inout] If non-null and successful, the binning is placed here.

Returns:

{bool} True if it succeeds, false if it fails.

virtual bool TryGetShutter(ChannelDetectorSettingsShutter *shutter) = 0

Try to get the shutter mode.

Parameters:

shutter – [inout] If non-null and successful, the shutter mode is placed here.

Returns:

{bool} True if it succeeds, false if it fails.

virtual bool TryGetPhotonConversionFactor(double *conversionFactor) = 0

Try to get the photon conversion factor.

Parameters:

conversionFactor – [inout] If non-null and successful, the conversion factor is placed here.

Returns:

{bool} True if it succeeds, false if it fails.

virtual bool TryGetGain(double *gain) = 0

Try to get the gain.

Parameters:

gain – [inout] If non-null and successful, the gain is placed here.

Returns:

{bool} True if it succeeds, false if it fails.

virtual bool TryGetDigitalGain(double *digitalgain) = 0

Try to get the digital gain.

Parameters:

digitalgain – [inout] If non-null and successful, the digital gain is placed here.

Returns:

{bool} True if it succeeds, false if it fails.

virtual bool TryGetOffset(double *offset) = 0

Try to get the offset.

Parameters:

offset – [inout] If non-null and successful, the offset is placed here.

Returns:

{bool} True if it succeeds, false if it fails.

virtual bool TryGetEMGain(double *emgain) = 0

Try to get the EM gain.

Parameters:

emgain – [inout] If non-null and successful, the EM gain is placed here.

Returns:

{bool} True if it succeeds, false if it fails.

virtual bool TryGetVoltage(double *voltage) = 0

Try to get the voltage.

Parameters:

voltage – [inout] If non-null and successful, the voltage is placed here.

Returns:

{bool} True if it succeeds, false if it fails.

virtual bool TryGetReadOutRate(double *readoutrate) = 0

Try to get the read out rate

Parameters:

readoutrate – [inout] If non-null and successful, the read out rate is placed here.

Returns:

{bool} True if it succeeds, false if it fails.

virtual bool TryGetUseBrightnessContrastCorrection(bool *usebrightnesscontrastcorrection) = 0

Try to get a boolean indicating whether brightness/contrast correction was used.

Parameters:

usebrightnesscontrastcorrection – [inout] If non-null and successful, a boolean indicating whether brightness/contrast correction was used is placed here.

Returns:

{bool} True if it succeeds, false if it fails.

virtual bool TryGetPixelMaximum(double *pixelmaximum) = 0

Try to get the pixel maximum.

Parameters:

pixelmaximum – [inout] If non-null and successful, the pixel maximum is placed here.

Returns:

{bool} True if it succeeds, false if it fails.

virtual bool TryGetPixelAccuracy(double *pixelaccuracy) = 0

Try to get the pixel accuracy.

Parameters:

pixelaccuracy – [inout] If non-null and successful, the pixel accuracy is placed here.

Returns:

{bool} True if it succeeds, false if it fails.

virtual bool TryGetPixelScaleFactor(double *pixelscalefactor) = 0

Try to get the pixel scale factor.

Parameters:

pixelscalefactor – [inout] If non-null and successful, the pixel scale factor is placed here.

Returns:

{bool} True if it succeeds, false if it fails.

virtual bool TryGetCameraProcessingMode(ChannelDetectorCameraProcessingMode *mode) = 0

Try to get the camera processing mode.

Parameters:

mode – [inout] If non-null and successful, the camera processing mode is placed here.

Returns:

{bool} True if it succeeds, false if it fails.

virtual ~IDimensionChannelDetectorSettings() = default