BeamSpotAlignmentParameters Class Reference

#include <BeamSpotAlignmentParameters.h>

Inheritance diagram for BeamSpotAlignmentParameters:

Public Types
enum	AlignmentParameterName {   dx = 0, dy, dxslope, dyslope,   N_PARAM }
	Give parameters a name. More...
Public Types inherited from AlignmentParameters
typedef AlignmentParametersData::DataContainer	DataContainer

Public Member Functions
void	apply () override
	apply parameters to alignable More...
	BeamSpotAlignmentParameters (Alignable *alignable, bool calcMis)
	BeamSpotAlignmentParameters (Alignable *alignable, const AlgebraicVector &parameters, const AlgebraicSymMatrix &covMatrix)
	Constructor for full set of parameters. More...
	BeamSpotAlignmentParameters (Alignable *alignable, const AlgebraicVector &parameters, const AlgebraicSymMatrix &covMatrix, const std::vector< bool > &selection)
	Constructor for selection. More...
BeamSpotAlignmentParameters *	clone (const AlgebraicVector &parameters, const AlgebraicSymMatrix &covMatrix) const override
	Clone all parameters (for update of parameters) More...
BeamSpotAlignmentParameters *	cloneFromSelected (const AlgebraicVector &parameters, const AlgebraicSymMatrix &covMatrix) const override
	Clone selected parameters (for update of parameters) More...
AlgebraicMatrix	derivatives (const TrajectoryStateOnSurface &tsos, const AlignableDetOrUnitPtr &) const override
	Get all derivatives. More...
AlgebraicVector	globalParameters (void) const
	calculate and return parameters in global frame More...
void	print (void) const
	print parameters to screen More...
AlgebraicVector	rotation (void) const
	Get rotation parameters. More...
AlgebraicMatrix	selectedDerivatives (const TrajectoryStateOnSurface &tsos, const AlignableDetOrUnitPtr &) const override
	Get selected derivatives. More...
AlgebraicVector	translation (void) const
	Get translation parameters. More...
int	type () const override
	tell type (AlignmentParametersFactory::ParametersType - but no circular dependency) More...
	~BeamSpotAlignmentParameters () override
	Destructor. More...
Public Member Functions inherited from AlignmentParameters
Alignable *	alignable (void) const
	Get pointer to corresponding alignable. More...
	AlignmentParameters ()
	Default constructor. More...
	AlignmentParameters (Alignable *object, const AlgebraicVector &par, const AlgebraicSymMatrix &cov)
	Constructor from given input. More...
	AlignmentParameters (Alignable *object, const AlgebraicVector &par, const AlgebraicSymMatrix &cov, const std::vector< bool > &sel)
	Constructor including selection of active parameters. More...
	AlignmentParameters (Alignable *object, const DataContainer &data)
	Constructor. More...
const AlgebraicSymMatrix &	covariance (void) const
	Get parameter covariance matrix. More...
virtual unsigned int	hierarchyLevel () const
bool	isValid (void) const
	Get validity flag. More...
int	numSelected (void) const
	Get number of selected parameters. More...
const AlgebraicVector &	parameters (void) const
	Get alignment parameters. More...
AlgebraicSymMatrix	selectedCovariance (void) const
	Get covariance matrix of selected parameters. More...
AlgebraicVector	selectedParameters (void) const
	Get selected parameters. More...
const std::vector< bool > &	selector (void) const
	Get alignment parameter selector vector. More...
void	setUserVariables (AlignmentUserVariables *auv)
	Set pointer to user variables. More...
void	setValid (bool v)
	Set validity flag. More...
int	size (void) const
	Get number of parameters. More...
AlignmentUserVariables *	userVariables (void) const
	Get pointer to user variables. More...
virtual	~AlignmentParameters ()
	Destructor. More...

Static Public Member Functions
static AlgebraicVector	displacementFromAlignable (const Alignable *ali)

Additional Inherited Members
Protected Member Functions inherited from AlignmentParameters
AlgebraicSymMatrix	collapseSymMatrix (const AlgebraicSymMatrix &m, const std::vector< bool > &sel) const
AlgebraicVector	collapseVector (const AlgebraicVector &m, const std::vector< bool > &sel) const
AlgebraicSymMatrix	expandSymMatrix (const AlgebraicSymMatrix &m, const std::vector< bool > &sel) const
AlgebraicVector	expandVector (const AlgebraicVector &m, const std::vector< bool > &sel) const
Protected Attributes inherited from AlignmentParameters
bool	bValid
	True if parameters are valid. More...
Alignable *	theAlignable
DataContainer	theData
AlignmentUserVariables *	theUserVariables

Detailed Description

Concrete class for alignment parameters and associated quantities [derived from AlignmentParameters]. The number of parameters N_PARAM is fixed to 4 (2 translations in x & y, and 2 slopes)

Date

2008/09/02 15:08:12

Revision

1.13

(last update by

Author

flucke

)

Definition at line 21 of file BeamSpotAlignmentParameters.h.

Member Enumeration Documentation

AlignmentParameterName

enum BeamSpotAlignmentParameters::AlignmentParameterName

Give parameters a name.

Enumerator
dx
dy
dxslope
dyslope
N_PARAM

Definition at line 24 of file BeamSpotAlignmentParameters.h.

{ dx = 0, dy, dxslope, dyslope, N_PARAM };

Constructor & Destructor Documentation

BeamSpotAlignmentParameters() [1/3]

BeamSpotAlignmentParameters::BeamSpotAlignmentParameters	(	Alignable *	alignable,
		bool	calcMis
	)

Constructor with empty parameters/covariance (if calcMis = false) or with parameters (no covariance) created from current (mis-)placement of alignable (if calcMis = true).

Definition at line 21 of file BeamSpotAlignmentParameters.cc.

Referenced by clone(), and cloneFromSelected().

    : AlignmentParameters(ali, displacementFromAlignable(calcMis ? ali : nullptr), AlgebraicSymMatrix(N_PARAM, 0)) {}

BeamSpotAlignmentParameters() [2/3]

BeamSpotAlignmentParameters::BeamSpotAlignmentParameters	(	Alignable *	alignable,
		const AlgebraicVector &	parameters,
		const AlgebraicSymMatrix &	covMatrix
	)

Constructor for full set of parameters.

Definition at line 25 of file BeamSpotAlignmentParameters.cc.

References Exception, N_PARAM, and AlignmentParameters::parameters().

    : AlignmentParameters(alignable, parameters, covMatrix) {
  if (parameters.num_row() != N_PARAM) {
    throw cms::Exception("BadParameters")
        << "in BeamSpotAlignmentParameters(): " << parameters.num_row() << " instead of " << N_PARAM << " parameters.";
  }
}

BeamSpotAlignmentParameters() [3/3]

BeamSpotAlignmentParameters::BeamSpotAlignmentParameters	(	Alignable *	alignable,
		const AlgebraicVector &	parameters,
		const AlgebraicSymMatrix &	covMatrix,
		const std::vector< bool > &	selection
	)

Constructor for selection.

Definition at line 36 of file BeamSpotAlignmentParameters.cc.

References Exception, N_PARAM, and AlignmentParameters::parameters().

    : AlignmentParameters(alignable, parameters, covMatrix, selection) {
  if (parameters.num_row() != N_PARAM) {
    throw cms::Exception("BadParameters")
        << "in BeamSpotAlignmentParameters(): " << parameters.num_row() << " instead of " << N_PARAM << " parameters.";
  }
}

~BeamSpotAlignmentParameters()

BeamSpotAlignmentParameters::~BeamSpotAlignmentParameters ( )

override

Destructor.

Definition at line 48 of file BeamSpotAlignmentParameters.cc.

{}

Member Function Documentation

apply()

void BeamSpotAlignmentParameters::apply ( )

overridevirtual

apply parameters to alignable

Implements AlignmentParameters.

Definition at line 147 of file BeamSpotAlignmentParameters.cc.

References AlignmentParameters::alignable(), Exception, Alignable::move(), align::rectify(), makeMuonMisalignmentScenario::rot, Alignable::rotateInGlobalFrame(), rotation(), edm::shift, Alignable::surface(), AlignableSurface::toGlobal(), align::toMatrix(), and translation().

Referenced by heavyIonTools.ConfigureHeavyIons::__call__(), coreTools.RunOnData::__call__(), trackTools.MakeAODTrackCandidates::__call__(), runJetUncertainties.RunJetUncertainties::__call__(), metTools.AddMETCollection::__call__(), heavyIonTools.ProductionDefaults::__call__(), cmsswVersionTools.PickRelValInputFiles::__call__(), coreTools.RemoveMCMatching::__call__(), trackTools.MakePATTrackCandidates::__call__(), trigTools.SwitchOnTrigger::__call__(), runMETCorrectionsAndUncertainties.RunMETCorrectionsAndUncertainties::__call__(), heavyIonTools.SelectionDefaults::__call__(), heavyIonTools.DisbaleMonteCarloDeps::__call__(), trigTools.SwitchOnTriggerStandAlone::__call__(), tauTools.AddTauCollection::__call__(), trackTools.MakeTrackCandidates::__call__(), trigTools.SwitchOnTriggerMatching::__call__(), trigTools.SwitchOnTriggerMatchingStandAlone::__call__(), trigTools.SwitchOnTriggerMatchEmbedding::__call__(), jetTools.AddJetCollection::__call__(), jetTools.SwitchJetCollection::__call__(), jetTools.UpdateJetCollection::__call__(), jetTools.AddJetID::__call__(), and jetTools.SetTagInfos::__call__().

                                        {
  Alignable *alignable = this->alignable();
  if (!alignable) {
    throw cms::Exception("BadParameters") << "BeamSpotAlignmentParameters::apply: parameters without alignable";
  }

  // Translation in local frame
  AlgebraicVector shift = this->translation();  // fixme: should be LocalVector

  // Translation local->global
  align::GlobalVector gv(shift[0], shift[1], shift[2]);
  alignable->move(gv);

  // Rotation in local frame
  align::EulerAngles angles = this->rotation();
  // original code:
  //  alignable->rotateInLocalFrame( align::toMatrix(angles) );
  // correct for rounding errors:
  align::RotationType rot = alignable->surface().toGlobal(align::toMatrix(angles));
  align::rectify(rot);
  alignable->rotateInGlobalFrame(rot);
}

clone()

BeamSpotAlignmentParameters * BeamSpotAlignmentParameters::clone ( const AlgebraicVector &  parameters, const AlgebraicSymMatrix &  covMatrix  ) const

overridevirtual

Clone all parameters (for update of parameters)

Implements AlignmentParameters.

Definition at line 51 of file BeamSpotAlignmentParameters.cc.

References AlignmentParameters::alignable(), BeamSpotAlignmentParameters(), AlignmentParameters::isValid(), AlignmentParameters::parameters(), AlignmentParameters::selector(), AlignmentParameters::setUserVariables(), AlignmentParameters::setValid(), and AlignmentParameters::userVariables().

Referenced by cloneFromSelected().

                                                                                                           {
  BeamSpotAlignmentParameters *rbap = new BeamSpotAlignmentParameters(alignable(), parameters, covMatrix, selector());

  if (userVariables())
    rbap->setUserVariables(userVariables()->clone());
  rbap->setValid(isValid());

  return rbap;
}

cloneFromSelected()

BeamSpotAlignmentParameters * BeamSpotAlignmentParameters::cloneFromSelected ( const AlgebraicVector &  parameters, const AlgebraicSymMatrix &  covMatrix  ) const

overridevirtual

Clone selected parameters (for update of parameters)

Implements AlignmentParameters.

Definition at line 63 of file BeamSpotAlignmentParameters.cc.

References AlignmentParameters::alignable(), BeamSpotAlignmentParameters(), clone(), AlignmentParameters::expandSymMatrix(), AlignmentParameters::expandVector(), AlignmentParameters::isValid(), AlignmentParameters::parameters(), AlignmentParameters::selector(), AlignmentParameters::setUserVariables(), AlignmentParameters::setValid(), and AlignmentParameters::userVariables().

                                                                                                                       {
  BeamSpotAlignmentParameters *rbap = new BeamSpotAlignmentParameters(
      alignable(), expandVector(parameters, selector()), expandSymMatrix(covMatrix, selector()), selector());

  if (userVariables())
    rbap->setUserVariables(userVariables()->clone());
  rbap->setValid(isValid());

  return rbap;
}

derivatives()

AlgebraicMatrix BeamSpotAlignmentParameters::derivatives ( const TrajectoryStateOnSurface &  tsos, const AlignableDetOrUnitPtr &  alidet  ) const

overridevirtual

Get all derivatives.

Implements AlignmentParameters.

Definition at line 76 of file BeamSpotAlignmentParameters.cc.

References AlignmentParameters::alignable(), Exception, and N_PARAM.

Referenced by selectedDerivatives().

                                                                                                    {
  const Alignable *ali = this->alignable();  // Alignable of these parameters

  if (ali == alidet) {  // same alignable => same frame
    return BeamSpotAlignmentDerivatives()(tsos);
  } else {
    throw cms::Exception("MisMatch") << "BeamSpotAlignmentParameters::derivatives: The hit alignable must "
                                        "match the "
                                     << "aligned one, i.e. these parameters make only sense for "
                                        "AlignableBeamSpot.\n";
    return AlgebraicMatrix(N_PARAM, 2);  // please compiler
  }
}

displacementFromAlignable()

AlgebraicVector BeamSpotAlignmentParameters::displacementFromAlignable ( const Alignable *  ali )

static

Calculate parameter vector of misplacements (shift+rotation) from alignable. (If ali=0, return empty AlgebraicVector of proper length.)

Definition at line 203 of file BeamSpotAlignmentParameters.cc.

References PV3DBase< T, PVType, FrameType >::basicVector(), Alignable::displacement(), HGC3DClusterGenMatchSelector_cfi::dR, Alignable::globalRotation(), N_PARAM, Alignable::rotation(), PV3DBase< T, PVType, FrameType >::x(), and PV3DBase< T, PVType, FrameType >::y().

                                                                                           {
  AlgebraicVector displacement(N_PARAM);

  if (ali) {
    const align::RotationType &dR = ali->rotation();

    const align::LocalVector shifts(ali->globalRotation() * (dR.transposed() * ali->displacement().basicVector()));

    align::GlobalVector gv(0.0, 0.0, 1.0);
    align::LocalVector lv(dR.transposed() * gv.basicVector());

    displacement[0] = shifts.x();
    displacement[1] = shifts.y();
    displacement[2] = lv.x() / lv.z();
    displacement[3] = lv.y() / lv.z();
  }

  return displacement;
}

globalParameters()

AlgebraicVector BeamSpotAlignmentParameters::globalParameters

(

void

)

const

calculate and return parameters in global frame

Definition at line 174 of file BeamSpotAlignmentParameters.cc.

References dxdz, dydz, N_PARAM, edm::shift, Alignable::surface(), AlignmentParameters::theAlignable, AlignableSurface::toGlobal(), translation(), PV3DBase< T, PVType, FrameType >::x(), PV3DBase< T, PVType, FrameType >::y(), and PV3DBase< T, PVType, FrameType >::z().

                                                                        {
  AlgebraicVector m_GlobalParameters(N_PARAM, 0);

  const AlgebraicVector shift = translation();  // fixme: should return LocalVector

  const align::GlobalVector dg(shift[0], shift[1], 0);

  m_GlobalParameters[0] = dg.x();
  m_GlobalParameters[1] = dg.y();

  align::LocalVector lv(0.0, 0.0, 1.0);
  align::GlobalVector gv = theAlignable->surface().toGlobal(lv);

  double dxdz = gv.x() / gv.z();
  double dydz = gv.x() / gv.z();

  m_GlobalParameters[2] = dxdz;
  m_GlobalParameters[3] = dydz;

  return m_GlobalParameters;
}

print()

void BeamSpotAlignmentParameters::print

(

void

)

const

print parameters to screen

Definition at line 197 of file BeamSpotAlignmentParameters.cc.

References gather_cfg::cout, and AlignmentParameters::theData.

                                                  {
  std::cout << "Contents of BeamSpotAlignmentParameters:"
            << "\nParameters: " << theData->parameters() << "\nCovariance: " << theData->covariance() << std::endl;
}

rotation()

AlgebraicVector BeamSpotAlignmentParameters::rotation

(

void

)

const

Get rotation parameters.

Definition at line 125 of file BeamSpotAlignmentParameters.cc.

References funct::cos(), dxdz, dydz, makeMuonMisalignmentScenario::rot, funct::sin(), AlignmentParameters::theData, and align::toAngles().

Referenced by apply().

                                                                {
  AlgebraicVector rot(3);

  double dxdz = theData->parameters()[2];
  double dydz = theData->parameters()[3];
  double angleY = std::atan(dxdz);
  double angleX = -std::atan(dydz);

  align::RotationType rotY(std::cos(angleY), 0., -std::sin(angleY), 0., 1., 0., std::sin(angleY), 0., std::cos(angleY));

  align::RotationType rotX(1., 0., 0., 0., std::cos(angleX), std::sin(angleX), 0., -std::sin(angleX), std::cos(angleX));

  align::EulerAngles angles = align::toAngles(rotY * rotX);

  rot[0] = angles(1);
  rot[1] = angles(2);
  rot[2] = angles(3);

  return rot;
}

selectedDerivatives()

AlgebraicMatrix BeamSpotAlignmentParameters::selectedDerivatives ( const TrajectoryStateOnSurface &  tsos, const AlignableDetOrUnitPtr &  alignableDet  ) const

overridevirtual

Get selected derivatives.

Reimplemented from AlignmentParameters.

Definition at line 92 of file BeamSpotAlignmentParameters.cc.

References derivatives(), hgcalPlots::ncols, AlignmentParameters::numSelected(), and AlignmentParameters::selector().

                                                                                                                  {
  const AlgebraicMatrix dev = this->derivatives(tsos, alignableDet);

  int ncols = dev.num_col();
  int nrows = dev.num_row();
  int nsel = numSelected();

  AlgebraicMatrix seldev(nsel, ncols);

  int ir2 = 0;
  for (int irow = 0; irow < nrows; ++irow) {
    if (selector()[irow]) {
      for (int icol = 0; icol < ncols; ++icol)
        seldev[ir2][icol] = dev[irow][icol];
      ++ir2;
    }
  }

  return seldev;
}

translation()

AlgebraicVector BeamSpotAlignmentParameters::translation

(

void

)

const

Get translation parameters.

Definition at line 115 of file BeamSpotAlignmentParameters.cc.

References mps_fire::i, edm::shift, and AlignmentParameters::theData.

Referenced by apply(), and globalParameters().

                                                                   {
  AlgebraicVector shift(3);
  for (int i = 0; i < 2; ++i)
    shift[i] = theData->parameters()[i];
  shift[2] = 0.0;

  return shift;
}

type()

int BeamSpotAlignmentParameters::type ( ) const

overridevirtual

tell type (AlignmentParametersFactory::ParametersType - but no circular dependency)

Implements AlignmentParameters.

Definition at line 171 of file BeamSpotAlignmentParameters.cc.

References AlignmentParametersFactory::kBeamSpot.

{ return AlignmentParametersFactory::kBeamSpot; }