arts-docs-master/doxygen/interpolation_8h_source.html

/* Copyright (C) 2002-2012 Stefan Buehler <sbuehler@ltu.se>


   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 interpolation_h

#define interpolation_h


#include "arts.h"

#include "matpackVII.h"

#include "mystring.h"


struct GridPos {

  Index idx;

  Numeric fd[2];

};


typedef Array<GridPos> ArrayOfGridPos;

typedef Array<Array<GridPos> > ArrayOfArrayOfGridPos;

typedef Array<Array<Array<GridPos> > > ArrayOfArrayOfArrayOfGridPos;

typedef Array<Array<Array<Array<GridPos> > > >

    ArrayOfArrayOfArrayOfArrayOfGridPos;


// Function headers (documentation is in .cc file):


ostream& operator<<(ostream& os, const GridPos& gp);


void gridpos(ArrayOfGridPos& gp,

             ConstVectorView old_grid,

             ConstVectorView new_grid,

             const Numeric& extpolfac = 0.5);


void gridpos(GridPos& gp,

             ConstVectorView old_grid,

             const Numeric& new_grid,

             const Numeric& extpolfac = 0.5);


void gridpos_1to1(ArrayOfGridPos& gp, ConstVectorView grid);


void gridpos_copy(GridPos& gp_new, const GridPos& gp_old);


Numeric fractional_gp(const GridPos& gp);


void gridpos_check_fd(GridPos& gp);


void gridpos_force_end_fd(GridPos& gp, const Index& n);


void gridpos_upperend_check(GridPos& gp, const Index& ie);


void gridpos_upperend_check(ArrayOfGridPos& gp, const Index& ie);


void gp4length1grid(ArrayOfGridPos& gp);


bool is_gridpos_at_index_i(const GridPos& gp,

                           const Index& i,

                           const bool& strict = true);


Index gridpos2gridrange(const GridPos& gp, const bool& upwards);


//                      Red Interpolation


void interpweights(VectorView itw, const GridPos& tc);


void interpweights(VectorView itw, const GridPos& tr, const GridPos& tc);


void interpweights(VectorView itw,

                   const GridPos& tp,

                   const GridPos& tr,

                   const GridPos& tc);


void interpweights(VectorView itw,

                   const GridPos& tb,

                   const GridPos& tp,

                   const GridPos& tr,

                   const GridPos& tc);


void interpweights(VectorView itw,

                   const GridPos& ts,

                   const GridPos& tb,

                   const GridPos& tp,

                   const GridPos& tr,

                   const GridPos& tc);


void interpweights(VectorView itw,

                   const GridPos& tv,

                   const GridPos& ts,

                   const GridPos& tb,

                   const GridPos& tp,

                   const GridPos& tr,

                   const GridPos& tc);


Numeric interp(ConstVectorView itw, ConstVectorView a, const GridPos& tc);


Numeric interp(ConstVectorView itw,

               ConstMatrixView a,

               const GridPos& tr,

               const GridPos& tc);


Numeric interp(ConstVectorView itw,

               ConstTensor3View a,

               const GridPos& tp,

               const GridPos& tr,

               const GridPos& tc);


Numeric interp(ConstVectorView itw,

               ConstTensor4View a,

               const GridPos& tb,

               const GridPos& tp,

               const GridPos& tr,

               const GridPos& tc);


Numeric interp(ConstVectorView itw,

               ConstTensor5View a,

               const GridPos& ts,

               const GridPos& tb,

               const GridPos& tp,

               const GridPos& tr,

               const GridPos& tc);


Numeric interp(ConstVectorView itw,

               ConstTensor6View a,

               const GridPos& tv,

               const GridPos& ts,

               const GridPos& tb,

               const GridPos& tp,

               const GridPos& tr,

               const GridPos& tc);


//                      Blue interpolation


void interpweights(MatrixView itw, const ArrayOfGridPos& cgp);


void interpweights(MatrixView itw,

                   const ArrayOfGridPos& rgp,

                   const ArrayOfGridPos& cgp);


void interpweights(MatrixView itw,

                   const ArrayOfGridPos& pgp,

                   const ArrayOfGridPos& rgp,

                   const ArrayOfGridPos& cgp);


void interpweights(MatrixView itw,

                   const ArrayOfGridPos& bgp,

                   const ArrayOfGridPos& pgp,

                   const ArrayOfGridPos& rgp,

                   const ArrayOfGridPos& cgp);


void interpweights(MatrixView itw,

                   const ArrayOfGridPos& sgp,

                   const ArrayOfGridPos& bgp,

                   const ArrayOfGridPos& pgp,

                   const ArrayOfGridPos& rgp,

                   const ArrayOfGridPos& cgp);


void interpweights(MatrixView itw,

                   const ArrayOfGridPos& vgp,

                   const ArrayOfGridPos& sgp,

                   const ArrayOfGridPos& bgp,

                   const ArrayOfGridPos& pgp,

                   const ArrayOfGridPos& rgp,

                   const ArrayOfGridPos& cgp);


void interp(VectorView ia,

            ConstMatrixView itw,

            ConstVectorView a,

            const ArrayOfGridPos& cgp);


void interp(VectorView ia,

            ConstMatrixView itw,

            ConstMatrixView a,

            const ArrayOfGridPos& rgp,

            const ArrayOfGridPos& cgp);


void interp(VectorView ia,

            ConstMatrixView itw,

            ConstTensor3View a,

            const ArrayOfGridPos& pgp,

            const ArrayOfGridPos& rgp,

            const ArrayOfGridPos& cgp);


void interp(VectorView ia,

            ConstMatrixView itw,

            ConstTensor4View a,

            const ArrayOfGridPos& bgp,

            const ArrayOfGridPos& pgp,

            const ArrayOfGridPos& rgp,

            const ArrayOfGridPos& cgp);


void interp(VectorView ia,

            ConstMatrixView itw,

            ConstTensor5View a,

            const ArrayOfGridPos& sgp,

            const ArrayOfGridPos& bgp,

            const ArrayOfGridPos& pgp,

            const ArrayOfGridPos& rgp,

            const ArrayOfGridPos& cgp);


void interp(VectorView ia,

            ConstMatrixView itw,

            ConstTensor6View a,

            const ArrayOfGridPos& vgp,

            const ArrayOfGridPos& sgp,

            const ArrayOfGridPos& bgp,

            const ArrayOfGridPos& pgp,

            const ArrayOfGridPos& rgp,

            const ArrayOfGridPos& cgp);


//                      Green interpolation


void interpweights(Tensor3View itw,

                   const ArrayOfGridPos& rgp,

                   const ArrayOfGridPos& cgp);


void interpweights(Tensor4View itw,

                   const ArrayOfGridPos& pgp,

                   const ArrayOfGridPos& rgp,

                   const ArrayOfGridPos& cgp);


void interpweights(Tensor5View itw,

                   const ArrayOfGridPos& bgp,

                   const ArrayOfGridPos& pgp,

                   const ArrayOfGridPos& rgp,

                   const ArrayOfGridPos& cgp);


void interpweights(Tensor6View itw,

                   const ArrayOfGridPos& sgp,

                   const ArrayOfGridPos& bgp,

                   const ArrayOfGridPos& pgp,

                   const ArrayOfGridPos& rgp,

                   const ArrayOfGridPos& cgp);


void interpweights(Tensor7View itw,

                   const ArrayOfGridPos& vgp,

                   const ArrayOfGridPos& sgp,

                   const ArrayOfGridPos& bgp,

                   const ArrayOfGridPos& pgp,

                   const ArrayOfGridPos& rgp,

                   const ArrayOfGridPos& cgp);


void interp(MatrixView ia,

            ConstTensor3View itw,

            ConstMatrixView a,

            const ArrayOfGridPos& rgp,

            const ArrayOfGridPos& cgp);


void interp(Tensor3View ia,

            ConstTensor4View itw,

            ConstTensor3View a,

            const ArrayOfGridPos& pgp,

            const ArrayOfGridPos& rgp,

            const ArrayOfGridPos& cgp);


void interp(Tensor4View ia,

            ConstTensor5View itw,

            ConstTensor4View a,

            const ArrayOfGridPos& bgp,

            const ArrayOfGridPos& pgp,

            const ArrayOfGridPos& rgp,

            const ArrayOfGridPos& cgp);


void interp(Tensor5View ia,

            ConstTensor6View itw,

            ConstTensor5View a,

            const ArrayOfGridPos& sgp,

            const ArrayOfGridPos& bgp,

            const ArrayOfGridPos& pgp,

            const ArrayOfGridPos& rgp,

            const ArrayOfGridPos& cgp);


void interp(Tensor6View ia,

            ConstTensor7View itw,

            ConstTensor6View a,

            const ArrayOfGridPos& vgp,

            const ArrayOfGridPos& sgp,

            const ArrayOfGridPos& bgp,

            const ArrayOfGridPos& pgp,

            const ArrayOfGridPos& rgp,

            const ArrayOfGridPos& cgp);


Numeric interp_poly(ConstVectorView x,

                    ConstVectorView y,

                    const Numeric& x_i,

                    const GridPos& gp);


#endif  // interpolation_h

arts.h
The global header file for ARTS.

Array< GridPos >

ConstMatrixView
A constant view of a Matrix.
Definition: matpackI.h:1014

ConstTensor3View
A constant view of a Tensor3.
Definition: matpackIII.h:132

ConstTensor4View
A constant view of a Tensor4.
Definition: matpackIV.h:133

ConstTensor5View
A constant view of a Tensor5.
Definition: matpackV.h:143

ConstTensor6View
A constant view of a Tensor6.
Definition: matpackVI.h:149

ConstTensor7View
A constant view of a Tensor7.
Definition: matpackVII.h:147

ConstVectorView
A constant view of a Vector.
Definition: matpackI.h:489

MatrixView
The MatrixView class.
Definition: matpackI.h:1125

Tensor3View
The Tensor3View class.
Definition: matpackIII.h:239

Tensor4View
The Tensor4View class.
Definition: matpackIV.h:284

Tensor5View
The Tensor5View class.
Definition: matpackV.h:333

Tensor6View
The Tensor6View class.
Definition: matpackVI.h:621

Tensor7View
The Tensor7View class.
Definition: matpackVII.h:1286

VectorView
The VectorView class.
Definition: matpackI.h:626

gridpos2gridrange
Index gridpos2gridrange(const GridPos &gp, const bool &upwards)
gridpos2gridrange
Definition: interpolation.cc:697

is_gridpos_at_index_i
bool is_gridpos_at_index_i(const GridPos &gp, const Index &i, const bool &strict=true)
is_gridpos_at_index_i
Definition: interpolation.cc:657

gridpos
void gridpos(ArrayOfGridPos &gp, ConstVectorView old_grid, ConstVectorView new_grid, const Numeric &extpolfac=0.5)
Set up a grid position Array.
Definition: interpolation.cc:156

gridpos_force_end_fd
void gridpos_force_end_fd(GridPos &gp, const Index &n)
gridpos_force_end_fd
Definition: interpolation.cc:555

gridpos_check_fd
void gridpos_check_fd(GridPos &gp)
gridpos_check_fd
Definition: interpolation.cc:509

gridpos_upperend_check
void gridpos_upperend_check(GridPos &gp, const Index &ie)
gridpos_upperend_check
Definition: interpolation.cc:589

ArrayOfGridPos
Array< GridPos > ArrayOfGridPos
An Array of grid positions.
Definition: interpolation.h:84

ArrayOfArrayOfArrayOfArrayOfGridPos
Array< Array< Array< Array< GridPos > > > > ArrayOfArrayOfArrayOfArrayOfGridPos
Definition: interpolation.h:88

interpweights
void interpweights(VectorView itw, const GridPos &tc)
Red 1D interpolation weights.
Definition: interpolation.cc:741

interp_poly
Numeric interp_poly(ConstVectorView x, ConstVectorView y, const Numeric &x_i, const GridPos &gp)
Polynomial interpolation.
Definition: interpolation.cc:2787

operator<<
ostream & operator<<(ostream &os, const GridPos &gp)
Output operator for GridPos.
Definition: interpolation.cc:96

ArrayOfArrayOfGridPos
Array< Array< GridPos > > ArrayOfArrayOfGridPos
Definition: interpolation.h:85

gp4length1grid
void gp4length1grid(ArrayOfGridPos &gp)
Grid position matching a grid of length 1.
Definition: interpolation.cc:636

interp
Numeric interp(ConstVectorView itw, ConstVectorView a, const GridPos &tc)
Red 1D Interpolate.
Definition: interpolation.cc:970

ArrayOfArrayOfArrayOfGridPos
Array< Array< Array< GridPos > > > ArrayOfArrayOfArrayOfGridPos
Definition: interpolation.h:86

gridpos_copy
void gridpos_copy(GridPos &gp_new, const GridPos &gp_old)
gridpos_copy
Definition: interpolation.cc:473

gridpos_1to1
void gridpos_1to1(ArrayOfGridPos &gp, ConstVectorView grid)
gridpos_1to1
Definition: interpolation.cc:449

fractional_gp
Numeric fractional_gp(const GridPos &gp)
fractional_gp
Definition: interpolation.cc:492

matpackVII.h

Index
INDEX Index
The type to use for all integer numbers and indices.
Definition: matpack.h:39

Numeric
NUMERIC Numeric
The type to use for all floating point numbers.
Definition: matpack.h:33

mystring.h
This file contains the definition of String, the ARTS string class.

a
#define a

GridPos
Structure to store a grid position.
Definition: interpolation.h:73

GridPos::fd
Numeric fd[2]
Definition: interpolation.h:75

GridPos::idx
Index idx
Definition: interpolation.h:74