Developer Reference Manual¶
Release: | 0.2.0 |
---|---|
Date: | Oct 29, 2018 |
This is the developer reference guide for PyDDA which covers most of the available functions, modules, and classes.
cost_functions
Module¶
Module containing cost functions and their gradients.
pydda.cost_functions (pydda.vis)¶
The procedures in this module calculate the individual cost functions and their gradients.
J_function (winds, vrs, azs, els, wts, ...[, ...]) |
Calculates the total cost function. |
grad_J (winds, vrs, azs, els, wts, u_back, ...) |
Calculates the gradient of the cost function. |
calculate_radial_vel_cost_function (vrs, azs, ...) |
Calculates the cost function due to difference of the wind field from radar radial velocities. |
calculate_grad_radial_vel (vrs, els, azs, u, ...) |
Calculates the gradient of the cost function due to difference of wind field from radar radial velocities. |
calculate_mass_continuity (u, v, w, z, dx, dy, dz) |
Calculates the mass continuity cost function by taking the divergence of the wind field. |
calculate_mass_continuity_gradient (u, v, w, ...) |
Calculates the gradient of mass continuity cost function. |
calculate_smoothness_cost (u, v, w[, Cx, Cy, Cz]) |
Calculates the smoothness cost function by taking the Laplacian of the wind field. |
calculate_smoothness_gradient (u, v, w[, Cx, ...]) |
Calculates the gradient of the smoothness cost function by taking the Laplacian of the Laplacian of the wind field. |
calculate_background_cost (u, v, w, weights, ...) |
Calculates the background cost function. |
calculate_background_gradient (u, v, w, ...) |
Calculates the gradient of the background cost function. |
calculate_vertical_vorticity_cost (u, v, w, ...) |
Calculates the cost function due to deviance from vertical vorticity equation. |
calculate_vertical_vorticity_gradient (u, v, ...) |
Calculates the gradient of the cost function due to deviance from vertical vorticity equation. |
calculate_model_cost (u, v, w, weights, ...) |
Calculates the cost function for the model constraint. |
calculate_model_gradient (u, v, w, weights, ...) |
Calculates the cost function for the model constraint. |
calculate_fall_speed (grid[, refl_field, frz]) |
Estimates fall speed based on reflectivity. |
retrieval
Module¶
Main module for wind retrieval.
pydda.retrieval (pydda.retrieval)¶
The module containing the core techniques for the multiple doppler wind retrieval.
get_dd_wind_field (Grids, u_init, v_init, w_init) |
This function takes in a list of Py-ART Grid objects and derives a wind field. |
get_bca (rad1_lon, rad1_lat, rad2_lon, ...) |
This function gets the beam crossing angle between two lat/lon pairs. |
vis
Module¶
Visualization module for PyDDA.
pydda.vis (pydda.vis)¶
A visualization module for plotting generated wind fields.
plot_horiz_xsection_barbs (Grids[, ax, ...]) |
This procedure plots a horizontal cross section of winds from wind fields generated by PyDDA using barbs. |
plot_xz_xsection_barbs (Grids[, ax, ...]) |
This procedure plots a cross section of winds from wind fields generated by PyDDA in the X-Z plane using barbs. |
plot_yz_xsection_barbs (Grids[, ax, ...]) |
This procedure plots a cross section of winds from wind fields generated by PyDDA in the Y-Z plane using barbs. |
plot_horiz_xsection_barbs_map (Grids[, ax, ...]) |
This procedure plots a horizontal cross section of winds from wind fields generated by PyDDA onto a geographical map using barbs. |
plot_horiz_xsection_streamlines (Grids[, ax, ...]) |
This procedure plots a horizontal cross section of winds from wind fields generated by PyDDA using streamlines. |
plot_xz_xsection_streamlines (Grids[, ax, ...]) |
This procedure plots a cross section of winds from wind fields generated by PyDDA in the X-Z plane using streamlines. |
plot_yz_xsection_streamlines (Grids[, ax, ...]) |
This procedure plots a cross section of winds from wind fields generated by PyDDA in the Y-Z plane using streamlines. |
plot_horiz_xsection_streamlines_map (Grids[, ...]) |
This procedure plots a horizontal cross section of winds from wind fields generated by PyDDA using streamlines. |
initalization
Module¶
The module for creating custom initial states for the PyDDA retrieval.
pydda.initialization (pydda.initialization)¶
The module containing the core techniques for the multiple doppler wind retrieval.
make_constant_wind_field (Grid[, wind, vel_field]) |
This function makes a constant wind field given a wind vector. |
make_wind_field_from_profile (Grid, profile) |
This function makes a 3D wind field from a sounding. |
make_test_divergence_field (Grid, wind_vel, ...) |
This function makes a test field with wind convergence at the surface and divergence aloft. |
make_background_from_wrf (Grid, file_path, ...) |
This function makes an initalization field based off of the u and w from a WRF run. |
constraints
Module¶
The module for creating custom constraints (i.e. from models, satellites) for the PyDDA retrieval.
pydda.constraints (pydda.constraints)¶
The procedures in this module calculate the individual cost functions and their gradients.
make_constraint_from_wrf (Grid, file_path, ...) |
This function makes an initalization field based off of the u and w from a WRF run in netCDF format. |
add_hrrr_constraint_to_grid (Grid, file_path) |
This function will read an HRRR GRIB2 file and create the constraining |