Detailed Description

A class used to define and generate a spider structure mask.

This class is used to generate a spider mask structure defined by arms distributed at a fixed angular period, defined by fArmsSeparationAngle,

The spider pattern is centered in (0,0) and it can be shifted using the offset defined inside TRestPatternMask. It must be noted that it is the pattern that will be shifted and not the mask. The circular mask imposed by TRestPatternMask will still be centered at (0,0).

Specific spider metadata parameters

armsSeparationAngle: This parameter defines the spider periodicity in radians.
armsWidth: The width of each arm in radians.
initialRadius: The radius from which the ring structure starts to be effective.
internalRegionRadius: If different from 0, which is the default, it will define an additional circular region inside the initialRadius where the spider structure starts.

Note: Once those parameters have been initialized, and when using this class in a stand-alone mode, we need to call the method TRestSpiderMask::GenerateSpider in order to initialize the internal data members TRestSpiderMask::fPositiveRanges and TRestSpiderMask::fNegativeRanges that are effectively used inside the TRestSpiderMask::GetRegion calculation.

Common pattern metadata parameters

On top of the metadata class parameters, we may define common pattern parameters to induce an offset and rotation to the pattern.

offset: A parameter to shift the spider pattern.
maskRadius: A radius defining the limits of the circular mask.

Examples

Mask pattern RML definitions can be found inside the file REST_PATH/examples/masks.rml.

The following definition ilustrates a complete RML implementation of a TRestSpiderMask.

<TRestSpiderMask name="spider3" verboseLevel="info">
  <parameter name="maskRadius" value="20cm"/>
  <parameter name="offset" value="(0,0)cm"/>
  <parameter name="rotationAngle" value="30deg"/>
 
  <parameter name="armsWidth" value="5deg"/>
  <parameter name="armsSeparationAngle" value="60degrees"/>
  <parameter name="initialRadius" value="6cm"/>
</TRestSpiderMask>

The basic use of this class is provided by the TRestSpiderMask::GetRegion method. For example:

TRestSpiderMask mask("masks.rml", "spider");
Int_t id = mask.GetRegion( 12.5, 4.3 );
std::cout << "Region id is : " << id << endl;

The following figure may be generated using the TRestPatternMask::DrawMonteCarlo method, using spider1, spider2 and spider3 definitions.

TRestSpiderMask mask("masks.rml", "spider2");
mask.GenerateSpider();
TCanvas *c = mask.DrawMonteCarlo(30000);
c->Draw();
c->Print("spider2.png");

REST-for-Physics - Software for Rare Event Searches Toolkit

History of developments:

2022-05: First implementation of TRestSpiderMask Javier Galan

Author: : Javier Galan - javie.nosp@m.r.ga.nosp@m.lan@u.nosp@m.niza.nosp@m.r.es

Definition at line 29 of file TRestSpiderMask.h.

#include <TRestSpiderMask.h>

Inheritance diagram for TRestSpiderMask:

Public Member Functions
	ClassDefOverride (TRestSpiderMask, 2)

void	GenerateSpider ()
	This method is used to initialize the spider arm angles data members that are used to determine if a particle hits the spider pattern. More...

Double_t	GetArmsSeparationAngle ()
	It returns the gap/periodicity of the spider structure arms in radians. More...

Double_t	GetArmsWidth ()
	It returns the angular width of each spider arm in radians. More...

Double_t	GetInitialRadius ()
	It returns the inner ring radius that defines the inner start of the spider structure. More...

virtual Int_t	GetRegion (Double_t &x, Double_t &y) override
	It returns a number identifying the region where the particle with coordinates (x,y) felt in. The method returns 0 if the particle hits the pattern. More...

void	PrintMask () override
	Prints on screen the information about the metadata members from this class, including common pattern headers, but without common metadata headers. More...

void	PrintMaskMembers () override
	Prints on screen the information about the metadata members from this class, excluding common metadata headers. More...

void	PrintMetadata () override
	Prints on screen the complete information about the metadata members from this class. More...

	TRestSpiderMask ()
	Default constructor. More...

	TRestSpiderMask (const char *cfgFileName, std::string name="")
	Constructor loading data from a config file. More...

	~TRestSpiderMask ()
	Default destructor. More...

Public Member Functions inherited from TRestPatternMask
	ClassDefOverride (TRestPatternMask, 1)

