Class ElevatedSurfaceExposureGenerator

This class computes the elevated surface exposure polygon tree.

Index

Constructors

Accessors

polygon result threshold

Methods

compute compute

Constructors

constructor

new ElevatedSurfaceExposureGenerator(
polygon: PointSourcePolygon<PointSourcePolygonConfig>,
options?: ElevatedSurfaceExposureOptions,
): ElevatedSurfaceExposureGenerator
Parameters
- polygon: PointSourcePolygon<PointSourcePolygonConfig>
  The source polygon the exposure is computed for
- Optionaloptions: ElevatedSurfaceExposureOptions = {}
  The surface exposure options
Returns ElevatedSurfaceExposureGenerator

Accessors

polygon

get polygon(): PointSourcePolygon<PointSourcePolygonConfig>
The source polygon the exposure is computed for.

Returns PointSourcePolygon<PointSourcePolygonConfig>

result

get result(): PolygonTree | null
The result of the computation, which is null if the surface exposure is empty.

Returns PolygonTree | null
Throws
If ElevatedSurfaceExposureGenerator#compute wasn't called yet.

threshold

get threshold(): number
Points with at most this distance (grid units) from the surface are exposed.

Returns number

Methods

compute

compute(): PolygonTree | null
Compute the surface exposure.

Returns PolygonTree | null
The computed elevated surface exposure or null if empty

`Static`compute

compute(
polygon: PointSourcePolygon<PointSourcePolygonConfig>,
options?: ElevatedSurfaceExposureOptions,
): PolygonTree | null
Compute the elevated surface exposure for the given source polygon using the ElevatedSurfaceExposureGenerator.
Parameters
- polygon: PointSourcePolygon<PointSourcePolygonConfig>
  The source polygon the exposure is computed for
- Optionaloptions: ElevatedSurfaceExposureOptions
  The surface exposure options
Returns PolygonTree | null
The computed elevated surface exposure or null if empty