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

The settings of the SPIM galvo scanner. More...

#include <libCZI_Metadata2.h>

Public Member Functions

virtual bool TryGetAmplitudeYScan (double *amplitudeYScan)=0
 
virtual bool TryGetFrequency (double *frequency)=0
 
virtual bool TryGetOffset1Left (double *offset1Left)=0
 
virtual bool TryGetOffset1Right (double *offset1Right)=0
 
virtual bool TryGetOffset2Left (double *offset2Left)=0
 
virtual bool TryGetOffset2Right (double *offset2Right)=0
 

Detailed Description

The settings of the SPIM galvo scanner.

Member Function Documentation

◆ TryGetAmplitudeYScan()

virtual bool libCZI::ISPIMIlluminationGalvoScannerSettings::TryGetAmplitudeYScan ( double *  amplitudeYScan)
pure virtual

Try to get the amplitude in y direction.

Parameters
[in,out]amplitudeYScanIf non-null and successful, the amplitude amplitude in y direction is placed here.
Returns
{bool} True if it succeeds, false if it fails.

◆ TryGetFrequency()

virtual bool libCZI::ISPIMIlluminationGalvoScannerSettings::TryGetFrequency ( double *  frequency)
pure virtual

Try to get the frequency.

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

◆ TryGetOffset1Left()

virtual bool libCZI::ISPIMIlluminationGalvoScannerSettings::TryGetOffset1Left ( double *  offset1Left)
pure virtual

Try to get the "offset 1 left".

Parameters
[in,out]offset1LeftIf non-null and successful, the "offset 1 left" is placed here.
Returns
{bool} True if it succeeds, false if it fails.

◆ TryGetOffset1Right()

virtual bool libCZI::ISPIMIlluminationGalvoScannerSettings::TryGetOffset1Right ( double *  offset1Right)
pure virtual

Try to get the "offset 1 right".

Parameters
[in,out]offset1RightIf non-null and successful, the "offset 1 right" is placed here.
Returns
{bool} True if it succeeds, false if it fails.

◆ TryGetOffset2Left()

virtual bool libCZI::ISPIMIlluminationGalvoScannerSettings::TryGetOffset2Left ( double *  offset2Left)
pure virtual

Try to get the "offset 2 left".

Parameters
[in,out]offset2LeftIf non-null and successful, the "offset 2 left" is placed here.
Returns
{bool} True if it succeeds, false if it fails.

◆ TryGetOffset2Right()

virtual bool libCZI::ISPIMIlluminationGalvoScannerSettings::TryGetOffset2Right ( double *  offset2Right)
pure virtual

Try to get the "offset 2 right".

Parameters
[in,out]offset2RightIf non-null and successful, the "offset 2 right" is placed here.
Returns
{bool} True if it succeeds, false if it fails.
The documentation for this class was generated from the following file: