AlignableComposite.cc

Go to the documentation of this file.

#include <memory>

// Framework
#include "FWCore/Utilities/interface/Exception.h"
#include "FWCore/MessageLogger/interface/MessageLogger.h"

#include "CondFormats/Alignment/interface/Alignments.h"
#include "CondFormats/Alignment/interface/AlignmentErrorsExtended.h"
#include "DataFormats/TrackingRecHit/interface/AlignmentPositionError.h"
#include "Geometry/CommonDetUnit/interface/GeomDet.h"

#include "Alignment/CommonAlignment/interface/AlignableComposite.h"


//__________________________________________________________________________________________________
AlignableComposite::AlignableComposite( const GeomDet* geomDet ) : 
  Alignable( geomDet->geographicalId().rawId(), geomDet->surface() ),
  theStructureType(align::AlignableDet)
{
  compConstraintType_ = Alignable::CompConstraintType::POSITION;
}

//__________________________________________________________________________________________________
AlignableComposite::AlignableComposite(align::ID id,
                       StructureType type,
                       const RotationType& rot):
  Alignable(id, rot),
  theStructureType(type)
{
  compConstraintType_ = Alignable::CompConstraintType::POSITION;
}

//__________________________________________________________________________________________________
AlignableComposite::~AlignableComposite()
{
  for (unsigned int i = 0; i < theComponents.size(); ++i) delete theComponents[i];
}

//__________________________________________________________________________________________________
void AlignableComposite::update(const GeomDet* geomDet)
{
  if (!geomDet) {
    throw cms::Exception("Alignment")
      << "@SUB=AlignableComposite::update\n"
      << "Trying to update with GeomDet* pointing to 'nullptr'.";
  }

  Alignable::update(geomDet->geographicalId().rawId(), geomDet->surface());
}

//__________________________________________________________________________________________________
void AlignableComposite::update(align::ID id,
                                StructureType type,
                                const RotationType& rot)
{
  if (theStructureType != type) {
    throw cms::Exception("Alignment")
      << "@SUB=AlignableComposite::update\n"
      << "Current alignable type does not match type of the update.";
  }
  // composite's position is already updated by components, i.e. it needs to be kept
  Alignable::update(id, AlignableSurface{this->globalPosition(), rot});
}

//__________________________________________________________________________________________________
void AlignableComposite::addComponent(Alignable* ali)
{
  const auto& newComps = ali->deepComponents();

  theDeepComponents.insert( theDeepComponents.end(), newComps.begin(), newComps.end() );

  Scalar k = static_cast<Scalar>( newComps.size() ) / theDeepComponents.size();

  theSurface.move( ( ali->globalPosition() - globalPosition() ) * k );

  ali->setMother(this);
  theComponents.push_back(ali);
}

//__________________________________________________________________________________________________
void AlignableComposite::recursiveComponents(Alignables &result) const
{

  const auto& components = this->components();
  if (this->alignableObjectId() == align::AlignableDet 
      && components.size() <= 1) { // Non-glued AlignableDets (still) contain themselves
    return; // (would be better to implement AlignableDet::recursiveComponents!)
  }
  for (const auto& iter: components) {
    result.push_back(iter); // could use std::copy(..), but here we build a real hierarchy
    iter->recursiveComponents(result);
  }
}

//__________________________________________________________________________________________________
void AlignableComposite::move( const GlobalVector& displacement ) 
{
  
  // Move components
  for (const auto& i: this->components()) i->move(displacement);

  // Move surface
  this->addDisplacement( displacement );
  theSurface.move( displacement );

}


//__________________________________________________________________________________________________
void AlignableComposite::moveComponentsLocal( const LocalVector& localDisplacement )
{

  this->move( this->surface().toGlobal(localDisplacement) );

}

//__________________________________________________________________________________________________
void AlignableComposite::moveComponentLocal( const int i, const LocalVector& localDisplacement )
{

  if (i >= size() ) 
    throw cms::Exception("LogicError")
      << "AlignableComposite index (" << i << ") out of range";

  const auto& comp = this->components();
  comp[i]->move( this->surface().toGlobal( localDisplacement ) );

}


//__________________________________________________________________________________________________
void AlignableComposite::rotateInGlobalFrame( const RotationType& rotation )
{
  
  const auto& comp = this->components();
  
  PositionType myPosition = this->globalPosition();
  
  for (const auto& i: comp)
    {
      
      // It is much simpler to calculate the local position given in coordinates 
      // of the GLOBAL frame and then just apply the rotation matrix given in the 
      // GLOBAL frame as well. ONLY this is somewhat tricky... as Teddy's frames 
      // don't like this kind of mixing...
      
      // Rotations are defined for "Basic3DVector" types, without any FrameTAG,
      // because Rotations usually switch between different frames. You get
      // this by using the method .basicVector()
    
      // localPosition = globalPosition (Component) - globalPosition(Composite)
      // moveVector = rotated localPosition  - original localposition
      // LocalVector localPositionVector = (**i).globalPosition()-myPosition;
    
    
      // Local Position given in coordinates of the GLOBAL Frame
      const GlobalVector localPositionVector = i->globalPosition() - myPosition;
      const GlobalVector::BasicVectorType& lpvgf = localPositionVector.basicVector();

      // rotate with GLOBAL rotation matrix  and subtract => moveVector in 
      // global Coordinates
      // apparently... you have to use the inverse of the rotation here
      // (rotate the VECTOR rather than the frame) 
      GlobalVector moveVector( rotation.multiplyInverse(lpvgf) - lpvgf );
    
    
      i->move(moveVector);
      i->rotateInGlobalFrame(rotation);

    }

  this->addRotation( rotation );
  
  theSurface.rotate( rotation );

}


