Aravis.Camera¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37), Gio.Initable (2)
Structs:: GObject.ObjectClass (5)

class	`new` (name)
class	`new_with_device` (device)
	`abort_acquisition` ()
	`acquisition` (timeout)
	`are_chunks_available` ()
	`clear_triggers` ()
	`create_chunk_parser` ()
	`create_stream` (callback, *user_data)
	`dup_available_black_levels` ()
	`dup_available_components` ()
	`dup_available_enumerations` (feature)
	`dup_available_enumerations_as_display_names` (feature)
	`dup_available_enumerations_as_strings` (feature)
	`dup_available_gains` ()
	`dup_available_pixel_formats` ()
	`dup_available_pixel_formats_as_display_names` ()
	`dup_available_pixel_formats_as_strings` ()
	`dup_available_trigger_sources` ()
	`dup_available_triggers` ()
	`dup_register` (feature)
	`execute_command` (feature)
	`get_acquisition_mode` ()
	`get_binning` ()
	`get_black_level` ()
	`get_black_level_auto` ()
	`get_black_level_bounds` ()
	`get_boolean` (feature)
	`get_chunk_mode` ()
	`get_chunk_state` (chunk)
	`get_device` ()
	`get_device_id` ()
	`get_device_serial_number` ()
	`get_exposure_time` ()
	`get_exposure_time_auto` ()
	`get_exposure_time_bounds` ()
	`get_exposure_time_increment` ()
	`get_exposure_time_representation` ()
	`get_feature_representation` (feature)
	`get_float` (feature)
	`get_float_bounds` (feature)
	`get_float_increment` (feature)
	`get_frame_count` ()
	`get_frame_count_bounds` ()
	`get_frame_rate` ()
	`get_frame_rate_bounds` ()
	`get_frame_rate_enable` ()
	`get_gain` ()
	`get_gain_auto` ()
	`get_gain_bounds` ()
	`get_gain_increment` ()
	`get_gain_representation` ()
	`get_height_bounds` ()
	`get_height_increment` ()
	`get_integer` (feature)
	`get_integer_bounds` (feature)
	`get_integer_increment` (feature)
	`get_model_name` ()
	`get_payload` ()
	`get_pixel_format` ()
	`get_pixel_format_as_string` ()
	`get_region` ()
	`get_sensor_size` ()
	`get_string` (feature)
	`get_trigger_source` ()
	`get_vendor_name` ()
	`get_width_bounds` ()
	`get_width_increment` ()
	`get_x_binning_bounds` ()
	`get_x_binning_increment` ()
	`get_x_offset_bounds` ()
	`get_x_offset_increment` ()
	`get_y_binning_bounds` ()
	`get_y_binning_increment` ()
	`get_y_offset_bounds` ()
	`get_y_offset_increment` ()
	`gv_auto_packet_size` ()
	`gv_get_current_stream_channel` ()
	`gv_get_ip_configuration_mode` ()
	`gv_get_multipart` ()
	`gv_get_n_network_interfaces` ()
	`gv_get_n_stream_channels` ()
	`gv_get_packet_delay` ()
	`gv_get_packet_size` ()
	`gv_get_persistent_ip` ()
	`gv_is_multipart_supported` ()
	`gv_select_stream_channel` (channel_id)
	`gv_set_ip_configuration_mode` (mode)
	`gv_set_multipart` (enable)
	`gv_set_packet_delay` (delay_ns)
	`gv_set_packet_size` (packet_size)
	`gv_set_packet_size_adjustment` (adjustment)
	`gv_set_persistent_ip` (ip, mask, gateway)
	`gv_set_persistent_ip_from_string` (ip, mask, gateway)
	`gv_set_stream_options` (options)
	`is_binning_available` ()
	`is_black_level_auto_available` ()
	`is_black_level_available` ()
	`is_component_available` ()
	`is_enumeration_entry_available` (feature, entry)
	`is_exposure_auto_available` ()
	`is_exposure_time_available` ()
	`is_feature_available` (feature)
	`is_feature_implemented` (feature)
	`is_frame_rate_available` ()
	`is_gain_auto_available` ()
	`is_gain_available` ()
	`is_gv_device` ()
	`is_region_offset_available` ()
	`is_software_trigger_supported` ()
	`is_uv_device` ()
	`select_and_enable_component` (component, disable_others)
	`select_black_level` (selector)
	`select_component` (component, flags)
	`select_gain` (selector)
	`set_access_check_policy` (policy)
	`set_acquisition_mode` (value)
	`set_binning` (dx, dy)
	`set_black_level` (blacklevel)
	`set_black_level_auto` (auto_mode)
	`set_boolean` (feature, value)
	`set_chunk_mode` (is_active)
	`set_chunk_state` (chunk, is_enabled)
	`set_chunks` (chunk_list)
	`set_exposure_mode` (mode)
	`set_exposure_time` (exposure_time_us)
	`set_exposure_time_auto` (auto_mode)
	`set_float` (feature, value)
	`set_frame_count` (frame_count)
	`set_frame_rate` (frame_rate)
	`set_frame_rate_enable` (enable)
	`set_gain` (gain)
	`set_gain_auto` (auto_mode)
	`set_integer` (feature, value)
	`set_pixel_format` (format)
	`set_pixel_format_from_string` (format)
	`set_range_check_policy` (policy)
	`set_region` (x, y, width, height)
	`set_register` (feature, length, value)
	`set_register_cache_policy` (policy)
	`set_string` (feature, value)
	`set_trigger` (source)
	`set_trigger_source` (source)
	`software_trigger` ()
	`start_acquisition` ()
	`stop_acquisition` ()
	`uv_get_bandwidth` ()
	`uv_get_bandwidth_bounds` ()
	`uv_is_bandwidth_control_available` ()
	`uv_set_bandwidth` (bandwidth)
	`uv_set_usb_mode` (usb_mode)

