Impact Acquire SDK Python
|
Category that contains items that belong to the data stream module of the transport layer. More...
Public Member Functions | |
__init__ (self, *args) | |
Constructs a new mvIMPACT.acquire.DataStreamModule object. | |
Properties | |
eventNotification = property(lib_mvIMPACT_acquire.DataStreamModule_eventNotification_get, doc=) | |
An enumerated integer property. | |
eventSelector = property(lib_mvIMPACT_acquire.DataStreamModule_eventSelector_get, doc=) | |
An enumerated integer property. | |
mvAutoJoinMulticastGroups = property(lib_mvIMPACT_acquire.DataStreamModule_mvAutoJoinMulticastGroups_get, doc=) | |
A boolean property. | |
mvLowLatencyModeEnable = property(lib_mvIMPACT_acquire.DataStreamModule_mvLowLatencyModeEnable_get, doc=) | |
A boolean property. | |
mvMMAPBufferCount = property(lib_mvIMPACT_acquire.DataStreamModule_mvMMAPBufferCount_get, doc=) | |
An integer property. | |
mvMultiCoreAcquisitionBaseCore = property(lib_mvIMPACT_acquire.DataStreamModule_mvMultiCoreAcquisitionBaseCore_get, doc=) | |
An integer property. | |
mvMultiCoreAcquisitionCoreCount = property(lib_mvIMPACT_acquire.DataStreamModule_mvMultiCoreAcquisitionCoreCount_get, doc=) | |
An integer property. | |
mvMultiCoreAcquisitionCoreSwitchInterval = property(lib_mvIMPACT_acquire.DataStreamModule_mvMultiCoreAcquisitionCoreSwitchInterval_get, doc=) | |
An integer property. | |
mvMultiCoreAcquisitionEnable = property(lib_mvIMPACT_acquire.DataStreamModule_mvMultiCoreAcquisitionEnable_get, doc=) | |
A boolean property. | |
mvMultiCoreAcquisitionFirstCoreIndex = property(lib_mvIMPACT_acquire.DataStreamModule_mvMultiCoreAcquisitionFirstCoreIndex_get, doc=) | |
An integer property. | |
mvResendActive = property(lib_mvIMPACT_acquire.DataStreamModule_mvResendActive_get, doc=) | |
A boolean property. | |
mvResendBatchingActive = property(lib_mvIMPACT_acquire.DataStreamModule_mvResendBatchingActive_get, doc=) | |
A boolean property. | |
mvResendMaximumGapSize = property(lib_mvIMPACT_acquire.DataStreamModule_mvResendMaximumGapSize_get, doc=) | |
An integer property. | |
mvResendMode = property(lib_mvIMPACT_acquire.DataStreamModule_mvResendMode_get, doc=) | |
An integer property. | |
mvResendRequestCredits = property(lib_mvIMPACT_acquire.DataStreamModule_mvResendRequestCredits_get, doc=) | |
A floating point property. | |
mvResendRequestMax = property(lib_mvIMPACT_acquire.DataStreamModule_mvResendRequestMax_get, doc=) | |
An integer property. | |
mvResendResponseTimeout = property(lib_mvIMPACT_acquire.DataStreamModule_mvResendResponseTimeout_get, doc=) | |
An integer property. | |
mvResendsPerTimeout = property(lib_mvIMPACT_acquire.DataStreamModule_mvResendsPerTimeout_get, doc=) | |
An integer property. | |
mvResendThreshold = property(lib_mvIMPACT_acquire.DataStreamModule_mvResendThreshold_get, doc=) | |
An integer property. | |
mvResendUserControlledEnable = property(lib_mvIMPACT_acquire.DataStreamModule_mvResendUserControlledEnable_get, doc=) | |
A boolean property. | |
mvStreamAnnounceBufferMaximum = property(lib_mvIMPACT_acquire.DataStreamModule_mvStreamAnnounceBufferMaximum_get, doc=) | |
An integer property. | |
mvStreamDriverTechnology = property(lib_mvIMPACT_acquire.DataStreamModule_mvStreamDriverTechnology_get, doc=) | |
A string property. | |
mvV4L2MemoryMode = property(lib_mvIMPACT_acquire.DataStreamModule_mvV4L2MemoryMode_get, doc=) | |
An enumerated integer property. | |
payloadSize = property(lib_mvIMPACT_acquire.DataStreamModule_payloadSize_get, doc=) | |
An integer property. | |
streamAnnounceBufferMinimum = property(lib_mvIMPACT_acquire.DataStreamModule_streamAnnounceBufferMinimum_get, doc=) | |
An integer property. | |
streamAnnouncedBufferCount = property(lib_mvIMPACT_acquire.DataStreamModule_streamAnnouncedBufferCount_get, doc=) | |
An integer property. | |
streamBufferAlignment = property(lib_mvIMPACT_acquire.DataStreamModule_streamBufferAlignment_get, doc=) | |
An integer property. | |
streamBufferHandlingMode = property(lib_mvIMPACT_acquire.DataStreamModule_streamBufferHandlingMode_get, doc=) | |
An enumerated integer property. | |
streamChunkCountMaximum = property(lib_mvIMPACT_acquire.DataStreamModule_streamChunkCountMaximum_get, doc=) | |
An integer property. | |
streamDeliveredFrameCount = property(lib_mvIMPACT_acquire.DataStreamModule_streamDeliveredFrameCount_get, doc=) | |
An integer property. | |
streamID = property(lib_mvIMPACT_acquire.DataStreamModule_streamID_get, doc=) | |
A string property. | |
streamInputBufferCount = property(lib_mvIMPACT_acquire.DataStreamModule_streamInputBufferCount_get, doc=) | |
An integer property. | |
streamIsGrabbing = property(lib_mvIMPACT_acquire.DataStreamModule_streamIsGrabbing_get, doc=) | |
A boolean property. | |
streamLostFrameCount = property(lib_mvIMPACT_acquire.DataStreamModule_streamLostFrameCount_get, doc=) | |
An integer property. | |
streamOutputBufferCount = property(lib_mvIMPACT_acquire.DataStreamModule_streamOutputBufferCount_get, doc=) | |
An integer property. | |
streamStartedFrameCount = property(lib_mvIMPACT_acquire.DataStreamModule_streamStartedFrameCount_get, doc=) | |
An integer property. | |
streamType = property(lib_mvIMPACT_acquire.DataStreamModule_streamType_get, doc=) | |
An enumerated integer property. | |
thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag") | |
Category that contains items that belong to the data stream module of the transport layer.
The DataStream category contains items that belong to the data stream module of the transport layer.
__init__ | ( | self, | |
* | args ) |
Constructs a new mvIMPACT.acquire.DataStreamModule object.
pDev | [in] A pointer to a mvIMPACT.acquire.Device object obtained from a mvIMPACT.acquire.DeviceManager object. |
index | [in] The index of the instance this object shall be created for. Passing an invalid index will raise an exception. |
settingName | [in] The name of the driver internal setting to access with this instance. A list of valid setting names can be obtained by a call to mvIMPACT.acquire.FunctionInterface.getAvailableSettings, new settings can be created with the function mvIMPACT.acquire.FunctionInterface.createSetting |
Reimplemented from ComponentCollection.
|
static |
An enumerated integer property.
Activate or deactivate the notification to the host application of the occurrence of the selected Event.
Activate or deactivate the notification to the host application of the occurrence of the selected Event.
The following string values might be valid for this feature:
|
static |
An enumerated integer property.
Selects which Event to signal to the host application.
Selects which Event to signal to the host application.
The following string values might be valid for this feature:
|
static |
A boolean property.
This feature controls whether the host automatically joins the multicast group(s) of the camera(s) it configures.
This feature controls whether the host automatically joins the multicast group(s) of the camera(s) it configures.
|
static |
A boolean property.
This feature controls whether the low-latency mode (NVIDIA specific) is active or not.
PRELIMINARY. SUBJECT TO CHANGE WITHOUT FURTHER NOTICE. This feature controls whether the low-latency mode (NVIDIA specific) is active or not.
|
static |
An integer property.
The number of buffers internally used for the MMAP memory mode.
PRELIMINARY. SUBJECT TO CHANGE WITHOUT FURTHER NOTICE. This feature defines the number of buffers internally used for the MMAP memory mode. This is NOT to be confused with the value of the 'RequestCount' property.
|
static |
An integer property.
This feature indicates the base CPU core (as selected by the NIC) that will be used for the processing of network data for this stream.
This feature indicates the base CPU core (as selected by the NIC) that will be used for the processing of network data for this stream. This value when added to 'mvMultiCoreAcquisitionFirstCoreIndex' will indicate the first of 'mvMultiCoreAcquisitionCoreCount' actual CPUs that will ater be used for the processing of network data for this stream
|
static |
An integer property.
This feature controls how many CPU cores will be used for the processing of network data for this stream.
This feature controls how many CPU cores will be used for the processing of network data for this stream
|
static |
An integer property.
This feature controls after how many network packets the processing shall switch to the next CPU core. Smaller values introduce a higher overhead, values too high might result in loss of data when the network card runs out of buffers. The recommended values are in the range of 32 - 256.
This feature controls after how many network packets the processing shall switch to the next CPU core. Smaller values introduce a higher overhead, values too high might result in loss of data when the network card runs out of buffers. The recommended values are in the range of 32 - 256
|
static |
A boolean property.
This feature controls whether the host shall process incoming data a single arbitrary CPU core (Off) or one or multiple dedicated ones (On).
This feature controls whether the host shall process incoming data a single arbitrary CPU core (Off) or one or multiple dedicated ones (On)
|
static |
An integer property.
This feature controls which is the first CPU core to use for processing network data out of the list of CPU cores available for this task for the NIC associated with this stream.
This feature controls which is the first CPU core to use for processing network data out of the list of CPU cores available for this task for the NIC associated with this stream. Please note that this number does NOT have a 1:1 relationship to the CPU in your system but to the CPUs available for processing on the selected NIC. So if e.g. the corresponding NICs RSS table can access CPUs 6, 8, 10 and 12 then setting 'mvMultiCoreAcquisitionFirstCoreIndex' to 2 will result in CPUs 10 and 12 to be used.
|
static |
A boolean property.
This feature controls if the stream will issue packet resend requests.
This feature controls if the stream will issue packet resend requests.
|
static |
A boolean property.
This feature controls if the stream will issue batched packet resend requests if it detects several consecutive missing packets.
This feature controls if the stream will issue batched packet resend requests if it detects several consecutive missing packets.
|
static |
An integer property.
Defines the maximum gap between 2 consecutive packets in the stream.
This feature defines the maximum gap between 2 consecutive packets in the stream. If a detected gap larger than 'MaximumGapSize' this block is considered as incomplete. When this parameter is 0 no gap will be considered as too big.
|
static |
An integer property.
Indicates the mode the internal resend algorithm is working in. This feature is a bit mask. The bits have the following meaning (LSB to MSB): Request Resends when a new block starts and the current one has missing packets(0x01)(not recommended for LAG), Request Resends when a new block starts and the current one has no trailer so far(0x02)(not recommended for LAG), Request Resends when more than 'ResendThreshold' packets have been received since a missing packet has been detected(0x04), Request Resends whenever 'mvResendResponseTimeout' did elapse for the previous still incomplete buffer(0x08), Request Resends whenever 'mvResendResponseTimeout' did elapse for the current still incomplete buffer(0x10), Request Resends whenever a packet is considered as missing(0x20)(not recommended for LAG), Request Resends whenever a block start has been missing(e.g. because no capture buffer was available at the time the block did start)(0x40)
Indicates the mode the internal resend algorithm is working in. This feature is a bit mask. The bits have the following meaning (LSB to MSB): Request Resends when a new block starts and the current one has missing packets(0x01)(not recommended for LAG), Request Resends when a new block starts and the current one has no trailer so far(0x02)(not recommended for LAG), Request Resends when more than 'ResendThreshold' packets have been received since a missing packet has been detected(0x04), Request Resends whenever 'mvResendResponseTimeout' did elapse for the previous still incomplete buffer(0x08), Request Resends whenever 'mvResendResponseTimeout' did elapse for the current still incomplete buffer(0x10), Request Resends whenever a packet is considered as missing(0x20)(not recommended for LAG), Request Resends whenever a block start has been missing(e.g. because no capture buffer was available at the time the block did start)(0x40)
|
static |
A floating point property.
Indicates the maximum number of resend requests in percent of payload packets per buffer to send to the device until the packet is considered as lost.
This feature indicates the maximum number of resend requests in percent of payload packets per buffer to send to the device until the packet is considered as lost.
|
static |
An integer property.
Indicates the maximum number of resend requests per packet to send to the device until the packet is considered as lost.
This feature indicates the maximum number of resend requests per packet to send to the device until the packet is considered as lost.
|
static |
An integer property.
This feature controls the resend response timeout in milliseconds.
This float value sets the resend response timeout in milliseconds. Whenever a requested packet does not arrive within this timer period it will be requested again until mvResendRequestMax resend requests for this packet have been issued.
|
static |
An integer property.
Indicates the number of packets to be requested whenever the resend response timeout elapses.
This feature indicates the number of packets to be requested whenever the resend response timeout elapses.
|
static |
An integer property.
Indicates the resend threshold within the capture window.
This feature indicates the resend threshold within the capture window. If current packet ID and first missing packet ID are mvResendThreshold IDs apart the stream will issue a resend request.
|
static |
A boolean property.
This feature controls if the resend related parameters on this stream will be controlled by the driver or the host application.
This feature controls if the resend related parameters on this stream will be controlled by the driver or the host application.
|
static |
An integer property.
Maximal number of buffers to announce to enable selected acquisition mode.
This feature indicates the maximal number of buffers to announce to enable selected acquisition mode.
|
static |
A string property.
The underlying driver technology used by this stream.
This is a read only element. It is a string that contains the underlying driver technology used by this stream.
|
static |
An enumerated integer property.
Controls which of the underlying V4L2 specific buffer memory modes will be used.
PRELIMINARY. SUBJECT TO CHANGE WITHOUT FURTHER NOTICE. This feature controls which of the underlying V4L2 specific buffer memory modes will be used.
The following string values might be valid for this feature:
|
static |
An integer property.
Provides the number of bytes transferred for each data buffer or chunk on the stream channel.
Provides the number of bytes transferred for each data buffer or chunk on the stream channel. This includes any end-of-line, end-of-frame statistics or other stamp data. This is the total size of data payload for a data block.
|
static |
An integer property.
Minimal number of buffers to announce to enable selected acquisition mode.
This feature indicates the minimal number of buffers to announce to enable selected acquisition mode.
|
static |
An integer property.
Number of announced (known) buffers on this stream. This value is volatile. It may change if additional buffers are announced and/or buffers are revoked by the GenTL Consumer.
This is a read-only feature. It indicates the number of announced (known) buffers on this stream. This value is volatile. It may change if additional buffers are announced and/or buffers are revoked by the GenTL Consumer.
|
static |
An integer property.
Alignment size in bytes of the buffers passed to DSAnnounceBuffer.
This feature indicates the alignment size in bytes of the buffers passed to DSAnnounceBuffer. If a buffer is passed to DSAnnounceBuffer which is not aligned according to the alignment size it is up to the Producer to either reject the buffer and return a GC_ERR_INVALID_BUFFER error code or to cope with a potential overhead and use the unaligned buffer as is.
|
static |
An enumerated integer property.
Allows to select the buffer handling mode for the stream.
This enumeration allows the selection of the buffer handling mode for the stream.
The following string values might be valid for this feature:
|
static |
An integer property.
Maximum number of chunks to be expected in a buffer (can be used to allocate the array for the DSGetBufferChunkData function).
Maximum number of chunks to be expected in a buffer (can be used to allocate the array for the DSGetBufferChunkData function).
|
static |
An integer property.
Number of delivered frames since last acquisition start.
This feature indicates the number of delivered frames since last acquisition start. It is not reset until the stream is closed.
|
static |
A string property.
Device wide unique ID of the selected stream.
This is a read only element. It is a string that indicates a device wide unique identifier of the selected stream.
|
static |
An integer property.
Number of buffers in the input buffer pool plus the buffers(s) currently being filled.
This feature indicates the number of buffers in the input buffer pool plus the buffers(s) currently being filled.
|
static |
A boolean property.
Flag indicating whether the acquisition engine is started or not.
This feature indicates whether the acquisition engine is started or not. This is independent from the acquisition status of the remote device.
|
static |
An integer property.
Number of lost frames due to queue underrun.
This feature indicates the number of lost frames due to queue underrun. This number is initialized with zero at the time the stream is opened and incremented every time the data could not be acquired because there was no buffer in the input buffer pool. It is not reset until the stream is closed.
|
static |
An integer property.
Number of buffers in the output buffer queue.
This feature indicates the number of buffers in the output buffer queue.
|
static |
An integer property.
Number of frames started in the acquisition engine.
This feature indicates the number of frames started in the acquisition engine. This number is incremented every time in case of a new buffer is started and then to be filled (data written to) regardless even if the buffer is later delivered to the user or discarded for any reason. This number is initialized with 0 at the time the stream is opened. It is not reset until the stream is closed.
|
static |
An enumerated integer property.
Identifies the stream technology of the GenTL Producer implementation.
This is a read only feature. This enumeration provides a value that indicates stream technology of the GenTL Producer implementation.
The following string values might be valid for this feature:
|
static |