Vertex.h

Go to the documentation of this file.

//
// \file  lardataobj/RecoBase/Vertex.h
// \brief Definition of vertex object for LArSoft
//
// \author brebel@fnal.gov
//

#ifndef RB_VERTEX_H
#define RB_VERTEX_H

#include <iosfwd>

#include "larcoreobj/SimpleTypesAndConstants/PhysicalConstants.h"
#include "lardataobj/RecoBase/TrackingTypes.h"

namespace recob {

  class Vertex {

  public:
    using Point_t = tracking::Point_t;
    using SMatrixSym33 = tracking::SMatrixSym33;
    using SMatrixSym22 = tracking::SMatrixSym22;
    using SVector3 = tracking::SVector3;
    using SVector2 = tracking::SVector2;

    enum Status { Invalid, Valid, ValidWithCovariance };

    Vertex();

    explicit Vertex(double* xyz, int id = util::kBogusI);

    Vertex(const Point_t& pos,
           const SMatrixSym33& cov,
           double chi2,
           int ndof,
           int id = util::kBogusI)
      : pos_(pos), cov_(cov), chi2_(chi2), ndof_(ndof), status_(ValidWithCovariance), id_(id)
    {}

    const Point_t& position() const { return pos_; }
    const SMatrixSym33& covariance() const { return cov_; }
    // Return vertex fit chi2.
    double chi2() const { return chi2_; }
    // Return vertex fit ndof.
    int ndof() const { return ndof_; }
    // Return vertex fit chi2 per ndof.
    double chi2PerNdof() const { return (ndof_ > 0. ? chi2_ / ndof_ : util::kBogusD); }
    //
    // Return vertex status.
    Status status() const { return status_; }
    bool isValid() const { return status_ >= Valid; }
    bool isValidCovariance() const { return status_ >= ValidWithCovariance; }

    void XYZ(double* xyz) const;

    int ID() const;

    void setID(int newID) { id_ = newID; }

    friend bool operator<(const Vertex& a, const Vertex& b);
    friend std::ostream& operator<<(std::ostream& o, const Vertex& a);

  private:
    Point_t pos_;      
    SMatrixSym33 cov_; 
    double chi2_;      
    int ndof_;         
    Status status_;    
    int id_;           
  };
}

inline int recob::Vertex::ID() const
{
  return id_;
}

#endif // RB_VERTEX_H