AOFlaggerStep.h

Go to the documentation of this file.

// AOFlaggerStep.h: DPPP step class to flag data using rficonsole's
// functionality
//
// Copyright (C) 2023 ASTRON (Netherlands Institute for Radio Astronomy)
// SPDX-License-Identifier: GPL-3.0-or-later
//
 
#ifndef DP3_STEPS_AOFLAGGERSTEP_H_
#define DP3_STEPS_AOFLAGGERSTEP_H_
 
#include "InputStep.h"
 
#include "base/DPBuffer.h"
#include "base/FlagCounter.h"
 
#include <memory>
#include <mutex>
 
#include <aoflagger.h>
 
namespace dp3 {
 
namespace common {
class ParameterSet;
}
 
namespace steps {
 
 
 
class AOFlaggerStep : public Step {
 public:
  AOFlaggerStep(const common::ParameterSet&, const std::string& prefix);
 
  ~AOFlaggerStep() override;
 
  common::Fields getRequiredFields() const override {
    return kDataField | kFlagsField;
  }
 
  common::Fields getProvidedFields() const override { return kFlagsField; }
 
  bool process(std::unique_ptr<base::DPBuffer> buffer) override;
 
  void finish() override;
 
  void addToMS(const std::string& msName) 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;
 
 private:
  void flag(unsigned int rightOverlap);
 
  static void formatBytes(std::ostream&, double);
 
  void flagBaseline(unsigned int leftOverlap, unsigned int windowSize,
                    unsigned int rightOverlap, unsigned int bl,
                    base::FlagCounter& counter, aoflagger::Strategy& strategy,
                    aoflagger::QualityStatistics& rfiStats);
 
  void addStats(aoflagger::QualityStatistics& rfiStats,
                const aoflagger::ImageSet& values,
                const aoflagger::FlagMask& rfiMask,
                const aoflagger::FlagMask& origMask, int bl);
 
  std::string name_;
  unsigned int buffer_index_;
  unsigned int n_times_;
  std::string strategy_name_;
  unsigned int window_size_;
  unsigned int overlap_;  
  double overlap_percentage_;
  double memory_;  
  double memory_percentage_;
  double memory_needed_;  
  bool flag_auto_correlations_;
  bool collect_statistics_;
  std::vector<std::unique_ptr<base::DPBuffer>> buffer_;
  base::FlagCounter flag_counter_;
  common::NSTimer total_timer_;
  common::NSTimer quality_timer_;
  common::NSTimer compute_timer_;
  double move_time_;   
  double flag_time_;   
  double stats_time_;  
  std::vector<double> frequencies_;
  aoflagger::AOFlagger aoflagger_;
  std::mutex mutex_;
  bool has_qstats_;
  aoflagger::QualityStatistics qstats_;
};
 
}  // namespace steps
}  // namespace dp3
 
#endif