mvHDRControl Class Reference

Category that contains features to control the devices High Dynamic Range parameters. More...

Inheritance diagram for mvHDRControl:

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.
	mvHDRControl (mv.impact.acquire.Device device)
	Constructs a new mv.impact.acquire.GenICam.mvHDRControl object.
	mvHDRControl (mv.impact.acquire.Device device, System.String settingName)
	Constructs a new mv.impact.acquire.GenICam.mvHDRControl object.
void	restoreDefault ()
	Restores the default for every component of this collection.

Public Attributes
readonly mv.impact.acquire.PropertyIBoolean	mvHDRAdaptiveLocalToneMappingEnable = new mv.impact.acquire.PropertyIBoolean()
	A boolean property. Enables Adaptive Local Tone Mapping.
readonly mv.impact.acquire.PropertyIBoolean	mvHDREnable = new mv.impact.acquire.PropertyIBoolean()
	A boolean property. Enables the High Dynamic Range Feature.
readonly mv.impact.acquire.PropertyI64	mvHDRExposure1 = new mv.impact.acquire.PropertyI64()
	An integer property. First HDR Exposure in ppm.
readonly mv.impact.acquire.PropertyI64	mvHDRExposure2 = new mv.impact.acquire.PropertyI64()
	An integer property. Second HDR Exposure in ppm.
readonly mv.impact.acquire.PropertyI64	mvHDRExposureRatio = new mv.impact.acquire.PropertyI64()
	An enumerated integer property. T1/T2 Exposure Ratio.
readonly mv.impact.acquire.PropertyIBoolean	mvHDRMotionCompensationEnable = new mv.impact.acquire.PropertyIBoolean()
	A boolean property. Enables motion compensation.
readonly mv.impact.acquire.PropertyI64	mvHDRPreset = new mv.impact.acquire.PropertyI64()
	An enumerated integer property. Selects the HDR parameter set.
readonly mv.impact.acquire.PropertyI64	mvHDRSelector = new mv.impact.acquire.PropertyI64()
	An enumerated integer property. Selects the HDR parameter set to configure.
readonly mv.impact.acquire.PropertyI64	mvHDRVoltage1 = new mv.impact.acquire.PropertyI64()
	An integer property. First HDR Voltage in mV.
readonly mv.impact.acquire.PropertyI64	mvHDRVoltage2 = new mv.impact.acquire.PropertyI64()
	An integer property. Second HDR Voltage in mV.

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

Category that contains features to control the devices High Dynamic Range parameters.

A category that contains features to control the devices High Dynamic Range parameters.

Constructor & Destructor Documentation

mvHDRControl() [1/2]

mvHDRControl ( mv::impact::acquire::Device device )

inline

Constructs a new mv.impact.acquire.GenICam.mvHDRControl object.

Parameters

[in]

device

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

mvHDRControl() [2/2]

mvHDRControl ( mv::impact::acquire::Device device, System::String settingName )

inline

Constructs a new mv.impact.acquire.GenICam.mvHDRControl 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

mvHDRAdaptiveLocalToneMappingEnable

readonly mv.impact.acquire.PropertyIBoolean mvHDRAdaptiveLocalToneMappingEnable = new mv.impact.acquire.PropertyIBoolean()

A boolean property. Enables Adaptive Local Tone Mapping.

Enables Adaptive Local Tone Mapping. Recommended if mvHDRMotionCompensationEnable is enabled.

mvHDREnable

readonly mv.impact.acquire.PropertyIBoolean mvHDREnable = new mv.impact.acquire.PropertyIBoolean()

A boolean property. Enables the High Dynamic Range Feature.

Enables the High Dynamic Range Feature.

mvHDRExposure1

readonly mv.impact.acquire.PropertyI64 mvHDRExposure1 = new mv.impact.acquire.PropertyI64()

An integer property. First HDR Exposure in ppm.

First HDR Exposure in ppm.

mvHDRExposure2

readonly mv.impact.acquire.PropertyI64 mvHDRExposure2 = new mv.impact.acquire.PropertyI64()

