This is historical information of device classes implemented in TangoVimba device server.

Use this link to find the valid information.

Development status: Released
Information status: Updated

Contact:


Class Description

Tango device server for Allied Vision GigE cameras

Families: Acquisition

Key words:

Platform: Unix Like

Language: Cpp

License: GPL

Contact:

Hardware

Manufacturer: Allied Vision

Product:

https://www.alliedvision.com

Bus: Ethernet

Class interface

Attributes:

Name Description
FileDirScalar: DevString directory path to store image files in - the directory must exist - the server will check if the user running the server has write permissions for this directory, if not, the device will go to state fault / throw an exception - the attribute is memorized (last written value stored in tango db and read from there at server startup)
FilePrefixScalar: DevString String prefixed to file names (memorized attribute)
FileStartNumScalar: DevULong Start number for files: - not initialized - incremented after every file - range 0 - 999999
FilePostfixScalar: DevString file postfix (determines file format). Supported file formats at time of writing are: bmp jpg/jpeg png ppm pbm pgm tif/tiff xbm xpm nx: nexus hdf5 files
FileSavingScalar: DevBoolean if set to true, acquired images will be saved to files. Can be set / reset during acquisition.
TuneModeScalar: DevUShort Mode for adjusting camera frame rate: 0 = no adjustment 1 = frame rate will be set to the maximum number of frames the server can process 2 = frame rate will be set so that the server will consume max. MaxLoad % cpu time
MaxLoadScalar: DevDouble Max. allowed cpu load if TuneMode is set to 2
ViewingModeScalar: DevShort How camera data are written to attributes: 0 : nothing is written to any attributes 1: data are converted to 8-bit greyscale and written to Image8 2: data are converted to 16-bit greyscale and written to Image16 3: data are not converted and written to ImageRaw (ImageRaw dimensions will alway be ImageSize (in bytes) x 1). 4: data are converted to RGB-JPEG and written to ImageEnc 5: ata are converted to RGBA and written to ImageRGB Note: - not all pixel formats can be converted to 16-bit greyscale. An exception will be thrown if the current camera pixel format cannot be converted. - pixel formats Mono10/12/14/16 will not be converted at all when ViewingMode is 2. Data are written to the attribute `as is`.
BinCommentScalar: DevString This goes as a comment into files of type nx (c.f FilePostfix). Max. length 256 chars.
ImageEncScalar: DevEncoded JPEG encoded representation of the acquired image(s). Attribute is written if ViewingMode is set to 4.
FramesPerNXFileScalar: DevULong Max. number of frames written to one file if file format is nx. A new file will be created whenever this value is surpassed. 0 means all frames go into one file.
NXFileCompressionScalar: DevShort Caveat utilitor ! This works, but CPU load and memory usage might increase a lot. And if you collect files with compression enabled for a long time the OS might kill the server. It all depends on PixelFomat, ImageSize and FrameRate. So: test before using this in experiment setups.
BayerToGrayScalar: DevBoolean if set to true, bayer pixel formats will be saved as greyscale images. Bayer<XY>8 is saved as a 8bit-mono image, Bayer<XY>10-16 as 16bit-mono image. Be aware that saving 16bit mono images is only possible with formats tiff and nx.
QueuedFramesScalar: DevULong64 Number of frames stored in the servers queue which have not been processed (i.e. written to file or to attribute). Normally this value should be small (while acquisition is running it will never go below 1) It may fluctate a little, but should not be constantly increasing. If this is the case, the server will use up memory and eventually be killed by the OS. To remedy this, your options are - lower the framerate - or set property QueueSizeMax to a value > 0 (and read the docs) - or buy a faster computer
MaxQueuedFramesScalar: DevULong64 Maximum number of frames stored in the servers queue which had not been processed (i.e. written to file or to attribute). If this value keeps on increasing while acquisition is running make things run slower. Otherwise the server will use up all the memory there is. The servers maximum queue size can be set with property QueueSizeMax.
DiscardedFramesScalar: DevULong64 Number of frames not put into the servers. Discarding frames may happen if the servers internal queue size was limited with property QueueSizeMax and the queue is filled up to this size when a frame arrives from the camera.
FramesProcessedScalar: DevULong64 Number of frames written to file / attribute and removed from the servers internal queue
MaxFramesPerQueueScalar: DevULong64 Maximum number of frames which can be stored in the servers queue. The number depends on - the size you set for property QueueSizeMax - the selected pixelformat - the size of the image
FramesPerSingleAcquisitionScalar: DevULong Max. number of frames to collect for a call of StartSingleAcquisition. The server will reset this value to 1 if you run StartAcquisition.
BrokenFramesScalar: DevULong64 Number of invalid frames received from the camera. The value will be 0 at server start. It`s writable so you can reset it.
DisplayBrokenFramesScalar: DevBoolean If set to true, broken frames (where the image data are all set to 0, i.e. a black image) will be written to the Image<X> attribute during acquisition. The attribute quality will be set to INVALID. Otherwise they will be skipped.
StoreBrokenFramesScalar: DevBoolean If set to true, broken frames will be written files. In nx files, the value in `validity` will contain a value < 0, the image data will be set to 0. In other files, only this value will be written to the file, the file will contain no image data. If set to false, broken frames will be skipped.
Image8Image: DevUChar Array of unsigned char representing the acquired image(s). Pixel data are converted to 8-bit greyscale. Attribute is written if ViewingMode is set to 1.
Image16Image: DevUShort Array of unsigned short representing the acquired image(s). Pixel data will be converted to 16-bit greyscale. Attribute is written if ViewingMode is set to 2.
ImageRawImage: DevUChar Array of unsigned char representing the acquired raw image date. ImageRaw dimensions will always be ImageSize (in bytes) x 1) Attribute is written if ViewingMode is set to 3.
ImageRGBImage: DevULong Array of unsigned int representing the acquired image(s) in RGB format. Pixel data will be converted to 32-bit RGB Attribute is written if ViewingMode is set to 5.

Commands:

Name Description
StateInput: DevVoid
Output: State
Device state		 This command gets the device state (stored in its device_state data member) and returns it to the caller.
StatusInput: DevVoid
Output: ConstDevString
Device status		 This command gets the device status (stored in its device_status data member) and returns it to the caller.
StartAcquisitionInput: DevVoid
Output: DevVoid		 Start continous image acquisition
StartSingleAcquisitionInput: DevVoid
Output: DevVoid		 Start single acquisition. Acquisition will stop automatically after number of requested images (c.f. attribute FramesPerSingleAcquisition) is collected.
AbortAcquisitionInput: DevVoid
Output: DevVoid		 Abort continous image acquisition immediately (all open files will be closed, frames in bufffer which were not written yet will be discarded)
StopAcquisitionInput: DevVoid
Output: DevVoid		 Stop continous image acquisition. Frames in the buffer tagged for writing to files will be written, while this happens the device is in state EXTRACT.
SaveNextImageInput: DevBoolean
true: increment FileStartNum, append index number to filename false: do not increment FileStartNum, do not append index number to filename
Output: DevVoid		 Will save the next frame coming in from the camera while the acquisition is running and without interrupting it. Settings of FileDir/FilePrefix/FilePostfix are taken into respect. If input argument is true, FileStartNum will be incremented and an index number will be appended to the filename. Otherwise not. Use this to take a `snapshot` if you run acquisition without FileSaving set to true.
SoftTriggerInput: DevVoid
Output: DevVoid		 Generate a software trigger. To make use of this command - add `TriggerSource` to the VisibleAttributes property - add `TriggerMode` to the VisibleAttributes property - restart the server - set attribute `TriggerSource` to `Software` - set attribute `TriggerMode` to `On` - run StartAcquisition If you then call this command, the camera will send an image which will be processed by the server according to the setting of `FileSaving` and `ViewingMode`.

Pipes:

Name Description

Properties:

Name Description
DynAttrListArray of DevString for internal use only
VisibleAttributesArray of DevString Since different cameras support different features (and the same feature may even have different names on different cameras), camera features are dynamically converted into device attributes. Converting all available camera features into attributes will create a quite lengthy and cluttered list, so you can put those features you want to see as device attributes into this list. Only the features mentioned here will be shown as attributes. To find out about the available features of a camera either use a program like VimbaViewer or leave this list empty. Then all features will be shown as attributes. For features which are of type enumeration (e.g. PixelFormat) an additional read-only attribute <FeatureName>_Values will be created. This shows the possible values for this feature on this camera.
FrameBuffersDevUShort Number of frame buffers for image acquistion (defaults to 4)
GainFeatureNameDevString Depending on the camera type the name of the Gain feature differs(e,g. `Gain`, `GainRaw`). Please check for the camera you are using and enter the appropriate string here.
DeviceIDDevString Identifier of camera, this can be: - the mac address (notation e.g. 000F3101C94A, no `-` or `:` between digits) - the ID as reported by Vimba (e.g. DEV_000F3101C94A) - the serial number (e.g. 02-2110A-07625) (use of ip address as identifier is not supported - hot plugging won`t work with ip address)
QueueSizeMaxDevUShort Maximum memory siz of the servers internal queue in megabyte.. If frames arrive when this limit is hit they will be discarded. Setting value to 0 disables internal queue size restriction (but watch out for process memory usage).

