RAVE
pyverticalprofile.c File Reference

Python version of the VerticalProfile API. More...

#include "pyravecompat.h"
#include <limits.h>
#include <math.h>
#include <stdio.h>
#include <string.h>
#include "pyverticalprofile.h"
#include <arrayobject.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 PYVERTICALPROFILE_MODULE
 to get correct part of pyverticalprofile,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 ("_verticalprofile")
 Debug this module.
 
 PyDoc_STRVAR (_pyverticalprofile_type_doc, "Defines the functions available when working with vertical profiles.\n" "Like all other product types there are a number of member attributes that are relevant for this product besides the actual data\n" "The member attributes are:\n" "time - Time this vertical profile product should represent as a string with format HHmmSS\n" "date - Date this vertical profile should represent as a string in the format YYYYMMDD\n" "starttime - Start time for this product as a string with format HHmmSS.\n" "startdate - Start date for this product as a string with format YYYYMMDD.\n" "endtime - End time for this product as a string with format HHmmSS.\n" "enddate - End date for this product as a string with 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" "product - The product this vertical profile should represent as defined in ODIM H5. Can basically be any string.\n" "prodname - The product name\n" "longitude - Longitude (in radians)\n" "latitude - Latitude (in radians)\n" "height - Height of the centre of the antenna\n" "interval - The vertical distance (m) between height intervals, or 0.0 if variable\n" "minheight - Minimum height in meters above mean sea level\n" "maxheight - Maximum height in meters above mean sea level\n" "Usage:\n" " import _verticalprofile\n" " vp = _verticalprofile.new()\n" " vp.source = \"NOD:.....\"\n" " vp.longitude = 14.0*math.pi/180.0\n" " ...\n" " vp.setDBZ(ravefield)\n" " ...")
 
 MOD_INIT (_verticalprofile)
 

Variables

PyTypeObject PyVerticalProfile_Type
 

Detailed Description

Python version of the VerticalProfile API.

Author
Anders Henja (Swedish Meteorological and Hydrological Institute, SMHI)
Date
2012-08-24

@co-author Ulf Nordh (Swedish Meteorological and Hydrological Institute, SMHI)

Date
2017-10-27 Uppdated code with new vertical profile field definitions (HGHT, n, UWND, VWND) and functions for accessing starttime, endtime, startdate, endate and product

Macro Definition Documentation

◆ PYVERTICALPROFILE_MODULE

#define PYVERTICALPROFILE_MODULE

to get correct part of pyverticalprofile,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 ( "_verticalprofile" )

Debug this module.

Variable Documentation

◆ PyVerticalProfile_Type

PyTypeObject PyVerticalProfile_Type

Type definitions