Add filter for time range inside time frame

Author: pnwkw

EventVisualisation/Workflow/include/EveWorkflow/EveWorkflowHelper.h

@@ -117,7 +117,9 @@ class EveWorkflowHelper
 
   using FilterSet = std::bitset<Filter::NFilters>;
 
-  EveWorkflowHelper(const FilterSet& enabledFilters = {}, std::size_t maxNTracks = -1);
+  using TBracket = o2::math_utils::Bracketf_t;
+
+  EveWorkflowHelper(const FilterSet& enabledFilters = {}, std::size_t maxNTracks = -1, const TBracket& timeBracket = {});
   static std::vector<PNT> getTrackPoints(const o2::track::TrackPar& trc, float minR, float maxR, float maxStep, float minZ = -25000, float maxZ = 25000);
   void selectTracks(const CalibObjectsConst* calib, GID::mask_t maskCl,
                     GID::mask_t maskTrk, GID::mask_t maskMatch);
@@ -162,6 +164,7 @@ class EveWorkflowHelper
 
   FilterSet mEnabledFilters;
   std::size_t mMaxNTracks;
+  TBracket mTimeBracket;
   o2::globaltracking::RecoContainer mRecoCont;
   o2::globaltracking::RecoContainer& getRecoContainer() { return mRecoCont; }
   TracksSet mTrackSet;

EventVisualisation/Workflow/include/EveWorkflow/O2DPLDisplay.h

@@ -49,9 +49,9 @@ class O2DPLDisplaySpec : public o2::framework::Task
   static constexpr float mWorkflowVersion = 1.02; // helps recognizing version of workflow which produce data
   O2DPLDisplaySpec(bool useMC, o2::dataformats::GlobalTrackID::mask_t trkMask,
                    o2::dataformats::GlobalTrackID::mask_t clMask,
-                   std::shared_ptr<o2::globaltracking::DataRequest> dataRequest, std::string jsonPath,
-                   std::chrono::milliseconds timeInterval, int numberOfFiles, int numberOfTracks, bool eveHostNameMatch, bool noEmptyOutput, bool filterITSROF)
-    : mUseMC(useMC), mTrkMask(trkMask), mClMask(clMask), mDataRequest(dataRequest), mJsonPath(jsonPath), mTimeInteval(timeInterval), mNumberOfFiles(numberOfFiles), mNumberOfTracks(numberOfTracks), mEveHostNameMatch(eveHostNameMatch), mNoEmptyOutput(noEmptyOutput), mFilterITSROF(filterITSROF)
+                   std::shared_ptr<o2::globaltracking::DataRequest> dataRequest, const std::string& jsonPath,
+                   std::chrono::milliseconds timeInterval, int numberOfFiles, int numberOfTracks, bool eveHostNameMatch, bool noEmptyOutput, bool filterITSROF, bool filterTime, const EveWorkflowHelper::TBracket& timeBracket)
+    : mUseMC(useMC), mTrkMask(trkMask), mClMask(clMask), mDataRequest(dataRequest), mJsonPath(jsonPath), mTimeInteval(timeInterval), mNumberOfFiles(numberOfFiles), mNumberOfTracks(numberOfTracks), mEveHostNameMatch(eveHostNameMatch), mNoEmptyOutput(noEmptyOutput), mFilterITSROF(filterITSROF), mFilterTime(filterTime), mTimeBracket(timeBracket)
   {
     this->mTimeStamp = std::chrono::high_resolution_clock::now() - timeInterval; // first run meets condition
   }
@@ -65,13 +65,15 @@ class O2DPLDisplaySpec : public o2::framework::Task
   void updateTimeDependentParams(o2::framework::ProcessingContext& pc);
 
   bool mUseMC = false;
-  bool mEveHostNameMatch;                 // empty or correct hostname
-  bool mNoEmptyOutput;                    // don't create files with no tracks/clusters
-  bool mFilterITSROF;                     // don't display tracks outside ITS readout frame
-  std::string mJsonPath;                  // folder where files are stored
-  std::chrono::milliseconds mTimeInteval; // minimal interval between files in miliseconds
-  int mNumberOfFiles;                     // maximun number of files in folder - newer replaces older
-  int mNumberOfTracks;                    // maximun number of track in single file (0 means no limit)
+  bool mEveHostNameMatch;                   // empty or correct hostname
+  bool mNoEmptyOutput;                      // don't create files with no tracks/clusters
+  bool mFilterITSROF;                       // don't display tracks outside ITS readout frame
+  bool mFilterTime;                         // don't display tracks outside [min, max] range in TF time
+  EveWorkflowHelper::TBracket mTimeBracket; // [min, max] range in TF time for the filter
+  std::string mJsonPath;                    // folder where files are stored
+  std::chrono::milliseconds mTimeInteval;   // minimal interval between files in milliseconds
+  int mNumberOfFiles;                       // maximum number of files in folder - newer replaces older
+  int mNumberOfTracks;                      // maximum number of track in single file (0 means no limit)
   std::chrono::time_point<std::chrono::high_resolution_clock> mTimeStamp;
 
   o2::dataformats::GlobalTrackID::mask_t mTrkMask;

EventVisualisation/Workflow/src/EveWorkflowHelper.cxx

@@ -33,8 +33,6 @@ using namespace o2::event_visualisation;
 void EveWorkflowHelper::selectTracks(const CalibObjectsConst* calib,
                                      GID::mask_t maskCl, GID::mask_t maskTrk, GID::mask_t maskMatch)
 {
-  using TBracket = o2::math_utils::Bracketf_t;
-
   std::vector<TBracket> itsROFBrackets;
 
   if (mEnabledFilters.test(Filter::ITSROF)) {
@@ -103,6 +101,10 @@ void EveWorkflowHelper::selectTracks(const CalibObjectsConst* calib,
 
     auto bracket = correctTrackTime(trk, time, terr);
 
+    if (mEnabledFilters.test(Filter::TimeBracket) && mTimeBracket.getOverlap(bracket).isInvalid()) {
+      return true;
+    }
+
     if (mEnabledFilters.test(Filter::ITSROF) && !isInsideITSROF(bracket)) {
       return true;
     }
@@ -642,7 +644,7 @@ void EveWorkflowHelper::drawTRDClusters(const o2::trd::TrackTRD& tpcTrdTrack, fl
   }
 }
 
-EveWorkflowHelper::EveWorkflowHelper(const FilterSet& enabledFilters, std::size_t maxNTracks) : mEnabledFilters(enabledFilters), mMaxNTracks(maxNTracks)
+EveWorkflowHelper::EveWorkflowHelper(const FilterSet& enabledFilters, std::size_t maxNTracks, const TBracket& timeBracket) : mEnabledFilters(enabledFilters), mMaxNTracks(maxNTracks), mTimeBracket(timeBracket)
 {
   o2::mch::TrackExtrap::setField();
   this->mMFTGeom = o2::mft::GeometryTGeo::Instance();

EventVisualisation/Workflow/src/O2DPLDisplay.cxx

@@ -47,14 +47,16 @@ void customize(std::vector<ConfigParamSpec>& workflowOptions)
     {"number-of_files", VariantType::Int, 300, {"maximum number of json files in folder"}},
     {"number-of_tracks", VariantType::Int, -1, {"maximum number of track stored in json file (-1 means no limit)"}},
     {"time-interval", VariantType::Int, 5000, {"time interval in milliseconds between stored files"}},
-    {"disable-mc", o2::framework::VariantType::Bool, false, {"disable visualization of MC data"}},
+    {"disable-mc", VariantType::Bool, false, {"disable visualization of MC data"}},
     {"display-clusters", VariantType::String, "ITS,TPC,TRD,TOF", {"comma-separated list of clusters to display"}},
     {"display-tracks", VariantType::String, "TPC,ITS,ITS-TPC,TPC-TRD,ITS-TPC-TRD,TPC-TOF,ITS-TPC-TOF", {"comma-separated list of tracks to display"}},
-    {"disable-root-input", o2::framework::VariantType::Bool, false, {"disable root-files input reader"}},
+    {"disable-root-input", VariantType::Bool, false, {"disable root-files input reader"}},
     {"configKeyValues", VariantType::String, "", {"Semicolon separated key=value strings ..."}},
-    {"skipOnEmptyInput", o2::framework::VariantType::Bool, false, {"Just don't run the ED when no input is provided"}},
-    {"no-empty-output", o2::framework::VariantType::Bool, false, {"don't create files with no tracks/clusters"}},
-    {"filter-its-rof", o2::framework::VariantType::Bool, false, {"don't display tracks outside ITS readout frame"}},
+    {"skipOnEmptyInput", VariantType::Bool, false, {"Just don't run the ED when no input is provided"}},
+    {"filter-its-rof", VariantType::Bool, false, {"don't display tracks outside ITS readout frame"}},
+    {"no-empty-output", VariantType::Bool, false, {"don't create files with no tracks/clusters"}},
+    {"filter-time-min", VariantType::Float, -1, {"display tracks only in [min, max] microseconds time range in each time frame, requires --filter-time-max to be specified as well"}},
+    {"filter-time-max", VariantType::Float, -1, {"display tracks only in [min, max] microseconds time range in each time frame, requires --filter-time-min to be specified as well"}},
   };
 
   std::swap(workflowOptions, options);
@@ -90,11 +92,15 @@ void O2DPLDisplaySpec::run(ProcessingContext& pc)
     enabledFilters.set(EveWorkflowHelper::Filter::ITSROF);
   }
 
+  if (this->mFilterTime) {
+    enabledFilters.set(EveWorkflowHelper::Filter::TimeBracket);
+  }
+
   if (this->mNumberOfTracks != -1) {
     enabledFilters.set(EveWorkflowHelper::Filter::TotalNTracks);
   }
 
-  EveWorkflowHelper helper(enabledFilters, this->mNumberOfTracks);
+  EveWorkflowHelper helper(enabledFilters, this->mNumberOfTracks, this->mTimeBracket);
 
   helper.getRecoContainer().collectData(pc, *mDataRequest);
   helper.selectTracks(&(mData.mConfig->configCalib), mClMask, mTrkMask, mTrkMask);
@@ -181,6 +187,27 @@ WorkflowSpec defineDataProcessing(ConfigContext const& cfgc)
     }
     throw std::runtime_error("No input configured");
   }
+
+  bool filterTime;
+  EveWorkflowHelper::TBracket timeBracket;
+
+  if (cfgc.options().isDefault("filter-time-min") && cfgc.options().isDefault("filter-time-max")) {
+    filterTime = false;
+  } else if (!cfgc.options().isDefault("filter-time-min") && !cfgc.options().isDefault("filter-time-max")) {
+    filterTime = true;
+
+    auto filterTimeMin = cfgc.options().get<float>("filter-time-min");
+    auto filterTimeMax = cfgc.options().get<float>("filter-time-max");
+
+    timeBracket = EveWorkflowHelper::TBracket{filterTimeMin, filterTimeMax};
+
+    if (timeBracket.isInvalid()) {
+      throw std::runtime_error("Filter time bracket is invalid");
+    }
+  } else {
+    throw std::runtime_error("Both filter times, min and max, have to be specified at the same time");
+  }
+
   std::shared_ptr<DataRequest> dataRequest = std::make_shared<DataRequest>();
   dataRequest->requestTracks(srcTrk, useMC);
   dataRequest->requestClusters(srcCl, useMC);
@@ -199,7 +226,7 @@ WorkflowSpec defineDataProcessing(ConfigContext const& cfgc)
     "o2-eve-display",
     dataRequest->inputs,
     {},
-    AlgorithmSpec{adaptFromTask<O2DPLDisplaySpec>(useMC, srcTrk, srcCl, dataRequest, jsonFolder, timeInterval, numberOfFiles, numberOfTracks, eveHostNameMatch, noEmptyFiles, filterITSROF)}});
+    AlgorithmSpec{adaptFromTask<O2DPLDisplaySpec>(useMC, srcTrk, srcCl, dataRequest, jsonFolder, timeInterval, numberOfFiles, numberOfTracks, eveHostNameMatch, noEmptyFiles, filterITSROF, filterTime, timeBracket)}});
 
   return std::move(specs);
 }