Impact Acquire SDK Python
Public Member Functions | Properties
ImageDestination Class Reference
Common

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

Inheritance diagram for ImageDestination:
[legend]

Public Member Functions

 __init__ (self, *args)
 

Properties

 imageHeight = property(lib_mvIMPACT_acquire.ImageDestination_imageHeight_get, doc=)
 An integer property defining the height of the scaled image.
 
 imageWidth = property(lib_mvIMPACT_acquire.ImageDestination_imageWidth_get, doc=)
 An integer property defining the width of the scaled image.
 
 pixelFormat = property(lib_mvIMPACT_acquire.ImageDestination_pixelFormat_get, doc=)
 An enumerated integer property defining the pixel format of the resulting image.
 
 scalerAoiEnable = property(lib_mvIMPACT_acquire.ImageDestination_scalerAoiEnable_get, doc=)
 A boolean property defining whether an AOI, rather than the whole image, will be used for scaling.
 
 scalerAoiHeight = property(lib_mvIMPACT_acquire.ImageDestination_scalerAoiHeight_get, doc=)
 An integer property defining the height of the AOI in pixel to be used for scaling.
 
 scalerAoiStartX = property(lib_mvIMPACT_acquire.ImageDestination_scalerAoiStartX_get, doc=)
 An integer property defining the X-offset of the AOI in pixel to be used for the calculation.
 
 scalerAoiStartY = property(lib_mvIMPACT_acquire.ImageDestination_scalerAoiStartY_get, doc=)
 An integer property defining the Y-offset of the AOI in pixel to be used for the calculation.
 
 scalerAoiWidth = property(lib_mvIMPACT_acquire.ImageDestination_scalerAoiWidth_get, doc=)
 An integer property defining the width of the AOI in pixel to be used for the calculation.
 
 scalerInterpolationMode = property(lib_mvIMPACT_acquire.ImageDestination_scalerInterpolationMode_get, doc=)
 An integer property defining the interpolation method used when the scaler is active.
 
 scalerMode = property(lib_mvIMPACT_acquire.ImageDestination_scalerMode_get, doc=)
 An integer property defining whether the image is scaled or not.
 
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 

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

◆ __init__()

__init__ ( self,
* args )

Reimplemented from ComponentCollection.

Property Documentation

◆ imageHeight

imageHeight = property(lib_mvIMPACT_acquire.ImageDestination_imageHeight_get, doc=)
static

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

imageWidth = property(lib_mvIMPACT_acquire.ImageDestination_imageWidth_get, doc=)
static

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.

◆ pixelFormat

pixelFormat = property(lib_mvIMPACT_acquire.ImageDestination_pixelFormat_get, doc=)
static

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

Valid values for this property may be: mvIMPACT.acquire.idpfAuto, mvIMPACT.acquire.idpfRaw, mvIMPACT.acquire.idpfMono8, mvIMPACT.acquire.idpfRGBx888Packed, mvIMPACT.acquire.idpfYUV422Packed, mvIMPACT.acquire.idpfRGBx888Planar, mvIMPACT.acquire.idpfMono10, mvIMPACT.acquire.idpfMono12, mvIMPACT.acquire.idpfMono14, mvIMPACT.acquire.idpfMono16, mvIMPACT.acquire.idpfRGB888Packed, mvIMPACT.acquire.idpfYUV422Planar, mvIMPACT.acquire.idpfRGB101010Packed, mvIMPACT.acquire.idpfRGB121212Packed, mvIMPACT.acquire.idpfRGB141414Packed, mvIMPACT.acquire.idpfRGB161616Packed, mvIMPACT.acquire.idpfYUV422_UYVYPacked, mvIMPACT.acquire.idpfMono12Packed_V2, mvIMPACT.acquire.idpfYUV422_10Packed, mvIMPACT.acquire.idpfYUV422_UYVY_10Packed, mvIMPACT.acquire.idpfBGR888Packed, mvIMPACT.acquire.idpfBGR101010Packed_V2, mvIMPACT.acquire.idpfYUV444_UYVPacked, mvIMPACT.acquire.idpfYUV444_UYV_10Packed, mvIMPACT.acquire.idpfYUV444Packed, mvIMPACT.acquire.idpfYUV444_10Packed, mvIMPACT.acquire.idpfMono12Packed_V1, mvIMPACT.acquire.idpfYUV411_UYYVYY_Packed, mvIMPACT.acquire.idpfRGB888Planar.

◆ scalerAoiEnable

scalerAoiEnable = property(lib_mvIMPACT_acquire.ImageDestination_scalerAoiEnable_get, doc=)
static

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

scalerAoiHeight = property(lib_mvIMPACT_acquire.ImageDestination_scalerAoiHeight_get, doc=)
static

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

scalerAoiStartX = property(lib_mvIMPACT_acquire.ImageDestination_scalerAoiStartX_get, doc=)
static

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

scalerAoiStartY = property(lib_mvIMPACT_acquire.ImageDestination_scalerAoiStartY_get, doc=)
static

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

scalerAoiWidth = property(lib_mvIMPACT_acquire.ImageDestination_scalerAoiWidth_get, doc=)
static

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

scalerInterpolationMode = property(lib_mvIMPACT_acquire.ImageDestination_scalerInterpolationMode_get, doc=)
static

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

scalerMode = property(lib_mvIMPACT_acquire.ImageDestination_scalerMode_get, doc=)
static

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.

◆ thisown

thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
static