Description of a module in a calorimeter system. More...

#include "NcCalmodule.h"

Inheritance diagram for NcCalmodule:

Detailed Description

Description of a module in a calorimeter system.

Copyright(c) 1997 NCFS/IIHE, All Rights Reserved.                           *
                                                                            *
Authors: The Netherlands Center for Fundamental Studies (NCFS).             *
         The Inter-university Institute for High Energies (IIHE).           *                 
                   Website : http://www.iihe.ac.be                          *
           Contact : Nick van Eijndhoven (nickve.nl@gmail.com)              *
                                                                            *
Contributors are mentioned in the code where appropriate.                   *
                                                                            * 
No part of this software may be used, copied, modified or distributed       *
by any means nor transmitted or translated into machine language for        *
commercial purposes without written permission by the IIHE representative.  *
Permission to use the software strictly for non-commercial purposes         *
is hereby granted without fee, provided that the above copyright notice     *
appears in all copies and that both the copyright notice and this           *
permission notice appear in the supporting documentation.                   *
This software is provided "as is" without express or implied warranty.      *
The authors make no claims that this software is free of error, or is       *
consistent with any particular standard of merchantability, or that it      *
will meet your requirements for any particular application, other than      *
indicated in the corresponding documentation.                               *
This software should not be relied on for solving a problem whose           *
incorrect solution could result in injury to a person or loss of property.  *
If you do use this software in such a manner, it is at your own risk.       *
The authors disclaim all liability for direct or consequential damage       *
resulting from your use of this software.                                   *

// Class NcCalmodule
// Description of a module in a calorimeter system.
// A matrix geometry is assumed, such that a module
// is identified by (row,col) and contains a certain signal.
// Note : row and col start counting at 1.
//
//--- Author: Nick van Eijndhoven 13-jun-1997 Utrecht University
//- Modified: NvE $Date: 2010-03-19 11:10:02 +0100 (Fri, 19 Mar 2010) $ NCFS

Definition at line 10 of file NcCalmodule.h.

Public Member Functions
	NcCalmodule ()

	NcCalmodule (const NcCalmodule &m)

	NcCalmodule (Int_t row, Int_t col, Double_t sig)

virtual	~NcCalmodule ()

virtual void	AddSignal (Double_t sig, Int_t j=1)

virtual void	AddSignal (Double_t sig, TString name)

virtual TObject *	Clone (const char *name="") const

Float_t	GetClusteredSignal () const

Int_t	GetColumn () const

Int_t	GetRow () const

void	SetClusteredSignal (Double_t val)

void	SetColumn (Int_t i)

void	SetRow (Int_t i)

virtual void	SetSignal (Double_t sig, Int_t j=1)

virtual void	SetSignal (Double_t sig, TString name)

Public Member Functions inherited from NcSignal
	NcSignal (const char name="", const char title="")

	NcSignal (const NcSignal &s)

virtual	~NcSignal ()

void	AddLink (TObject *obj, Int_t j=1)

void	AddLink (TObject *obj, TString name)

void	AddTrack (NcTrack &t, Int_t mode=1)

virtual void	Data (TString f="car", TString u="rad") const

void	DeleteSample (Int_t j=1)

void	DeleteSample (TString name)

virtual void	DeleteSignals (Int_t mode=0)

void	DeleteWaveform (Int_t j=1)

void	DeleteWaveform (TString name)

NcSample *	DisplaySample (Int_t j=1, Int_t i=1) const

NcSample *	DisplaySample (TString name, Int_t i=1) const

NcDevice *	GetDevice () const

Int_t	GetErrorFlag (Int_t j=1) const

Int_t	GetErrorFlag (TString name) const

NcTrack *	GetIdTrack (Int_t id) const

Int_t	GetIndices (TObject *obj, Int_t j, TArrayI &ks) const

Int_t	GetIndices (TObject *obj, TArrayI &js, Int_t k) const

Int_t	GetIndices (TObject *obj, TArrayI &js, TArrayI &ks) const

Int_t	GetIndices (TObject *obj, TString name, TArrayI &ks) const

TObject *	GetLink (Int_t j=1, Int_t k=1) const

TObject *	GetLink (TString name, Int_t k=1) const

