NswAsBuilt::Element Class Reference

Element: a node in a hierarchy of alignment frames. More...

#include <Element.h>

Collaboration diagram for NswAsBuilt::Element:

Public Types
enum class	ParameterClass { NOMINAL , CORRECTION }
using	ParameterVector = ElementModel::ParameterVector
using	ipar_t = ElementModel::ipar_t
using	daughterVec_t = std::vector<std::unique_ptr<Element>>
using	VectorSetRef = ElementModel::VectorSetRef

Public Member Functions
	Element (std::unique_ptr< ElementModel > deformationModel)
	Element ()=delete
	Element (const Element &)=delete
Element &	operator= (const Element &)=delete
double	getParameter (ParameterClass iclass, ipar_t ipar) const
void	setParameter (ParameterClass iclass, ipar_t ipar, double value)
void	setParametersFromMap (ParameterClass iclass, const std::map< std::string, double > &values)
void	transform (ParameterClass iclass, const VectorSetRef &local) const
void	transformToFrame (ParameterClass iclass, const VectorSetRef &local, const Element *frame) const
void	cacheTransforms ()
void	setAsapId (const std::string &asapId)
const std::string &	asapId () const
Element *	addDaughter (std::unique_ptr< Element > daughter)
const Element *	mother () const
Element *	mother ()
void	traverseTree (const std::function< void(Element &)> &callback)

Private Member Functions
ParameterVector &	parameterVector (ParameterClass iclass)
const ParameterVector &	parameterVector (ParameterClass iclass) const

Private Attributes
std::unique_ptr< ElementModel >	m_deformationModel
ParameterVector	m_nominalPar
ParameterVector	m_correctedPar
daughterVec_t	m_daughters
Element *	m_mother {nullptr}
std::string	m_asapId {""}

Detailed Description

Element: a node in a hierarchy of alignment frames.

The class Element is the building block for chaining alignment transformations in various coordinate systems.

Each Element has attached to it a local coordinate system. The transformation of a point in local coordinates from this Element frame to the higher-level coordinate system is achieved with the method transform. The transform method applies rigid transformation (rotations, translation) and possibly deformations.

The Elements are organized in a tree structure, representing the hierarchy of coordinate systems. Traversal of the tree may be achieved using the mother and daughter pointers, or with the method traverseTree, which applies the user-provided function to all the daughers and grand-daughters of this Element.

In this context, it is interesting to call the transform methods iteratively on all the mothers. This is achieved by the method transformToFrame.

The transformation method is handled by an external class ElementModel, which, by sub-classing, provides the deformation model of this Element. The ElementModel must be set in the constructor.

The ElementModel is parameterized by an array of model parameters, whose meaning is known only to the used ElementModel implementation. The model parameters are members of this class, and are provided in two forms: the NOMINAL parameters (meant to represent the nominal geometry), and the CORRECTION parameters (meant to represent the actually measured parameters). The choice of one or the other of the two forms is possible using the ParameterClass argument of the transform method.

Definition at line 52 of file Element.h.

Member Typedef Documentation

daughterVec_t

using NswAsBuilt::Element::daughterVec_t = std::vector<std::unique_ptr<Element>>

Definition at line 56 of file Element.h.

ipar_t

using NswAsBuilt::Element::ipar_t = ElementModel::ipar_t

Definition at line 55 of file Element.h.

ParameterVector

using NswAsBuilt::Element::ParameterVector = ElementModel::ParameterVector

Definition at line 54 of file Element.h.

VectorSetRef

using NswAsBuilt::Element::VectorSetRef = ElementModel::VectorSetRef

Definition at line 57 of file Element.h.

Member Enumeration Documentation

ParameterClass

enum class NswAsBuilt::Element::ParameterClass

strong

Enumerator
NOMINAL
CORRECTION

Definition at line 63 of file Element.h.

                                {
        NOMINAL,
        CORRECTION
      };

Constructor & Destructor Documentation

Element() [1/3]

Element::Element

(

std::unique_ptr< ElementModel >

deformationModel

)

Definition at line 11 of file Element.cxx.

: m_deformationModel(std::move(deformationModel))
,  m_nominalPar(m_deformationModel->nParameters())
,  m_correctedPar(m_deformationModel->nParameters())
{ }

Element() [2/3]

NswAsBuilt::Element::Element ( )

delete

Element() [3/3]

NswAsBuilt::Element::Element ( const Element & )

delete

Member Function Documentation

addDaughter()

Element * Element::addDaughter

(

std::unique_ptr< Element >

daughter

)

Definition at line 92 of file Element.cxx.

{
  if (daughter->m_mother) {
    throw std::runtime_error("Element has a defined mother already");
  }
  daughter->m_mother = this;
  m_daughters.push_back(std::move(daughter));
  return m_daughters.back().get();
}

asapId()

const std::string & NswAsBuilt::Element::asapId ( ) const

inline

Definition at line 94 of file Element.h.

{ return m_asapId; }

