#include <StMuFmsCluster.h>

Inheritance diagram for StMuFmsCluster:

Collaboration diagram for StMuFmsCluster:

Public Member Functions
	StMuFmsCluster (int detectorId=0, int category=-1, float energy=0.f, float x=0.f, float y=0.f)

	StMuFmsCluster (const StFmsCluster &)

virtual	~StMuFmsCluster ()

virtual void	Clear (Option_t *option="")

UShort_t	detectorId () const

UShort_t	category () const

float	energy () const

float	x () const

float	y () const

TRefArray *	hits ()

const TRefArray *	hits () const

TRefArray *	photons ()

const TRefArray *	photons () const

void	setDetectorId (UShort_t detector)

void	setCategory (UShort_t category)

void	setEnergy (float energy)

void	setX (float x)

void	setY (float y)

Protected Attributes
UShort_t	mDetectorId
	Detector ID as defined in database. More...

UShort_t	mCategory
	Category of cluster (see EFmsClusterCategory) More...

Float_t	mEnergy
	Total energy contained in the cluster. More...

Float_t	mX
	Mean x ("center of gravity") More...

Float_t	mY
	Mean y ("center of gravity") More...

TRefArray	mHits
	StMuFmsHits in the current cluster. More...

TRefArray	mPhotons
	StMuFmsPoints in the cluster. More...

Private Member Functions
	StMuFmsCluster (const StMuFmsCluster &)

StMuFmsCluster &	operator= (const StMuFmsCluster &)

Detailed Description

Micro-DST FMS cluster class.

Describes a cluster (collection of adjacent towers) in the FMS. May be created by one or more photons. It maintains references to the hits that form the cluster, and to photons that are fitted to it. However it does not own any of those objects - they are owned by the relevant TClonesArrays in the micro-DST.

Definition at line 28 of file StMuFmsCluster.h.

Constructor & Destructor Documentation

StMuFmsCluster::StMuFmsCluster	(	int	detectorId = `0`,
		int	category = `-1`,
		float	energy = `0.f`,
		float	x = `0.f`,
		float	y = `0.f`
	)

Constructor.

Definition at line 16 of file StMuFmsCluster.cxx.

StMuFmsCluster::StMuFmsCluster ( const StFmsCluster & cluster )

explicit

Initialise from an equivalent StEvent cluster.

Definition at line 21 of file StMuFmsCluster.cxx.

StMuFmsCluster::~StMuFmsCluster ( )

virtual

Destructor.

Definition at line 25 of file StMuFmsCluster.cxx.

StMuFmsCluster::StMuFmsCluster ( const StMuFmsCluster & )

private

Disallow copy construction.

Duplication should only be done via Clone().

Member Function Documentation

UShort_t StMuFmsCluster::category ( ) const

inline

Category of the cluster (see EFmsClusterCategory).

Definition at line 42 of file StMuFmsCluster.h.

Here is the caller graph for this function:

void StMuFmsCluster::Clear ( Option_t * option = "" )

virtual

Clear hit and photon arrays.

Definition at line 27 of file StMuFmsCluster.cxx.

UShort_t StMuFmsCluster::detectorId ( ) const

inline

ID of the sub-detector with which the cluster is associated.

Definition at line 40 of file StMuFmsCluster.h.

Here is the caller graph for this function:

float StMuFmsCluster::energy ( ) const

inline

Total cluster energy (sum over towers).

Definition at line 44 of file StMuFmsCluster.h.

Here is the caller graph for this function:

TRefArray* StMuFmsCluster::hits ( )

inline

The collection of hits in the cluster.

Definition at line 50 of file StMuFmsCluster.h.

Here is the caller graph for this function:

const TRefArray* StMuFmsCluster::hits ( ) const

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 52 of file StMuFmsCluster.h.

StMuFmsCluster& StMuFmsCluster::operator= ( const StMuFmsCluster & )

private

Disallow assignment.

Duplication should only be done via Clone().

TRefArray* StMuFmsCluster::photons ( )

inline

Photons in this cluster.

Definition at line 54 of file StMuFmsCluster.h.

Here is the caller graph for this function:

const TRefArray* StMuFmsCluster::photons ( ) const

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 56 of file StMuFmsCluster.h.

void StMuFmsCluster::setCategory ( UShort_t category )

inline

Set category of the cluster (see EFmsClusterCategory).

Definition at line 60 of file StMuFmsCluster.h.

Here is the call graph for this function:

Here is the caller graph for this function:

void StMuFmsCluster::setDetectorId ( UShort_t detector )

inline

Set ID of the sub-detector with which the cluster is associated.

Definition at line 58 of file StMuFmsCluster.h.

Here is the caller graph for this function:

void StMuFmsCluster::setEnergy ( float energy )

inline

Set total cluster energy (sum over towers).

Definition at line 62 of file StMuFmsCluster.h.

Here is the call graph for this function:

Here is the caller graph for this function:

void StMuFmsCluster::setX ( float x )

inline

Set x "center of gravity" of the cluster.

Definition at line 64 of file StMuFmsCluster.h.

Here is the call graph for this function:

Here is the caller graph for this function:

void StMuFmsCluster::setY ( float y )

inline

Set y "center of gravity" of the cluster.

Definition at line 66 of file StMuFmsCluster.h.

Here is the call graph for this function:

Here is the caller graph for this function:

float StMuFmsCluster::x ( ) const

inline

x "center of gravity" of the cluster.

Definition at line 46 of file StMuFmsCluster.h.

Here is the caller graph for this function:

float StMuFmsCluster::y ( ) const

inline

y "center of gravity" of the cluster.

Definition at line 48 of file StMuFmsCluster.h.

Here is the caller graph for this function:

Member Data Documentation

UShort_t StMuFmsCluster::mCategory

protected

Category of cluster (see EFmsClusterCategory)

Definition at line 70 of file StMuFmsCluster.h.

UShort_t StMuFmsCluster::mDetectorId

protected

Detector ID as defined in database.

Definition at line 69 of file StMuFmsCluster.h.

Float_t StMuFmsCluster::mEnergy

protected

Total energy contained in the cluster.

Definition at line 71 of file StMuFmsCluster.h.

TRefArray StMuFmsCluster::mHits

protected

StMuFmsHits in the current cluster.

Definition at line 74 of file StMuFmsCluster.h.

TRefArray StMuFmsCluster::mPhotons

protected

StMuFmsPoints in the cluster.

Definition at line 75 of file StMuFmsCluster.h.

Float_t StMuFmsCluster::mX

protected

Mean x ("center of gravity")

Definition at line 72 of file StMuFmsCluster.h.

Float_t StMuFmsCluster::mY

protected

Mean y ("center of gravity")

Definition at line 73 of file StMuFmsCluster.h.

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

/Users/thomasburton/Documents/projects/StFms/StRoot/StMuDSTMaker/COMMON/StMuFmsCluster.h
/Users/thomasburton/Documents/projects/StFms/StRoot/StMuDSTMaker/COMMON/StMuFmsCluster.cxx

Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation