PmaNode3D.h

Go to the documentation of this file.

/**
 *  @file   PmaNode3D.h
 *
 *  @author D.Stefan and R.Sulej
 *
 *  @brief  Implementation of the Projection Matching Algorithm
 *
 *          3D track node. See PmaTrack3D.h file for details.
 */

#ifndef PmaNode3D_h
#define PmaNode3D_h

#include "larreco/RecoAlg/PMAlg/PmaElement3D.h"
#include "larreco/RecoAlg/PMAlg/SortedObjects.h"
#include "larreco/RecoAlg/PMAlg/Utilities.h"
namespace detinfo {
  class DetectorPropertiesData;
}

#include "TVector2.h"
#include "TVector3.h"

#include <vector>

namespace geo {
  class TPCGeo;
}

namespace pma {
  class Node3D;
}

class pma::Node3D final : public pma::Element3D, public pma::SortedBranchBase {
public:
  Node3D();
  Node3D(detinfo::DetectorPropertiesData const& detProp,
         const TVector3& p3d,
         unsigned int tpc,
         unsigned int cryo,
         bool vtx = false,
         double xshift = 0);

  TVector3 const&
  Point3D() const
  {
    return fPoint3D;
  }

  /// Returns true if the new position was accepted; returns false if the new position
  /// was trimmed to fit insite TPC volume + fMargin.
  bool SetPoint3D(const TVector3& p3d);

  TVector2 const&
  Projection2D(unsigned int view) const
  {
    return fProj2D[view];
  }

  double GetDistToWall() const;

  /// Check if p3d is in the same TPC as the node.
  bool SameTPC(const TVector3& p3d, float margin = 0.0F) const;
  bool SameTPC(const pma::Vector3D& p3d, float margin = 0.0F) const;

  /// Belongs to more than one track?
  bool IsBranching() const;

  /// Is the first/last in this TPC?
  bool IsTPCEdge() const;

  /// Check fIsVertex flag.
  bool
  IsVertex() const
  {
    return fIsVertex;
  }
  void
  SetVertex(bool state)
  {
    fIsVertex = state;
  }
  void
  SetVertexToBranching(bool setAllNodes)
  {
    if (setAllNodes || !fIsVertex) fIsVertex = IsBranching();
  }

  std::vector<pma::Track3D*> GetBranches() const;

  /// Distance [cm] from the 3D point to the point 3D.
  double GetDistance2To(const TVector3& p3d) const override;

  /// Distance [cm] from the 2D point to the object's 2D projection in one of
  /// wire views.
  double GetDistance2To(const TVector2& p2d, unsigned int view) const override;

  /// Get 3D direction cosines of the next segment, or pevious segment if this
  /// is the last node.
  pma::Vector3D GetDirection3D() const override;

  /// In case of a node it is simply 3D position of the node.
  TVector3
  GetUnconstrainedProj3D(const TVector2& p2d, unsigned int view) const override
  {
    return fPoint3D;
  }

  /// Set hit 3D position and its 2D projection to the vertex.
  void SetProjection(pma::Hit3D& h) const override;

  /// Squared sum of half-lengths of connected 3D segments
  /// (used in the vertex position optimization).
  double Length2() const override;

  /// Cosine of 3D angle between connected segments.
  double SegmentCos() const;
  /// Cosine of 2D angle (in plane parallel to wire planes) between connected
  /// segments. Should be changed / generalized for horizontal wire planes (e.g.
  /// 2-phase LAr).
  double SegmentCosWirePlane() const;
  /// Cosine of 2D angle (in horizontal plane, parallel to drift) between
  /// connected segments. Should be changed / generalized for horizontal wire
  /// planes (e.g. 2-phase LAr).
  double SegmentCosTransverse() const;

  /// Objective function minimized during oprimization.
  double GetObjFunction(float penaltyValue, float endSegWeight) const;

  /// Optimize vertex 3D position with given penalty on connected
  /// segments angle and weight assigned to the outermost segments.
  /// Only MSE is used in case of branching nodes.
  void Optimize(float penaltyValue, float endSegWeight);

  void ClearAssigned(pma::Track3D* trk = 0) override;

  void
  ApplyDriftShift(double dx)
  {
    fPoint3D[0] += dx;
    fDriftOffset += dx;
  }
  double
  GetDriftShift() const
  {
    return fDriftOffset;
  }

  /// Set allowed node position margin around TPC.
  static void
  SetMargin(double m)
  {
    if (m >= 0.0) fMargin = m;
  }

private:
  /// Returns true if node position was trimmed to its TPC volume + fMargin
  bool LimitPoint3D();
  void UpdateProj2D();

  double EndPtCos2Transverse() const;
  double PiInWirePlane() const;
  double PenaltyInWirePlane() const;

  double Pi(float endSegWeight, bool doAsymm) const;
  double Penalty(float endSegWeight) const;
  double Mse() const;

  double MakeGradient(float penaltyValue, float endSegWeight);
  double StepWithGradient(float alfa, float tol, float penalty, float weight);

  double SumDist2Hits() const override;

  geo::TPCGeo const& fTpcGeo;

  double fMinX, fMaxX, fMinY, fMaxY, fMinZ,
    fMaxZ; // TPC boundaries to limit the node position (+margin)

  TVector3 fPoint3D;   // node position in 3D space in [cm]
  TVector2 fProj2D[3]; // node projections to 2D views, scaled to [cm], updated
                       // on each change of 3D position
  double fDriftOffset; // the offset due to t0

  TVector3 fGradient;
  bool fIsVertex; // no penalty on segments angle if branching or kink detected

  static bool fGradFixed[3];
  static double fMargin;
};

#endif