SensorGrid::SensorGridBase Class Reference

Common base class for sensor grids. More...

#include <PndDiscSensorGrid.h>

Inheritance diagram for SensorGrid::SensorGridBase:

Public Member Functions
	SensorGridBase ()
virtual	~SensorGridBase ()
void	SetUserColumnOffset (int ofs)
void	SetUserRowOffset (int ofs)
void	LockGrid (bool lock)
	Lock the grid: More...
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
	Return information of the next pixel (pixel iteration) More...

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 45 of file PndDiscSensorGrid.h.

Constructor & Destructor Documentation

SensorGrid::SensorGridBase::SensorGridBase ( )

inline

Definition at line 47 of file PndDiscSensorGrid.h.

        : pixel_number_offset(0), user_row_offset(0), user_col_offset(0), number_of_pixels(0), locked(false)
    { }

virtual SensorGrid::SensorGridBase::~SensorGridBase ( )

inlinevirtual

Definition at line 50 of file PndDiscSensorGrid.h.

{}

Member Function Documentation

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

protectedpure virtual

Implemented in SensorGrid::MultipleGrids, and SensorGrid::BasicGrid.

Referenced by EnumerateGridsProxy(), and LockGrid().

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

inlineprotected

Definition at line 68 of file PndDiscSensorGrid.h.

References EnumerateGrids().

Referenced by SensorGrid::MultipleGrids::EnumerateGrids().

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

int SensorGrid::SensorGridBase::GetNumberOfPixels ( )

inline

Definition at line 56 of file PndDiscSensorGrid.h.

References number_of_pixels.

Referenced by SensorGrid::SensorGridPhotodetector::GenerateNoise(), SensorGrid::SensorGridPhotodetector::GetNoiseHit(), SensorGrid::SensorGridPhotodetector::Init(), and SensorGrid::SensorGridPhotodetector::SetDCR().

{ return number_of_pixels; }

bool SensorGrid::SensorGridBase::IsLocked ( )

inline

Definition at line 54 of file PndDiscSensorGrid.h.

References locked.

{ return locked; }

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

inlineprotectedvirtual

Reimplemented in SensorGrid::MultipleGrids.

Definition at line 64 of file PndDiscSensorGrid.h.

Referenced by LockChildsProxy(), and LockGrid().

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

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

inlineprotected

Definition at line 69 of file PndDiscSensorGrid.h.

References LockChilds().

Referenced by SensorGrid::MultipleGrids::LockChilds().

{ b->LockChilds(lock); }

void SensorGrid::SensorGridBase::LockGrid

(

bool

lock

)

Lock the grid:

Definition at line 19 of file PndDiscSensorGrid.cxx.

References EnumerateGrids(), LockChilds(), locked, and number_of_pixels.

Referenced by SensorGrid::SensorGridPhotodetector::Init().

                                       {
    if(lock == true) {
        // Enumerate this and all child grids:
        int grid_id = 1;
        int pixel_offset = number_of_pixels;
        EnumerateGrids(grid_id, pixel_offset);
        LockChilds(true);

        // and set lock flag
        locked = true;
    }
    else
        locked = false;
}

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

virtual

Return information of the next pixel (pixel iteration)

The pixel_info.pixel_number will be increased by one and the pixel_info structure is updated to the corresponding values. The position of the pixel center is also returned using arguments x, y.

Definition at line 40 of file PndDiscSensorGrid.cxx.

References SensorGrid::PixelInfo::pixel_number, and PixelToPosition().

                                                                                   {
    // simple method that will work with all derived classes.
    // !!! maybe slow !!! -> derived classes should implement caching of last subgrid.
    if(pixel_info.pixel_number < 0) pixel_info.pixel_number = 0;     // start enum
    else ++pixel_info.pixel_number;            // run enum
    return PixelToPosition(pixel_info, x, y);
}

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

pure virtual

Implemented in SensorGrid::MultipleGrids, and SensorGrid::BasicGrid.

Referenced by PndDiscTaskDigitization::Exec(), and NextPixel().

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

pure virtual

Implemented in SensorGrid::MultipleGrids, and SensorGrid::BasicGrid.

Referenced by SensorGrid::SensorGridPhotodetector::Detect().

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

inlineprotected

Definition at line 65 of file PndDiscSensorGrid.h.

References offset(), and pixel_number_offset.

{ pixel_number_offset= offset; }

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

inline

Definition at line 51 of file PndDiscSensorGrid.h.

References user_col_offset.

Referenced by DiscDIRC_Photodetector::Init().

{ user_col_offset = ofs; }

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

inline

Definition at line 52 of file PndDiscSensorGrid.h.

References user_row_offset.

Referenced by DiscDIRC_Photodetector::Init().

{ user_row_offset = ofs; }

Member Data Documentation

int SensorGrid::SensorGridBase::grid_number

protected

Definition at line 73 of file PndDiscSensorGrid.h.

Referenced by SensorGrid::BasicGrid::EnumerateGrids(), SensorGrid::MultipleGrids::EnumerateGrids(), SensorGrid::BasicGrid::PixelToPosition(), and SensorGrid::BasicGrid::PositionToPixel().

bool SensorGrid::SensorGridBase::locked

protected

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

Definition at line 78 of file PndDiscSensorGrid.h.

Referenced by IsLocked(), LockGrid(), SensorGrid::BasicGrid::SetXDivision(), and SensorGrid::BasicGrid::SetYDivision().

int SensorGrid::SensorGridBase::number_of_pixels

protected

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

Definition at line 77 of file PndDiscSensorGrid.h.

Referenced by SensorGrid::BasicGrid::BasicGrid(), SensorGrid::BasicGrid::EnumerateGrids(), SensorGrid::MultipleGrids::EnumerateGrids(), GetNumberOfPixels(), LockGrid(), SensorGrid::BasicGrid::PixelToPosition(), SensorGrid::BasicGrid::SetXDivision(), and SensorGrid::BasicGrid::SetYDivision().

int SensorGrid::SensorGridBase::pixel_number_offset

protected

Definition at line 74 of file PndDiscSensorGrid.h.

Referenced by SensorGrid::BasicGrid::EnumerateGrids(), SensorGrid::MultipleGrids::EnumerateGrids(), SensorGrid::BasicGrid::PixelToPosition(), SensorGrid::BasicGrid::PositionToPixel(), and SetPixelNumberOffset().

int SensorGrid::SensorGridBase::user_col_offset

protected

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

Definition at line 76 of file PndDiscSensorGrid.h.

Referenced by SensorGrid::BasicGrid::PixelToPosition(), SensorGrid::BasicGrid::PositionToPixel(), and SetUserColumnOffset().

int SensorGrid::SensorGridBase::user_row_offset

protected

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

Definition at line 75 of file PndDiscSensorGrid.h.

Referenced by SensorGrid::BasicGrid::PixelToPosition(), SensorGrid::BasicGrid::PositionToPixel(), and SetUserRowOffset().

---

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

• PndDiscSensorGrid.h
• PndDiscSensorGrid.cxx