Class IDimensionChannelLightSourcesSetting#
Defined in File libCZI_Metadata2.h
Nested Relationships#
Nested Types#
Class Documentation#
-
class IDimensionChannelLightSourcesSetting#
The light sources settings.
Public Functions
-
virtual bool TryGetLightSourceRef(std::wstring *lightsourceref) = 0#
Try to get the light source reference
- Parameters:
lightsourceref – [inout] If non-null, the lightsourceref.
- Returns:
{bool} True if it succeeds, false if it fails.
-
virtual bool TryGetWavelength(double *wavelength) = 0#
Try to get the wavelength.
- Parameters:
wavelength – [inout] If non-null and successful, the wavelength is placed here.
- Returns:
{bool} True if it succeeds, false if it fails.
-
virtual bool TryGetAttenuation(double *attenuation) = 0#
Try to get the attenuation.
- Parameters:
attenuation – [inout] If non-null and successful, the attenuation is placed here.
- Returns:
{bool} True if it succeeds, false if it fails.
-
virtual bool TryGetTransmission(double *transmission) = 0#
Try to get the transmission.
- Parameters:
transmission – [inout] If non-null and successful, the transmission is placed here.
- Returns:
{bool} True if it succeeds, false if it fails.
-
virtual bool TryGetIntensity(std::wstring *intensity) = 0#
Try to get the intensity.
- Parameters:
intensity – [inout] If non-null and successful, the intensity is placed here.
- Returns:
{bool} True if it succeeds, false if it fails.
-
virtual bool TryGetFlashDuration(double *flashduration) = 0#
Try to get the flash duration.
- Parameters:
flashduration – [inout] If non-null and successful, the flash duration is placed here.
- Returns:
{bool} True if it succeeds, false if it fails.
-
virtual bool TryGetTIRFAngle(double *tirfangle) = 0#
Try to get the TIRF angle.
- Parameters:
tirfangle – [inout] If non-null and successful, the TIRF angle is placed here.
- Returns:
{bool} True if it succeeds, false if it fails.
-
virtual bool TryGetTIRFDepthOfPenetration(double *tirfdepthofpenetration) = 0#
Try to get the TIRF depth of penetration.
- Parameters:
tirfdepthofpenetration – [inout] If non-null and successful, the TIRF depth of penetration is placed here.
- Returns:
{bool} True if it succeeds, false if it fails.
-
virtual bool TryGetIsTIRFCalibrated(bool *isTIRFcalibrated) = 0#
Try to get a boolean indicating whether TIRF was calibrated.
- Parameters:
isTIRFcalibrated – [inout] 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.
-
virtual bool TryGetIsNlo(bool *isnlo) = 0#
Try to get a boolean indicating whether a tunable laser line was used.
- Parameters:
isnlo – [inout] 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.
-
virtual bool TryGetPolarization(Polarization *polarization) = 0#
Try to get polarization information.
- Parameters:
polarization – [inout] If non-null and successful, the polarization information is placed here.
- Returns:
{bool} True if it succeeds, false if it fails.
-
virtual ~IDimensionChannelLightSourcesSetting() = default#
-
struct Polarization#
Description of the polarization.
-
virtual bool TryGetLightSourceRef(std::wstring *lightsourceref) = 0#