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

Description

Represents a data message containing a set of profile intensity arrays.

Inherits kObject.

Public Member Functions

k8u * GoProfileIntensityMsg_At (GoProfileIntensityMsg msg, kSize index)
 Gets a pointer to a profile intensity array. More...
 
kSize GoProfileIntensityMsg_Count (GoProfileIntensityMsg msg)
 Gets the count of profile intensity arrays in this message. More...
 
k32u GoProfileIntensityMsg_Exposure (GoProfileIntensityMsg msg)
 Gets the exposure. More...
 
kBool GoProfileIntensityMsg_IsResampled (GoProfileIntensityMsg msg)
 Gets the associated profile type (points or ranges). More...
 
GoDataSource GoProfileIntensityMsg_Source (GoProfileIntensityMsg msg)
 Gets the profile source. More...
 
kSize GoProfileIntensityMsg_Width (GoProfileIntensityMsg msg)
 Gets the count of intensity values in each profile intensity array. More...
 
k32s GoProfileIntensityMsg_XOffset (GoProfileIntensityMsg msg)
 Gets the profile x-offset, in micrometers. More...
 
k32u GoProfileIntensityMsg_XResolution (GoProfileIntensityMsg msg)
 Gets the x-resolution, in nanometers. More...
 
k32s GoProfileIntensityMsg_ZOffset (GoProfileIntensityMsg msg)
 Gets the profile z-offset, in micrometers. More...
 
k32u GoProfileIntensityMsg_ZResolution (GoProfileIntensityMsg msg)
 Gets the profile z-resolution, in nanometers. More...
 

Member Function Documentation

k8u * GoProfileIntensityMsg_At ( GoProfileIntensityMsg  msg,
kSize  index 
)

Gets a pointer to a profile intensity array.

Parameters
msgMessage object.
indexProfile intensity array index.
Returns
Data pointer.
kSize GoProfileIntensityMsg_Count ( GoProfileIntensityMsg  msg)

Gets the count of profile intensity arrays in this message.

Parameters
msgMessage object.
Returns
Count of profile arrays.
k32u GoProfileIntensityMsg_Exposure ( GoProfileIntensityMsg  msg)

Gets the exposure.

Parameters
msgMessage object.
Returns
Exposure in uS.
kBool GoProfileIntensityMsg_IsResampled ( GoProfileIntensityMsg  msg)

Gets the associated profile type (points or ranges).

Parameters
msgMessage object.
Returns
kTRUE for ranges; kFALSE for points.
GoDataSource GoProfileIntensityMsg_Source ( GoProfileIntensityMsg  msg)

Gets the profile source.

Parameters
msgMessage object.
Returns
Profile source.
kSize GoProfileIntensityMsg_Width ( GoProfileIntensityMsg  msg)

Gets the count of intensity values in each profile intensity array.

Parameters
msgMessage object.
Returns
Intensity count.
k32s GoProfileIntensityMsg_XOffset ( GoProfileIntensityMsg  msg)

Gets the profile x-offset, in micrometers.

Parameters
msgMessage object.
Returns
X offset (um).
k32u GoProfileIntensityMsg_XResolution ( GoProfileIntensityMsg  msg)

Gets the x-resolution, in nanometers.

Parameters
msgMessage object.
Returns
X resolution (nm).
k32s GoProfileIntensityMsg_ZOffset ( GoProfileIntensityMsg  msg)

Gets the profile z-offset, in micrometers.

Parameters
msgMessage object.
Returns
Z offset (um).
k32u GoProfileIntensityMsg_ZResolution ( GoProfileIntensityMsg  msg)

Gets the profile z-resolution, in nanometers.

Parameters
msgMessage object.
Returns
Z resolution (nm).

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