Class IDimensionChannelAiryscanSettings#

Class Documentation#

class IDimensionChannelAiryscanSettings#

The airy scan settings.

Public Types

enum class Mode : std::uint8_t#

Values that represent the mode.

Values:

enumerator SuperResolution#: An enum constant representing the super resolution option.

enumerator VirtualPinhole#: An enum constant representing the virtual pinhole option.

Public Functions

virtual bool TryGetMode(Mode *mode) = 0#

Try to get the mode.

Parameters:: mode – [inout] If non-null and successful, the mode is placed here.
Returns:: {bool} True if it succeeds, false if it fails.

virtual std::shared_ptr<IFastAiryScanSettings> GetFastAiryScanSettings() = 0#

Gets fast airy scan settings.

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

virtual bool TryGetVirtualPinholeSize(double *virtualPinholeSize) = 0#

Try to get the virtual pinhole size.

Parameters:: virtualPinholeSize – [inout] If non-null and successful, the size of the virtual pinhole is placed here.
Returns:: {bool} True if it succeeds, false if it fails.

virtual bool TryGetMagnification(double *magnification) = 0#

Try to get the magnification.

Parameters:: magnification – [inout] If non-null and successful, the magnification is placed here.
Returns:: {bool} True if it succeeds, false if it fails.

virtual bool TryGetTransformationXX(double *transformationXX) = 0#

Try to get the transformation for XX.

Parameters:: transformationXX – [inout] If non-null and successful, the transformation for XX is placed here.
Returns:: {bool} True if it succeeds, false if it fails.

virtual bool TryGetTransformationXY(double *transformationXY) = 0#

Try to get the transformation for XY.

Parameters:: transformationXY – [inout] If non-null and successful, the transformation for XY is placed here.
Returns:: {bool} True if it succeeds, false if it fails.

virtual bool TryGetTransformationYX(double *transformationYX) = 0#

Try to get the transformation for YX.

Parameters:: transformationYX – [inout] If non-null and successful, the transformation for YX is placed here.
Returns:: {bool} True if it succeeds, false if it fails.

virtual bool TryGetTransformationYY(double *transformationYY) = 0#

Try to get the transformation for YY.

Parameters:: transformationYY – [inout] If non-null and successful, the transformation for YY is placed here.
Returns:: {bool} True if it succeeds, false if it fails.