Image Manager (CVCDriver.dll) 14.1

Interface for acquiring images from a line scan device (deprecated!). More...

Typedefs

typedef cvbbool_t __stdcall * pLSBLOCKCALLBACK(cvbval_t NumBlocksPending, cvbdim_t StartLine, cvbdim_t NumLines, cvbbool_t LastBlock, void *pPrivate)
 This function is invoked when an image segment has been acquired.

The number of calls depends on how many blocks have been defined with the LSSetBlocksPerFrame function.
pLSBLOCKCALLBACK is a pointer to a callback function of the LineScan interface which is used by the LSGrab and LSSnap functions. To process a large line camera image better it is possible to subdivide the image logically into several small blocks. This means it is not necessary to wait until the entire image has been acquired before processing the image data. Instead, individual parts of the image can be processed one after another depending on the rate of acquisition. More...
 
typedef cvbbool_t __stdcall * pLSERRORCALLBACK(LSErrorCodes ErrorNumber, cvbval_t Data, void *pPrivate)
 This function is invoked when an error has occurred during acquisition.

pLSERRORCALLBACK is a pointer to a callback function of the LineScan interface which is used by the LSGrab and LSSnap functions. More...
 
typedef cvbbool_t __stdcall * pLSIMAGECALLBACK(cvbval_t NumImagesPending, cvbdim_t NumLines, void *pPrivate)
 This function is invoked when an entire image has been acquired.

pLSBLOCKCALLBACK is a pointer to a callback function of the LineScan interface which is used by the LSGrab and LSSnap functions. More...
 

Enumerations

enum  LSErrorCodes { CVC_LS_OK = 0 , CVC_LS_OVERRUN = 1 , CVC_LS_ERRORMAXCODES }
 Defines the error codes of the LineScan Interface. More...
 
enum  LSLineTriggerMode { CVC_LS_FREERUN = 0 , CVC_LS_EXTTRIGGER = 1 , CVC_LS_LINETRIGGERMAXMODES }
 Defines options of the polarity for ExSync/Prin. More...
 
enum  LSPolarity { CVC_LS_LO = 0 , CVC_LS_HI = 1 , CVC_LS_POLMAXMODES }
 Defines options of the polarity for ExSync/Prin. More...
 

Functions

cvbbool_t CanLineScan (IMG Image)
 This function verifies whether the image supports the LineScan interface. More...
 
cvbres_t LSFreeze (IMG Image)
 Stops continuous image acquisition that was started with the LSGrab function. More...
 
cvbres_t LSGetBlocksPerFrame (IMG Image, cvbval_t &lNumBlocks)
 Returns the number of blocks into which an image is subdivided. More...
 
cvbres_t LSGetBlocksPerFrameRange (IMG Image, cvbval_t &lMin, cvbval_t &lMax)
 Returns the minimum and maximum number of blocks into which an image can be subdivided. More...
 
cvbres_t LSGetExposureTime (IMG Image, cvbval_t &lExposureTime)
 Returns the current exposure time set for a single line. More...
 
cvbres_t LSGetExposureTimeRange (IMG Image, cvbval_t &lMin, cvbval_t &lMax)
 Returns the minimum and maximum exposure time possible for a single line. More...
 
cvbres_t LSGetExSyncPol (IMG Image, LSPolarity &lPol)
 Returns the current EXSYNC polarity. More...
 
cvbres_t LSGetImageHeight (IMG Image, cvbval_t &Lines)
 Returns the height of the current image in lines. More...
 
cvbres_t LSGetImageWidth (IMG Image, cvbdim_t &lStart, cvbdim_t &lWidth)
 Returns the width of the current image in pixels. More...
 
cvbres_t LSGetImageWidthRange (IMG Image, cvbdim_t &lMin, cvbdim_t &lMax)
 Returns the minimum and maximum image width. More...
 
cvbres_t LSGetLineRate (IMG Image, cvbval_t &lLineRate)
 Returns the current line rate. More...
 
cvbres_t LSGetLineRateRange (IMG Image, cvbval_t &lMin, cvbval_t &lMax)
 Returns the minimum and maximum line rate for a single line. More...
 
cvbres_t LSGetLineTriggerMode (IMG Image, LSLineTriggerMode &Mode)
 Returns the current linetrigger mode. More...
 
cvbres_t LSGetPrinPol (IMG Image, LSPolarity &lPol)
 Checks the PRIN polarity. More...
 
cvbres_t LSGrab (IMG Image, pLSBLOCKCALLBACK CBBlock, pLSIMAGECALLBACK CBImage, pLSERRORCALLBACK CBError, void *pPrivate)
 Starts continuous image acquisition. More...
 
cvbres_t LSSetBlocksPerFrame (IMG Image, cvbval_t lNumBlocks)
 Set the number of blocks into which an image is subdivided. More...
 
cvbres_t LSSetExposureTime (IMG Image, cvbval_t lExposureTime)
 Sets the exposure time for a single line. More...
 
cvbres_t LSSetExSyncPol (IMG Image, LSPolarity lPol)
 Sets the EXSYNC polarity. More...
 
cvbres_t LSSetImageHeight (IMG Image, cvbval_t Lines)
 Sets the height of the current image in lines. More...
 
cvbres_t LSSetImageWidth (IMG Image, cvbdim_t lStart, cvbdim_t lWidth)
 Returns the width of the current image in pixels. More...
 
cvbres_t LSSetLineRate (IMG Image, cvbval_t lLineRate)
 Defines the current line rate. More...
 
cvbres_t LSSetLineTriggerMode (IMG Image, LSLineTriggerMode Mode)
 Sets the linetrigger mode. More...
 
cvbres_t LSSetPrinPol (IMG Image, LSPolarity lPol)
 Sets the PRIN polarity. More...
 
cvbres_t LSSnap (IMG Image, pLSBLOCKCALLBACK CBBlock, pLSIMAGECALLBACK CBImage, pLSERRORCALLBACK CBError, void *pPrivate)
 Acquires a single image. More...
 
cvbres_t LSStatus (IMG Image, cvbval_t &lStatus)
 Returns the current line status. This is the line that was acquired at the time of the call. More...
 

Detailed Description

Interface for acquiring images from a line scan device (deprecated!).

Typedef Documentation

◆ pLSBLOCKCALLBACK

typedef cvbbool_t __stdcall * pLSBLOCKCALLBACK(cvbval_t NumBlocksPending, cvbdim_t StartLine, cvbdim_t NumLines, cvbbool_t LastBlock, void *pPrivate)

This function is invoked when an image segment has been acquired.

The number of calls depends on how many blocks have been defined with the LSSetBlocksPerFrame function.
pLSBLOCKCALLBACK is a pointer to a callback function of the LineScan interface which is used by the LSGrab and LSSnap functions. To process a large line camera image better it is possible to subdivide the image logically into several small blocks. This means it is not necessary to wait until the entire image has been acquired before processing the image data. Instead, individual parts of the image can be processed one after another depending on the rate of acquisition.

Attention
The list below descripes the specific constant declarations and typedefs. There are declared in the header file iCVCDriver.h.
Parameters
[in]NumBlocksPendingNumber of blocks waiting for processing.
[in]StartLineThe start line of the current block in the picture as a whole.
[in]NumLinesThe number of lines in the block.
[in]LastBlockFlag for indicating the last block.
[in]pPrivateA pointer to private data passed by LSGrab and LSSnap.
Returns
TRUE if succeeded, otherwise FALSE.
Supported platforms:
Win32
Win64
Linux

◆ pLSERRORCALLBACK

typedef cvbbool_t __stdcall * pLSERRORCALLBACK(LSErrorCodes ErrorNumber, cvbval_t Data, void *pPrivate)

This function is invoked when an error has occurred during acquisition.

pLSERRORCALLBACK is a pointer to a callback function of the LineScan interface which is used by the LSGrab and LSSnap functions.

