mvIMPACT Acquire SDK C++
ImageDestination Class Reference

Properties to define the format of resulting images. More...

Inheritance diagram for ImageDestination:
ComponentCollection

Public Member Functions

HOBJ hObj (void) const
 Returns a unique identifier for the component collection referenced by this object. More...
 
 ImageDestination (Device *pDev, const std::string &settingName="Base")
 brief Constructs a new mvIMPACT::acquire::ImageDestination object. More...
 
const ComponentCollectionrestoreDefault (void) const
 Restores the default for every component of this collection. More...
 

Public Attributes

PropertyI imageHeight
 An integer property defining the height of the scaled image. More...
 
PropertyI imageWidth
 An integer property defining the width of the scaled image. More...
 
PropertyIImageDestinationPixelFormat pixelFormat
 An enumerated integer property defining the pixel format of the resulting image. More...
 
PropertyIBoolean scalerAoiEnable
 A boolean property defining whether an AOI, rather than the whole image, will be used for scaling. More...
 
PropertyI scalerAoiHeight
 An integer property defining the height of the AOI in pixel to be used for scaling. More...
 
PropertyI scalerAoiStartX
 An integer property defining the X-offset of the AOI in pixel to be used for the calculation. More...
 
PropertyI scalerAoiStartY
 An integer property defining the Y-offset of the AOI in pixel to be used for the calculation. More...
 
PropertyI scalerAoiWidth
 An integer property defining the width of the AOI in pixel to be used for the calculation. More...
 
PropertyIScalerInterpolationMode scalerInterpolationMode
 An integer property defining the interpolation method used when the scaler is active. More...
 
PropertyIScalerMode scalerMode
 An integer property defining whether the image is scaled or not. More...
 

Protected Attributes

HOBJ m_hRoot
 

Detailed Description

Properties to define the format of resulting images.

This class provides properties allowing the user to define how the resulting image should be created. Things like the width and height of the captured image can be defined here for example.

Constructor & Destructor Documentation

◆ ImageDestination()

ImageDestination ( Device pDev,
const std::string &  settingName = "Base" 
)
inlineexplicit

brief Constructs a new mvIMPACT::acquire::ImageDestination 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

◆ hObj()

HOBJ hObj ( void  ) const
inlineinherited

Returns a unique identifier for the component collection referenced by this object.

This handle will always reference an object of type mvIMPACT::acquire::ComponentList.

Returns
A unique identifier for the component referenced by this object.

◆ restoreDefault()

const ComponentCollection& restoreDefault ( void  ) const
inlineinherited

Restores the default for every component of this collection.

Calling this function will restore the default value for every component belonging to this collection.

Note
The caller must have the right to modify the component. Otherwise an exception will be thrown.
Returns
A const reference to the component.

Member Data Documentation

◆ imageHeight

PropertyI imageHeight

An integer property defining the height of the scaled image.

Note
Whenever the property mvIMPACT::acquire::ImageDestination::scalerMode is set to mvIMPACT::acquire::smOff modifying or reading this property will have no effect. Call Component::isVisible to find out whether this property is currently active or not.
Please see remarks under mvIMPACT::acquire::ImageDestination::scalerMode.

◆ imageWidth

PropertyI imageWidth

An integer property defining the width of the scaled image.

Note
Whenever the property mvIMPACT::acquire::ImageDestination::scalerMode is set to mvIMPACT::acquire::smOff modifying or reading this property will have no effect. Call Component::isVisible to find out whether this property is currently active or not.
Please see remarks under mvIMPACT::acquire::ImageDestination::scalerMode.

◆ m_hRoot

HOBJ m_hRoot
protectedinherited

◆ pixelFormat

An enumerated integer property defining the pixel format of the resulting image.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TImageDestinationPixelFormat.

◆ scalerAoiEnable

PropertyIBoolean scalerAoiEnable

A boolean property defining whether an AOI, rather than the whole image, will be used for scaling.

Note
Whenever the property mvIMPACT::acquire::ImageDestination::scalerAoiEnable is set to mvIMPACT::acquire::bTrue the relevant AOI configuration properties will become visible.

◆ scalerAoiHeight

PropertyI scalerAoiHeight

An integer property defining the height of the AOI in pixel to be used for scaling.

Note
This property will be visible only when mvIMPACT::acquire::ImageDestination::scalerAoiEnable is set to mvIMPACT::acquire::bTrue.

◆ scalerAoiStartX

PropertyI scalerAoiStartX

An integer property defining the X-offset of the AOI in pixel to be used for the calculation.

Note
This property will be visible only when mvIMPACT::acquire::ImageDestination::scalerAoiEnable is set to mvIMPACT::acquire::bTrue.

◆ scalerAoiStartY

PropertyI scalerAoiStartY

An integer property defining the Y-offset of the AOI in pixel to be used for the calculation.

Note
This property will be visible only when mvIMPACT::acquire::ImageDestination::scalerAoiEnable is set to mvIMPACT::acquire::bTrue.

◆ scalerAoiWidth

PropertyI scalerAoiWidth

An integer property defining the width of the AOI in pixel to be used for the calculation.

Note
This property will be visible only when mvIMPACT::acquire::ImageDestination::scalerAoiEnable is set to mvIMPACT::acquire::bTrue.

◆ scalerInterpolationMode

PropertyIScalerInterpolationMode scalerInterpolationMode

An integer property defining the interpolation method used when the scaler is active.

Note
Whenever the property mvIMPACT::acquire::ImageDestination::scalerMode is set to mvIMPACT::acquire::smOff modifying or reading this property will have no effect. Call Component::isVisible to find out whether this property is currently active or not.
Please see remarks under mvIMPACT::acquire::ImageDestination::scalerMode. The interpolation mode currently will only be used when scaling is NOT done by the hardware.

◆ scalerMode

PropertyIScalerMode scalerMode

An integer property defining whether the image is scaled or not.

Note
This feature is available for every device! However currently only mvDELTA / mvSIGMA devices provide hardware support for REDUCING the image size. In this case the scaled width and height must be divisible by 4. For every other device this will be done by a software filter and therefore will introduce additional CPU load. Increasing the image size will always be done in software. When using the scaler the property mvIMPACT::acquire::Statistics::imageProcTime_s can be used to observe the additional CPU time needed for the image processing.

The documentation for this class was generated from the following file: