Personal tools
You are here: Home Device classes Abstract classes Ccd
Log in


Forgot your password?
 

Ccd

Abstract class for Ccd's

Ccd's are 2D detectors. They can be exposed for a certain number of seconds or fractions of seconds. The Ccd is triggered internally or externally. Ccd's can control a shutter. The shutter needs to be completely closed before reading out the pixels. A Ccd can be programmed to take a single or multiple images.

Version 1


Commands


The following commands must be implemented :

  1. Start - the ccd will start taking an exposure as soon as the trigger is ready (state = ON)
  2. Stop - stop the ccd from exposing (state = OFF)
  3. Reset - reset the ccd (state = OFF)
  4. WriteFile - write the current image to a file using the parameters in FileParams

Attributes


The following attributes must be implemented :

Attribute
TypeAccess Description
    
ExposureDOUBLERWexposure time in seconds
RoiSPECTRUM of LONGRWregion of interest [x1,y1,x2,y2]
BinningSPECTRUM of SHORT
 RWbinning in x and y
TriggerSHORTRWtrigger mode
WidthLONGROwidth of current image in pixels
HeightLONGROheight of current image in pixels
FramesLONGRWnumber of images to acquire
DepthSHORTROdepth of image in bytes
FileParamsSPECTRUM of STRINGRWfile parameters [directory, prefix, number, suffix, overwrite flag, number format]
FileFormatSTRINGRWfile format for writing e.g. "pgm", "edf", "nxs" etc.
ImageIMAGE of UCHARROimage as string of bytes in Intel format (little endian)
ImageFormatSTRINGROformat of image e.g. "mono16", "rgb"
ImageCounterLONGROnumber of acquired images
JpegImageIMAGE of UCHARROimage in compressed JPEG format
JpegQualitySHORT RWjpeg image quality
JpegCompressionBOOLEANRWjpeg image compression on


States


The following states must be implemented :

  1. ON - ccd is acquiring an image
  2. OFF - ccd is ready to start acquiring an image
  3. FAULT - ccd is in fault

Implementations


The following device servers implement the Ccd abstract interface :

  • Ccd1394 - for IEEE1394 (firewire) cameras
  • Pvcam - for cameras which can be controlled with the PVCAM SDK from Photometrics and Princeton
  • Falcon - for the Falcon video grabber
  • Pixium - for the Pixium pixel detector

Clients


The following client programs depend on the Ccd interface :

  • ccdpanel in atk
  • imagej ccd plugin
  • workbench ccd plugin
  • bpmccd device server
  • tacoccd device server

Contact


Please contact Andy Gotz (andy dot gotz at esrf dot fr) or tango at esrf dot fr if you want to make proposals to change this interface or have questions about it.
Document Actions