Library Reference

This page contains an auto-generated summary of \(\omega radlib\)’s API. Every submodule is documented separately.

• Gage adjustment
  • Concept
  • Quick start
  • Cross validation
• AdjustBase
  • AdjustBase.xvalidate
• AdjustMFB
• AdjustMultiply
• AdjustAdd
• AdjustMixed
• RawAtObs
• GageOnly
• AdjustNone
• Attenuation Correction
  • wradlib.atten.AttenuationOverflowError
  • wradlib.atten.correct_attenuation_hb
  • wradlib.atten.constraint_dbz
  • wradlib.atten.constraint_pia
  • wradlib.atten.correct_attenuation_constrained
  • wradlib.atten.correct_radome_attenuation_empirical
  • wradlib.atten.pia_from_kdp
  • wradlib.atten.AttenMethods
• AttenuationOverflowError
• correct_attenuation_hb
• constraint_dbz
• constraint_pia
• correct_attenuation_constrained
• correct_radome_attenuation_empirical
• pia_from_kdp
• AttenMethods
  • AttenMethods.correct_attenuation_constrained
• Clutter Identification and Hydrometeor Classification (HMC)
  • wradlib.classify.filter_gabella
  • wradlib.classify.filter_gabella_a
  • wradlib.classify.filter_gabella_b
  • wradlib.classify.filter_cloudtype
  • wradlib.classify.filter_window_distance
  • wradlib.classify.histo_cut
  • wradlib.classify.classify_echo_fuzzy
  • wradlib.classify.msf_index_indep
  • wradlib.classify.trapezoid
  • wradlib.classify.fuzzyfi
  • wradlib.classify.probability
  • wradlib.classify.classify
  • wradlib.classify.ClassifyMethods
• filter_gabella
• filter_gabella_a
• filter_gabella_b
• filter_cloudtype
• filter_window_distance
• histo_cut
• classify_echo_fuzzy
• msf_index_indep
• trapezoid
• fuzzyfi
• probability
• classify
• ClassifyMethods
  • ClassifyMethods.filter_gabella
  • ClassifyMethods.filter_gabella_a
  • ClassifyMethods.filter_gabella_b
  • ClassifyMethods.histo_cut
  • ClassifyMethods.classify_echo_fuzzy
  • ClassifyMethods.filter_window_distance
  • ClassifyMethods.msf_index_indep
  • ClassifyMethods.fuzzyfi
  • ClassifyMethods.probability
  • ClassifyMethods.classify
• Composition
  • wradlib.comp.extract_circle
  • wradlib.comp.togrid
  • wradlib.comp.compose_ko
  • wradlib.comp.compose_weighted
  • wradlib.comp.CompMethods
• extract_circle
• togrid
• compose_ko
• compose_weighted
• CompMethods
  • CompMethods.togrid
  • CompMethods.compose_weighted
• Dual-Pol and Differential Phase
  • Overview
• depolarization
• kdp_from_phidp
• phidp_kdp_vulpiani
• texture
• unfold_phi
• unfold_phi_vulpiani
• DpMethods
  • DpMethods.depolarization
  • DpMethods.kdp_from_phidp
  • DpMethods.phidp_kdp_vulpiani
  • DpMethods.texture
  • DpMethods.unfold_phi
  • DpMethods.unfold_phi_vulpiani
• Georeferencing
  • wradlib.georef.GeorefMethods
  • Miscellaneous
  • bin_altitude
  • bin_distance
  • site_distance
  • GeorefMiscMethods
  • Polar Grid Functions
  • georeference
  • spherical_to_xyz
  • spherical_to_proj
  • spherical_to_polyvert
  • spherical_to_centroids
  • centroid_to_polyvert
  • sweep_centroids
  • maximum_intensity_projection
  • GeorefPolarMethods
  • Projection Functions
  • reproject
  • create_osr
  • projstr_to_osr
  • epsg_to_osr
  • wkt_to_osr
  • get_default_projection
  • get_earth_radius
  • get_radar_projection
  • get_earth_projection
  • get_extent
  • GeorefProjectionMethods
  • Raster Functions
  • read_gdal_values
  • read_gdal_projection
  • read_gdal_coordinates
  • extract_raster_dataset
  • get_raster_extent
  • get_raster_elevation
  • reproject_raster_dataset
  • merge_raster_datasets
  • create_raster_dataset
  • set_raster_origin
  • set_raster_indexing
  • set_coordinate_indexing
  • raster_to_polyvert
  • Rectangular Grid Functions
  • get_radolan_coords
  • get_radolan_coordinates
  • get_radolan_grid
  • xyz_to_spherical
  • grid_to_polyvert
  • GeorefRectMethods
  • Satellite Functions
  • correct_parallax
  • dist_from_orbit
  • GeorefSatelliteMethods
  • Vector Functions (GDAL)
  • get_vector_coordinates
  • get_vector_points
  • transform_geometry
  • ogr_create_layer
  • ogr_copy_layer
  • ogr_copy_layer_by_name
  • ogr_reproject_layer
  • ogr_add_feature
  • ogr_add_geometry
  • numpy_to_ogr
  • ogr_to_numpy
  • ogr_geocol_to_numpy
  • get_centroid
  • Xarray Functions
  • as_xarray_dataarray
  • create_xarray_dataarray
• GeorefMethods
• GeorefMiscMethods
  • GeorefMiscMethods.bin_altitude
  • GeorefMiscMethods.bin_distance
  • GeorefMiscMethods.site_distance
• GeorefPolarMethods
  • GeorefPolarMethods.georeference
  • GeorefPolarMethods.spherical_to_xyz
  • GeorefPolarMethods.spherical_to_proj
  • GeorefPolarMethods.spherical_to_polyvert
  • GeorefPolarMethods.spherical_to_centroids
• GeorefProjectionMethods
  • GeorefProjectionMethods.get_earth_radius
  • GeorefProjectionMethods.reproject
• GeorefRectMethods
  • GeorefRectMethods.xyz_to_spherical
• GeorefSatelliteMethods
  • GeorefSatelliteMethods.correct_parallax
  • GeorefSatelliteMethods.dist_from_orbit
• as_xarray_dataarray
• bin_altitude
• bin_distance
• centroid_to_polyvert
• correct_parallax
• create_osr
• create_raster_dataset
• create_xarray_dataarray
• dist_from_orbit
• epsg_to_osr
• extract_raster_dataset
• georeference
• get_centroid
• get_default_projection
• get_earth_projection
• get_earth_radius
• get_extent
• get_radar_projection
• get_radolan_coordinates
• get_radolan_coords
• get_radolan_grid
• get_raster_elevation
• get_raster_extent
• get_vector_coordinates
• get_vector_points
• grid_to_polyvert
• maximum_intensity_projection
• merge_raster_datasets
• numpy_to_ogr
• ogr_add_feature
• ogr_add_geometry
• ogr_copy_layer
• ogr_copy_layer_by_name
• ogr_create_layer
• ogr_geocol_to_numpy
• ogr_reproject_layer
• ogr_to_numpy
• projstr_to_osr
• raster_to_polyvert
• read_gdal_coordinates
• read_gdal_projection
• read_gdal_values
• reproject
• reproject_raster_dataset
• set_coordinate_indexing
• set_raster_indexing
• set_raster_origin
• site_distance
• spherical_to_centroids
• spherical_to_polyvert
• spherical_to_proj
• spherical_to_xyz
• sweep_centroids
• transform_geometry
• wkt_to_osr
• xyz_to_spherical
• Raw Data I/O
  • Xarray backends
  • RadolanBackendEntrypoint
  • Digital Elevation Model Data I/O
  • download_srtm
  • get_srtm
  • get_srtm_tile_names
  • GDAL Raster/Vector Data I/O
  • open_vector
  • open_raster
  • read_safnwc
  • gdal_create_dataset
  • write_raster_dataset
  • VectorSource
  • HDF Data I/O
  • open_gpm_dataset
  • read_generic_hdf5
  • read_opera_hdf5
  • read_gamic_hdf5
  • to_hdf5
  • from_hdf5
  • read_gpm
  • read_trmm
  • IRIS/Sigmet Data I/O
  • read_iris
  • IrisProductFile
  • IrisCartesianProductFile
  • Miscellaneous Data I/O
  • write_polygon_to_text
  • to_pickle
  • from_pickle
  • get_radiosonde
  • get_membership_functions
  • NetCDF Data I/O
  • read_edge_netcdf
  • read_generic_netcdf
  • RADOLAN and DX Data I/O
  • open_radolan_dataset
  • open_radolan_mfdataset
  • read_dx
  • read_radolan_composite
  • get_radolan_filehandle
  • read_radolan_header
  • parse_dwd_composite_header
  • read_radolan_binary_array
  • decode_radolan_runlength_array
  • Rainbow Data I/O
  • read_rainbow
  • Xarray based Data I/O
  • WradlibVariable