An integer property. Second HDR Exposure in ppm.

Second HDR Exposure in ppm.

mvHDRExposureRatio

readonly mv.impact.acquire.PropertyI64 mvHDRExposureRatio = new mv.impact.acquire.PropertyI64()

An enumerated integer property. T1/T2 Exposure Ratio.

The ratio of the long exposure time to the short exposure time.

The following string values might be valid for this feature:

• mvRatio4x (Display string: 'mv Ratio 4x')
• mvRatio8x (Display string: 'mv Ratio 8x')
• mvRatio16x (Display string: 'mv Ratio 16x')
• mvRatio32x (Display string: 'mv Ratio 32x')

Note

Depending on the device some of these values might not be supported and especially when working with third party devices there might be custom values which are not listed here. To get a complete and reliable list of supported values at runtime an application should therefore call mv.impact.acquire.EnumPropertyI<T>.listOfValidStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

mvHDRMotionCompensationEnable

readonly mv.impact.acquire.PropertyIBoolean mvHDRMotionCompensationEnable = new mv.impact.acquire.PropertyIBoolean()

A boolean property. Enables motion compensation.

Enables motion compensation. Recommended for scenes with a lot of motion.

mvHDRPreset

readonly mv.impact.acquire.PropertyI64 mvHDRPreset = new mv.impact.acquire.PropertyI64()

An enumerated integer property. Selects the HDR parameter set.

Selects the HDR parameter set.

The following string values might be valid for this feature:

• mvDualKneePoint0 (Display string: 'mv Dual Knee Point 0')
• mvDualKneePoint1 (Display string: 'mv Dual Knee Point 1')
• mvDualKneePoint2 (Display string: 'mv Dual Knee Point 2')
• mvDualKneePoint3 (Display string: 'mv Dual Knee Point 3')
• mvDualKneePoint4 (Display string: 'mv Dual Knee Point 4')
• mvDualKneePoint5 (Display string: 'mv Dual Knee Point 5')
• mvDualKneePoint6 (Display string: 'mv Dual Knee Point 6')
• mvDualKneePointUser (Display string: 'mv Dual Knee Point User')

Note

Depending on the device some of these values might not be supported and especially when working with third party devices there might be custom values which are not listed here. To get a complete and reliable list of supported values at runtime an application should therefore call mv.impact.acquire.EnumPropertyI<T>.listOfValidStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

mvHDRSelector

readonly mv.impact.acquire.PropertyI64 mvHDRSelector = new mv.impact.acquire.PropertyI64()

An enumerated integer property. Selects the HDR parameter set to configure.

This enumeration selects the HDR parameter set to configure.

The following string values might be valid for this feature:

• mvDualKneePoint0 (Display string: 'mv Dual Knee Point 0')
• mvDualKneePoint1 (Display string: 'mv Dual Knee Point 1')
• mvDualKneePoint2 (Display string: 'mv Dual Knee Point 2')
• mvDualKneePoint3 (Display string: 'mv Dual Knee Point 3')
• mvDualKneePoint4 (Display string: 'mv Dual Knee Point 4')
• mvDualKneePoint5 (Display string: 'mv Dual Knee Point 5')
• mvDualKneePoint6 (Display string: 'mv Dual Knee Point 6')
• mvDualKneePointUser (Display string: 'mv Dual Knee Point User')

Note

Depending on the device some of these values might not be supported and especially when working with third party devices there might be custom values which are not listed here. To get a complete and reliable list of supported values at runtime an application should therefore call mv.impact.acquire.EnumPropertyI<T>.listOfValidStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

mvHDRVoltage1

readonly mv.impact.acquire.PropertyI64 mvHDRVoltage1 = new mv.impact.acquire.PropertyI64()

An integer property. First HDR Voltage in mV.

First HDR Voltage in mV.

mvHDRVoltage2

readonly mv.impact.acquire.PropertyI64 mvHDRVoltage2 = new mv.impact.acquire.PropertyI64()

An integer property. Second HDR Voltage in mV.

Second HDR Voltage in mV.

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.