RAVE
pypolarscan.c File Reference

Python version of the PolarScan API. More...

#include "pyravecompat.h"
#include <limits.h>
#include <math.h>
#include <stdio.h>
#include <string.h>
#include <float.h>
#include "pypolarscan.h"
#include <arrayobject.h>
#include "pypolarscanparam.h"
#include "pyprojection.h"
#include "pyrave_debug.h"
#include "pyravefield.h"
#include "rave_alloc.h"
#include "raveutil.h"
#include "rave.h"

Macros

#define NPY_NO_DEPRECATED_API   NPY_1_7_API_VERSION
 
#define PYPOLARSCAN_MODULE
 to get correct part of pypolarscan,h
 
#define raiseException_gotoTag(tag, type, msg)
 Sets a python exception and goto tag.
 
#define raiseException_returnNULL(type, msg)
 Sets a python exception and return NULL.
 

Functions

 PYRAVE_DEBUG_MODULE ("_polarscan")
 Debug this module.
 
 PyDoc_STRVAR (_pypolarscan_type_doc, "The polar scan represents one polar scan. There are several member attributes " "associated with a polar scan as well a number of child objects like parameters, quality fields and more.\n" "Since a lot of RAVE has been developed with ODIM H5 in mind, it is also possible to add arbitrary attributes in " "various groups, e.g. c.addAttribute(\"how/this\", 1.2) and so on.\n\n" "A list of avilable member attributes are described below. For information about member functions, check each functions doc.\n" "\n" "elangle - Elevation angle in radians.\n" "nbins - Number of bins in the data set.\n" "nrays - Number of rays in the data set.\n" "rstart - Range where the ray start for the scan.\n" "a1gate - the a1gate\n" "datatype - The data type for the selected default parameter. If no default parameter set, the UNDEFINED is returned.\n" "beamwidth - DEPRECATED, Use beamwH! The beamwidth. Default is 1.0 * M_PI/360.0.\n" "beamwV - The vertical beamwidth. Default is 1.0 * M_PI/360.0.\n" "beamwH - The horizontal beamwidth. Default is 1.0 * M_PI/360.0.\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" "starttime - Time the collection of this polar scan started as a string with format HHmmSS\n" "startdate - Date the collection of this polar scan started as a string in the format YYYYMMDD\n" "endtime - Time the collection of this polar scan ended as a string with format HHmmSS\n" "enddate - Date the collection of this polar scan ended 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" "use_azimuthal_nav_information - If astart/startazA/stopazA should be used when calculating indexes\n" "defaultparameter - Since a polar scan is a container of a number of different parameters, this setting allows the user to define a default parameter that will allow for operations directly in the scan instead of getting the parameter.\n" "\n" "The most common usage of this class is probably to load a ODIM H5 scan and perform operations on this object. However, to create a new instance:\n" "import _polarscan\n" "scan = _polarscan.new()\n")
 
 MOD_INIT (_polarscan)
 

Variables

PyTypeObject PyPolarScan_Type
 

Detailed Description

Python version of the PolarScan API.

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

Macro Definition Documentation

◆ PYPOLARSCAN_MODULE

#define PYPOLARSCAN_MODULE

to get correct part of pypolarscan,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 a python exception and return NULL.

Function Documentation

◆ PYRAVE_DEBUG_MODULE()

PYRAVE_DEBUG_MODULE ( "_polarscan" )

Debug this module.

Variable Documentation

◆ PyPolarScan_Type

PyTypeObject PyPolarScan_Type

Type definitions