reco::BeamSpot Class Reference

#include <BeamSpot.h>

Public Types
enum	{ dimension = 7 }
enum	{ dim3 = 3 }
enum	{ resdim = 2 }
enum	BeamType { Unknown =-1, Fake =0, LHC =1, Tracker =2 }
	beam spot flags More...
typedef math::Error< dim3 >::type	Covariance3DMatrix
typedef math::Error< dimension > ::type	CovarianceMatrix
typedef math::XYZPoint	Point
	point in the space More...
typedef math::Error< resdim >::type	ResCovMatrix

Public Member Functions
	BeamSpot ()
	default constructor More...
	BeamSpot (const Point &point, double sigmaZ, double dxdz, double dydz, double BeamWidthX, const CovarianceMatrix &error, BeamType type=Unknown)
	constructor from values More...
double	beamWidthFromBeta (double z, double e) const
double	BeamWidthX () const
	beam width X More...
double	BeamWidthXError () const
	error on beam width X, assume error in X = Y More...
double	BeamWidthY () const
	beam width Y More...
double	BeamWidthYError () const
	error on beam width Y, assume error in X = Y More...
double	betaStar () const
double	covariance (int i, int j) const
	(i,j)-th element of error matrix More...
CovarianceMatrix	covariance () const
	return full covariance matrix of dim 7 More...
Covariance3DMatrix	covariance3D () const
	return only 3D position covariance matrix More...
double	dxdz () const
	dxdz slope More...
double	dxdzError () const
	error on dxdz More...
double	dydz () const
	dydz slope More...
double	dydzError () const
	error on dydz More...
double	emittanceX () const
	additional information More...
double	emittanceY () const
const Point &	position () const
	position More...
const Point	position (const double z) const
	position of the beam spot at a given z value (it takes into account the dxdz and dydz slopes) More...
void	print (std::stringstream &ss) const
	print information More...
Covariance3DMatrix	rotatedCovariance3D () const
void	setBeamWidthX (double v)
void	setBeamWidthY (double v)
void	setbetaStar (double v)
void	setEmittanceX (double v)
void	setEmittanceY (double v)
void	setType (BeamType type)
	set beam type More...
double	sigmaZ () const
	sigma z More...
double	sigmaZ0Error () const
	error on sigma z More...
BeamType	type () const
	return beam type More...
double	x (const double z) const
	x coordinate of the beeam spot position at a given z value (it takes into account the dxdz slope) More...
double	x0 () const
	x coordinate More...
double	x0Error () const
	error on x More...
double	y (const double z) const
	y coordinate of the beeam spot position at a given z value (it takes into account the dydz slope) More...
double	y0 () const
	y coordinate More...
double	y0Error () const
	error on y More...
double	z0 () const
	z coordinate More...
double	z0Error () const
	error on z More...

Private Attributes
Double32_t	BeamWidthX_
Double32_t	BeamWidthY_
Double32_t	betaStar_
Double32_t	dxdz_
Double32_t	dydz_
Double32_t	emittanceX_
Double32_t	emittanceY_
CovarianceMatrix	error_
	errors More...
Point	position_
	position More...
Double32_t	sigmaZ_
BeamType	type_

Detailed Description

Reconstructed beam spot object which provides position, error, and width of the beam position.

Author

Francisco Yumiceva, Fermilab (yumic.nosp@m.eva@.nosp@m.fnal..nosp@m.gov)

Definition at line 22 of file BeamSpot.h.

Member Typedef Documentation

typedef math::Error<dim3>::type reco::BeamSpot::Covariance3DMatrix

Definition at line 33 of file BeamSpot.h.

typedef math::Error<dimension>::type reco::BeamSpot::CovarianceMatrix

Definition at line 31 of file BeamSpot.h.

typedef math::XYZPoint reco::BeamSpot::Point

point in the space

Definition at line 29 of file BeamSpot.h.

typedef math::Error<resdim>::type reco::BeamSpot::ResCovMatrix

Definition at line 35 of file BeamSpot.h.

Member Enumeration Documentation

anonymous enum

Enumerator
dimension

Definition at line 30 of file BeamSpot.h.

{ dimension = 7 };

anonymous enum

Enumerator
dim3

Definition at line 32 of file BeamSpot.h.

{ dim3 = 3 };

anonymous enum

Enumerator
resdim

Definition at line 34 of file BeamSpot.h.

{ resdim = 2 };

enum reco::BeamSpot::BeamType

beam spot flags

Enumerator
Unknown
Fake
LHC
Tracker

Definition at line 26 of file BeamSpot.h.

{ Unknown=-1, Fake=0, LHC=1, Tracker=2 };

Constructor & Destructor Documentation

reco::BeamSpot::BeamSpot

(

)

default constructor

Definition at line 24 of file BeamSpot.cc.

References j, relval_2017::k, and Unknown.

                     {
      // initialize
      position_ = Point(0.,0.,0.);
      sigmaZ_ = 0.;
      dxdz_ = 0.;
      dydz_ = 0.;
      BeamWidthX_ = 0.; BeamWidthY_ = 0;
      for (int j=0; j<7; j++) {
            for (int k=j; k<7; k++) {
                error_(j,k) = 0.;
            }
      }
      type_ = Unknown;
      emittanceX_ = 0;
      emittanceY_ = 0;
      betaStar_ = 0;
  }

reco::BeamSpot::BeamSpot ( const Point &  point, double  sigmaZ, double  dxdz, double  dydz, double  BeamWidthX, const CovarianceMatrix &  error, BeamType  type = Unknown  )

inline

constructor from values

Definition at line 41 of file BeamSpot.h.

References BeamWidthX(), BeamWidthX_, BeamWidthY_, betaStar_, dxdz(), dxdz_, dydz(), dydz_, emittanceX_, emittanceY_, relativeConstraints::error, error_, point, position_, sigmaZ(), sigmaZ_, type(), and type_.

                                   { 
      position_ = point;
      sigmaZ_ = sigmaZ;
      dxdz_ = dxdz;
      dydz_ = dydz;
      BeamWidthX_ = BeamWidthX;
      BeamWidthY_ = BeamWidthX;
      error_ = error;
      type_ = type;
      emittanceX_ = emittanceY_ = 0;
      betaStar_ = 0;
    };

Member Function Documentation

double reco::BeamSpot::beamWidthFromBeta ( double  z, double  e  ) const

inline

Definition at line 139 of file BeamSpot.h.

References betaStar_, position_, funct::pow(), and mathSSE::sqrt().

                                                         {
        return sqrt( e*betaStar_*(1 + pow((z-position_.Z())/betaStar_,2) ) );
    }

double reco::BeamSpot::BeamWidthX ( ) const

inline

beam width X

Definition at line 86 of file BeamSpot.h.

References BeamWidthX_.

Referenced by BeamSpot(), BeamSpotTransientTrackingRecHit::BeamSpotTransientTrackingRecHit(), TwoBodyDecayVirtualMeasurement::extractBeamSpotError(), HIBestVertexProducer::produce(), and HIProtoTrackSelector::select().

{ return BeamWidthX_; }

double reco::BeamSpot::BeamWidthXError ( ) const

inline

error on beam width X, assume error in X = Y

Definition at line 103 of file BeamSpot.h.

References error_, and mathSSE::sqrt().

{ return sqrt ( error_(6,6) );}

double reco::BeamSpot::BeamWidthY ( ) const

inline

beam width Y

Definition at line 88 of file BeamSpot.h.

References BeamWidthY_.

Referenced by BeamSpotTransientTrackingRecHit::BeamSpotTransientTrackingRecHit(), TwoBodyDecayVirtualMeasurement::extractBeamSpotError(), HIBestVertexProducer::produce(), and HIProtoTrackSelector::select().

{ return BeamWidthY_; }

double reco::BeamSpot::BeamWidthYError ( ) const

inline

error on beam width Y, assume error in X = Y

Definition at line 105 of file BeamSpot.h.

References error_, and mathSSE::sqrt().

{ return sqrt ( error_(6,6) );}

double reco::BeamSpot::betaStar ( ) const

inline

Definition at line 138 of file BeamSpot.h.

References betaStar_.

{ return betaStar_; }

double reco::BeamSpot::covariance ( int  i, int  j  ) const

inline

(i,j)-th element of error matrix

Definition at line 112 of file BeamSpot.h.

References error_.

                                           {
      return error_(i,j);
    }

CovarianceMatrix reco::BeamSpot::covariance ( void  ) const

inline

return full covariance matrix of dim 7

Definition at line 116 of file BeamSpot.h.

References error_.

{ return error_; }

Covariance3DMatrix reco::BeamSpot::covariance3D ( ) const

inline

return only 3D position covariance matrix

Definition at line 118 of file BeamSpot.h.

References error_, j, relval_2017::k, and makeMuonMisalignmentScenario::matrix.

                                            {

        Covariance3DMatrix matrix;
        for (int j=0; j<3; j++) {
            for (int k=j; k<3; k++) {
                matrix(j,k) = error_(j,k);
            }
        }
      return matrix;
    };

double reco::BeamSpot::dxdz ( ) const

inline

dxdz slope

Definition at line 82 of file BeamSpot.h.

References dxdz_.

Referenced by BeamSpot(), and x().

{ return dxdz_; }

double reco::BeamSpot::dxdzError ( ) const

inline

error on dxdz

Definition at line 98 of file BeamSpot.h.

References error_, and mathSSE::sqrt().

{ return sqrt ( error_(4,4) ); }

double reco::BeamSpot::dydz ( ) const

inline

dydz slope

Definition at line 84 of file BeamSpot.h.

References dydz_.

Referenced by BeamSpot(), and y().

{ return dydz_; }

double reco::BeamSpot::dydzError ( ) const

inline

error on dydz

Definition at line 100 of file BeamSpot.h.

References error_, and mathSSE::sqrt().

{ return sqrt ( error_(5,5) ); }

double reco::BeamSpot::emittanceX ( ) const

inline

additional information

Definition at line 136 of file BeamSpot.h.

References emittanceX_.

{ return emittanceX_; }

double reco::BeamSpot::emittanceY ( ) const

inline

Definition at line 137 of file BeamSpot.h.

References emittanceY_.

{ return emittanceY_; }

const Point& reco::BeamSpot::position ( ) const

inline

position

Definition at line 62 of file BeamSpot.h.

References position_.

Referenced by ElectronGeneralAnalyzer::analyze(), TwoBodyDecayVirtualMeasurement::beamSpotPosition(), ConversionSeedFinder::findLayers(), HIProtoTrackFilter::operator()(), HIBestVertexProducer::produce(), pat::PATConversionProducer::produce(), and HIProtoTrackSelector::select().

{ return position_; }

const BeamSpot::Point reco::BeamSpot::position

(

const double

z

)

const

position of the beam spot at a given z value (it takes into account the dxdz and dydz slopes)

Definition at line 42 of file BeamSpot.cc.

References x().

                                                             {

    Point pos(x(z),y(z),z);
    return pos;

  }

void reco::BeamSpot::print

(

std::stringstream &

ss

)

const

print information

Definition at line 50 of file BeamSpot.cc.

