SPATMOD::IMAGE::FILTER_FOCALTOPOGRAPHIC::SETTINGS Class Reference

Settings class for the FILTER_FOCALTOPOGRAPHIC class. More...

#include <spatmod/imagefilterfocaltopographic.h>

Public Member Functions
	SETTINGS ()
	~SETTINGS ()
double	GetXCellSize ()
double	GetYCellSize ()
void	SetAspectDataType (SPATMOD::DATATYPE type)
void	SetAspectParms (bool DoAspect, SPATMOD::DATATYPE type=SPATMOD::DATATYPE_FLOAT32)
void	SetCurvatureDataType (SPATMOD::DATATYPE type)
void	SetCurvatureParms (bool DoProfile, bool DoPlan, SPATMOD::DATATYPE type=SPATMOD::DATATYPE_SINT16, CURVATURE_UNITS units=FILTER_FOCALTOPOGRAPHIC::CURVATURE_UNITS_RadiansPerMeter)
void	SetCurvatureUnits (CURVATURE_UNITS units)
void	SetDirectionOfSun (double direction)
void	SetDoAspect (bool DoAspect)
void	SetDoPlan (bool DoPlan)
void	SetDoProfile (bool DoProfile)
void	SetDoShading (bool DoShading)
void	SetDoSlope (bool DoSlope)
void	SetElevationAngleOfSun (double angle)
void	SetElevationScale (double scale)
void	SetShadingDataType (SPATMOD::DATATYPE type)
void	SetShadingMethod (SHADING_METHOD method)
void	SetShadingParms (bool DoShading, SPATMOD::DATATYPE type=SPATMOD::DATATYPE_UINT8, SHADING_METHOD method=FILTER_FOCALTOPOGRAPHIC::SHADING_METHOD_Display)
void	SetSlopeDataType (SPATMOD::DATATYPE type)
void	SetSlopeParms (bool DoSlope, SPATMOD::DATATYPE type=SPATMOD::DATATYPE_SINT16, SLOPE_UNITS units=FILTER_FOCALTOPOGRAPHIC::SLOPE_UNITS_Degrees)
void	SetSlopeUnits (SLOPE_UNITS units)
void	SetSurfaceFittingMethod (SURFACE_FITTING_METHOD method)
void	SetXCellSize (double scale)
void	SetYCellSize (double scale)

Detailed Description

Settings class for the FILTER_FOCALTOPOGRAPHIC class.

Constructor & Destructor Documentation

SPATMOD::IMAGE::FILTER_FOCALTOPOGRAPHIC::SETTINGS::SETTINGS ( ) [inline]

Default constructor.

SPATMOD::IMAGE::FILTER_FOCALTOPOGRAPHIC::SETTINGS::~SETTINGS ( ) [inline]

Member Function Documentation

double SPATMOD::IMAGE::FILTER_FOCALTOPOGRAPHIC::SETTINGS::GetXCellSize ( ) [inline]

Get the X cell size set to use for the input raster.

double SPATMOD::IMAGE::FILTER_FOCALTOPOGRAPHIC::SETTINGS::GetYCellSize ( ) [inline]

Get the T cell size set to use for the input raster.

void SPATMOD::IMAGE::FILTER_FOCALTOPOGRAPHIC::SETTINGS::SetAspectDataType ( SPATMOD::DATATYPE type ) [inline]

Set DataType of the raster.

void SPATMOD::IMAGE::FILTER_FOCALTOPOGRAPHIC::SETTINGS::SetAspectParms	(	bool	DoAspect,
		SPATMOD::DATATYPE	type = `SPATMOD::DATATYPE_FLOAT32`
	)			`[inline]`

Set whether to compute a aspect raster and what parameters to use.

void SPATMOD::IMAGE::FILTER_FOCALTOPOGRAPHIC::SETTINGS::SetCurvatureDataType ( SPATMOD::DATATYPE type ) [inline]

Set DataType of the rasters.

void SPATMOD::IMAGE::FILTER_FOCALTOPOGRAPHIC::SETTINGS::SetCurvatureParms	(	bool	DoProfile,
		bool	DoPlan,
		SPATMOD::DATATYPE	type = `SPATMOD::DATATYPE_SINT16`,
		CURVATURE_UNITS	units = `FILTER_FOCALTOPOGRAPHIC::CURVATURE_UNITS_RadiansPerMeter`
	)			`[inline]`

Set whether to compute the profile or plan curvature rasters and what parameters to use.

void SPATMOD::IMAGE::FILTER_FOCALTOPOGRAPHIC::SETTINGS::SetCurvatureUnits ( CURVATURE_UNITS units ) [inline]

Set units for the curvature rasters.

void SPATMOD::IMAGE::FILTER_FOCALTOPOGRAPHIC::SETTINGS::SetDirectionOfSun ( double direction ) [inline]

Set the Direction of the Sun (in degrees), where north is 0 going clockwise (azimuth).

Parameters:

direction

Azimuth angle (degrees)

void SPATMOD::IMAGE::FILTER_FOCALTOPOGRAPHIC::SETTINGS::SetDoAspect ( bool DoAspect ) [inline]

Set whether to compute the aspect raster.

void SPATMOD::IMAGE::FILTER_FOCALTOPOGRAPHIC::SETTINGS::SetDoPlan ( bool DoPlan ) [inline]

Set whether to compute the plan curvature raster.

void SPATMOD::IMAGE::FILTER_FOCALTOPOGRAPHIC::SETTINGS::SetDoProfile ( bool DoProfile ) [inline]

Set whether to compute the profile curvature raster.

void SPATMOD::IMAGE::FILTER_FOCALTOPOGRAPHIC::SETTINGS::SetDoShading ( bool DoShading ) [inline]

Set whether to compute the shading raster.

void SPATMOD::IMAGE::FILTER_FOCALTOPOGRAPHIC::SETTINGS::SetDoSlope ( bool DoSlope ) [inline]

Set whether to compute the slope raster.

void SPATMOD::IMAGE::FILTER_FOCALTOPOGRAPHIC::SETTINGS::SetElevationAngleOfSun ( double angle ) [inline]

Set the Elevation Angle of the Sun (in degrees).

Parameters:

angle

Elevation angle (degrees)

void SPATMOD::IMAGE::FILTER_FOCALTOPOGRAPHIC::SETTINGS::SetElevationScale ( double scale ) [inline]

Set the elevation scale to use for the input raster.

void SPATMOD::IMAGE::FILTER_FOCALTOPOGRAPHIC::SETTINGS::SetShadingDataType ( SPATMOD::DATATYPE type ) [inline]

Set DataType of the raster.

void SPATMOD::IMAGE::FILTER_FOCALTOPOGRAPHIC::SETTINGS::SetShadingMethod ( SHADING_METHOD method ) [inline]

void SPATMOD::IMAGE::FILTER_FOCALTOPOGRAPHIC::SETTINGS::SetShadingParms	(	bool	DoShading,
		SPATMOD::DATATYPE	type = `SPATMOD::DATATYPE_UINT8`,
		SHADING_METHOD	method = `FILTER_FOCALTOPOGRAPHIC::SHADING_METHOD_Display`
	)			`[inline]`

Set whether to compute a shading raster and what parameters to use.

void SPATMOD::IMAGE::FILTER_FOCALTOPOGRAPHIC::SETTINGS::SetSlopeDataType ( SPATMOD::DATATYPE type ) [inline]

Set DataType of the raster.

void SPATMOD::IMAGE::FILTER_FOCALTOPOGRAPHIC::SETTINGS::SetSlopeParms	(	bool	DoSlope,
		SPATMOD::DATATYPE	type = `SPATMOD::DATATYPE_SINT16`,
		SLOPE_UNITS	units = `FILTER_FOCALTOPOGRAPHIC::SLOPE_UNITS_Degrees`
	)			`[inline]`

Set whether to compute a slope raster and what parameters to use.

void SPATMOD::IMAGE::FILTER_FOCALTOPOGRAPHIC::SETTINGS::SetSlopeUnits ( SLOPE_UNITS units ) [inline]

Set units for the slope raster.

void SPATMOD::IMAGE::FILTER_FOCALTOPOGRAPHIC::SETTINGS::SetSurfaceFittingMethod ( SURFACE_FITTING_METHOD method ) [inline]

Set the surface fitting method to use.

void SPATMOD::IMAGE::FILTER_FOCALTOPOGRAPHIC::SETTINGS::SetXCellSize ( double scale ) [inline]

Set the X cell size to use for the input raster.

void SPATMOD::IMAGE::FILTER_FOCALTOPOGRAPHIC::SETTINGS::SetYCellSize ( double scale ) [inline]

Set the Y cell size to use for the input raster.

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

spatmod/imagefilterfocaltopographic.h

SPATMOD::IMAGE::FILTER_FOCALTOPOGRAPHIC::SETTINGS Class Reference

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation