Gocator API
 All Classes Files Functions Variables Typedefs Macros Groups Pages
GoSurfaceIntensityMsg Class Reference

Description

Represents a data message containing a surface intensity array.

Inherits kObject.

Public Member Functions

k32u GoSurfaceIntensityMsg_Exposure (GoSurfaceIntensityMsg msg)
 Gets the exposure. More...
 
kSize GoSurfaceIntensityMsg_Height (GoSurfaceIntensityMsg msg)
 Gets the height of the surface (row count). More...
 
k8u * GoSurfaceIntensityMsg_RowAt (GoSurfaceIntensityMsg msg, kSize index)
 Gets a pointer to a surface intensity row. More...
 
GoDataSource GoSurfaceIntensityMsg_Source (GoSurfaceIntensityMsg msg)
 Gets the profile source. More...
 
k32s GoSurfaceIntensityMsg_SurfaceId (GoSurfaceIntensityMsg msg)
 Gets the surface ID. More...
 
kSize GoSurfaceIntensityMsg_Width (GoSurfaceIntensityMsg msg)
 Gets the width of the surface (column count). More...
 
k32s GoSurfaceIntensityMsg_XOffset (GoSurfaceIntensityMsg msg)
 Gets the surface x-offset, in micrometers. More...
 
k32u GoSurfaceIntensityMsg_XResolution (GoSurfaceIntensityMsg msg)
 Gets the surface x-resolution, in nanometers. More...
 
k32s GoSurfaceIntensityMsg_YOffset (GoSurfaceIntensityMsg msg)
 Gets the surface y-offset, in micrometers. More...
 
k32u GoSurfaceIntensityMsg_YResolution (GoSurfaceIntensityMsg msg)
 Gets the surface y-resolution, in nanometers. More...
 

Member Function Documentation

k32u GoSurfaceIntensityMsg_Exposure ( GoSurfaceIntensityMsg  msg)

Gets the exposure.

Parameters
msgMessage object.
Returns
Exposure in uS.
kSize GoSurfaceIntensityMsg_Height ( GoSurfaceIntensityMsg  msg)

Gets the height of the surface (row count).

Parameters
msgMessage object.
Returns
Surface height.
k8u * GoSurfaceIntensityMsg_RowAt ( GoSurfaceIntensityMsg  msg,
kSize  index 
)

Gets a pointer to a surface intensity row.

Parameters
msgMessage object.
indexSurface intensity row index.
Returns
Data pointer.
GoDataSource GoSurfaceIntensityMsg_Source ( GoSurfaceIntensityMsg  msg)

Gets the profile source.

Parameters
msgMessage object.
Returns
Profile source.
k32s GoSurfaceIntensityMsg_SurfaceId ( GoSurfaceIntensityMsg  msg)

Gets the surface ID.

Parameters
msgMessage object.
Returns
Surface ID.
kSize GoSurfaceIntensityMsg_Width ( GoSurfaceIntensityMsg  msg)

Gets the width of the surface (column count).

Parameters
msgMessage object.
Returns
Surface width;
k32s GoSurfaceIntensityMsg_XOffset ( GoSurfaceIntensityMsg  msg)

Gets the surface x-offset, in micrometers.

Parameters
msgMessage object.
Returns
X offset (um).
k32u GoSurfaceIntensityMsg_XResolution ( GoSurfaceIntensityMsg  msg)

Gets the surface x-resolution, in nanometers.

Parameters
msgMessage object.
Returns
X resolution (nm).
k32s GoSurfaceIntensityMsg_YOffset ( GoSurfaceIntensityMsg  msg)

Gets the surface y-offset, in micrometers.

Parameters
msgMessage object.
Returns
Y offset (um).
k32u GoSurfaceIntensityMsg_YResolution ( GoSurfaceIntensityMsg  msg)

Gets the surface y-resolution, in nanometers.

Parameters
msgMessage object.
Returns
Y resolution (nm).

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