libCZI
Reading and Writing CZI documents made easy
Classes | Public Member Functions | List of all members
libCZI::IDimensionChannelLightSourcesSetting Class Referenceabstract

The light sources settings. More...

#include <libCZI_Metadata2.h>

Classes

struct  Polarization
 Description of the polarization. More...
 

Public Member Functions

virtual bool TryGetLightSourceRef (std::wstring *lightsourceref)=0
 
virtual bool TryGetWavelength (double *wavelength)=0
 
virtual bool TryGetAttenuation (double *attenuation)=0
 
virtual bool TryGetTransmission (double *transmission)=0
 
virtual bool TryGetIntensity (std::wstring *intensity)=0
 
virtual bool TryGetFlashDuration (double *flashduration)=0
 
virtual bool TryGetTIRFAngle (double *tirfangle)=0
 
virtual bool TryGetTIRFDepthOfPenetration (double *tirfdepthofpenetration)=0
 
virtual bool TryGetIsTIRFCalibrated (bool *isTIRFcalibrated)=0
 
virtual bool TryGetIsNlo (bool *isnlo)=0
 
virtual bool TryGetPolarization (Polarization *polarization)=0
 

Detailed Description

The light sources settings.

Member Function Documentation

◆ TryGetAttenuation()

virtual bool libCZI::IDimensionChannelLightSourcesSetting::TryGetAttenuation ( double *  attenuation)
pure virtual

Try to get the attenuation.

Parameters
[in,out]attenuationIf 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]flashdurationIf 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]intensityIf 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]isnloIf 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]isTIRFcalibratedIf 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]lightsourcerefIf 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]polarizationIf 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]tirfangleIf 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]tirfdepthofpenetrationIf 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]transmissionIf 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]wavelengthIf 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: