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 34 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...

std::string	GetChannelName () const

std::string	GetChannelType () const

Int_t	GetDaqID () const
	Returns the corresponding daq channel id. More...

std::string	GetName () const
	Returns the channel name. 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...

std::string	GetType () const
	Returns the channel type. More...

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	SetChannelName (const std::string &name)

void	SetChannelType (const std::string &type)

void	SetDaqID (Int_t id)
	Sets the daq channel number id. More...

void	SetName (const std::string &name)
	Sets the channel name. More...

void	SetType (const std::string &type)
	Sets the channel type. More...

	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::string	fName

std::vector< TRestDetectorReadoutPixel >	fReadoutPixel

std::string	fType

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 85 of file TRestDetectorReadoutChannel.h.

◆ GetChannelId()

Int_t TRestDetectorReadoutChannel::GetChannelId ( ) const

inline

Returns the corresponding channel id.

Definition at line 59 of file TRestDetectorReadoutChannel.h.

◆ GetChannelName()

std::string TRestDetectorReadoutChannel::GetChannelName ( ) const

inline

Definition at line 61 of file TRestDetectorReadoutChannel.h.

◆ GetChannelType()

std::string TRestDetectorReadoutChannel::GetChannelType ( ) const

inline

Definition at line 62 of file TRestDetectorReadoutChannel.h.

◆ GetDaqID()

Int_t TRestDetectorReadoutChannel::GetDaqID ( ) const

inline

Returns the corresponding daq channel id.

Definition at line 50 of file TRestDetectorReadoutChannel.h.

◆ GetName()

std::string TRestDetectorReadoutChannel::GetName ( ) const

inline

Returns the channel name.

Definition at line 53 of file TRestDetectorReadoutChannel.h.

◆ GetNumberOfPixels()

Int_t TRestDetectorReadoutChannel::GetNumberOfPixels ( )

inline

Returns the total number of pixels inside the readout channel.

Definition at line 68 of file TRestDetectorReadoutChannel.h.

◆ GetPixel()

TRestDetectorReadoutPixel * TRestDetectorReadoutChannel::GetPixel ( int n )

inline

Returns a pointer to the pixel n by index.

Definition at line 73 of file TRestDetectorReadoutChannel.h.

◆ GetType()

std::string TRestDetectorReadoutChannel::GetType ( ) const

inline

Returns the channel type.

Definition at line 56 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 70 of file TRestDetectorReadoutChannel.h.

◆ Print()

void TRestDetectorReadoutChannel::Print ( int DetailLevel = 0 )

Prints the details of the readout channel including pixel coordinates.

Definition at line 81 of file TRestDetectorReadoutChannel.cxx.

◆ SetChannelID()

void TRestDetectorReadoutChannel::SetChannelID ( Int_t id )

inline

Sets the readout channel number id.

Definition at line 82 of file TRestDetectorReadoutChannel.h.

◆ SetChannelName()

void TRestDetectorReadoutChannel::SetChannelName ( const std::string & name )

inline

Definition at line 64 of file TRestDetectorReadoutChannel.h.

◆ SetChannelType()

void TRestDetectorReadoutChannel::SetChannelType ( const std::string & type )

inline

Definition at line 65 of file TRestDetectorReadoutChannel.h.

◆ SetDaqID()

void TRestDetectorReadoutChannel::SetDaqID ( Int_t id )

inline

Sets the daq channel number id.

Definition at line 79 of file TRestDetectorReadoutChannel.h.

◆ SetName()

void TRestDetectorReadoutChannel::SetName ( const std::string & name )

inline

Sets the channel name.

Definition at line 88 of file TRestDetectorReadoutChannel.h.

◆ SetType()

void TRestDetectorReadoutChannel::SetType ( const std::string & type )

inline

Sets the channel type.

Definition at line 91 of file TRestDetectorReadoutChannel.h.

Field Documentation

◆ fChannelId

Short_t TRestDetectorReadoutChannel::fChannelId = -1

private

It stores the corresponding physical readout channel.

Definition at line 41 of file TRestDetectorReadoutChannel.h.

◆ fDaqID

Int_t TRestDetectorReadoutChannel::fDaqID

private

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

Definition at line 36 of file TRestDetectorReadoutChannel.h.

◆ fName

std::string TRestDetectorReadoutChannel::fName

private

Definition at line 43 of file TRestDetectorReadoutChannel.h.

◆ fReadoutPixel

std::vector<TRestDetectorReadoutPixel> TRestDetectorReadoutChannel::fReadoutPixel

private

A std::vector storing the different TRestDetectorReadoutPixel definitions.

Definition at line 38 of file TRestDetectorReadoutChannel.h.

◆ fType

std::string TRestDetectorReadoutChannel::fType

private

Definition at line 44 of file TRestDetectorReadoutChannel.h.

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

Detailed Description

Public Member Functions

Private Member Functions

Private Attributes

Constructor & Destructor Documentation

◆ TRestDetectorReadoutChannel()

◆ ~TRestDetectorReadoutChannel()

Member Function Documentation

◆ AddPixel()

◆ GetChannelId()

◆ GetChannelName()

◆ GetChannelType()

◆ GetDaqID()

◆ GetName()

◆ GetNumberOfPixels()

◆ GetPixel()

◆ GetType()

◆ Initialize()

◆ isInside()

◆ operator[]()

◆ Print()

◆ SetChannelID()

◆ SetChannelName()

◆ SetChannelType()

◆ SetDaqID()

◆ SetName()

◆ SetType()

Field Documentation

◆ fChannelId

◆ fDaqID

◆ fName

◆ fReadoutPixel

◆ fType