Attention
No complete function definitions can be combined as new types in Visual Basic. The function definition that is given is therefore only an example of a callback function. The address of this function is then passed to LSGrab and LSSnap.
The list below descripes the specific constant declarations and typedefs. There are declared in the header file iCVCDriver.h.
Parameters
[in]ErrorNumberError code (see LSErrorCodes for more information).
[in]DataNot used at present.
[in]pPrivateA pointer to private data passed by LSGrab and LSSnap.
Returns
TRUE if succeeded, otherwise FALSE.
Supported Platforms:
Win32
Win64
Linux

◆ pLSIMAGECALLBACK

typedef cvbbool_t __stdcall * pLSIMAGECALLBACK(cvbval_t NumImagesPending, cvbdim_t NumLines, void *pPrivate)

This function is invoked when an entire image has been acquired.

pLSBLOCKCALLBACK is a pointer to a callback function of the LineScan interface which is used by the LSGrab and LSSnap functions.

Attention
No complete function definitions can be combined as new types in Visual Basic. The function definition that is given is therefore only an example of a callback function. The address of this function is then passed to LSGrab and LSSnap.
The list below descripes the specific constant declarations and typedefs. There are declared in the header file iCVCDriver.h.
Parameters
[in]NumImagesPendingNumber of images that have not been processed yet.
[in]NumLinesThe number of lines in the block.
[in]pPrivateA pointer to private data passed by LSGrab and LSSnap.
Returns
TRUE if succeeded, otherwise FALSE.
Supported Platforms:
Win32
Win64
Linux

Enumeration Type Documentation

◆ LSErrorCodes

Defines the error codes of the LineScan Interface.

Attention
The list below descripes the specific constant declarations and typedefs. There are declared in the header file iCVCDriver.* .
Enumerator
CVC_LS_OK 

No error occurred.

CVC_LS_OVERRUN 

Overrun in the LSGrab or LSSnap function, blocks have been acquired but not processed.

CVC_LS_ERRORMAXCODES 

Maximum numbers of error codes. Do not use it in the functions of the LineScan interface.

◆ LSLineTriggerMode

Defines options of the polarity for ExSync/Prin.

Attention
The list below descripes the specific constant declarations and typedefs. There are declared in the header file iCVCDriver.* .
Enumerator
CVC_LS_FREERUN 

line trigger in free run mode.

CVC_LS_EXTTRIGGER 

External line trigger.

CVC_LS_LINETRIGGERMAXMODES 

Maximum numbers.

◆ LSPolarity

enum LSPolarity

Defines options of the polarity for ExSync/Prin.

Attention
The list below descripes the specific constant declarations and typedefs. There are declared in the header file iCVCDriver.* .
Enumerator
CVC_LS_LO 

LOW polarity active.

CVC_LS_HI 

HI polarity active.

CVC_LS_POLMAXMODES 

Maximum numbers of polarity modes. Do not use it in the functions of the LineScan interface.

Function Documentation

◆ CanLineScan()

cvbbool_t CanLineScan ( IMG  Image)

This function verifies whether the image supports the LineScan interface.

Parameters
[in]ImageHandle of image object.
Deprecated:
Deprecated since Common Vision Blox 13.01.000 because most drivers do not support the ILineScan interface any more.
Returns
TRUE if the image supports the LineScan interface, FALSE otherwise.
Supported platforms:
Win32
Win64
Linux

◆ LSFreeze()

cvbres_t LSFreeze ( IMG  Image)

Stops continuous image acquisition that was started with the LSGrab function.

Parameters
[in]ImageHandle of image object.
Deprecated:
Deprecated since Common Vision Blox 13.01.000 because most drivers do not support the ILineScan interface any more.
Returns
>=0 : OK
<0 : an error occured
Supported platforms:
Win32
Win64
Linux

◆ LSGetBlocksPerFrame()

cvbres_t LSGetBlocksPerFrame ( IMG  Image,
cvbval_t &  lNumBlocks 
)

