SK91USB3-LX  1.2.0
Functions
Camera informations

This pages explains you how to get informations from the camera. More...

Functions

const char * SK_GETCAMTYPE (int CamID)
 Reads camera type as string. More...
 
const char * SK_GETCAMFAMILY (int CamID)
 Returns the camera family as string. More...
 
double SK_GETREVISION (int CamID, const char *strRev, unsigned int sizeOfBuffer)
 Query revision number of the camera. More...
 
int SK_GETSN (int CamID, const char *strSN, unsigned int sizeOfBuffer)
 Query for serial number of the camera. More...
 
int SK_GETUSBVERSION (int CamID, const char *strUSB, unsigned int sizeOfBuffer)
 Returns the USB version of the camera. More...
 
int SK_GETPIXELSPERLINE (int CamID)
 Returns the number of pixels per line. More...
 
int SK_GETBITSPERPIXEL (int CamID)
 Returns the number of bits per pixel. More...
 
int SK_GETBYTESPERPIXEL (int CamID)
 Returns the number of bytes per pixel. More...
 
int SK_GETBYTESPERLINE (int CamID)
 Returns the number of bytes per line. More...
 
int SK_GETPIXNUM (int CamID)
 Returns the number of physical pixels at the sensor. More...
 
double SK_GETPIXWIDTH (int CamID)
 Returns the pixel width of the sensor in microns. More...
 
double SK_GETPIXHEIGHT (int CamID)
 Returns the pixel height of the sensor in microns. More...
 
double SK_GETPIXDIST (int CamID)
 Returns the vertical pixel distance of the sensor in microns. More...
 
double SK_GETSENSORLENGTH (int CamID)
 Returns the physical sensor length in millimeters. More...
 
double SK_GETSENSORDYNAMIC (int CamID)
 Returns the sensor specific dynamic range. More...
 
int SK_ISTYPEDIGITAL (int CamID)
 Returns the type (digital or analog) of the camera. More...
 
int SK_ISTYPECOLOR (int CamID)
 Returns kind of camera type. More...
 
int SK_ISTYPEANTIBLOOM (int CamID)
 Query for anti-blooming feature of the sensor. More...
 
int SK_ISTYPEINTCTRL (int CamID)
 Query for integration control feature of the sensor. More...
 

Detailed Description

This pages explains you how to get informations from the camera.

Function Documentation

int SK_GETBITSPERPIXEL ( int  CamID)

Returns the number of bits per pixel.

The return values for bits per pixel are:

bits per pixel resolution
8 8 bit resolution gray scale
12 12 bit resolution gray scale
24 8 bit resolution color
48 12 bit resolution color
Remarks
The result depends on the programmed output data format.
Parameters
CamIDid of camera from 0 ... n - 1, 0 = 1st camera
Returns
number of bits per pixel, else see Error Code Table
int SK_GETBYTESPERLINE ( int  CamID)

Returns the number of bytes per line.

Remarks
The result depends on the programmed output data format.
Parameters
CamIDid of camera from 0 ... n - 1, 0 = 1st camera
Returns
number of bytes per line, else see Error Code Table
int SK_GETBYTESPERPIXEL ( int  CamID)

Returns the number of bytes per pixel.

The return values for bytes per pixel are:

bytes per pixel resolution
1 8 bit resolution gray scale
2 12 bit resolution gray scale
3 8 bit resolution color
6 12 bit resolution color
Remarks
The result depends on the programmed output data format.
Parameters
CamIDid of camera from 0 ... n - 1, 0 = 1st camera
Returns
number of bytes per pixel, else see Error Code Table
const char* SK_GETCAMFAMILY ( int  CamID)

Returns the camera family as string.

Parameters
CamIDid of camera from 0 ... n - 1, 0 = 1st camera
Returns
string with name of camera family, else nullptr
const char* SK_GETCAMTYPE ( int  CamID)

Reads camera type as string.

Parameters
CamIDid of camera from 0 ... n - 1, 0 = 1st camera
Returns
string with name of camera type, else nullptr
double SK_GETPIXDIST ( int  CamID)

Returns the vertical pixel distance of the sensor in microns.

