DexelaDetector API: DexDefs.h File Reference

Dexela API

DexDefs.h File Reference
#include "DexDefines.h" #include "windows.h"

Go to the source code of this file.

Classes

struct  DevInfo
 A structure to hold device information. More...
 
struct  GeometryCorrectionParams
 A structure used to specify the new image dimensions for geometry correction More...
 
struct  DetStatus
 Structure to hold the detector current status. More...
 

Enumerations

enum  DetectorInterface { CL, GIGE }
 An enumeration of detector interface types. More...
 
enum  TransportLib { Pleora, Epix }
 An enumeration of detector interface types. More...
 
enum  bins {
  x11 = 1, x12, x14, x21,
  x22, x24, x41, x42,
  x44, ix22, binsError
}
 An enumeration of the different bin levels available More...
 
enum  FileType { SMV, TIF, HIS, UNKNOWN }
 An enumeration of file types More...
 
enum  Derr {
  SUCCESS, NULL_IMAGE, WRONG_TYPE, WRONG_DIMS,
  BAD_PARAM, BAD_COMMS, BAD_TRIGGER, BAD_COMMS_OPEN,
  BAD_COMMS_WRITE, BAD_COMMS_READ, BAD_FILE_IO, BAD_BOARD,
  OUT_OF_MEMORY, EXPOSURE_FAILED, BAD_BIN_LEVEL
}
 Enumration for error codes returned from the API functions More...
 
enum  FullWellModes { Low =0, High, FullWellModesError }
 An enumeration of the available full well modes More...
 
enum  pType { u16 = 2, flt = 4, u32 = 6 }
 Enumneration of pixel types More...
 
enum  ExposureModes { Expose_and_read, Sequence_Exposure, Frame_Rate_exposure, Preprogrammed_exposure }
 An enumeration of exposure modes. More...
 
enum  ExposureTriggerSource { Ext_neg_edge_trig, Internal_Software, Ext_Duration_Trig }
 An enumeration of exposure trigger sources. More...
 
enum  ReadoutModes { ContinuousReadout, IdleMode, ReadoutModeError }
 An enumeration of ReadOut modes. More...
 
enum  ResolutionModes { pixelsize50micron = 1, pixelsize100micron = 0, ResolutionModesError }
 An enumeration of the available resolution modes More...
 
enum  DexImageTypes {
  Data = 0, Offset = 1, Gain = 2, Defect = 3,
  UnknownType = 0xFF
}
 An enumeration of the different image types. More...
 

Enumeration Type Documentation

enum bins

An enumeration of the different bin levels available

Enumerator
x11 

Unbinned

x12 

Binned vertically by 2

x14 

Binned vertically by 4

x21 

Binned horizontally by 2

x22 

Binned horizontally by 2 and vertically by 2

x24 

Binned horizontally by 2 and vertically by 4

x41 

Binned horizontally by 4

x42 

Binned horizontally by 4 and vertically by 2

x44 

Binned horizontally by 4 and vertically by 4

ix22 

Digital 2x2 binning

binsError 

Indcates an error

enum Derr

Enumration for error codes returned from the API functions

Enumerator
SUCCESS 

The operation was successful

NULL_IMAGE 

The image pointer was NULL

WRONG_TYPE 

The image pixel type was wrong for the operation requested

WRONG_DIMS 

The image dimesions were wrong for the operation requested

BAD_PARAM 

One or more parameters were incorrect

BAD_COMMS 

The communications channel is not open or could not be openned

BAD_TRIGGER 

An invalid trigger source was requested

BAD_COMMS_OPEN 

The communications channel failed to open

BAD_COMMS_WRITE 

A failure in a detector write command occurred

BAD_COMMS_READ 

A failure in a detector read command occurred

BAD_FILE_IO 

An error occurred openning or reading from a file

BAD_BOARD 

The software failed to open the PC driver or frame grabber

OUT_OF_MEMORY 

A function call was not able to reserve the memory it required

EXPOSURE_FAILED 

Exposure Acquisition failed

BAD_BIN_LEVEL 

Incorrect bin level specified

An enumeration of detector interface types.

Enumerator
CL 

CameraLink

GIGE 

Gigabit Ethernet

An enumeration of the different image types.

Enumerator
Data 

A data image

Offset 

An offset (dark) image

Gain 

An gain (flood) image

Defect 

A defect-map image

UnknownType 

The type of the image is not known

An enumeration of exposure modes.

Enumerator
Expose_and_read 

The detector should clear the sensor and wait for exposure time to pass before reading the detector image.

Sequence_Exposure 

The detector should take a sequence of images with no gaps.

Frame_Rate_exposure 

The detector should take a sequence of images with a specified gap no less than the minimum exposure timeforthe bin level.

Preprogrammed_exposure 

The detector should take a number of images with preset exposure times without a gap..

An enumeration of exposure trigger sources.

Enumerator
Ext_neg_edge_trig 

Trigger on negative edge

Internal_Software 

Trigger using software

Ext_Duration_Trig 

Detector exposure duration and trigger contorlled externally

enum FileType

An enumeration of file types

Enumerator
SMV 

SMV

TIF 

TIFF

HIS 

HIS

UNKNOWN 

Unknown/Unsupported

An enumeration of the available full well modes

Enumerator
Low 

The low noise reduced dynamic range mode

High 

The normal full well mode

FullWellModesError 

Indicates an error

enum pType

Enumneration of pixel types

Enumerator
u16 

A pixel type of 16-bit unsigned short

flt 

A pixel type of 32-bit floating point

u32 

A pixel type of 32-bit unsigned int </summary

An enumeration of ReadOut modes.

Enumerator
ContinuousReadout 

The sensor is continuously read-out using the minimum read-out time. On request an image will be transmitted. A frame request can be an external trigger pulse, internal trigger or software trigger

IdleMode 

The sensor is only read out (using the minimum frame time) on request. The read-out will be followed by the transmission of the image. A frame request can be an external trigger pulse, internal trigger or software trigger

ReadoutModeError 

Indicates an error

An enumeration of the available resolution modes

Enumerator
pixelsize50micron 

The 100micron mode

pixelsize100micron 

The 50micron mode

ResolutionModesError 

Indicates an error

An enumeration of detector interface types.

Enumerator
Pleora 

Pleora type GigE transport library

Epix 

Epix FG CameraLink transport library

Generated on Tue Nov 25 2014 10:22:44 for DexelaDetector API by   doxygen 1.8.7