TCanvas *	DrawMonteCarlo (Int_t nSamples=10000)
	It generates a Monte Carlo with positions and paints them the returned canvas. Each unique region is associated with different colors. If there are too many colors, they might be repited for different region ids. More...

Double_t	GetMaskRadius ()
	It returns the mask radius. More...

Int_t	GetMaxRegions ()

TVector2	GetOffset ()
	It returns the rotation angle. More...

virtual Int_t	GetRegion (Double_t &x, Double_t &y)
	To be implemented at the inherited class with the pattern and region identification logic. More...

Double_t	GetRotationAngle ()
	It returns the rotation angle. More...

std::string	GetType ()
	It returns the mask pattern type. More...

Bool_t	HitsPattern (Double_t x, Double_t y)
	Returns true if the pattern was hit. If (x,y) it is inside a region then, the pattern was not hit by (x,y). More...

void	PrintCommonPatternMembers ()
	Prints on screen the information about the metadata members without header. More...

virtual void	PrintMask ()

virtual void	PrintMaskMembers ()

void	PrintMetadata () override
	Prints on screen the information about the metadata members of TRestPatternMask. More...

void	SetMaskRadius (const Double_t &radius)
	It defines the mask radius. More...

void	SetMaxRegions (Int_t regions)

void	SetOffset (const TVector2 &offset)
	It defines the pattern offset. More...

void	SetRotationAngle (const Double_t &angle)
	It defines the rotation angle. More...

	TRestPatternMask ()
	Default constructor. More...

	TRestPatternMask (const char *cfgFileName, std::string name="")
	Constructor loading data from a config file. More...

	~TRestPatternMask ()
	Default destructor. More...

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	Initialize () override
	Function to initialize input/output event members and define the section name. More...

Private Attributes
Double_t	fArmsSeparationAngle = 0
	The angle between two consecutive spider arms measured in radians. More...

Double_t	fArmsWidth = TMath::Pi() / 18. / 4.
	The width of each specific spider arm. Measured in radians. Default is 2.5 degrees. More...

Double_t	fInitialRadius = 20.
	The spider structure will be effective from this radius, in mm. Default is from 20 mm. More...

Double_t	fInternalRegionRadius = 0.
	Radius of an internal circular region defined inside the fInitialRadius. If 0, there will be no region. More...

std::vector< std::pair< Double_t, Double_t > >	fNegativeRanges
	Used internally to define the forbidden (cosine) ang. ranges imposed by the spider structure (Pi,2Pi) More...

std::vector< std::pair< Double_t, Double_t > >	fPositiveRanges
	Used internally to define the forbidden (cosine) angular ranges imposed by the spider structure (0,Pi) More...

Additional Inherited Members
Protected Member Functions inherited from TRestPatternMask
Int_t	ApplyCommonMaskTransformation (Double_t &x, Double_t &y)
	It produces an effective mask rotation and translation for the point x,y. More...

void	SetType (const std::string &type)
	It defines the mask type. To be called by the inherited class constructor. More...

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 TRestPatternMask
Double_t	fMaskRadius = 0
	The maximum mask radius in mm (if 0 it will be infinite) More...

Int_t	fMaxRegions = 100
	The maximum number of regions allowed in each mask. 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

◆ TRestSpiderMask() [1/2]

TRestSpiderMask::TRestSpiderMask ( )

Default constructor.

Definition at line 125 of file TRestSpiderMask.cxx.

◆ TRestSpiderMask() [2/2]

TRestSpiderMask::TRestSpiderMask	(	const char *	cfgFileName,
		std::string	name = `""`
	)

Constructor loading data from a config file.

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

The default behaviour is that the config file must be specified with full path, absolute or relative.

Parameters

cfgFileName	A const char* giving the path to an RML file.
name	The name of the specific metadata. It will be used to find the corresponding TRestSpiderMask section inside the RML.

Definition at line 141 of file TRestSpiderMask.cxx.

◆ ~TRestSpiderMask()

TRestSpiderMask::~TRestSpiderMask ( )

Default destructor.

Definition at line 152 of file TRestSpiderMask.cxx.

Member Function Documentation

◆ GenerateSpider()

void TRestSpiderMask::GenerateSpider ( )

This method is used to initialize the spider arm angles data members that are used to determine if a particle hits the spider pattern.

Definition at line 216 of file TRestSpiderMask.cxx.

◆ GetArmsSeparationAngle()

Double_t TRestSpiderMask::GetArmsSeparationAngle ( )

inline

It returns the gap/periodicity of the spider structure arms in radians.

Definition at line 56 of file TRestSpiderMask.h.

◆ GetArmsWidth()

Double_t TRestSpiderMask::GetArmsWidth ( )

inline

It returns the angular width of each spider arm in radians.

Definition at line 59 of file TRestSpiderMask.h.

◆ GetInitialRadius()

Double_t TRestSpiderMask::GetInitialRadius ( )

inline

It returns the inner ring radius that defines the inner start of the spider structure.

Definition at line 62 of file TRestSpiderMask.h.

◆ GetRegion()

Int_t TRestSpiderMask::GetRegion	(	Double_t &	x,
		Double_t &	y
	)

overridevirtual

It returns a number identifying the region where the particle with coordinates (x,y) felt in. The method returns 0 if the particle hits the pattern.

The particle will be counter-rotated to emulate the mask rotation using the method TRestPatternMask::ApplyCommonMaskTransformation

Reimplemented from TRestPatternMask.

Definition at line 173 of file TRestSpiderMask.cxx.

◆ Initialize()

void TRestSpiderMask::Initialize ( )

overrideprivatevirtual

Function to initialize input/output event members and define the section name.

Reimplemented from TRestMetadata.

Definition at line 158 of file TRestSpiderMask.cxx.

◆ PrintMask()

void TRestSpiderMask::PrintMask ( )

overridevirtual

Prints on screen the information about the metadata members from this class, including common pattern headers, but without common metadata headers.

Reimplemented from TRestPatternMask.

Definition at line 303 of file TRestSpiderMask.cxx.

◆ PrintMaskMembers()

void TRestSpiderMask::PrintMaskMembers ( )

overridevirtual

Prints on screen the information about the metadata members from this class, excluding common metadata headers.

Reimplemented from TRestPatternMask.

Definition at line 313 of file TRestSpiderMask.cxx.

◆ PrintMetadata()

void TRestSpiderMask::PrintMetadata ( )

overridevirtual

Prints on screen the complete information about the metadata members from this class.

Reimplemented from TRestPatternMask.

Definition at line 292 of file TRestSpiderMask.cxx.

Field Documentation

◆ fArmsSeparationAngle

Double_t TRestSpiderMask::fArmsSeparationAngle = 0

private

The angle between two consecutive spider arms measured in radians.

Definition at line 33 of file TRestSpiderMask.h.

◆ fArmsWidth

Double_t TRestSpiderMask::fArmsWidth = TMath::Pi() / 18. / 4.

private

The width of each specific spider arm. Measured in radians. Default is 2.5 degrees.

Definition at line 36 of file TRestSpiderMask.h.

◆ fInitialRadius

Double_t TRestSpiderMask::fInitialRadius = 20.

private

The spider structure will be effective from this radius, in mm. Default is from 20 mm.

Definition at line 39 of file TRestSpiderMask.h.

◆ fInternalRegionRadius

Double_t TRestSpiderMask::fInternalRegionRadius = 0.

private

Radius of an internal circular region defined inside the fInitialRadius. If 0, there will be no region.

Definition at line 42 of file TRestSpiderMask.h.

◆ fNegativeRanges

std::vector<std::pair<Double_t, Double_t> > TRestSpiderMask::fNegativeRanges

private

Used internally to define the forbidden (cosine) ang. ranges imposed by the spider structure (Pi,2Pi)

Definition at line 48 of file TRestSpiderMask.h.

◆ fPositiveRanges

std::vector<std::pair<Double_t, Double_t> > TRestSpiderMask::fPositiveRanges

private

Used internally to define the forbidden (cosine) angular ranges imposed by the spider structure (0,Pi)

Definition at line 45 of file TRestSpiderMask.h.

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

Detailed Description

Specific spider metadata parameters

Common pattern metadata parameters

Examples

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ TRestSpiderMask() [1/2]

◆ TRestSpiderMask() [2/2]

◆ ~TRestSpiderMask()

Member Function Documentation

◆ GenerateSpider()

◆ GetArmsSeparationAngle()

◆ GetArmsWidth()

◆ GetInitialRadius()

◆ GetRegion()

◆ Initialize()

◆ PrintMask()

◆ PrintMaskMembers()

◆ PrintMetadata()

Field Documentation

◆ fArmsSeparationAngle

◆ fArmsWidth

◆ fInitialRadius

◆ fInternalRegionRadius

◆ fNegativeRanges

◆ fPositiveRanges