Remarks
At color triple line sensors it is the absolute line spacing between red, green, and blue in microns.
Parameters
CamIDid of camera from 0 ... n - 1, 0 = 1st camera
Returns
vertical pixel distance in microns, else see Error Code Table
int SK_GETPIXELSPERLINE ( int  CamID)

Returns the number of pixels per line.

Remarks
The result is independet from the data output format. Note also SK_GETBYTESPERPIXEL for calculating size of line in bytes.
Parameters
CamIDid of camera from 0 ... n - 1, 0 = 1st camera
Returns
pixels per line, else see Error Code Table
double SK_GETPIXHEIGHT ( int  CamID)

Returns the pixel height of the sensor in microns.

Parameters
CamIDid of camera from 0 ... n - 1, 0 = 1st camera
Returns
pixel height of the sensor in microns, else see Error Code Table
int SK_GETPIXNUM ( int  CamID)

Returns the number of physical pixels at the sensor.

Remarks
At color line scan cameras it is the sum of red, green and blue pixels of one line.
Parameters
CamIDid of camera from 0 ... n - 1, 0 = 1st camera
Returns
number of sensor pixels, else see Error Code Table
double SK_GETPIXWIDTH ( int  CamID)

Returns the pixel width of the sensor in microns.

Parameters
CamIDid of camera from 0 ... n - 1, 0 = 1st camera
Returns
pixel width of the sensor in microns, else see Error Code Table
double SK_GETREVISION ( int  CamID,
const char *  strRev,
unsigned int  sizeOfBuffer 
)

Query revision number of the camera.

Parameters
CamIDid of camera from 0 ... n - 1, 0 = 1st camera
strRevpointer to a buffer to store the revision number as string
sizeOfBuffersize of the user managed string buffer
Returns
revision number, else see Error Code Table
double SK_GETSENSORDYNAMIC ( int  CamID)

Returns the sensor specific dynamic range.

Parameters
CamIDid of camera from 0 ... n - 1, 0 = 1st camera
Returns
dynamic range, else see Error Code Table
double SK_GETSENSORLENGTH ( int  CamID)

Returns the physical sensor length in millimeters.

Parameters
CamIDid of camera from 0 ... n - 1, 0 = 1st camera
Returns
physical sensor length in millimeters, else see Error Code Table
int SK_GETSN ( int  CamID,
const char *  strSN,
unsigned int  sizeOfBuffer 
)

Query for serial number of the camera.

Parameters
CamIDid of camera from 0 ... n - 1, 0 = 1st camera
strSNpointer to a buffer to store the serial number as string
sizeOfBuffersize of the user managed string buffer
Returns
serial number, else see Error Code Table
int SK_GETUSBVERSION ( int  CamID,
const char *  strUSB,
unsigned int  sizeOfBuffer 
)

Returns the USB version of the camera.

Note
Reasons for return of 2, or 'USB 2.0' can be
  • a unqualified cable, which is not specified for Super Speed
  • the camera is plugged at a USB 2.0 connector
Parameters
CamIDid of camera from 0 ... n - 1, 0 = 1st camera
strUSBpointer to a buffer to store the USB version as string
sizeOfBuffersize of the user managed string buffer
Returns
USB version as number (e.g. 3 or 2), else see Error Code Table
int SK_ISTYPEANTIBLOOM ( int  CamID)

Query for anti-blooming feature of the sensor.

Parameters
CamIDid of camera from 0 ... n - 1, 0 = 1st camera
Returns
0 = no anti-blooming sensor
1 = sensor is blooming-resistance
else see Error Code Table
int SK_ISTYPECOLOR ( int  CamID)

Returns kind of camera type.

Parameters
CamIDid of camera from 0 ... n - 1, 0 = 1st camera
Returns
0 = monochrome line scan camera
1 = color line scan camera
else see Error Code Table
int SK_ISTYPEDIGITAL ( int  CamID)

Returns the type (digital or analog) of the camera.

Parameters
CamIDid of camera from 0 ... n - 1, 0 = 1st camera
Returns
0 = analog line scan camera
1 = digital line scan camera
else see Error Code Table
int SK_ISTYPEINTCTRL ( int  CamID)

Query for integration control feature of the sensor.

Parameters
CamIDid of camera from 0 ... n - 1, 0 = 1st camera
Returns
0 = integration control not exists
1 = sensor has the integration control feature
else see Error Code Table