/* This file is part of MAUS: http://micewww.pp.rl.ac.uk:8080/projects/maus
 *
 * MAUS is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * MAUS is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with MAUS.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef _SRC_COMMON_CPP_DATASTRUCTURE_SCIFITRACKPOINT_HH_
#define _SRC_COMMON_CPP_DATASTRUCTURE_SCIFITRACKPOINT_HH_

// C headers
#include <assert.h>
#include <iostream>
#include <cmath>

// C++ headers
#include <string>
#include <vector>
#include "TMath.h"
#include "TMatrixD.h"

// ROOT headers
#include "TObject.h"
#include "TRef.h"

#include "src/common_cpp/Utils/VersionNumber.hh"
#include "src/common_cpp/DataStructure/SciFiCluster.hh"
#include "src/common_cpp/DataStructure/ThreeVector.hh"

namespace MAUS {

class SciFiTrackPoint : public TObject {
 public:
  /** @brief  Constructor.
   */
  SciFiTrackPoint();

  /** @brief  Destructor.
   */
  virtual ~SciFiTrackPoint();

  /** @brief  Copy constructor.
   */
  SciFiTrackPoint(const SciFiTrackPoint &site);

  /** @brief  Assignment operator.
   */
  SciFiTrackPoint& operator=(const SciFiTrackPoint& site);

  /** @brief  Sets spill number.
   */
  void set_spill(int spill)                     { _spill = spill; }

  /** @brief  Sets event number.
   */
  void set_event(int event)                     { _event = event; }

  /** @brief  Sets tracker number.
   */
  void set_tracker(int tracker)                 { _tracker = tracker; }

  /** @brief  Sets station number.
   */
  void set_station(int station)                 { _station = station; }

  /** @brief  Sets plane number.
   */
  void set_plane(int plane)                     { _plane = plane; }

  /** @brief  Sets channel number.
   */
  void set_channel(double channel)              { _channel = channel; }

  /** @brief  Sets the filtered chi2 for this track point.
   */
  void set_chi2(double chi2)                    { _chi2 = chi2; }

  /** @brief  Sets the x coordinate.
   */
  void set_pos(ThreeVector pos)                 { _pos = pos; }

  /** @brief  Sets the x momentum component.
   */
  void set_mom(ThreeVector mom)                 { _mom  = mom; }

  /** @brief  Sets the x momentum component.
   */
  void set_gradient(ThreeVector grad)           { _gradient  = grad; }

  /** @brief Sets the ThreeVector of position errors
   */
  void set_pos_error(ThreeVector err)           { _errors_pos = err; }

  /** @brief Sets the ThreeVector of momentum errors
   */
  void set_mom_error(ThreeVector err)           { _errors_mom = err; }

  /** @brief Sets the ThreeVector of gradient errors
   */
  void set_gradient_error(ThreeVector err)      { _errors_gradient = err; }

  /** @brief  Sets the covariance matrix.
   */
  void set_covariance(std::vector<double> covariance)     { _covariance = covariance; }

  /** @brief  Sets the errors vector.
   */
  void set_errors(std::vector<double> errors)   { _errors = errors; }

  /** @brief  Sets pull (residual of the projected state).
   */
  void set_pull(double pull)                    { _pull = pull; }

  /** @brief  Sets residual for the filtered state.
   */
  void set_residual(double residual)            { _residual = residual; }

  /** @brief  Sets residual for the smoothed state.
   */
  void set_smoothed_residual(double s_residual) { _smoothed_residual = s_residual; }

  /** @brief Set to true if a cluster was present
   */
  void set_has_data(bool has_data) { _has_data = has_data; }


  /** @brief  Returns the tracker number.
   */
  int tracker()                    const { return _tracker; }

  /** @brief  Returns the station number.
   */
  int station()                     const { return _station; }

  /** @brief  Returns the plane number.
   */
  int plane()                       const { return _plane; }

  /** @brief  Returns the channel number.
   */
  double channel()                  const { return _channel; }

  /** @brief  Returns filtered chi2 value.
   */
  double chi2()                     const { return _chi2; }

  /** @brief  Returns the position threevector.
   */
  ThreeVector pos()                 const { return _pos; }

  /** @brief  Returns the momentum threevector.
   */
  ThreeVector mom()                 const { return _mom; }

  /** @brief  Returns the momentum in a threevector.
   */
  ThreeVector gradient()   const { return _gradient; }

  /** @brief Returns a ThreeVector of position errors
   */
  ThreeVector pos_error()  const { return _errors_pos; }

  /** @brief Returns a ThreeVector of momentum errors
   */
  ThreeVector mom_error()  const { return _errors_mom; }

  /** @brief Returns a ThreeVector of gradient errors
   */
  ThreeVector gradient_error()  const { return _errors_gradient; }

  /** @brief  Returns the covariance matrix.
   */
  std::vector<double> covariance()   const { return _covariance; }

  /** @brief  Returns the covariance matrix.
   *  LEGACY FUNCTION - DO NOT USE
   */
  std::vector<double> errors()       const { return _errors; }

  /** @brief  Returns the residual of the projected state.
   */
  double pull()                      const { return _pull; }

  /** @brief  Returns the residual of the filtered state.
   */
  double residual()                  const { return _residual; }

  /** @brief  Returns the residual of the smoothed state.
   */
  double smoothed_residual()         const { return _smoothed_residual; }

  /** @brief  Returns the spill number.
   */
  int spill()                        const { return _spill; }

  /** @brief  Returns the event number.
   */
  int event()                        const { return _event; }

  /** @brief Returns true ig a cluster was present
   */
  bool has_data()                    const { return _has_data; }

 private:
  /** @brief The number of the spill the trackpoint belongs to.
   */
  int _spill;

  /** @brief The number of the event the trackpoint belongs to.
   */
  int _event;

  /** @brief The tracker the trackpoint belongs to.
   */
  int _tracker;

  /** @brief The station the trackpoint belongs to.
   */
  int _station;

  /** @brief The plane the trackpoint belongs to.
   */
  int _plane;

  /** @brief The channel measurement corresponding to the trackpoint.
   */
  double _channel;

  /** @brief filtered chi2
   */
  double _chi2;

  /** @brief position
   */
  ThreeVector _pos;

  /** @brief momentum
   */
  ThreeVector _mom;

  /** @brief gradient
   */
  ThreeVector _gradient;

  /** @brief position error
   */
  ThreeVector _errors_pos;

  /** @brief momentum error
   */
  ThreeVector _errors_mom;

  /** @brief gradient error
   */
  ThreeVector _errors_gradient;

  /** @brief Covariance matrix for the state vector [x, px, y, py, pz]
   */
  std::vector<double> _covariance;

  /** @brief Errors vector for the state vector [x, px, y, py, pz]
   *  
   *  LEGACY FUNCTION - Do Not Use!
   */
  std::vector<double> _errors;

  /** @brief projected residual
   */
  double _pull;

  /** @brief filtered residual
   */
  double _residual;

  /** @brief smoothed residual
   */
  double _smoothed_residual;

  /** @brief record if a cluster was present
   */
  bool _has_data;

  MAUS_VERSIONED_CLASS_DEF(SciFiTrackPoint)
};

typedef std::vector<SciFiTrackPoint*> SciFiTrackPointPArray;

} // ~namespace MAUS

#endif