Returns the number of blocks into which an image is subdivided.

To process a large image acquired from a linescan camera it is possible to subdivide the image logically into several small blocks, each block can be processed before the entire image acquisition is complete.

Parameters
[in]ImageHandle of image object.
[out]lNumBlocksNumber of blocks into which an image is subdivided.
Deprecated:
Deprecated since Common Vision Blox 13.01.000 because most drivers do not support the ILineScan interface any more.
Returns
>=0 : OK
<0 : an error occured
Supported platforms:
Win32
Win64
Linux

◆ LSGetBlocksPerFrameRange()

cvbres_t LSGetBlocksPerFrameRange ( IMG  Image,
cvbval_t &  lMin,
cvbval_t &  lMax 
)

Returns the minimum and maximum number of blocks into which an image can be subdivided.

Attention
These results are dependent on the hardware being used, and are governed, for example, by the arrangement of frame buffers or interrupt limits.
Parameters
[in]ImageHandle of image object.
[out]lMinMinimum number of blocks.
[out]lMaxMaximum number of blocks.
Deprecated:
Deprecated since Common Vision Blox 13.01.000 because most drivers do not support the ILineScan interface any more.
Returns
>=0 : OK
<0 : an error occured
Supported platforms:
Win32
Win64
Linux

◆ LSGetExposureTime()

cvbres_t LSGetExposureTime ( IMG  Image,
cvbval_t &  lExposureTime 
)

Returns the current exposure time set for a single line.

Attention
These results are very dependent on the camera and frame grabber being used.
Parameters
[in]ImageHandle of image object.
[out]lExposureTimeExposure time for a single line in ms.
Deprecated:
Deprecated since Common Vision Blox 13.01.000 because most drivers do not support the ILineScan interface any more.
Returns
>=0 : OK
<0 : an error occured
Supported platforms:
Win32
Win64
Linux

◆ LSGetExposureTimeRange()

cvbres_t LSGetExposureTimeRange ( IMG  Image,
cvbval_t &  lMin,
cvbval_t &  lMax 
)

Returns the minimum and maximum exposure time possible for a single line.

Attention
These results are very dependent on the camera and frame grabber being used.
Parameters
[in]ImageHandle of image object.
[out]lMinMinimum exposure time for one line in ms.
[out]lMaxMaximum exposure time for one line in ms.
Deprecated:
Deprecated since Common Vision Blox 13.01.000 because most drivers do not support the ILineScan interface any more.
Returns
>=0 : OK
<0 : an error occured
Supported platforms:
Win32
Win64
Linux

◆ LSGetExSyncPol()

cvbres_t LSGetExSyncPol ( IMG  Image,
LSPolarity lPol 
)

Returns the current EXSYNC polarity.

The EXSYNC plolarity defines the start pulse from the frame grabber to the camera to read out a line.

Parameters
[in]ImageHandle of image object.
[out]lPolCurrent EXSYNC polarity. Possible values are:
CVC_LS_HI
CVC_LS_LO
(description of parameters see LSPolarity).
Deprecated:
Deprecated since Common Vision Blox 13.01.000 because most drivers do not support the ILineScan interface any more.
Returns
>=0 : OK
<0 : an error occured
Supported platforms:
Win32
Win64
Linux

◆ LSGetImageHeight()

cvbres_t LSGetImageHeight ( IMG  Image,
cvbval_t &  Lines 
)

Returns the height of the current image in lines.

Parameters
[in]ImageHandle of image object.
[out]LinesImage height in lines.
Deprecated:
Deprecated since Common Vision Blox 13.01.000 because most drivers do not support the ILineScan interface any more.
Returns
>=0 : OK
<0 : an error occured
Supported platforms:
Win32
Win64
Linux

◆ LSGetImageWidth()

cvbres_t LSGetImageWidth ( IMG  Image,
cvbdim_t &  lStart,
cvbdim_t &  lWidth 
)

Returns the width of the current image in pixels.

The Start value defines the start position of the data in the line, the horizontal offset.

