tsImageData Struct Reference

#include <clcamiface.h>

Public Types
enum	teImageType {   eeArea, eeBinned, eeMaskHorizontal, eeMaskVertical,   eeCustom, eeArea8 }

Data Fields
enum tsImageData::teImageType	meImageType
int	mnActiveCols
	Total number of columns (sensor dimensions)
int	mnActiveRows
	Total number of rows (sensor dimensions)
unsigned int	mnFrameSeqNo
int	mnHorBinSet
	Horizontal Binning Index.
unsigned int	mnImageNumber
	incrementing total frame count since connection
unsigned short	mnMaxPixel
int	mnNumCols
	number of columns captured
int	mnNumRows
	number of rows captured
int	mnStartCol
	first column of captured data
int	mnStartRow
	first row of captured data
int	mnVertBinSet
	Vertical Binning Index.
void *	mpData

---

Detailed Description

This structure defines the image data passed to the application from a IMAGEDATACALLBACK function callback.

---

Member Enumeration Documentation

enum tsImageData::teImageType

Describes the image type received.

Enumerator:

eeArea	area data read, mpData points to unsigned shorts (16 bits)
eeBinned	Vertical Binned data read, mpData points to signed integers (32 bits)
eeMaskHorizontal	Mask Binning mode, horizontal alignment, mpData points to signed integers (32 bits)
eeMaskVertical	Mask Binning mode, vertical alignment, mpData points to signed integers (32 bits)
eeCustom	Customer Customized image format.
eeArea8	area data read, mpData points to unsigned characters (8 bits)

---

Field Documentation

enum tsImageData::teImageType tsImageData::meImageType

int tsImageData::mnActiveCols

Total number of columns (sensor dimensions)

int tsImageData::mnActiveRows

Total number of rows (sensor dimensions)

unsigned int tsImageData::mnFrameSeqNo

Image number for current multiframe 

capture (1 to N, where N is number of frames requested)

int tsImageData::mnHorBinSet

Horizontal Binning Index.

unsigned int tsImageData::mnImageNumber

incrementing total frame count since connection

unsigned short tsImageData::mnMaxPixel

Maximum pixel value prior to digital binning for the image. Can be used to detect saturation conditions while digitally binning data.

int tsImageData::mnNumCols

number of columns captured

int tsImageData::mnNumRows

number of rows captured

int tsImageData::mnStartCol

first column of captured data

int tsImageData::mnStartRow

first row of captured data

int tsImageData::mnVertBinSet

Vertical Binning Index.

void* tsImageData::mpData

Data store for originating call.

For area reads performed using CLSetCCDArea and CLReadCCDArea commands, the data will be populated according to the area read ASSUMING a data block consistent with a NRxNC image size, where NR is the number of rows in the camera, and NC is the number of columns in the camera. E.G., if the user requests the first 20 columns from all 256 rows of a 256 row x 1024 column camera, pixels will be written to short (2 byte) offset positions 0-19, 1024-1043, ... 261120-261139. It is strongly recommended that users always allocate a full NRxNC short array buffer when working with the camera and area reads.

AreaByte reads are similar to area reads on the data is in the format of unsigned character data.

For binned reads performed using CLReadCCDBinned command, the data will be populated accordign to the binned rows read ASSUMING a data block consistent with NBRxNC image size, where NBR is the number of output binned rows (rows corresponding to the BIN_SEND opcode) and NC is the number of active columns in the camera. E.G., if the user creates a binning pattern that generates 2 binned output rows that have been horizontally binned two-to-1 of a 256 row x 1024 column camera, pixels will be written to integer (4 byte, signed) offset positions 0-512 and 1024-1536, of the buffer.

---

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

• clcamiface.h