Advanced 3-dimentional spectra processing functions.

Author: Miroslav Morhac

Definition at line 20 of file TSpectrum3.h.

Public Types
enum	{ kBackIncreasingWindow =0, kBackDecreasingWindow =1, kBackSuccessiveFiltering =0, kBackOneStepFiltering =1 }

Public Types inherited from TObject
enum	EStatusBits { kCanDelete = BIT(0), kMustCleanup = BIT(3), kObjInCanvas = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5), kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13) }

enum	{ kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff }

enum	{ kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }

Public Member Functions
	TSpectrum3 ()

	TSpectrum3 (Int_t maxpositions, Double_t resolution=1)
	maxpositions: maximum number of peaks resolution: determines resolution of the neighboring peaks default value is 1 correspond to 3 sigma distance between peaks. More...

virtual	~TSpectrum3 ()
	Destructor. More...

virtual const char *	Background (const TH1 hist, Int_t niter, Option_t option="goff")
	ONE-DIMENSIONAL BACKGROUND ESTIMATION FUNCTION // This function calculates background spectrum from source in h. More...

const char *	Background (Double_t ***spectrum, Int_t ssizex, Int_t ssizey, Int_t ssizez, Int_t numberIterationsX, Int_t numberIterationsY, Int_t numberIterationsZ, Int_t direction, Int_t filterType)
	THREE-DIMENSIONAL BACKGROUND ESTIMATION FUNCTIONS // This function calculates background spectrum from source spectrum. More...

const char *	Deconvolution (Double_t *source, const Double_t *resp, Int_t ssizex, Int_t ssizey, Int_t ssizez, Int_t numberIterations, Int_t numberRepetitions, Double_t boost)
	THREE-DIMENSIONAL DECONVOLUTION FUNCTION // This function calculates deconvolution from source spectrum // according to response spectrum // The result is placed in the cube pointed by source pointer. More...

TH1 *	GetHistogram () const

Int_t	GetNPeaks () const

Double_t *	GetPositionX () const

Double_t *	GetPositionY () const

Double_t *	GetPositionZ () const

virtual void	Print (Option_t *option="") const
	Print the array of positions. More...

virtual Int_t	Search (const TH1 hist, Double_t sigma=2, Option_t option="goff", Double_t threshold=0.05)
	ONE-DIMENSIONAL PEAK SEARCH FUNCTION // This function searches for peaks in source spectrum in hin // The number of found peaks and their positions are written into // the members fNpeaks and fPositionX. More...

Int_t	SearchFast (const Double_t *source, Double_t *dest, Int_t ssizex, Int_t ssizey, Int_t ssizez, Double_t sigma, Double_t threshold, Bool_t markov, Int_t averWindow)

Int_t	SearchHighRes (const Double_t *source, Double_t *dest, Int_t ssizex, Int_t ssizey, Int_t ssizez, Double_t sigma, Double_t threshold, Bool_t backgroundRemove, Int_t deconIterations, Bool_t markov, Int_t averWindow)

void	SetResolution (Double_t resolution=1)
	resolution: determines resolution of the neighboring peaks default value is 1 correspond to 3 sigma distance between peaks. More...

const char *	SmoothMarkov (Double_t ***source, Int_t ssizex, Int_t ssizey, Int_t ssizez, Int_t averWindow)
	THREE-DIMENSIONAL MARKOV SPECTRUM SMOOTHING FUNCTION // // This function calculates smoothed spectrum from source spectrum // based on Markov chain method. More...

Public Member Functions inherited from TNamed
	TNamed ()

	TNamed (const char name, const char title)

	TNamed (const TString &name, const TString &title)

	TNamed (const TNamed &named)

TNamed &	operator= (const TNamed &rhs)
	TNamed assignment operator. More...

virtual	~TNamed ()

virtual void	Clear (Option_t *option="")
	Set name and title to empty strings (""). More...

virtual TObject *	Clone (const char *newname="") const
	Make a clone of an object using the Streamer facility. More...

virtual Int_t	Compare (const TObject *obj) const
	Compare two TNamed objects. More...

virtual void	Copy (TObject &named) const
	Copy this to obj. More...

virtual void	FillBuffer (char *&buffer)
	Encode TNamed into output buffer. More...

virtual const char *	GetName () const
	Returns name of object. More...

virtual const char *	GetTitle () const
	Returns title of object. More...

