BowedSurfaceAlignmentParameters Class Reference

#include <BowedSurfaceAlignmentParameters.h>

Inheritance diagram for BowedSurfaceAlignmentParameters:

Public Types
enum	AlignmentParameterName {   dx = BowedDerivs::dx, dy = BowedDerivs::dy, dz = BowedDerivs::dz, dslopeX = BowedDerivs::dslopeX,   dslopeY = BowedDerivs::dslopeY, drotZ = BowedDerivs::drotZ, dsagittaX = BowedDerivs::dsagittaX, dsagittaXY = BowedDerivs::dsagittaXY,   dsagittaY = BowedDerivs::dsagittaY, N_PARAM = BowedDerivs::N_PARAM }
typedef BowedSurfaceAlignmentDerivatives	BowedDerivs
	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...
	BowedSurfaceAlignmentParameters (Alignable *alignable)
	Constructor with empty parameters/covariance. More...
	BowedSurfaceAlignmentParameters (Alignable *alignable, const AlgebraicVector &parameters, const AlgebraicSymMatrix &covMatrix)
	Constructor for full set of parameters. More...
	BowedSurfaceAlignmentParameters (Alignable *alignable, const AlgebraicVector &parameters, const AlgebraicSymMatrix &covMatrix, const std::vector< bool > &selection)
	Constructor for selection. More...
BowedSurfaceAlignmentParameters *	clone (const AlgebraicVector &parameters, const AlgebraicSymMatrix &covMatrix) const override
	Clone all parameters (for update of parameters) More...
BowedSurfaceAlignmentParameters *	cloneFromSelected (const AlgebraicVector &parameters, const AlgebraicSymMatrix &covMatrix) const override
	Clone selected parameters (for update of parameters) More...
AlgebraicMatrix	derivatives (const TrajectoryStateOnSurface &tsos, const AlignableDetOrUnitPtr &aliDet) const override
	Get all derivatives. More...
void	print () const
	print parameters to screen More...
align::EulerAngles	rotation () const
	Get rotation parameters. More...
align::LocalVector	translation () const
	Get translation parameters in double precision. More...
int	type () const override
	tell type (AlignmentParametersFactory::ParametersType - but no circular dependency) More...
	~BowedSurfaceAlignmentParameters () 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...
virtual AlgebraicMatrix	selectedDerivatives (const TrajectoryStateOnSurface &tsos, const AlignableDetOrUnitPtr &alidet) const
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...

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 9

• 3 translations
• 3 rotations/slopes
• 3 bows/sagittas (u, v and mixed term)

Date

2008/09/02 15:08:12

Revision

1.13

(last update by

Author

flucke

)

Definition at line 27 of file BowedSurfaceAlignmentParameters.h.

Member Typedef Documentation

BowedDerivs

typedef BowedSurfaceAlignmentDerivatives BowedSurfaceAlignmentParameters::BowedDerivs

Give parameters a name.

Definition at line 30 of file BowedSurfaceAlignmentParameters.h.

Member Enumeration Documentation

AlignmentParameterName

enum BowedSurfaceAlignmentParameters::AlignmentParameterName

Enumerator
dx
dy
dz
dslopeX
dslopeY
drotZ
dsagittaX
dsagittaXY
dsagittaY
N_PARAM

Definition at line 31 of file BowedSurfaceAlignmentParameters.h.

                              {
    dx = BowedDerivs::dx,
    dy = BowedDerivs::dy,
    dz = BowedDerivs::dz,
    dslopeX = BowedDerivs::dslopeX,  // NOTE: slope(u) -> k*tan(beta),
    dslopeY = BowedDerivs::dslopeY,  //       slope(v) -> l*tan(alpha)
    drotZ = BowedDerivs::drotZ,      //       rot(w)   -> m*gamma
    dsagittaX = BowedDerivs::dsagittaX,
    dsagittaXY = BowedDerivs::dsagittaXY,
    dsagittaY = BowedDerivs::dsagittaY,
    N_PARAM = BowedDerivs::N_PARAM
  };

Constructor & Destructor Documentation

BowedSurfaceAlignmentParameters() [1/3]

BowedSurfaceAlignmentParameters::BowedSurfaceAlignmentParameters

(

Alignable *

alignable

)

Constructor with empty parameters/covariance.

Definition at line 25 of file BowedSurfaceAlignmentParameters.cc.

Referenced by clone().

    : AlignmentParameters(ali, AlgebraicVector(N_PARAM), AlgebraicSymMatrix(N_PARAM, 0)) {}

BowedSurfaceAlignmentParameters() [2/3]

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

Constructor for full set of parameters.

Definition at line 29 of file BowedSurfaceAlignmentParameters.cc.

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

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

BowedSurfaceAlignmentParameters() [3/3]

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

Constructor for selection.

Definition at line 40 of file BowedSurfaceAlignmentParameters.cc.

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

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

~BowedSurfaceAlignmentParameters()

BowedSurfaceAlignmentParameters::~BowedSurfaceAlignmentParameters ( )

inlineoverride

Destructor.

Definition at line 59 of file BowedSurfaceAlignmentParameters.h.

{};

Member Function Documentation

apply()

void BowedSurfaceAlignmentParameters::apply ( )

overridevirtual

apply parameters to alignable

Implements AlignmentParameters.

Definition at line 119 of file BowedSurfaceAlignmentParameters.cc.

