radvolbroad.c File Reference

Radvol-QC algorithms for assessment of distance to radar related effects. More...

#include "radvolbroad.h"
#include "radvol.h"
#include "rave_debug.h"
#include "rave_alloc.h"
#include "raveutil.h"
#include <string.h>

Classes
struct	_RadvolBroad_t
	Represents the RadvolBroad algorithm. More...

Functions
int	RadvolBroad_broadAssessment_scan (PolarScan_t *scan, Radvol_params_t *params, char *paramFileName)
	Runs algorithm for assessment of distance-to-radar related effects with parameters from XML file.
int	RadvolBroad_broadAssessment_pvol (PolarVolume_t *pvol, Radvol_params_t *params, char *paramFileName)
	Runs algorithm for assessment of distance-to-radar related effects with parameters from XML file.

Variables
RaveCoreObjectType	RadvolBroad_TYPE
	Type definition to use when creating a rave object.

Detailed Description

Radvol-QC algorithms for assessment of distance to radar related effects.

Author

Katarzyna Osrodka (Institute of Meteorology and Water Management, IMGW-PIB)

Date

2012-12-20

Function Documentation

RadvolBroad_broadAssessment_pvol()

int RadvolBroad_broadAssessment_pvol	(	PolarVolume_t *	pvol,
		Radvol_params_t *	params,
		char *	paramFileName )

Runs algorithm for assessment of distance-to-radar related effects with parameters from XML file.

Parameters

pvol	- input polar volume
params	- struct containing algorithm-specific parameter settings
paramFileName	- name of XML file with parameters (otherwise default values are applied)

Returns

1 upon success, otherwise 0

RadvolBroad_broadAssessment_scan()

int RadvolBroad_broadAssessment_scan	(	PolarScan_t *	scan,
		Radvol_params_t *	params,
		char *	paramFileName )

Runs algorithm for assessment of distance-to-radar related effects with parameters from XML file.

Parameters

scan	- input polar scan
params	- struct containing algorithm-specific parameter settings
paramFileName	- name of XML file with parameters (otherwise default values are applied)

Returns

1 upon success, otherwise 0

Variable Documentation

RadvolBroad_TYPE

RaveCoreObjectType RadvolBroad_TYPE

Initial value:

= {
  "RadvolBroad",
  sizeof(RadvolBroad_t),
  RadvolBroad_constructor,
  RadvolBroad_destructor,
  RadvolBroad_copyconstructor
}

Type definition to use when creating a rave object.