Class IFastAiryScanSettings#
Defined in File libCZI_Metadata2.h
Nested Relationships#
Nested Types#
Class Documentation#
-
class IFastAiryScanSettings#
The fast airy scan settings.
Public Functions
-
virtual bool TryGetIlluminationLinePixels(Vector *illuminationLinePixels) = 0#
Try to get the illumination line in pixels.
- Parameters:
illuminationLinePixels – [inout] If non-null and successful, the illumination line in pixels is placed here.
- Returns:
{bool} True if it succeeds, false if it fails.
-
virtual bool TryGetIlluminationLine(Vector *illuminationLine) = 0#
Try to get the illumination line.
- Parameters:
illuminationLine – [inout] If non-null and successful, the illumination line is placed here.
- Returns:
{bool} True if it succeeds, false if it fails.
-
virtual bool TryGetFiberMapping(std::vector<int> *mapping) = 0#
Try to get the fiber mapping.
- Parameters:
mapping – [inout] If non-null and successful, the fiber mapping is placed here.
- Returns:
{bool} True if it succeeds, false if it fails.
-
virtual bool TryGetEffectiveNAinX(double *effectiveNAinX) = 0#
Try to get the effective numerical aperture in x direction.
- Parameters:
effectiveNAinX – [inout] 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.
-
virtual bool TryGetEffectiveNAinY(double *effectiveNAinY) = 0#
Try to get the effective numerical aperture in y direction.
- Parameters:
effectiveNAinY – [inout] 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.
-
virtual ~IFastAiryScanSettings() = default#
-
struct Vector#
A 2D-vector.
-
virtual bool TryGetIlluminationLinePixels(Vector *illuminationLinePixels) = 0#