libCZI::IDimensionChannelLaserScanInfo Class Reference

Information about the laser scan. More...

#include <libCZI_Metadata2.h>

Public Member Functions
virtual bool	TryGetPixelTime (double *pixelTime)=0
virtual bool	TryGetLineTime (double *lineTime)=0
virtual bool	TryGetFrameTime (double *frameTime)=0
virtual bool	TryGetAveraging (int *averaging)=0
virtual bool	TryGetScanningMode (DimensionChannelLaserScanScanningMode *mode)=0
virtual bool	TryGetSampleRotation (double *sampleRotation)=0
virtual bool	TryGetSampleOffsetX (double *sampleOffsetX)=0
virtual bool	TryGetSampleOffsetY (double *sampleOffsetY)=0
virtual bool	TryGetScanDirection (DimensionChannelLaserScanScanDirection *scanDirection)=0
virtual bool	TryGetZoomX (double *zoomX)=0
virtual bool	TryGetZoomY (double *zoomY)=0
virtual bool	TryGetZoomZ (double *zoomZ)=0
virtual bool	TryGetCropOffset (double *cropOffset)=0
virtual bool	TryGetLaserAttenuatorMeas (double *laserAttenuatorMeas)=0
virtual bool	TryGetLaserBlanking (double *laserBlanking)=0
virtual bool	TryGetLaserAttenuatorBleach (double *laserAttenuatorBleach)=0
virtual bool	TryGetLineStep (std::uint32_t *lineStep)=0
virtual bool	TryGetScanSpeed (int *scanSpeed)=0
virtual bool	TryGetAveragingMethod (DimensionChannelLaserScanAveragingMethod *averagingMethod)=0
virtual bool	TryGetAveragingMode (DimensionChannelLaserScanAveragingMode *averagingMode)=0
virtual bool	TryGetLaserAttenuatorState (DimensionChannelLaserScanLaserAttenuatorState *attenuatorState)=0

Detailed Description

Information about the laser scan.

Member Function Documentation

TryGetAveraging()

virtual bool libCZI::IDimensionChannelLaserScanInfo::TryGetAveraging ( int *  averaging )

pure virtual

Try to get the averaging (how many times the scanning was repeated).

Parameters

[in,out]

averaging

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

Returns

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

TryGetAveragingMethod()

virtual bool libCZI::IDimensionChannelLaserScanInfo::TryGetAveragingMethod ( DimensionChannelLaserScanAveragingMethod *  averagingMethod )

pure virtual

Try to get the averaging method.

Parameters

[in,out]

averagingMethod

If non-null and successful, the averaging method is placed here.

Returns

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

TryGetAveragingMode()

virtual bool libCZI::IDimensionChannelLaserScanInfo::TryGetAveragingMode ( DimensionChannelLaserScanAveragingMode *  averagingMode )

pure virtual

Try to get the averaging mode.

Parameters

[in,out]

averagingMode

If non-null and successful, the averaging mode is placed here.

Returns

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

TryGetCropOffset()

virtual bool libCZI::IDimensionChannelLaserScanInfo::TryGetCropOffset ( double *  cropOffset )

pure virtual

Attempts to get the crop offset

Parameters

[in,out]

cropOffset

If non-null and successful, the crop offset is placed here.

Returns

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

TryGetFrameTime()

virtual bool libCZI::IDimensionChannelLaserScanInfo::TryGetFrameTime ( double *  frameTime )

pure virtual

Try to get the frame time.

Parameters

[in,out]

frameTime

If non-null and successful, the frame time is placed here.

Returns

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

TryGetLaserAttenuatorBleach()

virtual bool libCZI::IDimensionChannelLaserScanInfo::TryGetLaserAttenuatorBleach ( double *  laserAttenuatorBleach )

pure virtual

Try to get the attenuation of the laser for bleaching.

Parameters

[in,out]

laserAttenuatorBleach

If non-null, the attenuator of the laser for bleaching is placed here.

Returns

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

TryGetLaserAttenuatorMeas()

virtual bool libCZI::IDimensionChannelLaserScanInfo::TryGetLaserAttenuatorMeas ( double *  laserAttenuatorMeas )

pure virtual

Try to get the attenuation of the laser.

Parameters

[in,out]

laserAttenuatorMeas

If non-null and successful, the attenuation of the laser is placed here.

Returns

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

TryGetLaserAttenuatorState()

