eBUS Python Class List¶

class eBUS.IPConfig¶

Bases: object

property thisown¶: The membership flag

property mIPAddress¶

property mSubnetMask¶

class eBUS.IPvChunkData(*args, **kwargs)¶

Bases: object

Generic chunk data interface.

property thisown¶: The membership flag

ResetChunks()¶

See PvBuffer.ResetChunks

Same as PvBuffer equivalent. Provided with this interface for convenience.

AddChunk(self, aID, aData) → PvResult¶

Add chunk data to the buffer payload section by specifying the ID of the chunk data. See PvBuffer.ResetChunks for more information.

Parameters:

aID (int, in) – Chunk data ID for aIndex.
aData (python bytes object, in) – Payload data of the chunk data. Python bytes object.

Return type:

PvResult

Returns:

A PvResult is used to capture the success or failure of the operation:

PV_OK
PV_BUFFER_TOO_SMALL There is not enough space in the buffer to add the chunk data.
PV_INVALID_PARAMETER One of the input arguments is invalid.

SetChunkLayoutID(aChunkLayoutID)¶

Set the chunk data layout ID.

Parameters:: aChunkLayoutID (int, in) – Chunk data layout ID.

HasChunks()¶

Returns true if the buffer has data chunks.

Unlike GetChunkCount, chunks do not need to be parsed or resolved with this method.

Return type:: boolean
Returns:: True if the buffer holds data chunks, false if not.

GetChunkCount()¶

See PvBuffer.GetChunkCount.

Same as PvBuffer equivalent. Provided with this interface for convenience.

Return type:: int
Returns:: Data chunks count. 0 if no chunks are available.

GetChunkIDByIndex(self, aIndex) → PvResult, int¶

Returns a tuple of PvResult and the ID of a chunk based on its index.

If the index is out of range or the PvBuffer does not have any data chunk, 0 is returned in ID.

Parameters:

aIndex (int, in) – Data chunk Index.

Return type:

Tuple(PvResult, int)

Returns:

Tuple composed of (result, chunkID):

PvResult representing the outcome:
- PV_OK
- PV_NOT_FOUND if the index is out of range or the buffer does not have any chunks
chunkID:
- Chunk ID.

GetChunkSizeByIndex(aIndex)¶

See PvBuffer.GetChunkSizeByIndex.

Same as PvBuffer equivalent. Provided with this interface for convenience.

Parameters:: aIndex (int, in) – Data chunk index.
Return type:: int
Returns:: Data chunk size. 0 if the index is out of range.

GetChunkSizeByID(aID)¶

See PvBuffer.GetChunkSizeByID.

Same as PvBuffer equivalent. Provided with this interface for convenience.

Parameters:: aID (int, in) – Data chunk ID.
Return type:: int
Returns:: Data chunk size. 0 if the chunk ID is not found.

GetChunkRawDataByIndex(self, aIndex) → ndarray¶

See PvBuffer::GetChunkRawDataByIndex. Same as PvBuffer equivalent. Provided with this interface for convenience.

Parameters:: aIndex (int, in) – Data chunk index.
Return type:: ndarray
Returns:: A 1-dimensional python numpy array with dtype np.uint8 describing the chunk data. Empty if the index is out of range.

GetChunkRawDataByID(aID)¶

GetChunkRawDataByIndex(self, aIndex) -> ndarray See PvBuffer.GetChunkRawDataByIndex. Same as PvBuffer equivalent. Provided with this interface for convenience.

Parameters:: aIndex (int, in) – Data chunk index.
Return type:: ndarray
Returns:: A 1-dimensional python numpy array with dtype np.uint8 describing the chunk data. Empty if the index is out of range.

GetChunkLayoutID()¶

Get the chunk data layout ID.

Return type:: int
Returns:: The current chunk data layout ID.

GetChunkDataSize()¶

Returns the current chunk data size.

In a transmission context this method returns how many bytes are used for extra chunk data. It includes the chunk headers for all chunk data and if applicable the chunk header for the main chunk (typically the image).

This method has no use in a reception context where the data receiver delivers the buffer. Use either the direct chunk access methods or the GenApi interface of the device to access chunk data.

Return type:: int
Returns:: Chunk data size in bytes.

GetChunkDataCapacity()¶

Returns the current chunk data capacity.

In a transmission context where you create the buffer, memory is allocated for chunks. This method returns how many bytes can still be added as chunk data.

One chunk is always made of 8-bytes of headers plus the chunk data length. You also need to reserve another 8-bytes for the main chunk (typically the image) unless you buffer only contains chunk data.

This method has no use in a reception context where the data receiver delivers the buffer. Use either the direct chunk access methods or the GenApi interface of the device to access chunk data.

Return type:: int
Returns:: Chunk data capacity.

class eBUS.IPvGenApiFactory(*args, **kwargs)¶

Bases: object

GenApi factory used to add custom GenApi parameters to a software-based GigE Vision Device GenICam XML file.

GenApi features can only be added to the device’s GenICam XML file using the IPvSoftDeviceGEVEventSink.OnCreateCustomGenApiFeatures callback. See IPvSoftDeviceGEVEventSink and PvSoftDeviceGEV for more information.

To add a feature, set all of its attributes in the factory and then call one of the Create methods. After calling a Create method, ALL feature attributes in the factory are reset to their default value.

The following sequence will work and is valid:

Set Feature A name.
Set Feature A category.
Create Feature A.
Reset feature attributes of the factory.
Set Feature B name.
Set Feature B category.
Create Feature B.

The following sequence will fail because Feature B would not have a category defined:

Set Feature A name.
Set Feature A category.
Create Feature A.
Reset feature attributes of the factory.
Set Feature B name.
Create Feature B.

property thisown¶: The membership flag

SetName(aName)¶

Sets the name of the next feature to be added to the GenICam XML file.

The name must not contain any special characters. It can only contain letters, digits, and underscores. The feature name must begin with a letter.

Parameters:: aName (str, in) – Feature name.

SetDisplayName(aDisplayName)¶

Sets the display name of the next feature to be added to the GenICam XML.

The display name can be used by GenApi browsers in order to present the features in a simpler user-interface. Display names do not have to be unique and do can contain spaces.

Features for which display names are not provided will have a display name automatically generated for them.

Automatically generated display names created by adding spaces and removing the last sub-category prefix from the name of the feature:

DeviceType from DeviceControl category: Type

WidthMax from ImageFormatControl category: Width Max

EventTestTimestamp from EventControlEventTestData category: Test Timestamp

These simple rules should be enough for most features. If you need more control on the display name of a feature, just call this method to set a custom display name before using the factory to create the feature.

Parameters:: aDisplayName (str, in) – Feature name.

SetCategory(*args)¶

SetDescription(aDescription)¶

Sets the description of the next feature to be added to the GenICam XML file.

Parameters:: aDescription (str, in) – Feature description.

SetToolTip(aToolTip)¶

Sets the tooltip of the next feature to be added to the GenICam XML file.

Parameters:: aToolTip (str, in) – Feature tooltip.

SetAccessMode(aAccessMode)¶

Sets the access mode of the next feature to be added to the GenICam XML file.

The access mode can be different than the register that it is bound to. However, it does not make sense for it to be more restrictive. As an example, a register could be read-write and the GenApi feature be read-only.

Parameters:: aAccessMode (int, in) – Feature access mode.

SetRepresentation(aRepresentation)¶

Sets the numeric representation of the next feature to be added to the GenICam XML file.

Parameters:: aRepresentation (int, in) – Feature representation.

SetVisibility(aVisibility)¶

Sets the visibility of the next feature to be added to the GenICam XML.

Parameters:: aVisibility (int, in) – Feature visibility.

SetCachable(aCache)¶

Sets the cache behavior of the next feature to be added to the GenICam XML file.

Possible values:

PvGenCacheWriteThrough: The cached value of the register behind the feature is updated to the new value on write operations.
PvGenCacheWriteAround: The cached value of the register behind the feature is invalidated on write operations and refreshed with the value read from PvSoftDeviceGEV on the next read operation.
PvGenCacheNone: The register value behind the feature is not cached and is refreshed every #SetPollingTime ms cycle.

Parameters:: aCache (int, in) – Feature cachable.

SetPollingTime(aPollingTime)¶

Sets the polling time, in ms, of the next feature to be added to the GenICam XML file.

The polling time provides a hint of how often no-cache features should be updated from GenApi browsers.

Parameters:: aPollingTime (int, in) – Feature polling time.

SetNameSpace(aNameSpace)¶

Sets the namespace of the next feature to be added to the GenICam XML file.

Possible values: - PvGenNameSpaceStandard for GenICam SFNC features. - PvGenNameSpaceCustom for custom features.

Parameters:: aNameSpace (int, in) – Feature namespace.

SetTLLocked(aLocked)¶

Sets the TLParamsLocked behavior of the next feature to be added to the GenICam XML file.

A feature with its TLLocked attribute set to True will be forced to read-only when the PvSoftDeviceGEV is streaming.

As an example, the Width and Height features use TLLocked (transport layer locked) to prevent the user from changing their values when the PvSoftDeviceGEV is streaming.

Parameters:: aLocked (boolean, in) – Feature TLLocked attribute.

SetStreamable(aStreamable)¶

Sets the streamable behaviour of the next feature to be added to the GenICam XML.

A feature with its streamable attribute set to true will be be considered when creating a persistence file of the GenApi interface of the device.

Parameters:: aStreamable (boolean, in) – Feature streamable attribute.

SetUnit(aUnit)¶

Sets the units for an integer or float feature.

This string-based unit is only used for display purpose, it carries not functional signification.

Applies to integer or float feature, SwissKnife or Converter.

Parameters:: aUnit (str, in) – Feature unit attribute.

SetPValue(aFeatureName)¶

Sets the pValue attribute of the next feature to be added to the GenICam XML.

Most GenApi features are linked to a register. With pValue you replace the register by the link or pointer to another feature.

When defining a register as pValue, do not provide a register when calling the factory create method, use NULL instead.

For ADVANCED GenApi support use cases.

Parameters:: aFeatureName (str) – [in] Feature name to use for pValue.

SetPIsAvailable(aFeatureName)¶

Sets the pIsAvaialble attribute of the next feature to be added to the GenICam XML.

This attribute can be used to make a feature dynamically available or unavailable. It has to be the name of another feature.

If you need an more complex expression to control the available state of a feature, create a private integer SwissKnife that returns non-zero (1 or true) when the feature should be available.

See #SetCategory for more information on private features. See #CreateIntSwissKnife for more information on SwissKnifes.

When pIsAvailable evaluates to true the feature is available as defined: read-write, read-only or write-only. When pIsAvailable evaluates to false the feature is not readable and not writable. The eBUS GenApi browser shows a feature that state as {Not available}.

For ADVANCED GenApi support use cases.

Parameters:: aFeatureName (str) – [in] Feature name to use for pIsImplemented.

SetPIsLocked(aFeatureName)¶

MapChunk(aChunkID, aAddress, aLength, aEndianness=0)¶

Maps the next feature to be added to the GenICam XML file to a chunk, identified by its ID.

Sets the chunk ID and mapping (address, length, and endianness) of the next feature to be added to the GenICam XML file.

By default all features map to a PvSoftDeviceGEV register provided in the Create calls, unless #MapChunk or #MapEvent are called when defining the feature attributes.

Parameters:

aChunkID (int, in) – Chunk ID to map.
aAddress (int, in) – Data offset of the feature in the chunk, in bytes.
aLength (int, in) – Data length of the feature in the chunk, in bytes.
aEndianness (int, in, optional) – Data endianness.

MapEvent(aEventID, aAddress, aLength, aEndianness=0, aAdjustAddress=True)¶

Maps the next feature to be added to the GenICam XML file to a messaging channel event, identified by its ID.

Sets the messaging channel event ID and mapping (address, length, and endianness) of the next feature to be added to the GenICam XML file.

By default all features map to a PvSoftDeviceGEV register provided in the Create calls, unless #MapChunk or #MapEvent are called when defining the feature attributes.

Parameters:

aEventID (int, in) – Event ID to map.
aAddress (int, in) – Data offset of the feature in the event data, in bytes.
aLength (int, in) – Data length of the feature in the event data, in bytes.
aEndianness (int, in, optional) – Data endianness.
aAdjustAddress (boolean, in, optional) – Applies an offset on the provided address.

AddSelected(aFeatureName)¶

Adds a selector to the next feature to be added to the GenICam XML file.

A selector, as specified by the GenICam SFNC, is used to index which instance of the feature is accessed in situations where multiple instances of a feature exist (For instance, the analog gain for each separate channel of the red/green/blue component of a color camera).

Feature A can be the selector for Features B and C. We could also say that B and C are indexed by A. In that case, Feature A needs to be identified as the selector for Feature B and Feature C.

Example

Create Feature A, our selector
Call IPvGenApiFactory.AddSelected with Feature A name
Call IPvGenApiFactory.AddSelected with Feature B name
Create Feature B (selected by A)
Create Feature C (selected by A)

A feature can have more than one selector. A feature with one selector could be thought of as a one-dimensional vector. A feature with two selector would be like a table with columns and rows, etc.

Parameters:: aFeatureName (str, in) – Name of the feature that is selecting the new feature.

AddInvalidator(aFeatureName)¶

Add an invalidator to the next feature to be added to the GenICam XML file.

Add one invalidator to a feature. For example, Feature A being invalidated by Feature B has the cache of Feature A being invalidated when a new value is written to Feature B.

Parameters:: aFeatureName (str, in) – Name of the feature that is invalidating the new feature.

AddEnumEntry(*args)¶

Overload 1:

Add an enumeration entry to the next feature to be added to the GenICam XML file.

When #CreateEnum is called, it will be populated with the enumeration entries added using this method. Call #AddEnumEntry for each enumeration entry of the new feature.

If one of the Create methods other than #CreateEnum is called, the enumeration entries added to the factory are ignored.

Parameters:

aName (str, in) – Name of the new enumeration entry.
aValue (int, in) – Value of the new enumeration entry.

Overload 2:

Add an enumeration entry to the next feature to be added to the GenICam XML file.

When #CreateEnum is called, it will be populated with the enumeration entries added using this method. Call #AddEnumEntry for each enumeration entry of the new feature.

If one of the Create methods other than #CreateEnum is called, the enumeration entries added to the factory are ignored.

Parameters:

aName (str, in) – Name of the new enumeration entry.
aValue (int, in) – Value of the new enumeration entry.
aDisplayName (str, in) – Custom display name for the new enum entry. If an empty string is provided a default display name is generated for the enum entry.
aNameSpace (int, in, optional) – Namespace for the new enum entry. See #SetNameSpace for more information on GenICam XML namespaces.

Overload 3:

Add an enumeration entry to the next feature to be added to the GenICam XML file.

When #CreateEnum is called, it will be populated with the enumeration entries added using this method. Call #AddEnumEntry for each enumeration entry of the new feature.

If one of the Create methods other than #CreateEnum is called, the enumeration entries added to the factory are ignored.

Parameters:

aName (str, in) – Name of the new enumeration entry.
aValue (int, in) – Value of the new enumeration entry.
aDisplayName (str, in) – Custom display name for the new enum entry. If an empty string is provided a default display name is generated for the enum entry.
aNameSpace – Namespace for the new enum entry. See #SetNameSpace for more information on GenICam XML namespaces.

AddVariable(aFeatureName)¶

Adds a variable that will be declared for the next SwissKnife of Converter to be added to the GenICam XML file.

In order to refer to a feature in a SwissKnife or Converter formula, it first needs to be defined as a variable.

Variables are defined using the exact case sensitive feature name. They are then used in the formulas using the same exact feature name.

A SwissKnife can have one or more variables.

A Converter can have zero or more variables. Important: the main feature a Converter operates on (TO/FROM) does not have to be defined as a variable.

Variables are ignored if the next feature to be added to the GenICam XML file is not a SwissKnife or Converter.

For ADVANCED GenApi support use cases.

Parameters:: aFeatureName (str) – [in] Feature name to use as variable.

CreateInteger(*args)¶

CreateFloat(*args)¶

CreateString(aRegister=None)¶

Adds a string feature to the GenICam XML file using the current state of the factory for its attributes.

After calling this method, all feature creation attributes are reset to their default values.

Parameters:

aRegister (IPvRegister, in, optional) – Register that the new string feature maps to or NULL if creating a chunk or messaging channel event data feature.

Return type:

PvResult

Returns:

Includes:

PV_OK on success.
PV_INVALID_PARAMETER
- If aRegister is NULL and none of chunk ID, messaging channel event or pValue has been defined.
PV_NOT_INITIALIZED if #SetName has not been called for the new feature.

CreateRegister(aRegister=None)¶

CreateBoolean(aRegister=None)¶

Adds a Boolean feature to the GenICam XML file using the current state of the factory for its attributes.

After calling this method, all feature creation attributes are reset to their default values.

Parameters:

aRegister (IPvRegister, in, optional) – Register that the new Boolean feature maps to or NULL if creating a chunk or messaging channel event data feature.

Return type:

PvResult

Returns:

Includes:

PV_OK on success.
PV_INVALID_PARAMETER
- If aRegister is NULL and none of chunk ID, messaging channel event or pValue has been defined.
PV_NOT_INITIALIZED if #SetName has not been called for the new feature.

CreateCommand(aRegister=None)¶

Adds a command feature to the GenICam XML file using the current state of the factory for its attributes.

After calling this method, all feature creation attributes are reset to their default values.

Parameters:

aRegister (IPvRegister, in, optional) – Register that the new command feature maps to.

Return type:

PvResult

Returns:

Includes:

PV_OK on success.
PV_INVALID_PARAMETER
- If aRegister is NULL and pValue has not been defined.
PV_NOT_INITIALIZED if #SetName has not been called for the new feature.

CreateEnum(aRegister=None)¶

Adds an enumeration feature to the GenICam XML file using the current state of the factory for its attributes.

After calling this method, all feature creation attributes are reset to their default values.

Parameters:

aRegister (IPvRegister, in, optional) – Register that the new enumeration feature maps to or NULL if creating a chunk or messaging channel event data feature.

Return type:

PvResult

Returns:

Includes:

PV_OK on success.
PV_INVALID_PARAMETER
- If aRegister is NULL and none of chunk ID, messaging channel event or pValue has been defined.
- If no enumeration entries have been defined for the new feature.
PV_NOT_INITIALIZED if #SetName has not be called for the new feature.

CreateIntSwissKnife(aFormula)¶

Adds an integer SwissKnife to the GenICam XML file using the current state of the factory for its attributes.

An integer SwissKnife is a GenApi read-only feature that resolves a formula whenever it is read. The formula is defined as a string and evaluates to an integer. It can refer to other features as long as they have been declared with #AddVariable. Variables can be integer, float (truncated to integer), enum (integer value) boolean (1 or 0 integer value) or command as long as they are readable.

Example of a simple SwissKnife adding the value of two features:

lFactory->SetName( "MySwissKnife" );
lFactory->SetCategory( "MyCategory" );
lFactory->AddVariable( "ValueA" );
lFactory->AddVariable( "ValueB" );
lFactory->CreateIntSwissKnife( "ValueA + ValueB" );

When MySwissKnife is read, the formula is evaluated. If ValueA is 4 and ValueB is 3, MySwissKnife will read as 7: 4 + 3.

Formula examples:

Simple constant: 42
Simple feature: ValueA
Simple mathematical expression: 32 + 10
Simple mathematical expression with features: ValueA + (10 * ValueB)
Bitwise operations: (ValueA << 16) | (ValueB >> 16)
‘if’ statement: (ValueA = 4) ? 8 : 16
Switch-case statement with default: (ValueA = 0) ? 0x0000B824 : (ValueA = 1) ? 0x0000B82C : (ValueA = 2) ? 0x0000B884 : (ValueA = 3) ? 0x0000B88C : 0xFFFFFFFF

After calling this method, all feature creation attributes are reset to their default values.

GenApi formulas are compatible with expressions defined for the Kirill Zaborsk’s math parser library, the CCalc library from Walery Studennikov. More information is available at http://kirya.narod.ru/mathparser.html.

For ADVANCED GenApi support use cases.

Parameters:

aFormula (str) – [in] SwissKnife formula.

Return type:

PvResult

Returns:

Includes:

PV_OK on success.
PV_INVALID_PARAMETER if the formula is empty.
PV_NOT_INITIALIZED if #SetName has not be called for the new feature.

CreateFloatSwissKnife(aFormula)¶

Adds a float SwissKnife to the GenICam XML file using the current state of the factory for its attributes.

A float SwissKnife is a GenApi read-only feature that resolves a formula whenever it is read. The formula is defined as a string and evaluates to a float. It can refer to other features as long as they have been declared with #AddVariable. Variables can be integer (converter to float), float, enum (integer value converted to float) boolean (1 or 0 integer value converted to float) or command as long as they are readable.

Example of a simple SwissKnife adding the value of two features:

lFactory->SetName( "MySwissKnife" );
lFactory->SetCategory( "MyCategory" );
lFactory->AddVariable( "ValueA" );
lFactory->AddVariable( "ValueB" );
lFactory->CreateFloatSwissKnife( "ValueA + ValueB" );

When MySwissKnife is read, the formula is evaluated. If ValueA is 4.1 and ValueB is 3.2, MySwissKnife will read as 7.3: 4.1 + 3.2.

Formula examples:

Simple constant: 42.4
Simple feature: ValueA
Simple mathematical expression: 32.34 + 10.714
Simple mathematical expression with features: ValueA + (10.1 * ValueB)
Advanced mathematical expression: SIN(0.814)
Advanced mathematical expression with feature: SQRT(ValueA)
‘if’ statement: (ValueA > 4) ? 8.12 : 16.991
Bitwise operations are not supported with float SwissKnife.

After calling this method, all feature creation attributes are reset to their default values.

GenApi formulas are compatible with expressions defined for the Kirill Zaborsk’s math parser library, the CCalc library from Walery Studennikov. More information is available at http://kirya.narod.ru/mathparser.html.

For ADVANCED GenApi support use cases.

Parameters:

aFormula (str) – [in] SwissKnife formula.

Return type:

PvResult

Returns:

Includes:

PV_OK on success.
PV_INVALID_PARAMETER if the formula is empty.
PV_NOT_INITIALIZED if #SetName has not be called for the new feature.

CreateIntConverter(aValueFeatureName, aFromFormula, aToFormula)¶

Adds an integer Converter to the GenICam XML file using the current state of the factory for its attributes.

A converter is a read-write GenApi construct that allows reading from and writing to a referenced feature using SwissKnife-like formulas.

The referenced feature is provided through aValueFeatureName and represents the feature on which the expressions operates. It is referred to as FROM and TO in the converter formulas and does not have to be declared as a variable.

The formula used to read the referenced feature is provided with aFromFormula. The raw value read from the reference is available as the special TO variable.

The formula used to write to the referenced feature is provided with aToFormula. The raw value written to the converter is available as the special FROM variable.

If the converter formulas need to reference additional features they should first be declared using the #AddVariable method.

Example of a converter handling conversion between milliseconds and nanoseconds:

lFactory->SetName( "MyNanosecondFeature" );
lFactory->SetCategory( "MyCategory" );
lFactory->SetUnit( "ms" );
lFactory->CreateIntConverter( "MyMillisecondFeature", "TO * 1000", "FROM / 1000" );

In the example above:

We create a MyNanosecondFeature.
The referenced feature is MyMillisecondFeature.
The converter read formula is TO * 1000, where TO is the value read from MyMillisecondFeature.
- Reading from the MyNanosecondFeature converter:
  
  Reads the referenced feature, MyMillisecondFeature (4)
  
  Replaces TO in the ‘from’ formula with the value read from MyMillisecondFeature (4 * 1000)
  
  Evaluates the formula (4000)
  
  Completes the read operation returning 4000
The converter write formula is is FROM / 1000, where FROM is the value written to the converter.
- Writing to the MyNanosecondFeature converter:
  
  Value written to the converter (2000)
  
  Replaces FROM in the ‘to’ formula with the value written to the converter (2000 / 1000)
  
  Evaluates the formula (2)
  
  Writes 2 to MyMillisecondFeature

See #CreateFloatSwissKnife for more information on formulas.

For ADVANCED GenApi support use cases.

After calling this method, all feature creation attributes are reset to their default values.

Parameters:

aValueFeatureName (str) – [in] Main feature the converter operates on, referred as TO and FROM in the formulas.
aFromFormula (str) – [in] Formula used when reading from the converter.
aToFormula (str) – [in] Formula used when writing to the converter.

Return type:

PvResult

Returns:

Includes:

PV_OK on success.
PV_INVALID_PARAMETER if value feature name or either formula is empty.
PV_NOT_INITIALIZED if #SetName has not be called for the new feature.

CreateFloatConverter(aValueFeatureName, aFromFormula, aToFormula)¶

Adds a float Converter to the GenICam XML file using the current state of the factory for its attributes.

A converter is a read-write GenApi construct that allows reading from and writing to a referenced feature using SwissKnife-like formulas.

The referenced feature is provided through aValueFeatureName and represents the feature on which the expressions operates. It is referred to as FROM and TO in the converter formulas and does not have to be declared as a variable.

The formula used to read the referenced feature is provided with aFromFormula. The raw value read from the reference is available as the special TO variable.

The formula used to write to the referenced feature is provided with aToFormula. The raw value written to the converter is available as the special FROM variable.

If the converter formulas need to reference additional features they should first be declared using the #AddVariable method.

Example of a converter handling conversion between inches and centimeters:

lFactory->SetName( "MyCentimeterFeature" );
lFactory->SetCategory( "MyCategory" );
lFactory->SetUnit( "cm" );
lFactory->CreateFloatConverter( "MyInchesFeature", "TO * 2.54", "FROM * 0.3937" );

In the example above:

We create a MyCentimeterFeature.
The referenced feature is MyInchesFeature.
The converter read formula is TO * 2.54, where TO is the value read from MyInchesFeature.
- Reading from the MyCentimeterFeature converter:
  
  Reads the referenced feature, MyInchesFeature (4)
  
  Replaces TO in the ‘from’ formula with the value read from MyInchesFeature (4 * 2.54)
  
  Evaluates the formula (10.16)
  
  Completes the read operation returning 10.16
  
  The converter write formula is is FROM * 0.3937, where FROM is the value written to the converter.
- Writing to the MyCentimeterFeature converter:
  
  Value written to the converter (2)
  
  Replaces FROM in the ‘to’ formula with the value written to the converter (2 * 0.3937)
  
  Evaluates the formula (0.7874)
  
  Writes 0.7874 to MyInchesFeature

See #CreateFloatSwissKnife for more information on formulas.

For ADVANCED GenApi support use cases.

After calling this method, all feature creation attributes are reset to their default values.

Parameters:

aValueFeatureName (str) – [in] Main feature the converter operates on, referred as TO and FROM in the formulas.
aFromFormula (str) – [in] Formula used when reading from the converter.
aToFormula (str) – [in] Formula used when writing to the converter.

Return type:

PvResult

Returns:

Includes:

PV_OK on success.
PV_INVALID_PARAMETER if value feature name or either formula is empty.
PV_NOT_INITIALIZED if #SetName has not be called for the new feature.

AddInvalidatorTo(aStandardFeatureName, aInvalidatorFeatureName)¶

Adds a a custom invalidator to a feature managed by PvSoftDeviceGEV.

This methods allows defining extra custom invalidators for features managed by PvSoftDeviceGEV. As an example, if you call this method to add an ComponentSelector invalidator to the PvSoftDeviceGEV managed (or owned) PixelFormat feature, the invalidator is added to the invalidators of PixelFormat when creating the GenICam XML of the device. With this example, the GenApi cache of PixelFormat would be invalidated when the value of ComponentSelector changes client-side.

For ADVANCED GenApi support use cases.

Parameters:

aStandardFeatureName (str) – [in] Name of the feature to add the invalidator to.
aInvalidatorFeatureName (str) – [in] Name of the feature which changes causes aStandardFeatureName to be invalidated.

Return type:

PvResult

Returns:

Includes:

PV_OK on success.

SetPIsAvailableFor(aStandardFeatureName, aPIsAvailableFeatureName)¶

Forces a pIsAvailable reference for a feature managed by PvSoftDeviceGEV.

The pIsAvailable would typically be an IntSwissKnife defined as a global feature in the IPvSoftDeviceGEVEventSink.OnCreateCustomGenApiFeatures callback. The feature identified by aStandardFeatureName would only be available when the IntSwissKnife referred to by aPIsAvailableFeatureName evaluates to non-zero.

With most use-cases #SetPIsAvailableFor should be called in the same context.

For ADVANCED GenApi support use cases.

Parameters:

aStandardFeatureName (str) – [in] Name of the feature to add the pIsAvailable for.
aPIsAvailableFeatureName (str) – [in] Feature used to evaluate if the feature is available or not.

Return type:

PvResult

Returns:

Includes:

PV_OK on success.

SetPIsAvailableForEnumEntry(aStandardFeatureName, aEnumEntryName, aPIsAvailableFeatureName)¶

Forces a pIsAvailable reference for a the enum entry of an enum feature managed by PvSoftDeviceGEV.

The pIsAvailable would typically be an IntSwissKnife defined as a global feature in the IPvSoftDeviceGEVEventSink.OnCreateCustomGenApiFeatures callback. aEnumEntry of the enum feature identified by aStandardFeatureName would only be available when the IntSwissKnife referred to by aPIsAvailableFeatureName evaluates to non-zero.

With most use-cases #SetPIsAvailableFor should be called in the same context.

For ADVANCED GenApi support use cases.

Parameters:

aStandardFeatureName (str) – [in] Name of the enum feature the enum entry belongs to.
aEnumEntryName (str) – [in] Name of the enum entry to add the pIsAvailable for.
aPIsAvailableFeatureName (str) – [in] Feature used to evaluate if the enum entry is available or not.

Return type:

PvResult

Returns:

Includes:

PV_OK on success.

SetPIsLockedFor(aStandardFeatureName, aPIsLockedFeatureName)¶

SetPValueFor(aStandardFeatureName, aPValueFeatureName)¶

Forces a pValue reference for a feature managed by PvSoftDeviceGEV.

For ADVANCED GenApi support use cases.

Parameters:

aStandardFeatureName (str) – [in] Name of the feature to force pValue for.
aPValueFeatureName (str) – [in] Name of the feature used provide the value of the aStandardFeatureName feature.

Return type:

PvResult

Returns:

Includes:

PV_OK on success.

SetPMinFor(aStandardFeatureName, aPMinFeatureName)¶

Forces a pMin reference for an integer or float feature managed by PvSoftDeviceGEV.

For ADVANCED GenApi support use cases.

Parameters:

aStandardFeatureName (str) – [in] Name of the feature to force pMin for.
aPMinFeatureName (str) – [in] Name of the feature used provide the minimum of the aStandardFeatureName feature.

Return type:

PvResult

Returns:

Includes:

PV_OK on success.

SetPMaxFor(aStandardFeatureName, aPMaxFeatureName)¶

Forces a pMax reference for an integer or float feature managed by PvSoftDeviceGEV.

For ADVANCED GenApi support use cases.

Parameters:

aStandardFeatureName (str) – [in] Name of the feature to force pMax for.
aPMaxFeatureName (str) – [in] Name of the feature used provide the maximum of the aStandardFeatureName feature.

Return type:

PvResult

Returns:

Includes:

PV_OK on success.

