Detailed Description

A metadata class to generate/store a readout description.

This is the main metadata readout class of REST. The readout class defines the methods allowing to stablish a relation between the hits inside the TPC and the signals read out by the electronics daq.

A full readout description is composed by at least one readout plane, (TRestDetectorReadoutPlane), where we can place any number of readout modules (TRestDetectorReadoutModule). A readout module is composed by readout channels (TRestDetectorReadoutChannel) which describe the basic active detection area, which can take any complex shape by combinning primitive geometry elements (TRestDetectorReadoutPixel).

REST processes such as TRestDetectorSignalToHitsProcess and TRestDetectorHitsToSignalProcess use the TRestDetectorReadout class to transform the spatial coordinates into raw signal data, and viceversa.

Constructing the readout through an RML file

The readout definition must be initialized through a RML file. The basic metadata structure of a readout follows this scheme

<section TRestDetectorReadout ... >
 
    <parameter name="mappingNodes" value="100" />
 
    // First, we need to construct the different readout modules we will
    // use inside the readout plane definition.
    <readoutModule name="modName" size="(100,100)" tolerance="1.e-4" >
 
        // Later, when we construct the readout plane we will use "modName"
        // to add the module to the readout plane definition.
 
        <readoutChannel id="0">
            <addPixel id="0" origin="(0,0)" size="(10,10)" rotation="45" />
            <addPixel id="1" origin="(10,10)" size="(10,10)" rotation="45"
            />
            ...
            // Add as many pixel definitions as needed to create the channel
            definition
            ...
        </readoutChannel>
 
        // And add as many readout channels as need to construct your
        readout module <readoutChannel id="1">
            ...
            ...
        </readoutChannel>
 
        // The id number given to the readout channel is the physical
        readout
        // channel used inside the decoding.
        <readoutChannel id="n">
            ...
            ...
        </readoutChannel>
 
    </readoutModule>
 
    // If your readout is composed by modules with different size or channel
    topologies,
    // you will need add additional <readoutModule ...> definitions here.
 
    // The readout plane allows to define the position, the orientation
    (planeVector),
    // and the position of the cathode that will define the detector active
    volume. <readoutPlane position="(0,0,-990)" units="mm"
                  planeVector="(0,0,1)"  chargeCollection="1"
                  cathodePosition="(0,0,0)" units="mm" >
 
           // We can then insert the modules inside each readout plane
           <addReadoutModule name="modName" // We use the previously defined
           readout module
                             origin="(0,0)" // Position of the left-bottom
                             corner (rotation point). rotation="0"   //
                             Rotation in degrees around position.
                             decodingFile="module.dec"  // A file describing
                             the decoding firstDaqChannel="0" >  // Offset
                             introduced to the daq signal channel inside the
                             decoding file.
 
           <addReadoutModule name="modName"
                             origin="(0,0)" rotation="0"
                             decodingFile="module.dec" firstDaqChannel="272"
                             >
 
          ...
 
          // Add as many modules as needed to construct your readout.
    </readoutPlane>
 
    // If needed you may add any additional readout layers to your
    definition adding new
    // readout plane <readoutPlane ...> definitions here.
 
 
</section>

The mappingNodes parameter allows to specify the size of the virtual grid that will be used to map the readout. The mapping allows to speed up the process finding a pixel inside a module for a given x,y coordinates. In general, the number of mapping nodes should be high enough so that every pixel from any readout channel is associated to, or contains, a node in the grid. However, as higher is the number of nodes in the mapping grid, higher will be the required computation time to find a pixel for a given x,y coordinates. If this value is not defined REST will try to find an optimum value for this parameter. Therefore, it is recommended to do not specify this parameter, except for solving readout problems or optimization purposes.

The decoding

The relation between the channel number imposed by the electronic acquisition and the readout channel id defined inside readoutChannel is given to TRestDetectorReadout through a decoding file.

The decodingFile parameter inside each module added to the readout plane allows to set the filename (in the code above, module.dec) of a file used to define the relation between the physical readout id defined at each readout channel, as <readoutChannel id="n"> and the daq channel number defined at the acquisition system. If no decoding file is defined the relation between daq and readout channel is assigned one to one. The decoding file must be a text file defining two columns with as many columns as the number of channels defined in the readout module. The first column is the daq channel number, and the second column is the readout channel defined in the RML file.

