Making some hard coded things user-changable

[jkhillier]

Hi William,

A possibly separate issue. I'd like to make some hard coded things user-changable, since I'm revisiting the code. e.g. wavInterpCombii() has
/As well as ScaleInteract, take out large features if excessively flat/
FlatnessFactor = 3.0; /smaller object has to be more than this many times pointier/
FlatnessCoeffFactor = 4.0; /*if the smaller one has a coefficient within this multiple, it can take it out */

How might it be easiest to do this in Topotoolbox? Default within the code, and a parameters text file?

Thank you,

John

[wkearn]

Parameters like these will need to be passed into the function:

int wavInterpCombii_inner(int linenum, float WavComb[], float distance[],
                          float WavCombScale[], ptrdiff_t Arr1[], float Arr2[],
                          float Arr3[], float FlatnessFactor, float FlatnessCoeffFactor);

The defaults would be defined in the higher-level languages (C doesn't have default parameters). In Python, an swt function will look something like:

def swt(..., flatness_factor=3.0, flatness_coeff_factor=4.0):
   ...
   _swt.wavInterpCombii_inner(..., flatness_factor, flatness_coeff_factor)
   ...

Feel free to make these changes as you are refactoring. Just remember to pass the default argument values when you call wavInterpCombii_inner from wavInterpCombii.

Unfortunately, this does sometimes lead to a ton of parameters as in libtopotoolbox's graphflood_full function

void graphflood_full(float *Z, float *hw, uint8_t *BCs,
                     float *Precipitations, float *manning, ptrdiff_t *dim,
                     float dt, float dx, bool SFD, bool D8,
                     ptrdiff_t N_iterations, float step);

which is a little too complicated. There are ways to group parameters together in both C and the higher-level languages, though, to make the function signatures easier to understand.