 |
|
HALCON 7.1 1394IIDC Interface for IEEE 1394 (FireWire) Cameras
This page provides the documentation of the HALCON 1394IIDC interface
which is based on the
libdc1394
library via any OHCI compliant IEEE 1394 adapter cards.
With this interface you can acquire images from all IEEE 1394 (FireWire)
cameras that are compliant to the IIDC 1394 standard.
Registered
customers can download the
latest
revision of this interface from the
MVTec WWW server.
Revision: 2.3
System Requirements
-
Intel compatible PC with Linux x86 or x86_64 operating system
and OHCI compliant IEEE 1394 adapter.
-
The following kernel modules must be loaded: ohci1394, ieee1394,
raw1394, video1394.
-
Read/write access to the following devices:
/dev/raw1394 and /dev/video1394.
-
Note that in order to avoid compatibility problems, this interface
is statically linked with the latest versions of the system
libraries libraw1394
(version 1.2.0) and
libdc1394
(version 1.2.2). Thus, the interface does not use the actually
installed versions of these libraries.
-
HALCON frame grabber interface HFG1394IIDC.so.
If you have properly installed the interface, the shared object file
should reside in lib/i586-linux2.2-gcc33 within the HALCON
base directory $HALCONROOT you have chosen during the
installation of HALCON.
-
Please note that this interface has been tested on
SuSE Linux versions 9.3/10.0 and will probably not work
with older Linux kernel versions.
Features
-
Supports all IEEE 1394 cameras that are compliant to the
IIDC 1394-based Digital Camera Specification.
-
Synchronous and asynchronous grabbing.
-
Multiple cameras.
-
External camera triggering.
-
Support of scalable image formats (Format_7).
-
Software control of all IIDC 1394 parameters.
Limitations
-
grab_region and grab_region_async not supported.
-
Currently only 400 MBit/s transfer rates supported, i.e., no
full support of IEEE 1394b cameras.
-
No LUTs.
-
No color formats in Format_7.
-
No software cropping of image parts.
-
Bus reset not supported.
-
No color conversion inside the interface, i.e., only the
native color formats of the camera can be used.
-
Format_6 not supported.
Description
Parameters for
open_framegrabber():
|
Name
|
|
'1394IIDC'
|
|
The name of the HALCON frame grabber interface.
|
|
HorizontalResolution
|
---
|
Ignored. Note that in Format_7 you can specify the actual
image part dynamically by using the operator
set_framegrabber_param with the parameter names
'horizontal_offset', 'horizontal_resolution',
'vertical_offset', and 'vertical_resolution'.
|
|
VerticalResolution
|
---
|
Ignored. Note that in Format_7 you can specify the actual
image part dynamically by using the operator
set_framegrabber_param with the parameter names
'horizontal_offset', 'horizontal_resolution',
'vertical_offset', and 'vertical_resolution'.
|
|
ImageWidth
|
---
|
Ignored. The actual value is specified by the parameter CameraType.
|
|
ImageHeight
|
---
|
Ignored. The actual value is specified by the parameter CameraType.
|
|
StartRow
|
---
|
Ignored.
|
|
StartColumn
|
---
|
Ignored.
|
|
Field
|
---
|
Ignored.
|
|
BitsPerChannel
|
---
|
Ignored. The actual value is specified by the parameter CameraType.
|
|
ColorSpace
|
---
|
Ignored. The actual value is specified by the parameter CameraType.
|
|
Gain
|
---
|
Ignored.
|
|
ExternalTrigger
|
'true', 'false'
|
Activate/deactivate external triggering (if supported by the camera).
Default: 'false'.
|
|
CameraType
|
'format:mode:fps', 'default'
|
Specify the desired video settings as a string consisting
of the video format (0,1,2,6,7), the video mode (0,1,2,3,4,5,6,7),
and the frame rate (0,1,2,3,4,5,6,7), separated by colons.
The supported values for video format, video mode
and frame rate depend on the specified camera. When setting video
format to Format_7 the last value is the color_coding (the frame rate
can be set via the parameter 'packet_size'):
- 0 = MONO8
- 1 = YUV411
- 2 = YUV422
- 3 = YUV444
- 4 = RGB8
- 5 = MONO16
- 6 = RGB16
- 7 = not supported
- 8 = not supported
- 9 = RAW8
- 10 = RAW16
For the supported settings refer to the user manual of your
specified camera or to the DCAM specification.
'default' means to adopt the supplied video settings of the camera.
Default: 'default'.
|
|
Device
|
'-1', 'card.id', 'GUID'',
|
Select the desired camera device: You can either do this by
specifying the indices of the used adapter card and id, or by the
camera GUID. To query the actual installed cameras you can call
info_framegrabber('1394IIDC','info_boards',...).
'-1' selects the first available device. Default: '-1'.
|
|
Port
|
---
|
Ignored.
|
|
LineIn
|
---
|
Ignored.
|
|
Parameters for
set_framegrabber_param():
Note that most of the following parameters (and also the valid
parameter values!) depend on the capabilities of the used
camera. Additionally, the default values of these parameters
depend on the current camera settings.
For many camera features the corresponding parameter (like 'shutter'
and 'brightness') allows to set the operation mode of this feature
by a string value:
- 'auto' means that the camera controls the value automatically by itself
- 'manual' disables the automatic control mode and enables manual setting
by integer values
- 'one_push' means that the camera controls the value automatically by itself
only once and returns to manual control mode
- 'off' fixes the specified value
You can request the valid minimal and maximal integer values and
the step width required for the manual setting as well as the
supported modes of these parameters by calling
get_framegrabber_param(...,'<parameter_name>_range',...)
.
Other parameters like 'camera_type or 'trigger_mode' support a
camera-specific set of values. This set of values can be requested
by calling
get_framegrabber_param(...,'<parameter_name>_values',...)
.
|
'brightness'
|
|
min ... max,
'auto', 'manual', 'one_push', 'off'
|
|
Sets the brightness mode of the camera if a
string value is passed. In case of an integer
value the brightness mode is switched to 'manual'
and the brightness value is set. See
get_framegrabber_param to yield
min, max and the supported modes.
|
|
'burst_count'
|
0, 1
|
Setting this parameter to 1 causes the camera to use the one shot mode
for grabbing images. Setting this parameter to 0 causes the camera to
use the continuous shot mode for grabbing images. Not all cameras support the
one shot mode (see also get_framegrabber_param).
Default: 0.
|
|
'capture_quality'
|
min ... max,
'auto', 'manual', 'one_push', 'off'
|
Sets the capture_quality mode of the camera if a
string value is passed. In case of an integer
value the capture_quality mode is switched to 'manual'
(if supported) and the capture_quality value is set.
See get_framegrabber_param to yield
min, max and the supported modes.
|
|
'capture_size'
|
min ... max,
'auto', 'manual', 'one_push', 'off'
|
Sets the capture_size mode of the camera if a
string value is passed. In case of an integer
value the capture_size mode is switched to 'manual'
(if supported) and the capture_size value is set.
See get_framegrabber_param to yield
min, max and the supported modes.
|
|
'camera_type'
|
'format:mode:fps'
|
Specify the desired video settings as a string consisting
of the video format (0,1,2,6,7), the video mode (0,1,2,3,4,5,6,7),
and the frame rate (0,1,2,3,4,5,6,7), separated by colons.
When setting video format to Format_7 the last parameter value is
the color_coding.
See get_framegrabber_param to yield all supported camera
type values.
|
|
'do_bus_reset'
|
---
|
Resets the 1394IIDC bus.
|
|
'do_free_resources'
|
---
|
Frees the resources of the isochronuous channel on the
IEEE 1394 bus. The setting fails,
e.g., if not enough bandwidth is available on the bus.
Note that calling a
grab_image_start,
grab_image_async and
grab_image
operator allocates the resources automatically if freed before.
|
|
'do_reset_camera'
|
---
|
Sets the factory defaults of the camera. The settings induced by this parameter
call depend highly on the camera.
|
|
'exposure'
|
min ... max,
'auto', 'manual', 'one_push', 'off'
|
Sets the exposure mode of the camera if a
string value is passed. In case of an integer
value the exposure mode is switched to 'manual'
(if supported) and the exposure value is set.
See get_framegrabber_param to yield
min, max and the supported modes.
|
|
'external_trigger'
|
'true', 'false'
|
Enables/disables the external trigger mode. Be aware of the settings your
camera supplies.
|
|
'focus'
|
min ... max,
'auto', 'manual', 'one_push', 'off'
|
Sets the focus mode of the camera if a
string value is passed. In case of an integer
value the focus mode is switched to 'manual'
(if supported) and the focus value is set.
See get_framegrabber_param to yield
min, max and the supported modes.
|
|
'gamma'
|
min ... max,
'auto', 'manual', 'one_push', 'off'
|
Sets the gamma mode of the camera if a string value is passed.
In case of an integer value the gamma mode is switched to 'manual'
(if supported) and the gamma value is set.
See get_framegrabber_param to yield
min, max and the supported modes.
|
|
'grab_timeout'
|
msec
|
Specify the desired timeout (milliseconds passed as a long)
for aborting a pending grab. -1 means to abort never.
Default: 5000.
|
|
'horizontal_offset'
|
min ... max
|
The row coordinate of the upper left pixel of the desired
image part if Format_7 is set. The passed value gets rounded
to the next smaller value
to fit the step width restriction of this parameter (which
depends on the camera). max equals the
maximum image height minus the step width. This parameter is
only supported if no resources are allocated (see also
'do_free_resources').
|
|
horizontal_resolution
|
min ... max
|
Sets the horizontal resolution of the desired image part if
Format_7 is specified. The passed value gets
rounded to the next smaller value
to fit the step width restriction of this parameter (which
depends on the camera). min equals the step
width whereas max equals the
maximum image width. This parameter is only supported if no
resources are allocated (see also
'do_free_resources').
|
|
'hue'
|
min ... max,
'auto', 'manual', 'one_push', 'off'
|
Sets the hue mode of the camera if a string value is passed.
In case of an integer value the hue mode is switched to 'manual'
(if supported) and the hue value is set.
See get_framegrabbe_param to yield
min, max and the supported modes.
|
|
'iris'
|
min ... max,
'auto', 'manual', 'one_push', 'off'
|
Sets the iris mode of the camera if a
string value is passed. In case of an integer
value the iris mode is switched to 'manual'
(if supported) and the iris value is set.
See get_framegrabber_param to yield
min, max and the supported modes.
|
|
'num_buffers'
|
number
|
Sets the size of the DMA ring buffer (num_buffers >= 2).
This parameter is only supported if no resources are allocated (see also
'do_free_resources').
Default: 2.
|
|
'optical_filter'
|
min ... max,
'auto', 'manual', 'one_push', 'off'
|
Sets the optical_filter mode of the camera if a
string value is passed. In case of an integer
value the optical_filter mode is switched to 'manual'
(if supported) and the optical_filter value is set.
See get_framegrabber_param to yield
min, max and the supported modes.
|
|
'packet_size'
|
min ... max, -1
|
Specifies the size of the transferred packets in bytes. This
parameter is only supported when no resources are currently
allocated and Format_7 is set (see also 'do_free_resources' and
'camea_type'). The passed value gets rounded to the next smaller value to
fit the step width restriction of this parameter. The value specifies the
bandwidth of the isochronuous channel and therefore influences the
frame rate of the camera. -1 specifies the maximal
packet size.
See get_framegrabber_param to yield
min, max and the step width.
|
|
'pan'
|
min ... max,
'auto', 'manual', 'one_push', 'off'
|
Sets the pan mode of the camera if a
string value is passed. In case of an integer
value the pan mode is switched to 'manual'
(if supported) and the pan value is set.
See get_framegrabber_param to yield
min, max and the supported modes.
|
|
'register_address'
|
'address'
|
Sets the register address of the camera control register you want to manipulate
directily. The register address must be assigned to the parameter value in the
hexadecimal format and as a string.
|
|
'register_value'
|
'value'
|
Manipulates the camera control register selected with the parameter 'register_address'
to the value specified. The value you want to set must be assigned to
the parameter value in the hexadecimal format and as a string.
Attention: this parameter manipulates any camera control register specified
by 'register_address' directly! Undefined register manupulations can have
bad side effects concerning the camera's funtionality.
|
|
'saturation'
|
min ... max,
'auto', 'manual', 'one_push', 'off'
|
Sets the saturation mode of the camera if a string value is passed.
In case of an integer value the saturation mode is switched to
'manual' (if supported) and the saturation value is set.
See get_framegrabber_param to yield
min, max and the supported modes.
|
|
'sharpness'
|
min ... max,
'auto', 'manual', 'one_push', 'off'
|
Sets the sharpness mode of the camera if a
string value is passed. In case of an integer
value the sharpness mode is switched to 'manual'
(if supported) and the sharpness value is set.
See get_framegrabber_param to yield
min, max and the supported modes.
|
|
'shift_bits'
|
number
|
Some cameras deliver for mono16 and rgb16 images a lower number of relevant bits
which are aligned to the least significant bit. Use the parameter 'shift_bits' to
shift the relevant bits to the most significant bit.
Default: 0.
|
|
'shutter'
|
min ... max
'auto', 'manual', 'one_push', 'off'
|
Sets the shutter mode of the camera if a string value is passed.
In case of an integer value the shutter mode is switched to
'manual' (if supported) and the shutter value is set.
See get_framegrabber_param to yield
min, max and the supported modes.
|
|
'start_async_after_grab_async'
|
'enable', 'disable'
|
By default, at the end of grab_image_async a new request
for an asynchronous grab command is automatically given to the
camera. If the parameter 'start_async_after_grab_async' is set to
'disable' this new grab command is omitted.
Default: 'enable'.
|
|
'swap_bytes'
|
'false', 'true'
|
Some cameras deliver the image data for mono16 and rgb16 in reverse
byte order. Setting this parameter to 'true' inverts the recived byte order
such that you get the image you want.
Default: 'false'.
|
|
'temperature'
|
min ... max,
'auto', 'manual', 'one_push', 'off'
|
Sets the temperature mode of the camera if a
string value is passed. In case of an integer
value the temperature mode is switched to 'manual'
(if supported) and the (target) temperature value is set.
See get_framegrabber_param to yield
min, max and the supported modes.
|
|
'tilt'
|
min ... max,
'auto', 'manual', 'one_push', 'off'
|
Sets the tilt mode of the camera if a
string value is passed. In case of an integer
value the tilt mode is switched to 'manual'
(if supported) and the tilt value is set.
See get_framegrabber_param to yield
min, max and the supported modes.
|
|
'trigger_mode'
|
0, 1, 2, 3
|
Sets the trigger mode as defined in the
IEEE 1394-based digital camera specification:
- 0: Integration time is described by shutter parameter.
- 1: Integration time is equal to the pulse width of the external trigger input.
- 2: Integration stops after n external trigger events, see also 'trigger_parameter'.
- 3: Camera will issue trigger internally and
cycle time is a multiple of the cycle time of the fastest frame rate,
see also 'trigger_parameter'. Integration time is described by shutter parameter.
|
|
'trigger_parameter'
|
number
|
Sets the trigger parameter needed by the trigger modes 2 and 3:
In trigger mode 2 it specifies the
number of trigger input events which define the
integration time (n>2!). In trigger mode 3 it defines the cycle time as
multiple of the cycle time of the fastest frame rate (n>1!). Refer to the
IIDC 1394-based DCAM specification for further information.
|
|
'trigger_polarity'
|
0, 1
|
Sets the trigger polarity and distinguishes whereas the rising (1)
or falling (0) edge triggers the camera. Be aware of the settings
your camera supplies.
|
|
'ub'
|
ub_value,
'auto', 'manual', 'one_push', 'off'
|
Sets the white_balance mode of the camera if a
string value is passed. In case of an integer
value the white_balance mode is switched to 'manual'
(if supported) and the ub value is set.
See get_framegrabber_param to yield
min, max and the supported modes.
|
|
'vertical_offset'
|
min ... max
|
The column coordinate of the upper left pixel of the desired
image part if Format_7 is set. The passed value gets rounded
to the next smaller value
to fit the step width restriction of this parameter (which
depends on the camera). max equals the
maximum image width minus the step width. This parameter is
only supported if no resources are allocated (see also
'do_free_resources').
|
|
vertical_resolution
|
min ... max
|
Sets the vertical resolution of the desired image part if
Format_7 is specified. The passed value gets
rounded to the next smaller value
to fit the step width restriction of this parameter (which
depends on the camera). min equals the step
width whereas max equals the
maximum image height. This parameter is only supported if no
resources are allocated (see also
'do_free_resources').
|
|
'video_gain'
|
min ... max
'auto', 'manual', 'one_push', 'off'
|
Sets the gain mode of the camera if a string value is passed.
In case of an integer value the gain mode is switched to 'manual'
(if supported) and the gain value is set.
See get_framegrabber_param to yield
min, max and the supported modes.
|
|
'volatile'
|
'enable', 'disable'
|
Grayscale 8bpp and 16bpp only!
In the volatile mode the image 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!
|
|
'vr'
|
vr_value,
'auto', 'manual', 'one_push', 'off'
|
Sets the white_balance mode of the camera if a
string value is passed. In case of an integer
value the white_balance mode is switched to 'manual'
(if supported) and the vr value is set.
See get_framegrabber_param to yield
min, max and the supported modes.
|
|
'white_shading'
|
[r_value,g_value,b_value],
'auto', 'manual', 'one_push', 'off'
|
Sets the white_shading mode of the camera if a
string value is passed. In case of a 3-tuple
value (type long) the white_shading mode is switched to 'manual'
(if supported) and the r_value, g_value and b_value are set.
See get_framegrabber_param to yield
min, max and the supported modes.
|
|
'zoom'
|
min ... max,
'auto', 'manual', 'one_push', 'off'
|
Sets the zoom mode of the camera if a
string value is passed. In case of an integer
value the zoom mode is switched to 'manual'
(if supported) and the zoom value is set.
See get_framegrabber_param to yield
min, max and the supported modes.
|
|
Parameters for
get_framegrabber_param():
Additional parameters supported by
get_framegrabber_param only.
Note that all parameters supported by
set_framegrabber_param
except the ones with prefix 'do_' can also be accessed by
get_framegrabber_param. Note that all parameters of
get_framegrabber_param
return an empty tuple if they are not supported by the used camera.
|
'brightness_range'
|
|
[min (long),
max (long),
step_width (long),
current_value (long),
<'auto'> (string),
<'manual'> (string),
<'one_push'> (string),
<'off'> (string)]
|
|
Returns the supported range of the 'brightness' parameter.
The first four elements contain the minimal and maximal brightness
value, the step width, and the current gain value. Furthermore, the
returned tuple contains the strings of the supported brightness
modes.
|
|
'camera_guid'
|
guid (string)
|
Returns the Global Unified Identifier (GUID) of the camera). The
returned string fits the format '0x<hexadecimal vendor
code>'.
|
|
'camera_model'
|
model_name (string)
|
Returns the name of the camera model.
|
|
'camera_type_values'
|
[<list of supported types> (string)]
|
Returns the supported values of the 'camera_type' parameter. The returned
camera types specify all the video settings supported by the
camera, containing video format, video mode, and frame rate. The
returned type strings fit the format 'format:mode:fps'.
In case of Format_7 the frame rate value is of no relevance and
-1 is returned instead. The supported color codings from Format_7
can be got via the parameter 'color_coding_values'.
|
|
'camera_vendor'
|
vendor_name (string)
|
Returns the name of the camera vendor.
|
|
'capture_quality_range'
|
[min (long),
max (long),
step_width (long),
current_value (long),
<'auto'> (string),
<'manual'> (string),
<'one_push'> (string),
<'off'> (string)]
|
Returns the supported range of the 'capture_quality' parameter. The first
four elements contain the minimal and maximal capture_quality value, the
step width, and the current capture_quality value. Furthermore, the returned
tuple contains the strings of the supported capture_quality modes.
|
|
'capture_size_range'
|
[min (long),
max (long),
step_width (long),
current_value (long),
<'auto'> (string),
<'manual'> (string),
<'one_push'> (string),
<'off'> (string)]
|
Returns the supported range of the 'capture_size' parameter. The first
four elements contain the minimal and maximal capture_size value, the
step width, and the current capture_size value. Furthermore, the returned
tuple contains the strings of the supported capture_size modes.
|
|
'color_coding_values'
|
[<list of supported color codings> (string)]
|
Returns the supported color_coding values. This query is
only supported if Format_7 is set.
|
|
'dcam_version'
|
version (string)
|
Returns the version number of the underlying
1394-based digital camera specification.
|
|
'exposure_range'
|
[min (long),
max (long),
step_width (long),
current_value (long),
<'auto'> (string),
<'manual'> (string),
<'one_push'> (string),
<'off'> (string)]
|
Returns the supported range of the 'exposure' parameter. The first
four elements contain the minimal and maximal exposure value, the
step width, and the current exposure value. Furthermore, the returned
tuple contains the strings of the supported exposure modes.
|
|
'focus_range'
|
[min (long),
max (long),
step_width (long),
current_value (long),
<'auto'> (string),
<'manual'> (string),
<'one_push'> (string),
<'off'> (string)]
|
Returns the supported range of the 'focus' parameter. The first
four elements contain the minimal and maximal focus value, the
step width, and the current focus value. Furthermore, the returned
tuple contains the strings of the supported focus modes.
|
|
'framerate'
|
fps (float)
|
The video frame rate of the camera. In case of Format_7 as
used video format the frame rate is estimated from the image size
in bytes and the size of the transferred bytes per packet and serves as a
upper reachable bound.
|
|
'gamma_range'
|
[min (long),
max (long),
step_width (long),
current_value (long),
<'auto'> (string),
<'manual'> (string),
<'one_push'> (string),
<'off'> (string)]
|
Returns the supported range of the 'gamma' parameter. The first
four elements contain the minimal and maximal gamma value, the
step width, and the current gamma value. Furthermore, the returned
tuple contains the strings of the supported gamma modes.
|
|
'horizontal_offset_range'
|
[min (long),
max (long),
step_width (long),
current_value (long)]
|
Returns the supported range of the 'horizontal_offset' parameter.
The four elements contain the minimal and maximal settable value, the
step width, and the current value of the parameter. This query
is only supported if Format_7 is set.
|
|
'horizontal_resolution_range'
|
[min (long),
max (long),
step_width (long),
current_value (long)]
|
Returns the supported range of the 'horizontal_resolution'
parameter. The four elements contain the minimal and maximal
settable image width, the step width, and the current value.
This query is only supported if Format_7 is set.
|
|
'hue_range'
|
[min (long),
max (long),
step_width (long),
current_value (long),
<'auto'> (string),
<'manual'> (string),
<'one_push'> (string),
<'off'> (string)]
|
Returns the supported range of the 'hue' parameter. The first
four elements contain the minimal and maximal hue value, the
step width, and the current hue value. Furthermore, the returned
tuple contains the strings of the supported hue modes.
|
|
'iris_range'
|
[min (long),
max (long),
step_width (long),
current_value (long),
<'auto'> (string),
<'manual'> (string),
<'one_push'> (string),
<'off'> (string)]
|
Returns the supported range of the 'iris' parameter. The first
four elements contain the minimal and maximal iris value, the
step width, and the current iris value. Furthermore, the returned
tuple contains the strings of the supported iris modes.
|
|
'optical_filter_range'
|
[min (long),
max (long),
step_width (long),
current_value (long),
<'auto'> (string),
<'manual'> (string),
<'one_push'> (string),
<'off'> (string)]
|
Returns the supported range of the 'optical_filter' parameter. The first
four elements contain the minimal and maximal optical_filter value, the
step width, and the current optical_filter value. Furthermore, the returned
tuple contains the strings of the supported optical_filter modes.
|
|
'packet_size_range'
|
[min (long),
max (long),
step_width (long),
current_value (long)]
|
Returns the supported range of the 'packet_size' parameter.
The four elements contain the minimal and maximal settable packet
size, the step width, and the current value of the packet size.
|
|
'pan_range'
|
[min (long),
max (long),
step_width (long),
current_value (long),
<'auto'> (string),
<'manual'> (string),
<'one_push'> (string),
<'off'> (string)]
|
Returns the supported range of the 'pan' parameter. The first
four elements contain the minimal and maximal pan value, the
step width, and the current pan value. Furthermore, the returned
tuple contains the strings of the supported pan modes.
|
|
'revision'
|
revision (string)
|
The revision number of the HALCON 1394IIDC interface.
|
|
'saturation_range'
|
[min (long),
max (long),
step_width (long),
current_value (long),
<'auto'> (string),
<'manual'> (string),
<'one_push'> (string),
<'off'> (string)]
|
Returns the supported range of the 'saturation' parameter. The
first four elements contain the minimal and maximal saturation
value, the step width, and the current saturation value.
Furthermore, the returned tuple contains the strings
of the supported saturation modes.
|
|
'sharpness_range'
|
[min (long),
max (long),
step_width (long),
current_value (long),
<'auto'> (string),
<'manual'> (string),
<'one_push'> (string),
<'off'> (string)]
|
Returns the supported range of the 'sharpness' parameter. The first
four elements contain the minimal and maximal sharpness value, the
step width, and the current sharpness value. Furthermore, the returned
tuple contains the strings of the supported sharpness modes.
|
|
'shutter_range'
|
[min (long),
max (long),
step_width (long),
current_value (long),
<'auto'> (string),
<'manual'> (string),
<'one_push'> (string),
<'off'> (string)]
|
Returns the supported range of the 'shutter' parameter. The first
four elements contain the minimal and maximal shutter value, the
step width and the current shutter value. Furthermore, the
returned tuple contains the strings of the supported shutter modes.
|
|
'temperature_range'
|
[min (long),
max (long),
target_temperature (long),
current_temperature (long),
<'auto'> (string),
<'manual'> (string),
<'one_push'> (string),
<'off'> (string)]
|
Returns the supported range of the 'temperature' parameter. The first
four elements contain the minimal and maximal temperature value, the
target temperature, and the current temperature. Furthermore, the returned
tuple contains the strings of the supported temperature modes.
|
|
'tilt_range'
|
[min (long),
max (long),
step_width (long),
current_value (long),
<'auto'> (string),
<'manual'> (string),
<'one_push'> (string),
<'off'> (string)]
|
Returns the supported range of the 'tilt' parameter. The first
four elements contain the minimal and maximal tilt value, the
step width, and the current tilt value. Furthermore, the returned
tuple contains the strings of the supported tilt modes.
|
|
'trigger'
|
[<'on/off capable'> (string),
<'polarity capable'> (string),
<'mode 0'> (string),
<'mode 1'> (string),
<'mode 2'> (string),
<'mode 3'> (string)]
|
Returns general informations about the trigger support of the camera including
the supported triger modes.
|
|
'trigger_mode_values'
|
[<list of supported modes> (long)]
|
The supported values of the 'trigger_mode' parameter. For the
meaning of the returned strings of the supported trigger modes see
the description of the 'trigger_mode' parameter.
|
|
'ub_range'
|
[min (long),
max (long),
step_width (long),
ub_value (long),
<'auto'> (string),
<'manual'> (string),
<'one_push'> (string),
<'off'> (string)]
|
Returns the supported range of the 'ub' parameter. The first
four elements contain the minimal and maximal value, the
step width, and the current value. Furthermore, the returned
tuple contains the strings of the supported white_balance modes.
|
|
'vertical_offset_range'
|
[min (long),
max (long),
step_width (long),
current_value (long)]
|
Returns the supported range of the 'vertical_offset' parameter.
The four elements contain the minimal and maximal settable value,
the step width and the current value of the parameter.
This query is only supported if Format_7 is set.
|
|
'vertical_resolution_range'
|
[min (long),
max (long),
step_width (long),
current_value (long)]
|
Returns the supported range of the 'vertical_resolution'
parameter. The four elements contain the minimal and
maximal settable image height, the step width, and the
current value. This query is only supported if Format_7 is set.
|
|
'video_gain_range'
|
[min (long),
max (long),
step_width (long),
current_value (long),
<'auto'> (string),
<'manual'> (string),
<'one_push'> (string),
<'off'> (string)]
|
Returns the supported range of the 'video_gain' parameter. The first
four elements contain the minimal and maximal gain value, the step
width, and the current value. Furthermore, the returned tuple
contains a strings of the supported gain modes.
|
|
'video_resolution'
|
resolution (string)
|
Returns the decoded video format and video mode setting within the
string format '<width>x<height>,
<color_code>' according to the
1394-based digital camera specification.
|
|
'vr_range'
|
[min (long),
max (long),
step_width (long),
vr_value (long),
<'auto'> (string),
<'manual'> (string),
<'one_push'> (string),
<'off'> (string)]
|
Returns the supported range of the 'vr' parameter. The first
four elements contain the minimal and maximal value, the
step width, and the current value. Furthermore, the returned
tuple contains the strings of the supported white_balance modes.
|
|
'white_shading_range'
|
[min (long),
max (long),
r_value (long),
g_value (long),
b_value (long),
<'auto'> (string),
<'manual'> (string),
<'one_push'> (string),
<'off'> (string)]
|
Returns the supported range of the 'white_shading' parameter. The first
five elements contain the minimal and maximal allowed values and the
current R, G and B values. Furthermore, the returned
tuple contains the strings of the supported white shading modes.
|
|
'zoom_range'
|
[min (long),
max (long),
step_width (long),
current_value (long),
<'auto'> (string),
<'manual'> (string),
<'one_push'> (string),
<'off'> (string)]
|
Returns the supported range of the 'zoom' parameter. The first
four elements contain the minimal and maximal zoom value, the
step width, and the current zoom value. Furthermore, the returned
tuple contains the strings of the supported zoom modes.
|
Release Notes
-
Revision 2.3 (Dec 1, 2008):
-
Format7 can be dynamically changed by parameter 'camera_type' now.
-
Bugfix in close_framegrabber, which led to an exception.
-
The values of the parameters 'horizontal_resolution' and
'vertical_resolution' are set correctly now.
-
Revision 2.2 (Sep 30, 2008):
-
Statically linked with latest versions of libdc1394_control.a
and libraw1394.a.
-
Added support of Linux x86_64 systems.
-
Added missing documentation of the parameter
'start_async_after_grab_async'.
-
Revision 2.1 (Apr 19, 2007):
-
Several small bugfixes to improve the stability.
-
Revision 2.0 (Nov 30, 2006):
|