• IrisCartesianProductFile
  • IrisCartesianProductFile.product_identifier
  • IrisCartesianProductFile.data
  • IrisCartesianProductFile.fix_ext_header
  • IrisCartesianProductFile.get_extended_header
  • IrisCartesianProductFile.get_image
  • IrisCartesianProductFile.get_data
  • IrisCartesianProductFile.decode_data
• IrisProductFile
  • IrisProductFile.product_identifier
  • IrisProductFile.data
  • IrisProductFile.protect_setup
  • IrisProductFile.get_protect_setup
  • IrisProductFile.get_results
  • IrisProductFile.get_data
• RadolanBackendEntrypoint
  • RadolanBackendEntrypoint.description
  • RadolanBackendEntrypoint.url
  • RadolanBackendEntrypoint.open_dataset
• VectorSource
  • VectorSource.close
  • VectorSource.mode
  • VectorSource.ds
  • VectorSource.extent
  • VectorSource.crs
  • VectorSource.data
  • VectorSource.geo
  • VectorSource.get_data_by_idx
  • VectorSource.get_data_by_att
  • VectorSource.get_data_by_geom
  • VectorSource.dump_vector
  • VectorSource.load_vector
  • VectorSource.dump_raster
  • VectorSource.set_attribute
  • VectorSource.get_attributes
  • VectorSource.get_geom_properties
  • VectorSource.get_attrs_and_props
• WradlibVariable
  • WradlibVariable.dimensions
  • WradlibVariable.data
  • WradlibVariable.attributes
• decode_radolan_runlength_array
• download_srtm
• from_hdf5
• from_pickle
• gdal_create_dataset
• get_membership_functions
• get_radiosonde
• get_radolan_filehandle
• get_srtm
• get_srtm_tile_names
• open_gpm_dataset
• open_radolan_dataset
• open_radolan_mfdataset
• open_raster
• open_vector
• parse_dwd_composite_header
• read_dx
• read_edge_netcdf
• read_gamic_hdf5
• read_generic_hdf5
• read_generic_netcdf
• read_gpm
• read_iris
• read_opera_hdf5
• read_radolan_binary_array
• read_radolan_composite
• read_radolan_header
• read_rainbow
• read_safnwc
• read_trmm
• to_hdf5
• to_pickle
• write_polygon_to_text
• write_raster_dataset
• Interpolation
  • wradlib.ipol.IpolBase
  • wradlib.ipol.Nearest
  • wradlib.ipol.Idw
  • wradlib.ipol.Linear
  • wradlib.ipol.OrdinaryKriging
  • wradlib.ipol.ExternalDriftKriging
  • wradlib.ipol.RectGrid
  • wradlib.ipol.RectBin
  • wradlib.ipol.QuadriArea
  • wradlib.ipol.interpolate
  • wradlib.ipol.interpolate_polar
  • wradlib.ipol.cart_to_irregular_interp
  • wradlib.ipol.cart_to_irregular_spline
  • wradlib.ipol.IpolMethods
• IpolBase
• Nearest
• Idw
• Linear
• OrdinaryKriging
• ExternalDriftKriging
• RectGrid
• RectBin
  • RectBin.binned_stats
• QuadriArea
• interpolate
• interpolate_polar
• cart_to_irregular_interp
• cart_to_irregular_spline
• IpolMethods
  • IpolMethods.interpolate_polar
• Data Quality
  • wradlib.qual.pulse_volume
  • wradlib.qual.beam_block_frac
  • wradlib.qual.cum_beam_block_frac
  • wradlib.qual.get_bb_ratio
  • wradlib.qual.QualMethods
• pulse_volume
• beam_block_frac
• cum_beam_block_frac
• get_bb_ratio
• QualMethods
  • QualMethods.pulse_volume
  • QualMethods.get_bb_ratio
• Data Transformation
  • wradlib.trafo.rvp_to_dbz
  • wradlib.trafo.decibel
  • wradlib.trafo.idecibel
  • wradlib.trafo.r_to_depth
  • wradlib.trafo.kdp_to_r
  • wradlib.trafo.si_to_kmh
  • wradlib.trafo.si_to_mph
  • wradlib.trafo.si_to_kts
  • wradlib.trafo.kmh_to_si
  • wradlib.trafo.mph_to_si
  • wradlib.trafo.kts_to_si
  • wradlib.trafo.KuBandToS
  • wradlib.trafo.KuBandToX
  • wradlib.trafo.SBandToKu
  • wradlib.trafo.TrafoMethods
• rvp_to_dbz
• decibel
• idecibel
• r_to_depth
• kdp_to_r
• si_to_kmh
• si_to_mph
• si_to_kts
• kmh_to_si
• mph_to_si
• kts_to_si
• KuBandToS
  • KuBandToS.snow
  • KuBandToS.hail
• KuBandToX
  • KuBandToX.snow
  • KuBandToX.hail
• SBandToKu
  • SBandToKu.snow
  • SBandToKu.rain
• TrafoMethods
  • TrafoMethods.decibel
  • TrafoMethods.idecibel
  • TrafoMethods.r_to_depth
• Utility functions
  • wradlib.util.from_to
  • wradlib.util.filter_window_polar
  • wradlib.util.filter_window_cartesian
  • wradlib.util.find_bbox_indices
  • wradlib.util.get_raster_origin
  • wradlib.util.calculate_polynomial
  • wradlib.util.derivate
  • wradlib.util.despeckle
  • wradlib.util.import_optional
  • wradlib.util.cross_section_ppi
  • wradlib.util.UtilMethods
• from_to
• filter_window_polar
• filter_window_cartesian
• find_bbox_indices
• get_raster_origin
• calculate_polynomial
• derivate
• despeckle
• import_optional
• cross_section_ppi
• UtilMethods
  • UtilMethods.despeckle
  • UtilMethods.derivate
  • UtilMethods.dim0
• Verification
  • wradlib.verify.ErrorMetrics
  • wradlib.verify.PolarNeighbours
• ErrorMetrics
  • ErrorMetrics.corr
  • ErrorMetrics.r2
  • ErrorMetrics.spearman
  • ErrorMetrics.nash
  • ErrorMetrics.sse
  • ErrorMetrics.mse
  • ErrorMetrics.rmse
  • ErrorMetrics.mas
  • ErrorMetrics.meanerr
  • ErrorMetrics.ratio
  • ErrorMetrics.pbias
  • ErrorMetrics.all
  • ErrorMetrics.pprint
