#include <heightfield_util.h>

Public Member Functions
void	blur (number alpha, size_t numIterations)
	Smoothens the field by adjusting the value of each pixel towards the average of its neighbours. More...

const vector2 &	cell_size () const

std::pair< int, int >	coordinate_to_index (number x, number y) const
	returns the index-tuple of the closest field-entry More...

bool	eliminate_invalid_cells ()
	eliminates invalid cells by repeatedly filling those cells with averages of neighboring cells More...

vector2	extent () const
	returns the x- and y-extent of the heightfield More...

Field< number > &	field ()

const Field< number > &	field () const

	Heightfield ()

vector2	index_to_coordinate (int ix, int iy) const
	returns the coordinate of the given cell (specified through an index-tuple) More...

void	move (const vector2 &v)

number	no_data_value () const

const vector2 &	offset () const

void	set_cell_size (const vector2 &s)

void	set_no_data_value (number val)

void	set_offset (const vector2 &o)


number	interpolate (number x, number y, int interpOrder) const
	returns the interpolated value at the given location. More...

number	interpolate (const vector2 &c, int interpOrder) const
	returns the interpolated value at the given location. More...

number	interpolate (number x, number y) const
	returns the interpolated value at the given location. More...

number	interpolate (const vector2 &c) const
	returns the interpolated value at the given location. More...

Private Member Functions
template<class Archive >
void	serialize (Archive &ar, const unsigned int version)

Private Attributes
vector2	m_cellSize

Field< number >	m_field

number	m_noDataValue

vector2	m_offset

Friends
class	boost::serialization::access

Detailed Description

A heightfield represents a grid of number-values together with descriptors for the cell dimensions and the total offset. You can manually create heightfields or load them from a file. Given a heightfield you may create a quad/tri grid or extract the heightfields boundary into a grid. Have a look at field_util.h, too, which declares some useful functions (e.g. blurring).

See also: LoadHeightfieldFromASC, CreateGridFromField, CreateGridFromFieldBoundary

Constructor & Destructor Documentation

◆ Heightfield()

ug::Heightfield::Heightfield ( )

Member Function Documentation

◆ blur()

void ug::Heightfield::blur	(	number	alpha,
		size_t	numIterations
	)

Smoothens the field by adjusting the value of each pixel towards the average of its neighbours.

References alpha, ug::BlurField(), field(), and no_data_value().

◆ cell_size()

const vector2& ug::Heightfield::cell_size ( ) const

inline

References m_cellSize.

Referenced by ug::CreateGridFromField(), ug::CreateGridFromFieldBoundary(), ug::RasterLayers::invalidate_small_lenses(), and ug::RasterLayers::remove_small_holes().

◆ coordinate_to_index()

std::pair< int, int > ug::Heightfield::coordinate_to_index	(	number	x,
		number	y
	)		const

returns the index-tuple of the closest field-entry

References m_cellSize, and m_offset.

Referenced by interpolate(), ug::RasterLayers::remove_small_holes(), and ug::SnapToHorizontalRaster().

◆ eliminate_invalid_cells()

bool ug::Heightfield::eliminate_invalid_cells ( )

eliminates invalid cells by repeatedly filling those cells with averages of neighboring cells

The field has to contain at least one valid cell. If it doesn't, false is returned.

References ug::EliminateInvalidCells(), field(), and no_data_value().

◆ extent()

vector2 ug::Heightfield::extent ( ) const

returns the x- and y-extent of the heightfield

References ug::Field< T >::height(), m_cellSize, m_field, and ug::Field< T >::width().

◆ field() [1/2]

Field<number>& ug::Heightfield::field ( )

inline

References m_field.

Referenced by blur(), ug::RasterLayers::construct_relative_to_global_height_table(), ug::CreateGridFromField(), ug::CreateGridFromFieldBoundary(), eliminate_invalid_cells(), ug::RasterLayers::eliminate_invalid_cells(), ug::RasterLayers::invalidate_flat_cells(), ug::RasterLayers::invalidate_small_lenses(), ug::LoadHeightfieldFromASC(), ug::RasterLayers::remove_small_holes(), and ug::RasterLayers::snap_cells_to_higher_layers().

◆ field() [2/2]

const Field<number>& ug::Heightfield::field ( ) const

inline

References m_field.

◆ index_to_coordinate()

vector2 ug::Heightfield::index_to_coordinate	(	int	ix,
		int	iy
	)		const

returns the coordinate of the given cell (specified through an index-tuple)

References m_cellSize, and m_offset.

Referenced by ug::RasterLayers::construct_relative_to_global_height_table(), ug::RasterLayers::invalidate_flat_cells(), ug::RasterLayers::remove_small_holes(), ug::RasterLayers::snap_cells_to_higher_layers(), and ug::SnapToHorizontalRaster().

◆ interpolate() [1/4]

number ug::Heightfield::interpolate ( const vector2 & c ) const

inline

returns the interpolated value at the given location.

returns the interpolated value at the given location. Through 'interpOrder' one may specify the order of interpolation:

0: piecewise constant (nearest entry)
1: linear

Todo:: : add a method 'set_interpolation_method' to also support bilinear- or spline-interpolation

References interpolate().

◆ interpolate() [2/4]

number ug::Heightfield::interpolate	(	const vector2 &	c,
		int	interpOrder
	)		const

inline

returns the interpolated value at the given location.

returns the interpolated value at the given location. Through 'interpOrder' one may specify the order of interpolation:

0: piecewise constant (nearest entry)
1: linear

Todo:: : add a method 'set_interpolation_method' to also support bilinear- or spline-interpolation

References interpolate().

◆ interpolate() [3/4]

number ug::Heightfield::interpolate	(	number	x,
		number	y
	)		const

inline

returns the interpolated value at the given location.

returns the interpolated value at the given location. Through 'interpOrder' one may specify the order of interpolation:

0: piecewise constant (nearest entry)
1: linear

Todo:: : add a method 'set_interpolation_method' to also support bilinear- or spline-interpolation

References interpolate().

◆ interpolate() [4/4]

number ug::Heightfield::interpolate	(	number	x,
		number	y,
		int	interpOrder
	)		const

returns the interpolated value at the given location.

returns the interpolated value at the given location. Through 'interpOrder' one may specify the order of interpolation:

0: piecewise constant (nearest entry)
1: linear

Todo:: : add a method 'set_interpolation_method' to also support bilinear- or spline-interpolation

References ug::Field< T >::at(), coordinate_to_index(), ug::Field< T >::height(), m_cellSize, m_field, m_noDataValue, m_offset, UG_THROW, and ug::Field< T >::width().

Referenced by ug::ExtrudeLayersMixed(), interpolate(), ug::RasterLayers::invalidate_flat_cells(), and ug::RasterLayers::snap_cells_to_higher_layers().

◆ move()

void ug::Heightfield::move ( const vector2 & v )

inline

References m_offset.

◆ no_data_value()

number ug::Heightfield::no_data_value ( ) const

inline

References m_noDataValue.

Referenced by blur(), ug::RasterLayers::construct_relative_to_global_height_table(), ug::CreateGridFromField(), ug::CreateGridFromFieldBoundary(), eliminate_invalid_cells(), ug::RasterLayers::eliminate_invalid_cells(), ug::ExtrudeLayers(), ug::ExtrudeLayersMixed(), ug::RasterLayers::invalidate_flat_cells(), ug::ProjectToLayer(), ug::RasterLayers::remove_small_holes(), and ug::RasterLayers::snap_cells_to_higher_layers().

◆ offset()

const vector2& ug::Heightfield::offset ( ) const

inline

References m_offset.

Referenced by ug::CreateGridFromField(), and ug::CreateGridFromFieldBoundary().

◆ serialize()

template<class Archive >

void ug::Heightfield::serialize	(	Archive &	ar,
		const unsigned int	version
	)

inlineprivate

References m_cellSize, m_field, m_noDataValue, and m_offset.

◆ set_cell_size()

void ug::Heightfield::set_cell_size ( const vector2 & s )

inline

References m_cellSize, and s.

Referenced by ug::LoadHeightfieldFromASC().

◆ set_no_data_value()

void ug::Heightfield::set_no_data_value ( number val )

inline

References m_noDataValue.

Referenced by ug::LoadHeightfieldFromASC().

◆ set_offset()

void ug::Heightfield::set_offset ( const vector2 & o )

inline

References m_offset.

Referenced by ug::LoadHeightfieldFromASC().

Friends And Related Function Documentation

◆ boost::serialization::access

friend class boost::serialization::access

friend

Member Data Documentation

◆ m_cellSize

vector2 ug::Heightfield::m_cellSize

private

Referenced by cell_size(), coordinate_to_index(), extent(), index_to_coordinate(), interpolate(), serialize(), and set_cell_size().

◆ m_field

Field<number> ug::Heightfield::m_field

private

Referenced by extent(), field(), interpolate(), and serialize().

◆ m_noDataValue

number ug::Heightfield::m_noDataValue

private

Referenced by interpolate(), no_data_value(), serialize(), and set_no_data_value().

◆ m_offset

vector2 ug::Heightfield::m_offset

private

Referenced by coordinate_to_index(), index_to_coordinate(), interpolate(), move(), offset(), serialize(), and set_offset().

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

ugbase/lib_grid/algorithms/heightfield_util.h
ugbase/lib_grid/algorithms/heightfield_util.cpp

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Heightfield()

Member Function Documentation

◆ blur()

◆ cell_size()

◆ coordinate_to_index()

◆ eliminate_invalid_cells()

◆ extent()

◆ field() [1/2]

◆ field() [2/2]

◆ index_to_coordinate()

◆ interpolate() [1/4]

◆ interpolate() [2/4]

◆ interpolate() [3/4]

◆ interpolate() [4/4]

◆ move()

◆ no_data_value()

◆ offset()

◆ serialize()

◆ set_cell_size()

◆ set_no_data_value()

◆ set_offset()

Friends And Related Function Documentation

◆ boost::serialization::access

Member Data Documentation

◆ m_cellSize

◆ m_field

◆ m_noDataValue

◆ m_offset