virtual ULong_t	Hash () const
	Return hash value for this object. More...

virtual Bool_t	IsSortable () const

virtual void	SetName (const char *name)
	Change (i.e. More...

virtual void	SetNameTitle (const char name, const char title)
	Change (i.e. set) all the TNamed parameters (name and title). More...

virtual void	SetTitle (const char *title="")
	Change (i.e. set) the title of the TNamed. More...

virtual void	ls (Option_t *option="") const
	List TNamed name and title. More...

virtual Int_t	Sizeof () const
	Return size of the TNamed part of the TObject. More...

Public Member Functions inherited from TObject
	TObject ()

	TObject (const TObject &object)
	TObject copy ctor. More...

TObject &	operator= (const TObject &rhs)
	TObject assignment operator. More...

virtual	~TObject ()
	TObject destructor. More...

virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad. More...

virtual void	Browse (TBrowser *b)
	Browse object. May be overridden for another default action. More...

virtual const char *	ClassName () const
	Returns name of class to which the object belongs. More...

virtual void	Delete (Option_t *option="")
	Delete this object. More...

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Computes distance from point (px,py) to the object. More...

virtual void	Draw (Option_t *option="")
	Default Draw method for all objects. More...

virtual void	DrawClass () const
	Draw class inheritance tree of the class to which this object belongs. More...

virtual TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current pad. More...

virtual void	Dump () const
	Dump contents of object on stdout. More...

virtual void	Execute (const char method, const char params, Int_t *error=0)
	Execute method on this object with the given parameter string, e.g. More...

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=0)
	Execute method on this object with parameters stored in the TObjArray. More...

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)
	Execute action corresponding to an event at (px,py). More...

virtual TObject *	FindObject (const char *name) const
	Must be redefined in derived classes. More...

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes. More...

virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object. More...

virtual UInt_t	GetUniqueID () const
	Return the unique object id. More...

virtual const char *	GetIconName () const
	Returns mime type name of object. More...

virtual Option_t *	GetOption () const

virtual char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py). More...

virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out. More...

virtual Bool_t	InheritsFrom (const char *classname) const
	Returns kTRUE if object inherits from class "classname". More...

virtual Bool_t	InheritsFrom (const TClass *cl) const
	Returns kTRUE if object inherits from TClass cl. More...

virtual void	Inspect () const
	Dump contents of this object in a graphics canvas. More...

virtual Bool_t	IsFolder () const
	Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...

virtual Bool_t	IsEqual (const TObject *obj) const
	Default equal comparison (objects are equal if they have the same address in memory). More...

Bool_t	IsOnHeap () const

Bool_t	IsZombie () const

virtual Bool_t	Notify ()
	This method must be overridden to handle object notification. More...

virtual void	Paint (Option_t *option="")
	This method must be overridden if a class wants to paint itself. More...

virtual void	Pop ()
	Pop on object drawn in a pad to the top of the display list. More...

virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory. More...

virtual void	RecursiveRemove (TObject *obj)
	Recursively remove this object from a list. More...

virtual void	SaveAs (const char filename="", Option_t option="") const
	Save this object in the file specified by filename. More...

virtual void	SavePrimitive (std::ostream &out, Option_t *option="")
	Save a primitive as a C++ statement(s) on output stream "out". More...

virtual void	SetDrawOption (Option_t *option="")
	Set drawing option for object. More...

virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id. More...

virtual void	UseCurrentStyle ()
	Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. More...

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory. More...

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory. More...

void *	operator new (size_t sz)

void *	operator new[] (size_t sz)

void *	operator new (size_t sz, void *vp)

void *	operator new[] (size_t sz, void *vp)

void	operator delete (void *ptr)
	Operator delete. More...

void	operator delete[] (void *ptr)
	Operator delete []. More...

void	SetBit (UInt_t f, Bool_t set)
	Set or unset the user status bits as specified in f. More...

void	SetBit (UInt_t f)

void	ResetBit (UInt_t f)

Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

void	InvertBit (UInt_t f)

virtual void	Info (const char method, const char msgfmt,...) const
	Issue info message. More...

virtual void	Warning (const char method, const char msgfmt,...) const
	Issue warning message. More...

virtual void	Error (const char method, const char msgfmt,...) const
	Issue error message. More...

virtual void	SysError (const char method, const char msgfmt,...) const
	Issue system error message. More...

