fdhwlib  2.0.25
Public Member Functions
FEbaseImage Class Reference
Application Programmers Interface

#include <febaseimage.h>

Inheritance diagram for FEbaseImage:
FE4image FEimage

List of all members.

Public Member Functions

Detailed Description

The class allows the access to the image data of a single mirror.

The size of the image depends on the coding of the values. In compression mode the size equals the physical number of pixel (20x22 pixel). Using virtual channel there are two additional rows (20x24 pixel). The rows are numbered from 1 to 22(24) and columns are numbered from 1 to 20. For each pixel there are 32 pages numbered from 1 to 32 of 1k words of data. They contain the history of the last 100us before the next page signal. To be more efficient the readout procedure will return long words including the data of two consecutive pixel in one column.

Due to bright stars and other light sources that affect only some of the pixel it is necessary to manage the state of each pixel separately. The state of a pixel can be enabled, fixed to low, fixed to high or disabled For each column two long words are used mark the pixel as disabled or fixed. Another parameter defines whether the pixel in case of being fixed is fixed to lower or higher border. In the parameters the bits 0-21 correspond with the pixel 0-21 of the column.

In close conjunction with the image data there is another features of the analog electronic, the gain of the analog electronic.

Changes:

  • The statistical evaluation uses now the buffered sum of squares!
  • The ADC memory is now read in arrays of type unsigned short ak 7.2.01
  • The data of two consecutive pixel in one column is transfered in one long word (19.7.00, ak).
  • The metheods enablePixel, disablePixel, fixPixel, setFixedTypeToLow and setFixedTypeToHigh are added (26.7.00, ak).
  • 10.7.01 ak: Calculate of the statistics over now 2^16 samples (elongation by 6bit). The type of the argument number of samples changed!
Todo:
Make the statistical functions multitasking safe!
See also:
FE FEimageData

Definition at line 70 of file febaseimage.h.

Constructor & Destructor Documentation

FEbaseImage::FEbaseImage ( ) [inline]

Definition at line 72 of file febaseimage.h.

{ }
virtual FEbaseImage::~FEbaseImage ( ) [virtual]

Member Function Documentation

virtual void FEbaseImage::disableGainErr ( int  ) [inline, virtual]

Reimplemented in FE4image, and FEimage.

Definition at line 296 of file febaseimage.h.

{ }
virtual void FEbaseImage::disablePixel ( int  ,
unsigned long   
) [inline, virtual]

Disable all pixel in the mask.

Reimplemented in FE4image, and FEimage.

Definition at line 263 of file febaseimage.h.

{ }
virtual void FEbaseImage::enableGainErr ( int  ) [inline, virtual]

Reimplemented in FE4image, and FEimage.

Definition at line 294 of file febaseimage.h.

{ }
virtual void FEbaseImage::enablePixel ( int  ,
unsigned long   
) [inline, virtual]

Enable all pixel in the mask.

Clears fixed and disabled pixel.

Reimplemented in FE4image, and FEimage.

Definition at line 260 of file febaseimage.h.

{ }
virtual void FEbaseImage::fixPixel ( int  ,
unsigned long   
) [inline, virtual]

Set all pixel in the mask to fixed.

Reimplemented in FE4image, and FEimage.

Definition at line 266 of file febaseimage.h.

{ }
virtual unsigned FEbaseImage::getCurrent ( int  ,
int   
) [inline, virtual]

Read the DC component of the anode current of the specified pixel.

Reimplemented in FEimage.

Definition at line 222 of file febaseimage.h.

{ return 0; }
virtual unsigned long FEbaseImage::getDisabledPixel ( int  ) [inline, virtual]

Get a list of the disabled pixel (0 not disabeled, 1 disabled)

Reimplemented in FE4image, and FEimage.

Definition at line 240 of file febaseimage.h.

{ return 0; }
virtual unsigned long FEbaseImage::getFixedPixel ( int  ) [inline, virtual]

Get a list of the fixed pixel (0 not fixed, 1 fixed)

Reimplemented in FE4image, and FEimage.

Definition at line 245 of file febaseimage.h.

{ return 0; }
virtual unsigned long FEbaseImage::getFixedType ( int  ) [inline, virtual]

Get list of the pixel fixed to low and high (0 low, 1 high).

