RVC::RASTEROP::DEPRESSIONFILLER Class Reference

Class to fill depressions in elevation raster. More...

#include <rvc/depressionfiller.h>

List of all members.

Public Member Functions

 DEPRESSIONFILLER ()
 ~DEPRESSIONFILLER ()
ERRVALUE FillAll (const RVC::OBJITEM &ObjItem, SIMPLE_ARRAY< LPOINT2D > *pUnfilledPts=0)
ERRVALUE FillAll (const RVC::OBJITEM &ObjItemSrc, RVC::OBJITEM &ObjItemTgt, SIMPLE_ARRAY< LPOINT2D > *pUnfilledPts=0)
INT32 GetForceFillCells () const
INT32 GetMaxFillCells () const
double GetMaxFillDepth () const
INT32 GetMaxNullCells () const
bool GetPutNullAtUnfilled () const
void SetForceFillCells (UINT32 ForceFillCells)
void SetMaxFillCells (UINT32 MaxFillCells)
void SetMaxFillDepth (double MaxFillDepth)
void SetMaxNullCells (UINT32 MaxNullCells)
void SetPutNullAtUnfilled (bool PutNullAtUnfilled)

Detailed Description

Class to fill depressions in elevation raster.

Provides methods for automatically filling all depressions and for filling individual depression.


Constructor & Destructor Documentation

RVC::RASTEROP::DEPRESSIONFILLER::DEPRESSIONFILLER (  ) 

Constructor.

RVC::RASTEROP::DEPRESSIONFILLER::~DEPRESSIONFILLER (  ) 

Destructor.


Member Function Documentation

ERRVALUE RVC::RASTEROP::DEPRESSIONFILLER::FillAll ( const RVC::OBJITEM ObjItem,
SIMPLE_ARRAY< LPOINT2D > *  pUnfilledPts = 0 
)

Fill all depressions (in place), subject to constraint settings.

Parameters:
ObjItem Elevation raster location
pUnfilledPts Locations of unfilled depression points returned
ERRVALUE RVC::RASTEROP::DEPRESSIONFILLER::FillAll ( const RVC::OBJITEM ObjItemSrc,
RVC::OBJITEM ObjItemTgt,
SIMPLE_ARRAY< LPOINT2D > *  pUnfilledPts = 0 
)

Fill all depressions, subject to constraint settings.

Target raster will be of same type as source, uncompressed, with no pyramid tiers.

Parameters:
ObjItemSrc Source raster location
ObjItemTgt Target raster location (may not be existing object)
pUnfilledPts Locations of unfilled depression points returned
INT32 RVC::RASTEROP::DEPRESSIONFILLER::GetForceFillCells (  )  const [inline]

Get number of cells forced to fill before setting base for maximum depth constraint.

INT32 RVC::RASTEROP::DEPRESSIONFILLER::GetMaxFillCells (  )  const [inline]

Get maximum number of cells to fill for single depression.

double RVC::RASTEROP::DEPRESSIONFILLER::GetMaxFillDepth (  )  const [inline]

Get maximum depth.

INT32 RVC::RASTEROP::DEPRESSIONFILLER::GetMaxNullCells (  )  const [inline]

Get maximum number of null cells in single depression to fill.

bool RVC::RASTEROP::DEPRESSIONFILLER::GetPutNullAtUnfilled (  )  const [inline]

Get setting for whether to put null cells at bottom location of unfilled depressions.

void RVC::RASTEROP::DEPRESSIONFILLER::SetForceFillCells ( UINT32  ForceFillCells  )  [inline]

Set number of cells to fill before setting base for maximum depth constraint.

This avoids having small deep pit/well in depression unduly limiting fill. Default is 100 cells.

Parameters:
ForceFillCells Size to force filling in cells
void RVC::RASTEROP::DEPRESSIONFILLER::SetMaxFillCells ( UINT32  MaxFillCells  )  [inline]

Set maximum depression size to fill.

Default is 10000 cells.

Parameters:
MaxFillCells Maximum fill size in cells
void RVC::RASTEROP::DEPRESSIONFILLER::SetMaxFillDepth ( double  MaxFillDepth  )  [inline]

Set maximum filling depth.

For integer rasters the maximum allowed value is 250. Default is 20.

Parameters:
MaxFillDepth Maximum depth for individual fill step
void RVC::RASTEROP::DEPRESSIONFILLER::SetMaxNullCells ( UINT32  MaxNullCells  )  [inline]

Set maximum size of null area which will be filled.

This allows small null areas which can occur in water areas to be filled. Default is 100 cells.

Parameters:
MaxNullCells Maximum null area size in cells
void RVC::RASTEROP::DEPRESSIONFILLER::SetPutNullAtUnfilled ( bool  PutNullAtUnfilled  )  [inline]

Set whether to put null cell in target raster at locations of unfilled depressions.

Default is to not put null cells.


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

Generated on Sun Oct 7 21:38:48 2012 for TNTsdk 2012 by  doxygen 1.6.1