SetPIncFor(aStandardFeatureName, aPIncFeatureName)¶

Forces a pInc reference for an integer feature managed by PvSoftDeviceGEV.

For ADVANCED GenApi support use cases.

Parameters:

aStandardFeatureName (str) – [in] Name of the feature to force pInc for.
aPIncFeatureName (str) – [in] Name of the feature used provide the maximum of the aStandardFeatureName feature.

Return type:

PvResult

Returns:

Includes:

PV_OK on success.

SetPMin(aFeatureName)¶

Sets node to use for integer or float dynamic minimum attribute.

Sets the pMin attribute of an integer or float to point to another GenApi node like a Swiss Knife. When pMin is set for a new feature, it has precedence on any defined constant minimum.

Parameters:: aFeatureName (str) – [in] Name of the feature the integer or float minimum attribute points to.

SetPMax(aFeatureName)¶

Sets node to use for integer or float dynamic maximum attribute.

Sets the pMax attribute of an integer or float to point to another GenApi node like a Swiss Knife. When pMax is set for a new feature, it has precedence on any defined constant maximum.

Parameters:: aFeatureName (str) – [in] Name of the feature the integer or float maximum attribute points to.

SetPInc(aFeatureName)¶

Sets node to use for integer dynamic increment attribute.

Sets the pInc attribute of an integer to point to another GenApi node like a Swiss Knife. When pInc is set for a new feature, it has precedence on any defined constant increment.

Parameters:: aFeatureName (str) – [in] Name of the feature the integer increment attribute points to.

class eBUS.IPvImage(*args, **kwargs)¶

Bases: object

Generic image interface.

property thisown¶: The membership flag

GetDataPointer(self) → ndarray¶

Get the numpy aray describing the image’s data.

The GetDataPointer method returns a numpy array describing the buffer. The number of channels determine the dimensions, the dtype of the ndarray is determined by the number of bits per pixel.

Any packed pixel format (10 bits/pixel, 12 bits/pixel… etc) is described as a 1-dimensional numpy array with dtype np.uint8. The user is in charge of unpacking if needed.

Unpacked Mono and Bayer images are described as a 2-dimensional numpy array with shape (height,width), the dtype of the array is either np.uint8 or np.uint16 based on the actual bits/pixel.

Unpacked RGB, YUV or YCbCr images are described as a 3-dimensional numpy array with shape (height, width, channels), the dtype of the array is either np.uint8 or np.uint16. For example, PvPixelYUV422_8_UYVY has shape (height, width, 2) with dtype np.uint8, PvPixelYCbCr8_CbYCr has shape (height, width, 3) with dtype np.uint8, PvPixelBGR16 has shape (height, width, 3) with dtype np.uint16.

Return type:: ndarray
Returns:: A numpy array pointing to the image data.

GetImageSize()¶

Actual image size within the payload or buffer.

Uses the GEV leader for the actual width. Uses the GEV trailer for line count which is the actual height.

Return type:: int
Returns:: The actual image size within the payload or buffer

GetWidth()¶

Get the image’s width.

Return type:: int
Returns:: The image’s width in pixels.

GetHeight()¶

Get the image’s height.

Return type:: int
Returns:: The image’s height, in pixels.

GetPixelType()¶

The buffer’s pixel type.

Return type:: int
Returns:: The pixel type. The pixel depth, colorspace, and other information are coded into the value.

GetBitsPerPixel()¶

Returns how many bits are required to hold a pixel using the current buffer’s pixel type

Return type:: int
Returns:: Bits per pixel for the current buffer’s pixel type.

GetOffsetX()¶

Get the image’s horizontal offset.

Return type:: int
Returns:: The image’s horizontal offset, in pixels.

GetOffsetY()¶

Get the image’s vertical offset.

Return type:: int
Returns:: The image’s vertical offset, in pixels.

GetPaddingX()¶

Get the horizontal image padding.

Images lines could be grabbed in increments of, let’s say, 32 bytes. For an image 511 bytes across, the video interface adds a meaningless byte to make the line total 512 bytes (divisible by 32). In this case, the paddingX value would be 1 (byte).

Other devices may have different requirements on line length. Divible by 4, 8, 16, etc. or no specific limitations or requirements.

Return type:: int
Returns:: The horizontal image padding, in bytes; the number of bytes at the end of an image’s line that contain meaningless data.

GetPaddingY()¶

Get the vertical image padding.

Additional bytes appended at the end of an image.

See #GetPaddingX.

Return type:: int
Returns:: The vertical image padding, in bytes.

List position	Entry value	Entry name
0	5	Orange
1	4	Apple
2	99	Watermelon