JCompass/JHit.hh

Go to the documentation of this file.

#ifndef __JCOMPASS_JHIT__
#define __JCOMPASS_JHIT__

#include "JLang/JObjectID.hh"
#include "JGeometry3D/JQuaternion3D.hh"

/**
 * \author mdejong
 */
namespace JCOMPASS {}
namespace JPP { using namespace JCOMPASS; }

namespace JCOMPASS {

  using JLANG::JObjectID;
  using JGEOMETRY3D::JQuaternion3D;


  /**
   * %Hit.
   */
  struct JHit :
    public JObjectID,
    public JQuaternion3D 
  {
    /**
     * Default constructor.
     */
    JHit() :
      JObjectID(),
      JQuaternion3D(),
      z(0.0),
      sigma(0.0)
    {}


    /**
     * Constructor.
     *
     * \param id              identifier
     * \param z               z-position
     * \param Q               quaternion
     * \param sigma           resolution [deg]
     */
    JHit(const int            id,
         const double         z, 
         const JQuaternion3D& Q,
         const double         sigma) :
      JObjectID(id),
      JQuaternion3D(Q),
      z(z),
      sigma(sigma)
    {}


    /**
     * Get z-position.
     *
     * \return                z-position
     */
    double getZ() const
    {
      return z;
    }


    /**
     * Get resolution.
     *
     * \return                sigma
     */
    double getSigma() const
    {
      return sigma;
    }

  protected:
    double z;
    double sigma;
  };
}

#endif