SpecDiv Class Reference

#include <SpecDiv.hh>

Inheritance diagram for SpecDiv:

Public Member Functions
	SpecDiv (const string &spec_name, Spectrum *sp0, Spectrum *sp1, const Double_t c0=1., const Double_t c1=0., const Double_t c2=0.)
	SpecDiv (const SpecDiv &original)
virtual	~SpecDiv ()
virtual void	Update ()
u_int	TypeId () const
string	Type () const
	ClassDef (SpecDiv, 0)
Public Member Functions inherited from SpecOper2
	SpecOper2 (const string &spec_name, Spectrum *sp0, Spectrum *sp1, const Int_t ncoef=0)
	SpecOper2 (const SpecOper2 &original)
virtual	~SpecOper2 ()
virtual bool	CheckOperands () const
	ClassDef (SpecOper2, 0)
Public Member Functions inherited from SpecOper
	SpecOper (const string &spec_name, const Int_t ncoef=0)
	SpecOper (const SpecOper &original)
virtual	~SpecOper ()
virtual void	Increment ()
virtual bool	IsUpdated () const
virtual string	Definition () const
virtual string	DefinitionString () const
virtual Int_t	GetCoefficientNumber () const
virtual Int_t	GetOperandNumber () const
virtual Spectrum *	GetOperand (const Int_t n) const
virtual Double_t	GetCoefficient (const Int_t n) const
virtual bool	UsesSpectrum (const Spectrum *sp, const bool rec=true) const
	ClassDef (SpecOper, 0)
Public Member Functions inherited from SpecCalc
	SpecCalc (const string &spec_name)
	SpecCalc (const string &spec_name, const u_int nx, const double x1, const double x2)
	SpecCalc (const string &spec_name, const u_int nx, const double x1, const double x2, const u_int ny, const double y1, const double y2)
	SpecCalc (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)
	SpecCalc (const SpecCalc &original)
virtual	~SpecCalc ()
virtual void	SetFilter (const Filter *f) const
virtual void	Start ()
virtual void	Stop ()
virtual void	Suspend ()
virtual u_int	Dimension () const
virtual Int_t	GetParamNumber () const
	ClassDef (SpecCalc, 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 bool	IsStarted () const
virtual bool	IsStopped () const
virtual bool	IsSuspended () const
virtual bool	IsIncremented () 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 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 int	Compare (const Spectrum &spec) const
virtual const Param *	GetXParamPtr () const
virtual const Param *	GetYParamPtr () const
virtual const Param *	GetZParamPtr () 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 &sp_name, const string &def_str, 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)

Private Member Functions
	GObject (SpecDiv)

Additional Inherited Members
Static Public Attributes inherited from SpecOper
static Double_t	epsilon = 1.e-12
	Limite de test des divisions par zéro
Protected Member Functions inherited from SpecOper2
virtual void	SetHistoXY ()
Protected Member Functions inherited from SpecOper
virtual Int_t	SetOperData (const string &defstr, const EventManager *evt_mgr)
virtual void	SetHistoBad ()
virtual void	SetHisto (const Int_t op=0)
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
Static Protected Member Functions inherited from SpecOper
static Int_t	SetOperData (const string &def_str, const EventManager *evt_mgr, Int_t &nop, Spectrum **&op, Int_t &nco, Double_t *&co)
Protected Attributes inherited from SpecOper
Int_t	oper_num
	Nombre de spectres opérandes.
Int_t	coef_num
	Nombre de coefficients.
Spectrum **	oper
	Table des pointeurs des spectres opérandes.
Double_t *	coef
	Table des coefficients.
Protected Attributes inherited from SpecCalc
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.
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

Classe des spectres obtenus par le rapport de 2 spectres opérandes. Ce type de spectre utilise 3 coefficients:

• S' = a * S0 / S1 + b si S1 est différent de 0
• S' = c si S0 ~ 0 (voir SpecOper::epsilon)

Constructor & Destructor Documentation

SpecDiv::SpecDiv	(	const string &	spec_name,
		Spectrum *	sp0,
		Spectrum *	sp1,
		const Double_t	c0 = 1.,
		const Double_t	c1 = 0.,
		const Double_t	c2 = 0.
	)

Constructeur. L'histogramme effectivement associé au spectre est créé par les classes dérivées, et non par la classe de base.

Parameters

spec_name	nom du spectre
sp0	pointeur sur le premier spectre opérande
sp1	pointeur sur le second spectre opérande
c0	facteur multiplicatif
c1	offset
c2	valeur en cas de division par zéro

References SpecOper::coef, Spectrum::Compare(), SpecCalc::dim, Spectrum::GetTitleX(), Spectrum::GetTitleY(), SpecOper::oper, Spectrum::Rename(), SpecOper::SetHisto(), and SpecOper::SetHistoBad().

Referenced by NewSpectrumDef().

SpecDiv::SpecDiv

(

const SpecDiv &

original

)

Constructeur de recopie.

Parameters

original

instance à recopier

References SpecCalc::dim, Spectrum::GetTitleX(), Spectrum::GetTitleY(), Spectrum::GetTitleZ(), Spectrum::histo_ptr, and Spectrum::Rename().

SpecDiv::~SpecDiv ( )

virtual

Destructeur.

References Spectrum::histo_ptr.

Member Function Documentation

SpecDiv::GObject ( SpecDiv  )

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.

void SpecDiv::Update ( )

virtual

Fonction de mise à jour du spectre à partir du spectre opérande.

Reimplemented from Spectrum.

References SpecOper::coef, SpecCalc::dim, SpecOper::epsilon, Spectrum::GetHistoPtr(), Spectrum::histo_ptr, SpecOper::IsUpdated(), SpecOper::oper, Spectrum::status, Spec1Dim::x_dim, and Spec2Dim::y_dim.

Spectrum * SpecDiv::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 Spectrum::Compare(), SpecOper::SetOperData(), and SpecDiv().

Referenced by Spectrum::NewSpectrum().

u_int SpecDiv::TypeId ( ) const

inlinevirtual

Retourne l'identificateur du type de spectre.

Implements Spectrum.

string SpecDiv::Type ( ) const

inlinevirtual

Retourne le nom du type de spectre.

Implements Spectrum.

References SPECTRUM_TYPE_TXT_DIV.

SpecDiv::ClassDef	(	SpecDiv	,
		0
	)

Définition à usage de ROOT...

---

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

• SpecDiv.hh
• SpecDiv.cpp