Detailed Description

Perform the plot over datasets.

This class is meant to perform the plots over a TRestDataSet and it is meant to replace TRestAnalysisPlot. A dataset is should be provided as input file in order to perform de plots, in addition the possibility to provide a file pattern is also supported for backward compatibility although this method will be deprecated. The rml file has been modified with respect to TRestAnalysisPlot, major changes are that now a TRestCut must be defined in advance in order to perform the cuts over the dataset, in addition the panel/label metadata has been changed in order to distinguish between metadata, variables or observable values.

The rml file can be splitted in three main blocks that are detailed below;

Basic parameters: global variables to perform the plot such as canvas size, pad divisions, preview or outputFile info.
Panel parameters: A panel defines different labels that will be written in a pad, it accepts different parameters such as metadata info, variable values, and observable values, that can be written in the panel. A cut can be provided to a panel in order to print the info after appliying a particular cut.
Plot parameters: It contains the info to produce a plot at the pad level. A plot consists of a set of histograms that can be plot together using THStack, note that only 1D and 2D histograms are supported. The histograms are defined inside the plot metadata section and one or two variables must be provided (1D or 2D histos) besides the range, while a cut can be set at the histogram level.

Parameters

Basic parameters of TRestDataSetPlot:
name: Name of the TRestDataSetPlot class and canvas
title: Title of the TRestDataSetPlot class and canvas
dataSetName: Name of the dataSet to be used to perform the plots. Note that if this variable is empty, it will use the name of the inputfile provided at restManager.
outputFileName: Name of the output file to be generated. Note that if this variable is empty, it will use the name of the outputFile provided at restManager, if still empty no outputFile will we generated. Note that it supports several formats such as root, pdf, eps, jpg,... If the output file is a root file, the different histograms and metadata will be saved besides the canvas.
previewPlot: If true the plot (canvas) is displayed and can be modified before saving it.
paletteStyle: Style of the palette to be used in all the plots.
legendX1: Start position of the legend in the X axis
legendY1: Start position of the legend in the X axis
legendX2: End position of the legend in the X axis
legendY2: End position of the legend in the X axis
canvasSize: TVector2 with the size of the canvas in points
canvasDivisions: TVector2 with the divisions of the canvas e.g. (3, 2) --> 3 x 2 The key addCut can be povided in order to perform the cut to the entire dataSet. Note that the TRestCut must be defined inside the rml and several cuts can be added.

Example of TRestDataSetPlot basic parameters with a set TRestCuts:

<TRestDataSetPlot name="restplot" title="Basic Plots" previewPlot="true" canvasSize="(1200,1200)"
canvasDivisions="(2,2)" verboseLevel="info">
  <addCut name="North"/>
  <addCut name="TrackBalance"/>
  <TRestCut name="North" verboseLevel="info">
      <cut name="c1" variable="alphaTrackAna_originZ" condition="<0"/>
  </TRestCut>
  <TRestCut name="TrackBalance" verboseLevel="info">
      <cut name="c2" variable="alphaTrackAna_trackBalanceX" condition=">0.9"/>
      <cut name="c3" variable="alphaTrackAna_trackBalanceY" condition=">0.9"/>
  </TRestCut>
</TRestDataSetPlot>

Panel parameters: Basic panel parameters:
font_size: Font size of the entire panel.
precision: Precision for the values to be written.
value: If true/ON panel is displayed, otherwise is ignored Different keys are provided: metadata is meant for the metadata info inside the TRestDataSet (as a RelevantQuantity), variable for a predefined variable e.g. rate, observable for an observable value and expression for a mathematical expression that can contain any of the previous. Note that the time-related variables startTime, endTime and runLength (then meanRate too) are obtained from the TRestDataSet and not the RDataFrame of the TRestDataSet, thus they are not afected by the cuts. All the keys have the same structure which is detailed below:
value: Name of the metadata, variable or observable value.
label: String of the label that will be written before the observable value.
units: String with the units to be appended to the label.
x: X position of the label inside the pad
y: Y position of the label inside the pad The key addCut can be povided in order to perform the cut to the panel. Note that the TRestCut must be defined inside the rml.

Example of panel rule:

