Internal API¶
Routines¶
Extraction and Diagnostic Routines¶
The routines below are called internally by wrf.getvar()
.
Return the two-dimensional fields of MCAPE, MCIN, LCL, and LFC. |
|
Return the three-dimensional CAPE and CIN. |
|
Return the cloud fraction for low, mid, and high level clouds. |
|
Return the cloud top temperature. |
|
Return the simulated radar reflectivity. |
|
Return the maximum simulated radar reflectivity. |
|
Return the dewpoint temperature. |
|
Return the 2m dewpoint temperature. |
|
Return the geopotential. |
|
Return the geopotential height. |
|
Return the geopotential height (AGL). |
|
Return the geopotential for the vertically staggered grid. |
|
Return the geopotential height for the vertically staggered grid. |
|
Return the storm relative helicity. |
|
Return the updraft helicity. |
|
Return Omega. |
|
Return the pressure in the specified units. |
|
Return the pressure in [hPa]. |
|
Return the preciptiable water. |
|
Return the relative humidity. |
|
Return the 2m relative humidity. |
|
Return the sea level pressure in the specified units. |
|
Return the potential temperature. |
|
Return the temperature in the specified units. |
|
Return the equivalent potential temperature. |
|
Return the virtual temperature. |
|
Return the wetbulb temperature. |
|
Return the temperature in [K]. |
|
Return the temperature in [degC]. |
|
Return the terrain height in the specified units. |
|
Return a sequence of time objects. |
|
Return a sequence of time objects. |
|
Return the u,v wind components rotated to earth coordinates. |
|
Return the u,v components for the 10m winds rotated to earth coordinates. |
|
Return the wind speed and wind direction for the wind rotated to earth coordinates. |
|
Return the wind speed and wind direction for the 10m wind rotated to earth coordinates. |
|
Return the absolute vorticity. |
|
Return the potential vorticity. |
|
Return the u-component of the wind on mass points. |
|
Return the v-component of the wind on mass points. |
|
Return the w-component of the wind on mass points. |
|
Return the wind speed and wind direction for the wind in the projected coordinate (i.e. grid) space. |
|
Return the wind speed and wind direction for the 10m wind in projected coordinate (i.e. grid) space. |
|
Return the wind speed in the projected coordinate (i.e. grid) space. |
|
Return the wind direction in the projected coordinate (i.e. grid) space. |
|
Return the wind speed for the 10m wind in projected coordinate (i.e. grid) space. |
|
Return the wind direction for the 10m wind in projected coordinate (i.e. grid) space. |
|
Return the wind speed for the wind rotated to earth coordinates. |
|
Return the wind direction for the wind rotated to earth coordinates. |
|
Return the wind speed for the 10m wind rotated to earth coordinates. |
|
Return the wind direction for the 10m wind rotated to earth coordinates. |
|
Return the cloud fraction for the low level clouds. |
|
Return the cloud fraction for the mid level clouds. |
|
Return the cloud fraction for the high level clouds. |
|
Return the two-dimensional field of MCAPE (Max Convective Available Potential Energy). |
|
Return the two-dimensional field of MCIN (Max Convective Inhibition). |
|
Return the two-dimensional field of LCL (Lifted Condensation Level). |
|
Return the two-dimensional field of LFC (Level of Free Convection). |
|
Return the three-dimensional field of CAPE (Convective Available Potential Energy). |
|
Return the three-dimensional field of CIN (Convective Inhibition). |
Decorators¶
Algorithm Decorators¶
The decorators below are used for performing common operations related to diagnostic and interpolation calculations.
A decorator that converts the units from the wrapped function's output. |
|
A decorator to handle iterating over the leftmost dimensions. |
|
A decorator to handle type casting. |
|
A decorator to extract the data array from a |
|
A decorator to check that the wrapped function's arguments are valid. |
|
A decorator to handle iterating over the leftmost dimensions for the uvmet diagnostic. |
|
A decorator to handle iterating over the leftmost dimensions for the cape diagnostic. |
|
A decorator to handle iterating over the leftmost dimensions for the cloud fraction diagnostic. |
Metadata Decorators¶
The decorators below are used for performing common operations related to setting metadata.
A decorator that sets the metadata for a wrapped function's output. |
|
A decorator that sets the metadata for a wrapped wind function's output. |
|
A decorator that sets the metadata for a wrapped CAPE function's output. |
|
A decorator that sets the metadata for a wrapped cloud fraction function's output. |
|
A decorator that sets the metadata for a wrapped latlon function's output. |
|
A decorator that sets the metadata for a wrapped height function's output. |
|
A decorator that sets the metadata for a wrapped interpolation function. |
|
A decorator that sets the metadata for a wrapped raw diagnostic function. |
|
A decorator that sets the metadata for the wrapped raw UVMET diagnostic function. |
|
A decorator that sets the metadata for the wrapped raw CAPE diagnostic function. |
|
A decorator that sets the metadata for the wrapped raw cloud fraction diagnostic function. |
|
A decorator that sets the metadata for the wrapped raw destaggering function. |
Decorator Utilities¶
The routines below are used within the decorators.
A callable class that determines which variable is present in the file. |
|
A callable class that mixes dimension sizes from different function arguments. |
|
A callable class that retrieves attributes from the function argument. |
|
Return a mapping of argument name to value for the called function. |
|
Return all of the function arguments, including defaults, as a list. |
|
Return the function arguments as a single list along with the index within that list for a specified argument name. |
Classes¶
Iterable Wrapper Class¶
The class below is an Iterable wrapper class and provides an __iter__ function that always returns the beginning of the sequence, regardless of the Iterable type.
A wrapper class for generators and custom iterable classes that returns a new iterator to the start of the sequence when |