Virtual Methods¶

Inherited:: GObject.Object (7), Gio.Initable (1)

Properties¶

Name	Type	Flags	Short Description
`device`	`Aravis.Device`	r/w/co	The device associated with this camera
`name`	`str`	w/co	The camera name

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent_instance	`GObject.Object`	r

Class Details¶

class Aravis.Camera(**kwargs)¶

Bases:: GObject.Object, Gio.Initable
Abstract:: No
Structure:: Aravis.CameraClass

[class`Aravis`.Camera] is a class for the generic control of cameras. It hides the complexity of the genicam interface by providing a simple API, with the drawback of not exposing all the available features. See [class`Aravis`.Device] and [class`Aravis`.Gc] for a more advanced use of the Aravis library.

classmethod new(name)¶

Parameters:: name (str or None) – name of the camera.
Raises:: GLib.Error
Returns:: a new Aravis.Camera.
Return type:: Aravis.Camera

Creates a new Aravis.Camera. If name is null, it will instantiate the first available camera.

If the camera is a GigEVision, name can be either:

<vendor>-<model>-<serial>
<vendor_alias>-<serial>
<vendor>-<serial>
<user_id>
<ip_address>
<mac_address>

For example:

The Imaging Source Europe GmbH-DFK 33GX265-39020369
The Imaging Source Europe GmbH-39020369
TIS-39020369
192.168.0.2
00:07:48:py:data::af<Aravis.Camera.props.af>:a2:61

If the camera is a USB3Vision device, name is either:

<vendor_alias>-<serial>
<vendor>-<serial>

Added in version 0.8.0.

classmethod new_with_device(device)¶

Parameters:: device (Aravis.Device) – a Aravis.Device
Raises:: GLib.Error
Returns:: a new Aravis.Camera.
Return type:: Aravis.Camera

Creates a new Aravis.Camera, using device as its internal device object.

Added in version 0.8.6.

abort_acquisition()¶

Raises:: GLib.Error

Aborts video stream acquisition.

Added in version 0.8.0.

acquisition(timeout)¶

Parameters:: timeout (int) – acquisition timeout in µs. Zero means no timeout.
Raises:: GLib.Error
Returns:: A new Aravis.Buffer, None on error. The returned buffer must be freed using [method`GObject`.Object.unref].
Return type:: Aravis.Buffer

Acquire one image buffer.

Aravis.Camera.acquisition() sets the camera in SingleFrame acquisition mode. You may have to put back the camera in Continuous acquisition mode for later operations, using Aravis.Camera.set_acquisition_mode().

Added in version 0.8.0.

are_chunks_available()¶

Raises:: GLib.Error
Returns:: True if chunk data are available
Return type:: bool

Added in version 0.8.8.

clear_triggers()¶

Raises:: GLib.Error

Disables all triggers.

Added in version 0.8.0.

create_chunk_parser()¶

Returns:: a new [class`ArvChunkParser`].
Return type:: Aravis.ChunkParser

Creates a new [class`ArvChunkParser`] object, used for the extraction of chunk data from [class`ArvBuffer`].

Added in version 0.4.0.

create_stream(callback, *user_data)¶

Parameters:

callback (Aravis.StreamCallback or None) – a frame processing callback
user_data (object or None) – user data for callback

Raises:

GLib.Error

Returns:

a new [class`ArvStream`], to be freed after use with [method`GObject`.Object.unref].

Return type:

Aravis.Stream

Creates a new [class`ArvStream`] for video stream reception. See [callback`ArvStreamCallback`] for details regarding the callback function.

Added in version 0.8.23.

dup_available_black_levels()¶

Raises:: GLib.Error
Returns:: a newly allocated array of strings, to be freed after use with GLib.free().
Return type:: [str]

Retrieves the list of all available black level selectors as strings.

Added in version 0.8.27.

dup_available_components()¶

Raises:: GLib.Error
Returns:: a newly allocated array of strings, to be freed after use with GLib.free().
Return type:: [str]

Retrieves the list of available components.

Added in version 0.8.23.

dup_available_enumerations(feature)¶

Parameters:: feature (str) – feature name
Raises:: GLib.Error
Returns:: a newly created array of integers, which must freed after use using GLib.free, or None on error.
Return type:: [int]

Get all the available values of feature, as 64 bit integers.

Added in version 0.8.0.

dup_available_enumerations_as_display_names(feature)¶