References Alignable::addSurfaceDeformation(), AlignmentParameters::alignable(), dsagittaX, dsagittaXY, dsagittaY, Exception, Alignable::move(), submitPVValidationJobs::params, align::rectify(), makeMuonMisalignmentScenario::rot, Alignable::rotateInGlobalFrame(), rotation(), AlignmentParameters::selector(), Alignable::surface(), AlignmentParameters::theData, 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") << "BowedSurfaceAlignmentParameters::apply: parameters without "
                                             "alignable";
  }

  // Get translation in local frame, transform to global and apply:
  alignable->move(alignable->surface().toGlobal(this->translation()));

  // Rotation in local frame
  const 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);

  // only update the surface deformations if they were selected for alignment
  if (selector()[dsagittaX] || selector()[dsagittaXY] || selector()[dsagittaY]) {
    const auto &params = theData->parameters();
    const BowedSurfaceDeformation deform{params[dsagittaX], params[dsagittaXY], params[dsagittaY]};

    // FIXME: true to propagate down?
    //        Needed for hierarchy with common deformation parameter,
    //        but that is not possible now anyway.
    alignable->addSurfaceDeformation(&deform, false);
  }
}

clone()

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

overridevirtual

Clone all parameters (for update of parameters)

Implements AlignmentParameters.

Definition at line 52 of file BowedSurfaceAlignmentParameters.cc.

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

Referenced by cloneFromSelected().

                                                                                                                   {
  BowedSurfaceAlignmentParameters *rbap =
      new BowedSurfaceAlignmentParameters(this->alignable(), parameters, covMatrix, selector());

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

  return rbap;
}

cloneFromSelected()

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

overridevirtual

Clone selected parameters (for update of parameters)

Implements AlignmentParameters.

Definition at line 65 of file BowedSurfaceAlignmentParameters.cc.

References clone(), AlignmentParameters::expandSymMatrix(), AlignmentParameters::expandVector(), and AlignmentParameters::selector().

                                                                                  {
  return this->clone(this->expandVector(parameters, this->selector()),
                     this->expandSymMatrix(covMatrix, this->selector()));
}

derivatives()

AlgebraicMatrix BowedSurfaceAlignmentParameters::derivatives ( const TrajectoryStateOnSurface &  tsos, const AlignableDetOrUnitPtr &  aliDet  ) const

overridevirtual

Get all derivatives.

Implements AlignmentParameters.

Definition at line 72 of file BowedSurfaceAlignmentParameters.cc.

References AlignmentParameters::alignable(), Exception, AlignableSurface::length(), N_PARAM, Alignable::surface(), and AlignableSurface::width().

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

  if (ali == alidet) {
    const AlignableSurface &surf = ali->surface();
    return BowedDerivs()(tsos, surf.width(), surf.length());
  } else {
    // We could give this a meaning by applying frame-to-frame derivatives
    // to the first six parameters (be careful that alpha and beta changed
    // their scale and switched their place compared to RigidBody!) and
    // keep the remaining three untouched in local meaning.
    // In this way we could do higher level alignment and determine 'average'
    // surface structures for the components.
    throw cms::Exception("MisMatch") << "BowedSurfaceAlignmentParameters::derivatives: The hit alignable "
                                        "must match the "
                                     << "aligned one (i.e. bowed surface parameters cannot be used for "
                                        "composed alignables)\n";
    return AlgebraicMatrix(N_PARAM, 2);  // please compiler
  }
}

print()

void BowedSurfaceAlignmentParameters::print

(

void

)

const

print parameters to screen

Definition at line 154 of file BowedSurfaceAlignmentParameters.cc.

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

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

rotation()

align::EulerAngles BowedSurfaceAlignmentParameters::rotation

(

void

)

const

Get rotation parameters.

Definition at line 102 of file BowedSurfaceAlignmentParameters.cc.

References AlignmentParameters::alignable(), drotZ, dslopeX, dslopeY, BowedSurfaceAlignmentDerivatives::gammaScale(), AlignableSurface::length(), submitPVValidationJobs::params, Alignable::surface(), AlignmentParameters::theData, and AlignableSurface::width().

Referenced by apply().

                                                                 {
  const AlgebraicVector &params = theData->parameters();
  const Alignable *alignable = this->alignable();
  const AlignableSurface &surface = alignable->surface();

  align::EulerAngles eulerAngles(3);
  // Note that dslopeX <-> -beta and dslopeY <-> alpha:
  // Should we use atan of these values? Anyway it is small...
  eulerAngles[0] = params[dslopeY] * 2. / surface.length();
  eulerAngles[1] = -params[dslopeX] * 2. / surface.width();
  const double aScale = BowedDerivs::gammaScale(surface.width(), surface.length());
  eulerAngles[2] = params[drotZ] / aScale;

  return eulerAngles;
}

translation()

align::LocalVector BowedSurfaceAlignmentParameters::translation

(

void

)

const

Get translation parameters in double precision.

Definition at line 95 of file BowedSurfaceAlignmentParameters.cc.

References dx, dy, dz, submitPVValidationJobs::params, and AlignmentParameters::theData.

Referenced by apply().

                                                                    {
  // align::LocalVector uses double while LocalVector uses float only!
  const AlgebraicVector &params = theData->parameters();
  return align::LocalVector(params[dx], params[dy], params[dz]);
}

type()

int BowedSurfaceAlignmentParameters::type ( ) const

overridevirtual

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

Implements AlignmentParameters.

Definition at line 151 of file BowedSurfaceAlignmentParameters.cc.

References AlignmentParametersFactory::kBowedSurface.

{ return AlignmentParametersFactory::kBowedSurface; }