GainCalAlgorithm.h

Go to the documentation of this file.

// GainCalAlgorithm.h: Perform algorithm for gain calibration
// Copyright (C) 2020 ASTRON (Netherlands Institute for Radio Astronomy)
// SPDX-License-Identifier: GPL-3.0-or-later
 
 
#ifndef DPPP_GAINCALALGORITHM_H
#define DPPP_GAINCALALGORITHM_H
 
#include <casacore/casa/Arrays/Cube.h>
#include <casacore/casa/Arrays/ArrayMath.h>
 
#include <aocommon/recursivefor.h>
 
namespace dp3 {
 
namespace base {
 
class GainCalAlgorithm {
 public:
  enum Status { CONVERGED = 1, NOTCONVERGED = 2, STALLED = 3, FAILED = 4 };
 
  enum Mode { DEFAULT, PHASEONLY, AMPLITUDEONLY, FULLJONES };
 
  GainCalAlgorithm(unsigned int solInt, unsigned int nChan, Mode mode,
                   bool scalar, double tolerance, unsigned int maxAntennas,
                   bool detectStalling, unsigned int debugLevel);
 
  void resetVis();
 
  void init(bool initSolutions);
 
  Status doStep(unsigned int iter, aocommon::RecursiveFor& recursive_for);
 
  casacore::Matrix<std::complex<double>> getSolution(bool setNaNs);
 
  double getWeight() { return _totalWeight; }
 
  void incrementWeight(float weight);
 
  casacore::Array<std::complex<double>>& getVis() { return _vis; }
 
  casacore::Array<std::complex<double>>& getMVis() { return _mvis; }
 
  casacore::Vector<bool>& getStationFlagged() { return _stationFlagged; }
 
  unsigned int numCorrelations() { return _savedNCr; }
 
  unsigned int nCr() { return _nCr; }
 
  void clearStationFlagged();
 
 private:
  Status relax(unsigned int iter);
  static bool isFinite(const std::complex<double>& val) {
    return std::isfinite(val.real()) && std::isfinite(val.imag());
  }
 
  void doStep_polarized();
  void doStep_unpolarized(aocommon::RecursiveFor& recursive_for);
 
  double getAverageUnflaggedSolution();
 
  unsigned int _savedNCr;
  casacore::Vector<bool>
      _stationFlagged;  
  casacore::Array<std::complex<double>> _vis;   
  casacore::Array<std::complex<double>> _mvis;  
  casacore::Matrix<std::complex<double>>
      _g;  
  casacore::Matrix<std::complex<double>> _gx;  
  casacore::Matrix<std::complex<double>>
      _gxx;  
  casacore::Matrix<std::complex<double>> _gold;  
  casacore::Matrix<std::complex<double>>
      _h;  
  casacore::Matrix<std::complex<double>> _z;  
 
  unsigned int _nSt;       
  unsigned int _nUn;       
  unsigned int _nCr;       
  unsigned int _nSp;       
  unsigned int _badIters;  
  unsigned int
      _veryBadIters;     
  unsigned int _solInt;  
  unsigned int _nChan;   
  Mode _mode;            
  bool _scalar;          
  double _tolerance;
  double _totalWeight;
  bool _detectStalling;
  unsigned int _debugLevel;
 
  double _dg, _dgx;          
  std::vector<double> _dgs;  
};
 
}  // namespace base
}  // namespace dp3
 
#endif