NAME
/home/serge/sources/hyantes/geocode/hyantes.h - declaration of exported
hyantes functions include this file to get definitions from the hyantes
library
SYNOPSIS
Data Structures
struct hs_coord
structure containing the coordinates of an area all coordinate are
given in degree which means that -90 <= latitude <= 90 and -180 <=
longitude <= +180
struct hs_potential
structure containing the coordinate of a potential all coordiante
are given in radians which means that -90 <= latitude <= +90 and
-180 <= longitude <= +180
Typedefs
typedef struct hs_coord hs_coord_t
structure containing the coordinates of an area all coordinate are
given in degree which means that -90 <= latitude <= 90 and -180 <=
longitude <= +180
typedef struct hs_potential hs_potential_t
structure containing the coordinate of a potential all coordiante
are given in radians which means that -90 <= latitude <= +90 and
-180 <= longitude <= +180
Enumerations
enum hs_option_t { HS_PARSE_ONLY, HS_THRESHOLD, HS_LOAD_RAW,
HS_LOAD_PRECOMPUTED, HS_SMOOTH_FUNC }
enumeration of various options for hyantes
Functions
hs_potential_t * hs_smooth (int resoLat, int resoLon, hs_coord_t visu,
FILE *pFileReference)
perform the smoothing of target area inside visu, using potentials
from pFileReference pFileReference is either in raw or precomputed
format, as given by hs_set(HS_LOAD_RAW|HS_LOAD_PRECOMPUTED) 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
const char ** hs_list_smoothing (size_t *sz)
list all available smoothing methods a smoothing method always take
a radius and a distance (in kilometers) as input and returns a new
distance (possibly zero)
unsigned long hs_status ()
observer of the execution of the computation
int hs_set (hs_option_t,...)
hs_potential_t * hs_smoothing (int resoLat, int resoLon, const char
*function_name, double function_param, hs_coord_t visu, 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
Detailed Description
declaration of exported hyantes functions include this file to get
definitions from the hyantes library
Author:
serge guelton
Date:
2008-02-13
Definition in file hyantes.h.
Enumeration Type Documentation
enum hs_option_t
enumeration of various options for hyantes
Enumerator:
HS_PARSE_ONLY
only require generation of precomputed quadtree, extra arg :
’char *filename’
HS_THRESHOLD
set the threshold used for ignoring some area, extra arg:
’double threshold’
HS_LOAD_RAW
tells the library to consider input file as a raw data file, no
extra arg
HS_LOAD_PRECOMPUTED
tells the library to consider input file as a precomputed file,
no extra arg
HS_SMOOTH_FUNC
tells the library to use giben function and param to perform
smoothing, extra arg: ’char *funcname, double extra param, ...
Definition at line 72 of file hyantes.h.
Function Documentation
const char** hs_list_smoothing (size_t * sz)
list all available smoothing methods a smoothing method always take a
radius and a distance (in kilometers) as input and returns a new
distance (possibly zero)
Parameters:
sz pointer to the number of smoothing methods
Returns:
array of string constant of size *sz. Memory is still owned by
hyantes
Definition at line 57 of file hyantes.c.
References list_smoothing().
hs_potential_t* hs_smooth (int _resoLat, int _resoLon, hs_coord_t visu,
FILE * pFileReference)
perform the smoothing of target area inside visu, using potentials from
pFileReference pFileReference is either in raw or precomputed format,
as given by hs_set(HS_LOAD_RAW|HS_LOAD_PRECOMPUTED) 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 triplets
(lat, lon, pot) or NULL if an error occured
Definition at line 93 of file hyantes.c.
References build_quadtree(), qt::coords, create_planartree(),
do_smoothing(), free_quadtree(), hs_potential::lat, hs_potential::lon,
hs_coord::MLat, hs_coord::mLat, hs_coord::MLon, hs_coord::mLon,
read_input(), ptree::size, and smoothing_error.
Referenced by hs_smoothing().
hs_potential_t* hs_smoothing (int _resoLat, int _resoLon, const char *
function_name, double function_param, hs_coord_t visu, 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
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
function_param parameter (in kilometers) of the smoothing method
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 triplets
(lat, lon, pot) or NULL if an error occured
Definition at line 300 of file hyantes.c.
References HS_LOAD_RAW, hs_smooth(), and HS_SMOOTH_FUNC.
unsigned long hs_status ()
observer of the execution of the computation
Returns:
number of executed tasks from the beginning of the computation It
should be 0 before the beginning And resoLat x resoLon, in the end
Definition at line 68 of file hyantes.c.
Author
Generated automatically by Doxygen for Hyantes from the source code.
Hyantes /home/serge/sources/hyantes/geocode/hyantes.h(3)