Lib.rave_so Namespace Reference

Functions
	newSO (ipvol, opvol, aavg, ravg, maxelev)
	transform (iw, ow, iz, oz, aavg, ravg, maxelev)
	makeSO (fstr, ofstr, aavg, ravg, maxelev)

Variables
int	USE_SINGLE_ELEV = 1
int	USE_MANY_ELEV = 2
int	NEAREST = 1
int	BILINEAR = 2
int	CUBIC = 3
int	CRESSMAN = 4
int	UNIFORM = 5
int	INVERSE = 6
int	ALL_WEIGHTS = 1
int	NO_ZERO_WEIGHTS = 2

Detailed Description

rave_so.py - RAVE super-observations (SO). Defines new, generalized, pvol
             instances on the fly and feeds them to ptop for transformation.
             Output is to ASCII so modellers can manage...

             Input must be polar volume or scan files containing both Z and V.

Function Documentation

makeSO()

Lib.rave_so.makeSO	(		fstr,
			ofstr,
			aavg,
			ravg,
			maxelev )

Prepares a SO: Opens the SO file and writes the main header. Extracts wind
and reflectivity scans from the HDF5 files and converts data quantity from
dBZ to Z.

Arguments:
  string fstr: String of the HDF5 file to be used for SO production.
  string ofstr: SO output file name.
  int aavg: Azimuthal resolution [# azimuth gates] of the SO. Note: the
            total number of azimuth gates per scan (ysize) must be
            divisible by aavg.
  int ravg: Radial resolution [m] of the SO. Note: ravg must be divisible
            by the distance [m] betweeen two successive range bins
            (xscale).
  int maxelev: Maximum elevation angle [degrees] used for SO production.

Returns: Nothing if successful.

newSO()

Lib.rave_so.newSO	(		ipvol,
			opvol,
			aavg,
			ravg,
			maxelev )

Generates a new SO: Selects non-overlapping scans. Prepares output pvol
and adds required attributes.

Arguments:
  pyobject ipvol: input pvol
  pyobject opvol: output pvol (SO)
  int aavg: Azimuthal resolution [# azimuth gates] of the SO. Note: the
            total number of azimuth gates per scan (ysize) must be
            divisible by aavg.
  int ravg: Radial resolution [m] of the SO. Note: ravg must be divisible
            by the distance [m] betweeen two successive range bins
            (xscale).
  int maxelev: Maximum elevation angle [degrees] used for SO production.

Returns:
  pyobject ipvol: input pvol
  pyobject opvol: output pvol (SO)

transform()

Lib.rave_so.transform	(		iw,
			ow,
			iz,
			oz,
			aavg,
			ravg,
			maxelev )

The default transformation is UNIFORM (simple average). Other optional
methods are NEAREST (nearest neighbour), BILINEAR, CUBIC, INVERSE
(inverse-distance) and CRESSMAN (weights proximate bins more and distant
bins less than INVERSE). The actual choice of two or three interpolation
dimensions is regulated through the use of USE_SINGLE_ELEV (default) or
USE_MANY_ELEV, respectively. Additionally, there is a choice between
using NO_ZERO_WEIGHTS (default) and ALL_WEIGHTS.

Arguments:
  pyobject iw: input pvol (radial wind)
  pyobject ow: output pvol (radial wind) -> SO.
  pyobject iz: input pvol (reflectivity)
  pyobject oz: output pvol (reflectivity) -> SO.
  int aavg: Azimuthal resolution [# azimuth gates] of the SO. Note: the
            total number of azimuth gates per scan (ysize) must be
            divisible by aavg.
  int ravg: Radial resolution [m] of the SO. Note: ravg must be divisible
            by the distance [m] betweeen two successive range bins
            (xscale).
  int maxelev: Maximum elevation angle [degrees] used for SO production.

Returns:
  pyobject ow: output pvol (radial wind) -> SO.
  pyobject oz: output pvol (reflectivity) -> SO.