GriddedField2 Class Reference

#include <gridded_fields.h>

Inheritance diagram for GriddedField2:

Public Member Functions
	GriddedField2 ()
	Construct an empty GriddedField2.
	GriddedField2 (const String &s)
	Construct an empty GriddedField2 with the given name.
bool	checksize () const final
	Consistency check.
void	checksize_strict () const final
	Strict consistency check.
void	resize (const GriddedField2 &gf)
	Make this GriddedField2 the same size as the given one.
void	resize (Index r, Index c)
	Resize the data matrix.
Public Member Functions inherited from GriddedField
virtual	~GriddedField ()=default
	Defaulted con-/de-structors and assignments so unique pointers work w/o warnings.
	GriddedField (const GriddedField &)=default
	GriddedField (GriddedField &&)=default
GriddedField &	operator= (const GriddedField &)=default
GriddedField &	operator= (GriddedField &&)=default
Index	get_dim () const
	Get the dimension of this gridded field.
void	copy_grids (const GriddedField &gf)
	Copy grids.
const String &	get_grid_name (Index i) const
	Get grid name.
Index	get_grid_size (Index i) const
	Get the size of a grid.
GridType	get_grid_type (Index i) const
	Get grid type.
const Vector &	get_numeric_grid (Index i) const
	Get a numeric grid.
Vector &	get_numeric_grid (Index i)
	Get a numeric grid.
const ArrayOfString &	get_string_grid (Index i) const
	Get a string grid.
ArrayOfString &	get_string_grid (Index i)
	Get a string grid.
const String &	get_name () const
	Get the name of this gridded field.
void	set_grid (Index i, const Vector &g)
	Set a numeric grid.
void	set_grid (Index i, const ArrayOfString &g)
	Set a string grid.
void	set_grid_name (Index i, const String &s)
	Set grid name.
void	set_name (const String &s)
	Set name of this gridded field.
virtual bool	checksize () const =0
	Consistency check.
virtual void	checksize_strict () const =0
	Strict consistency check.

Public Attributes
Matrix	data

Friends
std::ostream &	operator<< (std::ostream &os, const GriddedField2 &gf)
String	metaErrorData (const GriddedField2 &gf)

Additional Inherited Members
Protected Member Functions inherited from GriddedField
	GriddedField ()
	Construct an empty GriddedField.
	GriddedField (const Index d, String s)
	Construct a GriddedField.

Detailed Description

Definition at line 337 of file gridded_fields.h.

Constructor & Destructor Documentation

GriddedField2() [1/2]

GriddedField2::GriddedField2 ( )

inline

Construct an empty GriddedField2.

Definition at line 340 of file gridded_fields.h.

GriddedField2() [2/2]

GriddedField2::GriddedField2 ( const String &  s )

inline

Construct an empty GriddedField2 with the given name.

Parameters

[in]

s

Name.

Definition at line 343 of file gridded_fields.h.

Member Function Documentation

checksize()

bool GriddedField2::checksize ( ) const

inlinefinalvirtual

Consistency check.

Check if the sizes of the grids match the data dimension.

This function must be overwritten by the derived classes.

Returns

True if sizes match.

Implements GriddedField.

Definition at line 345 of file gridded_fields.h.

References data, GriddedField::get_grid_size(), ConstMatrixView::ncols(), and ConstMatrixView::nrows().

Referenced by checksize_strict(), and main().

checksize_strict()

void GriddedField2::checksize_strict ( ) const

inlinefinalvirtual

Strict consistency check.

Same as GriddedField::checksize but throws runtime_error in case of error.

Implements GriddedField.

Definition at line 352 of file gridded_fields.h.

References ARTS_USER_ERROR_IF, and checksize().

Referenced by InterpGriddedField2ToPosition(), InterpSurfaceTypeMask(), and xml_read_from_stream().

resize() [1/2]

void GriddedField2::resize ( const GriddedField2 &  gf )

inline

Make this GriddedField2 the same size as the given one.

Parameters

[in]

gf

Source gridded field.

Definition at line 358 of file gridded_fields.h.

References data, GriddedField::get_grid_size(), and Matrix::resize().

Referenced by CIARecord::AppendDataset(), GriddedFieldLatLonExpand(), and GriddedFieldLatLonRegrid().

resize() [2/2]

void GriddedField2::resize ( Index  r, Index  c  )

inline

Resize the data matrix.

See also

Matrix::resize

Definition at line 364 of file gridded_fields.h.

References c, data, and Matrix::resize().

Friends And Related Function Documentation

metaErrorData

String metaErrorData ( const GriddedField2 &  gf )

friend

operator<<

std::ostream & operator<< ( std::ostream &  os, const GriddedField2 &  gf  )

friend

Member Data Documentation

data

Matrix GriddedField2::data

Definition at line 370 of file gridded_fields.h.

Referenced by CIARecord::AppendDataset(), checksize(), cia_interpolation(), FieldFromGriddedField(), GriddedFieldLatLonExpand(), GriddedFieldLatLonRegrid(), InterpGriddedField2ToPosition(), InterpSurfaceTypeMask(), main(), operator<<(), regrid_sun_spectrum(), resize(), test01(), xml_read_from_stream(), xml_write_to_stream(), and z_surfaceFromFileAndGrid().

---

The documentation for this class was generated from the following file:

• gridded_fields.h