PmaVtxCandidate.cxx

Go to the documentation of this file.

/**
 *  @file   PmaVtxCandidate.cxx
 *
 *  @author D.Stefan and R.Sulej
 *
 *  @brief  Vertex finding helper for the Projection Matching Algorithm
 *
 *          Candidate for 3D vertex. Used to test intersections and join tracks in vertices.
 *          See PmaTrack3D.h file for details.
 */

#include "larreco/RecoAlg/PMAlg/PmaVtxCandidate.h"
#include "larcoreobj/SimpleTypesAndConstants/geo_types.h"
#include "larreco/RecoAlg/PMAlg/PmaNode3D.h"
#include "larreco/RecoAlg/PMAlg/PmaSegment3D.h"
#include "larreco/RecoAlg/PMAlg/PmaTrack3D.h"
#include "larreco/RecoAlg/PMAlg/Utilities.h"

#include "larcore/Geometry/Geometry.h"

#include "messagefacility/MessageLogger/MessageLogger.h"

#include "TMath.h"

bool
pma::VtxCandidate::Has(pma::Track3D* trk) const
{
  for (const auto& t : fAssigned)
    if (trk == t.first.Track()) return true;
  return false;
}

bool
pma::VtxCandidate::Has(const pma::VtxCandidate& other) const
{
  for (const auto& t : other.fAssigned)
    if (!Has(t.first.Track())) return false;
  return true;
}

bool
pma::VtxCandidate::IsAttached(pma::Track3D* trk) const
{
  pma::Track3D const* rootTrk = trk->GetRoot();
  if (!rootTrk) throw cet::exception("pma::VtxCandidate") << "Broken track.";

  for (const auto& t : fAssigned) {
    pma::Track3D const* rootAssn = t.first.Track()->GetRoot();
    if (!rootAssn) throw cet::exception("pma::VtxCandidate") << "Broken track.";

    if (rootTrk->IsAttachedTo(rootAssn)) return true;
  }
  return false;
}

bool
pma::VtxCandidate::IsAttached(const pma::VtxCandidate& other) const
{
  for (const auto& t : other.fAssigned)
    if (IsAttached(t.first.Track())) return true;
  return false;
}

bool
pma::VtxCandidate::HasLoops() const
{
  for (size_t t = 0; t < fAssigned.size(); t++) {
    pma::Track3D const* trk_t = fAssigned[t].first.Track()->GetRoot();
    if (!trk_t) throw cet::exception("pma::VtxCandidate") << "Broken track.";

    for (size_t u = 0; u < fAssigned.size(); u++)
      if (t != u) {
        pma::Track3D const* trk_u = fAssigned[u].first.Track()->GetRoot();
        if (!trk_u) throw cet::exception("pma::VtxCandidate") << "Broken track.";

        if (trk_t->IsAttachedTo(trk_u)) return true;
      }
  }
  return false;
}

size_t
pma::VtxCandidate::Size(double minLength) const
{
  size_t n = 0;
  for (auto const& c : fAssigned)
    if (c.first.Track()->Length() > minLength) n++;
  return n;
}

bool
pma::VtxCandidate::Add(const pma::TrkCandidate& trk)
{
  if (IsAttached(trk.Track())) return false;

  fAssigned.emplace_back(trk, 0);

  double d, d_best;
  double mse, min_mse = kMaxDistToTrack * kMaxDistToTrack;
  if (fAssigned.size() > 2) {
    size_t n_best = 0;
    d_best = kMaxDistToTrack;
    for (size_t n = 0; n < trk.Track()->Nodes().size() - 1; n++) {
      pma::Segment3D* seg = trk.Track()->NextSegment(trk.Track()->Nodes()[n]);
      if (seg->Length() < fSegMinLength) continue;

      fAssigned.back().second = n;

      mse = Compute();
      if (mse < min_mse) {
        d = sqrt(seg->GetDistance2To(fCenter));
        if (d < d_best) {
          min_mse = mse;
          n_best = n;
          d_best = d;
        }
      }
    }

    if (d_best < kMaxDistToTrack) {
      fAssigned.back().second = n_best;
      fMse = Compute();
      fMse2D = ComputeMse2D();
      return true;
    }
    else {
      fAssigned.pop_back();
      fMse = Compute();
      fMse2D = ComputeMse2D();
      return false;
    }
  }
  else if (fAssigned.size() == 2) {
    pma::Track3D* p0 = fAssigned.front().first.Track();

    size_t n_best = 0, m_best = 0;
    d_best = kMaxDistToTrack;

    double lm, ln, l_best = 0;
    for (size_t m = 0; m < p0->Nodes().size() - 1; m++) {
      pma::Segment3D* seg_m = p0->NextSegment(p0->Nodes()[m]);
      lm = seg_m->Length();
      if (lm < fSegMinLength) continue;

      fAssigned.front().second = m;

      for (size_t n = 0; n < trk.Track()->Nodes().size() - 1; n++) {
        pma::Segment3D* seg_n = trk.Track()->NextSegment(trk.Track()->Nodes()[n]);
        ln = seg_n->Length();
        if (ln < fSegMinLength) continue;

        fAssigned.back().second = n;

        mse = Compute(); // std::cout << mse << std::endl;

        d = sqrt(ComputeMse2D());

        if (d < d_best) {
          double d_dist = (d_best - d) / d_best;
          if (lm + ln > 0.8 * d_dist * l_best) // take closer if not much shorter
          {
            min_mse = mse;
            n_best = n;
            m_best = m;
            d_best = d;
            l_best = lm + ln;
          }
        }
      }
    }

    if (d_best < kMaxDistToTrack) {
      fAssigned.front().second = m_best;
      fAssigned.back().second = n_best;
      fMse = Compute();

      fMse2D = ComputeMse2D();

      return true;
    }
    else {
      fAssigned.pop_back();
      fCenter.SetXYZ(0., 0., 0.);
      fMse = 0;
      fMse2D = 0;
      return false;
    }
  }
  else {
    for (size_t n = 0; n < trk.Track()->Nodes().size() - 1; n++) {
      pma::Segment3D* seg = trk.Track()->NextSegment(trk.Track()->Nodes()[n]);
      if (seg->Length() >= fSegMinLength) { return true; }
    }
    fAssigned.pop_back();
    fCenter.SetXYZ(0., 0., 0.);
    fMse = 0;
    fMse2D = 0;
    return false;
  }
}

double
pma::VtxCandidate::ComputeMse2D()
{
  art::ServiceHandle<geo::Geometry const> geom;

  double mse = 0.0;
  TVector2 center2d;
  for (const auto& t : fAssigned) {
    pma::Track3D* trk = t.first.Track();
    pma::Segment3D* seg = trk->NextSegment(trk->Nodes()[t.second]);

    int tpc = trk->Nodes()[t.second]->TPC();
    int cryo = trk->Nodes()[t.second]->Cryo();

    size_t k = 0;
    double m = 0.0;
    if (geom->TPC(tpc, cryo).HasPlane(geo::kU)) {
      center2d = GetProjectionToPlane(fCenter, geo::kU, tpc, cryo);
      m += seg->GetDistance2To(center2d, geo::kU);
      k++;
    }
    if (geom->TPC(tpc, cryo).HasPlane(geo::kV)) {
      center2d = GetProjectionToPlane(fCenter, geo::kV, tpc, cryo);
      m += seg->GetDistance2To(center2d, geo::kV);
      k++;
    }
    if (geom->TPC(tpc, cryo).HasPlane(geo::kZ)) {
      center2d = GetProjectionToPlane(fCenter, geo::kZ, tpc, cryo);
      m += seg->GetDistance2To(center2d, geo::kZ);
      k++;
    }
    mse += m / (double)k;
  }

  return mse / fAssigned.size();
}

double
pma::VtxCandidate::Test(const VtxCandidate& other) const
{
  double dx = fCenter[0] - other.fCenter[0];
  double dy = fCenter[1] - other.fCenter[1];
  double dz = fCenter[2] - other.fCenter[2];
  double dw = fErr[0] * other.fErr[0] * dx * dx + fErr[1] * other.fErr[1] * dy * dy +
              fErr[2] * other.fErr[2] * dz * dz;
  return sqrt(dw);
}