Referenced by reco::operator<<().

                                                {

    ss << "-----------------------------------------------------\n"
       << "              Beam Spot Data\n\n"
       << " Beam type    = " << type() << "\n"
       << "       X0     = " << x0() << " +/- " << x0Error() << " [cm]\n"
       << "       Y0     = " << y0() << " +/- " << y0Error() << " [cm]\n"
       << "       Z0     = " << z0() << " +/- " << z0Error() << " [cm]\n"
       << " Sigma Z0     = " << sigmaZ() << " +/- " << sigmaZ0Error() << " [cm]\n"
       << " dxdz         = " << dxdz() << " +/- " << dxdzError() << " [radians]\n"
       << " dydz         = " << dydz() << " +/- " << dydzError() << " [radians]\n"
       << " Beam width X = " << BeamWidthX() << " +/- " << BeamWidthXError() << " [cm]\n"
       << " Beam width Y = " << BeamWidthY() << " +/- " << BeamWidthYError() << " [cm]\n"
       << " EmittanceX   = " << emittanceX() << " [cm]\n"
       << " EmittanceY   = " << emittanceY() << " [cm]\n"
       << " beta-star    = " << betaStar() << " [cm]\n"
       << "-----------------------------------------------------\n\n";
    
  }

BeamSpot::Covariance3DMatrix reco::BeamSpot::rotatedCovariance3D

(

)

const

Definition at line 78 of file BeamSpot.cc.

References makeMuonMisalignmentScenario::matrix, funct::pow(), idealTransformation::rotation, TkRotation< T >::xx(), TkRotation< T >::xy(), TkRotation< T >::xz(), TkRotation< T >::yx(), TkRotation< T >::yy(), TkRotation< T >::yz(), TkRotation< T >::zx(), TkRotation< T >::zy(), and TkRotation< T >::zz().

Referenced by GsfConstraintAtVertex::constrainAtBeamSpot(), and TrajectoryStateClosestToBeamLine::transverseImpactParameter().

  {
      AlgebraicVector3 newZ(dxdz(), dydz(), 1.);
      AlgebraicVector3 globalZ(0.,0.,1.);
      AlgebraicVector3 rotationAxis = ROOT::Math::Cross(globalZ.Unit(), newZ.Unit());
      float rotationAngle = -acos( ROOT::Math::Dot(globalZ.Unit(),newZ.Unit()));
      Basic3DVector<float> aa(rotationAxis[0],rotationAxis[1],rotationAxis[2]);
      TkRotation<float> rotation(aa ,rotationAngle);
      AlgebraicMatrix33 rotationMatrix;
      rotationMatrix(0,0) = rotation.xx();
      rotationMatrix(0,1) = rotation.xy();
      rotationMatrix(0,2) = rotation.xz();
      rotationMatrix(1,0) = rotation.yx();
      rotationMatrix(1,1) = rotation.yy();
      rotationMatrix(1,2) = rotation.yz();
      rotationMatrix(2,0) = rotation.zx();
      rotationMatrix(2,1) = rotation.zy();
      rotationMatrix(2,2) = rotation.zz();

      AlgebraicSymMatrix33 diagError ;
      diagError(0,0) = pow(BeamWidthX(),2);
      diagError(1,1) = pow(BeamWidthY(),2);
      diagError(2,2) = pow(sigmaZ(),2);

      Covariance3DMatrix matrix;
      matrix = ROOT::Math::Similarity(rotationMatrix, diagError) + covariance3D();
      return matrix;
  }

void reco::BeamSpot::setBeamWidthX ( double  v )

inline

Definition at line 108 of file BeamSpot.h.

References BeamWidthX_, and findQualityFiles::v.

{ BeamWidthX_ = v; }

void reco::BeamSpot::setBeamWidthY ( double  v )

inline

Definition at line 109 of file BeamSpot.h.

References BeamWidthY_, and findQualityFiles::v.

Referenced by AlcaBeamSpotFromDB::endLuminosityBlockProduce(), and BeamSpotOnlineProducer::produce().

{ BeamWidthY_ = v; }

void reco::BeamSpot::setbetaStar ( double  v )

inline

Definition at line 145 of file BeamSpot.h.

References betaStar_, and findQualityFiles::v.

Referenced by AlcaBeamSpotFromDB::endLuminosityBlockProduce(), and BeamSpotOnlineProducer::produce().

{ betaStar_ = v; }

void reco::BeamSpot::setEmittanceX ( double  v )

inline

Definition at line 143 of file BeamSpot.h.

References emittanceX_, and findQualityFiles::v.

Referenced by AlcaBeamSpotFromDB::endLuminosityBlockProduce(), and BeamSpotOnlineProducer::produce().

{ emittanceX_ = v; }

void reco::BeamSpot::setEmittanceY ( double  v )

inline

Definition at line 144 of file BeamSpot.h.

References emittanceY_, and findQualityFiles::v.

Referenced by AlcaBeamSpotFromDB::endLuminosityBlockProduce(), and BeamSpotOnlineProducer::produce().

{ emittanceY_ = v; }

void reco::BeamSpot::setType ( BeamType  type )

inline

set beam type

Definition at line 131 of file BeamSpot.h.

References type(), and type_.

Referenced by AlcaBeamSpotFromDB::endLuminosityBlockProduce(), and BeamSpotOnlineProducer::produce().

{ type_ = type; }

double reco::BeamSpot::sigmaZ ( ) const

inline

sigma z

Definition at line 80 of file BeamSpot.h.

References sigmaZ_.

Referenced by BeamSpot(), BeamSpotTransientTrackingRecHit::BeamSpotTransientTrackingRecHit(), TwoBodyDecayVirtualMeasurement::extractBeamSpotError(), HIBestVertexProducer::produce(), GlobalTrackingRegionProducerFromBeamSpot::regions(), and GlobalTrackingRegionWithVerticesProducer::regions().

{ return sigmaZ_; }

double reco::BeamSpot::sigmaZ0Error ( ) const

inline

error on sigma z

Definition at line 96 of file BeamSpot.h.

References error_, and mathSSE::sqrt().

{ return sqrt ( error_(3,3) ); }

BeamType reco::BeamSpot::type ( ) const

inline

return beam type

Definition at line 129 of file BeamSpot.h.

References type_.

Referenced by BeamSpot(), and setType().

{ return type_; }

double reco::BeamSpot::x ( const double  z ) const

inline

x coordinate of the beeam spot position at a given z value (it takes into account the dxdz slope)

Definition at line 71 of file BeamSpot.h.

References dxdz(), x0(), and z0().

{ return x0() + dxdz() * (z - z0()); }

double reco::BeamSpot::x0 ( ) const

inline

x coordinate

Definition at line 64 of file BeamSpot.h.

References position_.

Referenced by BeamSpotTransientTrackingRecHit::BeamSpotTransientTrackingRecHit(), FWBeamSpotProxyBuilder::build(), GsfConstraintAtVertex::constrainAtBeamSpot(), HIBestVertexProducer::produce(), MuonSeedGenerator::produce(), GlobalTrackingRegionProducerFromBeamSpot::regions(), GlobalTrackingRegionWithVerticesProducer::regions(), TrackingRegionsFromBeamSpotAndL2Tau::regions(), HIProtoTrackFilter::update(), x(), and FWBeamSpot::x0().

{ return position_.X(); }

double reco::BeamSpot::x0Error ( ) const

inline

error on x

Definition at line 90 of file BeamSpot.h.

References error_, and mathSSE::sqrt().

Referenced by FWBeamSpotProxyBuilder::build(), and FWBeamSpot::x0Error().

{ return sqrt( error_(0,0) ); }

double reco::BeamSpot::y ( const double  z ) const

inline

y coordinate of the beeam spot position at a given z value (it takes into account the dydz slope)

Definition at line 73 of file BeamSpot.h.

References dydz(), y0(), and z0().

{ return y0() + dydz() * (z - z0()); }

double reco::BeamSpot::y0 ( ) const

inline

y coordinate

Definition at line 66 of file BeamSpot.h.

References position_.

Referenced by BeamSpotTransientTrackingRecHit::BeamSpotTransientTrackingRecHit(), FWBeamSpotProxyBuilder::build(), GsfConstraintAtVertex::constrainAtBeamSpot(), HIBestVertexProducer::produce(), MuonSeedGenerator::produce(), GlobalTrackingRegionProducerFromBeamSpot::regions(), GlobalTrackingRegionWithVerticesProducer::regions(), TrackingRegionsFromBeamSpotAndL2Tau::regions(), HIProtoTrackFilter::update(), y(), and FWBeamSpot::y0().

{ return position_.Y(); }

double reco::BeamSpot::y0Error ( ) const

inline

error on y

Definition at line 92 of file BeamSpot.h.

References error_, and mathSSE::sqrt().

Referenced by FWBeamSpotProxyBuilder::build(), and FWBeamSpot::y0Error().

{ return sqrt( error_(1,1) ); }

double reco::BeamSpot::z0 ( ) const

inline

z coordinate

Definition at line 68 of file BeamSpot.h.

References position_.

Referenced by BeamSpotTransientTrackingRecHit::BeamSpotTransientTrackingRecHit(), FWBeamSpotProxyBuilder::build(), GsfConstraintAtVertex::constrainAtBeamSpot(), MuonSeedGenerator::produce(), GlobalTrackingRegionProducerFromBeamSpot::regions(), GlobalTrackingRegionWithVerticesProducer::regions(), TrackingRegionsFromBeamSpotAndL2Tau::regions(), HIProtoTrackFilter::update(), x(), y(), and FWBeamSpot::z0().

{ return position_.Z(); }

double reco::BeamSpot::z0Error ( ) const

inline

error on z

Definition at line 94 of file BeamSpot.h.

References error_, and mathSSE::sqrt().

Referenced by FWBeamSpotProxyBuilder::build(), and FWBeamSpot::z0Error().

{ return sqrt( error_(2,2) ); }

Member Data Documentation

Double32_t reco::BeamSpot::BeamWidthX_

private

Definition at line 157 of file BeamSpot.h.

Referenced by BeamSpot(), BeamWidthX(), and setBeamWidthX().

Double32_t reco::BeamSpot::BeamWidthY_

private

Definition at line 158 of file BeamSpot.h.

Referenced by BeamSpot(), BeamWidthY(), and setBeamWidthY().

Double32_t reco::BeamSpot::betaStar_

private

Definition at line 163 of file BeamSpot.h.

Referenced by BeamSpot(), beamWidthFromBeta(), betaStar(), and setbetaStar().

Double32_t reco::BeamSpot::dxdz_

private

Definition at line 159 of file BeamSpot.h.

Referenced by BeamSpot(), and dxdz().

Double32_t reco::BeamSpot::dydz_

private

Definition at line 160 of file BeamSpot.h.

Referenced by BeamSpot(), and dydz().

Double32_t reco::BeamSpot::emittanceX_

private

Definition at line 161 of file BeamSpot.h.

Referenced by BeamSpot(), emittanceX(), and setEmittanceX().

Double32_t reco::BeamSpot::emittanceY_

private

Definition at line 162 of file BeamSpot.h.

Referenced by BeamSpot(), emittanceY(), and setEmittanceY().

CovarianceMatrix reco::BeamSpot::error_

private

errors

Definition at line 154 of file BeamSpot.h.

Referenced by BeamSpot(), BeamWidthXError(), BeamWidthYError(), covariance(), covariance3D(), dxdzError(), dydzError(), sigmaZ0Error(), x0Error(), y0Error(), and z0Error().

Point reco::BeamSpot::position_

private

position

Definition at line 152 of file BeamSpot.h.

Referenced by BeamSpot(), beamWidthFromBeta(), position(), x0(), y0(), and z0().

Double32_t reco::BeamSpot::sigmaZ_

private

Definition at line 156 of file BeamSpot.h.

Referenced by BeamSpot(), and sigmaZ().

BeamType reco::BeamSpot::type_

private

Definition at line 165 of file BeamSpot.h.

Referenced by BeamSpot(), RandomRunSource.RandomRunSource::insertInto(), setType(), and type().