Parameters
[in]ImageHandle of image object.
[out]lStartStart position of the data in the line (horizontal offset).
[out]lWidthImage width in pixels.
Deprecated:
Deprecated since Common Vision Blox 13.01.000 because most drivers do not support the ILineScan interface any more.
Returns
>=0 : OK
<0 : an error occured
Supported platforms:
Win32
Win64
Linux

◆ LSGetImageWidthRange()

cvbres_t LSGetImageWidthRange ( IMG  Image,
cvbdim_t &  lMin,
cvbdim_t &  lMax 
)

Returns the minimum and maximum image width.

Attention
These results are very dependent on the camera and frame grabber being used.
Parameters
[in]ImageHandle of image object.
[out]lMinMinimum image width.
[out]lMaxMaximum image width.
Deprecated:
Deprecated since Common Vision Blox 13.01.000 because most drivers do not support the ILineScan interface any more.
Returns
>=0 : OK
<0 : an error occured
Supported platforms:
Win32
Win64
Linux

◆ LSGetLineRate()

cvbres_t LSGetLineRate ( IMG  Image,
cvbval_t &  lLineRate 
)

Returns the current line rate.

Parameters
[in]ImageHandle of image object.
[out]lLineRateLine rate in Hz.
Deprecated:
Deprecated since Common Vision Blox 13.01.000 because most drivers do not support the ILineScan interface any more.
Returns
>=0 : OK
<0 : an error occured
Supported platforms:
Win32
Win64
Linux

◆ LSGetLineRateRange()

cvbres_t LSGetLineRateRange ( IMG  Image,
cvbval_t &  lMin,
cvbval_t &  lMax 
)

Returns the minimum and maximum line rate for a single line.

Attention
These results are dependent on the camera and frame grabber being used.
Parameters
[in]ImageHandle of image object.
[out]lMinMinimum line rate.
[out]lMaxMaximum line rate.
Deprecated:
Deprecated since Common Vision Blox 13.01.000 because most drivers do not support the ILineScan interface any more.
Returns
>=0 : OK
<0 : an error occured
Supported platforms:
Win32
Win64
Linux

◆ LSGetLineTriggerMode()

cvbres_t LSGetLineTriggerMode ( IMG  Image,
LSLineTriggerMode Mode 
)

Returns the current linetrigger mode.

Parameters
[in]ImageHandle of image object.
[out]ModeCurrent PRIN polarity. Possible values are:
CVC_LS_FREERUN
CVC_LS_EXTTRIGGER
(description of parameters see LSLineTriggerMode).
Deprecated:
Deprecated since Common Vision Blox 13.01.000 because most drivers do not support the ILineScan interface any more.
Returns
>=0 : OK
<0 : an error occured
Supported platforms:
Win32
Win64
Linux

◆ LSGetPrinPol()

cvbres_t LSGetPrinPol ( IMG  Image,
LSPolarity lPol 
)

Checks the PRIN polarity.

The PRIN plolarity is the pulse to control exposure time for a line from the frame grabber to the camera.

Parameters
[in]ImageHandle of image object.
[out]lPolCurrent PRIN polarity. Possible values are:
CVC_LS_HI
CVC_LS_LO
(description of parameters see LSPolarity).
Deprecated:
Deprecated since Common Vision Blox 13.01.000 because most drivers do not support the ILineScan interface any more.
Returns
>=0 : OK
<0 : an error occured
Supported platforms:
Win32
Win64
Linux

◆ LSGrab()

cvbres_t LSGrab ( IMG  Image,
pLSBLOCKCALLBACK  CBBlock,
pLSIMAGECALLBACK  CBImage,
pLSERRORCALLBACK  CBError,
void *  pPrivate 
)

Starts continuous image acquisition.

In addition to the image object, special callback functions to handle block, image and error events are passed to this function.

Parameters
[in]ImageHandle of image object.
[in]CBBlockThis callback function is invoked when an image segment has been aquired and the block is in memory ready for processing (see LSSetBlocksPerFrame). The number of calls depends on how many blocks have been defined with the LSSetBlocksPerFrame function. If, for example, a frame consists of 10 blocks this function is invoked for every block i.e. 10 times per image.
[in]CBImageThis callback function is invoked when a frame (entire image) has been acquired and is in memory ready for processing.
Note: The time between the end of one frame and the beginning of the next is very short as far as line cameras are concerned, normally too short to analyse the entire image.
[in]CBErrorThis callback function is invoked when an error occurs e.g. there is an overrun or a timeout. An overrun occurs when image blocks are acquired faster than they can be processed.
[in]pPrivatePointer to private data (e.g. class pointer) which is passed to the callback functions. This private data can then be used in these Callback functions.
Deprecated:
Deprecated since Common Vision Blox 13.01.000 because most drivers do not support the ILineScan interface any more.
Returns
>=0 : OK
<0 : an error occured
CBError Test Case:
An image (frame) consists of 10 blocks. Processing of the second block takes so long that it is not finished by the time the eleventh block has been acquired. The driver therefore does not overwrite the data of the second block but returns an error message stating that 'new' image data has been lost.
Supported platforms:
Win32
Win64
Linux

◆ LSSetBlocksPerFrame()

cvbres_t LSSetBlocksPerFrame ( IMG  Image,
cvbval_t  lNumBlocks 
)

Set the number of blocks into which an image is subdivided.

Attention
The height of the image have to be a multiply of the block number.
Parameters
[in]ImageHandle of image object.
[in]lNumBlocksNumber of blocks into which an image is subdivided.
Deprecated:
Deprecated since Common Vision Blox 13.01.000 because most drivers do not support the ILineScan interface any more.
Returns
>=0 : OK
<0 : an error occured
Supported platforms:
Win32
Win64
Linux
Related Topics:
LSGetBlocksPerFrame,
LSGetBlocksPerFrameRange

◆ LSSetExposureTime()

cvbres_t LSSetExposureTime ( IMG  Image,
cvbval_t  lExposureTime 
)

Sets the exposure time for a single line.

Attention
These results are very dependent on the camera and frame grabber being used.
Parameters
[in]ImageHandle of image object.
[in]lExposureTimeExposure time for a single line in ms.
Deprecated:
Deprecated since Common Vision Blox 13.01.000 because most drivers do not support the ILineScan interface any more.
Returns
>=0 : OK
<0 : an error occured
Supported platforms:
Win32
Win64
Linux

◆ LSSetExSyncPol()

cvbres_t LSSetExSyncPol ( IMG  Image,
LSPolarity  lPol 
)

Sets the EXSYNC polarity.

The EXSYNC plolarity defines the start pulse from the frame grabber to the camera to read out a line.

Parameters
[in]ImageHandle of image object.
[in]lPolCurrent EXSYNC polarity. Possible values are:
CVC_LS_HI
CVC_LS_LO
(description of parameters see LSPolarity).
Deprecated:
Deprecated since Common Vision Blox 13.01.000 because most drivers do not support the ILineScan interface any more.
Returns
>=0 : OK
<0 : an error occured
Supported platforms:
Win32
Win64
Linux

◆ LSSetImageHeight()

cvbres_t LSSetImageHeight ( IMG  Image,
cvbval_t  Lines 
)

Sets the height of the current image in lines.

Parameters
[in]ImageHandle of image object.
[in]LinesImage height in lines.
Deprecated:
Deprecated since Common Vision Blox 13.01.000 because most drivers do not support the ILineScan interface any more.
Returns
>=0 : OK
<0 : an error occured
Supported platforms:
Win32
Win64
Linux

◆ LSSetImageWidth()

cvbres_t LSSetImageWidth ( IMG  Image,
cvbdim_t  lStart,
cvbdim_t  lWidth 
)

Returns the width of the current image in pixels.

The Start value defines the start position of the data in the line, the horizontal offset.

Parameters
[in]ImageHandle of image object.
[in]lStartStart position of the data in the line (horizontal offset).
[in]lWidthImage width in pixels.
Deprecated:
Deprecated since Common Vision Blox 13.01.000 because most drivers do not support the ILineScan interface any more.
Returns
>=0 : OK
<0 : an error occured
Supported platforms:
Win32
Win64
Linux

◆ LSSetLineRate()

cvbres_t LSSetLineRate ( IMG  Image,
cvbval_t  lLineRate 
)

Defines the current line rate.

Parameters
[in]ImageHandle of image object.
[in]lLineRateLine rate in Hz.
Deprecated:
Deprecated since Common Vision Blox 13.01.000 because most drivers do not support the ILineScan interface any more.
Returns
>=0 : OK
<0 : an error occured
Supported platforms:
Win32
Win64
Linux

◆ LSSetLineTriggerMode()

cvbres_t LSSetLineTriggerMode ( IMG  Image,
LSLineTriggerMode  Mode 
)

Sets the linetrigger mode.

Parameters
[in]ImageHandle of image object.
[in]ModeCurrent PRIN polarity. Possible values are:
CVC_LS_FREERUN
CVC_LS_EXTTRIGGER
(description of parameters see LSLineTriggerMode).
Deprecated:
Deprecated since Common Vision Blox 13.01.000 because most drivers do not support the ILineScan interface any more.
Returns
>=0 : OK
<0 : an error occured
Supported platforms:
Win32
Win64
Linux

◆ LSSetPrinPol()

cvbres_t LSSetPrinPol ( IMG  Image,
LSPolarity  lPol 
)

Sets the PRIN polarity.

The PRIN plolarity is the pulse to control exposure time for a line from the frame grabber to the camera.

Parameters
[in]ImageHandle of image object.
[in]lPolCurrent PRIN polarity. Possible values are:
CVC_LS_HI
CVC_LS_LO
(description of parameters see LSPolarity).
Deprecated:
Deprecated since Common Vision Blox 13.01.000 because most drivers do not support the ILineScan interface any more.
Returns
>=0 : OK
<0 : an error occured
Supported platforms:
Win32
Win64
Linux

◆ LSSnap()

cvbres_t LSSnap ( IMG  Image,
pLSBLOCKCALLBACK  CBBlock,
pLSIMAGECALLBACK  CBImage,
pLSERRORCALLBACK  CBError,
void *  pPrivate 
)

Acquires a single image.

In addition to the image object, special callback functions to handle block, image and error events are passed to this function.

Parameters
[in]ImageHandle of image object.
[in]CBBlockThis callback function is invoked when an image segment has been aquired and the block is in memory ready for processing (see LSSetBlocksPerFrame).
The number of calls depends on how many blocks have been defined with the LSSetBlocksPerFrame function. If, for example, a frame consists of 10 blocks this function is invoked for every block i.e. 10 times per image.
[in]CBImageThis callback function is invoked when a frame (entire image) has been acquired and is in memory ready for processing.
Note: The time between the end of one frame and the beginning of the next is very short as far as line cameras are concerned, normally too short to analyse the entire image.
[in]CBErrorThis callback function is invoked when an error occurs e.g. there is a timeout.
[in]pPrivatePointer to private data (e.g. class pointer) which is passed to the callback functions. This private data can then be used in these Callback functions.
Deprecated:
Deprecated since Common Vision Blox 13.01.000 because most drivers do not support the ILineScan interface any more.
Returns
>=0 : OK
<0 : an error occured
Supported platforms:
Win32
Win64
Linux

◆ LSStatus()

cvbres_t LSStatus ( IMG  Image,
cvbval_t &  lStatus 
)

Returns the current line status. This is the line that was acquired at the time of the call.

Parameters
[in]ImageHandle of image object.
[out]lStatusLine number.
Deprecated:
Deprecated since Common Vision Blox 13.01.000 because most drivers do not support the ILineScan interface any more.
Returns
>=0 : OK
<0 : an error occured
Supported platforms:
Win32
Win64
Linux