JCOMPASS::JModel Struct Reference

Model. More...

#include <JModel.hh>

Inheritance diagram for JCOMPASS::JModel:

Public Member Functions
	JModel ()
	Default constructor. More...
	JModel (const JQuaternion3D &Q0, const JQuaternion3D &Q1)
	Constructor. More...
template<class T >
	JModel (T __begin, T __end)
	Constructor. More...
JModel &	add (const JModel &model)
	Add model. More...
JModel &	sub (const JModel &model)
	Subtract model. More...
JModel &	mul (const double factor)
	Scale model. More...
JQuaternion3D	operator() (const double z) const
	Get quaternion at given z-position. More...
JFirst_t &	mul (const JSecond_t &object)
	Multiply with object. More...

Public Attributes
JQuaternion3D	Q0
	tilt More...
JQuaternion3D	Q1
	twist More...

Static Public Attributes
static const int	NUMBER_OF_PARAMETERS = 4
	number of parameters of fit per quaternion More...

Detailed Description

Model.

Definition at line 32 of file JCompass/JModel.hh.

Constructor & Destructor Documentation

JModel() [1/3]

JCOMPASS::JModel::JModel ( )

inline

Default constructor.

Definition at line 38 of file JCompass/JModel.hh.

             :
      Q0(JQuaternion3D::getIdentity()),
      Q1(JQuaternion3D::getIdentity())
    {}

JModel() [2/3]

JCOMPASS::JModel::JModel ( const JQuaternion3D &  Q0, const JQuaternion3D &  Q1  )

inline

Constructor.

Parameters

Q0	tilt
Q1	twist

Definition at line 50 of file JCompass/JModel.hh.

                                    :
      Q0(Q0),
      Q1(Q1)
    {}

JModel() [3/3]

template<class T >

JCOMPASS::JModel::JModel ( T  __begin, T  __end  )

inline

Constructor.

The data type corresponding to the hits should provide for the following policy methods.

   double        getZ();             // get z-position
   JQuaternion3D getQuaternion();    // get quaternion

Note that the input data should be ordered with increasing z-positions.

Parameters

__begin	begin of data
__end	end of data

Definition at line 71 of file JCompass/JModel.hh.

                    :
      Q0(JQuaternion3D::getIdentity()),
      Q1(JQuaternion3D::getIdentity())
    {
      using namespace std;
      using namespace JPP;
 
      const int N = distance(__begin, __end);
 
      if (N >= NUMBER_OF_PARAMETERS) {
 
        vector<JQuaternion3D> buffer;
 
        for (T q = __begin, p = q++; q != __end; ++p, ++q) {
 
          const double dz = q->getZ() - p->getZ();
 
          if (dz != 0.0) {
 
            JQuaternion3D Q(p->getQuaternion());
 
            Q.conjugate();
            Q.mul(q->getQuaternion());
            Q.pow(1.0 / dz);
 
            buffer.push_back(Q);
          }
        }
 
        Q1  = getAverage(buffer.begin(), buffer.end());
        Q1  = JQuaternion3D::decomposition(Q1, JVector3Z_t).twist;
 
        const double z1 = getAverage(make_array(__begin, __end, &JHit::getZ));
 
        Q0  = getAverage(make_array(__begin, __end, &JHit::getQuaternion));
        Q0  = pow(Q1, -z1) * Q0;
 
      } else {
        throw JValueOutOfRange("JModel: Not enough data points.");
      }
    }

Member Function Documentation

add()

JModel& JCOMPASS::JModel::add ( const JModel &  model )

inline

Add model.

Parameters

model

model

Returns

this model

Definition at line 121 of file JCompass/JModel.hh.

    {
      Q0 *= model.Q0;
      Q1 *= model.Q1;
 
      Q0.normalise();
      Q1.normalise();
 
      return *this;
    }

sub()

JModel& JCOMPASS::JModel::sub ( const JModel &  model )

inline

Subtract model.

Parameters

model

model

Returns

this model

Definition at line 139 of file JCompass/JModel.hh.

    {
      Q0 *= model.Q0.getConjugate();
      Q1 *= model.Q1.getConjugate();
 
      Q0.normalise();
      Q1.normalise();
 
      return *this;
    }

mul() [1/2]

JModel& JCOMPASS::JModel::mul ( const double  factor )

inline

Scale model.

Parameters

factor

multiplication factor

Returns

this model

Definition at line 157 of file JCompass/JModel.hh.

    {
      Q0.pow(factor);
      Q1.pow(factor);
 
      return *this;
    }

operator()()

JQuaternion3D JCOMPASS::JModel::operator() ( const double  z ) const

inline

Get quaternion at given z-position.

Parameters

z	z-position.

Returns

quaternion

Definition at line 172 of file JCompass/JModel.hh.

    {
      using namespace JPP;
 
      return pow(Q1, z) * Q0;
    }

mul() [2/2]

template<class JFirst_t , class JSecond_t >

JFirst_t& JMATH::JMath< JFirst_t, JSecond_t >::mul ( const JSecond_t &  object )

inlineinherited

Multiply with object.

Parameters

object

object

Returns

result object

Definition at line 354 of file JMath.hh.

    {
      return static_cast<JFirst_t&>(*this) = JFirst_t().mul(static_cast<const JFirst_t&>(*this), object);
    }

Member Data Documentation

NUMBER_OF_PARAMETERS

const int JCOMPASS::JModel::NUMBER_OF_PARAMETERS = 4

static

number of parameters of fit per quaternion

Definition at line 179 of file JCompass/JModel.hh.

Q0

JQuaternion3D JCOMPASS::JModel::Q0

tilt

Definition at line 181 of file JCompass/JModel.hh.

Q1

JQuaternion3D JCOMPASS::JModel::Q1

twist

Definition at line 182 of file JCompass/JModel.hh.

---

The documentation for this struct was generated from the following file:

• JCompass/JModel.hh