ElementModel.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2022 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef MUONNSWASBUILT_ELEMENTMODEL_H
#define MUONNSWASBUILT_ELEMENTMODEL_H
 
#include <vector>
#include "GeoPrimitives/GeoPrimitives.h"
 
namespace NswAsBuilt {

  class ElementModel {
    public:
      using ipar_t = unsigned int;
      using VectorSet = Eigen::Matrix<double, 3, Eigen::Dynamic, Eigen::ColMajor|Eigen::AutoAlign, 3, 5>;
      using VectorSetRef = Eigen::Ref<VectorSet>;
      virtual ~ElementModel() = default;
 
     /* The ParameterVector: a wrapper around a std::vector<double> containing
      * the actual model parameters.
      * In addition, this struct may save the cache-able rigid component of the
      * transformation represented by the parameter vector */
      struct ParameterVector {
        std::vector<double> parameters{};
        Eigen::Affine3d transformCache{Eigen::Affine3d::Identity()};
        bool transformCacheValid{false};
 
        // Contructed: provide the number of parameters
        ParameterVector(size_t npars) : parameters(npars, 0.0) {}
 
        // accessors
        double operator[] (size_t ipar) const { return parameters.at(ipar); }
        double& operator[] (size_t ipar) { return parameters.at(ipar); }
      };
 
     /* The number of parameters used */
      virtual int nParameters() const = 0;
 
     /* Transform a set of vectors expressed in local frame, stored in a matrix */
      virtual void transform(const ParameterVector& parvec, VectorSetRef local) const = 0;
 
     /* Cache the rigid component of this deformation model */
      virtual void cacheTransform(ParameterVector& parvec) const = 0;
 
     /* Helper methods to convert parameter index to string representation */
      virtual ipar_t getParameterIndex(const std::string& parname) const = 0;
      virtual std::string getParameterName(ipar_t ipar) const = 0;
  };
}
 
#endif