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

The SIM (Structured Illumination Microscopy) settings. More...

#include <libCZI_Metadata2.h>

Public Member Functions

virtual bool TryGetSIMDeviceRef (std::wstring *simDeviceRef)=0
 
virtual bool TryGetGratingPeriod (double *gratingPeriod)=0
 
virtual bool TryGetGratingRotation (double *gratingRotation)=0
 
virtual bool TryGetGridDescription (std::wstring *gridDescription)=0
 
virtual bool TryGetReflector (std::wstring *reflector)=0
 
virtual bool TryGetFilterSetRef (std::wstring *filterSetRef)=0
 
virtual bool TryGetDiffractionEfficiency1 (double *diffractionEfficiency1)=0
 
virtual bool TryGetDiffractionEfficiency2 (double *diffractionEfficiency2)=0
 
virtual bool TryGetDiffractionEfficiency3 (double *diffractionEfficiency3)=0
 

Detailed Description

The SIM (Structured Illumination Microscopy) settings.

Member Function Documentation

◆ TryGetDiffractionEfficiency1()

virtual bool libCZI::IDimensionChannelSIMSettings::TryGetDiffractionEfficiency1 ( double *  diffractionEfficiency1)
pure virtual

Try to get the diffraction efficiency for diffraction order -1.

Parameters
[in,out]diffractionEfficiency1If non-null and successful, the diffraction efficiency for diffraction order -1 is placed here.
Returns
{bool} True if it succeeds, false if it fails.

◆ TryGetDiffractionEfficiency2()

virtual bool libCZI::IDimensionChannelSIMSettings::TryGetDiffractionEfficiency2 ( double *  diffractionEfficiency2)
pure virtual

Try to get the diffraction efficiency for diffraction order 0.

Parameters
[in,out]diffractionEfficiency2If non-null and successful, the diffraction efficiency for diffraction order 0 is placed here.
Returns
{bool} True if it succeeds, false if it fails.

◆ TryGetDiffractionEfficiency3()

virtual bool libCZI::IDimensionChannelSIMSettings::TryGetDiffractionEfficiency3 ( double *  diffractionEfficiency3)
pure virtual

Try to get the diffraction efficiency for diffraction order 1.

Parameters
[in,out]diffractionEfficiency3If non-null and successful, the diffraction efficiency for diffraction order 1 is placed here.
Returns
{bool} True if it succeeds, false if it fails.

◆ TryGetFilterSetRef()

virtual bool libCZI::IDimensionChannelSIMSettings::TryGetFilterSetRef ( std::wstring *  filterSetRef)
pure virtual

Try to get reference to filter set.

Parameters
[in,out]filterSetRefIf non-null and successful, the reference to the filter set is placed here.
Returns
{bool} True if it succeeds, false if it fails.

◆ TryGetGratingPeriod()

virtual bool libCZI::IDimensionChannelSIMSettings::TryGetGratingPeriod ( double *  gratingPeriod)
pure virtual

Try to get the grating period.

Parameters
[in,out]gratingPeriodIf non-null and successful, the grating period is placed here.
Returns
{bool} True if it succeeds, false if it fails.

◆ TryGetGratingRotation()

virtual bool libCZI::IDimensionChannelSIMSettings::TryGetGratingRotation ( double *  gratingRotation)
pure virtual

Try to get the grating rotation-

Parameters
[in,out]gratingRotationIf non-null and successful, the grating rotation is placed here.
Returns
{bool} True if it succeeds, false if it fails.

◆ TryGetGridDescription()

virtual bool libCZI::IDimensionChannelSIMSettings::TryGetGridDescription ( std::wstring *  gridDescription)
pure virtual

Try to get the grid description.

Parameters
[in,out]gridDescriptionIf non-null and successful, information describing the grid is placed here.
Returns
{bool} True if it succeeds, false if it fails.

◆ TryGetReflector()

virtual bool libCZI::IDimensionChannelSIMSettings::TryGetReflector ( std::wstring *  reflector)
pure virtual

Try to get reference to reflector.

Parameters
[in,out]reflectorIf non-null and successful, the reference to the reflector is placed here.
Returns
{bool} True if it succeeds, false if it fails.

◆ TryGetSIMDeviceRef()

virtual bool libCZI::IDimensionChannelSIMSettings::TryGetSIMDeviceRef ( std::wstring *  simDeviceRef)
pure virtual

Try to get reference to the SIM device.

Parameters
[in,out]simDeviceRefIf non-null and successful, the reference to the SIM device is placed here.
Returns
{bool} True if it succeeds, false if it fails.
The documentation for this class was generated from the following file: