mvIMPACT Acquire SDK C++
CustomCommandGenerator Class Reference

Contains convenience functions to control features understood by a devices custom command interpreter. More...

#include <mvIMPACT_acquire_GenICam_CustomCommands.h>

Public Member Functions

unsigned int commandBufferSize (void) const
 Returns the size of the command buffer for this device in bytes.
 
unsigned int commandBufferSizeUsed (void) const
 Returns the amount of bytes of the command buffer currently used(thus the amount of bytes that await sending) for this device in bytes.
 
 CustomCommandGenerator (mvIMPACT::acquire::Device *pDev, const std::string &settingName="Base")
 Constructs a new mvIMPACT::acquire::GenICam::CustomCommandGenerator object.
 
void discardCommandBuffer ()
 Discards all pending custom commands to the device.
 
int modifySequencerSetValue (const int64_type sequencerSet, const TSequencerSetParameter parameter, const double value)
 Modifies a value of a certain sequencer set at runtime.
 
int modifySequencerSetValue (const int64_type sequencerSet, const TSequencerSetParameter parameter, const int64_type value)
 Modifies a value of a certain sequencer set at runtime.
 
int queueSequencerSetValueModification (const int64_type sequencerSet, const TSequencerSetParameter parameter, const double value)
 Queues the modification of a value of a certain sequencer set at runtime.
 
int queueSequencerSetValueModification (const int64_type sequencerSet, const TSequencerSetParameter parameter, const int64_type value)
 Queues the modification of a value of a certain sequencer set at runtime.
 
int queueTransmissionRequest (const Request *pRequest, int offsetX, int offsetY, int width, int height, TRequestTransmissionMode mode=rtmFullResolution, unsigned int identifier=0)
 Request the transmission of an image currently associated with the Request object in a different mode/ROI.
 
int queueTransmissionRequest (const Request *pRequest, unsigned int identifier=0)
 Request the transmission of an image currently associated with the Request object in full resolution.
 
int queueTransmissionRequest (int64_type timestamp_us, int offsetX, int offsetY, int width, int height, TRequestTransmissionMode mode=rtmFullResolution, unsigned int identifier=0)
 Request the transmission of an image with a certain timestamp in a different mode/ROI.
 
int requestTransmission (const Request *pRequest, int offsetX, int offsetY, int width, int height, TRequestTransmissionMode mode=rtmFullResolution, unsigned int identifier=0)
 Request the transmission of an image currently associated with the Request object in a different mode/ROI.
 
int requestTransmission (const Request *pRequest, unsigned int identifier=0)
 Request the transmission of an image currently associated with the Request object in full resolution.
 
int requestTransmission (int64_type timestamp_us, int offsetX, int offsetY, int width, int height, TRequestTransmissionMode mode=rtmFullResolution, unsigned int identifier=0)
 Request the transmission of an image with a certain timestamp in a different mode/ROI.
 
int sendCommandBuffer (void)
 Applies all pending custom commands to the device.
 

Detailed Description

Contains convenience functions to control features understood by a devices custom command interpreter.

Contains convenience functions to control features understood by a devices custom command interpreter.

Note
Creating an instance of this class will only succeed when the device associated with this object supports the mvIMPACT::acquire::GenICam::mvCustomData.mvCustomCommandBuffer feature. If the feature is not supported an exception will be raised!

This class will allow to create various special commands understood by MATRIX VISION GmbH devices. For example an application can modify parameters in a running sequencer program without stopping the acquisition engine and/or the sequencer program (see mvIMPACT::acquire::GenICam::SequencerControl and the corresponding use cases for details). This allows changes to be applied much faster than with a conventional approach which would work like this:

mvIMPACT::acquire::GenICam::AcquisitionControl ac( getDevicePointerFromSomewhere() );
mvIMPACT::acquire::GenICam::SequencerControl sc( getDevicePointerFromSomewhere() );
sc.sequencerMode.writeS( "Off" );
sc.sequencerConfigurationMode.writeS( "On" );
sc.sequencerSetSelector.write( 2 );
sc.sequencerSetLoad.call(); // needed as otherwise other parameters in the set might get changed as well.
ac.exposureTime.write( 20000 );
sc.sequencerSetSave.call();
sc.sequencerConfigurationMode.writeS( "Off" );
sc.sequencerMode.writeS( "On" );
Category for the acquisition and trigger control features.
Definition: mvIMPACT_acquire_GenICam.h:2105
Category for the Sequencer Control features.
Definition: mvIMPACT_acquire_GenICam.h:9893

