Enums¶

Details¶

class Aravis.AccessCheckPolicy(value)¶

Bases: GObject.GEnum

New in version 0.8.6.

DEFAULT = 0¶

DISABLE = 0¶: never check the register access mode

ENABLE = 1¶: always check the register access mode

class Aravis.AcquisitionMode(value)¶

Bases: GObject.GEnum

classmethod from_string(string)¶

Parameters:: string (str) –
Return type:: Aravis.AcquisitionMode

classmethod to_string(value)¶

Parameters:: value (Aravis.AcquisitionMode) –
Return type:: str

CONTINUOUS = 0¶: frames are captured continuously until stopped with the AcquisitionStop command.

SINGLE_FRAME = 1¶: only one frame will be acquired

MULTI_FRAME = 2¶: the number of frames specified by AcquisitionFrameCount is captured.

class Aravis.Auto(value)¶

Bases: GObject.GEnum

classmethod from_string(string)¶

Parameters:: string (str) –
Return type:: Aravis.Auto

classmethod to_string(value)¶

Parameters:: value (Aravis.Auto) –
Return type:: str

OFF = 0¶: manual setting

ONCE = 1¶: automatic setting done once, then returns to manual

CONTINUOUS = 2¶: setting is adjusted continuously

class Aravis.BufferPartDataType(value)¶

Bases: GObject.GEnum

UNKNOWN = -1¶

2D_IMAGE = 1¶

_2D_IMAGE = 1¶

CHUNK_DATA = 10¶

JPEG = 11¶

JPEG2000 = 12¶

2D_PLANE_BIPLANAR = 2¶

_2D_PLANE_BIPLANAR = 2¶

2D_PLANE_TRIPLANAR = 3¶

_2D_PLANE_TRIPLANAR = 3¶

DEVICE_SPECIFIC = 32768¶

2D_PLANE_QUADPLANAR = 4¶

_2D_PLANE_QUADPLANAR = 4¶

3D_IMAGE = 5¶

_3D_IMAGE = 5¶

3D_PLANE_BIPLANAR = 6¶

_3D_PLANE_BIPLANAR = 6¶

3D_PLANE_TRIPLANAR = 7¶

_3D_PLANE_TRIPLANAR = 7¶

3D_PLANE_QUADPLANAR = 8¶

_3D_PLANE_QUADPLANAR = 8¶

CONFIDENCE_MAP = 9¶

class Aravis.BufferPayloadType(value)¶

Bases: GObject.GEnum

UNKNOWN = -1¶: unknown payload type

NO_DATA = 0¶: no data

IMAGE = 1¶: image data

MULTIPART = 10¶: multipart data

RAWDATA = 2¶: raw data (not supported)

FILE = 3¶: file (not supported)

CHUNK_DATA = 4¶: chunk data (not supported)

EXTENDED_CHUNK_DATA = 5¶: extended chunk data

JPEG = 6¶: JPEG data (not supported)

JPEG2000 = 7¶: JPEG2000 data (not supported)

H264 = 8¶: h264 data (not supported)

MULTIZONE_IMAGE = 9¶: multizone image (not supported)

class Aravis.BufferStatus(value)¶

Bases: GObject.GEnum

UNKNOWN = -1¶: unknown status

SUCCESS = 0¶: the buffer contains a valid image

CLEARED = 1¶: the buffer is cleared

TIMEOUT = 2¶: timeout was reached before all packets are received

MISSING_PACKETS = 3¶: stream has missing packets

WRONG_PACKET_ID = 4¶: stream has packet with wrong id

SIZE_MISMATCH = 5¶: the received image didn’t fit in the buffer data space

FILLING = 6¶: the image is currently being filled

ABORTED = 7¶: the filling was aborted before completion

PAYLOAD_NOT_SUPPORTED = 8¶: payload not yet supported

class Aravis.ChunkParserError(value)¶

Bases: GObject.GEnum

classmethod quark()¶

Return type:: int

INVALID_FEATURE_TYPE = 0¶: invalid feature type

BUFFER_NOT_FOUND = 1¶: a buffer is not attached to the chunk parser

CHUNK_NOT_FOUND = 2¶: the requested chunk is not found in the buffer data

class Aravis.ComponentSelectionFlags(value)¶

Bases: GObject.GEnum

NONE = 0¶

ENABLE = 1¶

DISABLE = 2¶

EXCLUSIVE_ENABLE = 3¶

ENABLE_ALL = 4¶

class Aravis.DeviceError(value)¶

Bases: GObject.GEnum

classmethod quark()¶

Return type:: int

WRONG_FEATURE = 0¶: Wrong feature type

FEATURE_NOT_FOUND = 1¶: Feature node not found

NOT_CONTROLLER = 10¶: Controller privilege required

UNKNOWN = 11¶: Unknown error

PROTOCOL_ERROR_NOT_IMPLEMENTED = 12¶

PROTOCOL_ERROR_INVALID_PARAMETER = 13¶

PROTOCOL_ERROR_INVALID_ADDRESS = 14¶

PROTOCOL_ERROR_WRITE_PROTECT = 15¶

PROTOCOL_ERROR_BAD_ALIGNMENT = 16¶

PROTOCOL_ERROR_ACCESS_DENIED = 17¶

PROTOCOL_ERROR_BUSY = 18¶

NOT_CONNECTED = 2¶: Device is not connected

PROTOCOL_ERROR = 3¶: Protocol error

TRANSFER_ERROR = 4¶: Transfer error

TIMEOUT = 5¶: Timeout detected

NOT_FOUND = 6¶: Device not found

INVALID_PARAMETER = 7¶: Invalid construction parameter

GENICAM_NOT_FOUND = 8¶: Missing Genicam data

NO_STREAM_CHANNEL = 9¶: No stream channel found

class Aravis.DomNodeType(value)¶

Bases: GObject.GEnum

ELEMENT_NODE = 1¶

DOCUMENT_TYPE_NODE = 10¶

DOCUMENT_FRAGMENT_NODE = 11¶

NOTATION_NODE = 12¶

ATTRIBUTE_NODE = 2¶

TEXT_NODE = 3¶

CDATA_SECTION_NODE = 4¶

ENTITY_REFERENCE_NODE = 5¶

ENTITY_NODE = 6¶

PROCESSING_INSTRUCTION_NODE = 7¶

COMMENT_NODE = 8¶

DOCUMENT_NODE = 9¶

class Aravis.ExposureMode(value)¶

Bases: GObject.GEnum

classmethod from_string(string)¶

Parameters:: string (str) –
Return type:: Aravis.ExposureMode

classmethod to_string(value)¶

Parameters:: value (Aravis.ExposureMode) –
Return type:: str

OFF = 0¶: disables the Exposure and let the shutter open.

TIMED = 1¶: timed exposure. The exposure duration time is set using the ExposureTime or ExposureAuto features and the exposure starts with the FrameStart or LineStart.

TRIGGER_WIDTH = 2¶: uses the width of the current Frame or Line trigger signal(s) pulse to control the exposure duration. Note that if the Frame or Line TriggerActivation is RisingEdge or LevelHigh, the exposure duration will be the time the trigger stays High. If TriggerActivation is FallingEdge or LevelLow, the exposure time will last as long as the trigger stays Low.

TRIGGER_CONTROLLED = 3¶: uses one or more trigger signal(s) to control the exposure duration independently from the current Frame or Line triggers. See ExposureStart, ExposureEnd and ExposureActive of the TriggerSelector feature.

class Aravis.GcAccessMode(value)¶

Bases: GObject.GEnum

Specifies access mode for feature nodes and registers.

classmethod from_string(string)¶

Parameters:: string (str) –
Return type:: Aravis.GcAccessMode

classmethod to_string(value)¶

Parameters:: value (Aravis.GcAccessMode) –
Return type:: str

UNDEFINED = -1¶: undefined access mode

RO = 0¶: read-only access

WO = 1¶: write-only access

RW = 2¶: read and write access

class Aravis.GcCachable(value)¶

Bases: GObject.GEnum

Specifies caching mode for register values.

UNDEFINED = -1¶: undefined cache mode

NO_CACHE = 0¶: no value caching

WRITE_THROUGH = 1¶: write-through cache mode

WRITE_AROUND = 2¶: write-around cache mode

class Aravis.GcDisplayNotation(value)¶

Bases: GObject.GEnum

Number display notations for showing numbers in user interfaces.

New in version 0.8.0.

UNDEFINED = -1¶: undefined number notation

AUTOMATIC = 0¶: automatically detect whether to use fixed or scientific number notation

FIXED = 1¶: used fixed (i.e. decimal) notation for displaying numbers