virtual void	Fatal (const char method, const char msgfmt,...) const
	Issue fatal error message. More...

void	AbstractMethod (const char *method) const
	Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...

void	MayNotUse (const char *method) const
	Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). More...

void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const
	Use this method to declare a method obsolete. More...

Protected Attributes
Int_t	fMaxPeaks

Int_t	fNPeaks

Double_t *	fPosition

Double_t *	fPositionX

Double_t *	fPositionY

Double_t *	fPositionZ

Double_t	fResolution

TH1 *	fHistogram

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

Additional Inherited Members
Static Public Member Functions inherited from TObject
static Long_t	GetDtorOnly ()
	Return destructor only flag. More...

static void	SetDtorOnly (void *obj)
	Set destructor only flag. More...

static Bool_t	GetObjectStat ()
	Get status of object stat flag. More...

static void	SetObjectStat (Bool_t stat)
	Turn on/off tracking of objects in the TObjectTable. More...

Protected Member Functions inherited from TObject
void	MakeZombie ()

virtual void	DoError (int level, const char location, const char fmt, va_list va) const
	Interface to ErrorHandler (protected). More...

#include <TSpectrum3.h>

Inheritance diagram for TSpectrum3:

Collaboration diagram for TSpectrum3:

Member Enumeration Documentation

anonymous enum

Enumerator
kBackIncreasingWindow
kBackDecreasingWindow
kBackSuccessiveFiltering
kBackOneStepFiltering

Definition at line 32 of file TSpectrum3.h.

Constructor & Destructor Documentation

TSpectrum3::TSpectrum3 ( )

TSpectrum3::TSpectrum3	(	Int_t	maxpositions,
		Double_t	resolution = `1`
	)

maxpositions: maximum number of peaks resolution: determines resolution of the neighboring peaks default value is 1 correspond to 3 sigma distance between peaks.

