API Reference

Module Contents:

• rivgraph
  • RivGraph (classes.py)
  • delta
    • delta.Iskel
    • delta.topo_metrics
    • delta.__init__()
    • delta.assign_flow_directions()
    • delta.compute_topologic_metrics()
    • delta.prune_network()
    • delta.skeletonize()
  • river
    • river.Iskel
    • river.topo_metrics
    • river.centerline
    • river.centerline_smooth
    • river.max_valley_width_pixels
    • river.width_chans
    • river.width_extent
    • river.meshlines
    • river.meshpolys
    • river.skeletonize()
    • river.prune_network()
    • river.compute_centerline()
    • river.compute_mesh()
    • river.assign_flow_direcions()
    • river.set_flow_dirs_manually()
    • river.__init__()
    • river.name
    • river.verbose
    • river.d
    • river.mask_path
    • river.imshape
    • river.gt
    • river.wkt
    • river.epsg
    • river.unit
    • river.pixarea
    • river.pixlen
    • river.paths
    • river.exit_sides
    • river.Imask
    • river.links
    • river.nodes
    • river.Idist
    • river.assign_flow_directions()
    • river.compute_centerline()
    • river.compute_mesh()
    • river.prune_network()
    • river.skeletonize()
  • rivnetwork
    • rivnetwork.__init__()
    • rivnetwork.name
    • rivnetwork.verbose
    • rivnetwork.d
    • rivnetwork.mask_path
    • rivnetwork.imshape
    • rivnetwork.gt
    • rivnetwork.wkt
    • rivnetwork.epsg
    • rivnetwork.unit
    • rivnetwork.pixarea
    • rivnetwork.pixlen
    • rivnetwork.paths
    • rivnetwork.exit_sides
    • rivnetwork.Imask
    • rivnetwork.links
    • rivnetwork.nodes
    • rivnetwork.Idist
    • rivnetwork.__weakref__
    • rivnetwork.adjacency_matrix()
    • rivnetwork.compute_distance_transform()
    • rivnetwork.compute_junction_angles()
    • rivnetwork.compute_link_width_and_length()
    • rivnetwork.compute_network()
    • rivnetwork.get_islands()
    • rivnetwork.init_logger()
    • rivnetwork.load_network()
    • rivnetwork.plot()
    • rivnetwork.save_network()
    • rivnetwork.to_geotiff()
    • rivnetwork.to_geovectors()
  • Directionality Utilities (directionality.py)
  • add_directionality_trackers()
  • algmap()
  • check_continuity()
  • cycle_get_original_orientation()
  • cycle_return_to_original_orientation()
  • dir_bridges()
  • dir_known_link_angles()
  • dir_main_channel()
  • dir_set_manually()
  • dir_shortest_paths_links()
  • dir_shortest_paths_nodes()
  • find_a_cycle()
  • fix_cycles()
  • fix_sources_and_sinks()
  • flip_links_in_G()
  • get_cycles()
  • get_link_vector()
  • merge_list_of_lists()
  • nodepath_to_links()
  • set_artificial_nodes()
  • set_by_known_flow_directions()
  • set_by_nearest_main_channel()
  • set_continuity()
  • set_inletoutlet()
  • set_link()
  • set_parallel_links()
  • widest_inlet_index()
  • Georeferencing Utilities (geo_utils.py)
  • coords_to_xy()
  • crop_geotif()
  • downsample_binary_geotiff()
  • geotiff_vals_from_coords()
  • get_unit()
  • idx_to_coords()
  • transform_coords()
  • xy_to_coords()
  • Image Utilities (im_utils.py)
  • blob_idcs()
  • bp_kernels()
  • crop_binary_coords()
  • crop_binary_im()
  • dilate()
  • downsample_binary_image()
  • edge_coords()
  • erode()
  • fill_holes()
  • four_conn()
  • get_array()
  • hand_clean()
  • im_connectivity()
  • imshowpair()
  • largest_blobs()
  • neighbor_idcs()
  • neighbor_vals()
  • neighbor_xy()
  • neighbors_flat()
  • nfour_connectivity()
  • regionprops()
  • reglobalize_flat_idx()
  • remove_blobs()
  • skel_branchpoints()
  • skel_endpoints()
  • skel_kernels()
  • skel_pixel_curvature()
  • trim_idcs()
  • Input/Output Utilities (io_utils.py)
  • centerline_to_geovector()
  • colortable()
  • coords_from_geovector()
  • coords_to_geovector()
  • create_manual_dir_csv()
  • get_driver()
  • links_to_geofile()
  • nodes_to_geofile()
  • pickle_links_and_nodes()
  • prepare_paths()
  • shapely_list_to_geovectors()
  • unpickle_links_and_nodes()
  • write_geotiff()
  • write_linkdirs_geotiff()
  • Network Utilities (ln_utils.py)
  • add_artificial_nodes()
  • add_link()
  • add_node()
  • adjust_for_padding()
  • append_link_lengths()
  • conn_links()
  • delete_link()
  • delete_node()
  • find_art_links()
  • find_parallel_links()
  • flip_link()
  • junction_angles()
  • link_updater()
  • link_widths_and_lengths()
  • links_to_gpd()
  • node_updater()
  • plot_dirlinks()
  • plot_network()
  • remove_all_spurs()
  • remove_disconnected_bridge_links()
  • remove_duplicate_links()
  • remove_single_pixel_links()
  • remove_two_link_nodes()
  • Mask to Graph Utilities (mask_to_graph.py)
  • pad_river_im()
  • simplify_skel()
  • skel_to_graph()
  • skeletonize_mask()
  • skeletonize_river_mask()
  • Mask Filtering Utils (mask_utils.py)
  • get_island_properties()
  • pixagon()
  • surrounding_link_properties()
  • Skeleton Walking Utils (walk.py)
  • bp_cluster()
  • cant_walk()
  • check_dup_links()
  • delete_link()
  • find_emanators()
  • get_neighbors()
  • handle_bp()
  • idcs_no_turnaround()
  • is_bp()
  • isbp_parsimonious()
  • isbp_walk_for_bps()
  • naxes_connectivity()
  • walkable_neighbors()
• deltas
  • delta_directionality
  • dir_synthetic_DEM()
  • fix_delta_cycle()
  • fix_delta_cycles()
  • hull_coords()
  • set_initial_directionality()
  • set_link_directions()
  • delta_metrics
  • add_super_apex()
  • calc_QR()
  • compute_delta_metrics()
  • compute_steady_state_link_fluxes()
  • delete_super_apex()
  • delta_nER()
  • delta_subN_F()
  • dist_from_apex()
  • dyn_entropy_based_dyn()
  • dyn_flux_sharing_index()
  • dyn_leakage_index()
  • dyn_pairwise_dep()
  • ensure_single_inlet()
  • find_inlet_outlet_nodes()
  • graphiphy()
  • graphshortestpath()
  • intermediate_vars()
  • nl_entropy_rate()
  • normalize_adj_matrix()
  • top_entropy_based_topo()
  • top_link_sharing_index()
  • top_number_alternative_paths()
  • top_resistance_distance()
  • top_s2s_topo_pairwise_dep()
  • delta_utils
  • clip_by_shoreline()
  • find_inlet_nodes()
  • prune_delta()
• rivers
  • river_directionality
  • dir_centerline()
  • dir_link_widths()
  • directional_info()
  • fix_river_cycle()
  • fix_river_cycles()
  • re_set_linkdirs()
  • set_directionality()
  • set_unknown_cluster_by_widthpct()
  • river_utils
  • centerline_mesh()
  • compute_eBI()
  • find_inlet_outlet_nodes()
  • mask_to_centerline()
  • max_valley_width()
  • mirror_line_ends()
  • prune_river()
  • valleyline_mesh()