• PolarNeighbours
  • PolarNeighbours.extract
  • PolarNeighbours.get_bincoords
  • PolarNeighbours.get_bincoords_at_points
• Visualisation
  • wradlib.vis.plot
  • wradlib.vis.plot_ppi_crosshair
  • wradlib.vis.create_cg
  • wradlib.vis.plot_scan_strategy
  • wradlib.vis.plot_plan_and_vert
  • wradlib.vis.plot_max_plan_and_vert
  • wradlib.vis.add_lines
  • wradlib.vis.add_patches
  • wradlib.vis.VisMethods
• plot
• plot_ppi_crosshair
• create_cg
• plot_scan_strategy
• plot_plan_and_vert
• plot_max_plan_and_vert
• add_lines
• add_patches
• VisMethods
  • VisMethods.plot
  • VisMethods.pcolormesh
  • VisMethods.contour
  • VisMethods.contourf
• Vertical Profile of Reflectivity (VPR)
  • wradlib.vpr.volcoords_from_polar
  • wradlib.vpr.make_3d_grid
  • wradlib.vpr.norm_vpr_stats
  • wradlib.vpr.CartesianVolume
  • wradlib.vpr.CAPPI
  • wradlib.vpr.PseudoCAPPI
  • wradlib.vpr.out_of_range
  • wradlib.vpr.blindspots
• volcoords_from_polar
• make_3d_grid
• norm_vpr_stats
• CartesianVolume
• CAPPI
• PseudoCAPPI
• out_of_range
• blindspots
• wradlib Xarray Accessors
  • wradlib.xarray.WradlibXarrayAccessor
• WradlibXarrayAccessor
  • WradlibXarrayAccessor.atten
  • WradlibXarrayAccessor.classify
  • WradlibXarrayAccessor.comp
  • WradlibXarrayAccessor.dp
  • WradlibXarrayAccessor.georef
  • WradlibXarrayAccessor.ipol
  • WradlibXarrayAccessor.qual
  • WradlibXarrayAccessor.trafo
  • WradlibXarrayAccessor.util
  • WradlibXarrayAccessor.vis
  • WradlibXarrayAccessor.zr
• Zonal Statistics
  • wradlib.zonalstats.ZonalDataBase
  • wradlib.zonalstats.ZonalDataPoint
  • wradlib.zonalstats.ZonalDataPoly
  • wradlib.zonalstats.ZonalStatsBase
  • wradlib.zonalstats.ZonalStatsPoly
  • wradlib.zonalstats.ZonalStatsPoint
  • wradlib.zonalstats.mask_from_bbox
  • wradlib.zonalstats.get_bbox
  • wradlib.zonalstats.grid_centers_to_vertices
  • wradlib.zonalstats.get_clip_mask
• ZonalDataBase
  • ZonalDataBase.count_intersections
  • ZonalDataBase.crs
  • ZonalDataBase.isecs
  • ZonalDataBase.get_isec
  • ZonalDataBase.get_source_index
  • ZonalDataBase.dump_vector
  • ZonalDataBase.load_vector
• ZonalDataPoint
• ZonalDataPoly
• ZonalStatsBase
  • ZonalStatsBase.zdata
  • ZonalStatsBase.ix
  • ZonalStatsBase.w
  • ZonalStatsBase.check_empty
  • ZonalStatsBase.mean
  • ZonalStatsBase.var
• ZonalStatsPoly
• ZonalStatsPoint
• mask_from_bbox
• get_bbox
• grid_centers_to_vertices
• get_clip_mask
• Z-R Conversions
  • wradlib.zr.z_to_r
  • wradlib.zr.r_to_z
  • wradlib.zr.z_to_r_enhanced
  • wradlib.zr.ZRMethods
• z_to_r
• r_to_z
• z_to_r_enhanced
• ZRMethods
  • ZRMethods.z_to_r
  • ZRMethods.r_to_z
  • ZRMethods.z_to_r_enhanced