MutableTrajectory.h

Go to the documentation of this file.

// AUTOMATICALLY GENERATED FILE - DO NOT EDIT
 
#ifndef EICD_MutableTrajectory_H
#define EICD_MutableTrajectory_H
 
#include "eicd/TrajectoryObj.h"
// Make the immutable class available from its mutable version but not vice versa
#include "eicd/Trajectory.h"
 
#include "eicd/TrackerHit.h"
#include "podio/RelationRange.h"
#include <cstdint>
#include <vector>
#include "podio/ObjectID.h"
#include <ostream>
 
#ifdef PODIO_JSON_OUTPUT
#include "nlohmann/json.hpp"
#endif
 
// forward declarations
namespace eicd {
class TrackParameters;
class MutableTrackParameters;
}
 
 
namespace eicd {
 
 
/** @class MutableTrajectory
 *  Raw trajectory from the tracking algorithm
 *  @author: S. Joosten, S. Li
 */
class MutableTrajectory {
 
  friend class TrajectoryCollection;
  friend class TrajectoryMutableCollectionIterator;
  friend class Trajectory;
 
public:
 
  /// default constructor
  MutableTrajectory();
  MutableTrajectory(std::uint32_t type, std::uint32_t nStates, std::uint32_t nMeasurements, std::uint32_t nOutliers, std::uint32_t nHoles, float chi2, std::uint32_t ndf, std::uint32_t nSharedHits);
 
  /// constructor from existing TrajectoryObj
  MutableTrajectory(TrajectoryObj* obj);
 
  /// copy constructor
  MutableTrajectory(const MutableTrajectory& other);
 
  /// copy-assignment operator
  MutableTrajectory& operator=(MutableTrajectory other);
 
  /// create a mutable deep-copy of the object with identical relations
  MutableTrajectory clone() const;
 
  /// destructor
  ~MutableTrajectory();
 
  /// conversion to const object
  operator Trajectory() const;
 
public:
 
  /// Access the 0 (does not have good track fit), 1 (has good track fit)
  const std::uint32_t& getType() const;
 
  /// Access the Number of tracking steps
  const std::uint32_t& getNStates() const;
 
  /// Access the Number of hits used
  const std::uint32_t& getNMeasurements() const;
 
  /// Access the Number of hits not considered
  const std::uint32_t& getNOutliers() const;
 
  /// Access the Number of missing hits
  const std::uint32_t& getNHoles() const;
 
  /// Access the Total chi2
  const float& getChi2() const;
 
  /// Access the Number of degrees of freedom
  const std::uint32_t& getNdf() const;
 
  /// Access the Number of shared hits with other trajectories
  const std::uint32_t& getNSharedHits() const;
 
 
  /// Access the Associated track parameters, if any
  const eicd::TrackParameters getTrackParameters() const;
 
  /// Set the 0 (does not have good track fit), 1 (has good track fit)
  void setType(std::uint32_t value);
 
  /// Set the Number of tracking steps
  void setNStates(std::uint32_t value);
 
  /// Set the Number of hits used
  void setNMeasurements(std::uint32_t value);
 
  /// Set the Number of hits not considered
  void setNOutliers(std::uint32_t value);
 
  /// Set the Number of missing hits
  void setNHoles(std::uint32_t value);
 
  /// Set the Total chi2
  void setChi2(float value);
 
  /// Set the Number of degrees of freedom
  void setNdf(std::uint32_t value);
 
  /// Set the Number of shared hits with other trajectories
  void setNSharedHits(std::uint32_t value);
 
 
  /// Set the Associated track parameters, if any
  void setTrackParameters(eicd::TrackParameters value);
 
  void addToMeasurementHits(eicd::TrackerHit);
  unsigned int measurementHits_size() const;
  eicd::TrackerHit getMeasurementHits(unsigned int) const;
  std::vector<eicd::TrackerHit>::const_iterator measurementHits_begin() const;
  std::vector<eicd::TrackerHit>::const_iterator measurementHits_end() const;
  podio::RelationRange<eicd::TrackerHit> getMeasurementHits() const;
  void addToOutlierHits(eicd::TrackerHit);
  unsigned int outlierHits_size() const;
  eicd::TrackerHit getOutlierHits(unsigned int) const;
  std::vector<eicd::TrackerHit>::const_iterator outlierHits_begin() const;
  std::vector<eicd::TrackerHit>::const_iterator outlierHits_end() const;
  podio::RelationRange<eicd::TrackerHit> getOutlierHits() const;
  void addToMeasurementChi2(float);
  unsigned int measurementChi2_size() const;
  float getMeasurementChi2(unsigned int) const;
  std::vector<float>::const_iterator measurementChi2_begin() const;
  std::vector<float>::const_iterator measurementChi2_end() const;
  podio::RelationRange<float> getMeasurementChi2() const;
  void addToOutlierChi2(float);
  unsigned int outlierChi2_size() const;
  float getOutlierChi2(unsigned int) const;
  std::vector<float>::const_iterator outlierChi2_begin() const;
  std::vector<float>::const_iterator outlierChi2_end() const;
  podio::RelationRange<float> getOutlierChi2() const;
 
 
 
  /// check whether the object is actually available
  bool isAvailable() const;
  /// disconnect from TrajectoryObj instance
  void unlink() { m_obj = nullptr; }
 
  bool operator==(const MutableTrajectory& other) const { return m_obj == other.m_obj; }
  bool operator==(const Trajectory& other) const;
 
  // less comparison operator, so that objects can be e.g. stored in sets.
  bool operator<(const MutableTrajectory& other) const { return m_obj < other.m_obj; }
 
  unsigned int id() const { return getObjectID().collectionID * 10000000 + getObjectID().index; }
 
  const podio::ObjectID getObjectID() const;
 
  friend void swap(MutableTrajectory& a, MutableTrajectory& b) {
    using std::swap;
    swap(a.m_obj, b.m_obj); // swap out the internal pointers
  }
 
private:
  TrajectoryObj* m_obj;
};
 
#ifdef PODIO_JSON_OUTPUT
void to_json(nlohmann::json& j, const MutableTrajectory& value);
#endif
 
 
} // namespace eicd
 
 
#endif