SCIENTIFIC = 2¶: use scientific notation for displaying numbers

class Aravis.GcError(value)¶

Bases: GObject.GEnum

classmethod quark()¶

Return type:: int

PROPERTY_NOT_DEFINED = 0¶

PVALUE_NOT_DEFINED = 1¶

READ_ONLY = 10¶

SET_FROM_STRING_UNDEFINED = 11¶

GET_AS_STRING_UNDEFINED = 12¶

INVALID_BIT_RANGE = 13¶

INVALID_SYNTAX = 14¶

INVALID_PVALUE = 2¶

EMPTY_ENUMERATION = 3¶

OUT_OF_RANGE = 4¶

NO_DEVICE_SET = 5¶

NO_EVENT_IMPLEMENTATION = 6¶

NODE_NOT_FOUND = 7¶

ENUM_ENTRY_NOT_FOUND = 8¶

INVALID_LENGTH = 9¶

class Aravis.GcIsLinear(value)¶

Bases: GObject.GEnum

Describes relationship between TO and FROM variables in Converter feature nodes.

UNDEFINED = -1¶: undefined relationship between variables

NO = 0¶: non-linear relationship between variables

YES = 1¶: linear relationship between variables

class Aravis.GcNameSpace(value)¶

Bases: GObject.GEnum

Specifies feature node or register name space type. Standard name space features are listed in Genicam materials. Any other vendor-specific features should use custom name space type.

UNDEFINED = -1¶: undefined name space

STANDARD = 0¶: Genicam standardized name space

CUSTOM = 1¶: non-standardized name space

class Aravis.GcPropertyNodeType(value)¶

Bases: GObject.GEnum

UNKNOWN = 0¶

VALUE = 1¶

INCREMENT = 10¶

P_UNKNONW = 1000¶

P_FEATURE = 1001¶

P_VALUE = 1002¶

P_ADDRESS = 1003¶

P_IS_IMPLEMENTED = 1004¶

P_IS_LOCKED = 1005¶

P_IS_AVAILABLE = 1006¶

P_SELECTED = 1007¶

P_MINIMUM = 1008¶

P_MAXIMUM = 1009¶

P_INCREMENT = 1010¶

P_INDEX = 1011¶

P_LENGTH = 1012¶

P_PORT = 1013¶

P_VARIABLE = 1014¶

P_INVALIDATOR = 1015¶

P_COMMAND_VALUE = 1016¶

P_VALUE_INDEXED = 1017¶

P_VALUE_DEFAULT = 1018¶

P_ALIAS = 1019¶

P_CAST_ALIAS = 1020¶

IS_LINEAR = 11¶

REPRESENTATION = 12¶

DISPLAY_NOTATION = 13¶

DISPLAY_PRECISION = 14¶

UNIT = 15¶

ON_VALUE = 16¶

OFF_VALUE = 17¶

LENGTH = 18¶

FORMULA = 19¶

ADDRESS = 2¶

FORMULA_TO = 20¶

FORMULA_FROM = 21¶

EXPRESSION = 22¶

CONSTANT = 23¶

ACCESS_MODE = 24¶

IMPOSED_ACCESS_MODE = 25¶

CACHABLE = 26¶

POLLING_TIME = 27¶

ENDIANNESS = 28¶

SIGN = 29¶

DESCRIPTION = 3¶

LSB = 30¶

MSB = 31¶

BIT = 32¶

COMMAND_VALUE = 33¶

CHUNK_ID = 34¶

EVENT_ID = 35¶

VALUE_INDEXED = 36¶

VALUE_DEFAULT = 37¶

STREAMABLE = 38¶

IS_DEPRECATED = 39¶

VISIBILITY = 4¶

TOOLTIP = 5¶

DISPLAY_NAME = 6¶

MINIMUM = 7¶

MAXIMUM = 8¶

SLOPE = 9¶

class Aravis.GcRepresentation(value)¶

Bases: GObject.GEnum

Number representation formats.

New in version 0.8.0.

UNDEFINED = -1¶: undefined representation

LINEAR = 0¶: number presented on linear scale (e.g. on a linear slider)

LOGARITHMIC = 1¶: number presented on logarithmic scale (e.g. on a logarithmic slider)

BOOLEAN = 2¶: binary choice (e.g. a checkbox)

PURE_NUMBER = 3¶: number presented in an editable field (e.g. a spinbox)

HEX_NUMBER = 4¶: number presented in hexadecimal format

IPV4_ADDRESS = 5¶: IPv4 address

MAC_ADDRESS = 6¶: MAC address

class Aravis.GcSignedness(value)¶

Bases: GObject.GEnum

Specifies signedness of integer registers. Per standard Genicam internally uses signed 64-bit signed integers for representing all integer registers. Therefore unsigned 64-bit integers are not available.

UNDEFINED = -1¶: undefined sign

SIGNED = 0¶: signed integer

UNSIGNED = 1¶: unsigned integer

class Aravis.GcStreamable(value)¶

Bases: GObject.GEnum

Denotes that the corresponding feature is prepared to be stored to and loaded from a file via the node tree. The idea is to persist the state of a camera by storing the features marked as Streamable and restore the state by writing those features back to the node tree.

New in version 0.8.8.

UNDEFINED = -1¶: undefined streamable

NO = 0¶: the feature can’t be used for camera state persistence

YES = 1¶: the feature can be used for camera state persistence

class Aravis.GcVisibility(value)¶

Bases: GObject.GEnum

Specifies feature node recommended visibility in user interfaces.

UNDEFINED = -1¶: undefined feature visibility level

INVISIBLE = 0¶: feature should be not be visible in user interface

GURU = 1¶: very advanced feature to be shown to very experienced users

EXPERT = 2¶: advanced feature to be shown to expert users

BEGINNER = 3¶: basic feature to be shown to all users

class Aravis.GvIpConfigurationMode(value)¶

Bases: GObject.GEnum

NONE = 0¶

PERSISTENT_IP = 1¶

DHCP = 2¶

LLA = 3¶

FORCE_IP = 4¶

class Aravis.GvPacketSizeAdjustment(value)¶

Bases: GObject.GEnum

NEVER = 0¶: never adjust packet size

DEFAULT = 1¶: default adjustment, which is ON_FAILURE_ONCE

New in version 0.8.8.

ON_FAILURE_ONCE = 1¶: adjust packet size if test packet check fails the with current packet size, only on the first stream creation

ON_FAILURE = 2¶: adjust packet size if test packet check fails with current packet size

ONCE = 3¶: adjust packet size on the first stream creation

ALWAYS = 4¶: always adjust the stream packet size

class Aravis.GvStreamPacketResend(value)¶

Bases: GObject.GEnum

NEVER = 0¶: never request a packet resend

ALWAYS = 1¶: request a packet resend if a packet was missing

class Aravis.GvStreamSocketBuffer(value)¶

Bases: GObject.GEnum

FIXED = 0¶: socket buffer is set to a given fixed value

AUTO = 1¶: socket buffer size is set to the payload size

class Aravis.RangeCheckPolicy(value)¶

Bases: GObject.GEnum

New in version 0.8.6.

DEFAULT = 0¶: default range check policy

DISABLE = 0¶: never check if float or integer node value is in min/max range

ENABLE = 1¶: always check if if float or integer node is in min/max range

DEBUG = 2¶: check the value, but only display an error message if the value is not allowed

New in version 0.8.8.

class Aravis.RegisterCachePolicy(value)¶

Bases: GObject.GEnum

New in version 0.8.0.

DEFAULT = 0¶: default cache policy

DISABLE = 0¶: disable register caching

ENABLE = 1¶: enable register caching

DEBUG = 2¶: enable register caching, but read the acual register value for comparison

class Aravis.StreamCallbackType(value)¶

Bases: GObject.GEnum

Describes when the reason the stream callback is called. You are probably more interested in Aravis.StreamCallbackType.INIT and Aravis.StreamCallbackType.BUFFER_DONE.

INIT = 0¶: thread initialization, happens once

EXIT = 1¶: thread end, happens once

START_BUFFER = 2¶: buffer filling start, happens at each frame

BUFFER_DONE = 3¶: buffer filled, happens at each frame

class Aravis.UvUsbMode(value)¶

Bases: GObject.GEnum

SYNC = 0¶: utilize libusb synchronous device I/O API

ASYNC = 1¶: utilize libusb asynchronous device I/O API

DEFAULT = 1¶: default usb mode

class Aravis.XmlSchemaError(value)¶

Bases: GObject.GEnum

classmethod quark()¶

Return type:: int

STRUCTURE = 0¶: invalid structure