Contains convenience functions to control features understood by Birger Engineering, Inc. lens adapters. More...

Inheritance diagram for LensControlBirger:

Public Member Functions
	LensControlBirger (mv.impact.acquire.Device pDev)
	Constructs a new mv.impact.acquire.labs.GenICam.LensControlBirger object.

	LensControlBirger (mv.impact.acquire.Device pDev, int defaultCommunicationTimeout_ms)
	Constructs a new mv.impact.acquire.labs.GenICam.LensControlBirger object.

double	setAperture (int steps)
	Writes the new aperture to the device.

double	setAperture (int steps, int timeout_ms)
	Writes the new aperture to the device.

double	setApertureToMax ()
	Closes the aperture to the max possible value.

double	setApertureToMax (int timeout_ms)
	Closes the aperture to the max possible value.

double	setApertureToMin ()
	Opens the aperture to the min possible value.

double	setApertureToMin (int timeout_ms)
	Opens the aperture to the min possible value.

int	setFocus (int steps)
	Moves the focus about the provided number of encoder steps.

int	setFocus (int steps, int timeout_ms)
	Moves the focus about the provided number of encoder steps.

int	setFocusToInfinity ()
	Moves the focus to the infinity position.

int	setFocusToInfinity (int timeout_ms)
	Moves the focus to the infinity position.

int	setFocusToZero ()
	Moves the focus to the closest position.

int	setFocusToZero (int timeout_ms)
	Moves the focus to the closest position.

Properties
double	aperture `[get]`
	Reads the current f-stop value from the device.

double	apertureMax `[get]`
	Returns the maximum f-stop value of the attached lens.

double	apertureMin `[get]`
	Returns the minimum f-stop value of the attached lens.

int	apertureStepCount `[get]`
	Returns the number of possible stops usable to change the opening of the aperture of the attached lens.

int	defaultCommunicationTimeout_ms `[get, set]`
	Reads or writes the defaultCommunicationTimeout which is used as timeout value for each command issues by this class.

int	focus `[get]`
	Reads the current focus value from the device.

int	focusMax `[get]`
	Returns the maximum focus value of the attached lens.

int	focusMin `[get]`
	Returns the minimum focus value of the attached lens.

string	serial `[get]`
	Returns the serial number of the connected adapter.

Detailed Description

Contains convenience functions to control features understood by Birger Engineering, Inc. lens adapters.

Attention: Please note that this class currently is part of the mv.impact.acquire.GenICam.labs namespace! This means that this code is not yet final and therefore might change in a future release. Feedback will be highly appreciated and if changes are applied to this code a detailed migration guide can be found in the documentation!

Since: 2.38.0

Constructor & Destructor Documentation

◆ LensControlBirger() [1/2]

LensControlBirger	(	mv::impact::acquire::Device	pDev,
		int	defaultCommunicationTimeout_ms )

inline

Constructs a new mv.impact.acquire.labs.GenICam.LensControlBirger object.

Parameters

[in]	pDev	A pointer to a mv.impact.acquire.Device object obtained from a mv.impact.acquire.DeviceManager object.
[in]	defaultCommunicationTimeout_ms	The default timeout value in milliseconds after which a command is considered as not successful. This timeout will be used by all function not acceptation a custom timeout. It's value can be changed later by writing to the defaultCommunicationTimeout_ms property'

◆ LensControlBirger() [2/2]

LensControlBirger ( mv::impact::acquire::Device pDev )

inline

Constructs a new mv.impact.acquire.labs.GenICam.LensControlBirger object.

Parameters

[in] pDev A pointer to a mv.impact.acquire.Device object obtained from a mv.impact.acquire.DeviceManager object.

Member Function Documentation

◆ setAperture() [1/2]

double setAperture ( int steps )

inline

Writes the new aperture to the device.

Returns: The number of steps (1/4 stops) the aperture has actually moved.

Parameters

[in] steps The new aperture value which should be set in 1/4 stops.

◆ setAperture() [2/2]

double setAperture	(	int	steps,
		int	timeout_ms )

inline

Writes the new aperture to the device.

Returns: The number of steps (1/4 stops) the aperture has actually moved.

Parameters

[in]	steps	The new aperture value which should be set in 1/4 stops.
[in]	timeout_ms	The timeout value in milliseconds after which the command is considered as not successful. In case of '0' the value of defaultCommunicationTimeout_ms will be used.

◆ setApertureToMax() [1/2]

double setApertureToMax ( )

inline

Closes the aperture to the max possible value.

Returns: The number of steps (1/4 stops) the aperture has actually moved.

◆ setApertureToMax() [2/2]

double setApertureToMax ( int timeout_ms )

inline

Closes the aperture to the max possible value.

Returns: The number of steps (1/4 stops) the aperture has actually moved.

Parameters

[in] timeout_ms The timeout value in milliseconds after which the command is considered as not successful. In case of '0' the value of defaultCommunicationTimeout_ms will be used.

◆ setApertureToMin() [1/2]

double setApertureToMin ( )

inline

Opens the aperture to the min possible value.

Returns: The number of steps (1/4 stops) the aperture has actually moved.

◆ setApertureToMin() [2/2]

double setApertureToMin ( int timeout_ms )

inline

Opens the aperture to the min possible value.

Returns: The number of steps (1/4 stops) the aperture has actually moved.

Parameters

[in] timeout_ms The timeout value in milliseconds after which the command is considered as not successful. In case of '0' the value of defaultCommunicationTimeout_ms will be used.

◆ setFocus() [1/2]

int setFocus ( int steps )

inline

Moves the focus about the provided number of encoder steps.

Returns: The number of steps the focus has moved. Might be positive for a movement towards the infinity position or negative for a movement towards the zero position.

Parameters

[in] steps The value of encoder steps the focus should be moved. Might be positive for a movement towards the infinity position or negative for a movement towards the zero position.

◆ setFocus() [2/2]

int setFocus	(	int	steps,
		int	timeout_ms )

inline

Moves the focus about the provided number of encoder steps.

Returns: The number of steps the focus has moved. Might be positive for a movement towards the infinity position or negative for a movement towards the zero position.

Parameters

[in]	steps	The value of encoder steps the focus should be moved. Might be positive for a movement towards the infinity position or negative for a movement towards the zero position.
[in]	timeout_ms	The timeout value in milliseconds after which the command is considered as not successful. In case of '0' the value of defaultCommunicationTimeout_ms will be used.

◆ setFocusToInfinity() [1/2]

int setFocusToInfinity ( )

inline

Moves the focus to the infinity position.

Returns: The number of steps the focus has moved.

◆ setFocusToInfinity() [2/2]

int setFocusToInfinity ( int timeout_ms )

inline

Moves the focus to the infinity position.

Returns: The number of steps the focus has moved.

Parameters

[in] timeout_ms The timeout value in milliseconds after which the command is considered as not successful. In case of '0' the value of defaultCommunicationTimeout_ms will be used.

◆ setFocusToZero() [1/2]

int setFocusToZero ( )

inline

Moves the focus to the closest position.

Returns: The number of steps the focus has moved.

◆ setFocusToZero() [2/2]

int setFocusToZero ( int timeout_ms )

inline

Moves the focus to the closest position.

Returns: The number of steps the focus has moved.

Parameters

[in] timeout_ms The timeout value in milliseconds after which the command is considered as not successful. In case of '0' the value of defaultCommunicationTimeout_ms will be used.

Property Documentation

◆ aperture

double aperture

get

Reads the current f-stop value from the device.

Returns: The absolute position given as the lens f-number.

◆ apertureMax

double apertureMax

get

Returns the maximum f-stop value of the attached lens.

Returns: The maximum f-stop value of the attached lens as double value.

◆ apertureMin

double apertureMin

get

Returns the minimum f-stop value of the attached lens.

Returns: The minimum f-stop value of the attached lens as double value.

◆ apertureStepCount

int apertureStepCount

get

Returns the number of possible stops usable to change the opening of the aperture of the attached lens.

Returns: The number of possible stops as int.

◆ defaultCommunicationTimeout_ms

int defaultCommunicationTimeout_ms

getset

Reads or writes the defaultCommunicationTimeout which is used as timeout value for each command issues by this class.

Returns: The defaultCommunicationTimeout_ms value.

◆ focus

int focus

get

Reads the current focus value from the device.

Returns: The value the focus is currently set to.

◆ focusMax

int focusMax

get

Returns the maximum focus value of the attached lens.

Returns: The maximum focus value of the attached lens as int value.

◆ focusMin

int focusMin

get

Returns the minimum focus value of the attached lens.

Returns: The minimum focus value of the attached lens as int value.

◆ serial

string serial

get

Returns the serial number of the connected adapter.

Returns: The serial number of the attached adapter as string.

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ LensControlBirger() [1/2]

◆ LensControlBirger() [2/2]

Member Function Documentation

◆ setAperture() [1/2]

◆ setAperture() [2/2]

◆ setApertureToMax() [1/2]

◆ setApertureToMax() [2/2]

◆ setApertureToMin() [1/2]

◆ setApertureToMin() [2/2]

◆ setFocus() [1/2]

◆ setFocus() [2/2]

◆ setFocusToInfinity() [1/2]

◆ setFocusToInfinity() [2/2]

◆ setFocusToZero() [1/2]

◆ setFocusToZero() [2/2]

Property Documentation

◆ aperture

◆ apertureMax

◆ apertureMin

◆ apertureStepCount

◆ defaultCommunicationTimeout_ms

◆ focus

◆ focusMax

◆ focusMin

◆ serial