Int_t	GetNerrors () const

Int_t	GetNlinks (TObject *obj, TString name) const

Int_t	GetNlinks (TObject *obj=0, Int_t j=0) const

Int_t	GetNsamples () const

virtual Int_t	GetNslots () const

Int_t	GetNtracks (NcTrack *t=0) const

Int_t	GetNvalues () const

Int_t	GetNwaveforms () const

NcSample *	GetSample (Int_t j=1) const

NcSample *	GetSample (TString name) const

Int_t	GetSampleIndex (TString name) const

virtual Float_t	GetSignal (Int_t j=1, Int_t mode=0) const

virtual Float_t	GetSignal (TString name, Int_t mode=0) const

virtual Float_t	GetSignalError (Int_t j=1) const

virtual Float_t	GetSignalError (TString name) const

Int_t	GetSignalFlag (Int_t j=1) const

Int_t	GetSignalFlag (TString name) const

Int_t	GetSwapMode () const

NcTrack *	GetTrack (Int_t j) const

TH1F *	GetWaveform (Int_t j=1) const

TH1F *	GetWaveform (TString name) const

Int_t	GetWaveformIndex (TString name) const

virtual void	List (Int_t j=0) const

virtual void	List (TString name) const

void	ListSample (Int_t j=0) const

void	ListTrack (Int_t j=0) const

void	ListWaveform (Int_t j=0) const

void	RemoveTrack (NcTrack &t, Int_t mode=1)

void	RemoveTracks (Int_t mode=1)

virtual void	Reset (Int_t mode=0)

void	ResetLink (Int_t j=1, Int_t k=1)

void	ResetLink (TString name, Int_t k=1)

void	ResetLinks (TObject *obj, Int_t j=0, Int_t k=0)

void	ResetLinks (TObject *obj, TString name, Int_t k=0)

void	ResetSample (Int_t j=1)

void	ResetSample (TString name)

virtual void	ResetSignals (Int_t mode=0)

void	ResetWaveform (Int_t j=1)

void	ResetWaveform (TString name)

void	SetDevice (NcDevice *dev)

void	SetLink (TObject *obj, Int_t j=1, Int_t k=1)

void	SetLink (TObject *obj, TString name, Int_t k=1)

void	SetSample (NcSample *sample, Int_t j=1)

virtual void	SetSignalError (Double_t dsig, Int_t j=1)

virtual void	SetSignalError (Double_t dsig, TString name)

void	SetSwapMode (Int_t swap=1)

void	SetWaveform (TH1F *waveform, Int_t j=1)

Public Member Functions inherited from NcPosition
	NcPosition ()

	NcPosition (const NcPosition &p)

virtual	~NcPosition ()

Double_t	GetDistance (NcPosition &p, Float_t scale=-1)

Double_t	GetDistance (NcPosition *p, Float_t scale=-1)

NcPosition &	GetPosition ()

void	GetPosition (Double_t *r, TString f, TString u="rad", Float_t s=-1) const

void	GetPosition (Float_t *r, TString f, TString u="rad", Float_t s=-1) const

void	GetPositionErrors (Double_t *e, TString f, TString u="rad", Float_t s=-1) const

void	GetPositionErrors (Float_t *e, TString f, TString u="rad", Float_t s=-1) const

NcTimestamp *	GetTimestamp ()

Float_t	GetUnitScale () const

void	RemoveTimestamp ()

void	ResetPosition ()

void	SetPosition (Double_t *r, TString f, TString u="rad")

void	SetPosition (Double_t r1, Double_t r2, Double_t r3, TString f, TString u="rad")

void	SetPosition (Float_t *r, TString f, TString u="rad")

void	SetPosition (Nc3Vector &r)

void	SetPositionErrors (Double_t *e, TString f, TString u="rad")

void	SetPositionErrors (Double_t e1, Double_t e2, Double_t e3, TString f, TString u="rad")

void	SetPositionErrors (Float_t *e, TString f, TString u="rad")

void	SetTimestamp (NcTimestamp &t)

void	SetUnitScale (Float_t s)

Public Member Functions inherited from Nc3Vector
	Nc3Vector ()

	Nc3Vector (const Nc3Vector &v)

virtual	~Nc3Vector ()

Double_t	ConvertAngle (Double_t a, TString in, TString out) const

Nc3Vector	Cross (Nc3Vector &q) const

Double_t	Dot (Nc3Vector &q)

void	GetErrors (Double_t *e, TString f, TString u="rad") const

void	GetErrors (Float_t *e, TString f, TString u="rad") const

Double_t	GetNorm ()

virtual Double_t	GetOpeningAngle (Nc3Vector &q, TString u="rad")

Nc3Vector	GetPrimed (TRotMatrix *m) const

Double_t	GetPseudoRapidity ()

Double_t	GetResultError () const

Nc3Vector	GetUnprimed (TRotMatrix *m) const

Nc3Vector	GetVecLong () const

void	GetVector (Double_t *v, TString f, TString u="rad") const

void	GetVector (Float_t *v, TString f, TString u="rad") const

Nc3Vector	GetVecTrans () const

Double_t	GetX (Int_t i, TString f, TString u="rad")

Int_t	HasErrors () const

Int_t	HasVector () const

virtual void	Load (Nc3Vector &q)

Nc3Vector	operator* (Double_t s) const

Nc3Vector &	operator*= (Double_t s)

Nc3Vector	operator+ (Nc3Vector &q) const

Nc3Vector &	operator+= (Nc3Vector &q)

Nc3Vector	operator- (Nc3Vector &q) const

Nc3Vector &	operator-= (Nc3Vector &q)

Nc3Vector	operator/ (Double_t s) const

Nc3Vector &	operator/= (Double_t s)

Nc3Vector &	operator= (const Nc3Vector &q)

void	PrintAngle (Double_t a, TString in, TString out, Int_t ndig=1, Bool_t align=kFALSE) const

void	SetErrors (Double_t *e, TString f, TString u="rad")

void	SetErrors (Double_t e1, Double_t e2, Double_t e3, TString f, TString u="rad")

void	SetErrors (Float_t *e, TString f, TString u="rad")

void	SetVector (Double_t *v, TString f, TString u="rad")

void	SetVector (Double_t v1, Double_t v2, Double_t v3, TString f, TString u="rad")

void	SetVector (Float_t *v, TString f, TString u="rad")

virtual void	SetZero ()

Public Member Functions inherited from NcAttrib
	NcAttrib ()

	NcAttrib (const NcAttrib &a)

virtual	~NcAttrib ()

void	AddNamedSlot (TString s)

void	DecreaseEdgeValue (Int_t j=1)

void	DecreaseEdgeValue (TString name)

void	DeleteCalibrations (Int_t mode=0)

TF1 *	GetCalFunction (Int_t j=1) const

TF1 *	GetCalFunction (TString name) const

Int_t	GetCalWord (Int_t j=1) const

Int_t	GetCalWord (TString name) const

Int_t	GetDeadValue (Int_t j=1) const

Int_t	GetDeadValue (TString name) const

TF1 *	GetDecalFunction (Int_t j=1) const

TF1 *	GetDecalFunction (TString name) const

Int_t	GetEdgeValue (Int_t j=1) const

Int_t	GetEdgeValue (TString name) const

Float_t	GetGain (Int_t j=1) const

Float_t	GetGain (TString name) const

Int_t	GetGainFlag (Int_t j=1) const

Int_t	GetGainFlag (TString name) const

Int_t	GetLockValue (Int_t j=1) const

Int_t	GetLockValue (TString name) const

Int_t	GetNcalflags () const

Int_t	GetNcalfuncs () const

Int_t	GetNdecalfuncs () const

Int_t	GetNgains () const

Int_t	GetNnames () const

Int_t	GetNoffsets () const

Float_t	GetOffset (Int_t j=1) const

Float_t	GetOffset (TString name) const

Int_t	GetOffsetFlag (Int_t j=1) const

Int_t	GetOffsetFlag (TString name) const

Int_t	GetSlotIndex (TString name, Int_t opt=0) const

TString	GetSlotName (Int_t j=1) const

void	IncreaseEdgeValue (Int_t j=1)

void	IncreaseEdgeValue (TString name)

virtual void	Load (NcAttrib &a, Int_t j=0)

virtual void	Load (NcAttrib &a, TString name)

void	Lock (Int_t j=1)

void	Lock (TString name)

void	ResetGain (Int_t j=1)

void	ResetGain (TString name)

void	ResetOffset (Int_t j=1)

void	ResetOffset (TString name)

void	SetAlive (Int_t j=1)

void	SetAlive (TString name)

void	SetCalFunction (TF1 *f, Int_t j=1)

void	SetCalFunction (TF1 *f, TString name)

void	SetDead (Int_t j=1)

void	SetDead (TString name)

void	SetDecalFunction (TF1 *f, Int_t j=1)

void	SetDecalFunction (TF1 *f, TString name)

void	SetEdgeOff (Int_t j=1)

void	SetEdgeOff (TString name)

void	SetEdgeOn (Int_t j=1)

void	SetEdgeOn (TString name)

void	SetEdgeValue (Int_t val, Int_t j=1)

void	SetEdgeValue (Int_t val, TString name)

void	SetGain (Double_t gain, Int_t j=1)

void	SetGain (Double_t gain, TString name)

void	SetOffset (Double_t off, Int_t j=1)

void	SetOffset (Double_t off, TString name)

void	SetSlotName (TString s, Int_t j=1)

void	Unlock (Int_t j=1)

void	Unlock (TString name)

Protected Attributes
Int_t	fCol

Int_t	fRow

Float_t	fSigc

Protected Attributes inherited from NcSignal
TObject *	fDevice

TArrayF *	fDsignals

NcObjMatrix *	fLinks

TObjArray *	fSamples

TArrayI *	fSigflags

TArrayF *	fSignals

TObjArray *	fTracks

TObjArray *	fWaveforms

Protected Attributes inherited from NcPosition
Float_t	fScale

NcTimestamp *	fTstamp

Protected Attributes inherited from Nc3Vector
Double32_t	fDresult
	! Error on scalar result (e.g. norm or dotproduct)

Int_t	fNv

Double32_t *	fV

Protected Attributes inherited from NcAttrib
TArrayI *	fCalflags

TObjArray *	fCalfuncs

TObjArray *	fDecalfuncs

TArrayF *	fGains

TObjArray *	fNames

TArrayF *	fOffsets

Additional Inherited Members
Public Attributes inherited from NcSignal
Bool_t	fDevset

Protected Member Functions inherited from NcSignal
void	SetSigFlags (Int_t is, Int_t ie, Int_t j)

Protected Member Functions inherited from NcAttrib
void	SetCalFlags (Int_t gf, Int_t of, Int_t j)

Constructor & Destructor Documentation

◆ NcCalmodule() [1/3]

NcCalmodule::NcCalmodule ( )

// Default constructor, all module data is set to 0.

Definition at line 53 of file NcCalmodule.cxx.

◆ ~NcCalmodule()

NcCalmodule::~NcCalmodule ( )

virtual

// Default destructor.

Definition at line 66 of file NcCalmodule.cxx.

◆ NcCalmodule() [2/3]

NcCalmodule::NcCalmodule ( const NcCalmodule & m )

// Copy constructor.

Definition at line 75 of file NcCalmodule.cxx.

◆ NcCalmodule() [3/3]

NcCalmodule::NcCalmodule	(	Int_t	row,
		Int_t	col,
		Double_t	sig )

// Module constructor with initialisation of module data.

Definition at line 88 of file NcCalmodule.cxx.

Member Function Documentation

◆ AddSignal() [1/2]

void NcCalmodule::AddSignal	(	Double_t	sig,
		Int_t	j = 1 )

virtual

// Add or change the data of the module.

// This is an extension of NcSignal::AddSignal in view of the clustered signal.

Reimplemented from NcSignal.

Definition at line 137 of file NcCalmodule.cxx.

◆ AddSignal() [2/2]

void NcSignal::AddSignal	(	Double_t	sig,
		TString	name )

virtual

// Add value to the signal of the name-specified slot.
//
// Note :
// ------
// In case the 'lock' flag was set for the specified slot, the new
// signal value will not be stored.
// One has to unlock the specified slot first in case one really wants
// to overwite the signal value.
//
// This procedure involves a slot-index search based on the specified name
// at each invokation. This may become slow in case many slots have been
// defined and/or when this procedure is invoked many times.
// In such cases it is preferable to use indexed addressing in the user code
// either directly or via a few invokations of GetSlotIndex().

Reimplemented from NcSignal.

Definition at line 32 of file NcSignal.cxx.

◆ Clone()

TObject * NcCalmodule::Clone ( const char * name = "" ) const

virtual

// Make a deep copy of the current object and provide the pointer to the copy.
// This memberfunction enables automatic creation of new objects of the
// correct type depending on the object type, a feature which may be very useful
// for containers like NcCalorimeter when adding objects in case the
// container owns the objects. This feature allows e.g. NcCalorimeter
// to store either NcCalmodule objects or objects derived from NcCalmodule
// via tha AddSignal memberfunction, provided these derived classes also have
// a proper Clone memberfunction. 

Reimplemented from NcSignal.

Definition at line 202 of file NcCalmodule.cxx.

◆ GetClusteredSignal()

Float_t NcCalmodule::GetClusteredSignal ( ) const

// Provide the signal of the module after clustering.

Definition at line 183 of file NcCalmodule.cxx.

◆ GetColumn()

Int_t NcCalmodule::GetColumn ( ) const

// Provide the column number of the module.

Definition at line 172 of file NcCalmodule.cxx.

◆ GetRow()

Int_t NcCalmodule::GetRow ( ) const

// Provide the row number of the module.

Definition at line 161 of file NcCalmodule.cxx.

◆ SetClusteredSignal()

void NcCalmodule::SetClusteredSignal ( Double_t val )

// Set or change the signal of the module after clustering.

Definition at line 150 of file NcCalmodule.cxx.

◆ SetColumn()

void NcCalmodule::SetColumn ( Int_t i )

// Set the column number for this module.

Definition at line 113 of file NcCalmodule.cxx.

◆ SetRow()

void NcCalmodule::SetRow ( Int_t i )

// Set the row number for this module.

Definition at line 102 of file NcCalmodule.cxx.

◆ SetSignal() [1/2]

void NcCalmodule::SetSignal	(	Double_t	sig,
		Int_t	j = 1 )

virtual

// Set or change the data of the module.

// This is an extension of NcSignal::SetSignal in view of the clustered signal.

Reimplemented from NcSignal.

Definition at line 124 of file NcCalmodule.cxx.

◆ SetSignal() [2/2]

void NcSignal::SetSignal	(	Double_t	sig,
		TString	name )

virtual

// Store signal value for the name-specified slot.
//
// Note :
// ------
// In case the 'lock' flag was set for the specified slot, the new
// signal value will not be stored.
// One has to unlock the specified slot first in case one really wants
// to overwite the signal value.
//
// This procedure involves a slot-index search based on the specified name
// at each invokation. This may become slow in case many slots have been
// defined and/or when this procedure is invoked many times.
// In such cases it is preferable to use indexed addressing in the user code
// either directly or via a few invokations of GetSlotIndex().

Reimplemented from NcSignal.

Definition at line 30 of file NcSignal.cxx.

Member Data Documentation

◆ fCol

Int_t NcCalmodule::fCol

protected

Definition at line 31 of file NcCalmodule.h.

◆ fRow

Int_t NcCalmodule::fRow

protected

Definition at line 30 of file NcCalmodule.h.

◆ fSigc

Float_t NcCalmodule::fSigc

protected

Definition at line 32 of file NcCalmodule.h.

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

ncfspack/source/NcCalmodule.h
ncfspack/source/NcCalmodule.cxx

Detailed Description

Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ NcCalmodule() [1/3]

◆ ~NcCalmodule()

◆ NcCalmodule() [2/3]

◆ NcCalmodule() [3/3]

Member Function Documentation

◆ AddSignal() [1/2]

◆ AddSignal() [2/2]

◆ Clone()

◆ GetClusteredSignal()

◆ GetColumn()

◆ GetRow()

◆ SetClusteredSignal()

◆ SetColumn()

◆ SetRow()

◆ SetSignal() [1/2]

◆ SetSignal() [2/2]

Member Data Documentation

◆ fCol

◆ fRow

◆ fSigc