This information is only relevant if the pixel are fixed (and not disabled). To check use getFixedPixel and getDisabledPixel

Reimplemented in FE4image, and FEimage.

Definition at line 252 of file febaseimage.h.

{ return 0; }
virtual int FEbaseImage::getGain ( int  col,
int  row 
) [pure virtual]

Read the gain of the specified pixel.

Implemented in FE4image, and FEimage.

virtual bool FEbaseImage::getStatisticParameters ( int  col,
int  row,
int *  offset,
unsigned long *  n 
) [pure virtual]

Get parameters for the calculation of the statistical parameters.

Implemented in FE4image, and FEimage.

virtual void FEbaseImage::getStatistics ( int  col,
int  row,
double *  mean,
double *  var 
) [pure virtual]

Get statistical parameters for the ADC values.

Changes:

  • 30.8.01 ak: Offset considered in calculation of mean value

Implemented in FE4image, and FEimage.

virtual void FEbaseImage::getStatistics ( int  col,
int  row,
signed long *  sum,
unsigned long *  sumSq 
) [pure virtual]

Get statistical parameters for the ADC values.

Normally all parameters should be equal, so use only one existing pixel to read the parameters.

Returns:
The function will return true, if the evaluation of the statistic parameters is activ.

Implemented in FE4image, and FEimage.

virtual void FEbaseImage::getStatistics ( signed long *  sum,
unsigned long *  sumSq 
) [pure virtual]

Get statistical parameters for all pixel.

Implemented in FE4image, and FEimage.

virtual void FEbaseImage::initCurrentMonitor ( int  ) [inline, virtual]

don't use this function -- the function has been moved to the configuration section.

Initialize the current monitor

Reimplemented in FEimage.

Definition at line 235 of file febaseimage.h.

{ }
virtual int FEbaseImage::isBusyLoadingGains ( int  ) [inline, virtual]

Returns the load gain action busy flag.

(New for V4.)

After calling loadGains(col) this will return 1 during loading the gains. Data taking or reading/writing gains should be avoided until it is 0 again.

Reimplemented in FE4image.

Definition at line 217 of file febaseimage.h.

{  return 0; }
virtual bool FEbaseImage::isEnabledGainErr ( int  ) [inline, virtual]

Reimplemented in FE4image, and FEimage.

Definition at line 298 of file febaseimage.h.

{ return false; }
virtual void FEbaseImage::loadGains ( int  ) [inline, virtual]

Load (activate) the gains of the specified col (flt).

(New for V4.)

After setting the gains with setGain(int col, int row, int gain) they need to be activated/loaded by this command (all gains of this flt/col). The loading takes about 150 useconds (KATRIN) or 30 milli secons (AUGER) and is finished when the action busy flag of the status register is down.

Reimplemented in FE4image.

Definition at line 210 of file febaseimage.h.

{ }
virtual int FEbaseImage::read ( int  col,
int  row,
int  page,
unsigned short *  data 
) [pure virtual]

Read one page of data for one pixel.

The function requires an array of FLT_PAGE_SIZE long words. Each value contains the measurements for a single pixel.

Parameters:
colcolumn 1-20
rowrow 1-22, 23-24 for the virtual channel
pagepage 1-32
datadata[2000]
Returns:
Status of the transmisson. If an overflow in one of the bins occured the overflow flag is set. Compare with the values
  • PBUS_OVFL_UNKNOWN Overflow flag not considered
  • PBUS_OVFL_NONE No overflow detected
  • PBUS_OVFL_ACTIVE Overflow occured, read data in the virtual channel

Implemented in FE4image, and FEimage.

virtual int FEbaseImage::read ( int  col,
int  row,
int  page,
int  start,
unsigned short *  data,
int  len 
) [pure virtual]

Reading len values beginning from the position start.

Parameters:
colcolumn 1-20
rowrow 1-22, 23-24 for the virtual channel
pagepage 1-32
start0..999
datadata[1000]
len1...1000
Returns:
Status of the transmisson. If an overflow in one of the bins occured the overflow flag is set. Compare with the values
  • PBUS_OVFL_UNKNOW Overflow flag not considered
  • PBUS_OVFL_NONE No overflow detected
  • PBUS_OVFL_ACTIVE Overflow occured, read data in the virtual channel

Implemented in FE4image, and FEimage.