<panel font_size="0.05" precision="3">
      <metadata value="[TRestRun::fRunTag]" label="Run tag" x="0.25" y="0.82" />
      <variable value="[[entries]]" label="Entries" x="0.25" y="0.58" />
      <observable value="alphaTrackAna_angle" label="Mean Angle" units="rad" x="0.25" y="0.01" />
      <expression value="cos(alphaTrackAna_angle)^2" label="Cosine of the mean angle" units="" x="0.25"
      y="0.12" />
      <expression value="[TRestDetector::fDriftField]*[TRestDetector::fPressure]" label="Drift field"
      units="V/cm" x="0.25" y="0.24" />
      <addCut name="Fiducial"/>
</panel>

Plot parameters:
name: Name of the plot
title: Title of the plot
xlabel: Title of the label in the X axis
ylabel: Title of the label in the Y axis
logX;logY;logZ: If true plot log scale in the corresponding axis (X, Y or Z)
gridX;gridY: If true plot grid in the corresponding axis (X or Y)
marginLeft;marginRight;marginTop;marginBottom: Margins size
legend: If true/ON it plots the legend
stackOption*: THStack draw option to be used, note that by default is set to NOSTACK
**timeDisplay: If true/ON time display is set in the X axis
norm: Normalization constant in which the plot will be normalized, e.g. use 1 in case you want to normalize by 1.
scale: Divide all the histogram bins by a constant given by scale. You may use any mathematical expression in combination with the special keywords: binSize, entries, runLength (in hours) and integral. Adding a scale will make the histogram to be drawn with errors. To avoid this, set parameter option to 'hist' in the histogram.
value: If true/ON plot is displayed, otherwise is ignored
save: String with the name of the output file in which the plot will be saved in a separated file, several formats are supported (root, pdf, eps, jpg,...)
Histogram parameters: Please, use the histo key inside plot to add the plot parameters. You can add as many histograms as you want but note that only 1D and 2D histograms are supported.
name: Name of the histogram
option*: Draw option to be used, note that by default is set to COLZ
**lineColor*: Color of the line used in the histogram.
**lineWidth*: Width of the line used in the histogram.
**lineStyle*: Line style to be used in the histogram.
**fillStyle*: Fill style to used in the histogram.
**fillColor*: Fill color to used in the histogram.
**stats: If true/ON it plots histogram statistics In order to add one or two variables to the histogram please use the variable key. In order to perform a 2D plot you should add two variablekeys, where the first one corresponds to the X axis. Thevariable` key has the following parameters:
**name*: Name of the observable to be plotted, the observable must be defined inside the dataSet.
**range*: TVector2 with the range of the variable to be plotted
**nBins*: Number of bins that will be used in the histogram. The key addCut can be povided in order to perform the cut to the histogram. Note that the TRestCut must be defined inside the rml.

Example of plot rule:

   <plot name="TrackOrigin" title="TrackOrigin" xlabel="X [mm]" ylabel="Y [mm]" save="HitMapUpwards.pdf"
value="ON" >
       <histo name="HitMapUpwards" >
           <variable name="alphaTrackAna_originX" range="(0,250)" nbins="256" />
           <variable name="alphaTrackAna_originY" range="(0,250)" nbins="256" />
           <addCut name="Upwards"/>
       </histo>
    </plot>

Examples

Following example creates one panel and three plots including one or two histograms:

<TRestManager name="alphaTrack" title="alphaTrack" verboseLevel="info">
  <TRestDataSetPlot name="alphaTrackPlot" title="Basic Plots for alpha tracks" previewPlot="true"
  canvasSize="(1200,1200)" canvasDivisions="(2,2)" verboseLevel="info"
  outputFileName="Plots_[TRestRun::fRunTag]_plots.root">
    <addCut name="North"/>
    <addCut name="TrackBalance"/>
    <TRestCut name="North" verboseLevel="info">
        <cut name="c1" variable="alphaTrackAna_originZ" condition="<0"/>
    </TRestCut>
    <TRestCut name="Fiducial" verboseLevel="info">
        <cut name="c2" variable="alphaTrackAna_originX" condition=">20"/>
        <cut name="c3" variable="alphaTrackAna_originX" condition="<225"/>
        <cut name="c4" variable="alphaTrackAna_originY" condition=">20"/>
        <cut name="c5" variable="alphaTrackAna_originY" condition="<225"/>
    </TRestCut>
    <TRestCut name="Upwards" verboseLevel="info">
        <cut name="c6" variable="alphaTrackAna_downwards" condition="==false"/>
    </TRestCut>
    <TRestCut name="Downwards" verboseLevel="info">
        <cut name="c7" variable="alphaTrackAna_downwards" condition="==true"/>
    </TRestCut>
    <TRestCut name="TrackBalance" verboseLevel="info">
        <cut name="c8" variable="alphaTrackAna_trackBalanceX" condition=">0.9"/>
        <cut name="c9" variable="alphaTrackAna_trackBalanceY" condition=">0.9"/>
    </TRestCut>
    <panel font_size="0.05" precision="3">
        <variable label="Summary" x="0.25" y="0.9"/>
        <metadata value="[TRestRun::fRunTag]" label="Run tag" x="0.25" y="0.82"/>
        <variable value="[[startTime]]" label="Data starts" x="0.25" y="0.74"/>
        <variable value="[[endTime]]" label="Data ends" x="0.25" y="0.66"/>
        <variable value="[[entries]]" label="Entries" x="0.25" y="0.58"/>
        <variable value="[[runLength]]" label="Run duration" units="hours" x="0.25" y="0.50"/>
        <observable value="alphaTrackAna_angle" label="Mean Angle" units="rad" x="0.25" y="0.42"/>
        <addCut name="Fiducial"/>
    </panel>
    <plot name="TrackOrigin" title="TrackOrigin" xlabel="X [mm]" ylabel="Y [mm]" save="" value="ON"
    stats="ON">
        <variable name="alphaTrackAna_originX" range="(0,250)" nbins="256"/>
        <variable name="alphaTrackAna_originY" range="(0,250)" nbins="256"/>
    </plot>
    <plot name="Spectra" title="Spectra" xlabel="Amplitude(ADC)" ylabel="Counts" legend="ON" value="ON"
    save="Spectra.pdf">
        <histo name="SpectraDownwards">
            <variable name="alphaTrackAna_totalEnergy" range="(0,1000000)" nbins="200"/>
            <addCut name="Fiducial"/>
            <addCut name="Downwards"/>
        </histo>
        <histo name="SpectraUpwards">
            <variable name="alphaTrackAna_totalEnergy" range="(0,1000000)" nbins="200"/>
            <parameter name="lineColor" value="1"/>
            <addCut name="Fiducial"/>
            <addCut name="Upwards"/>
        </histo>
    </plot>
    <plot name="Rate" title="Rate" xlabel="Date/time" ylabel="Rate (Hz)" legend="ON" value="ON"
    scale="binSize" timeDisplay="ON">
        <histo name="RateDownwards">
            <variable name="timeStamp" range="" nbins="100"/>
            <addCut name="Downwards"/>
        </histo>
        <histo name="RateUpwards">
            <variable name="timeStamp" range="" nbins="100"/>
            <parameter name="lineColor" value="1"/>
            <addCut name="Upwards"/>
        </histo>
    </plot>
  </TRestDataSetPlot>
  <addTask command="alphaTrackPlot->PlotCombinedCanvas()" value="ON"/>
</TRestManager>

Running example

restManager --c thisExample.rml --f FileWithDataSet.root

Figure to be added (a png image should be uploaded to the ./images/ directory)

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

History of developments:

2023-04: First implementation of TRestDataSetPlot, based on TRestAnalysisPlot JuanAn Garcia

2024-05: Extend some functionalities, Álvaro Ezquerro

Author: : JuanAn Garcia e-mail: juana.nosp@m.ngp@.nosp@m.uniza.nosp@m.r.es

Definition at line 33 of file TRestDataSetPlot.h.

#include <TRestDataSetPlot.h>

Inheritance diagram for TRestDataSetPlot:

Data Structures
struct	HistoInfo
	Nested classes for internal use only. More...

struct	PanelInfo
	Auxiliary class for panels/labels. More...

struct	PlotInfo
	Auxiliary struct for plots/pads. More...

Public Member Functions
	ClassDefOverride (TRestDataSetPlot, 2)

void	CleanUp ()
	Clean up histos and text but note that the metadata is unchanged. More...

void	GenerateDataSetFromFilePattern (TRestDataSet &dataSet)
	This functions generates a dataSet based on the information of the rml file. A TRestDataSet is pased as reference and will be overwritten. More...

Int_t	GetIDFromMapString (const std::map< std::string, int > &mapStr, const std::string &in)
	This functions gets the ID from a map string that is passed by reference. It is used to translate colors, line styles and fill styles from the string to an integer value. More...

void	Initialize () override
	Function to initialize input/output event members and define the section name. More...

void	PlotCombinedCanvas ()
	This functions performs the plot of the combined canvas with the different panels and plots. More...

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

TRestCut *	ReadCut (TRestCut cut, TiXmlElement ele=nullptr)
	this function is used to add the different cuts provided in different metadata sections, it uses as parameter the cut where the cut is meant to be added and returns the added cut. If *cut is a nullptr it just instantiate it More...

void	ReadPanelInfo ()
	This function reads the config file panel info and stores it in a vector of PanelInfo. More...

void	ReadPlotInfo ()
	This function reads the config file plot info and stores it in a vector of PlotInfo. More...

	TRestDataSetPlot ()
	Default constructor. More...

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

	~TRestDataSetPlot ()
	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	InitFromConfigFile () override
	Initialization of specific TRestDataSetPlot members through an RML file. More...

Private Attributes
const std::map< std::string, int >	ColorIdMap
	Maps for internal use only. More...

TVector2	fCanvasDivisionMargins = TVector2(0.01, 0.01)

TVector2	fCanvasDivisions = TVector2(2, 2)

TVector2	fCanvasSize = TVector2(800, 600)
	Canvas options, size, divisions and margins. More...

TRestCut *	fCut = nullptr
	Global cut for the entire dataSet. More...

std::string	fDataSetName = ""
	Name of the dataset to be imported. More...

const std::map< std::string, int >	FillStyleMap
	FillStyleMap as enum "EFillStyle" defined in TAttFill.h. More...

Double_t	fLegendX1 = 0.7
	Legend position and size. More...

Double_t	fLegendX2 = 0.88

Double_t	fLegendY1 = 0.75

Double_t	fLegendY2 = 0.88

std::string	fOutputFileName = ""
	OutputFileName. More...

Int_t	fPaletteStyle = 57
	Palette style. More...

std::vector< PanelInfo >	fPanels
	Vector with panels/label options. More...

std::vector< PlotInfo >	fPlots
	Vector with plots/pads options. More...

Bool_t	fPreviewPlot = true
	Preview plot. More...

const std::map< std::string, int >	LineStyleMap
	LineStyleMap as enum "ELineStyle" defined in TAttLine.h. 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

◆ TRestDataSetPlot() [1/2]

TRestDataSetPlot::TRestDataSetPlot ( )

Default constructor.

Definition at line 284 of file TRestDataSetPlot.cxx.

◆ TRestDataSetPlot() [2/2]

TRestDataSetPlot::TRestDataSetPlot	(	const char *	configFilename,
		std::string	name = `""`
	)

Constructor loading data from a config file.

Definition at line 289 of file TRestDataSetPlot.cxx.

◆ ~TRestDataSetPlot()

TRestDataSetPlot::~TRestDataSetPlot ( )

Default destructor.

Definition at line 299 of file TRestDataSetPlot.cxx.

Member Function Documentation

◆ CleanUp()

void TRestDataSetPlot::CleanUp ( )

Clean up histos and text but note that the metadata is unchanged.

Definition at line 930 of file TRestDataSetPlot.cxx.

◆ GenerateDataSetFromFilePattern()

void TRestDataSetPlot::GenerateDataSetFromFilePattern ( TRestDataSet & dataSet )

This functions generates a dataSet based on the information of the rml file. A TRestDataSet is pased as reference and will be overwritten.

Definition at line 505 of file TRestDataSetPlot.cxx.

◆ GetIDFromMapString()

Int_t TRestDataSetPlot::GetIDFromMapString	(	const std::map< std::string, int > &	mapStr,
		const std::string &	in
	)

This functions gets the ID from a map string that is passed by reference. It is used to translate colors, line styles and fill styles from the string to an integer value.

Definition at line 952 of file TRestDataSetPlot.cxx.

◆ InitFromConfigFile()

void TRestDataSetPlot::InitFromConfigFile ( )

overrideprivatevirtual

Initialization of specific TRestDataSetPlot members through an RML file.

Reimplemented from TRestMetadata.

Definition at line 310 of file TRestDataSetPlot.cxx.

◆ Initialize()

void TRestDataSetPlot::Initialize ( )

overridevirtual

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

Reimplemented from TRestMetadata.

Definition at line 305 of file TRestDataSetPlot.cxx.

◆ PlotCombinedCanvas()

void TRestDataSetPlot::PlotCombinedCanvas ( )

This functions performs the plot of the combined canvas with the different panels and plots.

Build the histograms and add them to the THStack

Definition at line 604 of file TRestDataSetPlot.cxx.

◆ PrintMetadata()

void TRestDataSetPlot::PrintMetadata ( )

overridevirtual

Prints on screen the information about the metadata members of TRestDataSetPlot.

Reimplemented from TRestMetadata.

Definition at line 968 of file TRestDataSetPlot.cxx.

◆ ReadCut()

TRestCut * TRestDataSetPlot::ReadCut	(	TRestCut *	cut,
		TiXmlElement *	ele = `nullptr`
	)

this function is used to add the different cuts provided in different metadata sections, it uses as parameter the cut where the cut is meant to be added and returns the added cut. If *cut is a nullptr it just instantiate it

Definition at line 328 of file TRestDataSetPlot.cxx.

◆ ReadPanelInfo()

void TRestDataSetPlot::ReadPanelInfo ( )

This function reads the config file panel info and stores it in a vector of PanelInfo.

Definition at line 349 of file TRestDataSetPlot.cxx.

◆ ReadPlotInfo()

void TRestDataSetPlot::ReadPlotInfo ( )

This function reads the config file plot info and stores it in a vector of PlotInfo.

Definition at line 427 of file TRestDataSetPlot.cxx.

Field Documentation

◆ ColorIdMap

const std::map<std::string, int> TRestDataSetPlot::ColorIdMap

private

Initial value:

{{"white", kWhite},   {"black", kBlack},     {"gray", kGray},
                                                {"red", kRed},       {"green", kGreen},     {"blue", kBlue},
                                                {"yellow", kYellow}, {"magenta", kMagenta}, {"cyan", kCyan},
                                                {"orange", kOrange}, {"spring", kSpring},   {"teal", kTeal},
                                                {"azure", kAzure},   {"violet", kViolet},   {"pink", kPink}}

Maps for internal use only.

ColorIdMap as enum "EColor" defined in Rtypes.h

Definition at line 108 of file TRestDataSetPlot.h.

◆ fCanvasDivisionMargins

TVector2 TRestDataSetPlot::fCanvasDivisionMargins = TVector2(0.01, 0.01)

private

Definition at line 156 of file TRestDataSetPlot.h.

◆ fCanvasDivisions

TVector2 TRestDataSetPlot::fCanvasDivisions = TVector2(2, 2)

private

Definition at line 155 of file TRestDataSetPlot.h.

◆ fCanvasSize

TVector2 TRestDataSetPlot::fCanvasSize = TVector2(800, 600)

private

Canvas options, size, divisions and margins.

Definition at line 154 of file TRestDataSetPlot.h.

◆ fCut

TRestCut* TRestDataSetPlot::fCut = nullptr

private

Global cut for the entire dataSet.

Definition at line 139 of file TRestDataSetPlot.h.

◆ fDataSetName

std::string TRestDataSetPlot::fDataSetName = ""

private

Name of the dataset to be imported.

Definition at line 133 of file TRestDataSetPlot.h.

◆ FillStyleMap

const std::map<std::string, int> TRestDataSetPlot::FillStyleMap

private

Initial value:

{
        {"dotted", kFDotted1},        {"dashed", kFDashed1},    {"dotted1", kFDotted1},
        {"dotted2", kFDotted2},       {"dotted3", kFDotted3},   {"hatched1", kFHatched1},
        {"hatched2", kHatched2},      {"hatched3", kFHatched3}, {"hatched4", kFHatched4},
        {"wicker", kFWicker},         {"scales", kFScales},     {"bricks", kFBricks},
        {"snowflakes", kFSnowflakes}, {"circles", kFCircles},   {"tiles", kFTiles},
        {"mondrian", kFMondrian},     {"diamonds", kFDiamonds}, {"waves1", kFWaves1},
        {"dashed1", kFDashed1},       {"dashed2", kFDashed2},   {"alhambra", kFAlhambra},
        {"waves2", kFWaves2},         {"stars1", kFStars1},     {"stars2", kFStars2},
        {"pyramids", kFPyramids},     {"frieze", kFFrieze},     {"metopes", kFMetopes},
        {"empty", kFEmpty},           {"solid", kFSolid}}

FillStyleMap as enum "EFillStyle" defined in TAttFill.h.

Definition at line 119 of file TRestDataSetPlot.h.

◆ fLegendX1

Double_t TRestDataSetPlot::fLegendX1 = 0.7

private

Legend position and size.

Definition at line 148 of file TRestDataSetPlot.h.

◆ fLegendX2

Double_t TRestDataSetPlot::fLegendX2 = 0.88

private

Definition at line 150 of file TRestDataSetPlot.h.

◆ fLegendY1

Double_t TRestDataSetPlot::fLegendY1 = 0.75

private

Definition at line 149 of file TRestDataSetPlot.h.

◆ fLegendY2

Double_t TRestDataSetPlot::fLegendY2 = 0.88

private

Definition at line 151 of file TRestDataSetPlot.h.

◆ fOutputFileName

std::string TRestDataSetPlot::fOutputFileName = ""

private

OutputFileName.

Definition at line 136 of file TRestDataSetPlot.h.

◆ fPaletteStyle

Int_t TRestDataSetPlot::fPaletteStyle = 57

private

Palette style.

Definition at line 142 of file TRestDataSetPlot.h.

◆ fPanels

std::vector<PanelInfo> TRestDataSetPlot::fPanels

private

Vector with panels/label options.

Definition at line 162 of file TRestDataSetPlot.h.

◆ fPlots

std::vector<PlotInfo> TRestDataSetPlot::fPlots

private

Vector with plots/pads options.

Definition at line 159 of file TRestDataSetPlot.h.

◆ fPreviewPlot

Bool_t TRestDataSetPlot::fPreviewPlot = true

private

Preview plot.

Definition at line 145 of file TRestDataSetPlot.h.

◆ LineStyleMap

const std::map<std::string, int> TRestDataSetPlot::LineStyleMap

private

Initial value:

{

{"solid", kSolid}, {"dashed", kDashed}, {"dotted", kDotted}, {"dashDotted", kDashDotted}}

LineStyleMap as enum "ELineStyle" defined in TAttLine.h.

Definition at line 115 of file TRestDataSetPlot.h.

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

Detailed Description

Parameters

Examples

Running example

Data Structures

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ TRestDataSetPlot() [1/2]

◆ TRestDataSetPlot() [2/2]

◆ ~TRestDataSetPlot()

Member Function Documentation

◆ CleanUp()

◆ GenerateDataSetFromFilePattern()

◆ GetIDFromMapString()

◆ InitFromConfigFile()

◆ Initialize()

◆ PlotCombinedCanvas()

◆ PrintMetadata()

◆ ReadCut()

◆ ReadPanelInfo()

◆ ReadPlotInfo()

Field Documentation

◆ ColorIdMap

◆ fCanvasDivisionMargins

◆ fCanvasDivisions

◆ fCanvasSize

◆ fCut

◆ fDataSetName

◆ FillStyleMap

◆ fLegendX1

◆ fLegendX2

◆ fLegendY1

◆ fLegendY2

◆ fOutputFileName

◆ fPaletteStyle

◆ fPanels

◆ fPlots

◆ fPreviewPlot

◆ LineStyleMap