HALCON 6.1 Frame Grabber Interface for Imagenation PXD1000 Boards

This page provides the documentation of the HALCON frame grabber interface HFGPxd.dll for the Imagenation PXD1000 frame grabber from CyberOptics Semiconductor. Registered customers can download the latest revision of this interface from the MVTec WWW server.

Revision: 2.1

System Requirements

• Intel compatible PC with Windows NT 4.0 (Service Pack 4) or Windows 2000.
• Successfully installed Imagenation pxd.sys driver.
• Imagenation DLLs pxd_32.dll and frame_32.dll.
  These DLLs must be within your search path %PATH%. If you do not have this DLL, please contact Imagenation or the vendor from which you bought the frame grabber board.
• HALCON frame grabber interface HFGPxd.dll or parHFGPxd.dll, respectively.
  If you have properly installed the interface, both DLLs should reside in bin\i586-nt4 within the HALCON base directory %HALCONROOT% you have chosen during the installation of HALCON.

Features

• Multiple frame grabber boards.
• Synchronous and asynchronous grabbing.
• External trigger.
• Cropping of image parts.
• Software control of grabbing timeout.
• Software control of type and input line of the trigger signal.

Limitations

• No LUTs.
• grab_region() and grab_region_async() not supported.

Description

Parameters for open_framegrabber():

	Name	'Pxd'	The name of the HALCON frame grabber interface.
	HorizontalResolution	---	Ignored (the desired image resolution is set via the camera configuration specified in the CameraType parameter).
	VerticalResolution	---	Ignored (the desired image resolution is set via the camera configuration specified in the CameraType parameter).
	ImageWidth	0, width	The width of the desired image part ('0' stands for the complete image). Default: 0.
	ImageHeight	0, height	The height of the desired image part ('0' stands for the complete image). Default: 0.
	StartRow	0, row	The row coordinate of the upper left pixel within the desired image part ('0' obviously results in delivering the complete image). Default: 0.
	StartColumn	0, column	The column coordinate of the upper left pixel within the desired image part ('0' obviously results in delivering the complete image). Default: 0.
	Field	---	Ignored (the desired field is set via the camera configuration specified in the CameraType parameter).
	BitsPerChannel	-1, 8, 10, 12, 14, 16	The number of bits per channel. If using a camera with more than 8bpp this parameter controls the alignment of the image data to ensure the correct gray value range of the resulting HALCON image (e.g., [0...1023] when using a 10 bpp camera). If you specify '8' the resulting HALCON image is a byte image (with gray values between 0 and 255) instead of a int2 image; this "overriding" of the configuration settings cannot be combined with the volatile mode! The gray value conversion is done by using the built-in lookup table of the PXD board. By specifying the default '-1', '8' (in combination with a 8bpp camera) or '16' (in case of a camera with more than 8bpp) no conversion is done. Default: -1.
	ColorSpace	---	Ignored (the desired color space is set via the camera configuration specified in the CameraType parameter).
	Gain	---	Ignored.
	ExternalTrigger	'true', 'false'	Activate/deactivate external triggering. Default: 'false'.
	CameraType	'configfile'	This parameter is used to specify the desired camera configuration file, e.g. 'C:\\Pxd\\Cameras\\Hitachi\\KPF100.cam'. If CameraType is set to 'default' the default camera configuration is loaded. To check a camera configuration use the ViewPXD program from Imagenation. Default: 'default'.
	Device	'-1', 'board'	The number of the frame grabber board (passed as a string!) or '-1' (default) for an automatic detection (in case you have only one PXD board installed in your PC). Default: '-1'.
	Port	---	Ignored.
	LineIn	---	Ignored.

Parameters for set_framegrabber_param():

	'volatile'	'enable', 'disable'	Grayscale mode only. In the volatile mode the two frame grabber interface buffers are used directly to store HALCON images. This is the fastest mode avoiding to copy raw images in memory. However, be aware that older images are overwritten again and again as a side-effect. Thus, you can only process one image while you grab another image. Older images are invalid! The volatile mode cannot be applied in case of a camera configuration with more than 8bpp in conjunction with the overriding of the BitsPerChannel parameter by the value '8'.
	'external_trigger'	'true', 'false'	Activate/deactivate external triggering.
	'trigger_signal'	'falling', 'rising', 'debounce', 'low', 'high'	Specify the desired type of trigger signal for external triggering. See the Imagenation documentation for details. Default: 'high'.
	'trigger_input_line'	'trigger', 'wen', 'gpin0'	Specify the desired input line for external triggering. See the Imagenation documentation for details. Default: 'trigger'.
	'suppress_errors'	'true', 'false'	If the value 'true' is chosen, PCI transfer errors are not reported. Default: 'false'.
	'grab_timeout'	timeout	Number of milliseconds (integer) after which a pending grabbing command is aborted. The default setting is -1 (no timeout). Note that the interface measures the time interval between the start of the grabbing command and the delivery of the image in the next grab_image() or grab_image_async() operator. It cannot take into account the time when an asynchronous grab was actually finished (which can be long before the image is accessed with the next grabbing command). Thus, timeout settings shorter than the time passing between consecutive grabbing calls might will lead to false timeout alarms when grabbing asynchronously.

Parameters for get_framegrabber_param():

Additional parameters supported by get_framegrabber_param() only. Note that all parameters supported by set_framegrabber_param() can also be accessed by get_framegrabber_param().

	'revision'	revision	The revision number of the HALCON frame grabber interface HFGPxd.dll.

Release Notes

• Revision 2.1 (Feb 5, 2001):
  
  • HALCON 6.1 version of the interface (included in HALCON 6.1 CD).
  • Bugfix in evaluating the 'CameraType' parameter during open_framegrabber().
  • The 'BitsPerChannel' parameter now enables the HALCON-compliant grabbing of images with more than 8bpp, see description above.
• Revision 2.0 (Nov 8, 2000):
  
  • First official release (included in the HALCON 6.0 CD).

Last modified: Mon May 6 11:04:31 CEST 2002