Parameters:: feature (str) – feature name
Raises:: GLib.Error
Returns:: a newly created array of const strings, to be freed after use using GLib.free, or None on error.
Return type:: [str]

Get display names of all the available entries of feature.

Added in version 0.8.0.

dup_available_enumerations_as_strings(feature)¶

Parameters:: feature (str) – feature name
Raises:: GLib.Error
Returns:: a newly created array of const strings, which must freed after use using GLib.free, or None on error.
Return type:: [str]

Get all the available values of feature, as strings.

Added in version 0.8.0.

dup_available_gains()¶

Raises:: GLib.Error
Returns:: a newly allocated array of strings, to be freed after use with GLib.free().
Return type:: [str]

Retrieves the list of all available gain selectors as strings.

Added in version 0.8.27.

dup_available_pixel_formats()¶

Raises:: GLib.Error
Returns:: a newly allocated array of #ArvPixelFormat, to be freed after use with GLib.free().
Return type:: [int]

Retrieves the list of all available pixel formats.

Added in version 0.8.0.

dup_available_pixel_formats_as_display_names()¶

Raises:: GLib.Error
Returns:: a newly allocated array of string constants, to be freed after use with GLib.free().
Return type:: [str]

Retrieves the list of all available pixel formats as display names. In general, these human-readable strings cannot be used as settings.

Added in version 0.8.0.

dup_available_pixel_formats_as_strings()¶

Raises:: GLib.Error
Returns:: a newly allocated array of strings, to be freed after use with GLib.free().
Return type:: [str]

Retrieves the list of all available pixel formats as strings.

Added in version 0.8.0.

dup_available_trigger_sources()¶

Raises:: GLib.Error
Returns:: a newly allocated array of strings, which must be freed using [func`GLib`.free].
Return type:: [str]

Gets the list of all available trigger sources.

Added in version 0.8.0.

dup_available_triggers()¶

Raises:: GLib.Error
Returns:: a newly allocated array of strings, which must be freed using [func`GLib`.free].
Return type:: [str]

Gets a list of all available triggers: FrameStart, ExposureActive, etc…

Added in version 0.8.0.

dup_register(feature)¶

Parameters:

feature (str) – feature name

Raises:

GLib.Error

Returns:

register content, must be freed using [func`GLib`.free].

length:: register length

Return type:

(object or None, length: int)

Added in version 0.8.31.

execute_command(feature)¶

Parameters:: feature (str) – feature name
Raises:: GLib.Error

Execute a Genicam command.

Added in version 0.8.0.

get_acquisition_mode()¶

Raises:: GLib.Error
Returns:: acquisition mode.
Return type:: Aravis.AcquisitionMode

Added in version 0.8.0.

get_binning()¶

Raises:

GLib.Error

Returns:

dx:: horizontal binning placeholder
dy:: vertical binning placeholder

Return type:

(dx: int, dy: int)

Retrieves binning in both directions.

Added in version 0.8.0.

get_black_level()¶

Raises:: GLib.Error
Returns:: the current blacklevel setting.
Return type:: float

Added in version 0.8.19.

get_black_level_auto()¶

Raises:: GLib.Error
Returns:: auto black level mode selection
Return type:: Aravis.Auto

Added in version 0.8.19.

get_black_level_bounds()¶

Raises:

GLib.Error

Returns:

min:: minimum blacklevel
max:: maximum blacklevel

Return type:

(min: float, max: float)

Retrieves blacklevel bounds.

Added in version 0.8.19.

get_boolean(feature)¶

Parameters:: feature (str) – feature name
Raises:: GLib.Error
Returns:: output value
Return type:: value: bool

Added in version 0.8.0.

get_chunk_mode()¶

Raises:: GLib.Error
Returns:: True if chunk data mode is active.
Return type:: bool

Check wether chunk data mode is active. Please see Aravis.Camera.set_chunk_mode().

Added in version 0.8.0.

get_chunk_state(chunk)¶

Parameters:: chunk (str) – chunk data name
Raises:: GLib.Error
Returns:: True if chunk is enabled.
Return type:: bool

Gets state of chunk data. Chunk data are be embedded in Aravis.Buffer only if chunk mode is active. Please see Aravis.Camera.set_chunk_mode().

Added in version 0.8.0.

get_device()¶

Returns:: underlying device object.
Return type:: Aravis.Device

Retrieves the Aravis.Device object for more complete access to camera features.

Added in version 0.2.0.

get_device_id()¶

Raises:: GLib.Error
Returns:: the camera device ID.
Return type:: str

Added in version 0.8.0.

get_device_serial_number()¶

Raises:: GLib.Error
Returns:: the camera device serial number.
Return type:: str

Added in version 0.8.8.

get_exposure_time()¶

Raises:: GLib.Error
Returns:: current exposure time, in µs.
Return type:: float

Added in version 0.8.0.

get_exposure_time_auto()¶

Raises:: GLib.Error
Returns:: auto exposure mode selection
Return type:: Aravis.Auto

Added in version 0.8.0.

get_exposure_time_bounds()¶

Raises:

GLib.Error

Returns:

min:: minimum exposure time, or -GObject.G_MAXDOUBLE on error
max:: maximum exposure time, or GObject.G_MAXDOUBLE on error

Return type:

(min: float, max: float)

Retrieves exposure time bounds, in µs.

Added in version 0.8.0.

get_exposure_time_increment()¶

Raises:: GLib.Error
Returns:: exposure time increment, in µs, or GObject.G_MINDOUBLE on error.
Return type:: float

Added in version 0.8.36.

get_exposure_time_representation()¶

Returns:: exposure time representation, Aravis.GcRepresentation.UNDEFINED if not available.
Return type:: Aravis.GcRepresentation

Added in version 0.8.31.

get_feature_representation(feature)¶

Parameters:: feature (str) – feature name
Returns:: the feature representation, Aravis.GcRepresentation.UNDEFINED if not available.
Return type:: Aravis.GcRepresentation

Added in version 0.8.31.

get_float(feature)¶

Parameters:: feature (str) – feature name
Raises:: GLib.Error
Returns:: the float feature value, 0.0 on error.
Return type:: float

Added in version 0.8.0.

get_float_bounds(feature)¶

Parameters:

feature (str) – feature name

Raises:

GLib.Error

Returns:

min:: minimum feature value
max:: maximum feature value

Return type:

(min: float, max: float)

Retrieves float feature bounds.

Added in version 0.8.0.

get_float_increment(feature)¶

Parameters:: feature (str) – feature name
Raises:: GLib.Error
Returns:: feature value increment, or GObject.G_MINDOUBLE on error.
Return type:: float

Added in version 0.8.16.

get_frame_count()¶

Raises:: GLib.Error
Returns:: number of frames to capture in MultiFrame mode.
Return type:: int

Added in version 0.8.0.

get_frame_count_bounds()¶

Raises:

GLib.Error

Returns:

min:: minimal possible frame count
max:: maximum possible frame count

Return type:

(min: int, max: int)

Retrieves allowed range for frame count.

Added in version 0.8.0.

get_frame_rate()¶

Raises:: GLib.Error
Returns:: actual frame rate, in Hz.
Return type:: float

Added in version 0.8.0.

get_frame_rate_bounds()¶

Raises:

GLib.Error

Returns:

min:: minimal possible framerate
max:: maximum possible framerate

Return type:

(min: float, max: float)

Retrieves allowed range for framerate.

Added in version 0.8.0.

get_frame_rate_enable()¶

Raises:

GLib.Error

Returns:

whether the upper frame rate limit is enabled.

Implements vendor specific quirks if needed.

Return type:

bool

Added in version 0.8.31.

get_gain()¶

Raises:: GLib.Error
Returns:: the current gain setting.
Return type:: float

Added in version 0.8.0.

get_gain_auto()¶

Raises:: GLib.Error
Returns:: auto gain mode selection
Return type:: Aravis.Auto

Added in version 0.8.0.

get_gain_bounds()¶

Raises:

GLib.Error

Returns:

min:: minimum gain, or -GObject.G_MAXDOUBLE on error
max:: maximum gain, or GObject.G_MAXDOUBLE on error

Return type:

(min: float, max: float)

Retrieves gain bounds.

Added in version 0.8.0.

get_gain_increment()¶

Raises:: GLib.Error
Returns:: gain increment, or GObject.G_MINDOUBLE on error.
Return type:: float

Added in version 0.8.36.

get_gain_representation()¶

Returns:: gain representation, Aravis.GcRepresentation.UNDEFINED if not available.
Return type:: Aravis.GcRepresentation

Added in version 0.8.31.

get_height_bounds()¶

Raises:

GLib.Error

Returns:

min:: minimum height
max:: maximum height

Return type:

(min: int, max: int)

Retrieves the valid range for image height.

Added in version 0.8.0.

get_height_increment()¶

Raises:: GLib.Error
Returns:: height value increment.
Return type:: int

Added in version 0.8.0.

get_integer(feature)¶

Parameters:: feature (str) – feature name
Raises:: GLib.Error
Returns:: the integer feature value, 0 on error.
Return type:: int

Added in version 0.8.0.

get_integer_bounds(feature)¶

Parameters:

feature (str) – feature name

Raises:

GLib.Error

Returns:

min:: minimum feature value
max:: maximum feature value

Return type:

(min: int, max: int)

Retrieves integer feature bounds.

Added in version 0.8.0.

get_integer_increment(feature)¶

Parameters:: feature (str) – feature name
Raises:: GLib.Error
Returns:: feature value increment, or 1 on error.
Return type:: int

Added in version 0.8.0.

get_model_name()¶

Raises:: GLib.Error
Returns:: the camera model name.
Return type:: str

Added in version 0.8.0.

get_payload()¶

Raises:: GLib.Error
Returns:: frame storage size, in bytes.
Return type:: int

Retrieves the size needed for the storage of an image. This value is used for the creation of the stream buffers.

Added in version 0.8.0.

get_pixel_format()¶

Raises:: GLib.Error
Returns:: pixel format.
Return type:: int

Added in version 0.8.0.

get_pixel_format_as_string()¶

Raises:: GLib.Error
Return type:: str

Retuns: pixel format as string, None on error.

Added in version 0.8.0.

get_region()¶

Raises:

GLib.Error

Returns:

x:: x offset
y:: y_offset
width:: region width
height:: region height

Return type:

(x: int, y: int, width: int, height: int)

Retrieves the current region of interest.

Added in version 0.8.0.

get_sensor_size()¶

Raises:

GLib.Error

Returns:

width:: camera sensor width
height:: camera sensor height

Return type:

(width: int, height: int)

Added in version 0.8.0.

get_string(feature)¶

Parameters:: feature (str) – feature name
Raises:: GLib.Error
Returns:: the string feature value, None on error.
Return type:: str

Added in version 0.8.0.

get_trigger_source()¶

Raises:: GLib.Error
Returns:: a string containing the trigger source name, None on error.
Return type:: str

Gets the trigger source. This function doesn’t check if the camera is configured to actually use this source as a trigger.

Added in version 0.8.0.

get_vendor_name()¶

Raises:: GLib.Error
Returns:: the camera vendor name.
Return type:: str

Added in version 0.8.0.

get_width_bounds()¶

Raises:

GLib.Error

Returns:

min:: minimum width
max:: maximum width

Return type:

(min: int, max: int)

Retrieves the valid range for image width.

Added in version 0.8.0.

get_width_increment()¶

Raises:: GLib.Error
Returns:: width value increment.
Return type:: int

Added in version 0.8.0.

get_x_binning_bounds()¶

Raises:

GLib.Error

Returns:

min:: minimum binning
max:: maximum binning

Return type:

(min: int, max: int)

Retrieves the valid range for image horizontal binning.

Added in version 0.8.0.

get_x_binning_increment()¶

Raises:: GLib.Error
Returns:: horizontal binning value increment.
Return type:: int

Added in version 0.8.0.

get_x_offset_bounds()¶

Raises:

GLib.Error

Returns:

min:: minimum offset
max:: maximum offset

Return type:

(min: int, max: int)

Retrieves the valid range for image horizontal offset.

Added in version 0.8.0.

get_x_offset_increment()¶

Raises:: GLib.Error
Returns:: horizontal offset value increment.
Return type:: int

Added in version 0.8.0.

get_y_binning_bounds()¶

Raises:

GLib.Error

Returns:

min:: minimum binning
max:: maximum binning

Return type:

(min: int, max: int)

Retrieves the valid range for image vertical binning.

Added in version 0.8.0.

get_y_binning_increment()¶

Raises:: GLib.Error
Returns:: vertical binning value increment.
Return type:: int

Added in version 0.8.0.

get_y_offset_bounds()¶

Raises:

GLib.Error

Returns:

min:: minimum offset
max:: maximum offset

Return type:

(min: int, max: int)

Retrieves the valid range for image vertical offset.

Added in version 0.8.0.

get_y_offset_increment()¶

Raises:: GLib.Error
Returns:: vertical offset value increment.
Return type:: int

Added in version 0.8.0.

gv_auto_packet_size()¶

Raises:: GLib.Error
Returns:: The packet size, in bytes.
Return type:: int

Automatically determine the biggest packet size that can be used data streaming, and set GevSCPSPacketSize value accordingly. This function relies on the GevSCPSFireTestPacket feature. If this feature is not available, the packet size will be set to a default value (1500 bytes).

Added in version 0.8.0.

gv_get_current_stream_channel()¶

Raises:: GLib.Error
Returns:: The current stream channel id.
Return type:: int

Added in version 0.8.0.

gv_get_ip_configuration_mode()¶

Raises:: GLib.Error
Returns:: IP address configuration mode
Return type:: Aravis.GvIpConfigurationMode

Get the IP address configuration mode.

Added in version 0.8.22.

gv_get_multipart()¶

Raises:: GLib.Error
Returns:: True if multipart payload support is enabled.
Return type:: bool

Added in version 0.8.23.

gv_get_n_network_interfaces()¶

Raises:: GLib.Error
Returns:: the number of device network interfaces.
Return type:: int

Added in version 0.8.25.

gv_get_n_stream_channels()¶

Raises:: GLib.Error
Returns:: the number of supported stream channels.
Return type:: int

Added in version 0.8.0.

gv_get_packet_delay()¶

Raises:: GLib.Error
Returns:: The inter packet delay, in nanoseconds.
Return type:: int

Added in version 0.8.0.

gv_get_packet_size()¶

Raises:: GLib.Error
Returns:: The stream packet size, in bytes.
Return type:: int

Added in version 0.8.0.

gv_get_persistent_ip()¶

Raises:

GLib.Error

Returns:

ip:: a IP address placeholder
mask:: a netmask placeholder, None to ignore
gateway:: a gateway IP address placeholder, None to ignore

Return type:

(ip: Gio.InetAddress, mask: Gio.InetAddressMask, gateway: Gio.InetAddress)

Get the persistent IP address setting of camera.

Added in version 0.8.22.

gv_is_multipart_supported()¶

Raises:: GLib.Error
Returns:: True if multipart payload is supported by self.
Return type:: bool

Added in version 0.8.23.

gv_select_stream_channel(channel_id)¶

Parameters:: channel_id (int) – id of the channel to select
Raises:: GLib.Error

Select the current stream channel. Negative channel_id is ignored.

Added in version 0.8.0.

gv_set_ip_configuration_mode(mode)¶

Parameters:: mode (Aravis.GvIpConfigurationMode) – IP address configuration mode
Raises:: GLib.Error

Sets the IP address configuration mode. Available modes are Aravis.GvIpConfigurationMode.DHCP, Aravis.GvIpConfigurationMode.PERSISTENT_IP, Aravis.GvIpConfigurationMode.LLA

Added in version 0.8.22.

gv_set_multipart(enable)¶

Parameters:: enable (bool) – True to enable multipart
Raises:: GLib.Error

Control multipart payload support

Added in version 0.8.23.

gv_set_packet_delay(delay_ns)¶

Parameters:: delay_ns (int) – inter packet delay, in nanoseconds
Raises:: GLib.Error

Configure the inter packet delay to insert between each packet for the current stream channel. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device. Negative delay_ns is ignored.

Added in version 0.8.0.

gv_set_packet_size(packet_size)¶

Parameters:: packet_size (int) – packet size, in bytes
Raises:: GLib.Error

Specifies the stream packet size, in bytes, to send on the selected channel for a GVSP transmitter or specifies the maximum packet size supported by a GVSP receiver.

This does not include data leader and data trailer and the last data packet which might be of smaller size (since packet size is not necessarily a multiple of block size for stream channel). Negative packet_size is ignored.

Added in version 0.8.0.

gv_set_packet_size_adjustment(adjustment)¶

Parameters:: adjustment (Aravis.GvPacketSizeAdjustment) – a Aravis.GvPacketSizeAdjustment option

Sets the option for packet size adjustment that happens at stream object creation.

Added in version 0.8.3.

gv_set_persistent_ip(ip, mask, gateway)¶

Parameters:

ip (Gio.InetAddress) – IPv4 address
mask (Gio.InetAddressMask) – Netmask
gateway (Gio.InetAddress) – Gateway IPv4 address

Raises:

GLib.Error

Sets the persistent IP address to camera.

Added in version 0.8.22.

gv_set_persistent_ip_from_string(ip, mask, gateway)¶

Parameters:

ip (str) – IPv4 address in string format
mask (str) – netmask in string format
gateway (str) – Gateway IPv4 address in string format

Raises:

GLib.Error

Sets the persistent IP address to camera.

Added in version 0.8.22.

gv_set_stream_options(options)¶

Parameters:: options (Aravis.GvStreamOption) – option for stream creation

Sets the options used during stream object creation. These options mus be set before the call to Aravis.Camera.create_stream().

Added in version 0.6.0.

is_binning_available()¶

Raises:: GLib.Error
Returns:: True if Binning feature is available.
Return type:: bool

Added in version 0.8.0.

is_black_level_auto_available()¶

Raises:: GLib.Error
Returns:: True if auto black level feature is available.
Return type:: bool

Added in version 0.8.19.

is_black_level_available()¶

Raises:: GLib.Error
Returns:: True if BlackLevel feature is available.
Return type:: bool

Added in version 0.8.19.

is_component_available()¶

Raises:: GLib.Error
Returns:: True if Component features are available.
Return type:: bool

Added in version 0.8.25.

is_enumeration_entry_available(feature, entry)¶

Parameters:

feature (str) – enumeration feature name
entry (str) – entry name

Raises:

GLib.Error

Returns:

True if the feature and the feature entry are available

Return type:

bool

Added in version 0.8.17.

is_exposure_auto_available()¶

Raises:: GLib.Error
Returns:: True if Exposure Auto feature is available.
Return type:: bool

Added in version 0.8.0.

is_exposure_time_available()¶

Raises:: GLib.Error
Returns:: True if Exposure Time feature is available.
Return type:: bool

Added in version 0.8.0.

is_feature_available(feature)¶

Parameters:: feature (str) – feature name
Raises:: GLib.Error
Returns:: True if feature is available, False if not or on error.
Return type:: bool

Added in version 0.8.0.

is_feature_implemented(feature)¶

Parameters:: feature (str) – feature name
Raises:: GLib.Error
Returns:: True if feature is implemented, False if not or on error.
Return type:: bool

Added in version 0.8.23.

is_frame_rate_available()¶

Raises:: GLib.Error
Returns:: True if FrameRate feature is available
Return type:: bool

Added in version 0.8.0.

is_gain_auto_available()¶

Raises:: GLib.Error
Returns:: True if auto gain feature is available.
Return type:: bool

Added in version 0.8.0.

is_gain_available()¶

Raises:: GLib.Error
Returns:: True if Gain feature is available.
Return type:: bool

Added in version 0.8.0.

is_gv_device()¶

Returns:: True if self is a GigEVision device.
Return type:: bool

Added in version 0.4.0.

is_region_offset_available()¶

Raises:: GLib.Error
Returns:: True if OffsetX and OffsetY features are available.
Return type:: bool

Added in version 0.8.22.