cacheTransforms()

void Element::cacheTransforms

(

)

Definition at line 51 of file Element.cxx.

{
  m_deformationModel->cacheTransform(m_correctedPar);
  m_deformationModel->cacheTransform(m_nominalPar);
}

getParameter()

double Element::getParameter	(	ParameterClass	iclass,
		ipar_t	ipar ) const

Definition at line 59 of file Element.cxx.

{
  const auto& parvec = parameterVector(iclass).parameters;
  if (ipar>=parvec.size()) {
    throw std::runtime_error("Element::getParameter: Parameter exceeds parvec size "+std::to_string(ipar));
  }
  return parvec[ipar];
}

mother() [1/2]

Element * NswAsBuilt::Element::mother ( )

inline

Definition at line 99 of file Element.h.

{ return m_mother; }

mother() [2/2]

const Element * NswAsBuilt::Element::mother ( ) const

inline

Definition at line 98 of file Element.h.

{ return m_mother; }

operator=()

Element & NswAsBuilt::Element::operator= ( const Element & )

delete

parameterVector() [1/2]

Element::ParameterVector & Element::parameterVector ( ParameterClass iclass )

private

Definition at line 19 of file Element.cxx.

{
  return (iclass == ParameterClass::CORRECTION) ? m_correctedPar : m_nominalPar;
}

parameterVector() [2/2]

const Element::ParameterVector & Element::parameterVector ( ParameterClass iclass ) const

private

Definition at line 26 of file Element.cxx.

{
  return (iclass == ParameterClass::CORRECTION) ? m_correctedPar : m_nominalPar;
}

setAsapId()

void NswAsBuilt::Element::setAsapId ( const std::string & asapId )

inline

Definition at line 93 of file Element.h.

{ m_asapId = asapId; }

setParameter()

void Element::setParameter	(	ParameterClass	iclass,
		ipar_t	ipar,
		double	value )

Definition at line 70 of file Element.cxx.

{
  auto& parvec = parameterVector(iclass).parameters;
  if (ipar>=parvec.size()) {
    throw std::runtime_error("Element::setParameter: Parameter exceeds parvec size "+std::to_string(ipar));
  }
  parvec[ipar] = value;
  parameterVector(iclass).transformCacheValid = false;
}

setParametersFromMap()

void Element::setParametersFromMap	(	ParameterClass	iclass,
		const std::map< std::string, double > &	values )

Definition at line 82 of file Element.cxx.

{
  for (const auto& p : values) {
    setParameter(iclass, m_deformationModel->getParameterIndex(p.first), p.second);
  }
  m_deformationModel->cacheTransform(parameterVector(iclass));
}

transform()

void Element::transform	(	ParameterClass	iclass,
		const VectorSetRef &	local ) const

Definition at line 33 of file Element.cxx.

{
  m_deformationModel->transform(parameterVector(iclass), local);
}

transformToFrame()

void Element::transformToFrame	(	ParameterClass	iclass,
		const VectorSetRef &	local,
		const Element *	frame ) const

Definition at line 40 of file Element.cxx.

{
  const Element* el = this;
  while ((el!=nullptr) && (el!=frame)) {
    el->transform(iclass, local);
    el = el->m_mother;
  }
}

traverseTree()

void Element::traverseTree

(

const std::function< void(Element &)> &

callback

)

Definition at line 104 of file Element.cxx.

{
  struct tree_t {
    using iter = daughterVec_t::iterator;
    tree_t(iter it_, iter end_):
      it{it_},end{end_}{}
    iter it;
    iter end;
  };
  std::list<tree_t> dtree;
  callback(*this);
  dtree.emplace_back(m_daughters.begin(), m_daughters.end());
  while (!dtree.empty()) {
    auto& it = dtree.back().it;
    if (it != dtree.back().end) {
      Element& el = **it;
      callback(el);
      dtree.emplace_back(el.m_daughters.begin(), el.m_daughters.end());
      ++it;
    } else {
      dtree.pop_back();
    }
  }
}

Member Data Documentation

m_asapId

std::string NswAsBuilt::Element::m_asapId {""}

private

Definition at line 118 of file Element.h.

{""};           // Optional string identifier (imported from ASAP)

m_correctedPar

ParameterVector NswAsBuilt::Element::m_correctedPar

private

Definition at line 113 of file Element.h.

m_daughters

daughterVec_t NswAsBuilt::Element::m_daughters

private

Definition at line 115 of file Element.h.

m_deformationModel

std::unique_ptr<ElementModel> NswAsBuilt::Element::m_deformationModel

private

Definition at line 111 of file Element.h.

m_mother

Element* NswAsBuilt::Element::m_mother {nullptr}

private

Definition at line 116 of file Element.h.

{nullptr};    // The mother Element

m_nominalPar

ParameterVector NswAsBuilt::Element::m_nominalPar

private

Definition at line 112 of file Element.h.

---

The documentation for this class was generated from the following files:

• Element.h
• Element.cxx