LuciadCPillar C# 2024.0.04
Luciad.Rasters.PixelDensity Class Reference

A pixel density represents the number of pixel in raster data over a unit of area in a given coordinate reference. More...

Inheritance diagram for Luciad.Rasters.PixelDensity:

Public Member Functions

 PixelDensity (Luciad.Geodesy.CoordinateReference reference, double value)
 Construct a PixelDensity object. More...
 
void Dispose ()
 

Static Public Member Functions

static Luciad.Rasters.PixelDensity FromSampleDistance (double distanceInMeters, Luciad.Cartesian.Coordinate sampleLocation, Luciad.Geodesy.CoordinateReference pixelDensityReference)
 Creates a pixel density from a sample distance. More...
 

Properties

Luciad.Geodesy.CoordinateReference Reference [get]
 The pixel density coordinate reference. More...
 
double Value [get]
 The pixel density value. More...
 

Detailed Description

A pixel density represents the number of pixel in raster data over a unit of area in a given coordinate reference.

Concretely it's a value with the following units: px² / uom². Here, 'uom' mean the unit of measure of the coordinate reference in which the pixel density is expressed. It is typically meters.

More information on this, and hints on its usages can be fount in the related article: Retrieving height data.

A typical way to create a pixel density is by converting it from a sample distance. Imagine for example that you want to sample elevation data along a line, and get an elevation value every meter. In that case, you can use the FromSampleDistance method to create a pixel density where the distance between every pixel corresponds to 1 meter.

Since
2023.0

Constructor & Destructor Documentation

◆ PixelDensity()

Luciad.Rasters.PixelDensity.PixelDensity ( Luciad.Geodesy.CoordinateReference  reference,
double  value 
)
inline

Construct a PixelDensity object.

Parameters
referencethe coordinate reference, cannot be null
valuethe density value expressed in the given coordinate reference, must be greater than 0

Member Function Documentation

◆ Dispose()

void Luciad.Rasters.PixelDensity.Dispose ( )
inline

◆ FromSampleDistance()

static Luciad.Rasters.PixelDensity Luciad.Rasters.PixelDensity.FromSampleDistance ( double  distanceInMeters,
Luciad.Cartesian.Coordinate  sampleLocation,
Luciad.Geodesy.CoordinateReference  pixelDensityReference 
)
inlinestatic

Creates a pixel density from a sample distance.

The resulting PixelDensity, expressed in the given coordinate reference, is such that the distance between pixels corresponds roughly with the provided distance in meters at the given location.

Parameters
distanceInMetersthe desired distance between two adjacent samples, in meters
sampleLocationthe point at which the distance between samples must be equal to distanceInMeters
pixelDensityReferencethe reference in which sampleLocation, and the resulting PixelDensity, is expressed
Returns
a pixel density that meets the requirements
Exceptions
System.ArgumentExceptionif pixelDensityReference is neither a grid nor a geodetic reference.

Property Documentation

◆ Reference

Luciad.Geodesy.CoordinateReference Luciad.Rasters.PixelDensity.Reference
get

The pixel density coordinate reference.

[get]

Returns the pixel density coordinate reference.

◆ Value

double Luciad.Rasters.PixelDensity.Value
get

The pixel density value.

[get]

Returns the pixel density value.