The light sources settings.
More...
#include <libCZI_Metadata2.h>
The light sources settings.
◆ TryGetAttenuation()
virtual bool libCZI::IDimensionChannelLightSourcesSetting::TryGetAttenuation |
( |
double * |
attenuation | ) |
|
|
pure virtual |
Try to get the attenuation.
- Parameters
-
[in,out] | attenuation | If non-null and successful, the attenuation is placed here. |
- Returns
- {bool} True if it succeeds, false if it fails.
◆ TryGetFlashDuration()
virtual bool libCZI::IDimensionChannelLightSourcesSetting::TryGetFlashDuration |
( |
double * |
flashduration | ) |
|
|
pure virtual |
Try to get the flash duration.
- Parameters
-
[in,out] | flashduration | If non-null and successful, the flash duration is placed here. |
- Returns
- {bool} True if it succeeds, false if it fails.
◆ TryGetIntensity()
virtual bool libCZI::IDimensionChannelLightSourcesSetting::TryGetIntensity |
( |
std::wstring * |
intensity | ) |
|
|
pure virtual |
Try to get the intensity.
- Parameters
-
[in,out] | intensity | If non-null and successful, the intensity is placed here. |
- Returns
- {bool} True if it succeeds, false if it fails.
◆ TryGetIsNlo()
virtual bool libCZI::IDimensionChannelLightSourcesSetting::TryGetIsNlo |
( |
bool * |
isnlo | ) |
|
|
pure virtual |
Try to get a boolean indicating whether a tunable laser line was used.
- Parameters
-
[in,out] | isnlo | If non-null and successful, a boolean indicating whether a tunable laser line was used is placed here. |
- Returns
- {bool} True if it succeeds, false if it fails.
◆ TryGetIsTIRFCalibrated()
virtual bool libCZI::IDimensionChannelLightSourcesSetting::TryGetIsTIRFCalibrated |
( |
bool * |
isTIRFcalibrated | ) |
|
|
pure virtual |
Try to get a boolean indicating whether TIRF was calibrated.
- Parameters
-
[in,out] | isTIRFcalibrated | If non-null and successful, a boolean indicating whether TIRF was calibrated is placed here. |
- Returns
- {bool} True if it succeeds, false if it fails.
◆ TryGetLightSourceRef()
virtual bool libCZI::IDimensionChannelLightSourcesSetting::TryGetLightSourceRef |
( |
std::wstring * |
lightsourceref | ) |
|
|
pure virtual |
Try to get the light source reference
- Parameters
-
[in,out] | lightsourceref | If non-null, the lightsourceref. |
- Returns
- {bool} True if it succeeds, false if it fails.
◆ TryGetPolarization()
virtual bool libCZI::IDimensionChannelLightSourcesSetting::TryGetPolarization |
( |
Polarization * |
polarization | ) |
|
|
pure virtual |
Try to get polarization information.
- Parameters
-
[in,out] | polarization | If non-null and successful, the polarization information is placed here. |
- Returns
- {bool} True if it succeeds, false if it fails.
◆ TryGetTIRFAngle()
virtual bool libCZI::IDimensionChannelLightSourcesSetting::TryGetTIRFAngle |
( |
double * |
tirfangle | ) |
|
|
pure virtual |
Try to get the TIRF angle.
- Parameters
-
[in,out] | tirfangle | If non-null and successful, the TIRF angle is placed here. |
- Returns
- {bool} True if it succeeds, false if it fails.
◆ TryGetTIRFDepthOfPenetration()
virtual bool libCZI::IDimensionChannelLightSourcesSetting::TryGetTIRFDepthOfPenetration |
( |
double * |
tirfdepthofpenetration | ) |
|
|
pure virtual |
Try to get the TIRF depth of penetration.
- Parameters
-
[in,out] | tirfdepthofpenetration | If non-null and successful, the TIRF depth of penetration is placed here. |
- Returns
- {bool} True if it succeeds, false if it fails.
◆ TryGetTransmission()
virtual bool libCZI::IDimensionChannelLightSourcesSetting::TryGetTransmission |
( |
double * |
transmission | ) |
|
|
pure virtual |
Try to get the transmission.
- Parameters
-
[in,out] | transmission | If non-null and successful, the transmission is placed here. |
- Returns
- {bool} True if it succeeds, false if it fails.
◆ TryGetWavelength()
virtual bool libCZI::IDimensionChannelLightSourcesSetting::TryGetWavelength |
( |
double * |
wavelength | ) |
|
|
pure virtual |
Try to get the wavelength.
- Parameters
-
[in,out] | wavelength | If non-null and successful, the wavelength is placed here. |
- Returns
- {bool} True if it succeeds, false if it fails.
The documentation for this class was generated from the following file: