RAVE
pypolarvolume.c File Reference

Python version of the PolarVolume API. More...

#include "pyravecompat.h"
#include "rave_types.h"
#include <math.h>
#include <stdio.h>
#include <string.h>
#include "pypolarvolume.h"
#include <arrayobject.h>
#include "pypolarscan.h"
#include "pyrave_debug.h"
#include "pyravefield.h"
#include "pypolarnavinfo.h"
#include "rave_alloc.h"
#include "rave.h"

Macros

#define NPY_NO_DEPRECATED_API   NPY_1_7_API_VERSION
 
#define PYPOLARVOLUME_MODULE
 to get correct part in pypolarvolume.h
 
#define raiseException_gotoTag(tag, type, msg)
 Sets a python exception and goto tag.
 
#define raiseException_returnNULL(type, msg)
 Sets python exception and returns NULL.
 

Functions

 PYRAVE_DEBUG_MODULE ("_polarvolume")
 Debug this module.
 
 PyDoc_STRVAR (_pypolarvolume_type_doc, "The polar volume is a container for polar scans. There are a few member attributes and like polar scans and other classes " "it is possible to add arbitrary attributes in the 3 groups how, what and where. For example what/sthis.\n\n" "\n" "longitude - The longitude for where this polar scan originates from (lon0) in radians\n" "latitude - The latitude for where this polar scan originates from (lat0) in radians\n""" "height - The height above sea level where this polar scan originates from (alt0) in meters\n" "time - Time this polar scan should represent as a string with format HHmmSS\n" "date - Date this polar scan should represent as a string in the format YYYYMMDD\n" "source - The source for this product. Defined as what/source in ODIM H5. I.e. a comma separated list of various identifiers. For example. NOD:seang,WMO:1234,....\n" "paramname - The default parameter. Default parameter is used when operating on this volume unless the parameter (quantity) explicitly has been specified in the function.\n" " - All scans that currently are held by this volume and eventual new ones will all get the same default parameter.\n" "beamwidth - DEPRECATED, Use beamwH! Beamwidth for the volume. All scans will get the specified beamwidth. If you only want to make the beamwidth affect an individual\n" " scan, modify the scan directly.\n" "beamwH - Horizontal beamwidth for the volume. All scans will get the specified beamwidth. If you only want to make the beamwidth affect an individual\n" " scan, modify the scan directly.\n" "beamwV - Vertical beamwidth for the volume. All scans will get the specified beamwidth. If you only want to make the beamwidth affect an individual\n" " scan, modify the scan directly.\n" "use_azimuthal_nav_information - If setting. Then all currently added scans will get this value. It will not affect scans added after. If reading this value\n" " it will return True if at least one of the currently set scans returns True. Otherwise this attribute will be False.\n" "\n" "Usage:\n" "import _polarvolume\n" "vol = _polarvolume.new()\n")
 
 MOD_INIT (_polarvolume)
 Initializes polar volume.
 

Variables

PyTypeObject PyPolarVolume_Type
 

Detailed Description

Python version of the PolarVolume API.

Author
Anders Henja (Swedish Meteorological and Hydrological Institute, SMHI)
Date
2009-12-08

Macro Definition Documentation

◆ PYPOLARVOLUME_MODULE

#define PYPOLARVOLUME_MODULE

to get correct part in pypolarvolume.h

◆ raiseException_gotoTag

#define raiseException_gotoTag ( tag,
type,
msg )
Value:
{PyErr_SetString(type, msg); goto tag;}

Sets a python exception and goto tag.

◆ raiseException_returnNULL

#define raiseException_returnNULL ( type,
msg )
Value:
{PyErr_SetString(type, msg); return NULL;}

Sets python exception and returns NULL.

Function Documentation

◆ MOD_INIT()

MOD_INIT ( _polarvolume )

Initializes polar volume.

◆ PYRAVE_DEBUG_MODULE()

PYRAVE_DEBUG_MODULE ( "_polarvolume" )

Debug this module.

Variable Documentation

◆ PyPolarVolume_Type

PyTypeObject PyPolarVolume_Type

Type definitions