RayleighModelOff.h

Go to the documentation of this file.

#ifndef _atm_RayleighModelOff_h_
#define _atm_RayleighModelOff_h_


#include <atm/VRayleighModel.h>
#include <vector>
#include <limits>


namespace utl {
  class TabulatedFunctionErrors;
}

namespace atm {

  class ScatteringResult;
  class AttenuationResult;


  class RayleighModelOff : public VRayleighModel {

  public:
    virtual ~RayleighModelOff() { }

    atm::ScatteringResult
    EvaluateRayleighScattering(const utl::Point& xA,
                               const utl::Point& xB,
                               const double angle,
                               const double distance,
                               const std::vector<double>& wLength) const;

    atm::ScatteringResult
    EvaluateRayleighScattering(const utl::Point& xA,
                               const utl::Point& xB,
                               const double angle,
                               const double distance,
                               const atm::AttenuationResult& raylAtt) const;

    atm::AttenuationResult EvaluateRayleighAttenuation(const utl::Point& xInit,
                                                       const utl::Point& xFinal,
                                                       const std::vector<double>& wLength) const;

    double
    EvaluateRayleighScattering(const utl::Point& /*xA*/,
                               const utl::Point& /*xB*/,
                               const double /*angle*/,
                               const double /*distance*/,
                               const double /*wLength*/) const
    { return 0; }

    double
    EvaluateRayleighScattering(const utl::Point& /*xA*/,
                               const utl::Point& /*xB*/,
                               const double /*angle*/,
                               const double /*distance*/,
                               const double /*wLength*/,
                               const double /*raylAtt*/) const
    { return 0; }

    double
    EvaluateRayleighAttenuation(const utl::Point& /*xInit*/,
                                const utl::Point& /*xFinal*/,
                                const double /*wLength*/) const
    { return 1; }

    double
    GetAttenuationLength(const utl::Point& /*p*/,
                         const double /*wLength*/) const
    { return std::numeric_limits<double>::max(); }

    utl::TabulatedFunctionErrors
    GetAttenuationLength(const utl::Point& p,
                         const std::vector<double>& wLength) const;

    double
    EvaluateScatteringAngle(const utl::Point& /*p*/,
                            const double /*angle*/,
                            const double /*wLength*/) const
    { return 0; }

    void Init() { }

    bool HasData() const { return true; }

    REGISTER_MODEL(atm::VRayleighModel, "off", RayleighModelOff);
  };

}


#endif

// Configure (x)emacs for this file ...
// Local Variables:
// mode: c++
// compile-command: "make -C .. -k"
// End: