REST-for-Physics  v2.3
Rare Event Searches ToolKit for Physics
Public Member Functions | Private Member Functions | Private Attributes
TRestDetectorReadoutChannel Class Reference

Detailed Description

A class to store the readout channel definition used in TRestDetectorReadoutModule. It allows to integrate any number of independent readout pixels.

This class stores the readout pixel geometrical description, origin position, orientation, and size. A readout pixel is the most elementary component of a readout used to construct a readout channel.


RESTsoft - Software for Rare Event Searches with TPCs

History of developments:

2015-aug: First concept. Javier Galan

Author
Javier Galan

Definition at line 44 of file TRestDetectorReadoutChannel.h.

#include <TRestDetectorReadoutChannel.h>

Public Member Functions

void AddPixel (const TRestDetectorReadoutPixel &pixel)
 Adds a new pixel to the readout channel. More...
 
Int_t GetChannelId () const
 Returns the corresponding channel id. More...
 
Int_t GetDaqID () const
 Returns the corresponding daq channel id. More...
 
Int_t GetNumberOfPixels ()
 Returns the total number of pixels inside the readout channel. More...
 
TRestDetectorReadoutPixel * GetPixel (int n)
 Returns a pointer to the pixel n by index. More...
 
TRestDetectorReadoutChannelType GetType ()
 
Int_t isInside (Double_t x, Double_t y)
 Determines if (x,y) referenced to module coordinates is inside the channel. More...
 
TRestDetectorReadoutPixel & operator[] (int n)
 
void Print (int DetailLevel=0)
 Prints the details of the readout channel including pixel coordinates. More...
 
void SetChannelID (Int_t id)
 Sets the readout channel number id. More...
 
void SetDaqID (Int_t id)
 Sets the daq channel number id. More...
 
void SetType (TRestDetectorReadoutChannelType type)
 
 TRestDetectorReadoutChannel ()
 TRestDetectorReadoutChannel default constructor. More...
 
virtual ~TRestDetectorReadoutChannel ()
 TRestDetectorReadoutChannel default destructor. More...
 

Private Member Functions

void Initialize ()
 Initializes the channel members. More...
 

Private Attributes

Short_t fChannelId = -1
 It stores the corresponding physical readout channel. More...
 
Int_t fDaqID
 
std::vector< TRestDetectorReadoutPixel > fReadoutPixel
 

Constructor & Destructor Documentation

◆ TRestDetectorReadoutChannel()

TRestDetectorReadoutChannel::TRestDetectorReadoutChannel ( )

TRestDetectorReadoutChannel default constructor.

Definition at line 52 of file TRestDetectorReadoutChannel.cxx.

◆ ~TRestDetectorReadoutChannel()

TRestDetectorReadoutChannel::~TRestDetectorReadoutChannel ( )
virtual

TRestDetectorReadoutChannel default destructor.

Definition at line 57 of file TRestDetectorReadoutChannel.cxx.

Member Function Documentation

◆ AddPixel()

void TRestDetectorReadoutChannel::AddPixel ( const TRestDetectorReadoutPixel &  pixel)
inline

Adds a new pixel to the readout channel.

Definition at line 89 of file TRestDetectorReadoutChannel.h.

◆ GetChannelId()

Int_t TRestDetectorReadoutChannel::GetChannelId ( ) const
inline

Returns the corresponding channel id.

Definition at line 60 of file TRestDetectorReadoutChannel.h.

◆ GetDaqID()

Int_t TRestDetectorReadoutChannel::GetDaqID ( ) const
inline

Returns the corresponding daq channel id.

Definition at line 57 of file TRestDetectorReadoutChannel.h.

◆ GetNumberOfPixels()

Int_t TRestDetectorReadoutChannel::GetNumberOfPixels ( )
inline

Returns the total number of pixels inside the readout channel.

Definition at line 63 of file TRestDetectorReadoutChannel.h.

◆ GetPixel()

TRestDetectorReadoutPixel * TRestDetectorReadoutChannel::GetPixel ( int  n)
inline

Returns a pointer to the pixel n by index.

Definition at line 68 of file TRestDetectorReadoutChannel.h.

◆ GetType()

TRestDetectorReadoutChannelType TRestDetectorReadoutChannel::GetType ( )
inline

Definition at line 77 of file TRestDetectorReadoutChannel.h.

◆ Initialize()

void TRestDetectorReadoutChannel::Initialize ( )
private

Initializes the channel members.

Definition at line 62 of file TRestDetectorReadoutChannel.cxx.

◆ isInside()

Int_t TRestDetectorReadoutChannel::isInside ( Double_t  x,
Double_t  y 
)

Determines if (x,y) referenced to module coordinates is inside the channel.

Definition at line 68 of file TRestDetectorReadoutChannel.cxx.

◆ operator[]()

TRestDetectorReadoutPixel & TRestDetectorReadoutChannel::operator[] ( int  n)
inline

Definition at line 65 of file TRestDetectorReadoutChannel.h.

◆ Print()

void TRestDetectorReadoutChannel::Print ( int  DetailLevel = 0)

Prints the details of the readout channel including pixel coordinates.

Definition at line 78 of file TRestDetectorReadoutChannel.cxx.

◆ SetChannelID()

void TRestDetectorReadoutChannel::SetChannelID ( Int_t  id)
inline

Sets the readout channel number id.

Definition at line 86 of file TRestDetectorReadoutChannel.h.

◆ SetDaqID()

void TRestDetectorReadoutChannel::SetDaqID ( Int_t  id)
inline

Sets the daq channel number id.

Definition at line 83 of file TRestDetectorReadoutChannel.h.

◆ SetType()

void TRestDetectorReadoutChannel::SetType ( TRestDetectorReadoutChannelType  type)
inline

Definition at line 73 of file TRestDetectorReadoutChannel.h.

Field Documentation

◆ fChannelId

Short_t TRestDetectorReadoutChannel::fChannelId = -1
private

It stores the corresponding physical readout channel.

Definition at line 51 of file TRestDetectorReadoutChannel.h.

◆ fDaqID

Int_t TRestDetectorReadoutChannel::fDaqID
private

Defines the corresponding daq channel id. See decoding details at TRestDetectorReadout.

Definition at line 46 of file TRestDetectorReadoutChannel.h.

◆ fReadoutPixel

std::vector<TRestDetectorReadoutPixel> TRestDetectorReadoutChannel::fReadoutPixel
private

A std::vector storing the different TRestDetectorReadoutPixel definitions.

Definition at line 48 of file TRestDetectorReadoutChannel.h.


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