mc_antenna.h

Go to the documentation of this file.

/* Copyright (C) 2005-2012 Cory Davis <cdavis@staffmail.ed.ac.uk>
                            
   This program is free software; you can redistribute it and/or modify it
   under the terms of the GNU General Public License as published by the
   Free Software Foundation; either version 2, or (at your option) any
   later version.
 
   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.
 
   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
   USA. */
 
/*===========================================================================
  === External declarations
  ===========================================================================*/
#ifndef mc_antenna_h
#define mc_antenna_h
 
#include <cmath>
#include <stdexcept>
#include "arts.h"
#include "matpackI.h"
#include "ppath.h"
#include "rng.h"
 
enum AntennaType {
  ANTENNA_TYPE_PENCIL_BEAM = 1,
  ANTENNA_TYPE_GAUSSIAN = 2,
  ANTENNA_TYPE_LOOKUP = 3
};
 
class MCAntenna {
  AntennaType atype;
  Numeric sigma_aa, sigma_za;
  Vector aa_grid, za_grid;
  Matrix G_lookup;
 
 public:
  MCAntenna()
      : atype(),
        sigma_aa(0.),
        sigma_za(0.),
        aa_grid(),
        za_grid(),
        G_lookup() { /* Nothing to do here */
  }
 
  void set_pencil_beam();
  
  void set_gaussian(const Numeric& za_sigma, const Numeric& aa_sigma);
    
  void set_gaussian_fwhm(const Numeric& za_fwhm, const Numeric& aa_fwhm);
 
  void set_lookup(ConstVectorView za_grid,
                  ConstVectorView aa_grid,
                  ConstMatrixView G_lookup);
 
  AntennaType get_type() const;
    
  void return_los(Numeric& wgt,
                  ConstMatrixView R_return,
                  ConstMatrixView R_enu2ant) const;
    
  void draw_los(VectorView sampled_rte_los,
                MatrixView R_los,
                Rng& rng,
                ConstMatrixView R_ant2enu,
                ConstVectorView bore_sight_los) const;
  
  AntennaType Type() const {return atype;}
  Index Type(AntennaType x) {if (validType(x)) {atype = x; return EXIT_SUCCESS;} else return EXIT_FAILURE;}
  static bool validType(AntennaType x) noexcept
  {
    constexpr auto keys = stdarrayify(Index(ANTENNA_TYPE_PENCIL_BEAM), ANTENNA_TYPE_GAUSSIAN, ANTENNA_TYPE_LOOKUP);
    return std::any_of(keys.cbegin(), keys.cend(), [x](auto y){return x == y;});
  }
  Numeric& saa() {return sigma_aa;}
  Numeric& sza() {return sigma_za;};
  Vector& aag() {return aa_grid;}
  Vector& zag() {return za_grid;}
  Matrix& G() {return G_lookup;}
};
 
ostream& operator<<(ostream& os, const MCAntenna& mca);
 
Numeric ran_gaussian(Rng& rng, const Numeric sigma);
 
Numeric ran_uniform(Rng& rng);
 
void rotmat_enu(MatrixView R_ant2enu, ConstVectorView prop_los);
 
void rotmat_stokes(MatrixView R_pra,
                   const Index& stokes_dim,
                   const Numeric& f1_dir,
                   const Numeric& f2_dir,
                   ConstMatrixView R_f1,
                   ConstMatrixView R_f2);
 
#endif  // mc_antenna_h