mvIMPACT Acquire SDK C++

Category for optical control features. More...

#include <mvIMPACT_acquire_GenICam.h>

Public Member Functions

 OpticControl (mvIMPACT::acquire::Device *pDev, const std::string &settingName="Base")
 Constructs a new mvIMPACT::acquire::GenICam::OpticControl object.
 

Public Attributes

PropertyF aperture
 A floating point property. Sets the aperture (also called iris, f-number, f-stop or f/#) of the lens.
 
Method apertureInitialize
 A method object. Initializes the aperture and makes it ready for use.
 
PropertyI64 apertureStatus
 An enumerated integer property. Reads the status of the aperture.
 
PropertyI64 apertureStepper
 An integer property. ApertureStepper controls the stepper value of the aperture.
 
PropertyI64 filter
 An integer property. Filter positions in native number system.
 
Method filterInitialize
 A method object. Initializes the filter and makes it ready for use.
 
PropertyI64 filterStatus
 An enumerated integer property. Reads the status of the filter.
 
PropertyF focalLength
 A floating point property. Focal length in millimeters (mm).
 
Method focalLengthInitialize
 A method object. Initializes the focal length and makes it ready for use.
 
PropertyI64 focalLengthStatus
 An enumerated integer property. Reads the status of the focal length.
 
PropertyI64 focalLengthStepper
 An integer property. FocalLengthStepper controls the stepper value of the focal length.
 
PropertyF focalPower
 A floating point property. Sets the focal power (in diopters/dpt).
 
PropertyI64 focusAuto
 An enumerated integer property. Sets automatic focus.
 
PropertyI64 focusAutoMode
 An enumerated integer property. Sets automatic focus mode.
 
Method focusInitialize
 A method object. Initializes the focus and makes it ready for use.
 
PropertyI64 focusStatus
 An enumerated integer property. Reads the status of the focus.
 
PropertyI64 focusStepper
 An integer property. FocusStepper controls the stepper value of the focus.
 
PropertyF magnification
 A floating point property. Magnification of the lens, defined as ratio between apparent size of an image and its true size.
 
Method magnificationInitialize
 A method object. Initializes the magnification and makes it ready for use.
 
PropertyI64 magnificationStatus
 An enumerated integer property. Reads the status of the magnification.
 
PropertyI64 magnificationStepper
 An integer property. MagnificationStepper controls the stepper value of the magnification.
 
PropertyF numericalAperture
 A floating point property. Sets the numerical aperture of a lens.
 
PropertyF objectSensorDistance
 A floating point property. Distance from the image sensor surface to the object in millimeters (mm).
 
Method opticControllerAbort
 A method object. Aborts the current command or feature access.
 
Method opticControllerDisconnect
 A method object. Closes the optic controller connection and prepares it for removal.
 
PropertyS opticControllerFamilyName
 A string property. Name of the device family of the optic controller.
 
PropertyS opticControllerFirmwareVersion
 A string property. Version of the firmware in the optic controller.
 
Method opticControllerInitialize
 A method object. Initializes the optic controller and makes it ready for use.
 
PropertyS opticControllerModelName
 A string property. Model name of the optic controller.
 
PropertyI64 opticControllerSelector
 An enumerated integer property. Selects which optic controller to configure.
 
PropertyS opticControllerSerialNumber
 A string property. Serial number of the optic controller.
 
PropertyI64 opticControllerStatus
 An enumerated integer property. Reads the status of the optic controller.
 
PropertyF opticControllerTemperature
 A floating point property. Temperature of the optic controller in degrees Celsius (C).
 
PropertyS opticControllerVendorName
 A string property. Name of the manufacturer of the optic controller.
 
PropertyS opticControllerVersion
 A string property. Version of the optic controller.
 
PropertyI64 shutter
 An integer property. Controls whether the shutter is opened or closed.
 
Method shutterInitialize
 A method object. Initializes the shutter and makes it ready for use.
 
PropertyI64 shutterStatus
 An enumerated integer property. Reads the status of the shutter.
 
PropertyI64 stabilization
 An integer property. Control of image stabilization function build into the optic controller.
 
Method stabilizationInitialize
 A method object. Initializes the stabilization and makes it ready for use.
 
PropertyI64 stabilizationStatus
 An enumerated integer property. Reads the status of the stabilization.
 

Detailed Description

Category for optical control features.

A category for optical control features.

Constructor & Destructor Documentation

◆ OpticControl()

OpticControl ( mvIMPACT::acquire::Device pDev,
const std::string &  settingName = "Base" 
)
inlineexplicit

Constructs a new mvIMPACT::acquire::GenICam::OpticControl object.

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

Member Data Documentation

◆ aperture

PropertyF aperture

A floating point property. Sets the aperture (also called iris, f-number, f-stop or f/#) of the lens.

Sets the aperture (also called iris, f-number, f-stop or f/#) of the lens. The lower the f/# the more light goes through the lens (the 'faster' the lens) and the smaller the depth of field.

◆ apertureInitialize

Method apertureInitialize

A method object. Initializes the aperture and makes it ready for use.

Initializes the aperture and makes it ready for use. The aperture position after initialization is implementation dependent. This feature is only implemented if an additional initialization is required after OpticControllerInitialize.

◆ apertureStatus

PropertyI64 apertureStatus

An enumerated integer property. Reads the status of the aperture.

Reads the status of the aperture.

The following string values might be valid for this feature:

  • NotConnected (Display string: 'Not Connected'): The aperture controller is physically not connected.
  • NotInitialized (Display string: 'Not Initialized'): The aperture controller is not initialized.
  • NotSupported (Display string: 'Not Supported'): The aperture controller is physically connected but not supported.
  • Busy (Display string: 'Busy'): The aperture controller executes a feature access/command.
  • Ready (Display string: 'Ready'): The aperture controller is ready to use.
  • Error (Display string: 'Error'): The aperture controller encountered an error.
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 mvIMPACT::acquire::EnumPropertyI::getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ apertureStepper

PropertyI64 apertureStepper

An integer property. ApertureStepper controls the stepper value of the aperture.

ApertureStepper controls the stepper value of the aperture. 0 is the maximum opening.

◆ filter

PropertyI64 filter

An integer property. Filter positions in native number system.

Filter positions in native number system. This is implementation dependent.

◆ filterInitialize

Method filterInitialize

A method object. Initializes the filter and makes it ready for use.

Initializes the filter and makes it ready for use. The filter position after initialization is implementation dependent. This feature is only implemented if an additional initialization is required after OpticControllerInitialize.

◆ filterStatus

PropertyI64 filterStatus

An enumerated integer property. Reads the status of the filter.

Reads the status of the filter.

The following string values might be valid for this feature:

  • NotConnected (Display string: 'Not Connected'): The filter controller is physically not connected.
  • NotInitialized (Display string: 'Not Initialized'): The filter controller is not initialized.
  • NotSupported (Display string: 'Not Supported'): The filter controller is physically connected but not supported.
  • Busy (Display string: 'Busy'): The filter controller executes a feature access/command.
  • Ready (Display string: 'Ready'): The filter controller is ready to use.
  • Error (Display string: 'Error'): The filter controller encountered an error.
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 mvIMPACT::acquire::EnumPropertyI::getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ focalLength

PropertyF focalLength

A floating point property. Focal length in millimeters (mm).

Focal length in millimeters (mm).

◆ focalLengthInitialize

Method focalLengthInitialize

A method object. Initializes the focal length and makes it ready for use.

Initializes the focal length and makes it ready for use. The focal length position after initialization is implementation dependent. This feature is only implemented if an additional initialization is required after OpticControllerInitialize.

◆ focalLengthStatus

PropertyI64 focalLengthStatus

An enumerated integer property. Reads the status of the focal length.

Reads the status of the focal length.

The following string values might be valid for this feature:

  • NotConnected (Display string: 'Not Connected'): The focal length controller is physically not connected.
  • NotInitialized (Display string: 'Not Initialized'): The focal length controller is not initialized.
  • NotSupported (Display string: 'Not Supported'): The focal length controller is physically connected but not supported.
  • Busy (Display string: 'Busy'): The focal length controller executes a feature access/command.
  • Ready (Display string: 'Ready'): The focal length controller is ready to use.
  • Error (Display string: 'Error'): The focal length controller encountered an error.
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 mvIMPACT::acquire::EnumPropertyI::getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ focalLengthStepper

PropertyI64 focalLengthStepper

An integer property. FocalLengthStepper controls the stepper value of the focal length.

FocalLengthStepper controls the stepper value of the focal length. 0 is the shortest focal length.

◆ focalPower

PropertyF focalPower

A floating point property. Sets the focal power (in diopters/dpt).

Sets the focal power (in diopters/dpt). This is mostly used for liquid lenses and indicates how much a liquid lens focuses.

◆ focusAuto

PropertyI64 focusAuto

An enumerated integer property. Sets automatic focus.

Sets automatic focus. If enabled, the optic device shall be set into a mode of operation, where the lens automatically finds the best possible focus.

The following string values might be valid for this feature:

  • Off (Display string: 'Off'): The focus is set manually.
  • Once (Display string: 'Once'): The focus is adapted once by the device. Once it has converged, it returns to the Off state.
  • Continuous (Display string: 'Continuous'): The focus is constantly adapted by the device to maximize the dynamic range.
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 mvIMPACT::acquire::EnumPropertyI::getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ focusAutoMode

PropertyI64 focusAutoMode

An enumerated integer property. Sets automatic focus mode.

Sets automatic focus mode.

The following string values might be valid for this feature:

  • DistanceBased (Display string: 'Distance Based'): The OpticController has a built-in distance sensor and computes the focus based on the detected distance (open loop).
  • ImageBased (Display string: 'Image Based'): The OpticController evaluates the image for closed loop control (closed loop).
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 mvIMPACT::acquire::EnumPropertyI::getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ focusInitialize

Method focusInitialize

A method object. Initializes the focus and makes it ready for use.

Initializes the focus and makes it ready for use. The focus position after initialization is implementation dependent. This feature is only implemented if an additional initialization is required after OpticControllerInitialize.

◆ focusStatus

PropertyI64 focusStatus

An enumerated integer property. Reads the status of the focus.

Reads the status of the focus.

The following string values might be valid for this feature:

  • NotConnected (Display string: 'Not Connected'): The focus controller is physically not connected.
  • NotInitialized (Display string: 'Not Initialized'): The focus controller is not initialized.
  • NotSupported (Display string: 'Not Supported'): The focus controller is physically connected but not supported.
  • Busy (Display string: 'Busy'): The focus controller executes a feature access/command.
  • Ready (Display string: 'Ready'): The focus controller is ready to use.
  • Error (Display string: 'Error'): The focus controller encountered an error.
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 mvIMPACT::acquire::EnumPropertyI::getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ focusStepper

PropertyI64 focusStepper

An integer property. FocusStepper controls the stepper value of the focus.

FocusStepper controls the stepper value of the focus. E.g. ObjectSensorDistance or FocalPower. 0 is the closest focus.

◆ magnification

PropertyF magnification

A floating point property. Magnification of the lens, defined as ratio between apparent size of an image and its true size.

Magnification of the lens, defined as ratio between apparent size of an image and its true size.

◆ magnificationInitialize

Method magnificationInitialize

A method object. Initializes the magnification and makes it ready for use.

Initializes the magnification and makes it ready for use. The magnification position after initialization is implementation dependent. This feature is only implemented if an additional initialization is required after OpticControllerInitialize.

◆ magnificationStatus

PropertyI64 magnificationStatus

An enumerated integer property. Reads the status of the magnification.

Reads the status of the magnification.

The following string values might be valid for this feature:

  • NotConnected (Display string: 'Not Connected'): The magnification controller is physically not connected.
  • NotInitialized (Display string: 'Not Initialized'): The magnification controller is not initialized.
  • NotSupported (Display string: 'Not Supported'): The magnification controller is physically connected but not supported.
  • Busy (Display string: 'Busy'): The magnification controller executes a feature access/command.
  • Ready (Display string: 'Ready'): The magnification controller is ready to use.
  • Error (Display string: 'Error'): The magnification controller encountered an error.
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 mvIMPACT::acquire::EnumPropertyI::getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ magnificationStepper

PropertyI64 magnificationStepper

An integer property. MagnificationStepper controls the stepper value of the magnification.

MagnificationStepper controls the stepper value of the magnification. 0 is the lowest magnification.

◆ numericalAperture

PropertyF numericalAperture

A floating point property. Sets the numerical aperture of a lens.

Sets the numerical aperture of a lens. It is inversely proportional to the f/#.

◆ objectSensorDistance

PropertyF objectSensorDistance

A floating point property. Distance from the image sensor surface to the object in millimeters (mm).

Distance from the image sensor surface to the object in millimeters (mm).

◆ opticControllerAbort

Method opticControllerAbort

A method object. Aborts the current command or feature access.

Aborts the current command or feature access. This will end the process without completing it or having reached the desired end position or value. If no command or feature access is in progress, the command is ignored.

◆ opticControllerDisconnect

Method opticControllerDisconnect

A method object. Closes the optic controller connection and prepares it for removal.

Closes the optic controller connection and prepares it for removal.

◆ opticControllerFamilyName

PropertyS opticControllerFamilyName

A string property. Name of the device family of the optic controller.

Name of the device family of the optic controller.

◆ opticControllerFirmwareVersion

PropertyS opticControllerFirmwareVersion

A string property. Version of the firmware in the optic controller.

Version of the firmware in the optic controller.

◆ opticControllerInitialize

Method opticControllerInitialize

A method object. Initializes the optic controller and makes it ready for use.

Initializes the optic controller and makes it ready for use.

◆ opticControllerModelName

PropertyS opticControllerModelName

A string property. Model name of the optic controller.

Model name of the optic controller.

◆ opticControllerSelector

PropertyI64 opticControllerSelector

An enumerated integer property. Selects which optic controller to configure.

Selects which optic controller to configure.

The following string values might be valid for this feature:

  • OpticController0 (Display string: 'Optic Controller 0'): Selects Optic Controller 0.
  • OpticController1 (Display string: 'Optic Controller 1'): Selects Optic Controller 1.
  • OpticController2 (Display string: 'Optic Controller 2'): Selects Optic Controller 2.
  • OpticController#3# (Display string: 'Optic Controller #3#'): Selects Optic Controller #3#.
  • OpticController3 (Display string: 'Optic Controller 3'): Selects Optic Controller 3.
  • OpticController4 (Display string: 'Optic Controller 4'): Selects Optic Controller 4.
  • OpticController5 (Display string: 'Optic Controller 5'): Selects Optic Controller 5.
  • OpticController6 (Display string: 'Optic Controller 6'): Selects Optic Controller 6.
  • OpticController7 (Display string: 'Optic Controller 7'): Selects Optic Controller 7.
  • OpticController8 (Display string: 'Optic Controller 8'): Selects Optic Controller 8.
  • OpticController9 (Display string: 'Optic Controller 9'): Selects Optic Controller 9.
  • OpticController10 (Display string: 'Optic Controller 10'): Selects Optic Controller 10.
  • OpticController11 (Display string: 'Optic Controller 11'): Selects Optic Controller 11.
  • OpticController12 (Display string: 'Optic Controller 12'): Selects Optic Controller 12.
  • OpticController13 (Display string: 'Optic Controller 13'): Selects Optic Controller 13.
  • OpticController14 (Display string: 'Optic Controller 14'): Selects Optic Controller 14.
  • OpticController15 (Display string: 'Optic Controller 15'): Selects Optic Controller 15.
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 mvIMPACT::acquire::EnumPropertyI::getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ opticControllerSerialNumber

PropertyS opticControllerSerialNumber

A string property. Serial number of the optic controller.

Serial number of the optic controller.

◆ opticControllerStatus

PropertyI64 opticControllerStatus

An enumerated integer property. Reads the status of the optic controller.

Reads the status of the optic controller.

The following string values might be valid for this feature:

  • NotConnected (Display string: 'Not Connected'): The optic controller is physically not connected.
  • NotInitialized (Display string: 'Not Initialized'): The optic controller is not initialized.
  • NotSupported (Display string: 'Not Supported'): The optic controller is physically connected but not supported.
  • Busy (Display string: 'Busy'): The optic controller executes a feature access/command.
  • Ready (Display string: 'Ready'): The optic controller is ready to use.
  • Error (Display string: 'Error'): The optic controller encountered an error.
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 mvIMPACT::acquire::EnumPropertyI::getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ opticControllerTemperature

PropertyF opticControllerTemperature

A floating point property. Temperature of the optic controller in degrees Celsius (C).

Temperature of the optic controller in degrees Celsius (C).

◆ opticControllerVendorName

PropertyS opticControllerVendorName

A string property. Name of the manufacturer of the optic controller.

Name of the manufacturer of the optic controller.

◆ opticControllerVersion

PropertyS opticControllerVersion

A string property. Version of the optic controller.

Version of the optic controller.

◆ shutter

PropertyI64 shutter

An integer property. Controls whether the shutter is opened or closed.

Controls whether the shutter is opened or closed.

◆ shutterInitialize

Method shutterInitialize

A method object. Initializes the shutter and makes it ready for use.

Initializes the shutter and makes it ready for use. The shutter position after initialization is implementation dependent. This feature is only implemented if an additional initialization is required after OpticControllerInitialize.

◆ shutterStatus

PropertyI64 shutterStatus

An enumerated integer property. Reads the status of the shutter.

Reads the status of the shutter.

The following string values might be valid for this feature:

  • NotConnected (Display string: 'Not Connected'): The shutter controller is physically not connected.
  • NotInitialized (Display string: 'Not Initialized'): The shutter controller is not initialized.
  • NotSupported (Display string: 'Not Supported'): The shutter controller is physically connected but not supported.
  • Busy (Display string: 'Busy'): The shutter controller executes a feature access/command.
  • Ready (Display string: 'Ready'): The shutter controller is ready to use.
  • Error (Display string: 'Error'): The shutter controller encountered an error.
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 mvIMPACT::acquire::EnumPropertyI::getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ stabilization

PropertyI64 stabilization

An integer property. Control of image stabilization function build into the optic controller.

Control of image stabilization function build into the optic controller.

◆ stabilizationInitialize

Method stabilizationInitialize

A method object. Initializes the stabilization and makes it ready for use.

Initializes the stabilization and makes it ready for use. The stabilization state after initialization is implementation dependent. This feature is only implemented if an additional initialization is required after OpticControllerInitialize.

◆ stabilizationStatus

PropertyI64 stabilizationStatus

An enumerated integer property. Reads the status of the stabilization.

Reads the status of the stabilization.

The following string values might be valid for this feature:

  • NotConnected (Display string: 'Not Connected'): The stabilization controller is physically not connected.
  • NotInitialized (Display string: 'Not Initialized'): The stabilization controller is not initialized.
  • NotSupported (Display string: 'Not Supported'): The stabilization controller is physically connected but not supported.
  • Busy (Display string: 'Busy'): The stabilization controller executes a feature access/command.
  • Ready (Display string: 'Ready'): The stabilization controller is ready to use.
  • Error (Display string: 'Error'): The stabilization controller encountered an error.
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 mvIMPACT::acquire::EnumPropertyI::getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.