SAGA API  v9.6
Public Member Functions | Static Public Member Functions | List of all members
CSG_Distance_Weighting Class Reference

#include <geo_tools.h>

Public Member Functions

 CSG_Distance_Weighting (void)
 
virtual ~CSG_Distance_Weighting (void)
 
bool Create_Parameters (class CSG_Parameters &Parameters, const CSG_String &Parent="", bool bIDW_Offset=false)
 
bool Set_Parameters (class CSG_Parameters &Parameters)
 
TSG_Distance_Weighting Get_Weighting (void) const
 
bool Set_Weighting (TSG_Distance_Weighting Weighting)
 
double Get_IDW_Power (void) const
 
bool Set_IDW_Power (double Value)
 
bool Get_IDW_Offset (void) const
 
bool Set_IDW_Offset (bool bOn=true)
 
double Get_BandWidth (void) const
 
bool Set_BandWidth (double Value)
 
double Get_Weight (double Distance) const
 

Static Public Member Functions

static bool Enable_Parameters (class CSG_Parameters &Parameters)
 
static bool Add_Parameters (class CSG_Parameters &Parameters, const CSG_String &Parent="", bool bIDW_Offset=false)
 

Detailed Description

Definition at line 709 of file geo_tools.h.

Constructor & Destructor Documentation

◆ CSG_Distance_Weighting()

CSG_Distance_Weighting::CSG_Distance_Weighting ( void  )

Definition at line 1363 of file geo_classes.cpp.

References SG_DISTWGHT_None.

◆ ~CSG_Distance_Weighting()

CSG_Distance_Weighting::~CSG_Distance_Weighting ( void  )
virtual

Definition at line 1374 of file geo_classes.cpp.

Member Function Documentation

◆ Add_Parameters()

bool CSG_Distance_Weighting::Add_Parameters ( class CSG_Parameters &  Parameters,
const CSG_String &  Parent = "",
bool  bIDW_Offset = false 
)
static

Definition at line 1396 of file geo_classes.cpp.

References _TL, CSG_Parameters::Add_Bool(), CSG_Parameters::Add_Choice(), CSG_Parameters::Add_Double(), and CSG_String::Format().

Referenced by CSG_Grid_Cell_Addressor::Add_Parameters(), and Create_Parameters().

◆ Create_Parameters()

bool CSG_Distance_Weighting::Create_Parameters ( class CSG_Parameters &  Parameters,
const CSG_String &  Parent = "",
bool  bIDW_Offset = false 
)

Definition at line 1378 of file geo_classes.cpp.

References Add_Parameters(), and INIT_VALUE.

◆ Enable_Parameters()

bool CSG_Distance_Weighting::Enable_Parameters ( class CSG_Parameters &  Parameters)
static

Definition at line 1434 of file geo_classes.cpp.

References CSG_Parameters::Set_Enabled().

Referenced by CSG_Grid_Cell_Addressor::Enable_Parameters().

◆ Get_BandWidth()

double CSG_Distance_Weighting::Get_BandWidth ( void  ) const
inline

Definition at line 729 of file geo_tools.h.

◆ Get_IDW_Offset()

bool CSG_Distance_Weighting::Get_IDW_Offset ( void  ) const
inline

Definition at line 726 of file geo_tools.h.

◆ Get_IDW_Power()

double CSG_Distance_Weighting::Get_IDW_Power ( void  ) const
inline

Definition at line 723 of file geo_tools.h.

◆ Get_Weight()

double CSG_Distance_Weighting::Get_Weight ( double  Distance) const
inline

Definition at line 733 of file geo_tools.h.

References SG_DISTWGHT_EXP, SG_DISTWGHT_GAUSS, and SG_DISTWGHT_IDW.

◆ Get_Weighting()

TSG_Distance_Weighting CSG_Distance_Weighting::Get_Weighting ( void  ) const
inline

Definition at line 720 of file geo_tools.h.

◆ Set_BandWidth()

bool CSG_Distance_Weighting::Set_BandWidth ( double  Value)

Definition at line 1515 of file geo_classes.cpp.

Referenced by Set_Parameters().

◆ Set_IDW_Offset()

bool CSG_Distance_Weighting::Set_IDW_Offset ( bool  bOn = true)

Definition at line 1507 of file geo_classes.cpp.

Referenced by Set_Parameters().

◆ Set_IDW_Power()

bool CSG_Distance_Weighting::Set_IDW_Power ( double  Value)

Definition at line 1494 of file geo_classes.cpp.

Referenced by Set_Parameters().

◆ Set_Parameters()

bool CSG_Distance_Weighting::Set_Parameters ( class CSG_Parameters &  Parameters)

Definition at line 1449 of file geo_classes.cpp.

References Set_BandWidth(), Set_IDW_Offset(), Set_IDW_Power(), Set_Weighting(), SG_DISTWGHT_EXP, SG_DISTWGHT_GAUSS, SG_DISTWGHT_IDW, and SG_DISTWGHT_None.

◆ Set_Weighting()

bool CSG_Distance_Weighting::Set_Weighting ( TSG_Distance_Weighting  Weighting)

Definition at line 1486 of file geo_classes.cpp.

Referenced by Set_Parameters().

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