AlignableDet Class Reference

#include <AlignableDet.h>

Inheritance diagram for AlignableDet:

Public Member Functions
void	addAlignmentPositionError (const AlignmentPositionError &ape, bool propagateDown) override
void	addAlignmentPositionErrorFromRotation (const RotationType &rot, bool propagateDown) override
	AlignableDet (const GeomDet *geomDet, bool addComponents=true)
AlignmentErrorsExtended *	alignmentErrors () const override
	Return vector of alignment errors. More...
const AlignmentPositionError *	alignmentPositionError () const
	alignment position error - for checking only, otherwise use alignmentErrors() above! More...
Alignments *	alignments () const override
	Return vector of alignment data. More...
void	setAlignmentPositionError (const AlignmentPositionError &ape, bool propagateDown) override
	Set the AlignmentPositionError and, if (propagateDown), to all components. More...
void	update (const GeomDet *geomDet, bool updateComponents=true)
	~AlignableDet () override
	Destructor. More...
Public Member Functions inherited from AlignableComposite
void	addAlignmentPositionErrorFromLocalRotation (const RotationType &rotation, bool propagateDown) override
void	addComponent (Alignable *component) final
void	addSurfaceDeformation (const SurfaceDeformation *deformation, bool propagateDown) override
	AlignableComposite (align::ID id, StructureType aType, const RotationType &rot=RotationType())
StructureType	alignableObjectId () const override
	Return the alignable type identifier. More...
const Alignables &	components () const override
	Return vector of direct components. More...
void	dump () const override
	Recursive printout of alignable structure. More...
void	move (const GlobalVector &displacement) override
	Move with respect to the global reference frame. More...
virtual void	moveComponentLocal (const int i, const LocalVector &localDisplacement)
	Move a single component with respect to the local reference frame. More...
virtual void	moveComponentsLocal (const LocalVector &localDisplacement)
	Move with respect to the local reference frame. More...
void	recursiveComponents (Alignables &result) const override
	Provide all components, subcomponents etc. (cf. description in base class) More...
void	rotateInGlobalFrame (const RotationType &rotation) override
	Rotation interpreted in global reference frame. More...
void	setSurfaceDeformation (const SurfaceDeformation *deformation, bool propagateDown) override
	Set the surface deformation parameters - if (!propagateDown) do not affect daughters. More...
int	surfaceDeformationIdPairs (std::vector< std::pair< int, SurfaceDeformation * > > &) const override
	Return surface deformations. More...
void	update (align::ID, StructureType aType, const RotationType &rot=RotationType())
	~AlignableComposite () override
	deleting its components More...
Public Member Functions inherited from Alignable
	Alignable (align::ID, const AlignableSurface &)
	Alignable (align::ID, const RotationType &)
AlignmentParameters *	alignmentParameters () const
	Get the AlignmentParameters. More...
virtual void	cacheTransformation ()
	cache the current position, rotation and other parameters (e.g. surface deformations), also for possible components More...
virtual void	cacheTransformation (const align::RunNumber &)
virtual CompConstraintType	compConstraintType () const
	Return the alignable type of contraints wrt. its components. More...
const Alignables &	deepComponents () const
const GlobalVector &	displacement () const
	Return change of the global position since the creation of the object. More...
bool	firstCompsWithParams (Alignables &paramComps) const
const DetId &	geomDetId () const
const PositionType &	globalPosition () const
	Return the global position of the object. More...
const RotationType &	globalRotation () const
	Return the global orientation of the object. More...
align::ID	id () const
	Return the ID of Alignable, i.e. DetId of 'first' component GeomDet(Unit). More...
bool	lastCompsWithParams (Alignables &paramComps) const
Alignable *	mother () const
	Return pointer to container alignable (if any) More...
virtual void	recenterSurface ()
	Recenter surface object without moving possible components. More...
virtual void	restoreCachedTransformation ()
	restore the previously cached transformation, also for possible components More...
