#include <gridded_fields.h>

Inheritance diagram for GriddedField:

Public Member Functions
virtual	~GriddedField ()=default
	Defaulted con-/de-structors and assignments so unique pointers work w/o warnings. More...

	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. More...

void	copy_grids (const GriddedField &gf)
	Copy grids. More...

const String &	get_grid_name (Index i) const
	Get grid name. More...

Index	get_grid_size (Index i) const
	Get the size of a grid. More...

GridType	get_grid_type (Index i) const
	Get grid type. More...

const Vector &	get_numeric_grid (Index i) const
	Get a numeric grid. More...

Vector &	get_numeric_grid (Index i)
	Get a numeric grid. More...

const ArrayOfString &	get_string_grid (Index i) const
	Get a string grid. More...

ArrayOfString &	get_string_grid (Index i)
	Get a string grid. More...

const String &	get_name () const
	Get the name of this gridded field. More...

void	set_grid (Index i, const Vector &g)
	Set a numeric grid. More...

void	set_grid (Index i, const ArrayOfString &g)
	Set a string grid. More...

void	set_grid_name (Index i, const String &s)
	Set grid name. More...

void	set_name (const String &s)
	Set name of this gridded field. More...

virtual bool	checksize () const =0
	Consistency check. More...

virtual void	checksize_strict () const =0
	Strict consistency check. More...

Protected Member Functions
	GriddedField ()
	Construct an empty GriddedField. More...

	GriddedField (const Index d, String s)
	Construct a GriddedField. More...

Private Attributes
Index	dim

String	mname

Array< GridType >	mgridtypes

ArrayOfString	mgridnames

Array< ArrayOfString >	mstringgrids

ArrayOfVector	mnumericgrids

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

Detailed Description

Abstract base class for gridded fields.

Definition at line 157 of file gridded_fields.h.

Constructor & Destructor Documentation

◆ GriddedField() [1/4]

GriddedField::GriddedField ( )

inlineprotected

Construct an empty GriddedField.

The constructor for GriddedField is protected because it is only used internally by the derived classed.

Definition at line 172 of file gridded_fields.h.

◆ GriddedField() [2/4]

GriddedField::GriddedField	(	const Index	d,
		String	s
	)

inlineprotected

Construct a GriddedField.

Constructs a GriddedField with the given dimension and name.

The constructor for GriddedField is protected because it is only used internally by the derived classes.

Parameters

[in]	d	Dimension.
[in]	s	Name.

Definition at line 191 of file gridded_fields.h.

◆ ~GriddedField()

virtual GriddedField::~GriddedField ( )

virtualdefault

Defaulted con-/de-structors and assignments so unique pointers work w/o warnings.

◆ GriddedField() [3/4]

GriddedField::GriddedField ( const GriddedField & )

default

◆ GriddedField() [4/4]

GriddedField::GriddedField ( GriddedField && )

default

Member Function Documentation

◆ checksize()

virtual bool GriddedField::checksize ( ) const

pure virtual

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.

Implemented in GriddedField1, GriddedField2, GriddedField3, GriddedField4, GriddedField5, and GriddedField6.

◆ checksize_strict()

virtual void GriddedField::checksize_strict ( ) const

pure virtual

Strict consistency check.

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

Implemented in GriddedField1, GriddedField2, GriddedField3, GriddedField4, GriddedField5, and GriddedField6.

◆ copy_grids()

void GriddedField::copy_grids ( const GriddedField & gf )

Copy grids.

Copies the grids from the given GriddedField to the current one.

Parameters

[in] gf Source gridded field

Definition at line 59 of file gridded_fields.cc.

References ARTS_ASSERT, dim, get_dim(), get_grid_type(), get_numeric_grid(), get_string_grid(), GRID_TYPE_NUMERIC, GRID_TYPE_STRING, mgridtypes, mnumericgrids, and mstringgrids.

◆ get_dim()

Index GriddedField::get_dim ( ) const

inline

Get the dimension of this gridded field.

Returns: Dimension.

Definition at line 210 of file gridded_fields.h.

References dim.

Referenced by chk_griddedfield_gridname(), copy_grids(), xml_read_from_stream(), and xml_write_to_stream().

◆ get_grid_name()

const String & GriddedField::get_grid_name ( Index i ) const

inline

Get grid name.

Returns the name of the grid with index i.

Parameters

[in] i Grid index.

Returns: Grid name.

Definition at line 221 of file gridded_fields.h.

References mgridnames.

Referenced by chk_griddedfield_gridname(), GriddedFieldLatLonExpand(), GriddedFieldLatLonRegrid(), GriddedFieldLatLonRegridHelper(), GriddedFieldPRegrid(), GriddedFieldPRegridHelper(), GriddedFieldZToPRegrid(), and xml_write_to_stream().

◆ get_grid_size()

Index GriddedField::get_grid_size ( Index i ) const

inline

Get the size of a grid.

Returns the size of grid i.

Parameters

[in] i Grid index.

Returns: Grid size.

Definition at line 230 of file gridded_fields.h.

References ARTS_ASSERT, dim, GRID_TYPE_NUMERIC, GRID_TYPE_STRING, mgridtypes, mnumericgrids, mstringgrids, and Array< base >::nelem().

Referenced by GriddedField1::checksize(), GriddedField2::checksize(), GriddedField3::checksize(), GriddedField4::checksize(), GriddedField5::checksize(), GriddedField6::checksize(), GriddedFieldLatLonRegrid(), GriddedFieldLatLonRegridHelper(), GriddedField1::resize(), GriddedField2::resize(), GriddedField3::resize(), GriddedField4::resize(), GriddedField5::resize(), and GriddedField6::resize().

◆ get_grid_type()

GridType GriddedField::get_grid_type ( Index i ) const

inline

Get grid type.

Returns the type of the grid with index i.

Parameters

[in] i Grid index.

Returns: Grid type.

Definition at line 252 of file gridded_fields.h.

References mgridtypes.

Referenced by copy_grids(), and xml_write_to_stream().

◆ get_name()

const String & GriddedField::get_name ( ) const

inline

Get the name of this gridded field.

Returns: Gridded field name.

Definition at line 264 of file gridded_fields.h.

References mname.

Referenced by chk_griddedfield_gridname(), main(), and xml_write_to_stream().

◆ get_numeric_grid() [1/2]

Vector & GriddedField::get_numeric_grid ( Index i )

Get a numeric grid.

Returns the numeric grid with index i.

Throws a runtime error if grid i is not of type Numeric.

Parameters

[in] i Grid index.

Returns: Numeric grid.

Definition at line 105 of file gridded_fields.cc.

References ARTS_ASSERT, ARTS_USER_ERROR_IF, dim, GRID_TYPE_NUMERIC, mgridnames, mgridtypes, mname, mnumericgrids, and var_string().

◆ get_numeric_grid() [2/2]

const Vector & GriddedField::get_numeric_grid ( Index i ) const

Get a numeric grid.

Returns the numeric grid with index i.

Throws a runtime error if grid i is not of type Numeric.

Parameters

[in] i Grid index.

Returns: Numeric grid.

Definition at line 87 of file gridded_fields.cc.

References ARTS_ASSERT, ARTS_USER_ERROR_IF, dim, GRID_TYPE_NUMERIC, mgridnames, mgridtypes, mname, mnumericgrids, and var_string().

Referenced by antenna1d_matrix(), antenna2d_gridded_dlos(), antenna2d_interp_response(), AntennaConstantGaussian1D(), atm_fields_compactAddSpecies(), atm_fields_compactCreateFromField(), AtmFieldsCalc(), chk_pnd_data(), cia_interpolation(), complex_n_interp(), copy_grids(), FieldFromGriddedField(), FieldFromGriddedFieldCheckLatLonHelper(), GriddedFieldLatLonExpand(), GriddedFieldLatLonRegrid(), GriddedFieldLatLonRegridHelper(), GriddedFieldPRegrid(), GriddedFieldPRegridHelper(), GriddedFieldZToPRegrid(), GriddedFieldZToPRegridHelper(), InterpGriddedField2ToPosition(), MagFieldsCalc(), mixer_matrix(), regrid_star_spectrum(), sensor_responseAntenna(), sensor_responseMixer(), surface_complex_refr_indexFromGriddedField5(), surface_reflectivityFromGriddedField6(), surface_scalar_reflectivityFromGriddedField4(), surface_typeInterpTypeMask(), WindFieldsCalc(), xml_write_to_stream(), ybatchMetProfiles(), and ybatchMetProfilesClear().

◆ get_string_grid() [1/2]

ArrayOfString & GriddedField::get_string_grid ( Index i )

Get a string grid.

Returns the string grid with index i.

Throws a runtime error if grid i is not of type String.

Parameters

[in] i Grid index.

Returns: String grid.

Definition at line 141 of file gridded_fields.cc.

References ARTS_ASSERT, ARTS_USER_ERROR_IF, dim, GRID_TYPE_STRING, mgridnames, mgridtypes, mname, mstringgrids, and var_string().

◆ get_string_grid() [2/2]

const ArrayOfString & GriddedField::get_string_grid ( Index i ) const

Get a string grid.

Returns the string grid with index i.

Throws a runtime error if grid i is not of type String.

Parameters

[in] i Grid index.

Returns: String grid.

Definition at line 123 of file gridded_fields.cc.

References ARTS_ASSERT, ARTS_USER_ERROR_IF, dim, GRID_TYPE_STRING, mgridnames, mgridtypes, mname, mstringgrids, and var_string().

Referenced by antenna1d_matrix(), antenna2d_gridded_dlos(), antenna2d_interp_response(), atm_fields_compactAddConstant(), atm_fields_compactCleanup(), atm_fields_compactExpand(), copy_grids(), sensor_responseAntenna(), and xml_write_to_stream().

◆ operator=() [1/2]

GriddedField & GriddedField::operator= ( const GriddedField & )

default

◆ operator=() [2/2]

GriddedField & GriddedField::operator= ( GriddedField && )

default

◆ set_grid() [1/2]

void GriddedField::set_grid	(	Index	i,
		const ArrayOfString &	g
	)

Set a string grid.

Sets grid i to the given grid.

Parameters

[in]	i	Grid index.
[in]	g	New grid.

Definition at line 171 of file gridded_fields.cc.

References ARTS_ASSERT, dim, GRID_TYPE_STRING, mgridtypes, mnumericgrids, and mstringgrids.

◆ set_grid() [2/2]

void GriddedField::set_grid	(	Index	i,
		const Vector &	g
	)

Set a numeric grid.

Sets grid i to the given grid.

Parameters

[in]	i	Grid index.
[in]	g	New grid.

Definition at line 157 of file gridded_fields.cc.

References ARTS_ASSERT, dim, GRID_TYPE_NUMERIC, mgridtypes, mnumericgrids, and mstringgrids.

Referenced by antenna_responseGaussian(), antenna_responseVaryingGaussian(), CIARecord::AppendDataset(), atm_fields_compactCreateFromField(), atm_fields_compactFromMatrix(), complex_refr_indexConstant(), complex_refr_indexIceMatzler06(), complex_refr_indexTemperatureConstant(), complex_refr_indexWaterLiebe93(), complex_refr_indexWaterVisibleNIRHarvey98(), GriddedFieldLatLonExpand(), GriddedFieldLatLonRegrid(), GriddedFieldLatLonRegridHelper(), GriddedFieldPRegrid(), GriddedFieldPRegridHelper(), GriddedFieldZToPRegrid(), HydrotableCalc(), iyIndependentBeamApproximation(), main(), sensor_responseGenericAMSU(), sensor_responseSimpleAMSU(), surface_complex_refr_indexFromGriddedField5(), test01(), and xml_read_from_stream().

◆ set_grid_name()

void GriddedField::set_grid_name	(	Index	i,
		const String &	s
	)

inline

Set grid name.

Sets the name with the given index.

Parameters

[in]	i	Grid index.
[in]	s	Grid name.

Definition at line 277 of file gridded_fields.h.

References ARTS_ASSERT, dim, and mgridnames.

Referenced by antenna_responseGaussian(), antenna_responseVaryingGaussian(), CIARecord::AppendDataset(), complex_refr_indexConstant(), complex_refr_indexIceMatzler06(), complex_refr_indexTemperatureConstant(), complex_refr_indexWaterLiebe93(), complex_refr_indexWaterVisibleNIRHarvey98(), GriddedFieldLatLonExpand(), GriddedFieldLatLonRegrid(), GriddedFieldLatLonRegridHelper(), GriddedFieldPRegrid(), GriddedFieldPRegridHelper(), GriddedFieldZToPRegrid(), HydrotableCalc(), iyIndependentBeamApproximation(), main(), sensor_responseGenericAMSU(), sensor_responseSimpleAMSU(), surface_complex_refr_indexFromGriddedField5(), and xml_read_from_stream().

◆ set_name()

void GriddedField::set_name ( const String & s )

inline

Set name of this gridded field.

Parameters

[in] s Gridded field name.

Definition at line 284 of file gridded_fields.h.

References mname.

Referenced by antenna_responseGaussian(), antenna_responseVaryingGaussian(), HydrotableCalc(), iyIndependentBeamApproximation(), main(), sensor_responseGenericAMSU(), sensor_responseSimpleAMSU(), and xml_read_from_stream().

Friends And Related Function Documentation

◆ operator<<

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

friend

Member Data Documentation

◆ dim

Index GriddedField::dim

private

Definition at line 159 of file gridded_fields.h.

Referenced by copy_grids(), get_dim(), get_grid_size(), get_numeric_grid(), get_string_grid(), operator<<(), set_grid(), and set_grid_name().

◆ mgridnames

ArrayOfString GriddedField::mgridnames

private

Definition at line 162 of file gridded_fields.h.

Referenced by get_grid_name(), get_numeric_grid(), get_string_grid(), operator<<(), and set_grid_name().

◆ mgridtypes

Array<GridType> GriddedField::mgridtypes

private

Definition at line 161 of file gridded_fields.h.

Referenced by copy_grids(), get_grid_size(), get_grid_type(), get_numeric_grid(), get_string_grid(), operator<<(), and set_grid().

◆ mname

String GriddedField::mname

private

Definition at line 160 of file gridded_fields.h.

Referenced by get_name(), get_numeric_grid(), get_string_grid(), operator<<(), and set_name().

◆ mnumericgrids

ArrayOfVector GriddedField::mnumericgrids

private

Definition at line 164 of file gridded_fields.h.

Referenced by copy_grids(), get_grid_size(), get_numeric_grid(), operator<<(), and set_grid().

◆ mstringgrids

Array<ArrayOfString> GriddedField::mstringgrids

private

Definition at line 163 of file gridded_fields.h.

Referenced by copy_grids(), get_grid_size(), get_string_grid(), operator<<(), and set_grid().

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

Public Member Functions

Protected Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ GriddedField() [1/4]

◆ GriddedField() [2/4]

◆ ~GriddedField()

◆ GriddedField() [3/4]

◆ GriddedField() [4/4]

Member Function Documentation

◆ checksize()

◆ checksize_strict()

◆ copy_grids()

◆ get_dim()

◆ get_grid_name()

◆ get_grid_size()

◆ get_grid_type()

◆ get_name()

◆ get_numeric_grid() [1/2]

◆ get_numeric_grid() [2/2]

◆ get_string_grid() [1/2]

◆ get_string_grid() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ set_grid() [1/2]

◆ set_grid() [2/2]

◆ set_grid_name()

◆ set_name()

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ dim

◆ mgridnames

◆ mgridtypes

◆ mname

◆ mnumericgrids

◆ mstringgrids