double
pma::VtxCandidate::MaxAngle(double minLength) const
{
  TVector3 dir_i;
  size_t max_l_idx = 0;
  double l, max_l = 0.0;
  for (size_t i = 0; i < fAssigned.size() - 1; i++) {
    l = fAssigned[i].first.Track()->Length();
    if (l > max_l) {
      max_l = l;
      max_l_idx = i;
      pma::Track3D* trk_i = fAssigned[i].first.Track();
      pma::Node3D* vtx_i0 = trk_i->Nodes()[fAssigned[i].second];
      pma::Node3D* vtx_i1 = trk_i->Nodes()[fAssigned[i].second + 1];
      dir_i = vtx_i1->Point3D() - vtx_i0->Point3D();
      dir_i *= 1.0 / dir_i.Mag();
    }
  }

  double a, min = 1.0;
  for (size_t j = 0; j < fAssigned.size(); j++)
    if ((j != max_l_idx) && (fAssigned[j].first.Track()->Length() > minLength)) {
      pma::Track3D* trk_j = fAssigned[j].first.Track();
      pma::Node3D* vtx_j0 = trk_j->Nodes()[fAssigned[j].second];
      pma::Node3D* vtx_j1 = trk_j->Nodes()[fAssigned[j].second + 1];
      TVector3 dir_j = vtx_j1->Point3D() - vtx_j0->Point3D();
      dir_j *= 1.0 / dir_j.Mag();
      a = fabs(dir_i * dir_j);
      if (a < min) min = a;
    }

  return 180.0 * acos(min) / TMath::Pi();
}

bool
pma::VtxCandidate::MergeWith(const pma::VtxCandidate& other)
{
  double d = sqrt(pma::Dist2(fCenter, other.fCenter));
  if (d > 10.0) {
    mf::LogVerbatim("pma::VtxCandidate") << "too far..";
    return false;
  }

  double dw = Test(other);

  size_t ntrk = 0;
  for (const auto& t : other.fAssigned) {
    if (IsAttached(t.first.Track())) {
      mf::LogVerbatim("pma::VtxCandidate") << "already attached..";
      return false;
    }
    if (!Has(t.first.Track())) {
      fAssigned.push_back(t);
      ntrk++;
    }
  }
  if (ntrk) {
    double mse0 = fMse, mse1 = other.fMse;
    mf::LogVerbatim("pma::VtxCandidate")
      << "try: " << d << " mse0:" << sqrt(mse0) << " mse1:" << sqrt(mse1);
    //std::cout << "try: " << d << " mse0:" << sqrt(mse0) << " mse1:" << sqrt(mse1) << std::endl;

    double mse = Compute();
    mf::LogVerbatim("pma::VtxCandidate")
      << "out: " << Size() << " mse:" << sqrt(mse) << " dw:" << dw;
    //std::cout << "out: " << Size() << " mse:" << sqrt(mse) << " dw:" << dw << std::endl;

    if (mse < 1.0) // kMaxDistToTrack * kMaxDistToTrack)
    {
      fMse = mse;
      fMse2D = ComputeMse2D();
      return true;
    }
    else {
      mf::LogVerbatim("pma::VtxCandidate") << "high mse..";
      while (ntrk--) {
        fAssigned.pop_back();
      }
      fMse = Compute();
      fMse2D = ComputeMse2D();
      return false;
    }
  }
  else {
    mf::LogVerbatim("pma::VtxCandidate") << "no tracks..";
    return false;
  }
}

double
pma::VtxCandidate::Compute()
{
  std::vector<pma::Segment3D*> segments;
  std::vector<std::pair<TVector3, TVector3>> lines;
  std::vector<double> weights;
  for (const auto& v : fAssigned) {
    pma::Track3D* trk = v.first.Track();
    int vIdx = v.second;

    pma::Node3D* vtx1 = trk->Nodes()[vIdx];
    pma::Segment3D* seg = trk->NextSegment(vtx1);
    double segLength = seg->Length();
    if (segLength >= fSegMinLength) {
      pma::Node3D* vtx2 = static_cast<pma::Node3D*>(seg->Next(0));

      std::pair<TVector3, TVector3> endpoints(vtx1->Point3D(), vtx2->Point3D());
      double dy = endpoints.first.Y() - endpoints.second.Y();
      double fy_norm = asin(fabs(dy) / segLength) / (0.5 * TMath::Pi());
      double w = 1.0 - pow(fy_norm - 1.0, 12);
      if (w < 0.3) w = 0.3;

      lines.push_back(endpoints);
      segments.push_back(seg);
      weights.push_back(w);
    }
  }

  fCenter.SetXYZ(0., 0., 0.);
  fErr.SetXYZ(0., 0., 0.);

  TVector3 result;
  double resultMse = pma::SolveLeastSquares3D(lines, result);
  if (resultMse < 0.0) {
    mf::LogWarning("pma::VtxCandidate") << "Cannot compute crossing point.";
    return 1.0E+6;
  }

  TVector3 pproj;
  //double dx, dy, dz
  double wsum = 0.0;
  for (size_t s = 0; s < segments.size(); s++) {
    pma::Node3D* vprev = static_cast<pma::Node3D*>(segments[s]->Prev());
    pma::Node3D* vnext = static_cast<pma::Node3D*>(segments[s]->Next(0));

    pproj = pma::GetProjectionToSegment(result, vprev->Point3D(), vnext->Point3D());

    //dx = weights[s] * (result.X() - pproj.X());
    //dy = result.Y() - pproj.Y();
    //dz = result.Z() - pproj.Z();

    fErr[0] += weights[s] * weights[s];
    fErr[1] += 1.0;
    fErr[2] += 1.0;

    fCenter[0] += weights[s] * pproj.X();
    fCenter[1] += pproj.Y();
    fCenter[2] += pproj.Z();
    wsum += weights[s];
  }
  fCenter[0] /= wsum;
  fCenter[1] /= segments.size();
  fCenter[2] /= segments.size();

  fErr *= 1.0 / segments.size();
  fErr[0] = sqrt(fErr[0]);
  fErr[1] = sqrt(fErr[1]);
  fErr[2] = sqrt(fErr[2]);

  return resultMse;
}

bool
pma::VtxCandidate::JoinTracks(detinfo::DetectorPropertiesData const& detProp,
                              pma::TrkCandidateColl& tracks,
                              pma::TrkCandidateColl& src)
{
  if (tracksJoined) {
    mf::LogError("pma::VtxCandidate") << "Tracks already attached to the vertex.";
    return false;
  }
  tracksJoined = true;

  mf::LogVerbatim("pma::VtxCandidate")
    << "JoinTracks (" << fAssigned.size() << ") at:"
    << " vx:" << fCenter.X() << " vy:" << fCenter.Y() << " vz:" << fCenter.Z();

  for (auto const& c : fAssigned) {
    size_t t = 0;
    while (t < src.size()) {
      if (c.first.Track() == src[t].Track()) { // move from "src" to "tracks"
        tracks.push_back(src[t]);
        src.erase_at(t);
        break;
      }
      else
        t++;
    }
  }
  // all involved tracks are in the same container, so:
  tracks.setTreeIds();
  for (auto& c : fAssigned) // update ids
    for (auto const& t : tracks.tracks())
      if (c.first.Track() == t.Track()) {
        c.first.SetTreeId(t.TreeId());
        break;
      }

  // backup in case of fitting problems
  std::vector<int> treeIds;
  pma::TrkCandidateColl backupTracks;

  pma::Node3D* vtxCenter = 0;
  bool hasInnerCenter = false;
  size_t nOK = 0;
  for (size_t i = 0; i < fAssigned.size(); i++) {
    mf::LogVerbatim("pma::VtxCandidate") << "----------> track #" << i;

    pma::Track3D* trk = fAssigned[i].first.Track();
    int key = fAssigned[i].first.Key();
    int tid = fAssigned[i].first.TreeId();
    size_t idx = fAssigned[i].second;

    mf::LogVerbatim("pma::VtxCandidate") << "  track tid:" << tid << ", size:" << trk->size()
                                         << " (nodes:" << trk->Nodes().size() << ")";

    if (!has(treeIds, tid)) // backup in case of fitting problems
    {
      treeIds.push_back(tid);
      int rootIdx = tracks.getCandidateIndex(trk->GetRoot());
      if (rootIdx >= 0)
        tracks.getTreeCopy(backupTracks, rootIdx);
      else
        mf::LogError("pma::VtxCandidate") << "Root of the tree not found in tracks collection.";
    }

    TVector3 p0(trk->Nodes()[idx]->Point3D());
    TVector3 p1(trk->Nodes()[idx + 1]->Point3D());

    int tpc0 = trk->Nodes()[idx]->TPC();
    int tpc1 = trk->Nodes()[idx + 1]->TPC();

    int cryo0 = trk->Nodes()[idx]->Cryo();
    int cryo1 = trk->Nodes()[idx + 1]->Cryo();

    double d0 = sqrt(pma::Dist2(p0, fCenter));
    double d1 = sqrt(pma::Dist2(p1, fCenter));
    double ds = sqrt(pma::Dist2(p0, p1));
    double f = pma::GetSegmentProjVector(fCenter, p0, p1);
    TVector3 proj = pma::GetProjectionToSegment(fCenter, p0, p1);

    if ((idx == 0) && (f * ds <= kMinDistToNode)) {
      if (i == 0) {
        mf::LogVerbatim("pma::VtxCandidate") << "  new at front";
        vtxCenter = trk->Nodes().front();
        vtxCenter->SetPoint3D(fCenter);
        nOK++;
      }
      else {
        mf::LogVerbatim("pma::VtxCandidate") << "  front to center";
        if (trk->AttachTo(vtxCenter)) nOK++;
      }
    }
    else if ((idx + 2 == trk->Nodes().size()) && ((1.0 - f) * ds <= kMinDistToNode)) {
      if (i == 0) {
        if (trk->CanFlip()) {
          mf::LogVerbatim("pma::VtxCandidate") << "  flip trk to make new center";
          trk->Flip();
          vtxCenter = trk->Nodes().front();
        }
        else {
          mf::LogVerbatim("pma::VtxCandidate") << "  new center at the endpoint";
          vtxCenter = trk->Nodes().back();
        }
        vtxCenter->SetPoint3D(fCenter);
        nOK++;
      }
      else {
        if (vtxCenter->Prev() && trk->CanFlip()) {
          mf::LogVerbatim("pma::VtxCandidate") << "  flip trk to attach to inner";
          trk->Flip();
          if (trk->AttachTo(vtxCenter)) nOK++;
        }
        else {
          mf::LogVerbatim("pma::VtxCandidate") << "  endpoint to center";
          if (trk->AttachBackTo(vtxCenter)) nOK++;
        }
      }
    }
    else {
      bool canFlipPrev = true;
      if (vtxCenter && vtxCenter->Prev()) {
        pma::Segment3D* seg = static_cast<pma::Segment3D*>(vtxCenter->Prev());
        if (seg->Parent()->NextSegment(vtxCenter))
          canFlipPrev = false;
        else
          canFlipPrev = seg->Parent()->CanFlip();
      }

      if (hasInnerCenter || !canFlipPrev) {
        mf::LogVerbatim("pma::VtxCandidate") << "  split track";

        if ((f >= 0.0F) && (f <= 1.0) && (f * ds > kMinDistToNode) &&
            ((1.0 - f) * ds > kMinDistToNode)) {
          mf::LogVerbatim("pma::VtxCandidate") << "  add center inside segment";

          int tpc, cryo;
          if (f < 0.5) {
            tpc = tpc0;
            cryo = cryo0;
          }
          else {
            tpc = tpc1;
            cryo = cryo1;
          }

          trk->InsertNode(detProp, fCenter, ++idx, tpc, cryo);
        }
        else {
          if (d1 < d0) {
            mf::LogVerbatim("pma::VtxCandidate") << "  add center at end of segment";
            ++idx;
          }
          else {
            mf::LogVerbatim("pma::VtxCandidate") << "  center at start of segment - no action";
          }
        }

        pma::Track3D* t0 = trk->Split(detProp, idx); // makes both tracks attached to each other

        if (t0) {
          mf::LogVerbatim("pma::VtxCandidate")
            << "  trk size:" << trk->size() << " (nodes:" << trk->Nodes().size() << ")";

          trk->MakeProjection();

          mf::LogVerbatim("pma::VtxCandidate")
            << "  t0 size:" << t0->size() << " (nodes:" << t0->Nodes().size() << ")";

          t0->MakeProjection();

          tracks.tracks().emplace_back(t0, key, tid);
          if (i == 0) {
            mf::LogVerbatim("pma::VtxCandidate") << "  center at trk0 back";
            vtxCenter = trk->Nodes().front();
            nOK += 2;
          }
          else {
            mf::LogVerbatim("pma::VtxCandidate") << "  attach trk to trk0";
            if (trk->AttachTo(vtxCenter)) nOK += 2;
          }
        }
        mf::LogVerbatim("pma::VtxCandidate") << "  done";
      }
      else {
        mf::LogVerbatim("pma::VtxCandidate") << "  inner center";
        hasInnerCenter = true;

        if ((f >= 0.0F) && (f <= 1.0) && (f * ds > kMinDistToNode) &&
            ((1.0 - f) * ds > kMinDistToNode)) {
          mf::LogVerbatim("pma::VtxCandidate") << "  add center inside segment";

          int tpc, cryo;
          if (f < 0.5) {
            tpc = tpc0;
            cryo = cryo0;
          }
          else {
            tpc = tpc1;
            cryo = cryo1;
          }

          trk->InsertNode(detProp, fCenter, ++idx, tpc, cryo);
        }
        else {
          if (d1 < d0) {
            mf::LogVerbatim("pma::VtxCandidate") << "  add center at end of segment";
            ++idx;
          }
          else {
            mf::LogVerbatim("pma::VtxCandidate") << "  center at start of segment - no action";
          }
        }

        pma::Node3D* innerCenter = trk->Nodes()[idx];
        if (i > 0) // already has vtxCenter
        {
          // prepare for prev...
          pma::Track3D* rootBranch = 0;
          pma::Segment3D* seg = static_cast<pma::Segment3D*>(vtxCenter->Prev());
          if (seg) {
            rootBranch = seg->Parent();
            rootBranch->Flip();
          }

          // ...but nexts reattached first, then...
          auto branches = vtxCenter->GetBranches();

          for (size_t j = 0; j < branches.size(); ++j) {
            if (branches[j]->AttachTo(innerCenter, true)) {}
          }
          vtxCenter = innerCenter; // vtxCenter is deleted after full reattach
        }
        else {
          vtxCenter = innerCenter; // vtx from inner center
        }                          // set vtxCenter on i == 0

        nOK++;

        mf::LogVerbatim("pma::VtxCandidate") << "  done";
      }
    }
  }

  bool result = false;
  if (vtxCenter) {
    pma::Segment3D* rootSeg = 0;
    if (vtxCenter->NextCount())
      rootSeg = static_cast<pma::Segment3D*>(vtxCenter->Next(0));
    else if (vtxCenter->Prev())
      rootSeg = static_cast<pma::Segment3D*>(vtxCenter->Prev());
    else
      throw cet::exception("pma::VtxCandidate") << "Vertex with no segments attached.";

    pma::Track3D* rootTrk = rootSeg->Parent()->GetRoot();
    if (!rootTrk) rootTrk = rootSeg->Parent();

    std::vector<pma::Track3D const*> branchesToRemove;     // change to a more simple check
    bool noLoops = rootTrk->GetBranches(branchesToRemove); // if there are loops

    bool tuneOK = true;
    if (noLoops && (nOK > 1)) {
      fAssigned.clear();
      fCenter = vtxCenter->Point3D();
      fMse = 0.0;
      fMse2D = 0.0;

      double g = rootTrk->TuneFullTree();

      if (g > -2.0) // -1.0: high value of g; -2.0: inf. value of g.
      {
        result = true; // all OK, new vertex added
      }
      else {
        tuneOK = false; // inf. g, remove tracks
      }
    }

    if (noLoops && tuneOK) {
      mf::LogVerbatim("pma::VtxCandidate") << "remove backup tracks";
      for (auto& c : backupTracks.tracks())
        c.DeleteTrack();
    }
    else {
      mf::LogVerbatim("pma::VtxCandidate") << "restore tracks from backup....";
      for (int tid : treeIds) {
        size_t t = 0;
        while (t < tracks.size()) {
          if (tracks[t].TreeId() == tid) {
            tracks[t].DeleteTrack();
            tracks.erase_at(t);
          }
          else
            t++;
        }
      }
      for (const auto& c : backupTracks.tracks())
        tracks.push_back(c);
      mf::LogVerbatim("pma::VtxCandidate") << "  done";
    }
  }
  else
    mf::LogError("pma::VtxCandidate") << "Cannot create common vertex";

  return result;
}