ImageDestination Class Reference

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

Inheritance diagram for ImageDestination:

Public Member Functions
IEnumerable< T >	getEnumerable< T > ()
	Returns an enumerator of a certain type that iterates through the collection.
IEnumerator< int >	GetEnumerator ()
	Returns an enumerator that iterates through the collection.
	ImageDestination (Device device)
	Constructs a new mv.impact.acquire.ImageDestination object.
	ImageDestination (Device device, String settingName)
	Constructs a new mv.impact.acquire.ImageDestination object.
void	restoreDefault ()
	Restores the default for every component of this collection.

Public Attributes
readonly PropertyI	imageHeight = new PropertyI()
	An integer property defining the height of the scaled image.
readonly PropertyI	imageWidth = new PropertyI()
	An integer property defining the width of the scaled image.
readonly EnumPropertyI< TImageDestinationPixelFormat >	pixelFormat = new EnumPropertyI<TImageDestinationPixelFormat>()
	An enumerated integer property defining the pixel format of the resulting image.
readonly EnumPropertyI< TBoolean >	scalerAoiEnable = new EnumPropertyI<TBoolean>()
	A boolean property defining whether an AOI, rather than the whole image, will be used for scaling.
readonly PropertyI	scalerAoiHeight = new PropertyI()
	An integer property defining the height of the AOI in pixel to be used for scaling.
readonly PropertyI	scalerAoiStartX = new PropertyI()
	An integer property defining the X-offset of the AOI in pixel to be used for scaling.
readonly PropertyI	scalerAoiStartY = new PropertyI()
	An integer property defining the Y-offset of the AOI in pixel to be used for scaling.
readonly PropertyI	scalerAoiWidth = new PropertyI()
	An integer property defining the width of the AOI in pixel to be used for scaling.
readonly EnumPropertyI< TScalerInterpolationMode >	scalerInterpolationMode = new EnumPropertyI<TScalerInterpolationMode>()
	An integer property defining the interpolation method used when the scaler is active.
readonly EnumPropertyI< TScalerMode >	scalerMode = new EnumPropertyI<TScalerMode>()
	An integer property defining whether the image is scaled or not.

Properties
IEnumerable< Component >	componentEnumerable [get]
	Returns an enumerator that iterates through the collection.
IEnumerable< ComponentList >	componentListEnumerable [get]
	Returns an enumerator that iterates through all the mv.impact.acquire.ComponentList elements in the collection.
int	hObj [get]
	Returns a unique identifier for the component collection referenced by this object.

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/2]

ImageDestination ( Device device )

inline

Constructs a new mv.impact.acquire.ImageDestination object.

Parameters

[in]

device

A pointer to a mv.impact.acquire.Device object obtained from a mv.impact.acquire.DeviceManager object.

ImageDestination() [2/2]

ImageDestination ( Device device, String settingName )

inline

Constructs a new mv.impact.acquire.ImageDestination object.

Parameters

[in]	device	A pointer to a mv.impact.acquire.Device object obtained from a mv.impact.acquire.DeviceManager object.
[in]	settingName	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 mv.impact.acquire.FunctionInterface.availableSettings, new settings can be created with the function mv.impact.acquire.FunctionInterface.createSetting

Member Function Documentation

getEnumerable< T >()

IEnumerable< T > getEnumerable< T > ( )

inlineinherited

Returns an enumerator of a certain type that iterates through the collection.

This interface will allow to e.g. write code like this:

Info info = new Info(pDev);
foreach (Property c in info.getEnumerable<Property>())
{
  validateProperty(c);
}

See the framework's documentation about the System.Collections.IEnumerable interface for more information.

Returns

An enumerator that iterates through the collection

GetEnumerator()

IEnumerator< int > GetEnumerator ( )

inlineinherited

Returns an enumerator that iterates through the collection.

See the framework's documentation about the System.Collections.IEnumerable interface for more information.

Returns

An enumerator that iterates through the collection

restoreDefault()

void restoreDefault ( )

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.

