util::ClusterShapes Class Reference

#include <ClusterShapes.h>

Public Member Functions
	ClusterShapes (int nhits, float *a, float *x, float *y, float *z)
	ClusterShapes (int nhits, float *a, float *t, float *x, float *y, float *z)
	ClusterShapes (int nhits, std::vector< float > a, std::vector< float > x, std::vector< float > y, std::vector< float > z)
	ClusterShapes (int nhits, std::vector< float > a, std::vector< float > t, std::vector< float > x, std::vector< float > y, std::vector< float > z)
	~ClusterShapes ()
int	getNumberOfHits ()
float	getTotalAmplitude ()
float	getAverageTime ()
float *	getCenterOfGravity ()
float *	getEigenValInertia ()
float *	getEigenVecInertia ()
float	getWidth ()
float	radius ()
float	getElipsoid_r1 ()
float	getElipsoid_r2 ()
float	getElipsoid_r3 ()
float	getElipsoid_vol ()
float	getElipsoid_r_ave ()
float	getElipsoid_density ()
float	getElipsoid_eccentricity ()
float	getElipsoid_r_forw ()
float	getElipsoid_r_back ()

Private Member Functions
void	findElipsoid ()
void	findGravity ()
void	findInertia ()
void	findWidth ()
float	findDistance (int i)

Private Attributes
int	_nHits
std::vector< float >	_aHit
std::vector< float >	_tHit
std::vector< float >	_xHit
std::vector< float >	_yHit
std::vector< float >	_zHit
int	_ifNotGravity = 1
float	_totAmpl = 0.0
float	_totTime = 0.0
float	_radius = 0.0
float	_xgr = 0.0
float	_ygr = 0.0
float	_zgr = 0.0
float	_analogGravity [3] = {0.0, 0.0, 0.0}
int	_ifNotWidth = 1
float	_analogWidth = 0.0
int	_ifNotInertia = 1
float	_ValAnalogInertia [3] = {0., 0., 0.}
float	_VecAnalogInertia [9] = {0., 0., 0., 0., 0., 0., 0., 0., 0.}
int	_ifNotElipsoid = 1
float	_r1 = 0.0
float	_r2 = 0.0
float	_r3 = 0.0
float	_vol = 0.0
float	_r_ave = 0.0
float	_density = 0.0
float	_eccentricity = 0.0
float	_r1_forw = 0.0
float	_r1_back = 0.0

Detailed Description

Utility class to derive properties of clusters, such as centre of gravity, axes of inertia, fits of the cluster shape and so on. All the details are explained in the documentation of the methods. Several classes of the GSL (GNU Scientific Library) are needed in this class.

Authors

V. Morgunov (ITEP/DESY), A. Raspereza (DESY), O. Wendt (DESY)

Version

Id

ClusterShapes.h,v 1.14 2007-04-27 13:56:53 owendt Exp

Definition at line 25 of file ClusterShapes.h.

Constructor & Destructor Documentation

util::ClusterShapes::ClusterShapes	(	int	nhits,
		float *	a,
		float *	x,
		float *	y,
		float *	z
	)

Constructor

Parameters

nhits	: number of hits in the cluster
a	: amplitudes of elements ('cells') of the cluster. Stored in an array, with one entry for each element ('cell'). Each entry is depending on coordinates x,y,z (Cartesian), which are stored in the arrays x,y,z.
x,y,z	: array of coordinates corresponding to the array of amplitudes a.

Definition at line 13 of file ClusterShapes.cxx.

    : _nHits(nhits), _aHit(nhits, 0.0), _tHit(nhits, 0.0), _xHit(nhits, 0.0), _yHit(nhits, 0.0), _zHit(nhits, 0.0), _ifNotGravity(1), _ifNotWidth(1), _ifNotInertia(1), _ifNotElipsoid(1)
    {
        for (int i(0); i < nhits; ++i)
        {
            _aHit[i] = a[i];
            _tHit[i] = 0.;
            _xHit[i] = x[i];
            _yHit[i] = y[i];
            _zHit[i] = z[i];
        }
    }

util::ClusterShapes::ClusterShapes	(	int	nhits,
		float *	a,
		float *	t,
		float *	x,
		float *	y,
		float *	z
	)

Definition at line 26 of file ClusterShapes.cxx.

    : _nHits(nhits), _aHit(nhits, 0.0), _tHit(nhits, 0.0), _xHit(nhits, 0.0), _yHit(nhits, 0.0), _zHit(nhits, 0.0), _ifNotGravity(1), _ifNotWidth(1), _ifNotInertia(1), _ifNotElipsoid(1)
    {
        for (int i(0); i < nhits; ++i)
        {
            _aHit[i] = a[i];
            _tHit[i] = t[i];
            _xHit[i] = x[i];
            _yHit[i] = y[i];
            _zHit[i] = z[i];
        }
    }

util::ClusterShapes::ClusterShapes	(	int	nhits,
		std::vector< float >	a,
		std::vector< float >	x,
		std::vector< float >	y,
		std::vector< float >	z
	)

Definition at line 41 of file ClusterShapes.cxx.

    : _nHits(nhits), _aHit(nhits, 0.0), _xHit(nhits, 0.0), _yHit(nhits, 0.0), _zHit(nhits, 0.0), _ifNotGravity(1), _ifNotWidth(1), _ifNotInertia(1), _ifNotElipsoid(1)
    {
        for (int i(0); i < nhits; ++i)
        {
            _aHit[i] = a[i];
            _tHit[i] = 0.;
            _xHit[i] = x[i];
            _yHit[i] = y[i];
            _zHit[i] = z[i];
        }
    }

util::ClusterShapes::ClusterShapes	(	int	nhits,
		std::vector< float >	a,
		std::vector< float >	t,
		std::vector< float >	x,
		std::vector< float >	y,
		std::vector< float >	z
	)

Definition at line 54 of file ClusterShapes.cxx.

    : _nHits(nhits), _aHit(nhits, 0.0), _tHit(nhits, 0.0), _xHit(nhits, 0.0), _yHit(nhits, 0.0), _zHit(nhits, 0.0), _ifNotGravity(1), _ifNotWidth(1), _ifNotInertia(1), _ifNotElipsoid(1)
    {
        for (int i(0); i < nhits; ++i)
        {
            _aHit[i] = a[i];
            _tHit[i] = t[i];
            _xHit[i] = x[i];
            _yHit[i] = y[i];
            _zHit[i] = z[i];
        }
    }

util::ClusterShapes::~ClusterShapes

(

)

Destructor

Definition at line 70 of file ClusterShapes.cxx.

                                  {

    }

Member Function Documentation

float util::ClusterShapes::findDistance ( int  i )

private

Definition at line 304 of file ClusterShapes.cxx.

                                           {

        float cx = 0.0;
        float cy = 0.0;
        float cz = 0.0;
        float dx = 0.0;
        float dy = 0.0;
        float dz = 0.0;

        cx = _VecAnalogInertia[0] ;
        cy = _VecAnalogInertia[1] ;
        cz = _VecAnalogInertia[2] ;
        dx = _analogGravity[0] - _xHit[i] ;
        dy = _analogGravity[1] - _yHit[i] ;
        dz = _analogGravity[2] - _zHit[i] ;

        float tx = cy*dz - cz*dy ;
        float ty = cz*dx - cx*dz ;
        float tz = cx*dy - cy*dx ;
        float tt = sqrt(tx*tx+ty*ty+tz*tz) ;
        float ti = sqrt(cx*cx+cy*cy+cz*cz) ;
        float f = tt / ti ;

        return f ;
    }

void util::ClusterShapes::findElipsoid ( )

private

Elipsoid parameter calculations see cluster_proper.f

Definition at line 122 of file ClusterShapes.cxx.

                                     {

        /**   Elipsoid parameter calculations see cluster_proper.f  */
        float cx,cy,cz ;
        float dx,dy,dz ;
        float r_hit_max, d_begn, d_last, r_max, proj;

        if (_ifNotInertia == 1) findInertia() ;

        //   Normalize the eigen values of inertia tensor
        float wr1 = sqrt(_ValAnalogInertia[0]/_totAmpl);
        float wr2 = sqrt(_ValAnalogInertia[1]/_totAmpl);
        float wr3 = sqrt(_ValAnalogInertia[2]/_totAmpl);

        _r1 = sqrt(wr2*wr3);                // spatial axis length -- the largest
        _r2 = sqrt(wr1*wr3);                // spatial axis length -- less
        _r3 = sqrt(wr1*wr2);                // spatial axis length -- even more less
        _vol = 4.*M_PI*_r1*_r2*_r3/3.;      // ellipsoid volume
        _r_ave = pow(_vol,1/3);             // average radius  (quibc root)
        _density = _totAmpl/_vol;           // density
        _eccentricity =_analogWidth/_r1;   // Cluster Eccentricity

        // Find Minumal and Maximal Lenght for Principal axis
        r_hit_max = -100000.;
        d_begn    =  100000.;
        d_last    = -100000.;
        cx = _VecAnalogInertia[0] ;
        cy = _VecAnalogInertia[1] ;
        cz = _VecAnalogInertia[2] ;

        for (int i(0); i < _nHits; ++i)
        {
            dx = _xHit[i] - _xgr;
            dy = _yHit[i] - _ygr;
            dz = _zHit[i] - _zgr;
            r_max = sqrt(dx*dx + dy*dy + dz*dz);

            if(r_max > r_hit_max) r_hit_max = r_max;
            proj = dx*cx + dy*cy + dz*cz;

            if(proj < d_begn)
            d_begn = proj;

            if(proj > d_last)
            d_last = proj;
        }

        _r1_forw = fabs(d_last);
        _r1_back = fabs(d_begn);

        _ifNotElipsoid = 0;
    }

void util::ClusterShapes::findGravity ( )

private

Definition at line 177 of file ClusterShapes.cxx.

                                    {

        _totAmpl = 0. ;

        for (int i(0); i < 3; ++i)
        _analogGravity[i] = 0.0 ;

        for (int i(0); i < _nHits; ++i)
        {
            _totAmpl+=_aHit[i] ;
            _totTime+=_tHit[i] ;
            _analogGravity[0]+=_aHit[i]*_xHit[i] ;
            _analogGravity[1]+=_aHit[i]*_yHit[i] ;
            _analogGravity[2]+=_aHit[i]*_zHit[i] ;
        }

        for (int i(0); i < 3; ++i)
        _analogGravity[i]/=_totAmpl ;

        _xgr = _analogGravity[0];
        _ygr = _analogGravity[1];
        _zgr = _analogGravity[2];

        _ifNotGravity = 0;
    }

void util::ClusterShapes::findInertia ( )

private

Definition at line 205 of file ClusterShapes.cxx.

                                    {

        double aIne[3][3];
        float radius2 = 0.0;

        findGravity();

        for (int i(0); i < 3; ++i) {
            for (int j(0); j < 3; ++j) {
                aIne[i][j] = 0.0;
            }
        }

        for (int i(0); i < _nHits; ++i)
        {
            float dX = _xHit[i] - _analogGravity[0];
            float dY = _yHit[i] - _analogGravity[1];
            float dZ = _zHit[i] - _analogGravity[2];
            aIne[0][0] += _aHit[i]*(dY*dY+dZ*dZ);
            aIne[1][1] += _aHit[i]*(dX*dX+dZ*dZ);
            aIne[2][2] += _aHit[i]*(dX*dX+dY*dY);
            aIne[0][1] -= _aHit[i]*dX*dY;
            aIne[0][2] -= _aHit[i]*dX*dZ;
            aIne[1][2] -= _aHit[i]*dY*dZ;
        }

        for (int i(0); i < 2; ++i) {
            for (int j = i+1; j < 3; ++j) {
                aIne[j][i] = aIne[i][j];
            }
        }
        //****************************************
        // analog Inertia
        //****************************************

        gsl_matrix_view aMatrix = gsl_matrix_view_array((double*)aIne,3,3);
        gsl_vector* aVector = gsl_vector_alloc(3);
        gsl_matrix* aEigenVec = gsl_matrix_alloc(3,3);
        gsl_eigen_symmv_workspace* wa = gsl_eigen_symmv_alloc(3);
        gsl_eigen_symmv(&aMatrix.matrix,aVector,aEigenVec,wa);
        gsl_eigen_symmv_free(wa);
        gsl_eigen_symmv_sort(aVector,aEigenVec,GSL_EIGEN_SORT_ABS_ASC);

        for (int i(0); i < 3; i++) {
            _ValAnalogInertia[i] = gsl_vector_get(aVector,i);
            for (int j(0); j < 3; j++) {
                _VecAnalogInertia[i+3*j] = gsl_matrix_get(aEigenVec,i,j);
            }
        }

        // Main principal points away from IP
        _radius = 0.;
        radius2 = 0.;

        for (int i(0); i < 3; ++i) {
            _radius += _analogGravity[i]*_analogGravity[i];
            radius2 += (_analogGravity[i]+_VecAnalogInertia[i])*(_analogGravity[i]+_VecAnalogInertia[i]);
        }

        if ( radius2 < _radius) {
            for (int i(0); i < 3; ++i)
            _VecAnalogInertia[i] = - _VecAnalogInertia[i];
        }

        _radius = sqrt(_radius);
        _ifNotInertia = 0;

        // The final job
        findWidth();
        findElipsoid();

        gsl_vector_free(aVector);
        gsl_matrix_free(aEigenVec);

    }

void util::ClusterShapes::findWidth ( )

private

Definition at line 283 of file ClusterShapes.cxx.

                                  {

        float dist = 0.0;

        if (_ifNotInertia == 1)  findInertia() ;

        _analogWidth  = 0.0 ;

        for (int i(0); i < _nHits; ++i)
        {
            dist = findDistance(i) ;
            _analogWidth+=_aHit[i]*dist*dist ;
        }

        _analogWidth  = sqrt(_analogWidth / _totAmpl) ;

        _ifNotWidth = 0 ;
    }

float util::ClusterShapes::getAverageTime

(

)

returns the average time over the whole cluster

Definition at line 89 of file ClusterShapes.cxx.

                                        {
        if (_ifNotGravity == 1) findGravity();
        return _totTime/_nHits;
    }

float * util::ClusterShapes::getCenterOfGravity

(

)

returns an array, which represents a vector from the origin of the coordiante system, i. e. IP, to the centre of gravity of the cluster. The centre of gravity is calculated with the energy of the entries of the cluster.

Definition at line 96 of file ClusterShapes.cxx.

                                             {
        if (_ifNotGravity == 1) findGravity() ;
        return &_analogGravity[0] ;
    }

float * util::ClusterShapes::getEigenValInertia

(

)

array of the inertias of mass (i. e. energy) corresponding to the three main axes of inertia. The array is sorted in ascending order.

Definition at line 103 of file ClusterShapes.cxx.

                                             {
        if (_ifNotInertia == 1) findInertia();
        return &_ValAnalogInertia[0] ;
    }

float * util::ClusterShapes::getEigenVecInertia

(

)

array of the three main axes of inertia (9 entries) starting with the axis corresponding to the smallest inertia of mass (main principal axis). All axes are normalised to a length of 1.

Definition at line 110 of file ClusterShapes.cxx.

                                             {
        if (_ifNotInertia == 1) findInertia();
        return &_VecAnalogInertia[0] ;
    }

float util::ClusterShapes::getElipsoid_density ( )

inline

density of the ellipsoid defined by: totAmpl/vol

Definition at line 139 of file ClusterShapes.h.

{ return _density; }

float util::ClusterShapes::getElipsoid_eccentricity ( )

inline

eccentricity of the ellipsoid defined by: Width/r1

Definition at line 145 of file ClusterShapes.h.

{ return _eccentricity; }

float util::ClusterShapes::getElipsoid_r1 ( )

inline

largest spatial axis length of the ellipsoid derived by the inertia tensor (by their eigenvalues and eigen- vectors)

Definition at line 110 of file ClusterShapes.h.

{ return _r1; }

float util::ClusterShapes::getElipsoid_r2 ( )

inline

medium spatial axis length of the ellipsoid derived by the inertia tensor (by their eigenvalues and eigen- vectors)

Definition at line 117 of file ClusterShapes.h.

{ return _r2; }

float util::ClusterShapes::getElipsoid_r3 ( )

inline

smallest spatial axis length of the ellipsoid derived by the inertia tensor (by their eigenvalues and eigen- vectors)

Definition at line 124 of file ClusterShapes.h.

{ return _r3; }

float util::ClusterShapes::getElipsoid_r_ave ( )

inline

average radius of the ellipsoid (qubic root of volume)

Definition at line 134 of file ClusterShapes.h.

{ return _r_ave; }

float util::ClusterShapes::getElipsoid_r_back ( )

inline

distance from centre of gravity to the point nearest to IP projected on the main principal axis

Definition at line 157 of file ClusterShapes.h.

{ return _r1_back; }

float util::ClusterShapes::getElipsoid_r_forw ( )

inline

distance from centre of gravity to the point most far away from IP projected on the main principal axis

Definition at line 151 of file ClusterShapes.h.

{ return _r1_forw; }

float util::ClusterShapes::getElipsoid_vol ( )

inline

volume of the ellipsoid

Definition at line 129 of file ClusterShapes.h.

{ return _vol; }

int util::ClusterShapes::getNumberOfHits

(

)

returns the number of elements of the cluster

Definition at line 76 of file ClusterShapes.cxx.

                                       {
        return _nHits;
    }

float util::ClusterShapes::getTotalAmplitude

(

)

returns the accumulated amplitude for the whole cluster (just the sum of the energy in all the entries of the cluster)

Definition at line 82 of file ClusterShapes.cxx.

                                           {
        if (_ifNotGravity == 1) findGravity();
        return _totAmpl;
    }

float util::ClusterShapes::getWidth

(

)

'mean' width of the cluster perpendicular to the main principal axis, defined as: width := sqrt( 1/TotalAmplitude * Sum(a[i]*d[i]*d[i]) ), where d[i] is the distance of the i-th point to the main principal axis.

Definition at line 117 of file ClusterShapes.cxx.

                                  {
        if (_ifNotWidth == 1) findWidth();
        return _analogWidth;
    }

float util::ClusterShapes::radius ( )

inline

distance to the centre of gravity measured from IP (absolut value of the vector to the centre of gravity)

Definition at line 103 of file ClusterShapes.h.

{ return _radius; }

Member Data Documentation

std::vector<float> util::ClusterShapes::_aHit

private

Definition at line 163 of file ClusterShapes.h.

float util::ClusterShapes::_analogGravity[3] = {0.0, 0.0, 0.0}

private

Definition at line 176 of file ClusterShapes.h.

float util::ClusterShapes::_analogWidth = 0.0

private

Definition at line 179 of file ClusterShapes.h.

float util::ClusterShapes::_density = 0.0

private

Definition at line 191 of file ClusterShapes.h.

float util::ClusterShapes::_eccentricity = 0.0

private

Definition at line 192 of file ClusterShapes.h.

int util::ClusterShapes::_ifNotElipsoid = 1

private

Definition at line 185 of file ClusterShapes.h.

int util::ClusterShapes::_ifNotGravity = 1

private

Definition at line 169 of file ClusterShapes.h.

int util::ClusterShapes::_ifNotInertia = 1

private

Definition at line 181 of file ClusterShapes.h.

int util::ClusterShapes::_ifNotWidth = 1

private

Definition at line 178 of file ClusterShapes.h.

int util::ClusterShapes::_nHits

private

Definition at line 161 of file ClusterShapes.h.

float util::ClusterShapes::_r1 = 0.0

private

Definition at line 186 of file ClusterShapes.h.

float util::ClusterShapes::_r1_back = 0.0

private

Definition at line 194 of file ClusterShapes.h.

float util::ClusterShapes::_r1_forw = 0.0

private

Definition at line 193 of file ClusterShapes.h.

float util::ClusterShapes::_r2 = 0.0

private

Definition at line 187 of file ClusterShapes.h.

float util::ClusterShapes::_r3 = 0.0

private

Definition at line 188 of file ClusterShapes.h.

float util::ClusterShapes::_r_ave = 0.0

private

Definition at line 190 of file ClusterShapes.h.

float util::ClusterShapes::_radius = 0.0

private

Definition at line 172 of file ClusterShapes.h.

std::vector<float> util::ClusterShapes::_tHit

private

Definition at line 164 of file ClusterShapes.h.

float util::ClusterShapes::_totAmpl = 0.0

private

Definition at line 170 of file ClusterShapes.h.

float util::ClusterShapes::_totTime = 0.0

private

Definition at line 171 of file ClusterShapes.h.

float util::ClusterShapes::_ValAnalogInertia[3] = {0., 0., 0.}

private

Definition at line 182 of file ClusterShapes.h.

float util::ClusterShapes::_VecAnalogInertia[9] = {0., 0., 0., 0., 0., 0., 0., 0., 0.}

private

Definition at line 183 of file ClusterShapes.h.

float util::ClusterShapes::_vol = 0.0

private

Definition at line 189 of file ClusterShapes.h.

float util::ClusterShapes::_xgr = 0.0

private

Definition at line 173 of file ClusterShapes.h.

std::vector<float> util::ClusterShapes::_xHit

private

Definition at line 165 of file ClusterShapes.h.

float util::ClusterShapes::_ygr = 0.0

private

Definition at line 174 of file ClusterShapes.h.

std::vector<float> util::ClusterShapes::_yHit

private

Definition at line 166 of file ClusterShapes.h.

float util::ClusterShapes::_zgr = 0.0

private

Definition at line 175 of file ClusterShapes.h.

std::vector<float> util::ClusterShapes::_zHit

private

Definition at line 167 of file ClusterShapes.h.

---

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

• garsoft/RecoAlg/ClusterShapes.h
• garsoft/RecoAlg/ClusterShapes.cxx