A single parameter in a defined sequencer set can be modified much faster at runtime like this:

mvIMPACT::acquire::GenICam::CustomCommandGenerator ccg( getDevicePointerFromSomewhere() );
// change the exposure time in sequencer set 2 to 30000 us.
ccg.modifySequencerSetValue( 2, sspExposureTime, 30000 );
Contains convenience functions to control features understood by a devices custom command interpreter...
Definition: mvIMPACT_acquire_GenICam_CustomCommands.h:436
@ sspExposureTime
Requests the ExposureTime property to be modified in a user selected sequencer set.
Definition: mvCustomCommandDataTypes.h:115
Attention
In a real world application the instance of mvIMPACT::acquire::GenICam::CustomCommandGenerator should be a member of a class or stored elsewhere as constructing objects from the mvIMPACT::acquire::GenICam namespace is taking time so this shouldn't be done for each command that shall be sent!

This class uses an internal command buffer which allows an application to send multiple change commands in a single packet. This can be achieved like this:

mvIMPACT::acquire::GenICam::CustomCommandGenerator ccg( getDevicePointerFromSomewhere() );
// queue 2 parameter change requests
// change the \c AnalogAll gain in sequencer set 0 to 3.14 dB.
ccg.queueSequencerSetValueModification( 0, sspGain_AnalogAll, 3.14 );
// change the exposure time in sequencer set 1 to 20000 us.
ccg.queueSequencerSetValueModification( 1, sspExposureTime, 20000 );
// send the 2 modifications in a single package
ccg.sendCommandBuffer();
@ sspGain_AnalogAll
Requests the Gain[GainSelector=AnalogAll] property to be modified in a user selected sequencer set.
Definition: mvCustomCommandDataTypes.h:117

The command queue NEVER overflows. When no more data can be stored in the queue before queuing the next parameter change all the pending changes will be transmitted to the device. Calling mvIMPACT::acquire::GenICam::CustomCommandGenerator.queueSequencerSetValueModification and mvIMPACT::acquire::GenICam::CustomCommandGenerator.sendCommandBuffer directly afterwards is equivalent to call mvIMPACT::acquire::GenICam::CustomCommandGenerator.modifySequencerSetValue. So the previous example can also be rewritten like this:

mvIMPACT::acquire::GenICam::CustomCommandGenerator ccg( getDevicePointerFromSomewhere() );
// queue 2 parameter change requests
// change the \c AnalogAll gain in sequencer set 0 to 3.14 dB.
ccg.queueSequencerSetValueModification( 0, sspGain_AnalogAll, 3.14 );
// change the exposure time in sequencer set 1 to 20000 us and send both requests to the device in a single packet.
ccg.modifySequencerSetValue( 1, sspExposureTime, 20000 );

Because there can never be an overflow of the command queue even this code is valid:

for( int i = 0; i < 100; i += 2 )
{
// if the command buffer is full everything should be sent to the device thus no error should be returned here
ccg.queueSequencerSetValueModification( i % 5, sspCounterDuration_Counter1, i * 100 );
ccg.queueSequencerSetValueModification( i % 5, sspExposureTime, ac.exposureTime.getMinValue() + static_cast<double>( i * 10 ) );
}
@ sspCounterDuration_Counter1
Requests the CounterDuration[CounterSelector=Counter1] property to be modified in a user selected seq...
Definition: mvCustomCommandDataTypes.h:99

Apart from modifying sequencer sets at runtime some MATRIX VISION GmbH devices support the so called Smart Frame Recall feature. For more information about the feature itself please refer to the corresponding use case in the product documentation. There is also a C++ example called GenICamSmartFrameRecallUsage.cpp which can be read to get a first glimpse. The source code and the documentation of this example can be found in the C++ version of this documentation. The mvIMPACT::acquire::GenICam::CustomCommandGenerator provides functions to request a full resolution version of an image based on a mvIMPACT::acquire::Request object containing an image with reduced resolution passed to it (internally the relevant piece of information is the timestamp of the image to request). To request an image an application can call one of the various versions of the mvIMPACT::acquire::GenICam::CustomCommandGenerator.requestTransmission functions.

int getNextRandomValue( int min, int max )
{
return ( rand() % ( max - min ) ) + min;
}
//...
// switch on the smart frame recall feature
ac.mvSmartFrameRecallEnable.write( bTrue );
// more code
Request* pRequest = getRequestFromSomewhere();
// request the transmission of an arbitrary ROI of this image in full resolution
int w = getNextRandomValue( 1, pRequest->imageWidth.read() );
int h = getNextRandomValue( 1, pRequest->imageHeight.read() );
int x = getNextRandomValue( 0, pRequest->imageWidth.read() - w );
int y = getNextRandomValue( 0, pRequest->imageHeight.read() - h );
ccg.requestTransmission( pRequest, x, y, w, h, rtmFullResolution );
ZYX read(int index=0) const
Reads a value from a property.
Definition: mvIMPACT_acquire.h:4170
Contains information about a captured buffer.
Definition: mvIMPACT_acquire.h:8404
PropertyI imageHeight
An integer property (read-only) containing the height of the image in pixels.
Definition: mvIMPACT_acquire.h:10016
PropertyI imageWidth
An integer property (read-only) containing the width of the image in pixels.
Definition: mvIMPACT_acquire.h:10005
@ bTrue
On, true or logical high.
Definition: mvDriverBaseEnums.h:553
@ rtmFullResolution
Request transmission of an image in full resolution.
Definition: mvCustomCommandDataTypes.h:82

To allow the application to distinguish easily between images belonging to the reduced data stream and the ones that have been explicitly requested by the application the mvIMPACT::acquire::Request.chunkmvCustomIdentifier can be used. When requesting a full resolution ROI the application can tag the requested images with a custom identifier. This identifier is later returned in the chunk data of the image. The following example demonstrates how to use this feature:

// switch on the smart frame recall feature
ac.mvSmartFrameRecallEnable.write( bTrue );
// the chunk mode must be switched on to use chunk data for processing:
mvIMPACT::acquire::GenICam::ChunkDataControl cdc( getDevicePointerFromSomewhere() );
cdc.chunkModeActive.write( bTrue );
cdc.chunkSelector.writeS("Image");
cdc.chunkEnable.write( bTrue );
// enable the 'mvCustomIdentifier' chunk
cdc.chunkSelector.writeS("mvCustomIdentifier");
cdc.chunkEnable.write( bTrue );
// more code ...
Request* pRequest = getRequestFromSomewhere();
uint customID = 42;
if( pRequest->chunkmvCustomIdentifier.read() == 0 )
{
// As the 'mvCustomIdentifier' is 0 this is a frame from the normal stream
Rect r;
if( doesImageContainInteresstingData( r ) )
{
// request the transmission of the interesting ROI this image in full resolution
ccg.requestTransmission( pRequest, r.x, r.y, r.w, r.h, rtmFullResolution, customID );
}
}
else if( pRequest->chunkmvCustomIdentifier.read() == static_cast<int64_type>( customID ) )
{
// As the 'mvCustomIdentifier' is 'customID' this is a frame explicitly requested by the application
processImage( pRequest );
}
else
{
// some other ID (this however must have been set by the application as well)
}
// normal 'unlocking' code for requests should reside here!!
// more code...
ZYX read(int index=0) const
Reads a value from a property.
Definition: mvIMPACT_acquire.h:4772
Category that contains the Chunk Data control features.
Definition: mvIMPACT_acquire_GenICam.h:11936
PropertyI64 chunkmvCustomIdentifier
A 64 bit integer property (read-only) containing the previously configured user defined identifier at...
Definition: mvIMPACT_acquire.h:9803
Since
2.18.0
Examples
GenICamSequencerParameterChangeAtRuntime.cpp, GenICamSmartFrameRecallUsage.cpp, and GenICamSmartFrameRecallUsage.legacy.cpp.

Constructor & Destructor Documentation

◆ CustomCommandGenerator()

CustomCommandGenerator ( mvIMPACT::acquire::Device pDev,
const std::string &  settingName = "Base" 
)
inlineexplicit

Constructs a new mvIMPACT::acquire::GenICam::CustomCommandGenerator object.

Parameters
[in]pDevA pointer to a mvIMPACT::acquire::Device object obtained from a mvIMPACT::acquire::DeviceManager object.
[in]settingNameThe 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

Member Function Documentation

◆ commandBufferSize()

unsigned int commandBufferSize ( void  ) const
inline

Returns the size of the command buffer for this device in bytes.

Since
2.18.0
Returns
The size of the command buffer for this device in bytes.

◆ commandBufferSizeUsed()

unsigned int commandBufferSizeUsed ( void  ) const
inline

Returns the amount of bytes of the command buffer currently used(thus the amount of bytes that await sending) for this device in bytes.

Since
2.18.0
Returns
The amount of bytes of the command buffer currently used(thus the amount of bytes that await sending) for this device in bytes.

◆ discardCommandBuffer()

void discardCommandBuffer ( )
inline

Discards all pending custom commands to the device.

This function will discard all pending custom commands. After calling this function the pending command queue will be empty an can be filled with new commands.

Since
2.18.0

◆ modifySequencerSetValue() [1/2]

int modifySequencerSetValue ( const int64_type  sequencerSet,
const TSequencerSetParameter  parameter,
const double  value 
)
inline

Modifies a value of a certain sequencer set at runtime.

This is a convenience function combining a call to mvIMPACT::acquire::GenICam::CustomCommandGenerator::queueSequencerSetValueModification directly followed by a call to mvIMPACT::acquire::GenICam::CustomCommandGenerator::sendCommandBuffer. Commands which have been queued before and have not yet been sent will be sent as well when calling this function.

Since
2.18.0
Returns
Parameters
sequencerSetThe index of the sequencer set to modify.
parameterThe parameter within the selected sequencer set to modify.
valueThe new value the selected parameter within the selected sequencer set shall be set to.

◆ modifySequencerSetValue() [2/2]

int modifySequencerSetValue ( const int64_type  sequencerSet,
const TSequencerSetParameter  parameter,
const int64_type  value 
)
inline

Modifies a value of a certain sequencer set at runtime.

This is a convenience function combining a call to mvIMPACT::acquire::GenICam::CustomCommandGenerator::queueSequencerSetValueModification directly followed by a call to mvIMPACT::acquire::GenICam::CustomCommandGenerator::sendCommandBuffer. Commands which have been queued before and have not yet been sent will be sent as well when calling this function.

Since
2.18.0
Returns
Parameters
sequencerSetThe index of the sequencer set to modify.
parameterThe parameter within the selected sequencer set to modify.
valueThe new value the selected parameter within the selected sequencer set shall be set to.

◆ queueSequencerSetValueModification() [1/2]

int queueSequencerSetValueModification ( const int64_type  sequencerSet,
const TSequencerSetParameter  parameter,
const double  value 
)
inline

Queues the modification of a value of a certain sequencer set at runtime.

This function queues a single parameter modification of a selected sequencer set. The actual modification will not become effective until mvIMPACT::acquire::GenICam::CustomCommandGenerator::sendCommandBuffer is called. With this function multiple modifications can be sent to a device at once. When the new command does not fit inside the internal command queue any more all pending commands will be sent to the device before the new one is put into the queue.

See also
mvIMPACT::acquire::GenICam::CustomCommandGenerator::sendCommandBuffer
Since
2.18.0
Returns
Parameters
sequencerSetThe index of the sequencer set to modify.
parameterThe parameter within the selected sequencer set to modify.
valueThe new value the selected parameter within the selected sequencer set shall be set to.

◆ queueSequencerSetValueModification() [2/2]

int queueSequencerSetValueModification ( const int64_type  sequencerSet,
const TSequencerSetParameter  parameter,
const int64_type  value 
)
inline

Queues the modification of a value of a certain sequencer set at runtime.

This function queues a single parameter modification of a selected sequencer set. The actual modification will not become effective until mvIMPACT::acquire::GenICam::CustomCommandGenerator::sendCommandBuffer is called. With this function multiple modifications can be sent to a device at once. When the new command does not fit inside the internal command queue any more all pending commands will be sent to the device before the new one is put into the queue.

See also
mvIMPACT::acquire::GenICam::CustomCommandGenerator::sendCommandBuffer
Since
2.18.0
Returns
Parameters
sequencerSetThe index of the sequencer set to modify.
parameterThe parameter within the selected sequencer set to modify.
valueThe new value the selected parameter within the selected sequencer set shall be set to.

◆ queueTransmissionRequest() [1/3]

int queueTransmissionRequest ( const Request pRequest,
int  offsetX,
int  offsetY,
int  width,
int  height,
TRequestTransmissionMode  mode = rtmFullResolution,
unsigned int  identifier = 0 
)
inline

Request the transmission of an image currently associated with the Request object in a different mode/ROI.

If mvIMPACT::acquire::GenICam::AcquisitionControl::mvSmartFrameRecallEnable is set to mvIMPACT::acquire::bTrue this function can be used to request the transmission of the image currently associated with pRequest in a different mode/resolution. One use case would be to transmit every image taken by the sensor with a very coarse resolution e.g. by setting the properties mvIMPACT::acquire::GenICam::ImageFormatControl::decimationHorizontal and/or mvIMPACT::acquire::GenICam::ImageFormatControl::decimationVertical to values greater than 1. When then an algorithm finds something interesting within an image this function can be used to request the transmission of the very same image in full resolution for detailed processing.

Since
2.18.1
Returns
Parameters
[in]pRequestA pointer to a mvIMPACT::acquire::Request object currently associated with the image that shall be transmitted again.
[in]offsetXThe X-offset of the ROI of the image that shall be transmitted within the current image.
[in]offsetYThe Y-offset of the ROI of the image that shall be transmitted within the current image.
[in]widthThe width of the ROI of the image that shall be transmitted within the current image.
[in]heightThe height of the ROI of the image that shall be transmitted within the current image.
[in]modeThe mode in which this image shall be transmitted.
[in]identifierA user defined identifier that shall be attached to the image that will be sent as a result of calling this function. This value will be written into the mvIMPACT::acquire::Request::chunkmvCustomIdentifier property so in order to actually benefit from this parameter the corresponding chunk must be enabled. See mvIMPACT::acquire::GenICam::ChunkDataControl for details.

◆ queueTransmissionRequest() [2/3]

int queueTransmissionRequest ( const Request pRequest,
unsigned int  identifier = 0 
)
inline

Request the transmission of an image currently associated with the Request object in full resolution.

If mvIMPACT::acquire::GenICam::AcquisitionControl::mvSmartFrameRecallEnable is set to mvIMPACT::acquire::bTrue this function can be used to queue the transmission request of the image currently associated with pRequest in full resolution. One use case would be to transmit every image taken by the sensor with a very coarse resolution e.g. by setting the properties mvIMPACT::acquire::GenICam::ImageFormatControl::decimationHorizontal and/or mvIMPACT::acquire::GenICam::ImageFormatControl::decimationVertical to values greater than 1. When then an algorithm finds something interesting within an image this function can be used to request the transmission of the very same image in full resolution for detailed processing.

The actual transmission request will not be sent to the device until mvIMPACT::acquire::GenICam::CustomCommandGenerator::sendCommandBuffer is called. With this function multiple commands can be sent to a device at once. When the new command does not fit inside the internal command queue any more all pending commands will be sent to the device before the new one is put into the queue.

See also
mvIMPACT::acquire::GenICam::CustomCommandGenerator::sendCommandBuffer
Since
2.18.1
Returns
Parameters
[in]pRequestA pointer to a mvIMPACT::acquire::Request object currently associated with the image that shall be transmitted again.
[in]identifierA user defined identifier that shall be attached to the image that will be sent as a result of calling this function. This value will be written into the mvIMPACT::acquire::Request::chunkmvCustomIdentifier property so in order to actually benefit from this parameter the corresponding chunk must be enabled. See mvIMPACT::acquire::GenICam::ChunkDataControl for details.

