ImageDestination Class Reference

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

Inheritance diagram for ImageDestination:

Public Member Functions
synchronized void	delete ()
PropertyI	getImageHeight ()
	An integer property defining the height of the scaled image.
PropertyI	getImageWidth ()
	An integer property defining the width of the scaled image.
PropertyI	getPixelFormat ()
	An enumerated integer property defining the pixel format of the resulting image.
PropertyI	getScalerAoiEnable ()
	A boolean property defining whether an AOI, rather than the whole image, will be used for scaling.
PropertyI	getScalerAoiHeight ()
	An integer property defining the height of the AOI in pixel to be used for scaling.
PropertyI	getScalerAoiStartX ()
	An integer property defining the X-offset of the AOI in pixel to be used for the calculation.
PropertyI	getScalerAoiStartY ()
	An integer property defining the Y-offset of the AOI in pixel to be used for the calculation.
PropertyI	getScalerAoiWidth ()
	An integer property defining the width of the AOI in pixel to be used for the calculation.
PropertyI	getScalerInterpolationMode ()
	An integer property defining the interpolation method used when the scaler is active.
PropertyI	getScalerMode ()
	An integer property defining whether the image is scaled or not.
int	hObj ()
	Returns a unique identifier for the component collection referenced by this object.
	ImageDestination (Device pDev)
	brief Constructs a new mvIMPACT.acquire.ImageDestination object.
	ImageDestination (Device pDev, String settingName)
	brief Constructs a new mvIMPACT.acquire.ImageDestination object.
ComponentCollection	restoreDefault ()
	Restores the default for every component of this collection.

Protected Member Functions
void	finalize ()
	ImageDestination (long cPtr, boolean cMemoryOwn)

Static Protected Member Functions
static long	swigRelease (ComponentCollection obj)
static long	swigRelease (ImageDestination obj)

Protected Attributes
transient boolean	swigCMemOwn

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() [1/3]

ImageDestination ( long cPtr, boolean cMemoryOwn )

protected

ImageDestination() [2/3]

ImageDestination	(	Device	pDev,
		String	settingName )

brief Constructs a new mvIMPACT.acquire.ImageDestination object.

Parameters

pDev	[in] A pointer to a mvIMPACT.acquire.Device object obtained from a mvIMPACT.acquire.DeviceManager object.
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

ImageDestination() [3/3]

ImageDestination

(

Device

pDev

)

brief Constructs a new mvIMPACT.acquire.ImageDestination object.

Parameters

pDev

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

delete()

synchronized void delete

(

)

Reimplemented from ComponentCollection.

finalize()

void finalize ( )

protected

Reimplemented from ComponentCollection.

getImageHeight()

PropertyI getImageHeight

(

)

An integer property defining the height of the scaled image.

Note

Whenever the property mvIMPACT.acquire.ImageDestination.getScalerMode() is set to mvIMPACT.acquire.TScalerMode.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.getScalerMode().

getImageWidth()

PropertyI getImageWidth

(

)

An integer property defining the width of the scaled image.

Note

Whenever the property mvIMPACT.acquire.ImageDestination.getScalerMode() is set to mvIMPACT.acquire.TScalerMode.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.getScalerMode().

getPixelFormat()

PropertyI getPixelFormat

(

)

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.

getScalerAoiEnable()

PropertyI getScalerAoiEnable

(

)

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

Note

Whenever the property mvIMPACT.acquire.ImageDestination.getScalerAoiEnable() is set to mvIMPACT.acquire.TBoolean.bTrue the relevant AOI configuration properties will become visible.

getScalerAoiHeight()

PropertyI getScalerAoiHeight

(

)

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.getScalerAoiEnable() is set to mvIMPACT.acquire.TBoolean.bTrue.

getScalerAoiStartX()

PropertyI getScalerAoiStartX

(

)

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.getScalerAoiEnable() is set to mvIMPACT.acquire.TBoolean.bTrue.

getScalerAoiStartY()

PropertyI getScalerAoiStartY

(

)

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.getScalerAoiEnable() is set to mvIMPACT.acquire.TBoolean.bTrue.

getScalerAoiWidth()

PropertyI getScalerAoiWidth

(

)

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.getScalerAoiEnable() is set to mvIMPACT.acquire.TBoolean.bTrue.

getScalerInterpolationMode()

PropertyI getScalerInterpolationMode

(

)

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

Note

Whenever the property mvIMPACT.acquire.ImageDestination.getScalerMode() is set to mvIMPACT.acquire.TScalerMode.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.getScalerMode(). The interpolation mode currently will only be used when scaling is NOT done by the hardware.

getScalerMode()

PropertyI getScalerMode

(

)

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.getImageProcTime_s() can be used to observe the additional CPU time needed for the image processing.

hObj()

int hObj ( )

inherited

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()

ComponentCollection restoreDefault ( )

inherited

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.

swigRelease() [1/2]

static long swigRelease ( ComponentCollection obj )

staticprotectedinherited

swigRelease() [2/2]

static long swigRelease ( ImageDestination obj )

staticprotected

Member Data Documentation

swigCMemOwn

transient boolean swigCMemOwn

protectedinherited