PandaRoot
SensorGrid::SensorGridBase Class Referenceabstract

Common base class for sensor grids. More...

#include <PndDiscSensorGrid.h>

Inheritance diagram for SensorGrid::SensorGridBase:
SensorGrid::BasicGrid SensorGrid::MultipleGrids

Public Member Functions

 SensorGridBase ()
 
virtual ~SensorGridBase ()
 
void SetUserColumnOffset (int ofs)
 
void SetUserRowOffset (int ofs)
 
void LockGrid (bool lock)
 
bool IsLocked ()
 
int GetNumberOfPixels ()
 
virtual bool PositionToPixel (const double &x, const double &y, PixelInfo &pixel_info) const =0
 
virtual bool PixelToPosition (PixelInfo &pixel_info, double &x, double &y) const =0
 
virtual bool NextPixel (double &x, double &y, PixelInfo &pixel_number) const
 

Protected Member Functions

virtual void EnumerateGrids (int &id, int &pixel_offset)=0
 
virtual void LockChilds (bool)
 
void SetPixelNumberOffset (int offset)
 
void EnumerateGridsProxy (SensorGridBase *b, int &grid_id, int &pixel_number)
 
void LockChildsProxy (SensorGridBase *b, bool lock)
 

Protected Attributes

int grid_number
 
int pixel_number_offset
 
int user_row_offset
 The pixel number of the first pixel in this grid (or its childs) More...
 
int user_col_offset
 user prowided offset to add to row on grid value in PixelInfo More...
 
int number_of_pixels
 user prowided offset to add to column on grid value in PixelInfo More...
 
bool locked
 The total number of pixels in this grid (or its childs) More...
 

Detailed Description

Common base class for sensor grids.

The sensor grid is meant to store the spatial topology of the sensor structure and not metadata like PDE, DCR, gain. Latter should be stored in a external map (pixel_number -> metadata). Pixel enumeration via NextPixel can be used to implement noise generators.

Definition at line 41 of file PndDiscSensorGrid.h.

Constructor & Destructor Documentation

◆ SensorGridBase()

SensorGrid::SensorGridBase::SensorGridBase ( )
inline

Definition at line 43 of file PndDiscSensorGrid.h.

bool locked
The total number of pixels in this grid (or its childs)
int user_row_offset
The pixel number of the first pixel in this grid (or its childs)
int number_of_pixels
user prowided offset to add to column on grid value in PixelInfo
int user_col_offset
user prowided offset to add to row on grid value in PixelInfo

◆ ~SensorGridBase()

virtual SensorGrid::SensorGridBase::~SensorGridBase ( )
inlinevirtual

Definition at line 44 of file PndDiscSensorGrid.h.

44 {}

Member Function Documentation

◆ EnumerateGrids()

virtual void SensorGrid::SensorGridBase::EnumerateGrids ( int &  id,
int &  pixel_offset 
)
protectedpure virtual

◆ EnumerateGridsProxy()

void SensorGrid::SensorGridBase::EnumerateGridsProxy ( SensorGridBase b,
int &  grid_id,
int &  pixel_number 
)
inlineprotected

Definition at line 62 of file PndDiscSensorGrid.h.

References EnumerateGrids().

62 { b->EnumerateGrids(grid_id, pixel_number); }

◆ GetNumberOfPixels()

int SensorGrid::SensorGridBase::GetNumberOfPixels ( )
inline

Definition at line 50 of file PndDiscSensorGrid.h.

References SensorGrid::PixelInfo::pixel_number.

50 { return number_of_pixels; }
int number_of_pixels
user prowided offset to add to column on grid value in PixelInfo

◆ IsLocked()

bool SensorGrid::SensorGridBase::IsLocked ( )
inline

Definition at line 48 of file PndDiscSensorGrid.h.

48 { return locked; }
bool locked
The total number of pixels in this grid (or its childs)

◆ LockChilds()

virtual void SensorGrid::SensorGridBase::LockChilds ( bool  )
inlineprotectedvirtual

Reimplemented in SensorGrid::MultipleGrids.

Definition at line 58 of file PndDiscSensorGrid.h.

Referenced by LockChildsProxy().

58 {} // used to forward lock to children // lock//[R.K.03/2017] unused variable(s)

◆ LockChildsProxy()

void SensorGrid::SensorGridBase::LockChildsProxy ( SensorGridBase b,
bool  lock 
)
inlineprotected

Definition at line 63 of file PndDiscSensorGrid.h.

References LockChilds().

63 { b->LockChilds(lock); }

◆ LockGrid()

void SensorGrid::SensorGridBase::LockGrid ( bool  lock)

◆ NextPixel()

virtual bool SensorGrid::SensorGridBase::NextPixel ( double &  x,
double &  y,
PixelInfo pixel_number 
) const
virtual

◆ PixelToPosition()

virtual bool SensorGrid::SensorGridBase::PixelToPosition ( PixelInfo pixel_info,
double &  x,
double &  y 
) const
pure virtual

◆ PositionToPixel()

virtual bool SensorGrid::SensorGridBase::PositionToPixel ( const double &  x,
const double &  y,
PixelInfo pixel_info 
) const
pure virtual

◆ SetPixelNumberOffset()

void SensorGrid::SensorGridBase::SetPixelNumberOffset ( int  offset)
inlineprotected

Definition at line 59 of file PndDiscSensorGrid.h.

◆ SetUserColumnOffset()

void SensorGrid::SensorGridBase::SetUserColumnOffset ( int  ofs)
inline

Definition at line 45 of file PndDiscSensorGrid.h.

45 { user_col_offset = ofs; }
int user_col_offset
user prowided offset to add to row on grid value in PixelInfo

◆ SetUserRowOffset()

void SensorGrid::SensorGridBase::SetUserRowOffset ( int  ofs)
inline

Definition at line 46 of file PndDiscSensorGrid.h.

46 { user_row_offset = ofs; }
int user_row_offset
The pixel number of the first pixel in this grid (or its childs)

Member Data Documentation

◆ grid_number

int SensorGrid::SensorGridBase::grid_number
protected

Definition at line 66 of file PndDiscSensorGrid.h.

◆ locked

bool SensorGrid::SensorGridBase::locked
protected

The total number of pixels in this grid (or its childs)

Definition at line 71 of file PndDiscSensorGrid.h.

◆ number_of_pixels

int SensorGrid::SensorGridBase::number_of_pixels
protected

user prowided offset to add to column on grid value in PixelInfo

Definition at line 70 of file PndDiscSensorGrid.h.

◆ pixel_number_offset

int SensorGrid::SensorGridBase::pixel_number_offset
protected

Definition at line 67 of file PndDiscSensorGrid.h.

◆ user_col_offset

int SensorGrid::SensorGridBase::user_col_offset
protected

user prowided offset to add to row on grid value in PixelInfo

Definition at line 69 of file PndDiscSensorGrid.h.

◆ user_row_offset

int SensorGrid::SensorGridBase::user_row_offset
protected

The pixel number of the first pixel in this grid (or its childs)

Definition at line 68 of file PndDiscSensorGrid.h.


The documentation for this class was generated from the following file: