libCZI::IFastAiryScanSettings Class Reference

The fast airy scan settings. More...

#include <libCZI_Metadata2.h>

Classes
struct	Vector
	A 2D-vector. More...

Public Member Functions
virtual bool	TryGetIlluminationLinePixels (Vector *illuminationLinePixels)=0
virtual bool	TryGetIlluminationLine (Vector *illuminationLine)=0
virtual bool	TryGetFiberMapping (std::vector< int > *mapping)=0
virtual bool	TryGetEffectiveNAinX (double *effectiveNAinX)=0
virtual bool	TryGetEffectiveNAinY (double *effectiveNAinY)=0

Detailed Description

The fast airy scan settings.

Member Function Documentation

TryGetEffectiveNAinX()

virtual bool libCZI::IFastAiryScanSettings::TryGetEffectiveNAinX ( double *  effectiveNAinX )

pure virtual

Try to get the effective numerical aperture in x direction.

Parameters

[in,out]

effectiveNAinX

If non-null and successful, the effective numerical aperture in x direction is placed here.

Returns

{bool} True if it succeeds, false if it fails.

TryGetEffectiveNAinY()

virtual bool libCZI::IFastAiryScanSettings::TryGetEffectiveNAinY ( double *  effectiveNAinY )

pure virtual

Try to get the effective numerical aperture in y direction.

Parameters

[in,out]

effectiveNAinY

If non-null and successful, the effective numerical aperture in y direction is placed here.

Returns

{bool} True if it succeeds, false if it fails.

TryGetFiberMapping()

virtual bool libCZI::IFastAiryScanSettings::TryGetFiberMapping ( std::vector< int > *  mapping )

pure virtual

Try to get the fiber mapping.

Parameters

[in,out]

mapping

If non-null and successful, the fiber mapping is placed here.

Returns

{bool} True if it succeeds, false if it fails.

TryGetIlluminationLine()

virtual bool libCZI::IFastAiryScanSettings::TryGetIlluminationLine ( Vector *  illuminationLine )

pure virtual

Try to get the illumination line.

Parameters

[in,out]

illuminationLine

If non-null and successful, the illumination line is placed here.

Returns

{bool} True if it succeeds, false if it fails.

TryGetIlluminationLinePixels()

virtual bool libCZI::IFastAiryScanSettings::TryGetIlluminationLinePixels ( Vector *  illuminationLinePixels )

pure virtual

Try to get the illumination line in pixels.

Parameters

[in,out]

illuminationLinePixels

If non-null and successful, the illumination line in pixels is placed here.

Returns

{bool} True if it succeeds, false if it fails.

---

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

• libCZI/libCZI_Metadata2.h