radvolspike.h File Reference

Radvol-QC algorithms for spike removal. More...

#include "rave_object.h"
#include "polarvolume.h"
#include "polarscan.h"
#include "radvol.h"

Go to the source code of this file.

Typedefs
typedef struct _RadvolSpike_t	RadvolSpike_t
	Defines a RadvolSpike.

Functions
int	RadvolSpike_spikeRemoval_scan (PolarScan_t *scan, Radvol_params_t *params, char *paramFileName)
	Runs algorithm for spike removal and quality characterization with parameters from XML file.
int	RadvolSpike_spikeRemoval_pvol (PolarVolume_t *pvol, Radvol_params_t *params, char *paramFileName)
	Runs algorithm for spike removal and quality characterization with parameters from XML file.

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

Detailed Description

Radvol-QC algorithms for spike removal.

Author

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

Date

2012-12-20

Typedef Documentation

RadvolSpike_t

typedef struct _RadvolSpike_t RadvolSpike_t

Defines a RadvolSpike.

Function Documentation

RadvolSpike_spikeRemoval_pvol()

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

Runs algorithm for spike removal and quality characterization 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

RadvolSpike_spikeRemoval_scan()

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

Runs algorithm for spike removal and quality characterization 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

RadvolSpike_TYPE

RaveCoreObjectType RadvolSpike_TYPE

extern

Type definition to use when creating a rave object.