Advanced Spectra Processing.

Author: Miroslav Morhac

This class contains advanced spectra processing functions for:

One-dimensional background estimation
One-dimensional smoothing
One-dimensional deconvolution
One-dimensional peak search

The algorithms in this class have been published in the following references:

M.Morhac et al.: Background elimination methods for multidimensional coincidence gamma-ray spectra. Nuclear Instruments and Methods in Physics Research A 401 (1997) 113-132.
M.Morhac et al.: Efficient one- and two-dimensional Gold deconvolution and its application to gamma-ray spectra decomposition. Nuclear Instruments and Methods in Physics Research A 401 (1997) 385-408.
M.Morhac et al.: Identification of peaks in multidimensional coincidence gamma-ray spectra. Nuclear Instruments and Methods in Research Physics A 443(2000), 108-125.

These NIM papers are also available as doc or ps files from:

See also the online documentation and tutorials.

Definition at line 18 of file TSpectrum.h.

Public Types
enum	{ kBackOrder2 =0, kBackOrder4 =1, kBackOrder6 =2, kBackOrder8 =3, kBackIncreasingWindow =0, kBackDecreasingWindow =1, kBackSmoothing3 =3, kBackSmoothing5 =5, kBackSmoothing7 =7, kBackSmoothing9 =9, kBackSmoothing11 =11, kBackSmoothing13 =13, kBackSmoothing15 =15 }

Public Types inherited from TObject
enum	{ kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kInconsistent = 0x08000000, kBitMask = 0x00ffffff }

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

enum	EDeprecatedStatusBits { kObjInCanvas = BIT(3) }

enum	EStatusBits { kCanDelete = BIT(0), kMustCleanup = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5), kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13) }

Public Member Functions
	TSpectrum ()
	Constructor. More...

	TSpectrum (Int_t maxpositions, Double_t resolution=1)

virtual	~TSpectrum ()
	Destructor. More...

virtual TH1 *	Background (const TH1 hist, Int_t niter=20, Option_t option="")
	One-dimensional background estimation function. More...

const char *	Background (Double_t *spectrum, Int_t ssize, Int_t numberIterations, Int_t direction, Int_t filterOrder, bool smoothing, Int_t smoothWindow, bool compton)

const char *	Deconvolution (Double_t source, const Double_t response, Int_t ssize, Int_t numberIterations, Int_t numberRepetitions, Double_t boost)

const char *	DeconvolutionRL (Double_t source, const Double_t response, Int_t ssize, Int_t numberIterations, Int_t numberRepetitions, Double_t boost)

TH1 *	GetHistogram () const

Int_t	GetNPeaks () const

Double_t *	GetPositionX () const

Double_t *	GetPositionY () 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="", Double_t threshold=0.05)
	One-dimensional peak search function. More...

Int_t	Search1HighRes (Double_t source, Double_t destVector, Int_t ssize, Double_t sigma, Double_t threshold, bool backgroundRemove, Int_t deconIterations, bool markov, Int_t averWindow)

Int_t	SearchHighRes (Double_t source, Double_t destVector, Int_t ssize, Double_t sigma, Double_t threshold, bool backgroundRemove, Int_t deconIterations, bool markov, Int_t averWindow)

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

const char *	SmoothMarkov (Double_t *source, Int_t ssize, Int_t averWindow)

const char *	Unfolding (Double_t source, const Double_t *respMatrix, Int_t ssizex, Int_t ssizey, Int_t numberIterations, Int_t numberRepetitions, Double_t boost)

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 copy ctor. More...

virtual	~TNamed ()
	TNamed destructor. More...

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	ls (Option_t *option="") const
	List TNamed name and title. More...

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

virtual void	SetName (const char *name)
	Set the name of the TNamed. More...

virtual void	SetNameTitle (const char name, const char title)
	Set all the TNamed parameters (name and title). More...

virtual void	SetTitle (const char *title="")
	Set the title of the TNamed. More...

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

Public Member Functions inherited from TObject
	TObject ()
	TObject constructor. More...

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

virtual	~TObject ()
	TObject destructor. 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...

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...

ULong_t	CheckedHash ()
	Checked and record whether for this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object. 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 selected pad for instance with: `gROOT->SetSelectedPad(gPad)`. More...

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

