LSDTopoTools
 All Classes Files Functions Variables Friends Pages
Public Member Functions | Protected Attributes | List of all members
LSDHollow Class Reference

Object to store information about hollows and generate hollow average metrics. More...

#include <LSDHollow.hpp>

Public Member Functions

 LSDHollow (int Junction, LSDFlowInfo &FlowInfo, LSDJunctionNetwork &ChanNet)
 Default constructor method used to create a hollow object. More...
 
int get_NRows () const
 
int get_NCols () const
 
float get_XMinimum () const
 
float get_YMinimum () const
 
float get_DataResolution () const
 
int get_NoDataValue () const
 
vector< int > get_HollowNodes () const
 
int get_NumberOfCells () const
 
float get_Area () const
 
int get_Junction () const
 
bool get_Beheaded () const
 
int get_Outlet_i () const
 
int get_Outlet_j () const
 
int get_Centroid_i () const
 
int get_Centroid_j () const
 
float get_SlopeMean () const
 
float get_ElevationMean () const
 
float get_AspectMean () const
 
float get_ReliefMean () const
 
float get_PlanCurvMean () const
 
float get_ProfileCurvMean () const
 
float get_TotalCurvMean () const
 
float get_PlanCurvMax () const
 
float get_ProfileCurvMax () const
 
float get_TotalCurvMax () const
 
vector< int > get_Perimeter_i () const
 
vector< int > get_Perimeter_j () const
 
float get_CHTMean () const
 
float get_SoilProduction () const
 
float get_BasalAge () const
 
float get_Width () const
 
float get_DownslopeLength () const
 
float get_LongProfileLength () const
 
float CalculateHollowMean (LSDFlowInfo &FlowInfo, LSDRaster Data)
 Calculate the mean value of an LSDRaster which falls inside a hollow. More...
 
float CalculateHollowMax (LSDFlowInfo &FlowInfo, LSDRaster Data)
 Calculate the max value of an LSDRaster which falls inside a hollow. More...
 
Array2D< float > get_Raster_Data_For_Hollow (LSDFlowInfo &FlowInfo, LSDRaster Data)
 Return the LSDRaster data from within a hollow as an array. More...
 
Array2D< int > get_Raster_Data_For_Hollow (LSDFlowInfo &FlowInfo, LSDIndexRaster Data)
 Return the LSDIndexRaster data from within a hollow as an array. More...
 
void set_SlopeMean (LSDFlowInfo &FlowInfo, LSDRaster Slope)
 Set the mean slope of a hollow. More...
 
void set_ElevationMean (LSDFlowInfo &FlowInfo, LSDRaster Elevation)
 Set the mean Elevation of a hollow. More...
 
void set_ReliefMean (LSDFlowInfo &FlowInfo, LSDRaster Relief)
 Set the mean Relief of a hollow. More...
 
void set_PlanCurvMean (LSDFlowInfo &FlowInfo, LSDRaster PlanCurv)
 Set the mean PlanCurve of a hollow. More...
 
void set_ProfileCurvMean (LSDFlowInfo &FlowInfo, LSDRaster ProfileCurv)
 Set the mean ProfCurv of a hollow. More...
 
void set_TotalCurvMean (LSDFlowInfo &FlowInfo, LSDRaster TotalCurv)
 Set the mean TotalCurv of a hollow. More...
 
void set_PlanCurvMax (LSDFlowInfo &FlowInfo, LSDRaster PlanCurv)
 Set the max PlanCurve of a hollow. More...
 
void set_ProfileCurvMax (LSDFlowInfo &FlowInfo, LSDRaster ProfileCurv)
 Set the max ProfCurv of a hollow. More...
 
void set_TotalCurvMax (LSDFlowInfo &FlowInfo, LSDRaster TotalCurv)
 Set the max TotalCurv of a hollow. More...
 
void set_CHTMean (LSDFlowInfo &FlowInfo, LSDRaster CHT)
 Set the mean hilltop curvature of a hollow. More...
 
void set_AspectMean (LSDFlowInfo &FlowInfo, LSDRaster Aspect)
 Set the mean aspect of a hollow. More...
 
void set_Perimeter (LSDFlowInfo &FlowInfo)
 Set the perimeter pixels using a simple edge detection algorithm. More...
 
void set_SoilProduction (float SoilProdRate)
 Set the Soil production rate. More...
 
void set_BasalAge (float basal_age)
 Set the basal age. More...
 
void set_All_Parameters (LSDRaster &Elevation, LSDFlowInfo &FlowInfo, LSDRaster &CHT, LSDRaster &Relief, float window_radius, float SoilProduction=-9999, float BasalAge=-9999)
 Set all of the hollow parameters with one call. More...
 
LSDIndexRaster write_raster_data_to_LSDIndexRaster (LSDIndexRaster Data, LSDFlowInfo FlowInfo)
 Cookie cut data from an LSDIndexRaster into the shape of the hollow. More...
 
LSDRaster write_raster_data_to_LSDRaster (LSDRaster Data, LSDFlowInfo FlowInfo)
 Cookie cut data from an LSDRaster into the shape of the hollow. More...
 
LSDRaster write_real_data_to_LSDRaster (float Param, LSDFlowInfo FlowInfo)
 Write a real value to an LSDRaster in the shape of the hollow. More...
 
LSDIndexRaster write_integer_data_to_LSDIndexRaster (int Param, LSDFlowInfo FlowInfo)
 Write an integer value to an LSDIndexRaster in the shape of the hollow. More...
 
LSDIndexRaster write_Junction (LSDFlowInfo FlowInfo)
 Write Junction values into the shape of the hollow. More...
 
LSDIndexRaster write_NumberOfCells (LSDFlowInfo FlowInfo)
 Write NumberOfCells values into the shape of the hollow. More...
 
LSDRaster write_Area (LSDFlowInfo FlowInfo)
 Write Area values into the shape of the hollow. More...
 
LSDRaster write_SlopeMean (LSDFlowInfo FlowInfo)
 Write SlopeMean values into the shape of the hollow. More...
 
LSDRaster write_ElevationMean (LSDFlowInfo FlowInfo)
 Write ElevationMean values into the shape of the hollow. More...
 
LSDRaster write_AspectMean (LSDFlowInfo FlowInfo)
 Write AspectMean values into the shape of the hollow. More...
 
LSDRaster write_ReliefMean (LSDFlowInfo FlowInfo)
 Write ReliefMean values into the shape of the hollow. More...
 
LSDRaster write_PlanCurvMean (LSDFlowInfo FlowInfo)
 Write PlanCurvMean values into the shape of the hollow. More...
 
LSDRaster write_ProfileCurvMean (LSDFlowInfo FlowInfo)
 Write ProfileCurvMean values into the shape of the hollow. More...
 
LSDRaster write_TotalCurvMean (LSDFlowInfo FlowInfo)
 Write TotalCurvMean values into the shape of the hollow. More...
 
LSDRaster write_PlanCurvMax (LSDFlowInfo FlowInfo)
 Write PlanCurvMax values into the shape of the hollow. More...
 
LSDRaster write_ProfileCurvMax (LSDFlowInfo FlowInfo)
 Write ProfileCurvMax values into the shape of the hollow. More...
 
LSDRaster write_TotalCurvMax (LSDFlowInfo FlowInfo)
 Write TotalCurvMax values into the shape of the hollow. More...
 
LSDRaster write_CHTMean (LSDFlowInfo FlowInfo)
 Write CHTMean values into the shape of the hollow. More...
 
LSDRaster write_Width (LSDFlowInfo FlowInfo)
 Write Width values into the shape of the hollow. More...
 
void set_Width (LSDFlowInfo FlowInfo, Array2D< float > FlowDir)
 Calculate the width of a hollow. More...
 
void set_DownslopeLength (LSDFlowInfo FlowInfo, LSDRaster DEM)
 Calculate the downslope length in the hollow, defined as the D8 flow routing distance from between the maximum elevation point in the hollow to the minimum elevation, or to the edge of the hollow, whichever comes first. More...
 
