libCZI::IDimensionChannelDetectorSettings Class Reference

The detector settings. More...

#include <libCZI_Metadata2.h>

Public Member Functions
virtual bool	TryGetDetectorRef (std::wstring *detectorRef)=0
virtual bool	TryGetBinning (ChannelDetectorSettingsBinning *binning)=0
virtual bool	TryGetShutter (ChannelDetectorSettingsShutter *shutter)=0
virtual bool	TryGetPhotonConversionFactor (double *conversionFactor)=0
virtual bool	TryGetGain (double *gain)=0
virtual bool	TryGetDigitalGain (double *digitalgain)=0
virtual bool	TryGetOffset (double *offset)=0
virtual bool	TryGetEMGain (double *emgain)=0
virtual bool	TryGetVoltage (double *voltage)=0
virtual bool	TryGetReadOutRate (double *readoutrate)=0
virtual bool	TryGetUseBrightnessContrastCorrection (bool *usebrightnesscontrastcorrection)=0
virtual bool	TryGetPixelMaximum (double *pixelmaximum)=0
virtual bool	TryGetPixelAccuracy (double *pixelaccuracy)=0
virtual bool	TryGetPixelScaleFactor (double *pixelscalefactor)=0
virtual bool	TryGetCameraProcessingMode (ChannelDetectorCameraProcessingMode *mode)=0

Detailed Description

The detector settings.

Member Function Documentation

TryGetBinning()

virtual bool libCZI::IDimensionChannelDetectorSettings::TryGetBinning ( ChannelDetectorSettingsBinning *  binning )

pure virtual

Try to get the binning mode.

Parameters

[in,out]

binning

If non-null and successful, the binning is placed here.

Returns

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

TryGetCameraProcessingMode()

virtual bool libCZI::IDimensionChannelDetectorSettings::TryGetCameraProcessingMode ( ChannelDetectorCameraProcessingMode *  mode )

pure virtual

Try to get the camera processing mode.

Parameters

[in,out]

mode

If non-null and successful, the camera processing mode is placed here.

Returns

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

TryGetDetectorRef()

virtual bool libCZI::IDimensionChannelDetectorSettings::TryGetDetectorRef ( std::wstring *  detectorRef )

pure virtual

Try to get reference to detector

Parameters

[in,out]

detectorRef

If non-null and successful, the detector reference is placed here.

Returns

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

TryGetDigitalGain()

virtual bool libCZI::IDimensionChannelDetectorSettings::TryGetDigitalGain ( double *  digitalgain )

pure virtual

Try to get the digital gain.

Parameters

[in,out]

digitalgain

If non-null and successful, the digital gain is placed here.

Returns

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

TryGetEMGain()

virtual bool libCZI::IDimensionChannelDetectorSettings::TryGetEMGain ( double *  emgain )

pure virtual

Try to get the EM gain.

Parameters

[in,out]

emgain

If non-null and successful, the EM gain is placed here.

Returns

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

TryGetGain()

virtual bool libCZI::IDimensionChannelDetectorSettings::TryGetGain ( double *  gain )

pure virtual

Try to get the gain.

Parameters

[in,out]

gain

If non-null and successful, the gain is placed here.

Returns

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

TryGetOffset()

virtual bool libCZI::IDimensionChannelDetectorSettings::TryGetOffset ( double *  offset )

pure virtual

Try to get the offset.

Parameters

[in,out]

offset

If non-null and successful, the offset is placed here.

Returns

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

TryGetPhotonConversionFactor()

virtual bool libCZI::IDimensionChannelDetectorSettings::TryGetPhotonConversionFactor ( double *  conversionFactor )

pure virtual

Try to get the photon conversion factor.

Parameters

[in,out]

conversionFactor

If non-null and successful, the conversion factor is placed here.

Returns

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

TryGetPixelAccuracy()

virtual bool libCZI::IDimensionChannelDetectorSettings::TryGetPixelAccuracy ( double *  pixelaccuracy )

pure virtual

Try to get the pixel accuracy.

Parameters

[in,out]

pixelaccuracy

If non-null and successful, the pixel accuracy is placed here.

Returns

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

TryGetPixelMaximum()

virtual bool libCZI::IDimensionChannelDetectorSettings::TryGetPixelMaximum ( double *  pixelmaximum )

pure virtual

Try to get the pixel maximum.

Parameters

[in,out]

pixelmaximum

If non-null and successful, the pixel maximum is placed here.

Returns

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

TryGetPixelScaleFactor()

virtual bool libCZI::IDimensionChannelDetectorSettings::TryGetPixelScaleFactor ( double *  pixelscalefactor )

pure virtual

Try to get the pixel scale factor.

Parameters

[in,out]

pixelscalefactor

If non-null and successful, the pixel scale factor is placed here.

Returns

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

TryGetReadOutRate()

virtual bool libCZI::IDimensionChannelDetectorSettings::TryGetReadOutRate ( double *  readoutrate )

pure virtual

Try to get the read out rate

Parameters

[in,out]

readoutrate

If non-null and successful, the read out rate is placed here.

Returns

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

TryGetShutter()

virtual bool libCZI::IDimensionChannelDetectorSettings::TryGetShutter ( ChannelDetectorSettingsShutter *  shutter )

pure virtual

Try to get the shutter mode.

Parameters

[in,out]

shutter

If non-null and successful, the shutter mode is placed here.

Returns

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

TryGetUseBrightnessContrastCorrection()

virtual bool libCZI::IDimensionChannelDetectorSettings::TryGetUseBrightnessContrastCorrection ( bool *  usebrightnesscontrastcorrection )

pure virtual

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

Parameters

[in,out]

usebrightnesscontrastcorrection

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.

TryGetVoltage()

virtual bool libCZI::IDimensionChannelDetectorSettings::TryGetVoltage ( double *  voltage )

pure virtual

Try to get the voltage.

Parameters

[in,out]

voltage

If non-null and successful, the voltage is placed here.

Returns

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

---

The documentation for this class was generated from the following file:

• libCZI/libCZI_Metadata2.h