ElPatternEst.h

#pragma once
 
#include <tuple>
#include <vector>
#include <optional>
 
#include <Eigen/Dense>
 
#include <isce3/core/EMatrix.h>
#include <isce3/core/Ellipsoid.h>
#include <isce3/core/Linspace.h>
#include <isce3/core/Orbit.h>
#include <isce3/core/Poly1d.h>
#include <isce3/geometry/DEMInterpolator.h>
 
namespace isce3 { namespace antenna {

class ElPatternEst {
    // aliases
public:
    using RowMatrixXcf = isce3::core::EMatrix2D<std::complex<float>>;
 
protected:
    using Linspace_t = isce3::core::Linspace<double>;
    using tuple4_t = std::tuple<Eigen::ArrayXd, isce3::core::Linspace<double>,
            Eigen::ArrayXd, Eigen::ArrayXd>;
    using tuple5_t = std::tuple<Eigen::ArrayXd, isce3::core::Linspace<double>,
            Eigen::ArrayXd, Eigen::ArrayXd, isce3::core::Poly1d>;
 
public:
    // constructors
    ElPatternEst(double sr_start, const isce3::core::Orbit& orbit,
            int polyfit_deg = 6,
            const isce3::geometry::DEMInterpolator& dem_interp = {},
            double win_ped = 0.0, const isce3::core::Ellipsoid& ellips = {},
            bool center_scale_pf = false);

    ElPatternEst(double sr_start, const isce3::core::Orbit& orbit,
            const isce3::geometry::DEMInterpolator& dem_interp)
        : ElPatternEst(sr_start, orbit, 6, dem_interp, 0.0,
                  isce3::core::Ellipsoid(), false)
    {}
 
    // methods
    tuple5_t powerPattern2way(const Eigen::Ref<const RowMatrixXcf>& echo_mat,
            double sr_spacing, double chirp_rate, double chirp_dur,
            std::optional<double> az_time = {}, int size_avg = 8,
            bool inc_corr = true) const;

    tuple5_t powerPattern1way(const Eigen::Ref<const RowMatrixXcf>& echo_mat,
            double sr_spacing, double chirp_rate, double chirp_dur,
            std::optional<double> az_time = {}, int size_avg = 8,
            bool inc_corr = true) const;

    double winPed() const { return _win_ped; }

    int polyfitDeg() const { return _polyfit_deg; }

    bool isCenterScalePolyfit() const { return _center_scale_pf; }
 
private:
    tuple4_t _getCalibPowLinear(const Eigen::Ref<const RowMatrixXcf>& echo_mat,
            double sr_spacing, double chirp_rate, double chirp_dur,
            std::optional<double> az_time, int size_avg, bool inc_corr) const;
 
    // members
protected:
    // input common parameters
    double _sr_start;
    isce3::core::Orbit _orbit;
    double _polyfit_deg;
    isce3::geometry::DEMInterpolator _dem_interp;
    double _win_ped;
    isce3::core::Ellipsoid _ellips;
    bool _center_scale_pf;
};
 
}} // namespace isce3::antenna