An example of contents of a decoding file. Here 0, 1, 2, 3, ... are the physical readout channels corresponding to the daq channels 67, 65, 63, 61, ...

The channel number defined on the left column will be shifted by the value firstDaqChannel defined when adding the readout module to the readout plane. This may allow to re-use a decoding file for different readout modules in case we have a repetitive connection pattern.

New method has been added to update the decoding in an already generated readout. The following lines give an example of how to do it:

TFile *f = TFile::Open("myReadout.root", "UPDATE");
TRestDetectorReadout* readout = (TRestDetectorReadout*)f->Get("readoutName");
  for( int p = 0; p < readout->GetNumberOfReadoutPlanes(); p++ ){
    TRestDetectorReadoutPlane *plane = readout->GetReadoutPlane( p );
      for( int m = 0; m < plane->GetNumberOfModules(); m++ ) {
        TRestDetectorReadoutModule* module = &(*plane)[m];
        module->SetDecodingFile(decodingFile);
      }
  }
readout->Write("newDecoding");
f->Close();

Using the readout class

Once TRestDetectorReadout has been initialized, through and RML file or a previously stored TRestDetectorReadout class stored in a ROOT file, we can find the corresponding xy-position for a given readout channel id, module id, and readout plane, or the corresponding coordinates for a given channel inside a module contained in a readout plane.

The following code shows how we can identify the readout plane (planeId), the readout module (moduleId), and the readout channel (chanId) for a given x,y,z coordinates.

for( int p = 0; p < fReadout->GetNumberOfReadoutPlanes(); p++ )
{
    // We check if the xyz coordinates are in the volume defined by
    the readout plane modId =
    fReadout->GetReadoutPlane(p)->isInsideDriftVolume( x, y, z );
 
    // If the hit is contained in the readout, the last function
    returns the id of the
    // readout module that contains the x,y coordinates.
    if( modId >= 0 )
    {
        // We found the hit at planeId
        planeId = p;
 
        // Then we obtain the readoutChannel *id* as defined in the
        readout. Int_t chanId = fReadout->GetReadoutPlane( p
        )->FindChannel( modId, x, y );
 
        break;
    }
}

Once we found the readout channel, we can obtain the associated daq channel number, that was defined using the decoding file.

Int_t daqId = fReadout->GetReadoutPlane( planeId )
                      ->GetModule( modId )
                      ->GetChannel( chanId )->GetDaqID( );

The other way around we can obtain the corresponding x and y coordinates for a given daq channel id. The following code shows the basic idea to find signalId.

@code for( int p = 0; p < fReadout->GetNumberOfReadoutPlanes(); p++ ) { TRestDetectorReadoutPlane plane = fReadout->GetReadoutPlane( p ); for( int m = 0; m < plane->GetNumberOfModules(); m++ ) { TRestDetectorReadoutModule mod = plane->GetModule( m ); // We iterate over all readout modules searching for the one that contains our signal id if( mod->IsDaqIDInside( signalID ) ) { // If we find it we use the readoutModule id, and the signalId corresponding // to the physical readout channel and obtain the x,y coordinates. readoutChannelID = mod->DaqToReadoutChannel( signalID ); readoutModuleID = mod->GetModuleID(); x = plane->GetX( readoutModuleID, readoutChannelID ); y = plane->GetY( readoutModuleID, readoutChannelID ); break; } } } \endcode

RESTsoft - Software for Rare Event Searches with TPCs

History of developments:

2015-aug: First concept. Javier Galan

Author: Javier Galan

Definition at line 33 of file TRestDetectorReadout.h.

#include <TRestDetectorReadout.h>

Inheritance diagram for TRestDetectorReadout:

Public Member Functions
void	AddReadoutPlane (const TRestDetectorReadoutPlane &plane)
	Adds a readout plane to the readout. More...

	ClassDefOverride (TRestDetectorReadout, 3)

void	Draw ()
	Draws the readout on screen. Not yet implemented. More...

void	Export (const std::string &fileName)
	Export readout to a root file. More...

std::set< Int_t >	GetAllDaqIds ()

Int_t	GetDaqId (const TVector3 &position, bool check=true)
	Returns the DaqID of the channel for position. If no channel is found returns -1. More...

Int_t	GetHitsDaqChannel (const TVector3 &position, Int_t &planeID, Int_t &moduleID, Int_t &channelID)

std::tuple< Int_t, Int_t, Int_t >	GetHitsDaqChannelAtReadoutPlane (const TVector3 &position, Int_t planeId=0)
	Returns a tuple with the DaqID, ModuleID, ChannelID. More...

Int_t	GetModuleDefinitionId (const TString &name)
	Returns the id of the readout module with a given name. More...

Int_t	GetNumberOfChannels ()
	Returns the total number of channels implemented in all the readout planes and modules. More...

Int_t	GetNumberOfModules ()
	Returns the total number of modules implemented in all the readout planes. More...

Int_t	GetNumberOfReadoutPlanes () const

void	GetPlaneModuleChannel (Int_t daqID, Int_t &planeID, Int_t &moduleID, Int_t &channelID)

TRestDetectorReadoutChannel *	GetReadoutChannelWithDaqID (int daqId)
	Returns a pointer to the readout channel by daq id. More...

TRestDetectorReadoutModule *	GetReadoutModuleWithID (int id)
	Returns a pointer to the readout module by ID. More...

TRestDetectorReadoutPlane *	GetReadoutPlane (int p)
	Returns a pointer to the readout plane by index. More...

TRestDetectorReadoutPlane *	GetReadoutPlaneWithID (int id)
	Returns a pointer to the readout plane by ID. More...

std::string	GetTypeForChannelDaqId (Int_t daqId)

Double_t	GetX (Int_t planeID, Int_t modID, Int_t chID)
	It returns the x-coordinate for the given readout plane, plane, a given module, modID, and a given channel, chID. More...

Double_t	GetX (Int_t signalID)
	It returns the physical X-coordinate corresponding to a given signal id in plane coordinates. More...

Double_t	GetY (Int_t planeID, Int_t modID, Int_t chID)
	It returns the y-coordinate for the given readout plane, plane, a given module, modID, and a given channel, chID. More...

Double_t	GetY (Int_t signalID)
	It returns the physical Y-coordinate corresponding to a given signal id in plane coordinates. More...

TRestDetectorReadoutPlane &	operator[] (int p)

TRestDetectorReadoutModule *	ParseModuleDefinition (TiXmlElement *moduleDefinition)

void	PrintMetadata () override
	Implemented it in the derived metadata class to print out specific metadata information. More...

void	PrintMetadata (Int_t DetailLevel)
	Prints on screen the details about the readout definition. More...

	TRestDetectorReadout ()
	TRestDetectorReadout default constructor. More...

	TRestDetectorReadout (const char *configFilename)
	TRestDetectorReadout constructor loading data from a config file. More...

	TRestDetectorReadout (const char *configFilename, const std::string &name)
	TRestDetectorReadout constructor loading data from a config file. More...

	~TRestDetectorReadout () override
	TRestDetectorReadout default destructor.

Public Member Functions inherited from TRestMetadata
void	AddLog (std::string log="", bool print=true)
	Add logs to messageBuffer. More...

void	DoNotStore ()
	If this method is called the metadata information will not be stored in disk. More...

TVector2	Get2DVectorParameterWithUnits (std::string parName, TVector2 defaultValue=TVector2(-1, -1))

TVector3	Get3DVectorParameterWithUnits (std::string parName, TVector3 defaultValue=TVector3(-1, -1, -1))

TString	GetCommit ()
	Returns the REST commit value stored in fCommit. More...

std::string	GetConfigBuffer ()
	Returns the config section of this class. More...

std::string	GetDataMemberValue (std::string memberName)
	Get the value of data member as string. More...

std::vector< std::string >	GetDataMemberValues (std::string memberName, Int_t precision=0)
	Get the value of datamember as a vector of strings. More...

TString	GetDataPath ()
	Returns a std::string with the path used for data storage. More...

Double_t	GetDblParameterWithUnits (std::string parName, Double_t defaultValue=PARAMETER_NOT_FOUND_DBL)
	Gets the value of the parameter name parName, after applying unit conversion. More...

Bool_t	GetError () const
	It returns true if an error was identified by a derived metadata class. More...

TString	GetErrorMessage ()
	Returns a std::string containing the error message. More...

TString	GetLibraryVersion ()
	Returns the REST libraty version stored in fLibraryVersion. More...

TString	GetMainDataPath ()
	Gets a std::string with the path used for data storage. More...

Int_t	GetNumberOfErrors () const

Int_t	GetNumberOfWarnings () const

std::string	GetParameter (std::string parName, TString defaultValue=PARAMETER_NOT_FOUND_STR)
	Returns corresponding REST Metadata parameter from multiple sources. More...

std::string	GetSectionName ()
	Returns the section name of this class, defined at the beginning of fSectionName. More...

TRestStringOutput::REST_Verbose_Level	GetVerboseLevel ()
	returns the verboselevel in type of REST_Verbose_Level enumerator More...

TString	GetVerboseLevelString ()
	returns the verbose level in type of TString More...

TString	GetVersion ()
	Returns the REST version stored in fVersion. More...

Int_t	GetVersionCode ()

UInt_t	GetVersionMajor () const

UInt_t	GetVersionMinor () const

UInt_t	GetVersionPatch () const

Bool_t	GetWarning () const
	It returns true if an error was identified by a derived metadata class. More...

TString	GetWarningMessage ()
	Returns a std::string containing the warning message. More...

virtual void	Initialize ()
	Making default settings. More...

TRestMetadata *	InstantiateChildMetadata (int index, std::string pattern="")
	This method will retrieve a new TRestMetadata instance of a child element of the present TRestMetadata instance based on the `index` given by argument, which defines the element order to be retrieved, 0 for first element found, 1 for the second element found, etc. More...

TRestMetadata *	InstantiateChildMetadata (std::string pattern="", std::string name="")
	This method will retrieve a new TRestMetadata instance of a child element of the present TRestMetadata instance based on the `name` given by argument. More...

Bool_t	isCleanState () const

Bool_t	isOfficialRelease () const

Int_t	LoadConfigFromBuffer ()
	Initialize data from a string element buffer. More...

Int_t	LoadConfigFromElement (TiXmlElement eSectional, TiXmlElement eGlobal, std::map< std::string, std::string > envs={})
	Main starter method. More...

Int_t	LoadConfigFromFile (const std::string &configFilename, const std::string &sectionName="")
	Give the file name, find out the corresponding section. Then call the main starter. More...

virtual void	Merge (const TRestMetadata &)

TRestMetadata &	operator= (const TRestMetadata &)

void	Print ()
	Implementing TObject::Print() method. More...

void	PrintConfigBuffer ()
	Print the config xml section stored in the class. More...

void	PrintMessageBuffer ()
	Print the buffered message. More...

virtual void	PrintMetadata ()
	Implemented it in the derived metadata class to print out specific metadata information. More...

void	PrintTimeStamp (Double_t timeStamp)
	Print the current time on local machine. More...

void	SetConfigFile (std::string configFilename)
	set config file path from external More...

void	SetError (std::string message="", bool print=true, int maxPrint=5)
	A metadata class may use this method to signal that something went wrong. More...

void	SetHostmgr (TRestManager *m)
	Set the host manager for this class. More...

void	SetSectionName (std::string sName)
	set the section name, clear the section content More...

void	SetVerboseLevel (TRestStringOutput::REST_Verbose_Level v)
	sets the verbose level More...

void	SetWarning (std::string message="", bool print=true, int maxPrint=5)
	A metadata class may use this method to signal that something went wrong. More...

void	Store ()
	If this method is called the metadata information will be stored in disk. More...

	TRestMetadata (const TRestMetadata &)

virtual void	UpdateMetadataMembers ()
	Method to allow implementation of specific metadata members updates at inherited classes. More...

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
	overwriting the write() method with fStore considered More...

void	WriteConfigBuffer (std::string fName)
	Writes the config buffer to a file in append mode. More...

	~TRestMetadata ()
	TRestMetadata default destructor. More...

Private Member Functions
void	InitFromConfigFile () override
	Initializes the readout members using the information given in the TRestDetectorReadout RML section. More...

void	Initialize () override
	Initializes the readout members and defines the section name. More...

TRestDetectorReadoutModule definitions void	ValidateReadout () const
	This method is not implemented yet. But it could do some checks to help verifying the readout. More...

Private Attributes
Int_t	fMappingNodes

coordinate mapping See also TRestDetectorReadoutMapping std::vector< TRestDetectorReadoutModule >	fModuleDefinitions

std::vector< TRestDetectorReadoutPlane >	fReadoutPlanes
	A std::vector storing the TRestDetectorReadoutPlane definitions. More...

Additional Inherited Members
Protected Member Functions inherited from TRestMetadata
std::string	ElementToString (TiXmlElement *ele)
	Convert an TiXmlElement object to string. More...

TVector2	Get2DVectorParameterWithUnits (std::string parName, TiXmlElement *e, TVector2 defaultValue=TVector2(-1, -1))

TVector3	Get3DVectorParameterWithUnits (std::string parName, TiXmlElement *e, TVector3 defaultValue=TVector3(-1, -1, -1))

Double_t	GetDblParameterWithUnits (std::string parName, TiXmlElement *e, Double_t defaultVal=PARAMETER_NOT_FOUND_DBL)

TiXmlElement *	GetElement (std::string eleDeclare, TiXmlElement *e=nullptr)
	Get an xml element from a given parent element, according to its declaration. More...

TiXmlElement *	GetElementFromFile (std::string configFilename, std::string NameOrDecalre="")
	Open an xml encoded file and find its element. More...

TiXmlElement *	GetElementWithName (std::string eleDeclare, std::string eleName)
	Get an xml element from the default location, according to its declaration and its field "name". More...

TiXmlElement *	GetElementWithName (std::string eleDeclare, std::string eleName, TiXmlElement *e)
	Get an xml element from a given parent element, according to its declaration and its field "name". More...

std::string	GetFieldValue (std::string fieldName, std::string definition, size_t fromPosition=0)
	Gets field value in an xml element string by parsing it as TiXmlElement. More...

std::string	GetFieldValue (std::string parName, TiXmlElement *e)
	Returns the field value of an xml element which has the specified name. More...

std::string	GetKEYDefinition (std::string keyName)
	Gets the first key definition for keyName found inside buffer starting at fromPosition. More...

std::string	GetKEYDefinition (std::string keyName, size_t &Position)

std::string	GetKEYDefinition (std::string keyName, size_t &Position, std::string buffer)

std::string	GetKEYDefinition (std::string keyName, std::string buffer)

std::string	GetKEYStructure (std::string keyName)
	Gets the first key structure for keyName found inside buffer after fromPosition. More...

std::string	GetKEYStructure (std::string keyName, size_t &Position)

std::string	GetKEYStructure (std::string keyName, size_t &Position, std::string buffer)

std::string	GetKEYStructure (std::string keyName, size_t &Position, TiXmlElement *ele)

std::string	GetKEYStructure (std::string keyName, std::string buffer)

TiXmlElement *	GetNextElement (TiXmlElement *e)
	Get the next sibling xml element of this element, with same eleDeclare. More...

std::string	GetParameter (std::string parName, size_t &pos, std::string inputString)
	Returns the value for the parameter name parName found in inputString. More...

std::string	GetParameter (std::string parName, TiXmlElement *e, TString defaultValue=PARAMETER_NOT_FOUND_STR)
	Returns the value for the parameter named parName in the given section. More...

std::pair< std::string, std::string >	GetParameterAndUnits (std::string parname, TiXmlElement *e=nullptr)
	Returns the unit string of the given parameter of the given xml section. More...

std::map< std::string, std::string >	GetParametersList ()
	It retrieves a map of all parameter:value found in the metadata class. More...

TString	GetSearchPath ()

virtual void	InitFromConfigFile ()
	To make settings from rml file. This method must be implemented in the derived class. More...

virtual void	InitFromRootFile ()
	Method called after the object is retrieved from root file. More...

virtual Int_t	LoadSectionMetadata ()
	This method does some preparation of xml section. More...

void	ReadAllParameters ()
	Reflection methods, Set value of a datamember in class according to TRestMetadata::fElement. More...

void	ReadParametersList (std::map< std::string, std::string > &list)
	It reads a parameter list and associates it to its corresponding metadata member. par0 --> fPar0. More...

std::string	ReplaceConstants (const std::string buffer)
	Identifies "constants" in the input buffer, and replace them with corresponding value. More...

std::string	ReplaceVariables (const std::string buffer)
	Identifies environmental variable replacing marks in the input buffer, and replace them with corresponding value. More...

void	ReSetVersion ()
	Resets the version of TRestRun to REST_RELEASE. Only TRestRun is allowed to update version. More...

std::string	SearchFile (std::string filename)
	Search files in current directory and directories specified in "searchPath" section. More...

void	SetLibraryVersion (TString version)
	Set the library version of this metadata class. More...

TiXmlElement *	StringToElement (std::string definition)
	Parsing a string into TiXmlElement object. More...

	TRestMetadata ()
	TRestMetadata default constructor. More...

	TRestMetadata (const char *configFilename)
	constructor More...

void	UnSetVersion ()
	Resets the version of TRestRun to -1, in case the file is old REST file. Only TRestRun is allowed to update version. More...

Protected Attributes inherited from TRestMetadata
std::string	configBuffer
	The buffer where the corresponding metadata section is stored. Filled only during Write() More...

std::string	fConfigFileName
	Full name of the rml file. More...

std::map< std::string, std::string >	fConstants
	Saving a list of rml constants. name-value std::pair. Constants are temporary for this class only. More...

TiXmlElement *	fElement
	Saving the sectional element together with global element. More...

TiXmlElement *	fElementGlobal
	Saving the global element, to be passed to the resident class, if necessary. More...

Bool_t	fError = false
	It can be used as a way to identify that something went wrong using SetError method. More...

TString	fErrorMessage = ""
	A std::string to store an optional error message through method SetError. More...

TRestManager *	fHostmgr
	All metadata classes can be initialized and managed by TRestManager. More...

Int_t	fNErrors = 0
	It counts the number of errors notified. More...

Int_t	fNWarnings = 0
	It counts the number of warnings notified. More...

std::string	fSectionName
	Section name given in the constructor of the derived metadata class. More...

Bool_t	fStore
	This variable is used to determine if the metadata structure should be stored in the ROOT file. More...

std::map< std::string, std::string >	fVariables
	Saving a list of rml variables. name-value std::pair. More...

TRestStringOutput::REST_Verbose_Level	fVerboseLevel
	Verbose level used to print debug info. More...

Bool_t	fWarning = false
	It can be used as a way to identify that something went wrong using SetWarning method. More...

TString	fWarningMessage = ""
	It can be used as a way to identify that something went wrong using SetWarning method. More...

std::string	messageBuffer
	The buffer to store the output message through TRestStringOutput in this class. More...

endl_t	RESTendl
	Termination flag object for TRestStringOutput. More...

Constructor & Destructor Documentation

◆ TRestDetectorReadout() [1/3]

TRestDetectorReadout::TRestDetectorReadout ( )

TRestDetectorReadout default constructor.

Definition at line 295 of file src/TRestDetectorReadout.cxx.

◆ TRestDetectorReadout() [2/3]

TRestDetectorReadout::TRestDetectorReadout ( const char * configFilename )

explicit

TRestDetectorReadout constructor loading data from a config file.

If no configuration path was defined using TRestMetadata::SetConfigFilePath the path to the config file must be specified using full path, absolute or relative.

By default the config file must be specified with full path, absolute or relative.

First TRestDetectorReadout section occurrence will be loaded.

Parameters

configFilename A const char* giving the path to an RML file.

Definition at line 311 of file src/TRestDetectorReadout.cxx.

◆ TRestDetectorReadout() [3/3]

TRestDetectorReadout::TRestDetectorReadout	(	const char *	configFilename,
		const std::string &	name
	)

TRestDetectorReadout constructor loading data from a config file.

If no configuration path was defined using TRestMetadata::SetConfigFilePath the path to the config file must be specified using full path, absolute or relative.

By default the config file must be specified with full path, absolute or relative.

Parameters

configFilename	A const char* giving the path to an RML file.
name	The name of the TRestDetectorReadout section to be loaded

Definition at line 331 of file src/TRestDetectorReadout.cxx.

Member Function Documentation

◆ AddReadoutPlane()

void TRestDetectorReadout::AddReadoutPlane ( const TRestDetectorReadoutPlane & plane )

Adds a readout plane to the readout.

Definition at line 457 of file src/TRestDetectorReadout.cxx.

◆ Draw()

void TRestDetectorReadout::Draw ( )

Draws the readout on screen. Not yet implemented.

Definition at line 842 of file src/TRestDetectorReadout.cxx.

◆ Export()

void TRestDetectorReadout::Export ( const std::string & fileName )

Export readout to a root file.

Definition at line 857 of file src/TRestDetectorReadout.cxx.

◆ GetAllDaqIds()

set< Int_t > TRestDetectorReadout::GetAllDaqIds ( )

Definition at line 892 of file src/TRestDetectorReadout.cxx.

◆ GetDaqId()

Int_t TRestDetectorReadout::GetDaqId	(	const TVector3 &	position,
		bool	check = `true`
	)

Returns the DaqID of the channel for position. If no channel is found returns -1.

Definition at line 867 of file src/TRestDetectorReadout.cxx.

◆ GetHitsDaqChannel()

Int_t TRestDetectorReadout::GetHitsDaqChannel	(	const TVector3 &	position,
		Int_t &	planeID,
		Int_t &	moduleID,
		Int_t &	channelID
	)

Definition at line 695 of file src/TRestDetectorReadout.cxx.

◆ GetHitsDaqChannelAtReadoutPlane()

std::tuple< Int_t, Int_t, Int_t > TRestDetectorReadout::GetHitsDaqChannelAtReadoutPlane	(	const TVector3 &	position,
		Int_t	planeId = `0`
	)

Returns a tuple with the DaqID, ModuleID, ChannelID.

This method recovers the channel daq id corresponding to the (x,y,z) coordinates given by argument. It will fill the value the corresponding moduleID, and channelID where the hit was found, while it will return the value of the daq channel id.

It will search only at the specified readout plane.

This method requires to specify the plane id where the readout channel is to be found. If not given, the default value will be planeId = 0.

Returns: the value of the daq id corresponding to the readout channel

Definition at line 728 of file src/TRestDetectorReadout.cxx.

◆ GetModuleDefinitionId()

Int_t TRestDetectorReadout::GetModuleDefinitionId ( const TString & name )

Returns the id of the readout module with a given name.

Definition at line 382 of file src/TRestDetectorReadout.cxx.

◆ GetNumberOfChannels()

Int_t TRestDetectorReadout::GetNumberOfChannels ( )

Returns the total number of channels implemented in all the readout planes and modules.

Definition at line 369 of file src/TRestDetectorReadout.cxx.

◆ GetNumberOfModules()

Int_t TRestDetectorReadout::GetNumberOfModules ( )

Returns the total number of modules implemented in all the readout planes.

Definition at line 357 of file src/TRestDetectorReadout.cxx.

◆ GetNumberOfReadoutPlanes()

Int_t TRestDetectorReadout::GetNumberOfReadoutPlanes ( ) const

inline

Definition at line 61 of file TRestDetectorReadout.h.

◆ GetPlaneModuleChannel()

void TRestDetectorReadout::GetPlaneModuleChannel	(	Int_t	daqID,
		Int_t &	planeID,
		Int_t &	moduleID,
		Int_t &	channelID
	)

Definition at line 679 of file src/TRestDetectorReadout.cxx.

◆ GetReadoutChannelWithDaqID()

TRestDetectorReadoutChannel * TRestDetectorReadout::GetReadoutChannelWithDaqID ( int daqId )

Returns a pointer to the readout channel by daq id.

Definition at line 425 of file src/TRestDetectorReadout.cxx.

◆ GetReadoutModuleWithID()

TRestDetectorReadoutModule * TRestDetectorReadout::GetReadoutModuleWithID ( int id )

Returns a pointer to the readout module by ID.

e.g. micromegas M0 has id 0, M5 has id 5. The ID is Unique of all the readout mudules

Definition at line 409 of file src/TRestDetectorReadout.cxx.

◆ GetReadoutPlane()

TRestDetectorReadoutPlane * TRestDetectorReadout::GetReadoutPlane ( int p )

Returns a pointer to the readout plane by index.

Definition at line 441 of file src/TRestDetectorReadout.cxx.

◆ GetReadoutPlaneWithID()

TRestDetectorReadoutPlane * TRestDetectorReadout::GetReadoutPlaneWithID ( int id )

Returns a pointer to the readout plane by ID.

Definition at line 394 of file src/TRestDetectorReadout.cxx.

◆ GetTypeForChannelDaqId()

string TRestDetectorReadout::GetTypeForChannelDaqId ( Int_t daqId )

Definition at line 907 of file src/TRestDetectorReadout.cxx.

◆ GetX() [1/2]

Double_t TRestDetectorReadout::GetX	(	Int_t	planeID,
		Int_t	modID,
		Int_t	chID
	)

It returns the x-coordinate for the given readout plane, plane, a given module, modID, and a given channel, chID.

Definition at line 806 of file src/TRestDetectorReadout.cxx.

◆ GetX() [2/2]

Double_t TRestDetectorReadout::GetX ( Int_t signalID )

It returns the physical X-coordinate corresponding to a given signal id in plane coordinates.

Definition at line 779 of file src/TRestDetectorReadout.cxx.

◆ GetY() [1/2]

Double_t TRestDetectorReadout::GetY	(	Int_t	planeID,
		Int_t	modID,
		Int_t	chID
	)

It returns the y-coordinate for the given readout plane, plane, a given module, modID, and a given channel, chID.

Definition at line 815 of file src/TRestDetectorReadout.cxx.

◆ GetY() [2/2]

Double_t TRestDetectorReadout::GetY ( Int_t signalID )

It returns the physical Y-coordinate corresponding to a given signal id in plane coordinates.

Definition at line 792 of file src/TRestDetectorReadout.cxx.

◆ InitFromConfigFile()

void TRestDetectorReadout::InitFromConfigFile ( )

overrideprivatevirtual

Initializes the readout members using the information given in the TRestDetectorReadout RML section.

Reimplemented from TRestMetadata.

Definition at line 465 of file src/TRestDetectorReadout.cxx.

◆ Initialize()

void TRestDetectorReadout::Initialize ( )

overrideprivatevirtual

Initializes the readout members and defines the section name.

Reimplemented from TRestMetadata.

Definition at line 342 of file src/TRestDetectorReadout.cxx.

◆ operator[]()

TRestDetectorReadoutPlane & TRestDetectorReadout::operator[] ( int p )

inline

Definition at line 50 of file TRestDetectorReadout.h.

◆ ParseModuleDefinition()

TRestDetectorReadoutModule * TRestDetectorReadout::ParseModuleDefinition ( TiXmlElement * moduleDefinition )

Definition at line 552 of file src/TRestDetectorReadout.cxx.

◆ PrintMetadata() [1/2]

void TRestDetectorReadout::PrintMetadata ( )

inlineoverridevirtual

Implemented it in the derived metadata class to print out specific metadata information.

Prints metadata content on screen. Usually overloaded by the derived metadata class.

Reimplemented from TRestMetadata.

Definition at line 96 of file TRestDetectorReadout.h.

◆ PrintMetadata() [2/2]

void TRestDetectorReadout::PrintMetadata ( Int_t DetailLevel )

Prints on screen the details about the readout definition.

Parameters

fullDetail Prints all modules, channels and pixels info.

Definition at line 825 of file src/TRestDetectorReadout.cxx.

◆ ValidateReadout()

void TRestDetectorReadout::ValidateReadout ( ) const

private

This method is not implemented yet. But it could do some checks to help verifying the readout.

Definition at line 665 of file src/TRestDetectorReadout.cxx.

Field Documentation

◆ fMappingNodes

Int_t TRestDetectorReadout::fMappingNodes

private

Definition at line 42 of file TRestDetectorReadout.h.

◆ fModuleDefinitions

* coordinate mapping See also TRestDetectorReadoutMapping* std::vector<TRestDetectorReadoutModule> TRestDetectorReadout::fModuleDefinitions

private

Definition at line 44 of file TRestDetectorReadout.h.

◆ fReadoutPlanes

std::vector<TRestDetectorReadoutPlane> TRestDetectorReadout::fReadoutPlanes

private

A std::vector storing the TRestDetectorReadoutPlane definitions.

Definition at line 40 of file TRestDetectorReadout.h.

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

Detailed Description

Constructing the readout through an RML file

The decoding

Using the readout class

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ TRestDetectorReadout() [1/3]

◆ TRestDetectorReadout() [2/3]

◆ TRestDetectorReadout() [3/3]

Member Function Documentation

◆ AddReadoutPlane()

◆ Draw()

◆ Export()

◆ GetAllDaqIds()

◆ GetDaqId()

◆ GetHitsDaqChannel()

◆ GetHitsDaqChannelAtReadoutPlane()

◆ GetModuleDefinitionId()

◆ GetNumberOfChannels()

◆ GetNumberOfModules()

◆ GetNumberOfReadoutPlanes()

◆ GetPlaneModuleChannel()

◆ GetReadoutChannelWithDaqID()

◆ GetReadoutModuleWithID()

◆ GetReadoutPlane()

◆ GetReadoutPlaneWithID()

◆ GetTypeForChannelDaqId()

◆ GetX() [1/2]

◆ GetX() [2/2]

◆ GetY() [1/2]

◆ GetY() [2/2]

◆ InitFromConfigFile()

◆ Initialize()

◆ operator[]()

◆ ParseModuleDefinition()

◆ PrintMetadata() [1/2]

◆ PrintMetadata() [2/2]

◆ ValidateReadout()

Field Documentation

◆ fMappingNodes

◆ fModuleDefinitions

◆ fReadoutPlanes