TangoVimba Class Attributes
Name
Inherited
Abstract
Attr. type
R/W type
Data type
Level
Description
FileDir false false Scalar READ_WRITE Tango::DEV_STRING OPERATOR 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)
FilePrefix false false Scalar READ_WRITE Tango::DEV_STRING OPERATOR String prefixed to file names (memorized attribute)
FileStartNum false false Scalar READ_WRITE Tango::DEV_ULONG OPERATOR Start number for files:

- not initialized

- incremented after every file

- range 0 - 999999
FilePostfix false false Scalar READ_WRITE Tango::DEV_STRING OPERATOR file postfix (determines file format). Supported file formats at time of writing are:

bmp
jpg/jpeg
png
ppm
pbm
pgm
tif/tiff
xbm
xpm
bin: raw data as received from camera
nx: nexus hdf5 files
FileSaving false false Scalar READ_WRITE Tango::DEV_BOOLEAN OPERATOR if set to true, acquired images will be saved to files. Can be set / reset during acquisition.
TuneMode false false Scalar READ_WRITE Tango::DEV_USHORT EXPERT 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
MaxLoad false false Scalar READ_WRITE Tango::DEV_DOUBLE EXPERT Max. allowed cpu load if TuneMode is set to 2
ViewingMode false false Scalar READ_WRITE Tango::DEV_SHORT OPERATOR 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`.
BinComment false false Scalar READ_WRITE Tango::DEV_STRING OPERATOR This goes as a comment into files of type nx (c.f FilePostfix). Max. length 256 chars.
ImageEnc false false Scalar READ Tango::DEV_ENCODED OPERATOR JPEG encoded representation of the acquired image(s).
Attribute is written if ViewingMode is set to 4.
FramesPerNXFile false false Scalar READ_WRITE Tango::DEV_ULONG OPERATOR 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.
NXFileCompression false false Scalar READ_WRITE Tango::DEV_SHORT OPERATOR 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.
BayerToGray false false Scalar READ_WRITE Tango::DEV_BOOLEAN OPERATOR if set to true, bayer pixel formats will be saved as greyscale images.
Bayer8 is saved as a 8bit-mono image, Bayer10-16 as 16bit-mono image.

Be aware that saving 16bit mono images is only possible with formats tiff and nx.
QueuedFrames false false Scalar READ Tango::DEV_ULONG64 OPERATOR 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
MaxQueuedFrames false false Scalar READ Tango::DEV_ULONG64 OPERATOR 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.
DiscardedFrames false false Scalar READ Tango::DEV_ULONG64 OPERATOR 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.
FramesProcessed false false Scalar READ Tango::DEV_ULONG64 OPERATOR Number of frames written to file / attribute and removed from the servers internal queue
MaxFramesPerQueue false false Scalar READ Tango::DEV_ULONG64 OPERATOR 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
FramesPerSingleAcquisition false false Scalar READ_WRITE Tango::DEV_ULONG OPERATOR Max. number of frames to collect for a call of StartSingleAcquisition.

The server will reset this value to 1 if you run StartAcquisition.
BrokenFrames false false Scalar READ_WRITE Tango::DEV_ULONG64 OPERATOR Number of invalid frames received from the camera. The value will be 0 at server start.
It`s writable so you can reset it.
DisplayBrokenFrames false false Scalar READ_WRITE Tango::DEV_BOOLEAN OPERATOR 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 attribute during acquisition. The attribute quality will be
set to INVALID.
Otherwise they will be skipped.
StoreBrokenFrames false false Scalar READ_WRITE Tango::DEV_BOOLEAN OPERATOR 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.
JPEGQuality false false Scalar READ_WRITE Tango::DEV_SHORT OPERATOR jpeg quality (0 - 100)
CrossWire false false Scalar READ_WRITE Tango::DEV_BOOLEAN OPERATOR If set to true, insert crosswire into image
CrossWidth false false Scalar READ_WRITE Tango::DEV_LONG OPERATOR Width of crosswire in pixels
CrossY false false Scalar READ_WRITE Tango::DEV_LONG OPERATOR Y Position of crosswire center (0 is middle of image)
CrossHeight false false Scalar READ_WRITE Tango::DEV_LONG OPERATOR Height of crosswire in pixels
CrossX false false Scalar READ_WRITE Tango::DEV_LONG OPERATOR X position of crosswire center (0 is middle of image)
CameraGone false false Scalar READ_WRITE Tango::DEV_BOOLEAN EXPERT Never write to this, for internal use only !!!
CrossBrightness false false Scalar READ_WRITE Tango::DEV_DOUBLE OPERATOR Crosswire brightness (in %, 0 = dark, 100 = white). If set to -1, the pixel values will be inverted
at crosswire pixels.
PushChangeEvent false false Scalar READ_WRITE Tango::DEV_BOOLEAN OPERATOR If set to false, the server will not push change events for the Image.. attributes.
This might make sense if there are no clients in use that subscribe to Image.. attributes and
you want to save on cpu time.
Image8 false false Image READ Tango::DEV_UCHAR OPERATOR 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.
Image16 false false Image READ Tango::DEV_USHORT OPERATOR 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.
ImageRaw false false Image READ Tango::DEV_UCHAR OPERATOR 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.
ImageRGB false false Image READ Tango::DEV_ULONG OPERATOR 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.





TangoVimba Class Dynamic Attributes
Name
Inherited
Abstract
Attr. type
R/W type
Data type
Level
Description
DoubleDynAttr false false Scalar READ_WRITE Tango::DEV_DOUBLE OPERATOR for internal use only
LongDynAttr false false Scalar READ_WRITE Tango::DEV_LONG OPERATOR for internal use only
StringDynAttr false false Scalar READ_WRITE Tango::DEV_STRING OPERATOR for internal use only
BoolDynAttr false false Scalar READ_WRITE Tango::DEV_BOOLEAN OPERATOR for internal use only
LongDynAttrR false false Scalar READ Tango::DEV_LONG OPERATOR for internal use only
DoubleDynAttrR false false Scalar READ Tango::DEV_DOUBLE OPERATOR for internal use only
BoolDynAttrR false false Scalar READ Tango::DEV_BOOLEAN OPERATOR for internal use only
StringDynAttrR false false Scalar READ Tango::DEV_STRING OPERATOR for internal use only
StringArrayDynAttrR false false Spectrum READ Tango::DEV_STRING OPERATOR for internal use only