virtual void	restoreCachedTransformation (const align::RunNumber &)
virtual void	rotateAroundGlobalAxis (const GlobalVector &axis, Scalar radians)
	Rotation around arbitratry global axis. More...
virtual void	rotateAroundGlobalX (Scalar radians)
	Rotation around global x-axis. More...
virtual void	rotateAroundGlobalY (Scalar radians)
	Rotation around global y-axis. More...
virtual void	rotateAroundGlobalZ (Scalar radians)
	Rotation around global z-axis. More...
virtual void	rotateAroundLocalAxis (const LocalVector &axis, Scalar radians)
	Rotation around arbitratry local axis. More...
virtual void	rotateAroundLocalX (Scalar radians)
	Rotation around local x-axis. More...
virtual void	rotateAroundLocalY (Scalar radians)
	Rotation around local y-axis. More...
virtual void	rotateAroundLocalZ (Scalar radians)
	Rotation around local z-axis. More...
virtual void	rotateInLocalFrame (const RotationType &rotation)
	Rotation intepreted in the local reference frame. More...
const RotationType &	rotation () const
	Return change of orientation since the creation of the object. More...
void	setAlignmentParameters (AlignmentParameters *dap)
	Set the AlignmentParameters. More...
void	setMother (Alignable *mother)
	Assign mother to alignable. More...
void	setSurvey (const SurveyDet *)
	Set survey info. More...
int	size () const
	Return number of direct components. More...
const AlignableSurface &	surface () const
	Return the Surface (global position and orientation) of the object. More...
AlignmentSurfaceDeformations *	surfaceDeformations () const
	Return surface deformations, sorted by DetId. More...
const SurveyDet *	survey () const
	Return survey info. More...
void	update (align::ID, const AlignableSurface &)
virtual	~Alignable ()
	Destructor. More...

Private Attributes
AlignmentPositionError *	theAlignmentPositionError

Additional Inherited Members
Public Types inherited from Alignable
typedef align::Alignables	Alignables
enum	CompConstraintType { CompConstraintType::NONE, CompConstraintType::POSITION, CompConstraintType::POSITION_Z }
typedef align::GlobalVector	GlobalVector
typedef align::LocalVector	LocalVector
typedef align::PositionType	PositionType
typedef align::RotationType	RotationType
typedef align::Scalar	Scalar
typedef align::StructureType	StructureType
Protected Types inherited from Alignable
template<class T >
using	Cache = std::map< align::RunNumber, T >
Protected Member Functions inherited from AlignableComposite
	AlignableComposite (const GeomDet *geomDet)
	Constructor from GeomDet, only for use in AlignableDet. More...
void	setSurface (const AlignableSurface &s)
void	update (const GeomDet *geomDet)
template<class T >
void	update (T)=delete
Protected Member Functions inherited from Alignable
void	addDisplacement (const GlobalVector &displacement)
void	addRotation (const RotationType &rotation)
virtual void	updateMother (const GlobalVector &shift)
Protected Attributes inherited from AlignableComposite
StructureType	theStructureType
Protected Attributes inherited from Alignable
CompConstraintType	compConstraintType_ {CompConstraintType::NONE}
Cache< GlobalVector >	displacementsCache_
Cache< RotationType >	rotationsCache_
Cache< AlignableSurface >	surfacesCache_
GlobalVector	theCachedDisplacement
RotationType	theCachedRotation
AlignableSurface	theCachedSurface
Alignables	theDeepComponents
DetId	theDetId
GlobalVector	theDisplacement
align::ID	theId
RotationType	theRotation
AlignableSurface	theSurface

Detailed Description

An AlignableComposite corresponding to a composite GeomDet direct components are AlignableDetUnits or AlignableDets.

Definition at line 8 of file AlignableDet.h.

Constructor & Destructor Documentation

AlignableDet()

AlignableDet::AlignableDet	(	const GeomDet *	geomDet,
		bool	addComponents = true
	)

Constructor: If addComponents = true, creates components for geomDet's components, assuming they are GeomDetUnits

