CameraDescriptionDigitalBase Class Reference

A base class to describe an arbitrary digital camera signal(Device specific interface layout only) (deprecated. More...

Inheritance diagram for CameraDescriptionDigitalBase:

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.
	hObj (self)
	Returns a unique identifier for the component collection referenced by this object.
	importDescription (self)
	Updates a camera description with the data stored in a previous session or with the original default data.
	restoreDefault (self)
	Restores the default for every component of this collection.

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.
	bayerParity = property(lib_mvIMPACT_acquire.CameraDescriptionDigitalBase_bayerParity_get, doc=)
	An enumerated integer property defining the start pixel for a camera delivering an unconverted bayer image.
	bitsPerPixel = property(lib_mvIMPACT_acquire.CameraDescriptionDigitalBase_bitsPerPixel_get, doc=)
	An integer property defining the number of bits per pixel currently transmitted by this camera.
	className = property (getClassName, None, None, None)
	A string property (read-only) which holds the class this description is belonging to.
	format = property(lib_mvIMPACT_acquire.CameraDescriptionDigitalBase_format_get, doc=)
	An enumerated integer property defining the data format the camera is sending image data.
	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.

Detailed Description

A base class to describe an arbitrary digital camera signal(Device specific interface layout only) (deprecated.

Deprecated

Beginning with the release of 3.0.0 of Impact Acquire everything specifically related to frame grabber boards will be considered as deprecated and might be removed without further notice!

This class provides access to all settings specific for digital video signals.

Note

This class will only be available if mvIMPACT.acquire.Device.interfaceLayout is set to mvIMPACT.acquire.dilDeviceSpecific before the device is opened.

Constructor & Destructor Documentation

__init__()

__init__	(		self,
		*	args,
		**	kwargs )

Member Function Documentation

copyDescription()

copyDescription ( self, newName )

inherited

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.

Note

This will NOT store the new description permanently. After the driver has been closed, this data will be lost. To store the new list in a way that it will be available the next time the driver/device is opened again, mvIMPACT.acquire.CameraDescriptionBase.exportDescription must be called with the handle of the newly created description after this function.

See also

mvIMPACT.acquire.CameraDescriptionBase.exportDescription,
mvIMPACT.acquire.CameraDescriptionBase.importDescription

Returns

• mvIMPACT.acquire.DMR_NO_ERROR if successful.
• mvIMPACT.acquire.DEV_INPUT_PARAM_INVALID if new name matches a description that is already existing.
• A negative error code as listed here: Error code list

Parameters

newName

[in] The name for the newly created camera description. This name MUST NOT match a description already existing.

exportDescription()

exportDescription ( self )

inherited

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.

• On Windows® camera descriptions will be stored under PUBLIC%/Documents/Balluff/ImpactAcquire/CameraFiles (or MVIMPACT_ACQUIRE_DATA_DIR%/CameraFiles, which will point to the same folder)
• On Unix based systems this directory will be /opt/ImpactAcquire/data/camerafiles
• On other platforms these files will end up in the current working directory.

This behaviour can be modified by writing the property mvIMPACT.acquire.Device.customDataDirectory before initialising the device.

See also

mvIMPACT.acquire.CameraDescriptionBase.copyDescription,
mvIMPACT.acquire.CameraDescriptionBase.importDescription

Returns

• mvIMPACT.acquire.DMR_NO_ERROR if successful.
• A negative error code as listed here: Error code list

getClassName()

getClassName ( self )

inherited

Returns the class this description is belonging to.

Returns

The class this description is belonging to.

hObj()

hObj ( self )

inherited

Returns a unique identifier for the component collection referenced by this object.

This handle will always reference an object of type mvIMPACT.acquire.ComponentList.

Returns

A unique identifier for the component referenced by this object.

importDescription()

importDescription ( self )

inherited

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.

• On Windows® camera descriptions MUST be stored under PUBLIC%/Documents/Balluff/ImpactAcquire/CameraFiles (or MVIMPACT_ACQUIRE_DATA_DIR%/CameraFiles, which will point to the same folder)
• n Unix based systems this directory will be /opt/ImpactAcquire/data/camerafiles
• On other platforms these files MUST be located in the current working directory.

This 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.

Note

In order not to bloat the device driver with redundant data it's wise only to store the descriptions needed for the application to run under this location.

Only camera descriptions supported by the capture device will be added to the device drivers internal list and will therefore be accessible via the mvIMPACT.acquire.CameraDescriptionManager.

To restore the default values valid during the driver was initialized the function mvIMPACT.acquire.ComponentCollection.restoreDefault can be used as well.

See also

mvIMPACT.acquire.CameraDescriptionBase.exportDescription,
mvIMPACT.acquire.CameraDescriptionBase.copyDescription

Returns

• mvIMPACT.acquire.DMR_NO_ERROR if successful.
• A negative error code as listed here: Error code list

restoreDefault()

restoreDefault ( self )

inherited

Restores the default for every component of this collection.

Calling this function will restore the default value for every component belonging to this collection.

Note

The caller must have the right to modify the component. Otherwise an exception will be thrown.

Returns

A const reference to the component.

Property Documentation

aoiHeight

aoiHeight = property(lib_mvIMPACT_acquire.CameraDescriptionBase_aoiHeight_get, doc=)

staticinherited

An integer property defining the number of active lines to capture from the camera.

aoiStartX

aoiStartX = property(lib_mvIMPACT_acquire.CameraDescriptionBase_aoiStartX_get, doc=)

staticinherited

An integer property defining the X-offset in pixels to the first active pixel to capture.

aoiStartY

aoiStartY = property(lib_mvIMPACT_acquire.CameraDescriptionBase_aoiStartY_get, doc=)

staticinherited

An integer property defining the Y-offset in lines to the first active line to capture.

aoiWidth

aoiWidth = property(lib_mvIMPACT_acquire.CameraDescriptionBase_aoiWidth_get, doc=)

staticinherited

An integer property defining the number of active pixels to capture per line.

bayerParity

bayerParity = property(lib_mvIMPACT_acquire.CameraDescriptionDigitalBase_bayerParity_get, doc=)

static

An enumerated integer property defining the start pixel for a camera delivering an unconverted bayer image.

Valid values for this property may be: mvIMPACT.acquire.bmpUndefined, mvIMPACT.acquire.bmpGR, mvIMPACT.acquire.bmpRG, mvIMPACT.acquire.bmpBG, mvIMPACT.acquire.bmpGB.

bitsPerPixel

bitsPerPixel = property(lib_mvIMPACT_acquire.CameraDescriptionDigitalBase_bitsPerPixel_get, doc=)

static

An integer property defining the number of bits per pixel currently transmitted by this camera.

className

className = property (getClassName, None, None, None)

staticinherited

A string property (read-only) which holds the class this description is belonging to.

See mvIMPACT.acquire.CameraDescriptionBase.getClassName()

format

format = property(lib_mvIMPACT_acquire.CameraDescriptionDigitalBase_format_get, doc=)

static

An enumerated integer property defining the data format the camera is sending image data.

Valid values for this property may be: mvIMPACT.acquire.cdfUnknown, mvIMPACT.acquire.cdfMono, mvIMPACT.acquire.cdfBayer, mvIMPACT.acquire.cdfBayerPacked, mvIMPACT.acquire.cdfRGB, mvIMPACT.acquire.cdfYUV.

interlacedType

interlacedType = property(lib_mvIMPACT_acquire.CameraDescriptionBase_interlacedType_get, doc=)

staticinherited

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.

name

name = property(lib_mvIMPACT_acquire.CameraDescriptionBase_name_get, doc=)

staticinherited

A string property read-only containing the name of this camera description list.

thisown

thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

static

videoOutput

videoOutput = property(lib_mvIMPACT_acquire.CameraDescriptionBase_videoOutput_get, doc=)

staticinherited

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.

Note

This property will be (read-only) for camera descriptions of type mvIMPACT.acquire.CameraDescriptionCameraLink and mvIMPACT.acquire.CameraDescriptionSDI as for these camera types the video output depends on certain other parameters according to the corresponding standard.