packages/globalvertex/GlobalVertex.h

0001 // Tell emacs that this is a C++ source
0002 //  -*- C++ -*-.
0003 #ifndef GLOBALVERTEX_GLOBALVERTEX_H
0004 #define GLOBALVERTEX_GLOBALVERTEX_H
0005
0006 #include "Vertex.h"
0007
0008 #include <phool/PHObject.h>
0009
0010 #include <iostream>
0011 #include <limits>
0012 #include <map>
0013
0014 class GlobalVertex : public PHObject
0015 {
0016  public:
0017   // the order matters (best vertex -> highest number), so leave some space in case we want to wedge other vertices in here
0018   enum VTXTYPE
0019   {
0020     UNDEFINED = 0,
0021     TRUTH = 100,
0022     SMEARED = 200,
0023     MBD = 300,
0024     SVTX = 400,
0025     SVTX_MBD = 500
0026   };
0027
0028   typedef std::vector<const Vertex*> VertexVector;
0029   typedef std::map<GlobalVertex::VTXTYPE, VertexVector>::const_iterator ConstVertexIter;
0030   typedef std::map<GlobalVertex::VTXTYPE, VertexVector>::iterator VertexIter;
0031
0032   // Deprecated as of GlobalVertexv2
0033   typedef std::map<GlobalVertex::VTXTYPE, unsigned int>::const_iterator ConstVtxIter;
0034   typedef std::map<GlobalVertex::VTXTYPE, unsigned int>::iterator VtxIter;
0035
0036   ~GlobalVertex() override = default;
0037
0038   // PHObject virtual overloads
0039
0040   void identify(std::ostream& os = std::cout) const override
0041   {
0042     os << "GlobalVertex base class" << std::endl;
0043   }
0044   int isValid() const override { return 0; }
0045   PHObject* CloneMe() const override { return nullptr; }
0046
0047   // vertex info
0048
0049   virtual unsigned int get_id() const { return std::numeric_limits<unsigned int>::max(); }
0050   virtual void set_id(unsigned int) { return; }
0051
0052   virtual float get_t() const { return std::numeric_limits<float>::quiet_NaN(); }
0053   virtual void set_t(float) { return; }
0054
0055   virtual float get_t_err() const { return std::numeric_limits<float>::quiet_NaN(); }
0056   virtual void set_t_err(float) { return; }
0057
0058   virtual float get_x() const { return std::numeric_limits<float>::quiet_NaN(); }
0059   virtual void set_x(float) { return; }
0060
0061   virtual float get_y() const { return std::numeric_limits<float>::quiet_NaN(); }
0062   virtual void set_y(float) { return; }
0063
0064   virtual float get_z() const { return std::numeric_limits<float>::quiet_NaN(); }
0065   virtual void set_z(float) { return; }
0066
0067   virtual float get_chisq() const { return std::numeric_limits<float>::quiet_NaN(); }
0068   virtual void set_chisq(float) { return; }
0069
0070   virtual unsigned int get_ndof() const { return std::numeric_limits<unsigned int>::max(); }
0071   virtual void set_ndof(unsigned int) { return; }
0072
0073   virtual float get_position(unsigned int /*coor*/) const { return std::numeric_limits<float>::quiet_NaN(); }
0074   virtual void set_position(unsigned int /*coor*/, float /*xi*/) { return; }
0075
0076   virtual float get_error(unsigned int /*i*/, unsigned int /*j*/) const { return std::numeric_limits<float>::quiet_NaN(); }
0077   virtual void set_error(unsigned int /*i*/, unsigned int /*j*/, float /*value*/) { return; }
0078
0079   virtual unsigned int get_beam_crossing() const { return std::numeric_limits<unsigned int>::max(); }
0080   virtual void set_beam_crossing(unsigned int) { return; }
0081
0082   virtual bool empty_vtxs() const { return true; }
0083   virtual size_t size_vtxs() const { return 0; }
0084   virtual size_t count_vtxs(VTXTYPE) const { return 0; }
0085   virtual void clear_vtxs() { return; }
0086   virtual void insert_vtx(VTXTYPE, const Vertex*) { return; }
0087   virtual void clone_insert_vtx(VTXTYPE, const Vertex*) { return; }
0088   virtual size_t erase_vtxs(VTXTYPE) { return 0; }
0089   virtual void erase_vtxs(VertexIter) { return; }
0090
0091   virtual ConstVertexIter begin_vertexes() const;
0092   virtual ConstVertexIter find_vertexes(VTXTYPE type) const;
0093   virtual ConstVertexIter end_vertexes() const;
0094
0095   virtual VertexIter begin_vertexes();
0096   virtual VertexIter find_vertexes(VTXTYPE type);
0097   virtual VertexIter end_vertexes();
0098
0099   //
0100   // associated vertex ids methods
0101   // vtx id container accessors are deprecated.
0102   // Use actual vertex container accessors instead
0103   //
0104   virtual bool empty_vtxids() const { return true; }
0105   virtual size_t size_vtxids() const { return 0; }
0106   virtual size_t count_vtxids(VTXTYPE /*type*/) const { return 0; }
0107
0108   virtual void clear_vtxids() { return; }
0109   virtual void insert_vtxids(VTXTYPE /*type*/, unsigned int /*vtxid*/) { return; }
0110   virtual size_t erase_vtxids(VTXTYPE /*type*/) { return 0; }
0111   virtual void erase_vtxids(VtxIter /*iter*/) { return; }
0112   virtual void erase_vtxids(VtxIter /*first*/, VtxIter /*last*/) { return; }
0113
0114   virtual ConstVtxIter begin_vtxids() const;
0115   virtual ConstVtxIter find_vtxids(VTXTYPE type) const;
0116   virtual ConstVtxIter end_vtxids() const;
0117
0118   virtual VtxIter begin_vtxids();
0119   virtual VtxIter find_vtxids(VTXTYPE type);
0120   virtual VtxIter end_vtxids();
0121
0122  protected:
0123   GlobalVertex() = default;
0124
0125  private:
0126   ClassDefOverride(GlobalVertex, 1);
0127 };
0128
0129 #endif