Definition at line 14 of file AlignableDet.cc.

    : AlignableComposite(geomDet), theAlignmentPositionError(nullptr) {
  // ensure that the surface is not constrained to the average position of the
  // components:
  compConstraintType_ = Alignable::CompConstraintType::NONE;
 
  if (geomDet->alignmentPositionError()) {
    // false: do not propagate APE to (anyway not yet existing) daughters
    this->setAlignmentPositionError(*(geomDet->alignmentPositionError()), false);
  }
 
  if (addComponents) {
    if (geomDet->components().empty()) {  // Is a DetUnit
      throw cms::Exception("BadHierarchy") << "[AlignableDet] GeomDet with DetId " << geomDet->geographicalId().rawId()
                                           << " has no components, use AlignableDetUnit.\n";
    } else {  // Push back all components
      const std::vector<const GeomDet*>& geomDets = geomDet->components();
      for (std::vector<const GeomDet*>::const_iterator idet = geomDets.begin(); idet != geomDets.end(); ++idet) {
        const GeomDetUnit* unit = dynamic_cast<const GeomDetUnit*>(*idet);
        if (!unit) {
          throw cms::Exception("BadHierarchy")
              << "[AlignableDet] component not GeomDetUnit, call with addComponents==false"
              << " and build hierarchy yourself.\n";  // e.g. AlignableDTChamber
        }
        this->addComponent(new AlignableDetUnit(unit));
      }
    }
    // Ensure that the surface is not screwed up by addComponent, it must stay the GeomDet's one:
    theSurface = AlignableSurface(geomDet->surface());
  }  // end addComponents
}

References AlignableComposite::addComponent(), align::AlignableDetUnit, GeomDet::alignmentPositionError(), Alignable::compConstraintType_, GeomDet::components(), Exception, GeomDet::geographicalId(), Alignable::NONE, DetId::rawId(), setAlignmentPositionError(), GeomDet::surface(), Alignable::theSurface, and unit().

~AlignableDet()

AlignableDet::~AlignableDet ( )

override

Destructor.

Definition at line 47 of file AlignableDet.cc.

{ delete theAlignmentPositionError; }

References theAlignmentPositionError.

Member Function Documentation

addAlignmentPositionError()

void AlignableDet::addAlignmentPositionError ( const AlignmentPositionError &  ape, bool  propagateDown  )

overridevirtual

Add (or set if it does not exist yet) the AlignmentPositionError, if (propagateDown), add also to all components

Reimplemented from AlignableComposite.

Definition at line 108 of file AlignableDet.cc.

                                                                                                  {
  if (!theAlignmentPositionError) {
    theAlignmentPositionError = new AlignmentPositionError(ape);
  } else {
    *theAlignmentPositionError += ape;
  }
 
  this->AlignableComposite::addAlignmentPositionError(ape, propagateDown);
}

References AlignableComposite::addAlignmentPositionError(), and theAlignmentPositionError.

Referenced by addAlignmentPositionErrorFromRotation().

addAlignmentPositionErrorFromRotation()

void AlignableDet::addAlignmentPositionErrorFromRotation ( const RotationType &  rot, bool  propagateDown  )

overridevirtual

Add (or set if it does not exist yet) the AlignmentPositionError resulting from a rotation in the global reference frame, if (propagateDown), add also to all components

Reimplemented from AlignableComposite.

Definition at line 119 of file AlignableDet.cc.

                                                                                                    {
  // average error calculated by movement of a local point at
  // (xWidth/2,yLength/2,0) caused by the rotation rot
  GlobalVector localPositionVector =
      surface().toGlobal(LocalVector(.5 * surface().width(), .5 * surface().length(), 0.));
 
  const LocalVector::BasicVectorType& lpvgf = localPositionVector.basicVector();
  GlobalVector gv(rot.multiplyInverse(lpvgf) - lpvgf);
 
  AlignmentPositionError ape(gv.x(), gv.y(), gv.z());
  this->addAlignmentPositionError(ape, propagateDown);
 
  this->AlignableComposite::addAlignmentPositionErrorFromRotation(rot, propagateDown);
}

References addAlignmentPositionError(), AlignableComposite::addAlignmentPositionErrorFromRotation(), PV3DBase< T, PVType, FrameType >::basicVector(), makeMuonMisalignmentScenario::rot, Alignable::surface(), AlignableSurface::toGlobal(), and ApeEstimator_cff::width.

alignmentErrors()

AlignmentErrorsExtended * AlignableDet::alignmentErrors ( void  ) const

overridevirtual

Return vector of alignment errors.

Reimplemented from AlignableComposite.

Definition at line 159 of file AlignableDet.cc.

                                                                 {
  AlignmentErrorsExtended* m_alignmentErrors = new AlignmentErrorsExtended();
 
  // Add associated alignment position error
  uint32_t detId = this->geomDetId().rawId();
  CLHEP::HepSymMatrix clhepSymMatrix(6, 0);
  if (theAlignmentPositionError)  // Might not be set
    clhepSymMatrix = asHepMatrix(theAlignmentPositionError->globalError().matrix());
  AlignTransformErrorExtended transformError(clhepSymMatrix, detId);
  m_alignmentErrors->m_alignError.push_back(transformError);
 
  // Add those from components
  AlignmentErrorsExtended* compAlignmentErrs = this->AlignableComposite::alignmentErrors();
  std::copy(compAlignmentErrs->m_alignError.begin(),
            compAlignmentErrs->m_alignError.end(),
            std::back_inserter(m_alignmentErrors->m_alignError));
  delete compAlignmentErrs;
 
  return m_alignmentErrors;
}

References AlignableComposite::alignmentErrors(), asHepMatrix(), filterCSVwithJSON::copy, Alignable::geomDetId(), AlignmentPositionError::globalError(), AlignmentErrorsExtended::m_alignError, GlobalErrorBaseExtended< T, ErrorWeightType >::matrix(), DetId::rawId(), and theAlignmentPositionError.

alignmentPositionError()

const AlignmentPositionError* AlignableDet::alignmentPositionError ( ) const

inline

alignment position error - for checking only, otherwise use alignmentErrors() above!

Definition at line 44 of file AlignableDet.h.

{ return theAlignmentPositionError; }

References theAlignmentPositionError.

Referenced by AlignableDetOrUnitPtr::alignmentPositionError().

alignments()

Alignments * AlignableDet::alignments ( void  ) const

overridevirtual

Return vector of alignment data.

Reimplemented from AlignableComposite.

Reimplemented in AlignableSiStripDet.

Definition at line 135 of file AlignableDet.cc.

                                           {
  Alignments* m_alignments = new Alignments();
  RotationType rot(this->globalRotation());
 
  // Get position, rotation, detId
  CLHEP::Hep3Vector clhepVector(globalPosition().x(), globalPosition().y(), globalPosition().z());
  CLHEP::HepRotation clhepRotation(
      CLHEP::HepRep3x3(rot.xx(), rot.xy(), rot.xz(), rot.yx(), rot.yy(), rot.yz(), rot.zx(), rot.zy(), rot.zz()));
  uint32_t detId = this->geomDetId().rawId();
 
  AlignTransform transform(clhepVector, clhepRotation, detId);
 
  // Add to alignments container
  m_alignments->m_align.push_back(transform);
 
  // Add those from components
  Alignments* compAlignments = this->AlignableComposite::alignments();
  std::copy(compAlignments->m_align.begin(), compAlignments->m_align.end(), std::back_inserter(m_alignments->m_align));
  delete compAlignments;
 
  return m_alignments;
}

References AlignableComposite::alignments(), filterCSVwithJSON::copy, Alignable::geomDetId(), Alignable::globalPosition(), Alignable::globalRotation(), Alignments::m_align, DetId::rawId(), makeMuonMisalignmentScenario::rot, HcalDetIdTransform::transform(), x, y, and z.

Referenced by AlignableSiStripDet::alignments().

setAlignmentPositionError()

void AlignableDet::setAlignmentPositionError ( const AlignmentPositionError &  ape, bool  propagateDown  )

overridevirtual

Set the AlignmentPositionError and, if (propagateDown), to all components.

Reimplemented from AlignableComposite.

Definition at line 98 of file AlignableDet.cc.

                                                                                                  {
  if (!theAlignmentPositionError)
    theAlignmentPositionError = new AlignmentPositionError(ape);
  else
    *theAlignmentPositionError = ape;
 
  this->AlignableComposite::setAlignmentPositionError(ape, propagateDown);
}

References AlignableComposite::setAlignmentPositionError(), and theAlignmentPositionError.

Referenced by AlignableDet(), and update().

update()

void AlignableDet::update	(	const GeomDet *	geomDet,
		bool	updateComponents = true
	)

Updater from GeomDet The given GeomDet id has to match the current id.

Definition at line 50 of file AlignableDet.cc.

                                                                       {
  AlignableComposite::update(geomDet);
 
  if (geomDet->alignmentPositionError()) {
    // false: do not propagate APE to daughters (done by their update functions)
    this->setAlignmentPositionError(*(geomDet->alignmentPositionError()), false);
  }
 
  if (updateComponents) {
    if (geomDet->components().empty()) {  // Is a DetUnit
      throw cms::Exception("BadHierarchy") << "[AlignableDet] GeomDet with DetId " << geomDet->geographicalId().rawId()
                                           << " has no components, use AlignableDetUnit.\n";
    } else {  // Push back all components
      const auto& geomDets = geomDet->components();
      for (const auto& idet : geomDets) {
        auto unit = dynamic_cast<const GeomDetUnit*>(idet);
        if (!unit) {
          throw cms::Exception("BadHierarchy") << "[AlignableDet] component not GeomDetUnit, call with "
                                               << "updateComponents==false and build hierarchy yourself.\n";
          // -> e.g. AlignableDTChamber
        }
 
        const auto components = this->components();
        auto comp = std::find_if(components.begin(), components.end(), [&unit](const auto& c) {
          return c->id() == unit->geographicalId().rawId();
        });
 
        if (comp != components.end()) {
          auto aliDetUnit = dynamic_cast<AlignableDetUnit*>(*comp);
          if (aliDetUnit) {
            aliDetUnit->update(unit);
          } else {
            throw cms::Exception("LogicError") << "[AlignableDet::update] cast to 'AlignableDetUnit*' failed "
                                               << "while it should not\n";
          }
        } else {
          throw cms::Exception("GeometryMismatch")
              << "[AlignableDet::update] GeomDet with DetId " << unit->geographicalId().rawId()
              << " not found in current geometry.\n";
        }
      }
    }
    // Ensure that the surface is not screwed up by update of components, it must stay the GeomDet's one:
    theSurface = AlignableSurface(geomDet->surface());
  }  // end updateComponents
}

References GeomDet::alignmentPositionError(), c, AlCaHLTBitMon_QueryRunRegistry::comp, AlignableComposite::components(), GeomDet::components(), Exception, GeomDet::geographicalId(), DetId::rawId(), setAlignmentPositionError(), GeomDet::surface(), Alignable::theSurface, unit(), and AlignableComposite::update().

Referenced by progressbar.ProgressBar::__next__(), MatrixUtil.Matrix::__setitem__(), MatrixUtil.Steps::__setitem__(), dqm-mbProfile.Profile::finish(), progressbar.ProgressBar::finish(), MatrixUtil.Steps::overwrite(), AlignableGEMSuperChamber::update(), AlignableGEMChamber::update(), and AlignableCSCChamber::update().

Member Data Documentation

theAlignmentPositionError

AlignmentPositionError* AlignableDet::theAlignmentPositionError

private

Definition at line 47 of file AlignableDet.h.

Referenced by addAlignmentPositionError(), alignmentErrors(), alignmentPositionError(), setAlignmentPositionError(), and ~AlignableDet().