is_software_trigger_supported()¶

Raises:: GLib.Error
Returns:: True if software trigger is supported by self.
Return type:: bool

Added in version 0.8.17.

is_uv_device()¶

Returns:: True if self is a USB3Vision device.
Return type:: bool

Added in version 0.6.0.

select_and_enable_component(component, disable_others)¶

Parameters:

component (str) – component to select
disable_others (bool) – True to disable all the other components

Raises:

GLib.Error

Select and enable the given component.

Added in version 0.8.23.

select_black_level(selector)¶

Parameters:: selector (str) – black level selection
Raises:: GLib.Error

Configures Black Level Selector feature.

Added in version 0.8.27.

select_component(component, flags)¶

Parameters:

component (str) – component to select
flags (Aravis.ComponentSelectionFlags) – a Aravis.ComponentSelectionFlags

Raises:

GLib.Error

Returns:

True if the component is enabled

component_id:: a placeholder for the component id

Return type:

(bool, component_id: int)

Select and enable or disable the given component.

Added in version 0.8.25.

select_gain(selector)¶

Parameters:: selector (str) – gain selector
Raises:: GLib.Error

Configures Gain Selector feature.

Added in version 0.8.27.

set_access_check_policy(policy)¶

Parameters:: policy (Aravis.AccessCheckPolicy) – access check policy

Sets the feature access check policy. When enabled, before being accessed, the actual read/write access of register is checked using AccessMode properties. On some devices, it helps to avoid forbidden writes to registers that may put the device in a bad state.

Access check is disabled by default.

Added in version 0.8.22.

set_acquisition_mode(value)¶

Parameters:: value (Aravis.AcquisitionMode)
Raises:: GLib.Error

set_binning(dx, dy)¶

Parameters:

dx (int) – horizontal binning
dy (int) – vertical binning

Raises:

GLib.Error

Defines binning in both directions. Not all cameras support this feature. Negative dx or dy values are ignored.

Added in version 0.8.0.

set_black_level(blacklevel)¶

Parameters:: blacklevel (float) – blacklevel value
Raises:: GLib.Error

Added in version 0.8.19.

set_black_level_auto(auto_mode)¶

Parameters:: auto_mode (Aravis.Auto) – auto black_level mode selection
Raises:: GLib.Error

Configures automatic black level feature.

Added in version 0.8.19.

set_boolean(feature, value)¶

Parameters:

feature (str) – feature name
value (bool) – new feature value

Raises:

GLib.Error

Set a boolean feature value.

Added in version 0.8.0.

set_chunk_mode(is_active)¶

Parameters:: is_active (bool) – wether to enable chunk data mode
Raises:: GLib.Error

Controls wether chunk data mode is active. When active, chunk data are appended to image data in Aravis.Buffer. A Aravis.ChunkParser must be used in order to extract chunk data.

Added in version 0.8.0.

set_chunk_state(chunk, is_enabled)¶

Parameters:

chunk (str) – chunk data name
is_enabled (bool) – wether to enable this chunk

Raises:

GLib.Error

Sets state of a chunk data. Chunk data are be embedded in Aravis.Buffer only if chunk mode is active. Please see Aravis.Camera.set_chunk_mode().

Added in version 0.8.0.

set_chunks(chunk_list)¶

Parameters:: chunk_list (str) – chunk data names, as a comma or space separated list
Raises:: GLib.Error

Convenience function for enabling a set of chunk data. Chunk mode is activated, or deactivated if chunk_list is None or empty. All chunk data not listed are disabled.

Added in version 0.8.0.

set_exposure_mode(mode)¶

Parameters:: mode (Aravis.ExposureMode)
Raises:: GLib.Error

set_exposure_time(exposure_time_us)¶

Parameters:: exposure_time_us (float) – exposure time, in µs
Raises:: GLib.Error

Sets exposure time. User should take care to set a value compatible with the desired frame rate. Negative exposure_time_us is ignored.

Added in version 0.8.0.

set_exposure_time_auto(auto_mode)¶

Parameters:: auto_mode (Aravis.Auto) – auto exposure mode selection
Raises:: GLib.Error

Configures automatic exposure feature.

Added in version 0.8.0.

set_float(feature, value)¶

Parameters:

feature (str) – feature name
value (float) – new feature value

Raises:

GLib.Error

Set a float feature value.

Added in version 0.8.0.

set_frame_count(frame_count)¶

Parameters:: frame_count (int) – number of frames to capture in MultiFrame mode
Raises:: GLib.Error

Sets the number of frames to capture in MultiFrame mode.

Added in version 0.8.0.

set_frame_rate(frame_rate)¶

Parameters:: frame_rate (float) – frame rate, in Hz
Raises:: GLib.Error

Configures a fixed frame rate mode. Once acquisition start is triggered, the video stream will be acquired with the given frame rate. A negative or zero frame_rate value disables the frame rate limit.

All triggers are disabled.

Added in version 0.8.0.

set_frame_rate_enable(enable)¶

Parameters:: enable (bool)
Raises:: GLib.Error

set_gain(gain)¶

Parameters:: gain (float) – gain value
Raises:: GLib.Error

