Impact Acquire SDK Java
CameraDescriptionCameraLink Class Reference

A class to describe a CameraLink® compliant camera(Device specific interface layout only) (deprecated. More...

Inheritance diagram for CameraDescriptionCameraLink:
[legend]

Public Member Functions

int copyDescription (String newName)
 Creates a new camera description list as a copy of the current one.
 
synchronized void delete ()
 
int exportDescription ()
 Stores the current camera description on disk.
 
PropertyI getAoiHeight ()
 An integer property defining the number of active lines to capture from the camera.
 
PropertyI getAoiStartX ()
 An integer property defining the X-offset in pixels to the first active pixel to capture.
 
PropertyI getAoiStartY ()
 An integer property defining the Y-offset in lines to the first active line to capture.
 
PropertyI getAoiWidth ()
 An integer property defining the number of active pixels to capture per line.
 
PropertyI getBayerParity ()
 An enumerated integer property defining the start pixel for a camera delivering an unconverted bayer image.
 
PropertyI getBitsPerPixel ()
 An integer property defining the number of bits per pixel currently transmitted by this camera.
 
String getClassName ()
 Returns the class this description is belonging to.
 
PropertyI getDataValid ()
 An enumerated integer property defining the way this camera transmits the data valid (DVAL) signal.
 
PropertyI getFormat ()
 An enumerated integer property defining the data format the camera is sending image data.
 
PropertyI getInterlacedType ()
 An enumerated integer property defining how the camera transmits image data.
 
PropertyS getName ()
 A string property read-only containing the name of this camera description list.
 
PropertyI getPixelsPerCycle ()
 An integer property defining the number of pixels per clock cycle transmitted by this camera.
 
PropertyI getScanMode ()
 An enumerated integer property providing information about the sensor of this camera.
 
PropertyI getTapsXGeometry ()
 An enumerated integer property defining the way this camera transmits the pixel data in X direction.
 
PropertyI getTapsYGeometry ()
 An enumerated integer property defining the way this camera transmits the pixel data in Y direction.
 
PropertyI getVideoOutput ()
 An enumerated integer property defining the type of video outputs this camera offers.
 
int hObj ()
 Returns a unique identifier for the component collection referenced by this object.
 
int importDescription ()
 Updates a camera description with the data stored in a previous session or with the original default data.
 
ComponentCollection restoreDefault ()
 Restores the default for every component of this collection.
 

Protected Member Functions

 CameraDescriptionCameraLink (long cPtr, boolean cMemoryOwn)
 
void finalize ()
 

Static Protected Member Functions

static long swigRelease (CameraDescriptionBase obj)
 
static long swigRelease (CameraDescriptionCameraLink obj)
 
static long swigRelease (CameraDescriptionDigitalBase obj)
 
static long swigRelease (CameraDescriptionDigitalBase2 obj)
 
static long swigRelease (ComponentCollection obj)
 

Protected Attributes

transient boolean swigCMemOwn
 

Detailed Description

A class to describe a CameraLink® compliant camera(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 CameraLink® compliant cameras.

Note
This class will only be available if mvIMPACT.acquire.Device.getInterfaceLayout() is set to mvIMPACT.acquire.TDeviceInterfaceLayout.dilDeviceSpecific before the device is opened.

Constructor & Destructor Documentation

◆ CameraDescriptionCameraLink()

CameraDescriptionCameraLink ( long cPtr,
boolean cMemoryOwn )
protected

Member Function Documentation

◆ copyDescription()

int copyDescription ( String 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
Parameters
newName[in] The name for the newly created camera description. This name MUST NOT match a description already existing.

◆ delete()

synchronized void delete ( )

Reimplemented from CameraDescriptionDigitalBase2.

◆ exportDescription()

int exportDescription ( )
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.getCustomDataDirectory() before initialising the device.

See also
mvIMPACT.acquire.CameraDescriptionBase.copyDescription,
mvIMPACT.acquire.CameraDescriptionBase.importDescription
Returns

◆ finalize()

void finalize ( )
protected

Reimplemented from CameraDescriptionDigitalBase2.

◆ getAoiHeight()

PropertyI getAoiHeight ( )
inherited

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

◆ getAoiStartX()

PropertyI getAoiStartX ( )
inherited

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

◆ getAoiStartY()

PropertyI getAoiStartY ( )
inherited

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

◆ getAoiWidth()

PropertyI getAoiWidth ( )
inherited

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

◆ getBayerParity()

PropertyI getBayerParity ( )
inherited

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

Valid values for this property are defined by the enumeration mvIMPACT.acquire.TBayerMosaicParity.

◆ getBitsPerPixel()

PropertyI getBitsPerPixel ( )
inherited

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

◆ getClassName()

String getClassName ( )
inherited

Returns the class this description is belonging to.

Returns
The class this description is belonging to.

◆ getDataValid()

PropertyI getDataValid ( )

An enumerated integer property defining the way this camera transmits the data valid (DVAL) signal.

Valid values for this property are defined by the enumeration mvIMPACT.acquire.TCameraLinkDataValidMode.

◆ getFormat()

PropertyI getFormat ( )
inherited

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

Valid values for this property are defined by the enumeration mvIMPACT.acquire.TCameraDataFormat.

◆ getInterlacedType()

PropertyI getInterlacedType ( )
inherited

An enumerated integer property defining how the camera transmits image data.

Valid values for this property are defined by the enumeration mvIMPACT.acquire.TCameraInterlacedType.

◆ getName()

PropertyS getName ( )
inherited

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

◆ getPixelsPerCycle()

PropertyI getPixelsPerCycle ( )
inherited

An integer property defining the number of pixels per clock cycle transmitted by this camera.

This corresponds the number of taps used by the camera in the described configuration.

◆ getScanMode()

PropertyI getScanMode ( )
inherited

An enumerated integer property providing information about the sensor of this camera.

Valid values for this property are defined by the enumeration mvIMPACT.acquire.TCameraScanMode.

◆ getTapsXGeometry()

PropertyI getTapsXGeometry ( )

An enumerated integer property defining the way this camera transmits the pixel data in X direction.

Valid values for this property are defined by the enumeration mvIMPACT.acquire.TCameraTapsXGeometry.

◆ getTapsYGeometry()

PropertyI getTapsYGeometry ( )

An enumerated integer property defining the way this camera transmits the pixel data in Y direction.

Valid values for this property are defined by the enumeration mvIMPACT.acquire.TCameraTapsYGeometry.

◆ getVideoOutput()

PropertyI getVideoOutput ( )
inherited

An enumerated integer property defining the type of video outputs this camera offers.

Valid values for this property are defined by the enumeration mvIMPACT.acquire.TCameraOutput.

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.

◆ hObj()

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

int importDescription ( )
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.getCustomDataDirectory() 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.getType().

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

◆ restoreDefault()

ComponentCollection restoreDefault ( )
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.

◆ swigRelease() [1/5]

static long swigRelease ( CameraDescriptionBase obj)
staticprotectedinherited

◆ swigRelease() [2/5]

static long swigRelease ( CameraDescriptionCameraLink obj)
staticprotected

◆ swigRelease() [3/5]

static long swigRelease ( CameraDescriptionDigitalBase obj)
staticprotectedinherited

◆ swigRelease() [4/5]

static long swigRelease ( CameraDescriptionDigitalBase2 obj)
staticprotectedinherited

◆ swigRelease() [5/5]

static long swigRelease ( ComponentCollection obj)
staticprotectedinherited

Member Data Documentation

◆ swigCMemOwn

transient boolean swigCMemOwn
protectedinherited