Higher values allow higher resolution (smaller distance between peaks. May be set later through SetResolution.

Definition at line 92 of file TSpectrum3.cxx.

TSpectrum3::~TSpectrum3 ( )

virtual

Destructor.

Definition at line 109 of file TSpectrum3.cxx.

Member Function Documentation

const char * TSpectrum3::Background	(	const TH1 *	h,
		Int_t	number_of_iterations,
		Option_t *	option = `"goff"`
	)

virtual

ONE-DIMENSIONAL BACKGROUND ESTIMATION FUNCTION // This function calculates background spectrum from source in h.

// The result is placed in the vector pointed by spectrum pointer. // // Function parameters: // spectrum: pointer to the vector of source spectrum // size: length of spectrum and working space vectors // number_of_iterations, for details we refer to manual // //

Definition at line 131 of file TSpectrum3.cxx.

const char * TSpectrum3::Background	(	Double_t ***	spectrum,
		Int_t	ssizex,
		Int_t	ssizey,
		Int_t	ssizez,
		Int_t	numberIterationsX,
		Int_t	numberIterationsY,
		Int_t	numberIterationsZ,
		Int_t	direction,
		Int_t	filterType
	)

THREE-DIMENSIONAL BACKGROUND ESTIMATION FUNCTIONS // This function calculates background spectrum from source spectrum.

// The result is placed to the array pointed by spectrum pointer. // // Function parameters: // spectrum-pointer to the array of source spectrum // ssizex-x length of spectrum // ssizey-y length of spectrum // ssizez-z length of spectrum // numberIterationsX-maximal x width of clipping window // numberIterationsY-maximal y width of clipping window // numberIterationsZ-maximal z width of clipping window // for details we refer to manual // direction- direction of change of clipping window //

possible values=kBackIncreasingWindow // kBackDecreasingWindow // filterType-determines the algorithm of the filtering // -possible values=kBackSuccessiveFiltering // kBackOneStepFiltering // // //

Begin_Html

Definition at line 278 of file TSpectrum3.cxx.

const char * TSpectrum3::Deconvolution	(	Double_t ***	source,
		const Double_t ***	resp,
		Int_t	ssizex,
		Int_t	ssizey,
		Int_t	ssizez,
		Int_t	numberIterations,
		Int_t	numberRepetitions,
		Double_t	boost
	)

THREE-DIMENSIONAL DECONVOLUTION FUNCTION // This function calculates deconvolution from source spectrum // according to response spectrum // The result is placed in the cube pointed by source pointer.

// // Function parameters: // source-pointer to the cube of source spectrum // resp-pointer to the cube of response spectrum // ssizex-x length of source and response spectra // ssizey-y length of source and response spectra // ssizey-y length of source and response spectra // numberIterations, for details we refer to manual // numberRepetitions, for details we refer to manual // boost, boosting factor, for details we refer to manual // //

Begin_Html

Definition at line 1873 of file TSpectrum3.cxx.

TH1* TSpectrum3::GetHistogram ( ) const

inline

Definition at line 45 of file TSpectrum3.h.

Int_t TSpectrum3::GetNPeaks ( ) const

inline

Definition at line 46 of file TSpectrum3.h.

Double_t* TSpectrum3::GetPositionX ( ) const

inline

Definition at line 47 of file TSpectrum3.h.

Double_t* TSpectrum3::GetPositionY ( ) const

inline

Definition at line 48 of file TSpectrum3.h.

Double_t* TSpectrum3::GetPositionZ ( ) const

inline

Definition at line 49 of file TSpectrum3.h.

void TSpectrum3::Print ( Option_t * option = "" ) const

virtual

Print the array of positions.

Reimplemented from TNamed.

Definition at line 142 of file TSpectrum3.cxx.

Int_t TSpectrum3::Search	(	const TH1 *	hin,
		Double_t	sigma = `2`,
		Option_t *	option = `"goff"`,
		Double_t	threshold = `0.05`
	)

virtual

ONE-DIMENSIONAL PEAK SEARCH FUNCTION // This function searches for peaks in source spectrum in hin // The number of found peaks and their positions are written into // the members fNpeaks and fPositionX.

// // Function parameters: // hin: pointer to the histogram of source spectrum // sigma: sigma of searched peaks, for details we refer to manual // Note that sigma is in number of bins // threshold: (default=0.05) peaks with amplitude less than // threshold*highest_peak are discarded. // // if option is not equal to "goff" (goff is the default), then // a polymarker object is created and added to the list of functions of // the histogram. The histogram is drawn with the specified option and // the polymarker object drawn on top of the histogram. // The polymarker coordinates correspond to the npeaks peaks found in // the histogram. // A pointer to the polymarker object can be retrieved later via: // TList functions = hin->GetListOfFunctions(); // TPolyMarker *pm = (TPolyMarker)functions->FindObject("TPolyMarker") // //

Definition at line 178 of file TSpectrum3.cxx.

Int_t TSpectrum3::SearchFast	(	const Double_t ***	source,
		Double_t ***	dest,
		Int_t	ssizex,
		Int_t	ssizey,
		Int_t	ssizez,
		Double_t	sigma,
		Double_t	threshold,
		Bool_t	markov,
		Int_t	averWindow
	)

Definition at line 4104 of file TSpectrum3.cxx.

Int_t TSpectrum3::SearchHighRes	(	const Double_t ***	source,
		Double_t ***	dest,
		Int_t	ssizex,
		Int_t	ssizey,
		Int_t	ssizez,
		Double_t	sigma,
		Double_t	threshold,
		Bool_t	backgroundRemove,
		Int_t	deconIterations,
		Bool_t	markov,
		Int_t	averWindow
	)

Definition at line 2558 of file TSpectrum3.cxx.

Referenced by Search().

void TSpectrum3::SetResolution ( Double_t resolution = 1 )

resolution: determines resolution of the neighboring peaks default value is 1 correspond to 3 sigma distance between peaks.

Higher values allow higher resolution (smaller distance between peaks. May be set later through SetResolution.

Definition at line 244 of file TSpectrum3.cxx.

Referenced by TSpectrum3().

const char * TSpectrum3::SmoothMarkov	(	Double_t ***	source,
		Int_t	ssizex,
		Int_t	ssizey,
		Int_t	ssizez,
		Int_t	averWindow
	)

THREE-DIMENSIONAL MARKOV SPECTRUM SMOOTHING FUNCTION // // This function calculates smoothed spectrum from source spectrum // based on Markov chain method.

// The result is placed in the array pointed by spectrum pointer. // // Function parameters: // source-pointer to the array of source spectrum // working_space-pointer to the working array // ssizex-x length of spectrum and working space arrays // ssizey-y length of spectrum and working space arrays // ssizey-z length of spectrum and working space arrays // averWindow-width of averaging smoothing window // //

Begin_Html

Definition at line 1074 of file TSpectrum3.cxx.