- Generated on Thu Nov 14 2024 18:44:47
|
Impact Acquire SDK Python
|
A base class to describe a camera (Device specific interface layout only) connected to a frame grabber (deprecated. More...
Public Member Functions | |
| __init__ (self, *args, **kwargs) | |
| copyDescription (self, newName) | |
| Creates a new camera description list as a copy of the current one. | |
| exportDescription (self) | |
| Stores the current camera description on disk. | |
| getClassName (self) | |
| Returns the class this description is belonging to. | |
| importDescription (self) | |
| Updates a camera description with the data stored in a previous session or with the original default data. | |
Properties | |
| aoiHeight = property(lib_mvIMPACT_acquire.CameraDescriptionBase_aoiHeight_get, doc=) | |
| An integer property defining the number of active lines to capture from the camera. | |
| aoiStartX = property(lib_mvIMPACT_acquire.CameraDescriptionBase_aoiStartX_get, doc=) | |
| An integer property defining the X-offset in pixels to the first active pixel to capture. | |
| aoiStartY = property(lib_mvIMPACT_acquire.CameraDescriptionBase_aoiStartY_get, doc=) | |
| An integer property defining the Y-offset in lines to the first active line to capture. | |
| aoiWidth = property(lib_mvIMPACT_acquire.CameraDescriptionBase_aoiWidth_get, doc=) | |
| An integer property defining the number of active pixels to capture per line. | |
| className = property (getClassName, None, None, None) | |
| A string property (read-only) which holds the class this description is belonging to. | |
| interlacedType = property(lib_mvIMPACT_acquire.CameraDescriptionBase_interlacedType_get, doc=) | |
| An enumerated integer property defining how the camera transmits image data. | |
| name = property(lib_mvIMPACT_acquire.CameraDescriptionBase_name_get, doc=) | |
| A string property read-only containing the name of this camera description list. | |
| thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag") | |
| videoOutput = property(lib_mvIMPACT_acquire.CameraDescriptionBase_videoOutput_get, doc=) | |
| An enumerated integer property defining the type of video outputs this camera offers. | |
A base class to describe a camera (Device specific interface layout only) connected to a frame grabber (deprecated.
A camera description object provides an abstract way to prepare the capture device (e.g. a frame grabber) for the connected imaging device (e.g. a camera).
By selecting one of the available camera descriptions the underlying hardware will use the information provided in the camera description to prepare the image capture. Therefore it is crucial to select a camera description that matches the connected video signal as close as possible. If no description for the camera connected to a frame grabber is available a new description should be generated from one of the existing ones. This can be achieved by calling the function mvIMPACT.acquire.CameraDescriptionBase.copyDescription. A new camera description with the name that is passed to the function will be created.
This new description will be an exact copy of the one the copy function has been executed for. After creation this description can be selected e.g. by setting the property mvIMPACT.acquire.CameraSettingsFrameGrabber.type to the name of the new description.
Example: For a standard description with the name 'MyCam' the full name would be 'Standard_MyCam'.
| __init__ | ( | self, | |
| * | args, | ||
| ** | kwargs ) |
| copyDescription | ( | self, | |
| newName ) |
Creates a new camera description list as a copy of the current one.
This function can be used to create a new camera description list. It will create a deep copy of the properties referenced by this camera description and will append the new description to the list of camera descriptions.
| newName | [in] The name for the newly created camera description. This name MUST NOT match a description already existing. |
| exportDescription | ( | self | ) |
Stores the current camera description on disk.
This function can be used to store the current settings of a camera description permanently so that the next time the driver is initialized these settings are restored.
When exporting a camera description a file in XML format will be written to disk.
PUBLIC%/Documents/Balluff/ImpactAcquire/CameraFiles (or MVIMPACT_ACQUIRE_DATA_DIR%/CameraFiles, which will point to the same folder)/opt/ImpactAcquire/data/camerafilesThis behaviour can be modified by writing the property mvIMPACT.acquire.Device.customDataDirectory before initialising the device.
| getClassName | ( | self | ) |
Returns the class this description is belonging to.
| importDescription | ( | self | ) |
Updates a camera description with the data stored in a previous session or with the original default data.
When importing a camera description the device driver will try to retrieve the parameters needed from a XML file.
PUBLIC%/Documents/Balluff/ImpactAcquire/CameraFiles (or MVIMPACT_ACQUIRE_DATA_DIR%/CameraFiles, which will point to the same folder)/opt/ImpactAcquire/data/camerafilesThis behaviour can be modified by writing the property mvIMPACT.acquire.Device.customDataDirectory before initialising the device. To get access to an XML description file within the application, these file must be copied to this directory BEFORE the device is initialized. During the initialisation process the device driver will process every file located under this location and will add them to the internal list of descriptions. Every camera located during this process and also descriptions created later on during the program operation can be selected via the property mvIMPACT.acquire.CameraSettingsFrameGrabber.type.
To restore the default values valid during the driver was initialized the function mvIMPACT.acquire.ComponentCollection.restoreDefault can be used as well.
|
static |
An integer property defining the number of active lines to capture from the camera.
|
static |
An integer property defining the X-offset in pixels to the first active pixel to capture.
|
static |
An integer property defining the Y-offset in lines to the first active line to capture.
|
static |
An integer property defining the number of active pixels to capture per line.
|
static |
A string property (read-only) which holds the class this description is belonging to.
|
static |
An enumerated integer property defining how the camera transmits image data.
Valid values for this property may be: mvIMPACT.acquire.citNone, mvIMPACT.acquire.citInterlaced, mvIMPACT.acquire.citInvertedInterlaced.
|
static |
A string property read-only containing the name of this camera description list.
|
static |
|
static |
An enumerated integer property defining the type of video outputs this camera offers.
Valid values for this property may be: mvIMPACT.acquire.coUndefined, mvIMPACT.acquire.coAuto, mvIMPACT.acquire.coComposite, mvIMPACT.acquire.coBase, mvIMPACT.acquire.coDigital, mvIMPACT.acquire.coSVideo, mvIMPACT.acquire.coMedium, mvIMPACT.acquire.coRGB, mvIMPACT.acquire.co2xComposite, mvIMPACT.acquire.co3xComposite, mvIMPACT.acquire.co4xComposite, mvIMPACT.acquire.coFull, mvIMPACT.acquire.coSDSDI, mvIMPACT.acquire.coHDSDI, mvIMPACT.acquire.co3GSDI.