radvolspike.c File Reference

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

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

Classes
struct	_RadvolSpike_t
	Represents the RadvolSpike algorithm. More...

Macros
#define	NoSpike   0
	value for non-spike bin
#define	PotentialASpike   -1
	value for potential spike A
#define	DetectedASpike   -2
	value for detected spike A
#define	DetectedBSpike   -3
	value for detected spike B
#define	InterpolatedSpike   -4
	value for interpolated spike

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

Macro Definition Documentation

DetectedASpike

#define DetectedASpike   -2

value for detected spike A

DetectedBSpike

#define DetectedBSpike   -3

value for detected spike B

InterpolatedSpike

#define InterpolatedSpike   -4

value for interpolated spike

NoSpike

#define NoSpike   0

value for non-spike bin

PotentialASpike

#define PotentialASpike   -1

value for potential spike A

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

Initial value:

= {
  "RadvolSpike",
  sizeof(RadvolSpike_t),
  RadvolSpike_constructor,
  RadvolSpike_destructor,
  RadvolSpike_copyconstructor
}

Type definition to use when creating a rave object.