SpecHSum Class Reference

#include <SpecHSum.hh>

Inheritance diagram for SpecHSum:

Public Member Functions
	SpecHSum (const string &spec_name, Spectrum *spec)
	SpecHSum (const string &spec_name, const TH1 *hptr)
	SpecHSum (const SpecHSum &original)
virtual	~SpecHSum ()
const TH1 *	GetRefHisto () const
u_int	TypeId () const
string	Type () const
virtual u_int	Dimension () const
virtual string	Definition () const
virtual string	DefinitionString () const
	ClassDef (SpecHSum, 0)
Public Member Functions inherited from Spec3Dim
	Spec3Dim (const string &spec_name, const u_int nx, const double x1, const double x2, const u_int ny, const double y1, const double y2, const u_int nz, const double z1, const double z2)
	Spec3Dim (const Spec3Dim &original)
virtual	~Spec3Dim ()
virtual u_int	Zdim () const
virtual double	Zmin () const
virtual double	Zmax () const
virtual int	BinZ (const Data &d) const
	ClassDef (Spec3Dim, 0)
Public Member Functions inherited from Spec2Dim
	Spec2Dim (const string &spec_name, const u_int nx, const double x1, const double x2, const u_int ny, const double y1, const double y2)
	Spec2Dim (const Spec2Dim &original)
virtual	~Spec2Dim ()
virtual u_int	Ydim () const
virtual double	Ymin () const
virtual double	Ymax () const
virtual int	BinY (const Data &d) const
	ClassDef (Spec2Dim, 0)
Public Member Functions inherited from Spec1Dim
	Spec1Dim (const string &spec_name, const u_int nx, const double x1, const double x2)
	Spec1Dim (const Spec1Dim &original)
virtual	~Spec1Dim ()
virtual u_int	Xdim () const
virtual double	Xmin () const
virtual double	Xmax () const
virtual int	BinX (const Data &d) const
	ClassDef (Spec1Dim, 0)
Public Member Functions inherited from Spectrum
	Spectrum (const string &spec_name)
	Spectrum (const Spectrum &original)
virtual	~Spectrum ()
string	GetTitleX () const
string	GetTitleY () const
string	GetTitleZ () const
string	GetFamilyName () const
string	GetFilterName () const
TH1 *	GetHistoPtr () const
virtual bool	Write (ostream &os)
virtual bool	Write (FILE *fptr)
virtual string	BaseDefinitionString () const
virtual void	Start ()
virtual void	Stop ()
virtual void	Suspend ()
virtual bool	IsStarted () const
virtual bool	IsStopped () const
virtual bool	IsSuspended () const
virtual bool	IsIncremented () const
virtual bool	IsUpdated () const
virtual void	SetSelectionBit (const bool b=true)
virtual void	SetSaveSelectionBit (const bool b=true)
virtual void	SetDeleteSelectionBit (const bool b=true)
virtual bool	GetSelectionBit () const
virtual bool	GetSaveSelectionBit () const
virtual bool	GetDeleteSelectionBit () const
virtual void	SetSaveProtection (const bool b=true)
virtual void	SetDeleteProtection (const bool b=true)
virtual bool	GetSaveProtection () const
virtual bool	GetDeleteProtection () const
bool	FilterCheck () const
virtual string	StatusString () const
virtual void	Reset ()
virtual void	ClearEvent ()
virtual void	Increment ()
virtual void	Update ()
virtual SpectrumFamily *	GetFamilyPtr ()
virtual const SpectrumFamily *	GetFamilyPtr () const
virtual bool	SetFamily (SpectrumFamily *family)
virtual void	ResetFamily ()
virtual const Filter *	GetFilterPtr ()
virtual void	SetFilter (const Filter *f)
virtual bool	SetFilters (const string &filt_names, const EventManager *evt_mgr)
virtual void	ResetFilter ()
virtual bool	UsesContour (const RContour *ct, const bool rec=true) const
virtual bool	UsesFilter (const Filter *f, const bool rec=true) const
virtual bool	UsesSpectrum (const Spectrum *sp, const bool rec=true) const
virtual int	Compare (const Spectrum &spec) const
virtual const Param *	GetXParamPtr () const
virtual const Param *	GetYParamPtr () const
virtual const Param *	GetZParamPtr () const
virtual Int_t	GetParamNumber () const
virtual string	FilterInfo () const
virtual void	Rename (const string &name, const string &name_x="", const string &name_y="", const string &name_z="")
	ClassDef (Spectrum, 0)

Static Public Member Functions
static Spectrum *	NewSpectrumDef (const string &name, const string &defstr, const EventManager *evt_mgr, int &error)
Static Public Member Functions inherited from Spectrum
static string	ValidName (const string s_name)
static Spectrum *	ReadSpectrum (FILE *fptr, const EventManager *evt_mgr, string &fam, string &filt, int &error)
static Spectrum *	NewSpectrum (const string &str, const EventManager *evt_mgr, string &fam, string &filt)
static Spectrum *	NewSpectrum (const string &str, const EventManager *evt_mgr, string &fam, string &filt, int &error)
static bool	Compare (const Spectrum *spec1, const Spectrum *spec2, const UInt_t flags)
static Int_t	Compare (const Spectrum *spec1, const Spectrum *spec2)
static bool	Compare (const int sp_num, const Spectrum **sp_tab, const UInt_t flags)

Protected Member Functions
virtual TH1 *	SetHistoSum (const TH1 *hptr=NULL)
virtual void	IncrementSpectrum ()
Protected Member Functions inherited from Spec1Dim
string	AxisDefinition (const Param &p, const u_int dim, const double min, const double max) const
string	AxisDefinition (const string &label, const u_int dim, const double min, const double max) const
Protected Member Functions inherited from Spectrum
virtual void	IncrementFast ()
bool	FilterFastCheck () const
bool	FilterFastLocalCheck () const

Protected Attributes
const TH1 *	histo_src
	Pointer to the histogram to cumulate.
u_int	dim
	Dimension de l'histogramme.
Protected Attributes inherited from Spec3Dim
u_int	z_dim
	Nombre de canaux de la dimension Z.
double	z_min
	Valeur minimum de la dimension Z.
double	z_max
	Valeur maximum de la dimension Z.
double	z_bin
	largeur d'un bin sur l'axe Z
Protected Attributes inherited from Spec2Dim
u_int	y_dim
	Nombre de canaux de la dimension Y.
double	y_min
	Valeur minimum de la dimension Y.
double	y_max
	Valeur maximum de la dimension Y.
double	y_bin
	largeur d'un bin sur l'axe Y
Protected Attributes inherited from Spec1Dim
u_int	x_dim
	Nombre de canaux de la dimension X.
double	x_min
	Valeur minimum de la dimension X.
double	x_max
	Valeur maximum de la dimension X.
double	x_bin
	largeur d'un bin sur l'axe X
Protected Attributes inherited from Spectrum
u_int	status
	Mot d'état du spectre.
TH1 *	histo_ptr
	Pointeur sur l'histogramme Root.
SpectrumFamily **	family_ptr
const Filter **	filter_ptr
	Pointeur sur filtre associé
bool *	filter_local
	Indique si le filtre est créé localement comme un "ET" d'un ensemble de filtres.

Private Member Functions
	GObject (SpecHSum)

Additional Inherited Members
Static Protected Attributes inherited from Spectrum
static u_int	name_len = 0
	Longueur d'affichage des noms de spectres.
static u_int	type_len = 0
	Longueur d'affichage des types de spectres.
static u_int	param_name_len = 0
	Longueur d'affichage des noms de paramètres.
static u_int	dim_len = 0
	Longueur d'affichage des dimensions.
static u_int	bound_len = 0
	Longueur d'affichage des limites de spectre.
static u_int	bound_prec = 5
	Précision d'affichage des limites de spectre.

Detailed Description

The class is used to sum another spectrum or histogram, event by event.

Constructor & Destructor Documentation

SpecHSum::SpecHSum	(	const string &	spec_name,
		Spectrum *	spec
	)

Constructor

Parameters

spec_name	spectrum name
spec	pointer to the spectrum to be summed event by event

References dim, Spectrum::GetHistoPtr(), histo_src, and SetHistoSum().

Referenced by NewSpectrumDef().

SpecHSum::SpecHSum	(	const string &	spec_name,
		const TH1 *	hptr
	)

Constructor

Parameters

spec_name	spectrum name
hptr	pointer to the histogram to be summed event by event

References dim, histo_src, SetHistoSum(), and Spectrum::SetSaveProtection().

SpecHSum::SpecHSum

(

const SpecHSum &

original

)

Constructeur de recopie.

Parameters

original

instance à recopier

References dim, and histo_src.

SpecHSum::~SpecHSum ( )

virtual

Destructeur.

References Spectrum::histo_ptr.

Member Function Documentation

SpecHSum::GObject ( SpecHSum  )

private

Macro from GCpp library that defines the following functions:

• ClassName(): return the real class name of the object
• StaticClassName(): return the used class name of the object (that may be a base class of the real object).
• IsInstanceOf<T>(): return true if the current object is an instance of the template class name argument
• Clone(): return an allocated copy of the object.

TH1 * SpecHSum::SetHistoSum ( const TH1 *  hptr = NULL )

protectedvirtual

Set the histogram to be cumulated. The function returns the pointer to the sum histogram if no error occured (NULL otherwise).

Parameters

hptr	pointer to the histogram to be summed event by event

References dim, Spectrum::histo_ptr, histo_src, Spec1Dim::x_bin, Spec1Dim::x_dim, Spec1Dim::x_max, Spec1Dim::x_min, Spec2Dim::y_bin, Spec2Dim::y_dim, Spec2Dim::y_max, Spec2Dim::y_min, Spec3Dim::z_bin, Spec3Dim::z_dim, Spec3Dim::z_max, and Spec3Dim::z_min.

Referenced by SpecHMean::SetHistoMean(), and SpecHSum().

void SpecHSum::IncrementSpectrum ( )

protectedvirtual

Incrémentation automatique du spectre à partir du paramètre associé. Pour un spectre trace, chaque valeur du paramètre tableau est rangée dans un bin de l'histogramme (celui-ci est effacé avant).

Reimplemented from Spectrum.

Reimplemented in SpecHMean.

References Spectrum::histo_ptr, and histo_src.

const TH1 * SpecHSum::GetRefHisto ( ) const

inline

Returns the pointer to the reference histogram for the spectrum.

References histo_src.

Referenced by GEVSpectrumEditor::Copy().

u_int SpecHSum::TypeId ( ) const

inlinevirtual

Retourne l'identificateur du type de spectre.

Implements Spectrum.

string SpecHSum::Type ( ) const

inlinevirtual

Retourne le nom du type de spectre.

Implements Spectrum.

References SPECTRUM_TYPE_TXT_HSUM.

Referenced by Definition().

u_int SpecHSum::Dimension ( ) const

inlinevirtual

Fonction qui retourne la dimension du spectre.

Reimplemented from Spec3Dim.

References dim.

Referenced by Definition().

string SpecHSum::Definition ( ) const

virtual

Méthode qui retourne une chaîne décrivant le spectre: type, paramètre, dimension, etc...

Implements Spectrum.

References Dimension(), Spectrum::FilterInfo(), histo_src, Spectrum::name_len, and Type().

string SpecHSum::DefinitionString ( ) const

virtual

Fonction qui retourne la chaîne de définition d'un spectre au format d'écriture dans un fichier.

Implements Spectrum.

References Spectrum::BaseDefinitionString(), and histo_src.

Spectrum * SpecHSum::NewSpectrumDef ( const string &  sp_name, const string &  def_str, const EventManager *  evt_mgr, int &  error  )

static

Lecture de la définition spécifique d'un spectre dans une chaîne de caractères, pour allocation d'un nouveau spectre de ce type. La fonction retourne le pointeur sur le spectre alloué, et NULL en cas d'erreur (auquel cas la variable error prend une valeur négative en retour).

Parameters

sp_name	nom du spectre
def_str	chaîne de définition (fichier spectre)
evt_mgr	pointeur sur le gestionnaire d'événements
error	erreur en sortie

References EventManager::GetSpectrumPtr(), and SpecHSum().

Referenced by Spectrum::NewSpectrum().

SpecHSum::ClassDef	(	SpecHSum	,
		0
	)

Définition à usage de ROOT...

---

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

• SpecHSum.hh
• SpecHSum.cpp