table of contents
/home/serge/sources/hyantes/src/hyantes.c(3) | Library Functions Manual | /home/serge/sources/hyantes/src/hyantes.c(3) |
NAME¶
/home/serge/sources/hyantes/src/hyantes.c - core of hyantesSYNOPSIS¶
Defines¶
#define POW2(a) ((a)*(a))
Functions¶
static void do_run (hs_coord_t visu, data_t lonStep, data_t latStep, data_t range, size_t lonRange, size_t latRange, size_t nb, hs_potential_t plots[latRange][lonRange], hs_potential_t the_towns[nb], hs_config_t *configuration)
Variables¶
char const *const func_names []
Detailed Description¶
core of hyantesSebastien Martinez and Serge Guelton
Date:
2011-06-01
This file is part of hyantes.
hyantes is free software; you can redistribute it and/or modify it under the
terms of the CeCILL-C License
You should have received a copy of the CeCILL-C License along with this program.
If not, see <http://www.cecill.info/licences>.
Definition in file hyantes.c.
Function Documentation¶
void hs_display (size_tlonRange, size_tlatRange, hs_potential_tpt[latRange][lonRange])¶
displays the matrix of processed potentials Parameters:lonRange the longitudinal resolution of
the matrix
latRange the resolution of the matrix
pt the matrix of potential which is of size latRange by lonRange
const char** hs_list_smoothing (size_t *sz)¶
list all available smoothing methods that can be configured using hs_config Parameters:pointer to the number of smoothing
methods
Returns:
array of string constant of size *sz. Memory
is still owned by hyantes
static hs_potential_t* hs_read_towns (FILE *fd, size_t *len, hs_config_t *config) [static]¶
reads a file containing towns and parse it Parameters:fd file containg the towns
len pointer to the number of towns
Returns:
a vector of towns
hs_potential_t* hs_smooth (int_resoLat, int_resoLon, hs_coord_tvisu, FILE *pFileReference)¶
performs the smoothing of target area inside visu, using potentials from pFileReference the smoothing is performed using smoothing method given by hs_set(HS_SMOOTH_FUNC, ... ) the resolution of the output matrix will be resoLat x resoLon Parameters:_resoLat number of latitude points
computed
_resoLon number of longitude points computed
visu visualization window
pFileReference file containg the data in the format latitude longitude
potential latitude longitude potential ... latitude longitude potential where
latitude and longitude are given in degrees
Returns:
an allocated array of size resoLat x resoLon
containing a struct (lat, lon, pot) or NULL if an error occured
hs_potential_t* hs_smooth_r (int_resoLat, int_resoLon, hs_coord_tvisu, FILE *pFileReference, hs_config_t *configuration)¶
performs the smoothing of target area inside visu, using potentials from pFileReference and using given hs_config the smoothing is performed using smoothing method acording to the configuration given in the arguments the resolution of the output matrix will be resoLat x resoLon Parameters:_resoLat number of latitude points
computed
_resoLon number of longitude points computed
visu visualization window
pFileReference file containg the data in the format latitude longitude
potential latitude longitude potential ... latitude longitude potential where
latitude and longitude are given in degrees
configuration configuration to use
Returns:
an allocated array of size resoLat x resoLon
containing structs (lat, lon, pot) or NULL if an error occured
hs_potential_t* hs_smoothing (int_resoLat, int_resoLon, const char *function_name, doublefunction_param, hs_coord_tvisu, FILE *pFileReference)¶
perform the smoothing of target area inside visu, using potentials from pFileReference the smoothing is performed using function_name smoothing method, with a radius of function_param the resolution of the output matrix will be resoLat x resoLon (obsolete function, use hs_smmoth_r instead) Parameters:_resoLat number of latitude points
computed
_resoLon number of longitude points computed
function_name name of a smoothing method listed by hs_list_smoothing
parameter (in kilometers) of the smoothing method
visu visualization window
file containg the data in the format latitude longitude potential
latitude longitude potential ... latitude longitude potential where latitude
and longitude are given in degrees
Returns:
an allocated array of size resoLat x resoLon
containing structs (lat, lon, pot)
unsigned long hs_status ()¶
observer of the execution of the computation Returns:number of computed input potential points from
the beginning of the computation
Variable Documentation¶
char const* const func_names[] Initial value:¶
{ 'disk', 'amortized_disk', 'gaussian', 'exponential', 'pareto' }static array containg function names. each function must also be listed in func_ptrs in the same order Definition at line 29 of file hyantes.c. Referenced by hs_list_smoothing(), and vhs_set_r().
Author¶
Generated automatically by Doxygen for Hyantes from the source code.Sun May 20 2012 | Hyantes |