MadFlagger.h

Go to the documentation of this file.

// MadFlagger.h: DP3 step class to flag data based on median filtering
// Copyright (C) 2023 ASTRON (Netherlands Institute for Radio Astronomy)
// SPDX-License-Identifier: GPL-3.0-or-later
 
 
#ifndef DP3_STEPS_MADFLAGGER_H_
#define DP3_STEPS_MADFLAGGER_H_
 
#include "InputStep.h"
 
#include "base/DPBuffer.h"
#include "base/FlagCounter.h"
 
namespace dp3 {
namespace common {
class ParameterSet;
}
 
namespace steps {
 
 
class MadFlagger : public Step {
 public:
  MadFlagger(const common::ParameterSet&, const std::string& prefix);
 
  ~MadFlagger() override;
 
  common::Fields getRequiredFields() const override { return kDataField; }
 
  common::Fields getProvidedFields() const override { return kFlagsField; }
 
  bool process(std::unique_ptr<base::DPBuffer>) override;
 
  void finish() override;
 
  void updateInfo(const base::DPInfo&) override;
 
  void show(std::ostream&) const override;
 
  void showCounts(std::ostream&) const override;
 
  void showTimings(std::ostream&, double duration) const override;
 
  void flag(unsigned int index, const std::vector<unsigned int>& timeEntries);
 
  void computeFactors(const std::vector<unsigned int>& timeEntries,
                      unsigned int bl, int chan, int corr, int nchan, int ncorr,
                      float& Z1, float& Z2, std::vector<float>& tempBuffer,
                      common::NSTimer& moveTimer, common::NSTimer& medianTimer);
 
  void getExprValues(int maxNChan, int maxNTime);
 
 private:
  void flagBaseline(const std::vector<int>& ant1, const std::vector<int>& ant2,
                    const std::vector<unsigned int>& timeEntries,
                    unsigned int ib, unsigned int ncorr, unsigned int nchan,
                    const float* bufDataPtr, bool* bufFlagPtr, float& Z1,
                    float& Z2, std::vector<float>& tempBuffer,
                    base::FlagCounter& counter, common::NSTimer& moveTimer,
                    common::NSTimer& medianTimer);
 
 protected:
  std::string itsName;
  std::string itsThresholdStr;
  std::string itsFreqWindowStr;
  std::string itsTimeWindowStr;
  std::vector<float> itsThresholdArr;  
  std::vector<unsigned int>
      itsFreqWindowArr;  
  std::vector<unsigned int>
      itsTimeWindowArr;  
  float itsThreshold;
  unsigned int itsFreqWindow;
  unsigned int itsTimeWindow;
  unsigned int itsNTimes;
  unsigned int itsNTimesDone;
  std::vector<unsigned int> itsFlagCorr;
  bool itsApplyAutoCorr;
  std::vector<int> itsAutoCorrIndex;  
  unsigned int itsNrAutoCorr;
  double itsMinBLength;             
  double itsMaxBLength;             
  std::vector<double> itsBLengths;  
  std::vector<std::unique_ptr<base::DPBuffer>> itsBuffers;
  std::vector<xt::xtensor<float, 3>> itsAmplitudes;  
  base::FlagCounter itsFlagCounter;
  common::NSTimer itsTimer;
  common::NSTimer itsComputeTimer;  
  double itsMoveTime;               
  double itsMedianTime;             
};
 
}  // namespace steps
}  // namespace dp3
 
#endif