Luciad.Models.Rasters.RasterModelHeightProvider Class Reference

A height provider based on a raster model. More...

Inheritance diagram for Luciad.Models.Rasters.RasterModelHeightProvider:

Classes
class	Builder
	Builder for a RasterModelHeightProvider. More...

Public Member Functions
	RasterModelHeightProvider (Luciad.Models.Rasters.RasterModelHeightProvider other)
void	Dispose ()
double?	RetrieveHeightAt (Luciad.Cartesian.Coordinate coordinate, double pixelDensity)
	Retrieve the height data at the provided point at a provided pixel density. More...
double?	RetrieveHeightAt (Luciad.Cartesian.Coordinate coordinate, Luciad.Rasters.PixelDensity pixelDensity)
	Retrieve the height data at the provided point at a provided pixel density. More...

Static Public Member Functions
static Luciad.Models.Rasters.RasterModelHeightProvider.Builder	NewBuilder ()
	Returns a new RasterModelHeightProvider builder. More...

Properties
bool	IsInterpolate [get, set]
	Whether (bilinear) interpolation is used when calculating height values form the source data. More...
Luciad.Geodesy.CoordinateReference	Reference [get]
	The coordinate reference of this height provider. More...

Detailed Description

A height provider based on a raster model.

This class is thread-safe.

Related article: Retrieving height data.

Since

2023.0

Constructor & Destructor Documentation

RasterModelHeightProvider()

Luciad.Models.Rasters.RasterModelHeightProvider.RasterModelHeightProvider ( Luciad.Models.Rasters.RasterModelHeightProvider  other )

inline

Member Function Documentation

Dispose()

void Luciad.Models.Rasters.RasterModelHeightProvider.Dispose ( )

inline

NewBuilder()

static Luciad.Models.Rasters.RasterModelHeightProvider.Builder Luciad.Models.Rasters.RasterModelHeightProvider.NewBuilder ( )

inlinestatic

Returns a new RasterModelHeightProvider builder.

Returns

a new RasterModelHeightProvider builder.

RetrieveHeightAt() [1/2]

double? Luciad.Models.Rasters.RasterModelHeightProvider.RetrieveHeightAt ( Luciad.Cartesian.Coordinate  coordinate, double  pixelDensity  )

inline

Retrieve the height data at the provided point at a provided pixel density.

Looks for a tile in the underlying raster data covering the specified point and with a pixel density equal or lower to the specified density, and returns elevation data based on that tile. If several tiles match, then the most detailed tile is used; if all tiles covering the point have a density higher than requested density, then the least detailed tile is used.

Parameters

coordinate	The point for which the height is requested, expressed in the coordinate reference of the height provider. If the height provider reference is a 2D reference, Z-value is ignored.
pixelDensity	The pixel density used to determine the level of detail to use in the underlying data. Assumed to be in the coordinate reference of the height provider.

Returns

the height expressed in the reference of the height provider, or null if no data is available for this coordinate.

RetrieveHeightAt() [2/2]

double? Luciad.Models.Rasters.RasterModelHeightProvider.RetrieveHeightAt ( Luciad.Cartesian.Coordinate  coordinate, Luciad.Rasters.PixelDensity  pixelDensity  )

inline

Retrieve the height data at the provided point at a provided pixel density.

Looks for a tile in the underlying raster data covering the specified point and with a pixel density equal or lower to the specified density, and returns elevation data based on that tile. If several tiles match, then the most detailed tile is used; if all tiles covering the point have a density higher than requested density, then the least detailed tile is used.

Parameters

coordinate	The point for which the height is requested, expressed in the coordinate reference of the height provider. If the height provider reference is a 2D reference, Z-value is ignored.
pixelDensity	The pixel density used to determine the level of detail to use in the underlying data. Must be in the coordinate reference of the height provider.

Returns

the height expressed in the reference of the height provider, or null if no data is available for this coordinate.

Property Documentation

IsInterpolate

bool Luciad.Models.Rasters.RasterModelHeightProvider.IsInterpolate

getset

Whether (bilinear) interpolation is used when calculating height values form the source data.

[get]

Returns whether (bilinear) interpolation is used when calculating height values form the source data.

[set]

Sets whether (bilinear) interpolation is used when calculating height values form the source data. Using interpolation makes sure that neighbouring height values form a smoother curve.

Reference

Luciad.Geodesy.CoordinateReference Luciad.Models.Rasters.RasterModelHeightProvider.Reference

get

The coordinate reference of this height provider.

[get]

Returns the coordinate reference of this height provider. The input and output of RetrieveHeightAt are all expressed in this reference.