radvolatt.c File Reference

Radvol-QC algorithms of correction for attenuation in rain. More...

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

Classes
struct	_RadvolAtt_t
	Represents the RadvolAtt algorithm. More...

Macros
#define	ValuesFromWavelength   0
	parameter values deduced from wavelength
#define	ValuesFromXml   1
	parameter values read from xml file
#define	ValuesFromRave   2
	parameter values from memory, passed from RAVE
#define	NoValues   3
	no parameter values - error

Functions
int	RadvolAtt_attCorrection_scan (PolarScan_t *scan, Radvol_params_t *params, char *paramFileName)
	Runs algorithm of correction for attenuation in rain and quality characterization with parameters from XML file.
int	RadvolAtt_attCorrection_pvol (PolarVolume_t *pvol, Radvol_params_t *params, char *paramFileName)
	Runs algorithm of correction for attenuation in rain and quality characterization with parameters from XML file.

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

Detailed Description

Radvol-QC algorithms of correction for attenuation in rain.

Author

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

Date

2012-12-20

Macro Definition Documentation

NoValues

#define NoValues   3

no parameter values - error

ValuesFromRave

#define ValuesFromRave   2

parameter values from memory, passed from RAVE

ValuesFromWavelength

#define ValuesFromWavelength   0

parameter values deduced from wavelength

ValuesFromXml

#define ValuesFromXml   1

parameter values read from xml file

Function Documentation

RadvolAtt_attCorrection_pvol()

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

Runs algorithm of correction for attenuation in rain 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

RadvolAtt_attCorrection_scan()

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

Runs algorithm of correction for attenuation in rain 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

RadvolAtt_TYPE

RaveCoreObjectType RadvolAtt_TYPE

Initial value:

= {
  "RadvolAtt",
  sizeof(RadvolAtt_t),
  RadvolAtt_constructor,
  RadvolAtt_destructor,
  RadvolAtt_copyconstructor
}

Type definition to use when creating a rave object.