Averager.h

Go to the documentation of this file.

// Averager.h: DP3 step class to average in time and/or freq
// Copyright (C) 2023 ASTRON (Netherlands Institute for Radio Astronomy)
// SPDX-License-Identifier: GPL-3.0-or-later
 
 
#ifndef DP3_STEPS_AVERAGER_H_
#define DP3_STEPS_AVERAGER_H_
 
#include <memory>
 
#include <xtensor/containers/xtensor.hpp>
#include <aocommon/staticfor.h>
 
#include "base/DPBuffer.h"
#include "steps/Step.h"
#include "common/Timer.h"
 
namespace dp3 {
 
namespace common {
class ParameterSet;
}
 
namespace steps {
 
 
 
class Averager : public Step {
 public:
  static const common::Fields kRequiredFields;
  static const common::Fields kProvidedFields;
 
  Averager(const common::ParameterSet&, const std::string& prefix);
 
  Averager(const std::string& stepname, unsigned int nchanAvg,
           unsigned int ntimeAvg);
  Averager(const std::string& stepname, double freq_resolution,
           double time_resolution);
 
  ~Averager() override;
 
  common::Fields getRequiredFields() const override { return kRequiredFields; }
 
  common::Fields getProvidedFields() const override { return kProvidedFields; }
 
  bool process(std::unique_ptr<base::DPBuffer> buffer) override;
 
  void finish() override;
 
  void updateInfo(const base::DPInfo&) override;
 
  void show(std::ostream&) const override;
 
  void showTimings(std::ostream&, double duration) const override;
 
  static double getFreqHz(const std::string& freqstr);
 
 private:
  void average();
 
  std::string itsName;
  std::unique_ptr<base::DPBuffer> itsBuf;
  xt::xtensor<int, 3> itsNPoints;
  xt::xtensor<std::complex<float>, 3> itsAvgAll;
  xt::xtensor<float, 3> itsWeightAll;
  double itsFreqResolution;
  double itsTimeResolution;
  unsigned int itsNChanAvg;
  unsigned int itsNTimeAvg;
  unsigned int itsMinNPoint;
  float itsMinPerc;
  unsigned int itsNTimes;
  double itsOriginalTimeInterval;
  bool itsNoAvg;  
  common::NSTimer itsTimer;
};
 
}  // namespace steps
}  // namespace dp3
 
#endif