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. */



/*===========================================================================
  === File description 
  ===========================================================================*/

/*===========================================================================
  === External declarations
  ===========================================================================*/
#ifndef mc_antenna_h
#define mc_antenna_h

#include "arts.h"
#include "rng.h"
#include "matpackI.h"
#include <cmath>
#include <stdexcept>

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);
  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(void) const;      
  void draw_los(VectorView& sampled_rte_los,
                Rng& rng,
                ConstVectorView bore_sight_los) const;
};

ostream& operator<< (ostream& os, const MCAntenna& mca);

Numeric ran_gaussian (
                      Rng& rng, 
                      const Numeric sigma);

#endif  // mc_antenna_h