virtual int FEbaseImage::read ( int  col,
int  row,
int  page,
int  start,
unsigned short *  data 
) [pure virtual]

Read the complete image but start at the given address.

Parameters:
colcolumn 1-20
rowrow 1-22, 23-24 for the virtual channel
pagepage 1-32
start0..999
datadata[1000]
Returns:
Status of the transmisson. If an overflow in one of the bins occured the overflow flag is set. Compare with the values
  • PBUS_OVFL_UNKNOW Overflow flag not considered
  • PBUS_OVFL_NONE No overflow detected
  • PBUS_OVFL_ACTIVE Overflow occured, read data in the virtual channel

Implemented in FE4image, and FEimage.

virtual void FEbaseImage::readCurrent ( int  ,
unsigned long *   
) [inline, virtual]

Read the current monitor values of the complete row.

Make sure the array to store the data is of appropriate size (0..23).

Reimplemented in FEimage.

Definition at line 229 of file febaseimage.h.

{ }
virtual int FEbaseImage::readPage ( int  ,
int  ,
int  ,
unsigned short *   
) [inline, virtual]

Read one page of data for one pixel.

Use the 'imgAddr' computed by FEbaseEvent->getTimeStamp(...).

IMPLEMENTED FOR V4 ONLY!

Parameters:
colcolumn 1-20
rowrow 1-22, 23-24 for the virtual channel
imgAddrimage offset
datadata[2000]

Reimplemented in FE4image.

Definition at line 105 of file febaseimage.h.

                                              { return 0; }
virtual int FEbaseImage::readPage ( int  ,
int  ,
int  ,
unsigned short *  ,
int  ,
int   
) [inline, virtual]

Read one page of data for one pixel.

Use the 'imgAddr' computed by FEbaseEvent->getTimeStamp(...).

IMPLEMENTED FOR V4 ONLY!

Parameters:
colcolumn 1-20
rowrow 1-22, 23-24 for the virtual channel
imgAddrimage offset
startoffset of the block offset
datadata[2000]

Reimplemented in FE4image.

Definition at line 119 of file febaseimage.h.

                              { return 0; }
virtual void FEbaseImage::setDisabledPixel ( int  ,
unsigned long   
) [inline, virtual]

Mark pixel as disabled (0 not disabled, 1 disabled)

Reimplemented in FE4image, and FEimage.

Definition at line 256 of file febaseimage.h.

{ }
virtual void FEbaseImage::setFixedPixel ( int  ,
unsigned long   
) [inline, virtual]

Mark pixel as fixed (0 not fixed, 1 fixed).

The pixel can be fixed to low or high as chosen by setFixedType

Reimplemented in FE4image, and FEimage.

Definition at line 274 of file febaseimage.h.

{ }
virtual void FEbaseImage::setFixedType ( int  ,
unsigned long   
) [inline, virtual]

Defines whether the fixed pixel are set to low or high (0 low, 1 high)

Reimplemented in FE4image, and FEimage.

Definition at line 278 of file febaseimage.h.

{ }
virtual void FEbaseImage::setFixedTypeToHigh ( int  ,
unsigned long   
) [inline, virtual]

Change the fixed type of all pixel in the mask to high.

Reimplemented in FE4image, and FEimage.

Definition at line 287 of file febaseimage.h.

{ }
virtual void FEbaseImage::setFixedTypeToLow ( int  ,
unsigned long   
) [inline, virtual]

Change the fixed type of all pixel in the mask to low.

Reimplemented in FE4image, and FEimage.

Definition at line 282 of file febaseimage.h.

{ }
virtual void FEbaseImage::setGain ( int  col,
int  row,
int  gain 
) [pure virtual]

Write the gain of the specified pixel.

Implemented in FE4image, and FEimage.

virtual void FEbaseImage::setStatisticParameters ( bool  enable,
int  offset,
unsigned long  n 
) [pure virtual]

Set parameters for the calculation of the statistical parameters.

The function loads the same parameters for all pixel.

Implemented in FE4image, and FEimage.

virtual int FEbaseImage::waitForGainErr ( ) [inline, virtual]

Blocks execution until a gain error occurs.

Returns:
the column where the error has occurred (1-20).

Reimplemented in FE4image, and FEimage.

Definition at line 292 of file febaseimage.h.

{ return 0; }
The documentation for this class was generated from the following file: