Impact Acquire SDK Python
|
Category for optical control features. More...
Public Member Functions | |
__init__ (self, *args) | |
Constructs a new mvIMPACT.acquire.OpticControl object. | |
Properties | |
aperture = property(lib_mvIMPACT_acquire.OpticControl_aperture_get, doc=) | |
A floating point property. | |
apertureInitialize = property(lib_mvIMPACT_acquire.OpticControl_apertureInitialize_get, doc=) | |
A method object. | |
apertureStatus = property(lib_mvIMPACT_acquire.OpticControl_apertureStatus_get, doc=) | |
An enumerated integer property. | |
apertureStepper = property(lib_mvIMPACT_acquire.OpticControl_apertureStepper_get, doc=) | |
An integer property. | |
filter = property(lib_mvIMPACT_acquire.OpticControl_filter_get, doc=) | |
An integer property. | |
filterInitialize = property(lib_mvIMPACT_acquire.OpticControl_filterInitialize_get, doc=) | |
A method object. | |
filterStatus = property(lib_mvIMPACT_acquire.OpticControl_filterStatus_get, doc=) | |
An enumerated integer property. | |
focalLength = property(lib_mvIMPACT_acquire.OpticControl_focalLength_get, doc=) | |
A floating point property. | |
focalLengthInitialize = property(lib_mvIMPACT_acquire.OpticControl_focalLengthInitialize_get, doc=) | |
A method object. | |
focalLengthStatus = property(lib_mvIMPACT_acquire.OpticControl_focalLengthStatus_get, doc=) | |
An enumerated integer property. | |
focalLengthStepper = property(lib_mvIMPACT_acquire.OpticControl_focalLengthStepper_get, doc=) | |
An integer property. | |
focalPower = property(lib_mvIMPACT_acquire.OpticControl_focalPower_get, doc=) | |
A floating point property. | |
focusAuto = property(lib_mvIMPACT_acquire.OpticControl_focusAuto_get, doc=) | |
An enumerated integer property. | |
focusAutoMode = property(lib_mvIMPACT_acquire.OpticControl_focusAutoMode_get, doc=) | |
An enumerated integer property. | |
focusInitialize = property(lib_mvIMPACT_acquire.OpticControl_focusInitialize_get, doc=) | |
A method object. | |
focusStatus = property(lib_mvIMPACT_acquire.OpticControl_focusStatus_get, doc=) | |
An enumerated integer property. | |
focusStepper = property(lib_mvIMPACT_acquire.OpticControl_focusStepper_get, doc=) | |
An integer property. | |
magnification = property(lib_mvIMPACT_acquire.OpticControl_magnification_get, doc=) | |
A floating point property. | |
magnificationInitialize = property(lib_mvIMPACT_acquire.OpticControl_magnificationInitialize_get, doc=) | |
A method object. | |
magnificationStatus = property(lib_mvIMPACT_acquire.OpticControl_magnificationStatus_get, doc=) | |
An enumerated integer property. | |
magnificationStepper = property(lib_mvIMPACT_acquire.OpticControl_magnificationStepper_get, doc=) | |
An integer property. | |
numericalAperture = property(lib_mvIMPACT_acquire.OpticControl_numericalAperture_get, doc=) | |
A floating point property. | |
objectSensorDistance = property(lib_mvIMPACT_acquire.OpticControl_objectSensorDistance_get, doc=) | |
A floating point property. | |
opticControllerAbort = property(lib_mvIMPACT_acquire.OpticControl_opticControllerAbort_get, doc=) | |
A method object. | |
opticControllerDisconnect = property(lib_mvIMPACT_acquire.OpticControl_opticControllerDisconnect_get, doc=) | |
A method object. | |
opticControllerFamilyName = property(lib_mvIMPACT_acquire.OpticControl_opticControllerFamilyName_get, doc=) | |
A string property. | |
opticControllerFirmwareVersion = property(lib_mvIMPACT_acquire.OpticControl_opticControllerFirmwareVersion_get, doc=) | |
A string property. | |
opticControllerInitialize = property(lib_mvIMPACT_acquire.OpticControl_opticControllerInitialize_get, doc=) | |
A method object. | |
opticControllerModelName = property(lib_mvIMPACT_acquire.OpticControl_opticControllerModelName_get, doc=) | |
A string property. | |
opticControllerSelector = property(lib_mvIMPACT_acquire.OpticControl_opticControllerSelector_get, doc=) | |
An enumerated integer property. | |
opticControllerSerialNumber = property(lib_mvIMPACT_acquire.OpticControl_opticControllerSerialNumber_get, doc=) | |
A string property. | |
opticControllerStatus = property(lib_mvIMPACT_acquire.OpticControl_opticControllerStatus_get, doc=) | |
An enumerated integer property. | |
opticControllerTemperature = property(lib_mvIMPACT_acquire.OpticControl_opticControllerTemperature_get, doc=) | |
A floating point property. | |
opticControllerVendorName = property(lib_mvIMPACT_acquire.OpticControl_opticControllerVendorName_get, doc=) | |
A string property. | |
opticControllerVersion = property(lib_mvIMPACT_acquire.OpticControl_opticControllerVersion_get, doc=) | |
A string property. | |
shutter = property(lib_mvIMPACT_acquire.OpticControl_shutter_get, doc=) | |
An integer property. | |
shutterInitialize = property(lib_mvIMPACT_acquire.OpticControl_shutterInitialize_get, doc=) | |
A method object. | |
shutterStatus = property(lib_mvIMPACT_acquire.OpticControl_shutterStatus_get, doc=) | |
An enumerated integer property. | |
stabilization = property(lib_mvIMPACT_acquire.OpticControl_stabilization_get, doc=) | |
An integer property. | |
stabilizationInitialize = property(lib_mvIMPACT_acquire.OpticControl_stabilizationInitialize_get, doc=) | |
A method object. | |
stabilizationStatus = property(lib_mvIMPACT_acquire.OpticControl_stabilizationStatus_get, doc=) | |
An enumerated integer property. | |
thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag") | |
Category for optical control features.
A category for optical control features.
__init__ | ( | self, | |
* | args ) |
Constructs a new mvIMPACT.acquire.OpticControl object.
pDev | [in] A pointer to a mvIMPACT.acquire.Device object obtained from a mvIMPACT.acquire.DeviceManager object. |
settingName | [in] 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 mvIMPACT.acquire.FunctionInterface.getAvailableSettings, new settings can be created with the function mvIMPACT.acquire.FunctionInterface.createSetting |
|
static |
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.
|
static |
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.
|
static |
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:
|
static |
An integer property.
ApertureStepper controls the stepper value of the aperture.
ApertureStepper controls the stepper value of the aperture. 0 is the maximum opening.
|
static |
An integer property.
Filter positions in native number system.
Filter positions in native number system. This is implementation dependent.
|
static |
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.
|
static |
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:
|
static |
A floating point property.
Focal length in millimeters (mm).
Focal length in millimeters (mm).
|
static |
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.
|
static |
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:
|
static |
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.
|
static |
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.
|
static |
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:
|
static |
An enumerated integer property.
Sets automatic focus mode.
Sets automatic focus mode.
The following string values might be valid for this feature:
|
static |
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.
|
static |
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:
|
static |
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.
|
static |
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.
|
static |
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.
|
static |
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:
|
static |
An integer property.
MagnificationStepper controls the stepper value of the magnification.
MagnificationStepper controls the stepper value of the magnification. 0 is the lowest magnification.
|
static |
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/#.
|
static |
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).
|
static |
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.
|
static |
A method object.
Closes the optic controller connection and prepares it for removal.
Closes the optic controller connection and prepares it for removal.
|
static |
A string property.
Name of the device family of the optic controller.
Name of the device family of the optic controller.
|
static |
A string property.
Version of the firmware in the optic controller.
Version of the firmware in the optic controller.
|
static |
A method object.
Initializes the optic controller and makes it ready for use.
Initializes the optic controller and makes it ready for use.
|
static |
A string property.
Model name of the optic controller.
Model name of the optic controller.
|
static |
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:
|
static |
A string property.
Serial number of the optic controller.
Serial number of the optic controller.
|
static |
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:
|
static |
A floating point property.
Temperature of the optic controller in degrees Celsius (C).
Temperature of the optic controller in degrees Celsius (C).
|
static |
A string property.
Name of the manufacturer of the optic controller.
Name of the manufacturer of the optic controller.
|
static |
A string property.
Version of the optic controller.
Version of the optic controller.
|
static |
An integer property.
Controls whether the shutter is opened or closed.
Controls whether the shutter is opened or closed.
|
static |
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.
|
static |
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:
|
static |
An integer property.
Control of image stabilization function build into the optic controller.
Control of image stabilization function build into the optic controller.
|
static |
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.
|
static |
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:
|
static |