ImageStep.h

Go to the documentation of this file.

// Copyright (C) 2022 ASTRON (Netherlands Institute for Radio Astronomy)
// SPDX-License-Identifier: GPL-3.0-or-later
 
#ifndef DP3_STEPS_CADENCEIMAGER_H_
#define DP3_STEPS_CADENCEIMAGER_H_
 
#include "steps/Step.h"
 
#include "base/DPBuffer.h"
#include "common/ParameterSet.h"
#include "common/Timer.h"
 
#include <memory>
#include <string>
 
#include <wsclean/inmemoryms.h>
 
namespace dp3::steps {
 
class ImageStep final : public Step {
 public:
  ImageStep(const common::ParameterSet&, const std::string& prefix);
 
  common::Fields getRequiredFields() const override {
    return kDataField | kUvwField | kWeightsField | kFlagsField;
  }
 
  common::Fields getProvidedFields() const final { return {}; }
 
  bool process(std::unique_ptr<base::DPBuffer>) override;
 
  // TODO: implement the BDA processing.
  bool process(std::unique_ptr<base::BdaBuffer>) override;
 
  void finish() override;
 
  void updateInfo(const base::DPInfo&) override;
 
  void show(std::ostream&) const override;
 
  void showTimings(std::ostream&, double duration) const override;
 
 private:
  void InitializeInMemoryMs();
 
  void AddCurrentBufferToInMemoryMs(const base::DPBuffer::DataType& data,
                                    const base::DPBuffer::WeightsType& weights,
                                    const base::DPBuffer::UvwType& uvws,
                                    double time);
 
  std::string FormatImageNamePrefix() const;
 
  std::string name_;
  common::NSTimer timer_;
 
  double cadence_;
 
  std::string wsclean_options_;
 
  std::string fits_prefix_;
  size_t image_counter_ = 0;
 
  // Number of timesteps added to the in-memory MS.
  // Resets when the desired cadence is reached.
  size_t timestep_counter_ = 0;
  size_t n_timesteps_per_image_;
 
  bool has_frequency_bda_ = false;
  bool has_time_bda_ = false;
 
  std::unique_ptr<wsclean::InMemoryMs> in_memory_ms_;
};
 
}  // namespace dp3::steps
 
#endif