virtual void	Error (const char method, const char msgfmt,...) const
	Issue error message. 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 void	Fatal (const char method, const char msgfmt,...) const
	Issue fatal error message. 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 const char *	GetIconName () const
	Returns mime type name of object. More...

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

virtual Option_t *	GetOption () const

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

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

Bool_t	HasInconsistentHash () const
	Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e. More...

virtual void	Info (const char method, const char msgfmt,...) const
	Issue info message. 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...

void	InvertBit (UInt_t f)

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

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

R__ALWAYS_INLINE Bool_t	IsOnHeap () const

R__ALWAYS_INLINE Bool_t	IsZombie () const

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...

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

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

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

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

void *	operator new (size_t sz)

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

void *	operator new[] (size_t sz)

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

TObject &	operator= (const TObject &rhs)
	TObject assignment operator. 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...

void	ResetBit (UInt_t f)

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...

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)

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	SysError (const char method, const char msgfmt,...) const
	Issue system error message. More...

R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

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 void	Warning (const char method, const char msgfmt,...) const
	Issue warning message. 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...

Static Public Member Functions
static void	SetAverageWindow (Int_t w=3)
	Static function: Set average window of searched peaks (see TSpectrum::SearchHighRes). More...

static void	SetDeconIterations (Int_t n=3)
	Static function: Set max number of decon iterations in deconvolution operation (see TSpectrum::SearchHighRes). More...

static TH1 *	StaticBackground (const TH1 hist, Int_t niter=20, Option_t option="")

static Int_t	StaticSearch (const TH1 hist, Double_t sigma=2, Option_t option="goff", Double_t threshold=0.05)

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

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

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

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

Protected Attributes
TH1 *	fHistogram
	resulting histogram More...

Int_t	fMaxPeaks
	Maximum number of peaks to be found. More...

Int_t	fNPeaks
	number of peaks found More...

Double_t *	fPosition
	[fNPeaks] array of current peak positions More...

Double_t *	fPositionX
	[fNPeaks] X position of peaks More...

Double_t *	fPositionY
	[fNPeaks] Y position of peaks More...

Double_t	fResolution
	NOT USED resolution of the neighboring peaks More...

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

Static Protected Attributes
static Int_t	fgAverageWindow = 3
	Average window of searched peaks. More...

static Int_t	fgIterations = 3
	Maximum number of decon iterations (default=3) More...

Private Member Functions
	TSpectrum (const TSpectrum &)

TSpectrum &	operator= (const TSpectrum &)

Additional Inherited Members
Protected Member Functions inherited from TObject
virtual void	DoError (int level, const char location, const char fmt, va_list va) const
	Interface to ErrorHandler (protected). More...

void	MakeZombie ()

#include <TSpectrum.h>

Inheritance diagram for TSpectrum:

[legend]

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
kBackOrder2
kBackOrder4
kBackOrder6
kBackOrder8
kBackIncreasingWindow
kBackDecreasingWindow
kBackSmoothing3
kBackSmoothing5
kBackSmoothing7
kBackSmoothing9
kBackSmoothing11
kBackSmoothing13
kBackSmoothing15

Definition at line 36 of file TSpectrum.h.

Constructor & Destructor Documentation

◆ TSpectrum() [1/3]

TSpectrum::TSpectrum ( const TSpectrum & )

private

◆ TSpectrum() [2/3]

TSpectrum::TSpectrum ( )

Constructor.

Definition at line 50 of file TSpectrum.cxx.

◆ TSpectrum() [3/3]

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

maxpositions: maximum number of peaks
resolution: NOT USED determines resolution of the neighbouring 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 70 of file TSpectrum.cxx.

◆ ~TSpectrum()

TSpectrum::~TSpectrum ( )

virtual

Destructor.

Definition at line 87 of file TSpectrum.cxx.

Member Function Documentation

◆ Background() [1/2]

TH1 * TSpectrum::Background	(	const TH1 *	h,
		Int_t	niter = `20`,
		Option_t *	option = `""`
	)

virtual

One-dimensional background estimation function.

This function calculates the background spectrum in the input histogram h. The background is returned as a histogram.

Parameters:

h: input 1-d histogram
numberIterations, (default value = 20) Increasing numberIterations make the result smoother and lower.
option: may contain one of the following options:
- to set the direction parameter "BackIncreasingWindow". By default the direction is BackDecreasingWindow
- filterOrder-order of clipping filter, (default "BackOrder2") -possible values= "BackOrder4" "BackOrder6" "BackOrder8"
- "nosmoothing"- if selected, the background is not smoothed By default the background is smoothed.
- smoothWindow-width of smoothing window, (default is "BackSmoothing3") -possible values= "BackSmoothing5" "BackSmoothing7" "BackSmoothing9" "BackSmoothing11" "BackSmoothing13" "BackSmoothing15"
- "Compton" if selected the estimation of Compton edge will be included.
- "same" : if this option is specified, the resulting background histogram is superimposed on the picture in the current pad.

NOTE that the background is only evaluated in the current range of h. ie, if h has a bin range (set via h->GetXaxis()->SetRange(binmin,binmax), the returned histogram will be created with the same number of bins as the input histogram h, but only bins from binmin to binmax will be filled with the estimated background.

Definition at line 152 of file TSpectrum.cxx.

◆ Background() [2/2]

const char* TSpectrum::Background	(	Double_t *	spectrum,
		Int_t	ssize,
		Int_t	numberIterations,
		Int_t	direction,
		Int_t	filterOrder,
		bool	smoothing,
		Int_t	smoothWindow,
		bool	compton
	)

◆ Deconvolution()

const char* TSpectrum::Deconvolution	(	Double_t *	source,
		const Double_t *	response,
		Int_t	ssize,
		Int_t	numberIterations,
		Int_t	numberRepetitions,
		Double_t	boost
	)

◆ DeconvolutionRL()

const char* TSpectrum::DeconvolutionRL	(	Double_t *	source,
		const Double_t *	response,
		Int_t	ssize,
		Int_t	numberIterations,
		Int_t	numberRepetitions,
		Double_t	boost
	)

◆ GetHistogram()

TH1* TSpectrum::GetHistogram ( ) const

inline

Definition at line 56 of file TSpectrum.h.

◆ GetNPeaks()

Int_t TSpectrum::GetNPeaks ( ) const

inline

Definition at line 57 of file TSpectrum.h.

◆ GetPositionX()

Double_t* TSpectrum::GetPositionX ( ) const

inline

Definition at line 58 of file TSpectrum.h.

◆ GetPositionY()

Double_t* TSpectrum::GetPositionY ( ) const

inline

Definition at line 59 of file TSpectrum.h.

◆ operator=()

TSpectrum& TSpectrum::operator= ( const TSpectrum & )

private

◆ Print()

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

virtual

Print the array of positions.

Reimplemented from TNamed.

Definition at line 219 of file TSpectrum.cxx.

◆ Search()

Int_t TSpectrum::Search	(	const TH1 *	hin,
		Double_t	sigma = `2`,
		Option_t *	option = `""`,
		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. The search is performed in the current histogram range.

Parameters:

hin: pointer to the histogram of source spectrum
sigma: sigma of searched peaks, for details we refer to manual
threshold: (default=0.05) peaks with amplitude less than threshold*highest_peak are discarded. 0<threshold<1

By default, the background is removed before deconvolution. Specify the option "nobackground" to not remove the background.

By default the "Markov" chain algorithm is used. Specify the option "noMarkov" to disable this algorithm Note that by default the source spectrum is replaced by a new spectrum

By default 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");

Specify the option "goff" to disable the storage and drawing of the polymarker.

To disable the final drawing of the histogram with the search results (in case you want to draw it yourself) specify "nodraw" in the options parameter.

Definition at line 266 of file TSpectrum.cxx.

◆ Search1HighRes()

Int_t TSpectrum::Search1HighRes	(	Double_t *	source,
		Double_t *	destVector,
		Int_t	ssize,
		Double_t	sigma,
		Double_t	threshold,
		bool	backgroundRemove,
		Int_t	deconIterations,
		bool	markov,
		Int_t	averWindow
	)

◆ SearchHighRes()

Int_t TSpectrum::SearchHighRes	(	Double_t *	source,
		Double_t *	destVector,
		Int_t	ssize,
		Double_t	sigma,
		Double_t	threshold,
		bool	backgroundRemove,
		Int_t	deconIterations,
		bool	markov,
		Int_t	averWindow
	)

◆ SetAverageWindow()

void TSpectrum::SetAverageWindow ( Int_t w = 3 )

static

Static function: Set average window of searched peaks (see TSpectrum::SearchHighRes).

Definition at line 99 of file TSpectrum.cxx.

◆ SetDeconIterations()

void TSpectrum::SetDeconIterations ( Int_t n = 3 )

static

Static function: Set max number of decon iterations in deconvolution operation (see TSpectrum::SearchHighRes).

Definition at line 108 of file TSpectrum.cxx.

◆ SetResolution()

void TSpectrum::SetResolution ( Double_t resolution = 1 )

NOT USED resolution: determines resolution of the neighbouring 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 351 of file TSpectrum.cxx.

◆ SmoothMarkov()

const char* TSpectrum::SmoothMarkov	(	Double_t *	source,
		Int_t	ssize,
		Int_t	averWindow
	)

◆ StaticBackground()

static TH1* TSpectrum::StaticBackground	(	const TH1 *	hist,
		Int_t	niter = `20`,
		Option_t *	option = `""`
	)

static

◆ StaticSearch()

static Int_t TSpectrum::StaticSearch	(	const TH1 *	hist,
		Double_t	sigma = `2`,
		Option_t *	option = `"goff"`,
		Double_t	threshold = `0.05`
	)

static

◆ Unfolding()

const char* TSpectrum::Unfolding	(	Double_t *	source,
		const Double_t **	respMatrix,
		Int_t	ssizex,
		Int_t	ssizey,
		Int_t	numberIterations,
		Int_t	numberRepetitions,
		Double_t	boost
	)

Member Data Documentation

◆ fgAverageWindow

Int_t TSpectrum::fgAverageWindow = 3

staticprotected

Average window of searched peaks.

Definition at line 32 of file TSpectrum.h.

◆ fgIterations

Int_t TSpectrum::fgIterations = 3

staticprotected

Maximum number of decon iterations (default=3)

Definition at line 33 of file TSpectrum.h.

◆ fHistogram

TH1* TSpectrum::fHistogram

protected

resulting histogram

Definition at line 31 of file TSpectrum.h.

◆ fMaxPeaks

Int_t TSpectrum::fMaxPeaks

protected

Maximum number of peaks to be found.

Definition at line 25 of file TSpectrum.h.

◆ fNPeaks

Int_t TSpectrum::fNPeaks

protected

number of peaks found

Definition at line 26 of file TSpectrum.h.

◆ fPosition

Double_t* TSpectrum::fPosition

protected

[fNPeaks] array of current peak positions

Definition at line 27 of file TSpectrum.h.

◆ fPositionX

Double_t* TSpectrum::fPositionX

protected

[fNPeaks] X position of peaks

Definition at line 28 of file TSpectrum.h.

◆ fPositionY

Double_t* TSpectrum::fPositionY

protected

[fNPeaks] Y position of peaks

Definition at line 29 of file TSpectrum.h.

◆ fResolution

Double_t TSpectrum::fResolution

protected

NOT USED resolution of the neighboring peaks

Definition at line 30 of file TSpectrum.h.

Libraries for TSpectrum:

[legend]

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Additional Inherited Members

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ TSpectrum() [1/3]

◆ TSpectrum() [2/3]

◆ TSpectrum() [3/3]

◆ ~TSpectrum()

Member Function Documentation

◆ Background() [1/2]

Parameters:

◆ Background() [2/2]

◆ Deconvolution()

◆ DeconvolutionRL()

◆ GetHistogram()

◆ GetNPeaks()

◆ GetPositionX()

◆ GetPositionY()

◆ operator=()

◆ Print()

◆ Search()

Parameters:

◆ Search1HighRes()

◆ SearchHighRes()

◆ SetAverageWindow()

◆ SetDeconIterations()

◆ SetResolution()

◆ SmoothMarkov()

◆ StaticBackground()

◆ StaticSearch()

◆ Unfolding()

Member Data Documentation

◆ fgAverageWindow

◆ fgIterations

◆ fHistogram

◆ fMaxPeaks

◆ fNPeaks

◆ fPosition

◆ fPositionX

◆ fPositionY

◆ fResolution