hitran_xsec.h

Go to the documentation of this file.

/* Copyright (C) 2018 Oliver Lemke <oliver.lemke@uni-hamburg.de>

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

#ifndef HITRAN_XSEC_H
#define HITRAN_XSEC_H

#include "arts.h"

#include "array.h"
#include "bifstream.h"
#include "matpackI.h"
#include "messages.h"
#include "mystring.h"

class XsecRecord {
 public:
  Index Species() const { return mspecies; };

  String SpeciesName() const;

  void SetSpecies(const Index species) { mspecies = species; };

  ConstVectorView Coeffs() const { return mcoeffs; };

  ConstVectorView RefPressure() const { return mrefpressure; };

  ConstVectorView RefTemperature() const { return mreftemperature; };

  const ArrayOfVector& Fgrids() const { return mfgrids; };

  const ArrayOfVector& Xsecs() const { return mxsecs; };

  const ArrayOfVector& TemperatureSlope() const { return mtslope; };

  const ArrayOfVector& TemperatureIntersect() const { return mtintersect; };
  
  Vector& Coeffs() { return mcoeffs; };
  
  Vector& RefPressure() { return mrefpressure; };
  
  Vector& RefTemperature() { return mreftemperature; };
  
  ArrayOfVector& Fgrids() { return mfgrids; };
  
  ArrayOfVector& Xsecs() { return mxsecs; };
  
  ArrayOfVector& TemperatureSlope() { return mtslope; };
  
  ArrayOfVector& TemperatureIntersect() { return mtintersect; };

  void Extract(VectorView result,
               ConstVectorView f_grid,
               const Numeric& pressure,
               const Numeric& temperature,
               const Index& apply_tfit,
               const Verbosity& verbosity) const;

  friend void xml_read_from_stream(std::istream& is_xml,
                                   XsecRecord& cr,
                                   bifstream* pbifs,
                                   const Verbosity& verbosity);

 private:
  Index mspecies;
  Vector mcoeffs;
  Vector mrefpressure;
  Vector mreftemperature;
  ArrayOfVector mfgrids;
  ArrayOfVector mxsecs;
  ArrayOfVector mtslope;
  ArrayOfVector mtintersect;
};

typedef Array<XsecRecord> ArrayOfXsecRecord;

Index hitran_xsec_get_index(const ArrayOfXsecRecord& xsec_data,
                            const Index species);

std::ostream& operator<<(std::ostream& os, const XsecRecord& xd);

#endif  // HITRAN_XSEC_H