Aravis.Camera¶
- Subclasses:
None
Methods¶
- Inherited:
- Structs:
Virtual Methods¶
- Inherited:
Properties¶
Name |
Type |
Flags |
Short Description |
|---|---|---|---|
r/w/co |
The device associated with this camera |
||
w/co |
The camera name |
Signals¶
- Inherited:
Fields¶
- Inherited:
Name |
Type |
Access |
Description |
|---|---|---|---|
parent_instance |
r |
Class Details¶
- class Aravis.Camera(**kwargs)¶
- Bases:
- Abstract:
No
- Structure:
[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:
- Raises:
- Returns:
a new
Aravis.Camera.- Return type:
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>
New in version 0.8.0.
- classmethod new_with_device(device)¶
- Parameters:
device (
Aravis.Device) – aAravis.Device- Raises:
- Returns:
a new
Aravis.Camera.- Return type:
Creates a new
Aravis.Camera, using device as its internal device object.New in version 0.8.6.
- abort_acquisition()¶
- Raises:
Aborts video stream acquisition.
New in version 0.8.0.
- acquisition(timeout)¶
- Parameters:
timeout (
int) – acquisition timeout in µs. Zero means no timeout.- Raises:
- Returns:
A new
Aravis.Buffer,Noneon error. The returned buffer must be freed usingGObject.Object.unref().- Return type:
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, usingAravis.Camera.set_acquisition_mode().New in version 0.8.0.
- are_chunks_available()¶
- Raises:
- Returns:
Trueif chunk data are available- Return type:
New in version 0.8.8.
- clear_triggers()¶
- Raises:
Disables all triggers.
New in version 0.8.0.
- create_chunk_parser()¶
- Returns:
a new [class`ArvChunkParser`].
- Return type:
Creates a new [class`ArvChunkParser`] object, used for the extraction of chunk data from [class`ArvBuffer`].
New in version 0.4.0.
- create_stream(callback, *user_data)¶
- Parameters:
callback (
Aravis.StreamCallbackorNone) – a frame processing callback
- Raises:
- Returns:
a new [class`ArvStream`], to be freed after use with [method`GObject`.Object.unref].
- Return type:
Creates a new [class`ArvStream`] for video stream reception. See [callback`ArvStreamCallback`] for details regarding the callback function.
New in version 0.8.23.
- dup_available_black_levels()¶
- Raises:
- 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.
New in version 0.8.27.
- dup_available_components()¶
- Raises:
- Returns:
a newly allocated array of strings, to be freed after use with
GLib.free().- Return type:
[
str]
Retrieves the list of available components.
New in version 0.8.23.
- dup_available_enumerations(feature)¶
- Parameters:
feature (
str) – feature name- Raises:
- Returns:
a newly created array of integers, which must freed after use using
GLib.free, orNoneon error.- Return type:
[
int]
Get all the available values of feature, as 64 bit integers.
New in version 0.8.0.
- dup_available_enumerations_as_display_names(feature)¶
- Parameters:
feature (
str) – feature name- Raises:
- Returns:
a newly created array of const strings, to be freed after use using
GLib.free, orNoneon error.- Return type:
[
str]
Get display names of all the available entries of feature.
New in version 0.8.0.
- dup_available_enumerations_as_strings(feature)¶
- Parameters:
feature (
str) – feature name- Raises:
- Returns:
a newly created array of const strings, which must freed after use using
GLib.free, orNoneon error.- Return type:
[
str]
Get all the available values of feature, as strings.
New in version 0.8.0.
- dup_available_gains()¶
- Raises:
- 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.
New in version 0.8.27.
- dup_available_pixel_formats()¶
- Raises:
- 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.
New in version 0.8.0.
- dup_available_pixel_formats_as_display_names()¶
- Raises:
- 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.
New in version 0.8.0.
- dup_available_pixel_formats_as_strings()¶
- Raises:
- 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.
New in version 0.8.0.
- dup_available_trigger_sources()¶
- Raises:
- Returns:
a newly allocated array of strings, which must be freed using
GLib.free().- Return type:
[
str]
Gets the list of all available trigger sources.
New in version 0.8.0.
- dup_available_triggers()¶
- Raises:
- Returns:
a newly allocated array of strings, which must be freed using
GLib.free().- Return type:
[
str]
Gets a list of all available triggers: FrameStart, ExposureActive, etc…
New in version 0.8.0.
- execute_command(feature)¶
- Parameters:
feature (
str) – feature name- Raises:
Execute a Genicam command.
New in version 0.8.0.
- get_acquisition_mode()¶
- Raises:
- Returns:
acquisition mode.
- Return type:
New in version 0.8.0.
- get_binning()¶
- Raises:
- Returns:
- dx:
horizontal binning placeholder
- dy:
vertical binning placeholder
- Return type:
Retrieves binning in both directions.
New in version 0.8.0.
- get_black_level()¶
- Raises:
- Returns:
the current blacklevel setting.
- Return type:
New in version 0.8.19.
- get_black_level_auto()¶
- Raises:
- Returns:
auto black level mode selection
- Return type:
New in version 0.8.19.
- get_black_level_bounds()¶
- Raises:
- Returns:
- min:
minimum blacklevel
- max:
maximum blacklevel
- Return type:
Retrieves blacklevel bounds.
New in version 0.8.19.
- get_boolean(feature)¶
-
New in version 0.8.0.
- get_chunk_mode()¶
- Raises:
- Returns:
Trueif chunk data mode is active.- Return type:
Check wether chunk data mode is active. Please see
Aravis.Camera.set_chunk_mode().New in version 0.8.0.
- get_chunk_state(chunk)¶
-
Gets state of chunk data. Chunk data are be embedded in
Aravis.Bufferonly if chunk mode is active. Please seeAravis.Camera.set_chunk_mode().New in version 0.8.0.
- get_device()¶
- Returns:
underlying device object.
- Return type:
Retrieves the
Aravis.Deviceobject for more complete access to camera features.New in version 0.2.0.
- get_device_id()¶
- Raises:
- Returns:
the camera device ID.
- Return type:
New in version 0.8.0.
- get_device_serial_number()¶
- Raises:
- Returns:
the camera device serial number.
- Return type:
New in version 0.8.8.
- get_exposure_time()¶
- Raises:
- Returns:
current exposure time, in µs.
- Return type:
New in version 0.8.0.
- get_exposure_time_auto()¶
- Raises:
- Returns:
auto exposure mode selection
- Return type:
New in version 0.8.0.
- get_exposure_time_bounds()¶
- Raises:
- Returns:
- min:
minimum exposure time
- max:
maximum exposure time
- Return type:
Retrieves exposure time bounds, in µs.
New in version 0.8.0.
- get_float(feature)¶
- Parameters:
feature (
str) – feature name- Raises:
- Returns:
the float feature value, 0.0 on error.
- Return type:
New in version 0.8.0.
- get_float_bounds(feature)¶
- Parameters:
feature (
str) – feature name- Raises:
- Returns:
- min:
minimum feature value
- max:
maximum feature value
- Return type:
Retrieves float feature bounds.
New in version 0.8.0.
- get_float_increment(feature)¶
- Parameters:
feature (
str) – feature name- Raises:
- Returns:
feature value increment, or
GObject.G_MINDOUBLEon error.- Return type:
New in version 0.8.16.
- get_frame_count()¶
- Raises:
- Returns:
number of frames to capture in MultiFrame mode.
- Return type:
New in version 0.8.0.
- get_frame_count_bounds()¶
- Raises:
- Returns:
- min:
minimal possible frame count
- max:
maximum possible frame count
- Return type:
Retrieves allowed range for frame count.
New in version 0.8.0.
- get_frame_rate()¶
- Raises:
- Returns:
actual frame rate, in Hz.
- Return type:
New in version 0.8.0.
- get_frame_rate_bounds()¶
- Raises:
- Returns:
- min:
minimal possible framerate
- max:
maximum possible framerate
- Return type:
Retrieves allowed range for framerate.
New in version 0.8.0.
- get_gain()¶
- Raises:
- Returns:
the current gain setting.
- Return type:
New in version 0.8.0.
- get_gain_auto()¶
- Raises:
- Returns:
auto gain mode selection
- Return type:
New in version 0.8.0.
- get_gain_bounds()¶
- Raises:
- Returns:
- min:
minimum gain
- max:
maximum gain
- Return type:
Retrieves gain bounds.
New in version 0.8.0.
- get_height_bounds()¶
- Raises:
- Returns:
- min:
minimum height
- max:
maximum height
- Return type:
Retrieves the valid range for image height.
New in version 0.8.0.
- get_height_increment()¶
- Raises:
- Returns:
height value increment.
- Return type:
New in version 0.8.0.
- get_integer(feature)¶
- Parameters:
feature (
str) – feature name- Raises:
- Returns:
the integer feature value, 0 on error.
- Return type:
New in version 0.8.0.
- get_integer_bounds(feature)¶
- Parameters:
feature (
str) – feature name- Raises:
- Returns:
- min:
minimum feature value
- max:
maximum feature value
- Return type:
Retrieves integer feature bounds.
New in version 0.8.0.
- get_integer_increment(feature)¶
- Parameters:
feature (
str) – feature name- Raises:
- Returns:
feature value increment, or 1 on error.
- Return type:
New in version 0.8.0.
- get_model_name()¶
- Raises:
- Returns:
the camera model name.
- Return type:
New in version 0.8.0.
- get_payload()¶
- Raises:
- Returns:
frame storage size, in bytes.
- Return type:
Retrieves the size needed for the storage of an image. This value is used for the creation of the stream buffers.
New in version 0.8.0.
- get_pixel_format()¶
- Raises:
- Returns:
pixel format.
- Return type:
New in version 0.8.0.
- get_pixel_format_as_string()¶
- Raises:
- Return type:
Retuns: pixel format as string,
Noneon error.New in version 0.8.0.
- get_region()¶
- Raises:
- Returns:
- x:
x offset
- y:
y_offset
- width:
region width
- height:
region height
- Return type:
Retrieves the current region of interest.
New in version 0.8.0.
- get_sensor_size()¶
- Raises:
- Returns:
- width:
camera sensor width
- height:
camera sensor height
- Return type:
New in version 0.8.0.
- get_string(feature)¶
- Parameters:
feature (
str) – feature name- Raises:
- Returns:
the string feature value,
Noneon error.- Return type:
New in version 0.8.0.
- get_trigger_source()¶
- Raises:
- Returns:
a string containing the trigger source name,
Noneon error.- Return type:
Gets the trigger source. This function doesn’t check if the camera is configured to actually use this source as a trigger.
New in version 0.8.0.
- get_vendor_name()¶
- Raises:
- Returns:
the camera vendor name.
- Return type:
New in version 0.8.0.
- get_width_bounds()¶
- Raises:
- Returns:
- min:
minimum width
- max:
maximum width
- Return type:
Retrieves the valid range for image width.
New in version 0.8.0.
- get_width_increment()¶
- Raises:
- Returns:
width value increment.
- Return type:
New in version 0.8.0.
- get_x_binning_bounds()¶
- Raises:
- Returns:
- min:
minimum binning
- max:
maximum binning
- Return type:
Retrieves the valid range for image horizontal binning.
New in version 0.8.0.
- get_x_binning_increment()¶
- Raises:
- Returns:
horizontal binning value increment.
- Return type:
New in version 0.8.0.
- get_x_offset_bounds()¶
- Raises:
- Returns:
- min:
minimum offset
- max:
maximum offset
- Return type:
Retrieves the valid range for image horizontal offset.
New in version 0.8.0.
- get_x_offset_increment()¶
- Raises:
- Returns:
horizontal offset value increment.
- Return type:
New in version 0.8.0.
- get_y_binning_bounds()¶
- Raises:
- Returns:
- min:
minimum binning
- max:
maximum binning
- Return type:
Retrieves the valid range for image vertical binning.
New in version 0.8.0.
- get_y_binning_increment()¶
- Raises:
- Returns:
vertical binning value increment.
- Return type:
New in version 0.8.0.
- get_y_offset_bounds()¶
- Raises:
- Returns:
- min:
minimum offset
- max:
maximum offset
- Return type:
Retrieves the valid range for image vertical offset.
New in version 0.8.0.
- get_y_offset_increment()¶
- Raises:
- Returns:
vertical offset value increment.
- Return type:
New in version 0.8.0.
- gv_auto_packet_size()¶
- Raises:
- Returns:
The packet size, in bytes.
- Return type:
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).
New in version 0.8.0.
- gv_get_current_stream_channel()¶
- Raises:
- Returns:
The current stream channel id.
- Return type:
New in version 0.8.0.
- gv_get_ip_configuration_mode()¶
- Raises:
- Returns:
IP address configuration mode
- Return type:
Get the IP address configuration mode.
New in version 0.8.22.
- gv_get_multipart()¶
- Raises:
- Returns:
Trueif multipart payload support is enabled.- Return type:
New in version 0.8.23.
- gv_get_n_network_interfaces()¶
- Raises:
- Returns:
the number of device network interfaces.
- Return type:
New in version 0.8.25.
- gv_get_n_stream_channels()¶
- Raises:
- Returns:
the number of supported stream channels.
- Return type:
New in version 0.8.0.
- gv_get_packet_delay()¶
- Raises:
- Returns:
The inter packet delay, in nanoseconds.
- Return type:
New in version 0.8.0.
- gv_get_packet_size()¶
- Raises:
- Returns:
The stream packet size, in bytes.
- Return type:
New in version 0.8.0.
- gv_get_persistent_ip()¶
- Raises:
- Returns:
- Return type:
(ip:
Gio.InetAddress, mask:Gio.InetAddressMask, gateway:Gio.InetAddress)
Get the persistent IP address setting of camera.
New in version 0.8.22.
- gv_is_multipart_supported()¶
- Raises:
- Returns:
Trueif multipart payload is supported by self.- Return type:
New in version 0.8.23.
- gv_select_stream_channel(channel_id)¶
- Parameters:
channel_id (
int) – id of the channel to select- Raises:
Select the current stream channel. Negative channel_id is ignored.
New in version 0.8.0.
- gv_set_ip_configuration_mode(mode)¶
- Parameters:
mode (
Aravis.GvIpConfigurationMode) – IP address configuration mode- Raises:
Sets the IP address configuration mode. Available modes are
Aravis.GvIpConfigurationMode.DHCP,Aravis.GvIpConfigurationMode.PERSISTENT_IP,Aravis.GvIpConfigurationMode.LLANew in version 0.8.22.
- gv_set_multipart(enable)¶
- Parameters:
- Raises:
Control multipart payload support
New in version 0.8.23.
- gv_set_packet_delay(delay_ns)¶
- Parameters:
delay_ns (
int) – inter packet delay, in nanoseconds- Raises:
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.
New in version 0.8.0.
- gv_set_packet_size(packet_size)¶
- Parameters:
packet_size (
int) – packet size, in bytes- Raises:
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.
New in version 0.8.0.
- gv_set_packet_size_adjustment(adjustment)¶
- Parameters:
adjustment (
Aravis.GvPacketSizeAdjustment) – aAravis.GvPacketSizeAdjustmentoption
Sets the option for packet size adjustment that happens at stream object creation.
New in version 0.8.3.
- gv_set_persistent_ip(ip, mask, gateway)¶
- Parameters:
ip (
Gio.InetAddress) – IPv4 addressmask (
Gio.InetAddressMask) – Netmaskgateway (
Gio.InetAddress) – Gateway IPv4 address
- Raises:
Sets the persistent IP address to camera.
New in version 0.8.22.
- gv_set_persistent_ip_from_string(ip, mask, gateway)¶
- Parameters:
- Raises:
Sets the persistent IP address to camera.
New 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().New in version 0.6.0.
- is_binning_available()¶
- Raises:
- Returns:
Trueif Binning feature is available.- Return type:
New in version 0.8.0.
- is_black_level_auto_available()¶
- Raises:
- Returns:
Trueif auto black level feature is available.- Return type:
New in version 0.8.19.
- is_black_level_available()¶
- Raises:
- Returns:
Trueif BlackLevel feature is available.- Return type:
New in version 0.8.19.
- is_component_available()¶
- Raises:
- Returns:
Trueif Component features are available.- Return type:
New in version 0.8.25.
- is_enumeration_entry_available(feature, entry)¶
- Parameters:
- Raises:
- Returns:
Trueif the feature and the feature entry are available- Return type:
New in version 0.8.17.
- is_exposure_auto_available()¶
- Raises:
- Returns:
Trueif Exposure Auto feature is available.- Return type:
New in version 0.8.0.
- is_exposure_time_available()¶
- Raises:
- Returns:
Trueif Exposure Time feature is available.- Return type:
New in version 0.8.0.
- is_feature_available(feature)¶
- Parameters:
feature (
str) – feature name- Raises:
- Returns:
- Return type:
New in version 0.8.0.
- is_feature_implemented(feature)¶
- Parameters:
feature (
str) – feature name- Raises:
- Returns:
- Return type:
New in version 0.8.23.
- is_frame_rate_available()¶
- Raises:
- Returns:
Trueif FrameRate feature is available- Return type:
New in version 0.8.0.
- is_gain_auto_available()¶
- Raises:
- Returns:
Trueif auto gain feature is available.- Return type:
New in version 0.8.0.
- is_gain_available()¶
- Raises:
- Returns:
Trueif Gain feature is available.- Return type:
New in version 0.8.0.
- is_gv_device()¶
-
New in version 0.4.0.
- is_region_offset_available()¶
- Raises:
- Returns:
Trueif OffsetX and OffsetY features are available.- Return type:
New in version 0.8.22.
- is_software_trigger_supported()¶
- Raises:
- Returns:
Trueif software trigger is supported by self.- Return type:
New in version 0.8.17.
- is_uv_device()¶
-
New in version 0.6.0.
- select_and_enable_component(component, disable_others)¶
- Parameters:
- Raises:
Select and enable the given component.
New in version 0.8.23.
- select_black_level(selector)¶
- Parameters:
selector (
str) – black level selection- Raises:
Configures Black Level Selector feature.
New in version 0.8.27.
- select_component(component, flags)¶
- Parameters:
component (
str) – component to selectflags (
Aravis.ComponentSelectionFlags) – aAravis.ComponentSelectionFlags
- Raises:
- Returns:
Trueif the component is enabled- component_id:
a placeholder for the component id
- Return type:
Select and enable or disable the given component.
New in version 0.8.25.
- select_gain(selector)¶
- Parameters:
selector (
str) – gain selector- Raises:
Configures Gain Selector feature.
New 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.
New in version 0.8.22.
- set_acquisition_mode(value)¶
- Parameters:
value (
Aravis.AcquisitionMode) –- Raises:
- set_binning(dx, dy)¶
- Parameters:
- Raises:
Defines binning in both directions. Not all cameras support this feature. Negative dx or dy values are ignored.
New in version 0.8.0.
- set_black_level(blacklevel)¶
- Parameters:
blacklevel (
float) – blacklevel value- Raises:
New in version 0.8.19.
- set_black_level_auto(auto_mode)¶
- Parameters:
auto_mode (
Aravis.Auto) – auto black_level mode selection- Raises:
Configures automatic black level feature.
New in version 0.8.19.
- set_boolean(feature, value)¶
- Parameters:
- Raises:
Set a boolean feature value.
New in version 0.8.0.
- set_chunk_mode(is_active)¶
- Parameters:
is_active (
bool) – wether to enable chunk data mode- Raises:
Controls wether chunk data mode is active. When active, chunk data are appended to image data in
Aravis.Buffer. AAravis.ChunkParsermust be used in order to extract chunk data.New in version 0.8.0.
- set_chunk_state(chunk, is_enabled)¶
- Parameters:
- Raises:
Sets state of a chunk data. Chunk data are be embedded in
Aravis.Bufferonly if chunk mode is active. Please seeAravis.Camera.set_chunk_mode().New in version 0.8.0.
- set_chunks(chunk_list)¶
- Parameters:
chunk_list (
str) – chunk data names, as a comma or space separated list- Raises:
Convenience function for enabling a set of chunk data. Chunk mode is activated, or deactivated if chunk_list is
Noneor empty. All chunk data not listed are disabled.New in version 0.8.0.
- set_exposure_mode(mode)¶
- Parameters:
mode (
Aravis.ExposureMode) –- Raises:
- set_exposure_time(exposure_time_us)¶
- Parameters:
exposure_time_us (
float) – exposure time, in µs- Raises:
Sets exposure time. User should take care to set a value compatible with the desired frame rate. Negative exposure_time_us is ignored.
New in version 0.8.0.
- set_exposure_time_auto(auto_mode)¶
- Parameters:
auto_mode (
Aravis.Auto) – auto exposure mode selection- Raises:
Configures automatic exposure feature.
New in version 0.8.0.
- set_float(feature, value)¶
- Parameters:
- Raises:
Set a float feature value.
New in version 0.8.0.
- set_frame_count(frame_count)¶
- Parameters:
frame_count (
int) – number of frames to capture in MultiFrame mode- Raises:
Sets the number of frames to capture in MultiFrame mode.
New in version 0.8.0.
- set_frame_rate(frame_rate)¶
- Parameters:
frame_rate (
float) – frame rate, in Hz- Raises:
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.
New in version 0.8.0.
- set_gain(gain)¶
- Parameters:
gain (
float) – gain value- Raises:
Sets the gain of the ADC converter. Negative gain is ignored.
New in version 0.8.0.
- set_gain_auto(auto_mode)¶
- Parameters:
auto_mode (
Aravis.Auto) – auto gain mode selection- Raises:
Configures automatic gain feature.
New in version 0.8.0.
- set_integer(feature, value)¶
- Parameters:
- Raises:
Set an integer feature value.
New in version 0.8.0.
- set_pixel_format(format)¶
- Parameters:
format (
int) – pixel format- Raises:
Defines pixel format.
New in version 0.8.0.
- set_pixel_format_from_string(format)¶
- Parameters:
format (
str) – pixel format- Raises:
Defines pixel format described by a string.
New 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.GcFloatorAravis.GcIntegerinterface 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.
New in version 0.8.8.
- set_region(x, y, width, height)¶
- Parameters:
- Raises:
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.
New in version 0.8.0.
- 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.
New in version 0.8.8.
- set_string(feature, value)¶
- Parameters:
- Raises:
Set an string feature value.
New in version 0.8.0.
- set_trigger(source)¶
- Parameters:
source (
str) – trigger source as string- Raises:
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.Deviceobject returned byAravis.Camera.get_device().New in version 0.8.0.
- set_trigger_source(source)¶
- Parameters:
source (
str) – source name- Raises:
Sets the trigger source. This function doesn’t check if the camera is configured to actually use this source as a trigger.
New in version 0.8.0.
- software_trigger()¶
- Raises:
Sends a software trigger command to self. The camera must be previously configured to use a software trigger, using arv_camera_set_trigger().
New in version 0.8.0.
- start_acquisition()¶
- Raises:
Starts video stream acquisition.
New in version 0.8.0.
- stop_acquisition()¶
- Raises:
Stops video stream acquisition.
New in version 0.8.0.
- uv_get_bandwidth()¶
- Raises:
- Returns:
the current bandwidth limit
- Return type:
New in version 0.8.0.
- uv_get_bandwidth_bounds()¶
- Raises:
- Returns:
- min:
minimum bandwidth
- max:
maximum bandwidth
- Return type:
New in version 0.8.0.
- uv_is_bandwidth_control_available()¶
- Raises:
- Returns:
wether bandwidth limits are available on this camera
- Return type:
New in version 0.8.0.
- uv_set_bandwidth(bandwidth)¶
- Parameters:
bandwidth (
int) – Bandwith limit, in megabits/sec- Raises:
Set the bandwith limit or, if bandwith is not strictly positive, disable the limit.
New in version 0.8.0.
- uv_set_usb_mode(usb_mode)¶
- Parameters:
usb_mode (
Aravis.UvUsbMode) – aAravis.UvUsbModeoption
New in version 0.8.17.
Property Details¶
- Aravis.Camera.props.device¶
- Name:
device- Type:
- Default Value:
- Flags:
Internal device object
- Aravis.Camera.props.name¶
- Name:
name- Type:
- Default Value:
- Flags:
Internal device name for object construction