Sets the gain of the ADC converter. Negative gain is ignored.

Added in version 0.8.0.

set_gain_auto(auto_mode)¶

Parameters:: auto_mode (Aravis.Auto) – auto gain mode selection
Raises:: GLib.Error

Configures automatic gain feature.

Added in version 0.8.0.

set_integer(feature, value)¶

Parameters:

feature (str) – feature name
value (int) – new feature value

Raises:

GLib.Error

Set an integer feature value.

Added in version 0.8.0.

set_pixel_format(format)¶

Parameters:: format (int) – pixel format
Raises:: GLib.Error

Defines pixel format.

Added in version 0.8.0.

set_pixel_format_from_string(format)¶

Parameters:: format (str) – pixel format
Raises:: GLib.Error

Defines pixel format described by a string.

Added in version 0.8.0.

set_range_check_policy(policy)¶

Parameters:: policy (Aravis.RangeCheckPolicy) – range check policy

Sets the feature range check policy. When enabled, before being set, the value of all nodes with an Aravis.GcFloat or Aravis.GcInteger interface will be checked against their Min and Max properties.

Be aware that some camera may have wrong definition of Min and Max, as this check is defined as not mandatory in the Genicam specification. If this is the case, it will not possible to set the value of the features with faulty Min or Max definition. Range check is disabled by default.

Added in version 0.8.8.

set_region(x, y, width, height)¶

Parameters:

x (int) – x offset
y (int) – y_offset
width (int) – region width
height (int) – region height

Raises:

GLib.Error

Defines the region of interest which will be transmitted in the video stream. Negative x or y values, or not strictly positive width or height values are ignored.

Added in version 0.8.0.

set_register(feature, length, value)¶

Parameters:

feature (str) – feature name
length (int) – buffer length
value (object or None) – new feature value

Raises:

GLib.Error

Set a register content.

Added in version 0.8.31.

set_register_cache_policy(policy)¶

Parameters:: policy (Aravis.RegisterCachePolicy) – cache policy

Sets the Genicam register cache policy.

Be aware that some camera may have wrong Cachable properties defined in their Genicam metadata, which may lead to incorrect readouts. Using the debug cache policy, and activating genicam debug output (export ARV_DEBUG=genicam), can help you to check the cache validity. In this mode, every time the cache content is not in sync with the actual register value, a debug message is printed on the console.

Added in version 0.8.8.

set_string(feature, value)¶

Parameters:

feature (str) – feature name
value (str) – new feature value

Raises:

GLib.Error

Set an string feature value.

Added in version 0.8.0.

set_trigger(source)¶

Parameters:: source (str) – trigger source as string
Raises:: GLib.Error

Configures the camera in trigger mode. Typical values for source are “Line1” or “Line2”. See the camera documentation for the allowed values. Source can also be “Software”. In this case, an acquisition is triggered by a call to Aravis.Camera.software_trigger().

The trigger set is “FrameStart”. “AcquisitionStart” is used as a fallback if “FrameStart” is not present. All other triggers are disabled. “TriggerActivation” is set to rising edge.

For an advanced trigger configuration, use the underlying Aravis.Device object returned by Aravis.Camera.get_device().

Added in version 0.8.0.

set_trigger_source(source)¶

Parameters:: source (str) – source name
Raises:: GLib.Error

Sets the trigger source. This function doesn’t check if the camera is configured to actually use this source as a trigger.

Added in version 0.8.0.

software_trigger()¶

Raises:: GLib.Error

Sends a software trigger command to self. The camera must be previously configured to use a software trigger, using arv_camera_set_trigger().

Added in version 0.8.0.

start_acquisition()¶

Raises:: GLib.Error

Starts video stream acquisition.

Added in version 0.8.0.

stop_acquisition()¶

Raises:: GLib.Error

Stops video stream acquisition.

Added in version 0.8.0.

uv_get_bandwidth()¶

Raises:: GLib.Error
Returns:: the current bandwidth limit
Return type:: int

Added in version 0.8.0.

uv_get_bandwidth_bounds()¶

Raises:

GLib.Error

Returns:

min:: minimum bandwidth
max:: maximum bandwidth

Return type:

(min: int, max: int)

Added in version 0.8.0.

uv_is_bandwidth_control_available()¶

Raises:: GLib.Error
Returns:: wether bandwidth limits are available on this camera
Return type:: bool

Added in version 0.8.0.

uv_set_bandwidth(bandwidth)¶

Parameters:: bandwidth (int) – Bandwith limit, in megabits/sec
Raises:: GLib.Error

Set the bandwith limit or, if bandwith is not strictly positive, disable the limit.

Added in version 0.8.0.

uv_set_usb_mode(usb_mode)¶

Parameters:: usb_mode (Aravis.UvUsbMode) – a Aravis.UvUsbMode option

Added in version 0.8.17.

Property Details¶

Aravis.Camera.props.device¶

Name:: device
Type:: Aravis.Device
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Internal device object

Aravis.Camera.props.name¶

Name:: name
Type:: str
Default Value:: None
Flags:: WRITABLE, CONSTRUCT_ONLY

Internal device name for object construction