//__________________________________________________________________________________________________
void AlignableComposite::setAlignmentPositionError( const AlignmentPositionError& ape,
                            bool propagateDown )
{

  // Since no geomDet is attached, alignable composites do not have an APE
  // The APE is, therefore, just propagated down
  if (!propagateDown) return;

  for (const auto& i: this->components()) {
    i->setAlignmentPositionError(ape, propagateDown);
  }
}


//__________________________________________________________________________________________________
void 
AlignableComposite::addAlignmentPositionError( const AlignmentPositionError& ape,
                           bool propagateDown )
{

  // Since no geomDet is attached, alignable composites do not have an APE
  // The APE is, therefore, just propagated down
  if (!propagateDown) return;

  for (const auto& i: this->components()) {
    i->addAlignmentPositionError(ape, propagateDown);
  }
}


//__________________________________________________________________________________________________
void AlignableComposite::addAlignmentPositionErrorFromRotation( const RotationType& rotation,
                                bool propagateDown )
{
  if (!propagateDown) return;

  PositionType myPosition=this->globalPosition();

  for (const auto& i: this->components()) {
      // It is just similar to to the "movement" that results to the components
      // when the composite is rotated. 
      // Local Position given in coordinates of the GLOBAL Frame
      const GlobalVector localPositionVector = i->globalPosition()-myPosition;
      const GlobalVector::BasicVectorType& lpvgf = localPositionVector.basicVector();

      // rotate with GLOBAL rotation matrix  and subtract => moveVector in global coordinates
      // apparently... you have to use the inverse of the rotation here
      // (rotate the VECTOR rather than the frame) 
      GlobalVector moveVector( rotation.multiplyInverse(lpvgf) - lpvgf );    
      
      AlignmentPositionError ape( moveVector.x(), moveVector.y(), moveVector.z() );
      i->addAlignmentPositionError( ape, propagateDown );
      i->addAlignmentPositionErrorFromRotation( rotation, propagateDown );
    }
}


//__________________________________________________________________________________________________
void AlignableComposite::addAlignmentPositionErrorFromLocalRotation( const RotationType& rot,
                                     bool propagateDown )
{
  // if (!propagateDown) return; // No! Cannot yet jump out since
  // addAlignmentPositionErrorFromRotation(..) below might be overwritten in derived
  // classes to do something on 'this' (and in fact does so in AlignableDet).

  RotationType globalRot = globalRotation().multiplyInverse(rot*globalRotation());
  this->addAlignmentPositionErrorFromRotation(globalRot, propagateDown);

}

//__________________________________________________________________________________________________
void AlignableComposite::setSurfaceDeformation(const SurfaceDeformation *deformation,
                           bool propagateDown)
{
  // Only DetUnits have surface deformations.
  // The parameters are, therefore, just propagated down.
  if (!propagateDown) return;

  for (const auto& i: this->components()) {
    i->setSurfaceDeformation(deformation, propagateDown);
  }
}

//__________________________________________________________________________________________________
void AlignableComposite::addSurfaceDeformation(const SurfaceDeformation *deformation,
                           bool propagateDown)
{
  // Only DetUnits have surface deformations.
  // The parameters are, therefore, just propagated down.
  if (!propagateDown) return;

  for (const auto& i: this->components()) {
    i->addSurfaceDeformation(deformation, propagateDown);
  }
}

//__________________________________________________________________________________________________
void AlignableComposite::dump( void ) const
{

  // A simple printout method. Could be specialized in the implementation classes.

  const auto& comp = this->components();

  // Dump this
  edm::LogInfo("AlignableDump") 
    << " Alignable of type " << this->alignableObjectId() 
    << " has " << comp.size() << " components" << std::endl
    << " position = " << this->globalPosition() << ", orientation:" << std::endl
    << this->globalRotation();

  // Dump components
  for (const auto& i: comp) i->dump();
}



//__________________________________________________________________________________________________
Alignments* AlignableComposite::alignments( void ) const
{
  // Recursively call alignments, until we get to an AlignableDetUnit

  Alignments* m_alignments = new Alignments();

  // Add components recursively
  for (const auto& i: this->components()) {
    std::unique_ptr<Alignments> tmpAlignments{i->alignments()};
    std::copy(tmpAlignments->m_align.begin(), tmpAlignments->m_align.end(), 
              std::back_inserter(m_alignments->m_align));
  }
  
  return m_alignments;
}


//__________________________________________________________________________________________________
AlignmentErrorsExtended* AlignableComposite::alignmentErrors( void ) const
{
  // Recursively call alignmentsErrors, until we get to an AlignableDetUnit

  AlignmentErrorsExtended* m_alignmentErrors = new AlignmentErrorsExtended();

  // Add components recursively
  for (const auto& i: this->components()) {
    std::unique_ptr<AlignmentErrorsExtended> tmpAlignmentErrorsExtended{i->alignmentErrors()};
    std::copy(tmpAlignmentErrorsExtended->m_alignError.begin(), tmpAlignmentErrorsExtended->m_alignError.end(), 
               std::back_inserter(m_alignmentErrors->m_alignError));
    }

  return m_alignmentErrors;
}


//__________________________________________________________________________________________________
int AlignableComposite::surfaceDeformationIdPairs(std::vector<std::pair<int,SurfaceDeformation*> > & result) const
{
  int count = 0;

  // Add components recursively
  for (const auto& i: this->components()) {
    count += i->surfaceDeformationIdPairs(result);
  }
  
  return count;
}