DexDefines.h File Reference

Go to the source code of this file.

Macros
#define	TransMsgSize   1024
#define	DllExport   __declspec( dllimport )
#define	DllExportC   __declspec( dllimport )
#define	MAX_PIXEL_VAL   16383
	Maximum value for any pixel in detector output (14 bit) More...
#define	MIN_PIXEL_VAL   0
	Minimum allowable pixel value More...
#define	minTimeIncrement   0.01F
	The minimum time increment in ms for expose and read mode More...
#define	minTimeIncrement2   195.2F
	The minimum time increment in ns for line delay mode More...
#define	ExposureSleepTimems   10
	Variable to hold a time in ms used for sleeping threads in streaming mode. More...
#define	TimingResolution   100
	The resolution of the exposure time settings 1 for ms 100 for 0.01 ms More...
#define	RETURN_CHAR_LENGTH_CONST   50
#define	DarkPixelXOffset   2
	The offset in pixels in x when reaing dark pixel data More...
#define	DarkPixelYOffset   4
	The offset in pixels in y when reading dark pixel data More...
#define	AddrFPGANumber   126
	Register address for the FPGA version number of the detector More...
#define	AddrSerialNumber   125
	Register address for the serial number of the detector More...
#define	AddrModelNumber   124
	Register address for the model number of the detector More...
#define	AddrGapTime   18
	Register address for the gap time used in Frame Rate mode More...
#define	AddrNumberOfFrames   17
	Register address of number of frames register for use with sequence modes More...
#define	AddrFirmwareVersion   127
	Register address of firmware verion information More...
#define	AddrTriggerSource   0
	Register address of the Trigger Source bits More...
#define	AddrExposureTimeLow   11
#define	AddrExposureTimeHigh   12
#define	AddrExposureTime   12
	Register address of exposure time information in low res system More...
#define	AddrExposureTime2   13
	Register address of exposure time information in low res system for Line_Delay mode More...
#define	AddrExposureTime2Low   13
	Register address of low bytes of exposure time information for line delay mode More...
#define	AddrExposureTime2High   14
	Register address of high bytes of exposure time information for line delay mode More...
#define	AddrHorizontalBinReg   10
	Address of horizontal binning register More...
#define	AddrVerticalBinReg   9
	Address of vertical binning register More...
#define	AddrControlReg   0
	Address of control register More...
#define	AddrPPExposreTime1Low   27
	Register address of low bytes of pre-programmed exposure time 1 information More...
#define	AddrPPExposreTime1High   28
	Register address of high bytes of pre-programmed exposure time 1 information More...
#define	AddrPPExposreTime2Low   29
	Register address of low bytes of pre-programmed exposure time 2 information More...
#define	AddrPPExposreTime2High   30
	Register address of high bytes of pre-programmed exposure time 2 information More...
#define	AddrPPExposreTime3Low   31
	Register address of low bytes of pre-programmed exposure time 3 information More...
#define	AddrPPExposreTime3High   32
	Register address of high bytes of pre-programmed exposure time 3 information More...
#define	AddrPPExposreTime4Low   33
	Register address of low bytes of pre-programmed exposure time 4 information More...
#define	AddrPPExposreTime4High   34
	Register address of high bytes of pre-programmed exposure time 4 information More...
#define	SerialNumberReg1   0
	Address of serial number register 1 More...
#define	SerialNumberReg2   0
	Address of serial number register 2 More...
#define	SerialNumberReg3   0
	Address of serial number register 3 More...
#define	TemperatureReg   0
	Address of temperature register More...
#define	AddrWellReg   3
	Address of Well register More...
#define	AddrWellHigh   4
	Address of High Fullwell register More...
#define	AddrWellLow   65531
	Address of Low Fullwell register More...
#define	AddrSensorBinReg   3
	Address of sensor bin register More...
#define	AddrSensorBinReg2   5
	Address of sensor bin register 2 More...
#define	AddrNumLines   7
	Address of Numer of lines per sensor register More...
#define	AddrNumPixels   8
	Address of Number of pixels (per line) per sensor register More...
#define	SensorBinClear   65087
	Constant for clearing binning command More...
#define	DigitalBinBit   65533
	Constant for digital binning bit More...
#define	Sensor1x1   0
	Constant for 1x1 binning command More...
#define	Sensor1x2   0
	Constant for 1x2 binning command More...
#define	Sensor1x4   64
	Constant for 1x4 binning command More...
#define	Sensor2x1   128
	Constant for 2x1 binning command More...
#define	Sensor2x2   128
	Constant for 2x2 binning command More...
#define	Sensor2x4   192
	Constant for 2x4 binning command More...
#define	Sensor4x1   256
	Constant for 4x1 binning command More...
#define	Sensor4x2   256
	Constant for 4x2 binning command More...
#define	Sensor4x4   320
	Constant for 4x4 binning command More...
#define	BinCommit   514
	Constant for binning commit command More...
#define	AddrReadOutTime   410
	Readout time for the sensor, dynamically adapted to the read out mode (binning, ROI). Dependent on the implementation the value has to be muliplied by the factor ReadoutTimeFactor More...
#define	ReadoutTimeFactor1313   2
	ReadoutTimeFactor for Dexela 1313 More...
#define	AddrROIStartColumn   404
	Register address for the ROI OFFSET / first column: More...
#define	AddrROIwidth   405
	Register address for the width of the ROI stripe More...
#define	AddrROIStartRow   402
	Register address for the ROI OFFSET / first row: More...
#define	AddrROIheight   403
	Register address for the height of the ROI stripe More...
#define	AddrFrameCounter   63
	Register address for 16bit framecounter More...
#define	AddrFramePackingMode_ImageCountPerBlock   64
	Register address for frame packing mode: number of images per block More...
#define	AddrFramePackingMode_BlockHeightInRows   65
	Register address for frame packing mode: number of images per block More...
#define	AddrBuildDayAndMonth   38
	Register address storing day and month of the current firmware build More...
#define	AddrBuildYear   39
	Register address storing the year of the current firmware built More...
#define	AddrBuildTime   40
	Register address storing the time of the current firmware built More...
#define	AddrReadOutTimeLow   55
	Register address storing the first 16bit of detector read-out time will be retrieved in ticks (1 tick = ReadOutTimeBase1313 ns) More...
#define	AddrReadOutTimeHigh   56
	Register address storing the second 16bit of detector read-out time will be retrieved in ticks (1 tick = ReadOutTimeBase1313 ns) More...
#define	AddrControlReg1   1
	Address of control register 1 More...
#define	AddrFeaturesReg0   36
	Address of features register 0 More...
#define	AddrFeaturesReg1   37
	Address of features register 1 More...
#define	AVGERAGED_FLAG   1
#define	FIXED_FLAG   2
#define	LINEARIZED_FLAG   4
#define	SORTED_FLAG   8
#define	CLEAR_SORTED_FLAG   0xFFF7
#define	OPERATION_KNOWN_FLAG   0x8000
#define	CLEAR_OPERATION_KNOWN_FLAG   0x7FFF
#define	NOOP_FLAG   0x0
#define	XIS_OFFSET_CORRECTED_FLAG   1
#define	XIS_GAIN_CORRECTED_FLAG   2
#define	XIS_DEFECT_CORRECTED_FLAG   4
#define	XIS_MULTIGAIN_CORRECTED   8 /*this is not currently used appart from in XIS*/
#define	DEX_OFFSET_CORRECTED_FLAG   16 /*Dexela versions of the corrections*/
#define	DEX_GAIN_CORRECTED_FLAG   32
#define	DEX_DEFECT_CORRECTED_FLAG   64
#define	DEX_EXTRA_PARAMS_FLAG   0x4000 /*this flag will indicate the presence of new parameters (e.g. model, binning, operations) in the HIS header*/
#define	CORRECTION_KNOWN_FLAG   0x8000
#define	UNCORRECTED_FLAG   0x0
#define	TIFFTAG_DEX_CORRECTION_FLAGS   34595 /* New tiff-tag for storing correction flags parameter */
#define	TIFFTAG_DEX_OPERATION_FLAGS   34596 /* New tiff-tag for storing operation flags parameter */
#define	TIFFTAG_DEX_IMAGE_TYPE   34597 /* New tiff-tag for storing image-type parameter */
#define	DEX_DATA_IMAGE   0 /* regular data image */
#define	DEX_OFFSET_IMAGE   1 /* offset data image */
#define	DEX_GAIN_IMAGE   2 /* gain data image */
#define	DEX_DEFECT_MAP   3 /* defect map image */
#define	DEX_UNKONWN_TYPE_IMAGE   0xFF /* type of image is unknown */
#define	TIFFTAG_DEX_MODEL_NUM   34598 /* New tiff-tag for storing image-type parameter */
#define	TIFFTAG_DEX_BIN_FMT   34599
#define	TIFFTAG_ROI_START_COL   34600
#define	TIFFTAG_ROI_START_ROW   34601
#define	TIFFTAG_DEFECT_FLAGS   34602
#define	MAX_REG_ADDR   999
#define	MAX_REG_VALUE   0xFFFF

Typedefs
typedef unsigned short	ushort
typedef unsigned long	ulong
typedef unsigned char	byte

Macro Definition Documentation

#define AddrBuildDayAndMonth   38

Register address storing day and month of the current firmware build

#define AddrBuildTime   40

Register address storing the time of the current firmware built

#define AddrBuildYear   39

Register address storing the year of the current firmware built

#define AddrControlReg   0

Address of control register

#define AddrControlReg1   1

Address of control register 1

#define AddrExposureTime   12

Register address of exposure time information in low res system

#define AddrExposureTime2   13

Register address of exposure time information in low res system for Line_Delay mode

#define AddrExposureTime2High   14

Register address of high bytes of exposure time information for line delay mode

#define AddrExposureTime2Low   13

Register address of low bytes of exposure time information for line delay mode

#define AddrFeaturesReg0   36

Address of features register 0

#define AddrFeaturesReg1   37

Address of features register 1

#define AddrFirmwareVersion   127

Register address of firmware verion information

#define AddrFPGANumber   126

Register address for the FPGA version number of the detector

REGISTER CONSTANTS/////////////////////////

#define AddrFrameCounter   63

Register address for 16bit framecounter

#define AddrFramePackingMode_BlockHeightInRows   65

Register address for frame packing mode: number of images per block

#define AddrFramePackingMode_ImageCountPerBlock   64

Register address for frame packing mode: number of images per block

#define AddrGapTime   18

Register address for the gap time used in Frame Rate mode

#define AddrHorizontalBinReg   10

Address of horizontal binning register

#define AddrModelNumber   124

Register address for the model number of the detector

#define AddrNumberOfFrames   17

Register address of number of frames register for use with sequence modes

#define AddrNumLines   7

Address of Numer of lines per sensor register

#define AddrNumPixels   8

Address of Number of pixels (per line) per sensor register

#define AddrPPExposreTime1High   28

Register address of high bytes of pre-programmed exposure time 1 information

#define AddrPPExposreTime1Low   27

Register address of low bytes of pre-programmed exposure time 1 information

#define AddrPPExposreTime2High   30

Register address of high bytes of pre-programmed exposure time 2 information

#define AddrPPExposreTime2Low   29

Register address of low bytes of pre-programmed exposure time 2 information

#define AddrPPExposreTime3High   32

Register address of high bytes of pre-programmed exposure time 3 information

#define AddrPPExposreTime3Low   31

Register address of low bytes of pre-programmed exposure time 3 information

#define AddrPPExposreTime4High   34

Register address of high bytes of pre-programmed exposure time 4 information

#define AddrPPExposreTime4Low   33

Register address of low bytes of pre-programmed exposure time 4 information

#define AddrReadOutTime   410

Readout time for the sensor, dynamically adapted to the read out mode (binning, ROI). Dependent on the implementation the value has to be muliplied by the factor ReadoutTimeFactor

#define AddrReadOutTimeHigh   56

Register address storing the second 16bit of detector read-out time will be retrieved in ticks (1 tick = ReadOutTimeBase1313 ns)

#define AddrReadOutTimeLow   55

Register address storing the first 16bit of detector read-out time will be retrieved in ticks (1 tick = ReadOutTimeBase1313 ns)

#define AddrROIheight   403

Register address for the height of the ROI stripe

#define AddrROIStartColumn   404

Register address for the ROI OFFSET / first column:

#define AddrROIStartRow   402

Register address for the ROI OFFSET / first row:

#define AddrROIwidth   405

Register address for the width of the ROI stripe

#define AddrSensorBinReg   3

Address of sensor bin register

#define AddrSensorBinReg2   5

Address of sensor bin register 2

#define AddrSerialNumber   125

Register address for the serial number of the detector

#define AddrTriggerSource   0

Register address of the Trigger Source bits

#define AddrVerticalBinReg   9

Address of vertical binning register

#define AddrWellHigh   4

Address of High Fullwell register

#define AddrWellLow   65531

Address of Low Fullwell register

#define AddrWellReg   3

Address of Well register

#define BinCommit   514

Constant for binning commit command

#define DarkPixelXOffset   2

The offset in pixels in x when reaing dark pixel data

d

#define DarkPixelYOffset   4

The offset in pixels in y when reading dark pixel data

#define DigitalBinBit   65533

Constant for digital binning bit

#define ExposureSleepTimems   10

Variable to hold a time in ms used for sleeping threads in streaming mode.

#define MAX_PIXEL_VAL   16383

Maximum value for any pixel in detector output (14 bit)

#define MIN_PIXEL_VAL   0

Minimum allowable pixel value

#define minTimeIncrement   0.01F

The minimum time increment in ms for expose and read mode

#define minTimeIncrement2   195.2F

The minimum time increment in ns for line delay mode

#define ReadoutTimeFactor1313   2

ReadoutTimeFactor for Dexela 1313

#define Sensor1x1   0

Constant for 1x1 binning command

#define Sensor1x2   0

Constant for 1x2 binning command

#define Sensor1x4   64

Constant for 1x4 binning command

#define Sensor2x1   128

Constant for 2x1 binning command

#define Sensor2x2   128

Constant for 2x2 binning command

#define Sensor2x4   192

Constant for 2x4 binning command

#define Sensor4x1   256

Constant for 4x1 binning command

#define Sensor4x2   256

Constant for 4x2 binning command

#define Sensor4x4   320

Constant for 4x4 binning command

#define SensorBinClear   65087

Constant for clearing binning command

#define SerialNumberReg1   0

Address of serial number register 1

#define SerialNumberReg2   0

Address of serial number register 2

#define SerialNumberReg3   0

Address of serial number register 3

#define TemperatureReg   0

Address of temperature register

#define TimingResolution   100

The resolution of the exposure time settings 1 for ms 100 for 0.01 ms