GDAL

Public Member Functions | List of all members
gdal::viewshed::Viewshed Class Reference

Class to support viewshed raster generation. More...

`#include <viewshed.h>`

## Public Member Functions
| Viewshed (const Options &opts)
| Constructor.
| ~Viewshed ()
| Destructor.
bool | run (GDALRasterBandH hBand, GDALProgressFunc pfnProgress=GDALDummyProgress, void *pProgressArg=nullptr)
| Compute the viewshed of a raster band.
DatasetPtr | output ()
| Fetch a pointer to the created raster band.

## Detailed Description

Class to support viewshed raster generation.

## Constructor & Destructor Documentation

## ◆ Viewshed()

gdal::viewshed::Viewshed::Viewshed | ( | const Options & | opts | ) |
| explicit

Constructor.

Parameters

  opts | Options to use when calculating viewshed.

## Member Function Documentation

## ◆ output()

DatasetPtr gdal::viewshed::Viewshed::output | ( |  | ) |
| inline

Fetch a pointer to the created raster band.

Returns
  Unique pointer to the viewshed dataset.

## ◆ run()

bool gdal::viewshed::Viewshed::run | ( | GDALRasterBandH | band,
|  | GDALProgressFunc | pfnProgress = `GDALDummyProgress`,
|  | void * | pProgressArg = `nullptr`
| ) |  |

Compute the viewshed of a raster band.

Parameters

  band | Pointer to the raster band to be processed.
  pfnProgress | Pointer to the progress function. Can be null.
  pProgressArg | Argument passed to the progress function

Returns
  True on success, false otherwise.

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

- viewshed.h
- viewshed.cpp