◆ queueTransmissionRequest() [3/3]

int queueTransmissionRequest ( int64_type  timestamp_us,
int  offsetX,
int  offsetY,
int  width,
int  height,
TRequestTransmissionMode  mode = rtmFullResolution,
unsigned int  identifier = 0 
)
inline

Request the transmission of an image with a certain timestamp in a different mode/ROI.

If mvIMPACT::acquire::GenICam::AcquisitionControl::mvSmartFrameRecallEnable is set to mvIMPACT::acquire::bTrue this function can be used to request the transmission of the image currently associated with pRequest in a different mode/resolution. One use case would be to transmit every image taken by the sensor with a very coarse resolution e.g. by setting the properties mvIMPACT::acquire::GenICam::ImageFormatControl::decimationHorizontal and/or mvIMPACT::acquire::GenICam::ImageFormatControl::decimationVertical to values greater than 1. When then an algorithm finds something interesting within an image this function can be used to request the transmission of the very same image in full resolution for detailed processing.

Since
2.18.1
Returns
Parameters
[in]timestamp_usThe timestamp of the mvIMPACT::acquire::Request object shall be transmitted again.
[in]offsetXThe X-offset of the ROI of the image that shall be transmitted within the current image.
[in]offsetYThe Y-offset of the ROI of the image that shall be transmitted within the current image.
[in]widthThe width of the ROI of the image that shall be transmitted within the current image.
[in]heightThe height of the ROI of the image that shall be transmitted within the current image.
[in]modeThe mode in which this image shall be transmitted.
[in]identifierA user defined identifier that shall be attached to the image that will be sent as a result of calling this function. This value will be written into the mvIMPACT::acquire::Request::chunkmvCustomIdentifier property so in order to actually benefit from this parameter the corresponding chunk must be enabled. See mvIMPACT::acquire::GenICam::ChunkDataControl for details.

◆ requestTransmission() [1/3]

int requestTransmission ( const Request pRequest,
int  offsetX,
int  offsetY,
int  width,
int  height,
TRequestTransmissionMode  mode = rtmFullResolution,
unsigned int  identifier = 0 
)
inline

Request the transmission of an image currently associated with the Request object in a different mode/ROI.

This is a convenience function combining a call to mvIMPACT::acquire::GenICam::CustomCommandGenerator::queueTransmissionRequest directly followed by a call to mvIMPACT::acquire::GenICam::CustomCommandGenerator::sendCommandBuffer. Commands which have been queued before and have not yet been sent will be sent as well when calling this function.

If mvIMPACT::acquire::GenICam::AcquisitionControl::mvSmartFrameRecallEnable is set to mvIMPACT::acquire::bTrue this function can be used to request the transmission of the image currently associated with pRequest in a different mode/resolution. One use case would be to transmit every image taken by the sensor with a very coarse resolution e.g. by setting the properties mvIMPACT::acquire::GenICam::ImageFormatControl::decimationHorizontal and/or mvIMPACT::acquire::GenICam::ImageFormatControl::decimationVertical to values greater than 1. When then an algorithm finds something interesting within an image this function can be used to request the transmission of the very same image in full resolution for detailed processing.

Since
2.18.0
Returns
Parameters
[in]pRequestA pointer to a mvIMPACT::acquire::Request object currently associated with the image that shall be transmitted again.
[in]offsetXThe X-offset of the ROI of the image that shall be transmitted within the current image.
[in]offsetYThe Y-offset of the ROI of the image that shall be transmitted within the current image.
[in]widthThe width of the ROI of the image that shall be transmitted within the current image.
[in]heightThe height of the ROI of the image that shall be transmitted within the current image.
[in]modeThe mode in which this image shall be transmitted.
[in]identifierA user defined identifier that shall be attached to the image that will be sent as a result of calling this function. This value will be written into the mvIMPACT::acquire::Request::chunkmvCustomIdentifier property so in order to actually benefit from this parameter the corresponding chunk must be enabled. See mvIMPACT::acquire::GenICam::ChunkDataControl for details.

