spectral_domain.h

Go to the documentation of this file.

#ifndef SPECTRAL_DOMAIN_H
#define SPECTRAL_DOMAIN_H
#include "printable.h"
#include "unit.h"
#include "array_ad.h"
#include "array_with_unit.h"
#include <blitz/array.h>

namespace FullPhysics {
/****************************************************************/
class SpectralDomain: public Printable<SpectralDomain> {
public:
  enum TypePreference {PREFER_WAVENUMBER, PREFER_WAVELENGTH};

  SpectralDomain(const ArrayAd<double, 1>& Data, 
                 const Unit& U);
  SpectralDomain(const blitz::Array<double, 1>& Data,
                 const Unit& Units = units::inv_cm);
  SpectralDomain(const ArrayWithUnit<double, 1>& Data);
  SpectralDomain(const ArrayAd<double, 1>& Data, 
                 const blitz::Array<int, 1>& Sindex,
                 const Unit& U);
  SpectralDomain(const blitz::Array<double, 1>& Data,
                 const blitz::Array<int, 1>& Sindex,
                 const Unit& Units = units::inv_cm);
  SpectralDomain(const ArrayWithUnit<double, 1>& Data,
                 const blitz::Array<int, 1>& Sindex);

//-----------------------------------------------------------------------
//-----------------------------------------------------------------------

  const blitz::Array<double, 1>& data() const { return data_.value();}

//-----------------------------------------------------------------------
//-----------------------------------------------------------------------

  const ArrayAd<double, 1>& data_ad() const {return data_; }

//-----------------------------------------------------------------------
//-----------------------------------------------------------------------

  const blitz::Array<int, 1>& sample_index() const { return sindex_; }

//-----------------------------------------------------------------------
//-----------------------------------------------------------------------

  const Unit units() const {return units_;}

//-----------------------------------------------------------------------
//-----------------------------------------------------------------------

  const SpectralDomain clone() const { return SpectralDomain(data_.copy(), units_); }

//-----------------------------------------------------------------------
//-----------------------------------------------------------------------

  TypePreference type_preference() const
  {
    return (units_.is_commensurate(units::inv_cm) ? 
            PREFER_WAVENUMBER : PREFER_WAVELENGTH); 
  }

  blitz::Array<double, 1> convert_wave(const Unit& Units) const;
  blitz::Array<double, 1> wavenumber(const Unit& Units = units::inv_cm) const;
  blitz::Array<double, 1> wavelength(const Unit& Units = units::micron) const;
  ArrayWithUnit<double, 1> photon_to_radiance_factor() const;
  void print(std::ostream& Os) const { Os << "SpectralDomain";}

  //-----------------------------------------------------------------------
  // TODO: Add robustness by converting to common unit instead of require ==
  inline bool operator==(const SpectralDomain& A) const
  { return (A.data_ == this->data_) && (A.units_ == this->units_) ; }
  inline bool operator!= (const SpectralDomain& A) const
  { return !(A == *this); }


  SpectralDomain() {}

private:
  ArrayAd<double, 1> data_;
  blitz::Array<int, 1> sindex_;
  Unit units_;
};
}
#endif