virtual bool libCZI::IDimensionChannelLaserScanInfo::TryGetLaserAttenuatorState ( DimensionChannelLaserScanLaserAttenuatorState *  attenuatorState )

pure virtual

Try to get the laser attenuator state

Parameters

[in,out]

attenuatorState

If non-null and successful, the laser attenuator state is placed here.

Returns

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

TryGetLaserBlanking()

virtual bool libCZI::IDimensionChannelLaserScanInfo::TryGetLaserBlanking ( double *  laserBlanking )

pure virtual

Try to get the laser blanking (time the laser is not active while re-positioning for the next scan line).

Parameters

[in,out]

laserBlanking

If non-null and successful, the laser blanking time is placed here.

Returns

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

TryGetLineStep()

virtual bool libCZI::IDimensionChannelLaserScanInfo::TryGetLineStep ( std::uint32_t *  lineStep )

pure virtual

Try to get the line step.

Parameters

[in,out]

lineStep

If non-null and successful, the line step is place here.

Returns

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

TryGetLineTime()

virtual bool libCZI::IDimensionChannelLaserScanInfo::TryGetLineTime ( double *  lineTime )

pure virtual

Try to get the line time.

Parameters

[in,out]

lineTime

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

Returns

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

TryGetPixelTime()

virtual bool libCZI::IDimensionChannelLaserScanInfo::TryGetPixelTime ( double *  pixelTime )

pure virtual

Try to get the pixel time.

Parameters

[in,out]

pixelTime

If non-null and successful, the pixel time is placed here.

Returns

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

TryGetSampleOffsetX()

virtual bool libCZI::IDimensionChannelLaserScanInfo::TryGetSampleOffsetX ( double *  sampleOffsetX )

pure virtual

Try to get the sample offset in x-direction.

Parameters

[in,out]

sampleOffsetX

If non-null and successful, the sample offset in x direction is placed here.

Returns

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

TryGetSampleOffsetY()

virtual bool libCZI::IDimensionChannelLaserScanInfo::TryGetSampleOffsetY ( double *  sampleOffsetY )

pure virtual

Try to get the sample offset in y-direction.

Parameters

[in,out]

sampleOffsetY

If non-null and successful, the sample offset in y direction is placed here.

Returns

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

TryGetSampleRotation()

virtual bool libCZI::IDimensionChannelLaserScanInfo::TryGetSampleRotation ( double *  sampleRotation )

pure virtual

Try to get the sample rotation.

Parameters

[in,out]

sampleRotation

If non-null and successful, the sample rotation is placed here.

Returns

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

TryGetScanDirection()

virtual bool libCZI::IDimensionChannelLaserScanInfo::TryGetScanDirection ( DimensionChannelLaserScanScanDirection *  scanDirection )

pure virtual

Try to get the scan direction.

Parameters

[in,out]

scanDirection

If non-null and successful, the scan direction is placed here.

Returns

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

TryGetScanningMode()

virtual bool libCZI::IDimensionChannelLaserScanInfo::TryGetScanningMode ( DimensionChannelLaserScanScanningMode *  mode )

pure virtual

Try to get the scanning mode.

Parameters

[in,out]

mode

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

Returns

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

TryGetScanSpeed()

virtual bool libCZI::IDimensionChannelLaserScanInfo::TryGetScanSpeed ( int *  scanSpeed )

pure virtual

Try to get the scan speed.

Parameters

[in,out]

scanSpeed

If non-null and successful, the scan speed is placed here.

Returns

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

TryGetZoomX()

virtual bool libCZI::IDimensionChannelLaserScanInfo::TryGetZoomX ( double *  zoomX )

pure virtual

Try to get the zoom in x direction.

Parameters

[in,out]

zoomX

If non-null, the zoom in x direction is placed here.

Returns

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

TryGetZoomY()

virtual bool libCZI::IDimensionChannelLaserScanInfo::TryGetZoomY ( double *  zoomY )

pure virtual

Try to get the zoom in y direction.

Parameters

[in,out]

zoomY

If non-null, the zoom in y direction is placed here.

Returns

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

TryGetZoomZ()

virtual bool libCZI::IDimensionChannelLaserScanInfo::TryGetZoomZ ( double *  zoomZ )

pure virtual

Try to get the zoom in z direction.

Parameters

[in,out]

zoomZ

If non-null, the zoom in z direction 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