25 Jun 2022, DS Admin
Updated:
The device class has been updated.
You can see previous version here .


7 May 2022, DS Admin
Updated:
The device class has been updated.
You can see previous version here .


1 May 2021, DS Admin
Updated:
The device class has been updated.
You can see previous version here .


24 Apr 2021, DS Admin
Updated:
The device class has been updated.
You can see previous version here .


10 Apr 2021, DS Admin
Updated:
A device class has been added.
You are looking at this version now.


10 Apr 2021, DS Admin
Updated:
The device class has been updated.
You can see previous version here .


6 Mar 2021, DS Admin
Updated:
The device class has been updated.
You can see previous version here .


13 Feb 2021, DS Admin
Updated:
The device class has been updated.
You can see previous version here .


6 Feb 2021, DS Admin
Updated:
The device class has been updated.
You can see previous version here .


30 Jan 2021, DS Admin
Updated:
The device class has been updated.
You can see previous version here .


16 Jan 2021, DS Admin
Updated:
The device class has been updated.
You can see previous version here .


19 Dec 2020, DS Admin
Updated:
The device class has been updated.
You can see previous version here .


21 Nov 2020, DS Admin
Updated:
The device class has been updated.
You can see previous version here .


24 Oct 2020, DS Admin
Updated:
The device class has been updated.
You can see previous version here .


4 Jul 2020, DS Admin
Updated:
The device class has been updated.
You can see previous version here .


4 Apr 2020, DS Admin
Updated:
The device class has been updated.
You can see previous version here .


7 Mar 2020, DS Admin
Updated:
The device class has been updated.
You can see previous version here .


15 Jun 2019, DS Admin
Updated:
The device class has been updated.
You can see previous version here .


9 Mar 2019, DS Admin
Updated:
The device class has been updated.
You can see previous version here .


1 Dec 2018, DS Admin
Updated:
The device class has been updated.
You can see previous version here .


21 Apr 2018, DS Admin
Updated:
The device class has been updated.
You can see previous version here .


7 Apr 2018, DS Admin
Updated:
The device class has been updated.
You can see previous version here .


7 Oct 2017, Piotr Goryl
Updated:
The device class has been updated.
You can see previous version here .


26 Aug 2017, Piotr Goryl
Updated:
The device class has been updated.
You can see previous version here .


29 Apr 2017, Piotr Goryl
Updated:
The device class has been updated.
You can see previous version here .


20 Apr 2017, Piotr Goryl
Updated:
The device class has been updated.
You can see previous version here .


23 Feb 2017, Piotr Goryl
Updated:
The device class has been updated.
You can see previous version here .


19 Jan 2017, Piotr Goryl
Updated:
The device server has been updated.
You can see previous version here .


2 Jan 2017, Piotr Goryl
Created:
The device server has been added to catalogue.
Added by:pgoryl2 on:10 Apr 2021, 3:10 a.m.