libCZI
Reading and Writing CZI documents made easy
Loading...
Searching...
No Matches
libCZI::IDimensionChannelAiryscanSettings Class Referenceabstract

The airy scan settings. More...

#include <libCZI_Metadata2.h>

Public Types

enum class  Mode : std::uint8_t { SuperResolution , VirtualPinhole , MultiBeam , Off }
 Values that represent the mode. More...
 

Public Member Functions

virtual bool TryGetMode (Mode *mode)=0
 
virtual std::shared_ptr< IFastAiryScanSettingsGetFastAiryScanSettings ()=0
 
virtual bool TryGetVirtualPinholeSize (double *virtualPinholeSize)=0
 
virtual bool TryGetMagnification (double *magnification)=0
 
virtual bool TryGetTransformationXX (double *transformationXX)=0
 
virtual bool TryGetTransformationXY (double *transformationXY)=0
 
virtual bool TryGetTransformationYX (double *transformationYX)=0
 
virtual bool TryGetTransformationYY (double *transformationYY)=0
 

Detailed Description

The airy scan settings.

Member Enumeration Documentation

◆ Mode

enum class libCZI::IDimensionChannelAiryscanSettings::Mode : std::uint8_t
strong

Values that represent the mode.

Enumerator
SuperResolution 

An enum constant representing the super resolution option.

VirtualPinhole 

An enum constant representing the virtual pinhole option.

MultiBeam 

An enum constant representing the multi beam option.

Off 

An enum constant representing the off option.

Member Function Documentation

◆ GetFastAiryScanSettings()

virtual std::shared_ptr< IFastAiryScanSettings > libCZI::IDimensionChannelAiryscanSettings::GetFastAiryScanSettings ( )
pure virtual

Gets fast airy scan settings.

Returns
The fast airy scan settings object if successful, and empty pointer otherwise.

◆ TryGetMagnification()

virtual bool libCZI::IDimensionChannelAiryscanSettings::TryGetMagnification ( double *  magnification)
pure virtual

Try to get the magnification.

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

◆ TryGetMode()

virtual bool libCZI::IDimensionChannelAiryscanSettings::TryGetMode ( Mode mode)
pure virtual

Try to get the mode.

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

◆ TryGetTransformationXX()

virtual bool libCZI::IDimensionChannelAiryscanSettings::TryGetTransformationXX ( double *  transformationXX)
pure virtual

Try to get the transformation for XX.

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

◆ TryGetTransformationXY()

virtual bool libCZI::IDimensionChannelAiryscanSettings::TryGetTransformationXY ( double *  transformationXY)
pure virtual

Try to get the transformation for XY.

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

◆ TryGetTransformationYX()

virtual bool libCZI::IDimensionChannelAiryscanSettings::TryGetTransformationYX ( double *  transformationYX)
pure virtual

Try to get the transformation for YX.

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

◆ TryGetTransformationYY()

virtual bool libCZI::IDimensionChannelAiryscanSettings::TryGetTransformationYY ( double *  transformationYY)
pure virtual

Try to get the transformation for YY.

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

◆ TryGetVirtualPinholeSize()

virtual bool libCZI::IDimensionChannelAiryscanSettings::TryGetVirtualPinholeSize ( double *  virtualPinholeSize)
pure virtual

Try to get the virtual pinhole size.

Parameters
[in,out]virtualPinholeSizeIf non-null and successful, the size of the virtual pinhole is placed here.
Returns
{bool} True if it succeeds, false if it fails.

The documentation for this class was generated from the following file: