RAVE
rave_area.py File Reference

Module for defining geographical areas (cartographic surfaces) using the Proj and rave_projection module. More...

Classes

class  Lib.rave_area.AREA
 Area object. More...
 

Namespaces

namespace  Lib.rave_area
 

Functions

 Lib.rave_area.keys ()
 Returns a list of keys in the registry.
 
 Lib.rave_area.items ()
 Returns a list of tuples containing key:item pairs in the registry where the key is the area's identifier and the item is its object.
 
 Lib.rave_area.init ()
 Initializer.
 
 Lib.rave_area.area (Id)
 Returns the area instance corresponding with the given identifier.
 
 Lib.rave_area.register (A)
 Registers a new AREA instance.
 
 Lib.rave_area.make_tuple (text)
 Convenience function for converting a text representation of a tuple to a tuple.
 
 Lib.rave_area.makearg (parent, id, text, Type=None)
 Convenience function for creating XML.
 
 Lib.rave_area.add (id, description, projection_id, extent, xsize, ysize, xscale, yscale, filename=AREA_REGISTRY)
 Adds a new area to the registry.
 
 Lib.rave_area.remove (id, filename=AREA_REGISTRY)
 Removes an area from the registry.
 
 Lib.rave_area.write (filename=AREA_REGISTRY)
 Writes the contents of the registry to file.
 
 Lib.rave_area.describe (id)
 Prints an area's characteristics to stdout.
 
 Lib.rave_area.llToSc (lonlat, pcs_id)
 Translates lonlat (as radians) into surface coordinates according to specified pcs_id.
 
 Lib.rave_area.MakeCornersFromExtent (id)
 Calculates the corner coordinates in lon/lat based on an area's extent.
 
 Lib.rave_area.MakeAreaFromPolarFiles (files, proj_id='llwgs84', xscale=2000.0, yscale=2000.0)
 Convenience function that automatically derives a new area from several input ODIM_H5 polar volume or scan files.
 
 Lib.rave_area.MakeAreaFromPolarObjects (objects, proj_id='llwgs84', xscale=2000.0, yscale=2000.0)
 Convenience function that automatically derives a new area from several input ODIM_H5 polar volume or scan objects.
 
 Lib.rave_area.MakeSingleAreaFromSCAN (scan, pcsid, xscale, yscale)
 Helper for defining new areas.
 

Variables

bool Lib.rave_area.got_arearegistry = True
 
 Lib.rave_area.AREAS = os.path.join(RAVECONFIG, '*area_registry.xml')
 There's only one official area registry, but this module allows greater flexibility as long as files use the same naming convention.
 
dict Lib.rave_area._registry = {}
 Empty registry to be filled.
 
int Lib.rave_area.initialized = 0
 

Detailed Description

Module for defining geographical areas (cartographic surfaces) using the Proj and rave_projection module.

The area definitions are loaded from configuration file(s) given by the AREAS variable.

Author
Daniel Michelson, SMHI, based on work originally contracted to Fredrik Lundh
Date
2011-06-28