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

#include <mvIMPACT_acquire_GenICam_LensControl.h>

Inheritance diagram for LensControlBirger:

Public Member Functions
double	getAperture (unsigned int timeout_ms=0)
	Reads the current FStop value from the device.

unsigned int	getApertureStepCount (void) const
	Returns the number of possible stops usable to change the opening of the aperture of the attached lens.

int	getFocus (unsigned int timeout_ms=0)
	Reads the current focus value from the device.

double	getMaxAperture (void) const
	Returns the maximum f-stop value of the attached lens.

int	getMaxFocus (void) const
	Returns the maximum focus value of the attached lens.

double	getMinAperture (void) const
	Returns the minimum f-stop value of the attached lens.

int	getMinFocus (void) const
	Returns the minimum focus value of the attached lens.

std::string	getSerial (unsigned int timeout_ms=0) const
	Returns the serial number of the connected adapter.

	LensControlBirger (mvIMPACT::acquire::Device *pDev, unsigned int defaultCommunicationTimeout_ms=5000)
	Constructs a new mvIMPACT::acquire::GenICam::labs::LensControlBirger object.

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

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

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

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

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

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

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

LensControlBirger	(	mvIMPACT::acquire::Device *	pDev,
		unsigned int	defaultCommunicationTimeout_ms = 5000 )

inlineexplicit

Constructs a new mvIMPACT::acquire::GenICam::labs::LensControlBirger object.

Parameters

[in]	pDev	A pointer to a mvIMPACT::acquire::Device object obtained from a mvIMPACT::acquire::DeviceManager object.
[in]	defaultCommunicationTimeout_ms	The default timeout value in milliseconds after which a command is considered as not successful.

Member Function Documentation

◆ getAperture()

double getAperture ( unsigned int timeout_ms = 0 )

inline

Reads the current FStop value from the device.

Returns: The resulting f value the aperture is set to.

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.

◆ getApertureStepCount()

unsigned int getApertureStepCount ( void ) const

inline

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 unsigned int.

◆ getFocus()

int getFocus ( unsigned int timeout_ms = 0 )

inline

Reads the current focus value from the device.

Returns: The value the focus is currently set to.

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.

◆ getMaxAperture()

double getMaxAperture ( void ) const

inline

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

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

◆ getMaxFocus()

int getMaxFocus ( void ) const

inline

Returns the maximum focus value of the attached lens.

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

◆ getMinAperture()

double getMinAperture ( void ) const

inline

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

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

◆ getMinFocus()

int getMinFocus ( void ) const

inline

Returns the minimum focus value of the attached lens.

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

◆ getSerial()

std::string getSerial ( unsigned int timeout_ms = 0 ) const

inline

Returns the serial number of the connected adapter.

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

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.

◆ setAperture()

double setAperture	(	int	steps,
		unsigned int	timeout_ms = 0 )

inline

Writes the new aperture to the device.

Returns: The resulting FStop value the aperture is set to.

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

double setApertureToMax ( unsigned int timeout_ms = 0 )

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

double setApertureToMin ( unsigned int timeout_ms = 0 )

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

int setFocus	(	int	steps,
		unsigned int	timeout_ms = 0 )

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

int setFocusToInfinity ( unsigned int timeout_ms = 0 )

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

int setFocusToZero ( unsigned int timeout_ms = 0 )

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.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ LensControlBirger()

Member Function Documentation

◆ getAperture()

◆ getApertureStepCount()

◆ getFocus()

◆ getMaxAperture()

◆ getMaxFocus()

◆ getMinAperture()

◆ getMinFocus()

◆ getSerial()

◆ setAperture()

◆ setApertureToMax()

◆ setApertureToMin()

◆ setFocus()

◆ setFocusToInfinity()

◆ setFocusToZero()