void set_LongProfileLength (LSDFlowInfo FlowInfo)
 Measure the long profile length in the hollow, defined as the maximum dimension of the bounding box excluding diagonals. More...
 

Protected Attributes

int NRows
 Number of rows.
 
int NCols
 Number of columns.
 
float XMinimum
 Minimum X coordinate.
 
float YMinimum
 Minimum Y coordinate.
 
float DataResolution
 Data resolution.
 
int NoDataValue
 No data value.
 
int Junction
 Junction Number of the hollow, serves as a unique ID of a hollow.
 
vector< int > HollowNodes
 Vector of all nodes in hollow.
 
int NumberOfCells
 Number of DEM cells.
 
float Area
 Area in spatial units of the hollow.
 
bool Beheaded
 Boolean to show if the hollow is beheaded or not.
 
int Outlet_i
 i index of the outlet pixel
 
int Outlet_j
 j index of the outlet pixel
 
int Centroid_i
 The i index of the centroid of the hollow.
 
int Centroid_j
 The j index of the centroid of the hollow.
 
float SlopeMean
 Mean hollow slope.
 
float ElevationMean
 Mean hollow elevation.
 
float AspectMean
 Mean hollow aspect.
 
float ReliefMean
 Mean hollow relief.
 
float PlanCurvMean
 Mean hollow planform curvature.
 
float ProfileCurvMean
 Mean hollow profile curvature.
 
float TotalCurvMean
 Mean hollow total curvature.
 
float PlanCurvMax
 Max hollow planform curvature.
 
float ProfileCurvMax
 Max hollow profile curvature.
 
float TotalCurvMax
 Max hollow total curvature.
 
vector< int > Perimeter_i
 Hollow Perimeter's j index.
 
vector< int > Perimeter_j
 Hollow Perimeter's j index.
 
float CHTMean
 Mean hollow hilltop curvature.
 
float SoilProduction
 Soil production rate.
 
float BasalAge
 Basal age of hollow.
 
float Width
 Hollow width.
 
float DownslopeLength
 Downslope length.
 
float LongProfileLength
 Long Profile Length.
 

Detailed Description

Object to store information about hollows and generate hollow average metrics.

Constructor & Destructor Documentation

LSDHollow::LSDHollow ( int  Junction,
LSDFlowInfo FlowInfo,
LSDJunctionNetwork ChanNet 
)
inline

Default constructor method used to create a hollow object.

Parameters
Junctionoutlet junction of the hollow to be constructed.
FlowInfoLSDFlowInfo object.
ChanNetChannel network object.
Author
SWDG
Date
19/2/14

Member Function Documentation

float LSDHollow::CalculateHollowMax ( LSDFlowInfo FlowInfo,
LSDRaster  Data 
)

Calculate the max value of an LSDRaster which falls inside a hollow.

Parameters
FlowInfoFlowinfo object.
DataValues to find the max of.
Returns
Max value.
Author
SWDG
Date
14/2/14
float LSDHollow::CalculateHollowMean ( LSDFlowInfo FlowInfo,
LSDRaster  Data 
)

Calculate the mean value of an LSDRaster which falls inside a hollow.

Parameters
FlowInfoFlowinfo object.
DataValues to find the mean of.
Returns
Mean value.
Author
SWDG
Date
14/2/14
float LSDHollow::get_Area ( ) const
inline
Returns
Area of hollow in spatial units.
float LSDHollow::get_AspectMean ( ) const
inline
Returns
Mean aspect.
float LSDHollow::get_BasalAge ( ) const
inline
Returns
Basal age of hollow.
bool LSDHollow::get_Beheaded ( ) const
inline
Returns
Boolean value of whether a hollow is beheaded or not.
int LSDHollow::get_Centroid_i ( ) const
inline
Returns
i index of Centroid pixel.
int LSDHollow::get_Centroid_j ( ) const
inline
Returns
j index of Centroid pixel.
float LSDHollow::get_CHTMean ( ) const
inline
Returns
Mean hilltop curvature.
float LSDHollow::get_DataResolution ( ) const
inline
Returns
Data resolution as an integer.
float LSDHollow::get_DownslopeLength ( ) const
inline
Returns
Downslope length.
float LSDHollow::get_ElevationMean ( ) const
inline
Returns
Mean elevation.
vector<int> LSDHollow::get_HollowNodes ( ) const
inline
Returns
Nodes of the hollow.
int LSDHollow::get_Junction ( ) const
inline
Returns
Junction Number of the hollow.
float LSDHollow::get_LongProfileLength ( ) const
inline
Returns
Long Profile Length.
int LSDHollow::get_NCols ( ) const
inline
Returns
Number of columns as an integer.
int LSDHollow::get_NoDataValue ( ) const
inline
Returns
No Data Value as an integer.
int LSDHollow::get_NRows ( ) const
inline
Returns
Number of rows as an integer.
int LSDHollow::get_NumberOfCells ( ) const
inline
Returns
Number of cells in the hollow.
int LSDHollow::get_Outlet_i ( ) const
inline
Returns
i index of outlet pixel.
int LSDHollow::get_Outlet_j ( ) const
inline
Returns
j index of outlet pixel.
vector<int> LSDHollow::get_Perimeter_i ( ) const
inline
Returns
Hollow Perimeter's i index.
vector<int> LSDHollow::get_Perimeter_j ( ) const
inline
Returns
Hollow Perimeter's j index.
float LSDHollow::get_PlanCurvMax ( ) const
inline
Returns
Max plan curvature.
float LSDHollow::get_PlanCurvMean ( ) const
inline
Returns
Mean plan curvature.
float LSDHollow::get_ProfileCurvMax ( ) const
inline
Returns
Max profile curvature.
float LSDHollow::get_ProfileCurvMean ( ) const
inline
Returns
Mean profile curvature.
Array2D< float > LSDHollow::get_Raster_Data_For_Hollow ( LSDFlowInfo FlowInfo,
LSDRaster  Data 
)

Return the LSDRaster data from within a hollow as an array.

Parameters
FlowInfoFlowinfo object.
DataValues to extract.
Returns
Array of values.
Author
SWDG
Date
20/2/14
Array2D< int > LSDHollow::get_Raster_Data_For_Hollow ( LSDFlowInfo FlowInfo,
LSDIndexRaster  Data 
)

Return the LSDIndexRaster data from within a hollow as an array.

Parameters
FlowInfoFlowinfo object.
DataValues to extract.
Returns
Array of values.
Author
SWDG
Date
20/2/14
float LSDHollow::get_ReliefMean ( ) const
inline
Returns
Mean relief.
float LSDHollow::get_SlopeMean ( ) const
inline
Returns
Mean slope.
float LSDHollow::get_SoilProduction ( ) const
inline
Returns
Soil production rate.
float LSDHollow::get_TotalCurvMax ( ) const
inline
Returns
Max total curvature.
float LSDHollow::get_TotalCurvMean ( ) const
inline
Returns
Mean total curvature.
float LSDHollow::get_Width ( ) const
inline
Returns
Hollow Width.
float LSDHollow::get_XMinimum ( ) const
inline
Returns
Minimum X coordinate as an integer.
float LSDHollow::get_YMinimum ( ) const
inline
Returns
Minimum Y coordinate as an integer.
void LSDHollow::set_All_Parameters ( LSDRaster Elevation,
LSDFlowInfo FlowInfo,
LSDRaster CHT,
LSDRaster Relief,
float  window_radius,
float  SoilProduction = -9999,
float  BasalAge = -9999 
)

Set all of the hollow parameters with one call.

Runs polyfit to get the elevation derivatives, so can be quite memory intensive. Method calls all the setters one by one, to populate all the hollow parameters. So a hollow can be created and all it's properties set with 2 calls. The BasalAge and SoilProduction have default parameters of -9999 as these are rarely used variables.

Parameters
ElevationLSDRaster of filled elevation values.
FlowInfoFlowinfo object.
CHTLSDRaster of hilltop curvatures.
ReliefLSDRaster of the hilltop relief.
window_radiusRadius in spatial units for the polyft routine.
SoilProductionSoil production rate.
BasalAgeBasal age of the hollow.
Author
SWDG
Date
20/2/14
void LSDHollow::set_AspectMean ( LSDFlowInfo FlowInfo,
LSDRaster  Aspect 
)

Set the mean aspect of a hollow.

Parameters
FlowInfoFlowinfo object.
AspectValues to find the mean of.
Author
SWDG
Date
19/2/14
void LSDHollow::set_BasalAge ( float  basal_age)
inline

Set the basal age.

Parameters
BasalAgeBasal age - No sanity check on this value.
Author
SWDG
Date
19/02/14
void LSDHollow::set_CHTMean ( LSDFlowInfo FlowInfo,
LSDRaster  CHT 
)
inline

Set the mean hilltop curvature of a hollow.

Parameters
FlowInfoFlowinfo object.
CHTValues to find the mean of.
Author
SWDG
Date
19/2/14
void LSDHollow::set_DownslopeLength ( LSDFlowInfo  FlowInfo,
LSDRaster  DEM 
)

Calculate the downslope length in the hollow, defined as the D8 flow routing distance from between the maximum elevation point in the hollow to the minimum elevation, or to the edge of the hollow, whichever comes first.

Parameters
FlowInfoFlowinfo object.
DEMAn LSDRaster of elevations.
Author
SWDG
Date
20/02/14
void LSDHollow::set_ElevationMean ( LSDFlowInfo FlowInfo,
LSDRaster  Elevation 
)
inline

Set the mean Elevation of a hollow.

Parameters
FlowInfoFlowinfo object.
ElevationValues to find the mean of.
Author
SWDG
Date
14/2/14
void LSDHollow::set_LongProfileLength ( LSDFlowInfo  FlowInfo)

Measure the long profile length in the hollow, defined as the maximum dimension of the bounding box excluding diagonals.

Parameters
FlowInfoFlowinfo object.
Author
SWDG
Date
20/02/14
void LSDHollow::set_Perimeter ( LSDFlowInfo FlowInfo)

Set the perimeter pixels using a simple edge detection algorithm.

This is quite messy and will be improved soon.

Parameters
FlowInfoFlowinfo object.
Author
SWDG
Date
19/2/14
void LSDHollow::set_PlanCurvMax ( LSDFlowInfo FlowInfo,
LSDRaster  PlanCurv 
)
inline

Set the max PlanCurve of a hollow.

Parameters
FlowInfoFlowinfo object.
PlanCurvValues to find the max of.
Author
SWDG
Date
14/2/14
void LSDHollow::set_PlanCurvMean ( LSDFlowInfo FlowInfo,
LSDRaster  PlanCurv 
)
inline

Set the mean PlanCurve of a hollow.

Parameters
FlowInfoFlowinfo object.
PlanCurvValues to find the mean of.
Author
SWDG
Date
14/2/14
void LSDHollow::set_ProfileCurvMax ( LSDFlowInfo FlowInfo,
LSDRaster  ProfileCurv 
)
inline

Set the max ProfCurv of a hollow.

Parameters
FlowInfoFlowinfo object.
ProfileCurvValues to find the max of.
Author
SWDG
Date
14/2/14
void LSDHollow::set_ProfileCurvMean ( LSDFlowInfo FlowInfo,
LSDRaster  ProfileCurv 
)
inline

Set the mean ProfCurv of a hollow.

Parameters
FlowInfoFlowinfo object.
ProfileCurvValues to find the mean of.
Author
SWDG
Date
14/2/14
void LSDHollow::set_ReliefMean ( LSDFlowInfo FlowInfo,
LSDRaster  Relief 
)
inline

Set the mean Relief of a hollow.

Parameters
FlowInfoFlowinfo object.
ReliefValues to find the mean of.
Author
SWDG
Date
14/2/14
void LSDHollow::set_SlopeMean ( LSDFlowInfo FlowInfo,
LSDRaster  Slope 
)
inline

Set the mean slope of a hollow.

Parameters
FlowInfoFlowinfo object.
SlopeValues to find the mean of.
Author
SWDG
Date
14/2/14
void LSDHollow::set_SoilProduction ( float  SoilProdRate)
inline

Set the Soil production rate.

Parameters
SoilProdRateSoil production rate - No sanity check on this value.
Author
SWDG
Date
19/02/14
void LSDHollow::set_TotalCurvMax ( LSDFlowInfo FlowInfo,
LSDRaster  TotalCurv 
)
inline

Set the max TotalCurv of a hollow.

Parameters
FlowInfoFlowinfo object.
TotalCurvValues to find the max of.
Author
SWDG
Date
14/2/14
void LSDHollow::set_TotalCurvMean ( LSDFlowInfo FlowInfo,
LSDRaster  TotalCurv 
)
inline

Set the mean TotalCurv of a hollow.

Parameters
FlowInfoFlowinfo object.
TotalCurvValues to find the mean of.
Author
SWDG
Date
14/2/14
void LSDHollow::set_Width ( LSDFlowInfo  FlowInfo,
Array2D< float >  FlowDir 
)

Calculate the width of a hollow.

Parameters
FlowInfoFlowinfo object.
FlowDirD infinity flow directions.
Author
SWDG
Date
19/02/14
LSDRaster LSDHollow::write_Area ( LSDFlowInfo  FlowInfo)
inline

Write Area values into the shape of the hollow.

Parameters
FlowInfoFlowinfo object.
Returns
LSDRaster of Area values in the shape of the hollow.
Author
SWDG
Date
14/2/14
LSDRaster LSDHollow::write_AspectMean ( LSDFlowInfo  FlowInfo)
inline

Write AspectMean values into the shape of the hollow.

Parameters
FlowInfoFlowinfo object.
Returns
LSDRaster of AspectMean values in the shape of the hollow.
Author
SWDG
Date
14/2/14
LSDRaster LSDHollow::write_CHTMean ( LSDFlowInfo  FlowInfo)
inline

Write CHTMean values into the shape of the hollow.

Parameters
FlowInfoFlowinfo object.
Returns
LSDRaster of CHTMean values in the shape of the hollow.
Author
SWDG
Date
14/2/14
LSDRaster LSDHollow::write_ElevationMean ( LSDFlowInfo  FlowInfo)
inline

Write ElevationMean values into the shape of the hollow.

Parameters
FlowInfoFlowinfo object.
Returns
LSDRaster of ElevationMean values in the shape of the hollow.
Author
SWDG
Date
14/2/14
LSDIndexRaster LSDHollow::write_integer_data_to_LSDIndexRaster ( int  Param,
LSDFlowInfo  FlowInfo 
)

Write an integer value to an LSDIndexRaster in the shape of the hollow.

Parameters
Paraminteger value to be written
FlowInfoFlowinfo object.
Returns
LSDIndexRaster of the data in the shape of the hollow.
Author
SWDG
Date
14/2/14
LSDIndexRaster LSDHollow::write_Junction ( LSDFlowInfo  FlowInfo)
inline

Write Junction values into the shape of the hollow.

Parameters
FlowInfoFlowinfo object.
Returns
LSDIndexRaster of Junction values in the shape of the hollow.
Author
SWDG
Date
14/2/14
LSDIndexRaster LSDHollow::write_NumberOfCells ( LSDFlowInfo  FlowInfo)
inline

Write NumberOfCells values into the shape of the hollow.

Parameters
FlowInfoFlowinfo object.
Returns
LSDIndexRaster of NumberOfCells values in the shape of the hollow.
Author
SWDG
Date
14/2/14
LSDRaster LSDHollow::write_PlanCurvMax ( LSDFlowInfo  FlowInfo)
inline

Write PlanCurvMax values into the shape of the hollow.

Parameters
FlowInfoFlowinfo object.
Returns
LSDRaster of PlanCurvMax values in the shape of the hollow.
Author
SWDG
Date
14/2/14
LSDRaster LSDHollow::write_PlanCurvMean ( LSDFlowInfo  FlowInfo)
inline

Write PlanCurvMean values into the shape of the hollow.

Parameters
FlowInfoFlowinfo object.
Returns
LSDRaster of PlanCurvMean values in the shape of the hollow.
Author
SWDG
Date
14/2/14
LSDRaster LSDHollow::write_ProfileCurvMax ( LSDFlowInfo  FlowInfo)
inline

Write ProfileCurvMax values into the shape of the hollow.

Parameters
FlowInfoFlowinfo object.
Returns
LSDRaster of ProfileCurvMax values in the shape of the hollow.
Author
SWDG
Date
14/2/14
LSDRaster LSDHollow::write_ProfileCurvMean ( LSDFlowInfo  FlowInfo)
inline

Write ProfileCurvMean values into the shape of the hollow.

Parameters
FlowInfoFlowinfo object.
Returns
LSDRaster of ProfileCurvMean values in the shape of the hollow.
Author
SWDG
Date
14/2/14
LSDIndexRaster LSDHollow::write_raster_data_to_LSDIndexRaster ( LSDIndexRaster  Data,
LSDFlowInfo  FlowInfo 
)

Cookie cut data from an LSDIndexRaster into the shape of the hollow.

Parameters
DataLSDIndexRaster data to be written.
FlowInfoFlowinfo object.
Returns
LSDIndexRaster of the data in the shape of the hollow.
Author
SWDG
Date
14/2/14
LSDRaster LSDHollow::write_raster_data_to_LSDRaster ( LSDRaster  Data,
LSDFlowInfo  FlowInfo 
)

Cookie cut data from an LSDRaster into the shape of the hollow.

Parameters
DataLSDRaster data to be written.
FlowInfoFlowinfo object.
Returns
LSDRaster of the data in the shape of the hollow.
Author
SWDG
Date
14/2/14
LSDRaster LSDHollow::write_real_data_to_LSDRaster ( float  Param,
LSDFlowInfo  FlowInfo 
)

Write a real value to an LSDRaster in the shape of the hollow.

Parameters
Paramreal value to be written
FlowInfoFlowinfo object.
Returns
LSDRaster of the data in the shape of the hollow.
Author
SWDG
Date
14/2/14
LSDRaster LSDHollow::write_ReliefMean ( LSDFlowInfo  FlowInfo)
inline

Write ReliefMean values into the shape of the hollow.

Parameters
FlowInfoFlowinfo object.
Returns
LSDRaster of ReliefMean values in the shape of the hollow.
Author
SWDG
Date
14/2/14
LSDRaster LSDHollow::write_SlopeMean ( LSDFlowInfo  FlowInfo)
inline

Write SlopeMean values into the shape of the hollow.

Parameters
FlowInfoFlowinfo object.
Returns
LSDRaster of SlopeMean values in the shape of the hollow.
Author
SWDG
Date
14/2/14
LSDRaster LSDHollow::write_TotalCurvMax ( LSDFlowInfo  FlowInfo)
inline

Write TotalCurvMax values into the shape of the hollow.

Parameters
FlowInfoFlowinfo object.
Returns
LSDRaster of TotalCurvMax values in the shape of the hollow.
Author
SWDG
Date
14/2/14
LSDRaster LSDHollow::write_TotalCurvMean ( LSDFlowInfo  FlowInfo)
inline

Write TotalCurvMean values into the shape of the hollow.

Parameters
FlowInfoFlowinfo object.
Returns
LSDRaster of TotalCurvMean values in the shape of the hollow.
Author
SWDG
Date
14/2/14
LSDRaster LSDHollow::write_Width ( LSDFlowInfo  FlowInfo)
inline

Write Width values into the shape of the hollow.

Parameters
FlowInfoFlowinfo object.
Returns
LSDRaster of Width values in the shape of the hollow.
Author
SWDG
Date
20/2/14

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