◆ requestTransmission() [2/3]

int requestTransmission ( const Request pRequest,
unsigned int  identifier = 0 
)
inline

Request the transmission of an image currently associated with the Request object in full resolution.

This is a convenience function combining a call to mvIMPACT::acquire::GenICam::CustomCommandGenerator::queueTransmissionRequest directly followed by a call to mvIMPACT::acquire::GenICam::CustomCommandGenerator::sendCommandBuffer. Commands which have been queued before and have not yet been sent will be sent as well when calling this function.

If mvIMPACT::acquire::GenICam::AcquisitionControl::mvSmartFrameRecallEnable is set to mvIMPACT::acquire::bTrue this function can be used to request the transmission of the image currently associated with pRequest in full resolution. One use case would be to transmit every image taken by the sensor with a very coarse resolution e.g. by setting the properties mvIMPACT::acquire::GenICam::ImageFormatControl::decimationHorizontal and/or mvIMPACT::acquire::GenICam::ImageFormatControl::decimationVertical to values greater than 1. When then an algorithm finds something interesting within an image this function can be used to request the transmission of the very same image in full resolution for detailed processing.

Since
2.18.0
Returns
Parameters
[in]pRequestA pointer to a mvIMPACT::acquire::Request object currently associated with the image that shall be transmitted again.
[in]identifierA user defined identifier that shall be attached to the image that will be sent as a result of calling this function. This value will be written into the mvIMPACT::acquire::Request::chunkmvCustomIdentifier property so in order to actually benefit from this parameter the corresponding chunk must be enabled. See mvIMPACT::acquire::GenICam::ChunkDataControl for details.

◆ requestTransmission() [3/3]

int requestTransmission ( int64_type  timestamp_us,
int  offsetX,
int  offsetY,
int  width,
int  height,
TRequestTransmissionMode  mode = rtmFullResolution,
unsigned int  identifier = 0 
)
inline

Request the transmission of an image with a certain timestamp in a different mode/ROI.

This is a convenience function combining a call to mvIMPACT::acquire::GenICam::CustomCommandGenerator::queueTransmissionRequest directly followed by a call to mvIMPACT::acquire::GenICam::CustomCommandGenerator::sendCommandBuffer. Commands which have been queued before and have not yet been sent will be sent as well when calling this function.

If mvIMPACT::acquire::GenICam::AcquisitionControl::mvSmartFrameRecallEnable is set to mvIMPACT::acquire::bTrue this function can be used to request the transmission of the image currently associated with pRequest in a different mode/resolution. One use case would be to transmit every image taken by the sensor with a very coarse resolution e.g. by setting the properties mvIMPACT::acquire::GenICam::ImageFormatControl::decimationHorizontal and/or mvIMPACT::acquire::GenICam::ImageFormatControl::decimationVertical to values greater than 1. When then an algorithm finds something interesting within an image this function can be used to request the transmission of the very same image in full resolution for detailed processing.

Since
2.18.1
Returns
Parameters
[in]timestamp_usThe timestamp of the mvIMPACT::acquire::Request object shall be transmitted again.
[in]offsetXThe X-offset of the ROI of the image that shall be transmitted within the current image.
[in]offsetYThe Y-offset of the ROI of the image that shall be transmitted within the current image.
[in]widthThe width of the ROI of the image that shall be transmitted within the current image.
[in]heightThe height of the ROI of the image that shall be transmitted within the current image.
[in]modeThe mode in which this image shall be transmitted.
[in]identifierA user defined identifier that shall be attached to the image that will be sent as a result of calling this function. This value will be written into the mvIMPACT::acquire::Request::chunkmvCustomIdentifier property so in order to actually benefit from this parameter the corresponding chunk must be enabled. See mvIMPACT::acquire::GenICam::ChunkDataControl for details.

◆ sendCommandBuffer()

int sendCommandBuffer ( void  )
inline

Applies all pending custom commands to the device.

This function will send all pending custom commands to a device. After calling this function the pending command queue will be empty an can be filled with new commands. Calling this function multiple times without queuing new commands after each send will have no effect!

Since
2.18.0
Returns