Member Data Documentation

imageHeight

readonly PropertyI imageHeight = new PropertyI()

An integer property defining the height of the scaled image.

Note

Whenever the property mv.impact.acquire.ImageDestination.scalerMode is set to mv.impact.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 mv.impact.acquire.ImageDestination.scalerMode.

imageWidth

readonly PropertyI imageWidth = new PropertyI()

An integer property defining the width of the scaled image.

Note

Whenever the property mv.impact.acquire.ImageDestination.scalerMode is set to mv.impact.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 mv.impact.acquire.ImageDestination.scalerMode.

pixelFormat

readonly EnumPropertyI<TImageDestinationPixelFormat> pixelFormat = new EnumPropertyI<TImageDestinationPixelFormat>()

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

Valid values for this property are defined by the enumeration mv.impact.acquire.TImageDestinationPixelFormat.

scalerAoiEnable

readonly EnumPropertyI<TBoolean> scalerAoiEnable = new EnumPropertyI<TBoolean>()

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

Note

Whenever the property mv.impact.acquire.ImageDestination.scalerAoiEnable is set to mv.impact.acquire.TBoolean.bTrue the relevant AOI configuration properties will become visible.

scalerAoiHeight

readonly PropertyI scalerAoiHeight = new PropertyI()

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

Note

This property will be visible only when mv.impact.acquire.ImageDestination.scalerAoiEnable is set to mv.impact.acquire.TBoolean.bTrue.

scalerAoiStartX

readonly PropertyI scalerAoiStartX = new PropertyI()

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

Note

This property will be visible only when mv.impact.acquire.ImageDestination.scalerAoiEnable is set to mv.impact.acquire.TBoolean.bTrue.

scalerAoiStartY

readonly PropertyI scalerAoiStartY = new PropertyI()

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

Note

This property will be visible only when mv.impact.acquire.ImageDestination.scalerAoiEnable is set to mv.impact.acquire.TBoolean.bTrue.

scalerAoiWidth

readonly PropertyI scalerAoiWidth = new PropertyI()

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

Note

This property will be visible only when mv.impact.acquire.ImageDestination.scalerAoiEnable is set to mv.impact.acquire.TBoolean.bTrue.

scalerInterpolationMode

readonly EnumPropertyI<TScalerInterpolationMode> scalerInterpolationMode = new EnumPropertyI<TScalerInterpolationMode>()

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

Note

Whenever the property mv.impact.acquire.ImageDestination.scalerMode is set to mv.impact.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 mv.impact.acquire.ImageDestination.scalerMode. The interpolation mode currently will only be used when scaling is NOT done by the hardware.

scalerMode

readonly EnumPropertyI<TScalerMode> scalerMode = new EnumPropertyI<TScalerMode>()

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 mv.impact.acquire.Statistics.imageProcTime_s can be used to observe the additional CPU time needed for the image processing.

Property Documentation

componentEnumerable

IEnumerable<Component> componentEnumerable

getinherited

Returns an enumerator that iterates through the collection.

This interface will allow to e.g. write code like this:

Info info = new Info(pDev);
foreach (Component c in info.componentEnumerable)
{
  Console.WriteLine("{0}", c.name);
}

See the framework's documentation about the System.Collections.IEnumerable interface for more information.

Returns

An enumerator that iterates through the collection

componentListEnumerable

IEnumerable<ComponentList> componentListEnumerable

getinherited

Returns an enumerator that iterates through all the mv.impact.acquire.ComponentList elements in the collection.

This interface will allow to e.g. write code like this:

Info info = new Info(pDev);
foreach (ComponentList cl in info.componentListEnumerable)
{
  Console.WriteLine("{0}", cl.name);
}

See the framework's documentation about the System.Collections.IEnumerable interface for more information.

Returns

An enumerator that iterates through the collection

hObj

int hObj

getinherited

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

This handle will always reference an object of type mv.impact.acquire.ComponentList.

Returns

A unique identifier for the component referenced by this object.