JCOMPASS Namespace Reference

Auxiliary classes and methods for orientation calibration based on compasses. More...

Classes
struct	JQuaternion
	Quaternion. More...
struct	JOrientation
	Orientation of module. More...
struct	JHead
	Compass event header. More...
struct	JEvt
	Compass single fit. More...
struct	JHit
	Hit. More...
struct	JModel
	Model. More...
struct	JChi2
	Auxiliary data structure for chi2 evaluation. More...
struct	JNOAAFunction1D_t
	Auxiliary base class for interpolation of magnetic declination data obtained from website of NOAA. More...
struct	JARCAMagneticDeclination
	Interpolation of magnetic declination data at ARCA site. More...
struct	JORCAMagneticDeclination
	Interpolation of magnetic declination data at ORCA site. More...
struct	JZEROMagneticDeclination
	Fall back class for zero magnetic declination. More...
struct	JPolicy
	Auxiliary class to define policy for invalid modules. More...

Functions
JQuaternion3D	getQuaternion (const JQuaternion &Q)
	Get quaternion. More...
JQuaternion	getQuaternion (const JQuaternion3D &Q)
	Get quaternion. More...
JModel	getModel (const JEvt &evt)
	Get model. More...
JEvt	getEvt (const JHead &header, const JModel &model)
	Get event. More...
JTreeParameters	getTreeParameters (const JType< JOrientation > &type)
JTreeParameters	getTreeParameters (const JType< JEvt > &type)

Variables
static const double	ORCA_MERIDIAN_CONVERGENCE_ANGLE_DEG = -2.022225934803321
	Meridian convergence angle - angle between Geodesic North and UTM "northing". More...
static const double	ARCA_MERIDIAN_CONVERGENCE_ANGLE_DEG = 0.5773961143251137
	ARCA meridian convergence angle [deg]. More...
static const double	ORCA_MERIDIAN_CONVERGENCE_ANGLE_RAD = ORCA_MERIDIAN_CONVERGENCE_ANGLE_DEG * JMATH::PI / 180.0
	ORCA meridian convergence angle [rad]. More...
static const double	ARCA_MERIDIAN_CONVERGENCE_ANGLE_RAD = ARCA_MERIDIAN_CONVERGENCE_ANGLE_DEG * JMATH::PI / 180.0
	ARCA meridian convergence angle [rad]. More...
static JARCAMagneticDeclination	getARCAMagneticDeclination
	Function object for magnetic declination at ARCA site. More...
static JORCAMagneticDeclination	getORCAMagneticDeclination
	Function object for magnetic declination at ORCA site. More...
static JZEROMagneticDeclination	getZEROMagneticDeclination
	Function object for zero magnetic declination. More...

Detailed Description

Auxiliary classes and methods for orientation calibration based on compasses.

Author

mdejong

Function Documentation

JQuaternion3D JCOMPASS::getQuaternion ( const JQuaternion &  Q )

inline

Get quaternion.

Parameters

Q	quaternion

Returns

quaternion

Definition at line 27 of file JCompass/JEvtToolkit.hh.

  {
    return JQuaternion3D(Q.a, Q.b, Q.c, Q.d);
  }

JQuaternion JCOMPASS::getQuaternion ( const JQuaternion3D &  Q )

inline

Get quaternion.

Parameters

Q	quaternion

Returns

quaternion

Definition at line 39 of file JCompass/JEvtToolkit.hh.

  {
    return JQuaternion(Q.getA(), Q.getB(), Q.getC(), Q.getD());
  }

JModel JCOMPASS::getModel ( const JEvt &  evt )

inline

Get model.

Parameters

evt

event

Returns

model

Definition at line 51 of file JCompass/JEvtToolkit.hh.

  {
    JModel model;

    if (evt.size() >= 2) {
      model.Q0 = getQuaternion(evt[0]);
      model.Q1 = getQuaternion(evt[1]);
    }

    return model;
  }

JEvt JCOMPASS::getEvt ( const JHead &  header, const JModel &  model  )

inline

Get event.

Parameters

header	header
model	model

Returns

event

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

  {
    JEvt evt(header);

    evt.push_back(getQuaternion(model.Q0));
    evt.push_back(getQuaternion(model.Q1));

    return evt;
  }

JTreeParameters JCOMPASS::getTreeParameters ( const JType< JOrientation > &  type )

inline

Parameters

type

data type

Returns

TTree parameters

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

  {
    return JTreeParameters("ORIENTATION", "orientation", "",  2, 65536, 2);
  }

JTreeParameters JCOMPASS::getTreeParameters ( const JType< JEvt > &  type )

inline

Parameters

type

data type

Returns

TTree parameters

Definition at line 41 of file JCompass/JSupport.hh.

  {
    return JTreeParameters("COMPASS", "compass", "",  2, 65536, 2);
  }

Variable Documentation

const double JCOMPASS::ORCA_MERIDIAN_CONVERGENCE_ANGLE_DEG = -2.022225934803321

static

Meridian convergence angle - angle between Geodesic North and UTM "northing".

ORCA meridian convergence angle [deg]

Definition at line 22 of file JCompassSupportkit.hh.

const double JCOMPASS::ARCA_MERIDIAN_CONVERGENCE_ANGLE_DEG = 0.5773961143251137

static

ARCA meridian convergence angle [deg].

Definition at line 23 of file JCompassSupportkit.hh.

const double JCOMPASS::ORCA_MERIDIAN_CONVERGENCE_ANGLE_RAD = ORCA_MERIDIAN_CONVERGENCE_ANGLE_DEG * JMATH::PI / 180.0

static

ORCA meridian convergence angle [rad].

Definition at line 25 of file JCompassSupportkit.hh.

const double JCOMPASS::ARCA_MERIDIAN_CONVERGENCE_ANGLE_RAD = ARCA_MERIDIAN_CONVERGENCE_ANGLE_DEG * JMATH::PI / 180.0

static

ARCA meridian convergence angle [rad].

Definition at line 26 of file JCompassSupportkit.hh.

JARCAMagneticDeclination JCOMPASS::getARCAMagneticDeclination

static

Function object for magnetic declination at ARCA site.

Definition at line 730 of file JNOAA.hh.

JORCAMagneticDeclination JCOMPASS::getORCAMagneticDeclination

static

Function object for magnetic declination at ORCA site.

Definition at line 731 of file JNOAA.hh.

JZEROMagneticDeclination JCOMPASS::getZEROMagneticDeclination

static

Function object for zero magnetic declination.

Definition at line 732 of file JNOAA.hh.