WbW_tutorial_geomorfometria.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "marine-gregory",
   "metadata": {},
   "source": [
    "# WhiteboxWorkflows no Python: Geomorfometria\n",
    "\n",
    "### Prof. Carlos H. Grohmann - IEE-USP  \n",
    "\n",
    "### Exemplo de uso do WhiteboxWorkflows com análise de um Modelo de Elevação  \n",
    "\n",
    "manual: https://www.whiteboxgeo.com/manual/wbw-user-manual/book/preface.html\n",
    "\n",
    "tutoriais: https://www.whiteboxgeo.com/manual/wbw-user-manual/book/tutorials.html"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "arbitrary-kelly",
   "metadata": {},
   "source": [
    "## Instalação WbW e setup"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 57,
   "id": "seasonal-driver",
   "metadata": {},
   "outputs": [],
   "source": [
    "# Lembre-se que você precisa ter o WhiteboxWorkflows instalado. Se não tiver, pode fazer o download na próxima célula\n",
    "# !pip install whitebox-workflows"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 11,
   "id": "75b5b5cb-c4f1-43e0-8f09-ce678aa952b8",
   "metadata": {},
   "outputs": [],
   "source": [
    "import sys\n",
    "sys.path.append('C:\\\\users\\\\pc\\\\appdata\\\\local\\\\packages\\\\pythonsoftwarefoundation.python.3.7_qbz5n2kfra8p0\\\\localcache\\\\local-packages\\\\python37\\\\site-packages')"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 10,
   "id": "searching-region",
   "metadata": {},
   "outputs": [],
   "source": [
    "# setup inicial \n",
    "import whitebox_workflows as wbw\n",
    "wbe = wbw.WbEnvironment()\n",
    "wbe.verbose = True\n",
    "wbe.working_directory = 'C:\\\\users\\\\pc\\\\Desktop'"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 22,
   "id": "c7744953-50f5-4a82-8dbb-93c8efec394f",
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "['__class__',\n",
       " '__delattr__',\n",
       " '__dir__',\n",
       " '__doc__',\n",
       " '__eq__',\n",
       " '__format__',\n",
       " '__ge__',\n",
       " '__getattribute__',\n",
       " '__gt__',\n",
       " '__hash__',\n",
       " '__init__',\n",
       " '__init_subclass__',\n",
       " '__le__',\n",
       " '__lt__',\n",
       " '__module__',\n",
       " '__ne__',\n",
       " '__new__',\n",
       " '__reduce__',\n",
       " '__reduce_ex__',\n",
       " '__repr__',\n",
       " '__setattr__',\n",
       " '__sizeof__',\n",
       " '__str__',\n",
       " '__subclasshook__',\n",
       " 'accumulation_curvature',\n",
       " 'adaptive_filter',\n",
       " 'add_point_coordinates_to_table',\n",
       " 'aggregate_raster',\n",
       " 'anova',\n",
       " 'ascii_to_las',\n",
       " 'aspect',\n",
       " 'assess_route',\n",
       " 'attribute_correlation',\n",
       " 'attribute_histogram',\n",
       " 'attribute_scattergram',\n",
       " 'average_flowpath_slope',\n",
       " 'average_normal_vector_angular_deviation',\n",
       " 'average_overlay',\n",
       " 'average_upslope_flowpath_length',\n",
       " 'balance_contrast_enhancement',\n",
       " 'basins',\n",
       " 'bilateral_filter',\n",
       " 'block_maximum',\n",
       " 'block_minimum',\n",
       " 'bool_and',\n",
       " 'bool_not',\n",
       " 'bool_or',\n",
       " 'bool_xor',\n",
       " 'boundary_shape_complexity',\n",
       " 'breach_depressions_least_cost',\n",
       " 'breach_single_cell_pits',\n",
       " 'breakline_mapping',\n",
       " 'buffer_raster',\n",
       " 'burn_streams_at_roads',\n",
       " 'canny_edge_detection',\n",
       " 'centroid_raster',\n",
       " 'centroid_vector',\n",
       " 'change_vector_analysis',\n",
       " 'check_in_license',\n",
       " 'circular_variance_of_aspect',\n",
       " 'classify_buildings_in_lidar',\n",
       " 'classify_lidar',\n",
       " 'classify_overlap_points',\n",
       " 'clean_vector',\n",
       " 'clip',\n",
       " 'clip_lidar_to_polygon',\n",
       " 'clip_raster_to_polygon',\n",
       " 'closing',\n",
       " 'clump',\n",
       " 'colourize_based_on_class',\n",
       " 'colourize_based_on_point_returns',\n",
       " 'compactness_ratio',\n",
       " 'conservative_smoothing_filter',\n",
       " 'construct_vector_tin',\n",
       " 'contours_from_points',\n",
       " 'contours_from_raster',\n",
       " 'convert_nodata_to_zero',\n",
       " 'corner_detection',\n",
       " 'correct_vignetting',\n",
       " 'cost_allocation',\n",
       " 'cost_distance',\n",
       " 'cost_pathway',\n",
       " 'count_if',\n",
       " 'create_colour_composite',\n",
       " 'create_plane',\n",
       " 'crispness_index',\n",
       " 'cross_tabulation',\n",
       " 'csv_points_to_vector',\n",
       " 'cumulative_distribution',\n",
       " 'curvedness',\n",
       " 'd8_flow_accum',\n",
       " 'd8_mass_flux',\n",
       " 'd8_pointer',\n",
       " 'dbscan',\n",
       " 'dem_void_filling',\n",
       " 'depth_in_sink',\n",
       " 'depth_to_water',\n",
       " 'deviation_from_mean_elevation',\n",
       " 'deviation_from_regional_direction',\n",
       " 'diff_of_gaussians_filter',\n",
       " 'difference',\n",
       " 'difference_curvature',\n",
       " 'difference_from_mean_elevation',\n",
       " 'dinf_flow_accum',\n",
       " 'dinf_mass_flux',\n",
       " 'dinf_pointer',\n",
       " 'direct_decorrelation_stretch',\n",
       " 'directional_relief',\n",
       " 'dissolve',\n",
       " 'distance_to_outlet',\n",
       " 'diversity_filter',\n",
       " 'downslope_distance_to_stream',\n",
       " 'downslope_flowpath_length',\n",
       " 'downslope_index',\n",
       " 'edge_contamination',\n",
       " 'edge_density',\n",
       " 'edge_preserving_mean_filter',\n",
       " 'edge_proportion',\n",
       " 'elev_relative_to_min_max',\n",
       " 'elev_relative_to_watershed_min_max',\n",
       " 'elevation_above_pit',\n",
       " 'elevation_above_stream',\n",
       " 'elevation_above_stream_euclidean',\n",
       " 'elevation_percentile',\n",
       " 'eliminate_coincident_points',\n",
       " 'elongation_ratio',\n",
       " 'embankment_mapping',\n",
       " 'emboss_filter',\n",
       " 'erase',\n",
       " 'erase_polygon_from_lidar',\n",
       " 'erase_polygon_from_raster',\n",
       " 'euclidean_allocation',\n",
       " 'euclidean_distance',\n",
       " 'evaluate_training_sites',\n",
       " 'export_table_to_csv',\n",
       " 'exposure_towards_wind_flux',\n",
       " 'extend_vector_lines',\n",
       " 'extract_by_attribute',\n",
       " 'extract_nodes',\n",
       " 'extract_raster_values_at_points',\n",
       " 'extract_streams',\n",
       " 'extract_valleys',\n",
       " 'farthest_channel_head',\n",
       " 'fast_almost_gaussian_filter',\n",
       " 'fd8_flow_accum',\n",
       " 'fd8_pointer',\n",
       " 'feature_preserving_smoothing',\n",
       " 'fetch_analysis',\n",
       " 'fill_burn',\n",
       " 'fill_depressions',\n",
       " 'fill_depressions_planchon_and_darboux',\n",
       " 'fill_depressions_wang_and_liu',\n",
       " 'fill_missing_data',\n",
       " 'fill_pits',\n",
       " 'filter_lidar',\n",
       " 'filter_lidar_classes',\n",
       " 'filter_lidar_scan_angles',\n",
       " 'filter_raster_features_by_area',\n",
       " 'find_flightline_edge_points',\n",
       " 'find_lowest_or_highest_points',\n",
       " 'find_main_stem',\n",
       " 'find_noflow_cells',\n",
       " 'find_parallel_flow',\n",
       " 'find_patch_edge_cells',\n",
       " 'find_ridges',\n",
       " 'fix_dangling_arcs',\n",
       " 'flatten_lakes',\n",
       " 'flightline_overlap',\n",
       " 'flip_image',\n",
       " 'flood_order',\n",
       " 'flow_accum_full_workflow',\n",
       " 'flow_length_diff',\n",
       " 'gamma_correction',\n",
       " 'gaussian_contrast_stretch',\n",
       " 'gaussian_curvature',\n",
       " 'gaussian_filter',\n",
       " 'generalize_classified_raster',\n",
       " 'generalize_with_similarity',\n",
       " 'generating_function',\n",
       " 'geomorphons',\n",
       " 'hack_stream_order',\n",
       " 'heat_map',\n",
       " 'height_above_ground',\n",
       " 'hexagonal_grid_from_raster_base',\n",
       " 'hexagonal_grid_from_vector_base',\n",
       " 'high_pass_filter',\n",
       " 'high_pass_median_filter',\n",
       " 'highest_position',\n",
       " 'hillshade',\n",
       " 'hillslopes',\n",
       " 'histogram_equalization',\n",
       " 'histogram_matching',\n",
       " 'histogram_matching_two_images',\n",
       " 'hole_proportion',\n",
       " 'horizon_angle',\n",
       " 'horizontal_excess_curvature',\n",
       " 'horton_stream_order',\n",
       " 'hydrologic_connectivity',\n",
       " 'hypsometric_analysis',\n",
       " 'hypsometrically_tinted_hillshade',\n",
       " 'idw_interpolation',\n",
       " 'ihs_to_rgb',\n",
       " 'image_autocorrelation',\n",
       " 'image_correlation',\n",
       " 'image_correlation_neighbourhood_analysis',\n",
       " 'image_regression',\n",
       " 'image_segmentation',\n",
       " 'image_slider',\n",
       " 'image_stack_profile',\n",
       " 'impoundment_size_index',\n",
       " 'individual_tree_detection',\n",
       " 'insert_dams',\n",
       " 'integral_image_transform',\n",
       " 'intersect',\n",
       " 'inverse_pca',\n",
       " 'isobasins',\n",
       " 'jenson_snap_pour_points',\n",
       " 'join_tables',\n",
       " 'k_means_clustering',\n",
       " 'k_nearest_mean_filter',\n",
       " 'kappa_index',\n",
       " 'knn_classification',\n",
       " 'knn_regression',\n",
       " 'ks_normality_test',\n",
       " 'laplacian_filter',\n",
       " 'laplacian_of_gaussians_filter',\n",
       " 'las_to_ascii',\n",
       " 'las_to_shapefile',\n",
       " 'layer_footprint_raster',\n",
       " 'layer_footprint_vector',\n",
       " 'lee_filter',\n",
       " 'length_of_upstream_channels',\n",
       " 'license_type',\n",
       " 'lidar_block_maximum',\n",
       " 'lidar_block_minimum',\n",
       " 'lidar_classify_subset',\n",
       " 'lidar_colourize',\n",
       " 'lidar_construct_vector_tin',\n",
       " 'lidar_contour',\n",
       " 'lidar_digital_surface_model',\n",
       " 'lidar_eigenvalue_features',\n",
       " 'lidar_elevation_slice',\n",
       " 'lidar_ground_point_filter',\n",
       " 'lidar_hex_bin',\n",
       " 'lidar_hillshade',\n",
       " 'lidar_histogram',\n",
       " 'lidar_idw_interpolation',\n",
       " 'lidar_info',\n",
       " 'lidar_join',\n",
       " 'lidar_kappa',\n",
       " 'lidar_nearest_neighbour_gridding',\n",
       " 'lidar_point_density',\n",
       " 'lidar_point_return_analysis',\n",
       " 'lidar_point_stats',\n",
       " 'lidar_radial_basis_function_interpolation',\n",
       " 'lidar_ransac_planes',\n",
       " 'lidar_remove_outliers',\n",
       " 'lidar_rooftop_analysis',\n",
       " 'lidar_segmentation',\n",
       " 'lidar_segmentation_based_filter',\n",
       " 'lidar_shift',\n",
       " 'lidar_sibson_interpolation',\n",
       " 'lidar_thin',\n",
       " 'lidar_thin_high_density',\n",
       " 'lidar_tile',\n",
       " 'lidar_tile_footprint',\n",
       " 'lidar_tin_gridding',\n",
       " 'lidar_tophat_transform',\n",
       " 'line_detection_filter',\n",
       " 'line_intersections',\n",
       " 'line_thinning',\n",
       " 'linearity_index',\n",
       " 'lines_to_polygons',\n",
       " 'list_unique_values',\n",
       " 'list_unique_values_raster',\n",
       " 'local_hypsometric_analysis',\n",
       " 'logistic_regression',\n",
       " 'long_profile',\n",
       " 'long_profile_from_points',\n",
       " 'longest_flowpath',\n",
       " 'low_points_on_headwater_divides',\n",
       " 'lowest_position',\n",
       " 'majority_filter',\n",
       " 'map_off_terrain_objects',\n",
       " 'max_absolute_overlay',\n",
       " 'max_anisotropy_dev',\n",
       " 'max_anisotropy_dev_signature',\n",
       " 'max_branch_length',\n",
       " 'max_difference_from_mean',\n",
       " 'max_downslope_elev_change',\n",
       " 'max_elevation_dev_signature',\n",
       " 'max_elevation_deviation',\n",
       " 'max_overlay',\n",
       " 'max_procs',\n",
       " 'max_upslope_elev_change',\n",
       " 'max_upslope_flowpath_length',\n",
       " 'max_upslope_value',\n",
       " 'maximal_curvature',\n",
       " 'maximum_filter',\n",
       " 'mdinf_flow_accum',\n",
       " 'mean_curvature',\n",
       " 'mean_filter',\n",
       " 'median_filter',\n",
       " 'medoid',\n",
       " 'merge_line_segments',\n",
       " 'merge_table_with_csv',\n",
       " 'merge_vectors',\n",
       " 'min_absolute_overlay',\n",
       " 'min_dist_classification',\n",
       " 'min_downslope_elev_change',\n",
       " 'min_max_contrast_stretch',\n",
       " 'min_overlay',\n",
       " 'minimal_curvature',\n",
       " 'minimum_bounding_box',\n",
       " 'minimum_bounding_circle',\n",
       " 'minimum_bounding_envelope',\n",
       " 'minimum_convex_hull',\n",
       " 'minimum_filter',\n",
       " 'modified_k_means_clustering',\n",
       " 'modify_lidar',\n",
       " 'modify_nodata_value',\n",
       " 'mosaic',\n",
       " 'mosaic_with_feathering',\n",
       " 'multidirectional_hillshade',\n",
       " 'multipart_to_singlepart',\n",
       " 'multiply_overlay',\n",
       " 'multiscale_curvatures',\n",
       " 'multiscale_elevation_percentile',\n",
       " 'multiscale_roughness',\n",
       " 'multiscale_roughness_signature',\n",
       " 'multiscale_std_dev_normals',\n",
       " 'multiscale_std_dev_normals_signature',\n",
       " 'multiscale_topographic_position_image',\n",
       " 'narrowness_index',\n",
       " 'natural_neighbour_interpolation',\n",
       " 'nearest_neighbour_interpolation',\n",
       " 'new_lidar',\n",
       " 'new_raster',\n",
       " 'new_raster_from_base_raster',\n",
       " 'new_raster_from_base_vector',\n",
       " 'new_vector',\n",
       " 'normal_vectors',\n",
       " 'normalize_lidar',\n",
       " 'normalized_difference_index',\n",
       " 'num_downslope_neighbours',\n",
       " 'num_inflowing_neighbours',\n",
       " 'olympic_filter',\n",
       " 'opening',\n",
       " 'openness',\n",
       " 'otsu_thresholding',\n",
       " 'paired_sample_t_test',\n",
       " 'panchromatic_sharpening',\n",
       " 'parallelepiped_classification',\n",
       " 'patch_orientation',\n",
       " 'pennock_landform_classification',\n",
       " 'percent_elev_range',\n",
       " 'percent_equal_to',\n",
       " 'percent_greater_than',\n",
       " 'percent_less_than',\n",
       " 'percentage_contrast_stretch',\n",
       " 'percentile_filter',\n",
       " 'perimeter_area_ratio',\n",
       " 'phi_coefficient',\n",
       " 'pick_from_list',\n",
       " 'piecewise_contrast_stretch',\n",
       " 'plan_curvature',\n",
       " 'polygon_area',\n",
       " 'polygon_long_axis',\n",
       " 'polygon_perimeter',\n",
       " 'polygon_short_axis',\n",
       " 'polygonize',\n",
       " 'polygons_to_lines',\n",
       " 'prewitt_filter',\n",
       " 'principal_component_analysis',\n",
       " 'print_geotiff_tags',\n",
       " 'profile',\n",
       " 'profile_curvature',\n",
       " 'prune_vector_streams',\n",
       " 'qin_flow_accumulation',\n",
       " 'quantiles',\n",
       " 'quinn_flow_accumulation',\n",
       " 'radial_basis_function_interpolation',\n",
       " 'radius_of_gyration',\n",
       " 'raise_walls',\n",
       " 'random_field',\n",
       " 'random_forest_classification',\n",
       " 'random_forest_regression',\n",
       " 'random_sample',\n",
       " 'range_filter',\n",
       " 'raster_area',\n",
       " 'raster_calculator',\n",
       " 'raster_cell_assignment',\n",
       " 'raster_histogram',\n",
       " 'raster_perimeter',\n",
       " 'raster_streams_to_vector',\n",
       " 'raster_summary_stats',\n",
       " 'raster_to_vector_lines',\n",
       " 'raster_to_vector_points',\n",
       " 'raster_to_vector_polygons',\n",
       " 'rasterize_streams',\n",
       " 'read_lidar',\n",
       " 'read_lidars',\n",
       " 'read_raster',\n",
       " 'read_rasters',\n",
       " 'read_vector',\n",
       " 'read_vectors',\n",
       " 'reciprocal',\n",
       " 'reclass',\n",
       " 'reclass_equal_interval',\n",
       " 'reconcile_multiple_headers',\n",
       " 'recover_flightline_info',\n",
       " 'recreate_pass_lines',\n",
       " 'rectangular_grid_from_raster_base',\n",
       " 'rectangular_grid_from_vector_base',\n",
       " 'reinitialize_attribute_table',\n",
       " 'related_circumscribing_circle',\n",
       " 'relative_aspect',\n",
       " 'relative_stream_power_index',\n",
       " 'relative_topographic_position',\n",
       " 'remove_duplicates',\n",
       " 'remove_field_edge_points',\n",
       " 'remove_off_terrain_objects',\n",
       " 'remove_polygon_holes',\n",
       " 'remove_raster_polygon_holes',\n",
       " 'remove_short_streams',\n",
       " 'remove_spurs',\n",
       " 'repair_stream_vector_topology',\n",
       " 'resample',\n",
       " 'rescale_value_range',\n",
       " 'rgb_to_ihs',\n",
       " 'rho8_flow_accum',\n",
       " 'rho8_pointer',\n",
       " 'ring_curvature',\n",
       " 'river_centerlines',\n",
       " 'roberts_cross_filter',\n",
       " 'root_mean_square_error',\n",
       " 'rotor',\n",
       " 'ruggedness_index',\n",
       " 'scharr_filter',\n",
       " 'sediment_transport_index',\n",
       " 'select_tiles_by_polygon',\n",
       " 'set_nodata_value',\n",
       " 'shadow_animation',\n",
       " 'shadow_image',\n",
       " 'shape_complexity_index_raster',\n",
       " 'shape_complexity_index_vector',\n",
       " 'shape_index',\n",
       " 'shreve_stream_magnitude',\n",
       " 'sigmoidal_contrast_stretch',\n",
       " 'singlepart_to_multipart',\n",
       " 'sink',\n",
       " 'slope',\n",
       " 'slope_vs_aspect_plot',\n",
       " 'slope_vs_elev_plot',\n",
       " 'smooth_vectors',\n",
       " 'smooth_vegetation_residual',\n",
       " 'snap_pour_points',\n",
       " 'sobel_filter',\n",
       " 'sort_lidar',\n",
       " 'spherical_std_dev_of_normals',\n",
       " 'split_colour_composite',\n",
       " 'split_lidar',\n",
       " 'split_vector_lines',\n",
       " 'split_with_lines',\n",
       " 'standard_deviation_contrast_stretch',\n",
       " 'standard_deviation_filter',\n",
       " 'standard_deviation_of_slope',\n",
       " 'stochastic_depression_analysis',\n",
       " 'strahler_order_basins',\n",
       " 'strahler_stream_order',\n",
       " 'stream_link_class',\n",
       " 'stream_link_identifier',\n",
       " 'stream_link_length',\n",
       " 'stream_link_slope',\n",
       " 'stream_slope_continuous',\n",
       " 'subbasins',\n",
       " 'sum_overlay',\n",
       " 'surface_area_ratio',\n",
       " 'svm_classification',\n",
       " 'svm_regression',\n",
       " 'symmetrical_difference',\n",
       " 'tangential_curvature',\n",
       " 'thicken_raster_line',\n",
       " 'time_in_daylight',\n",
       " 'tin_interpolation',\n",
       " 'tophat_transform',\n",
       " 'topo_render',\n",
       " 'topographic_hachures',\n",
       " 'topographic_position_animation',\n",
       " 'topological_breach_burn',\n",
       " 'topological_stream_order',\n",
       " 'total_curvature',\n",
       " 'total_filter',\n",
       " 'trace_downslope_flowpaths',\n",
       " 'travelling_salesman_problem',\n",
       " 'trend_surface',\n",
       " 'trend_surface_vector_points',\n",
       " 'tributary_identifier',\n",
       " 'turning_bands_simulation',\n",
       " 'two_sample_ks_test',\n",
       " 'union',\n",
       " 'unnest_basins',\n",
       " 'unsharp_masking',\n",
       " 'unsphericity',\n",
       " 'update_nodata_cells',\n",
       " 'upslope_depression_storage',\n",
       " 'user_defined_weights_filter',\n",
       " 'vector_hex_binning',\n",
       " 'vector_lines_to_raster',\n",
       " 'vector_points_to_raster',\n",
       " 'vector_polygons_to_raster',\n",
       " 'vector_stream_network_analysis',\n",
       " 'verbose',\n",
       " 'version',\n",
       " 'vertical_excess_curvature',\n",
       " 'viewshed',\n",
       " 'visibility_index',\n",
       " 'voronoi_diagram',\n",
       " 'watershed',\n",
       " 'watershed_from_raster_pour_points',\n",
       " 'weighted_overlay',\n",
       " 'weighted_sum',\n",
       " 'wetness_index',\n",
       " 'wilcoxon_signed_rank_test',\n",
       " 'working_directory',\n",
       " 'write_function_memory_insertion',\n",
       " 'write_lidar',\n",
       " 'write_raster',\n",
       " 'write_vector',\n",
       " 'yield_filter',\n",
       " 'yield_map',\n",
       " 'yield_normalization',\n",
       " 'z_scores',\n",
       " 'zonal_statistics']"
      ]
     },
     "execution_count": 22,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "dir(wbe)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 65,
   "id": "bizarre-venezuela",
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Help on built-in function zonal_statistics:\n",
      "\n",
      "zonal_statistics(...) method of builtins.WbEnvironment instance\n",
      "    This tool can be used to extract common descriptive statistics associated with the distribution\n",
      "    of some underlying data raster based on feature units defined by a feature definition raster.\n",
      "    For example, this tool can be used to measure the maximum or average slope gradient (data image)\n",
      "    for each of a group of watersheds (feature definitions). Although the data raster can contain any\n",
      "    type of data, the feature definition raster must be categorical, i.e. it must define area entities\n",
      "    using integer values.\n",
      "    \n",
      "    The `stat` parameter can take the values, 'mean', 'median', 'minimum', 'maximum', 'range',\n",
      "    'standard deviation', or 'total'.\n",
      "    \n",
      "    If an output image name is specified, the tool will assign the descriptive statistic value to\n",
      "    each of the spatial entities defined in the feature definition raster. If text output is selected,\n",
      "    an HTML table will be output, which can then be readily copied into a spreadsheet program for\n",
      "    further analysis. This is a very powerful and useful tool for creating numerical summary data from\n",
      "    spatial data which can then be interrogated using statistical analyses. At least one output type\n",
      "    (image or text) must be specified for the tool to operate.\n",
      "    \n",
      "    NoData values in either of the two input images are ignored during the calculation of the\n",
      "    descriptive statistic.\n",
      "    \n",
      "    # See Also\n",
      "    <a href=\"tool_help.md#raster_summary_stats\">raster_summary_stats</a>\n",
      "    \n",
      "    # Function Signature\n",
      "    ```python\n",
      "    def zonal_statistics(self, data_raster: Raster, feature_definitions_raster: Raster, stat_type: str = \"mean\") -> Tuple[Raster, str]: ...\n",
      "    ```\n",
      "\n"
     ]
    }
   ],
   "source": [
    "help(wbe.zonal_statistics)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "outdoor-bowling",
   "metadata": {},
   "outputs": [],
   "source": []
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "elegant-inspiration",
   "metadata": {},
   "outputs": [],
   "source": []
  },
  {
   "cell_type": "markdown",
   "id": "urban-certification",
   "metadata": {},
   "source": [
    "## Trabalhando com CopDEM"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "spiritual-banks",
   "metadata": {},
   "source": [
    "O arquivo TIF está disponível em: https://github.com/CarlosGrohmann/whitebox_scripts"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 25,
   "id": "convenient-coordinator",
   "metadata": {},
   "outputs": [],
   "source": [
    "cop_tif = 'CopDEM_clip_petar.tif'\n",
    "cop = cop_tif[:-4] # nome do arquivo sem extensão '.tif'   "
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 26,
   "id": "conceptual-ground",
   "metadata": {},
   "outputs": [],
   "source": [
    "# Reading raster data\n",
    "dem = wbe.read_raster(cop_tif)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 56,
   "id": "6898f06c-c5f1-41ff-801e-83d7655abafc",
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "<Raster at 0x126065e6070>"
      ]
     },
     "execution_count": 56,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "dem"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 53,
   "id": "14e4397d-1580-4a74-8f23-5fb3eb5be658",
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "['__abs__',\n",
       " '__add__',\n",
       " '__class__',\n",
       " '__delattr__',\n",
       " '__delitem__',\n",
       " '__dir__',\n",
       " '__doc__',\n",
       " '__eq__',\n",
       " '__floordiv__',\n",
       " '__format__',\n",
       " '__ge__',\n",
       " '__getattribute__',\n",
       " '__getitem__',\n",
       " '__gt__',\n",
       " '__hash__',\n",
       " '__iadd__',\n",
       " '__idiv__',\n",
       " '__imul__',\n",
       " '__init__',\n",
       " '__init_subclass__',\n",
       " '__isub__',\n",
       " '__le__',\n",
       " '__lt__',\n",
       " '__mod__',\n",
       " '__module__',\n",
       " '__mul__',\n",
       " '__ne__',\n",
       " '__neg__',\n",
       " '__new__',\n",
       " '__pow__',\n",
       " '__radd__',\n",
       " '__reduce__',\n",
       " '__reduce_ex__',\n",
       " '__repr__',\n",
       " '__rfloordiv__',\n",
       " '__rmod__',\n",
       " '__rmul__',\n",
       " '__rpow__',\n",
       " '__rsub__',\n",
       " '__rtruediv__',\n",
       " '__setattr__',\n",
       " '__setitem__',\n",
       " '__sizeof__',\n",
       " '__str__',\n",
       " '__sub__',\n",
       " '__subclasshook__',\n",
       " '__truediv__',\n",
       " 'acos',\n",
       " 'acosh',\n",
       " 'asin',\n",
       " 'asinh',\n",
       " 'atan',\n",
       " 'atan2',\n",
       " 'atanh',\n",
       " 'calculate_clip_values',\n",
       " 'calculate_mean',\n",
       " 'calculate_mean_and_stdev',\n",
       " 'ceil',\n",
       " 'con',\n",
       " 'configs',\n",
       " 'cos',\n",
       " 'cosh',\n",
       " 'decrement',\n",
       " 'decrement_row_data',\n",
       " 'deep_copy',\n",
       " 'exp',\n",
       " 'exp2',\n",
       " 'file_mode',\n",
       " 'file_name',\n",
       " 'floor',\n",
       " 'get_column_from_x',\n",
       " 'get_data_size_in_bytes',\n",
       " 'get_row_data',\n",
       " 'get_row_from_y',\n",
       " 'get_value',\n",
       " 'get_value_as_hsi',\n",
       " 'get_value_as_rgba',\n",
       " 'get_x_from_column',\n",
       " 'get_y_from_row',\n",
       " 'increment',\n",
       " 'increment_row_data',\n",
       " 'is_nodata',\n",
       " 'ln',\n",
       " 'log10',\n",
       " 'log2',\n",
       " 'max',\n",
       " 'min',\n",
       " 'new_from_other',\n",
       " 'normalize',\n",
       " 'num_cells',\n",
       " 'num_valid_cells',\n",
       " 'raster_type',\n",
       " 'reinitialize_values',\n",
       " 'set_data_from_raster',\n",
       " 'set_row_data',\n",
       " 'set_value',\n",
       " 'set_value_from_rgba',\n",
       " 'signum',\n",
       " 'sin',\n",
       " 'sinh',\n",
       " 'size_of',\n",
       " 'sqrt',\n",
       " 'square',\n",
       " 'tan',\n",
       " 'tanh',\n",
       " 'to_degrees',\n",
       " 'to_radians',\n",
       " 'trunc',\n",
       " 'update_display_min_max',\n",
       " 'update_min_max']"
      ]
     },
     "execution_count": 53,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "dir(dem)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 54,
   "id": "83cd3a5a-7912-4829-be91-c6dd49a412fb",
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "['__class__',\n",
       " '__delattr__',\n",
       " '__dir__',\n",
       " '__doc__',\n",
       " '__eq__',\n",
       " '__format__',\n",
       " '__ge__',\n",
       " '__getattribute__',\n",
       " '__gt__',\n",
       " '__hash__',\n",
       " '__init__',\n",
       " '__init_subclass__',\n",
       " '__le__',\n",
       " '__lt__',\n",
       " '__module__',\n",
       " '__ne__',\n",
       " '__new__',\n",
       " '__reduce__',\n",
       " '__reduce_ex__',\n",
       " '__repr__',\n",
       " '__setattr__',\n",
       " '__sizeof__',\n",
       " '__str__',\n",
       " '__subclasshook__',\n",
       " 'bands',\n",
       " 'columns',\n",
       " 'coordinate_ref_system_wkt',\n",
       " 'data_type',\n",
       " 'east',\n",
       " 'epsg_code',\n",
       " 'geo_ascii_params',\n",
       " 'geo_double_params',\n",
       " 'geo_key_directory',\n",
       " 'maximum',\n",
       " 'metadata',\n",
       " 'minimum',\n",
       " 'model_pixel_scale',\n",
       " 'model_tiepoint',\n",
       " 'model_transformation',\n",
       " 'nodata',\n",
       " 'north',\n",
       " 'photometric_interp',\n",
       " 'pixel_is_area',\n",
       " 'projection',\n",
       " 'reflect_at_edges',\n",
       " 'resolution_x',\n",
       " 'resolution_y',\n",
       " 'rows',\n",
       " 'south',\n",
       " 'title',\n",
       " 'west',\n",
       " 'xy_units',\n",
       " 'z_units']"
      ]
     },
     "execution_count": 54,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "dir(dem.configs)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "fbebbe96-d930-48e4-b5fb-6dcd8828a9d8",
   "metadata": {},
   "outputs": [],
   "source": [
    "# https://www.whiteboxgeo.com/manual/wbw-user-manual/book/working-with-raster-data.html\n",
    "\n",
    "def print_metadata(rast):\n",
    "    # The RasterConfigs of a Raster object contains useful metadata about the Raster.\n",
    "    print(f'Rows: {rast.configs.rows}')\n",
    "    print(f'Columns: {rast.configs.columns}')\n",
    "    print(f'Resolution (x direction): {rast.configs.resolution_x}')\n",
    "    print(f'Resolution (y direction): {rast.configs.resolution_y}')\n",
    "    print(f'North: {rast.configs.north}')\n",
    "    print(f'South: {rast.configs.south}')\n",
    "    print(f'East: {rast.configs.east}')\n",
    "    print(f'West: {rast.configs.west}')\n",
    "    print(f'Min value: {rast.configs.minimum}')\n",
    "    print(f'Max value: {rast.configs.maximum}')\n",
    "    print(f'EPSG code: {rast.configs.epsg_code}') # 0 if not set\n",
    "    print(f'Nodata value: {rast.configs.nodata}')\n",
    "    # What data type are stored in raster grid cells?\n",
    "    # See the RasterDataType class for more info.\n",
    "    print(f'Data type: {rast.configs.data_type}') \n",
    "    # What is the photometric interpretation, continuous, categorical, RGB, etc.?\n",
    "    # See the PhotometricInterpretation class for more info.\n",
    "    print(f'Photometric interpretation: {rast.configs.photometric_interp}')"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 55,
   "id": "d40fc4b7-b6f1-4122-a6a2-aa30dac15fd4",
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Rows: 810\n",
      "Columns: 778\n",
      "Resolution (x direction): 0.0002777777789203086\n",
      "Resolution (y direction): 0.0002777777777777751\n",
      "North: -24.40875\n",
      "South: -24.63347222222222\n",
      "East: -48.56847222177892\n",
      "West: -48.784305556\n",
      "Min value: 60.5\n",
      "Max value: 1131.17236328125\n",
      "EPSG code: 4326\n",
      "Nodata value: -32768.0\n",
      "Data type: RasterDataType.F32\n",
      "Photometric interpretation: PhotometricInterpretation.Continuous\n"
     ]
    }
   ],
   "source": [
    "print_metadata(dem)"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "807ed5aa-c7c6-4e4f-a3f8-b1571eb96cd3",
   "metadata": {},
   "source": [
    "#### relevo sombreado"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 66,
   "id": "spectacular-danger",
   "metadata": {
    "scrolled": true
   },
   "outputs": [],
   "source": [
    "# relevo sombreado\n",
    "az = 45\n",
    "alt = 35\n",
    "zf = 1\n",
    "\n",
    "shade = wbe.hillshade(dem=dem, azimuth=az, altitude=alt, z_factor=zf)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 67,
   "id": "67dc05f3-50b1-43aa-a80d-0d0e490c1f40",
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "<Raster at 0x126065e48d0>"
      ]
     },
     "execution_count": 67,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "shade"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 68,
   "id": "9cbc6954-57d4-48d2-b9c4-dfe72d24e9af",
   "metadata": {},
   "outputs": [],
   "source": [
    "shade_tif = f'{cop}_shade_{az}_{alt}_z{zf}.tif'\n",
    "wbe.write_raster(shade, shade_tif, compress=True)\n",
    "\n",
    "# opção - calcular e salvar tif em uma só linha\n",
    "wbe.write_raster(wbe.hillshade(dem=dem, azimuth=az, altitude=alt, z_factor=zf), shade_tif, compress=True)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "3757faa5-7782-49dc-9ddf-c702039decab",
   "metadata": {},
   "outputs": [],
   "source": []
  },
  {
   "cell_type": "markdown",
   "id": "fd4ee3f2-9063-41f0-a17c-8f6823d384b2",
   "metadata": {},
   "source": [
    "#### geomorfometria"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 69,
   "id": "bd2c8df9-9372-4f20-bd55-a3112475616e",
   "metadata": {},
   "outputs": [],
   "source": [
    "# declividade\n",
    "slope_tif = f'{cop}_slope.tif'\n",
    "slope = wbe.slope(dem=dem, units=\"percent\")\n",
    "\n",
    "wbe.write_raster(slope, slope_tif, compress=True)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 70,
   "id": "5443db4b-7500-499c-8f99-cc562f714561",
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Rows: 810\n",
      "Columns: 778\n",
      "Resolution (x direction): 0.0002777777789203086\n",
      "Resolution (y direction): 0.0002777777777777751\n",
      "North: -24.40875\n",
      "South: -24.63347222222222\n",
      "East: -48.56847222177892\n",
      "West: -48.784305556\n",
      "Min value: inf\n",
      "Max value: -inf\n",
      "EPSG code: 4326\n",
      "Nodata value: -32768.0\n",
      "Data type: RasterDataType.F32\n",
      "Photometric interpretation: PhotometricInterpretation.Continuous\n"
     ]
    }
   ],
   "source": [
    "print_metadata(slope)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "0c626070-1e55-4a4f-a7d0-8c13126d0147",
   "metadata": {},
   "outputs": [],
   "source": []
  },
  {
   "cell_type": "code",
   "execution_count": 71,
   "id": "730748d6-a62c-4fec-b37c-037a1e76fbfe",
   "metadata": {},
   "outputs": [],
   "source": [
    "# aspecto\n",
    "aspect_tif = f'{cop}_aspect.tif'\n",
    "aspect = wbe.aspect(dem=dem)\n",
    "\n",
    "wbe.write_raster(aspect, aspect_tif, compress=True)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "fcd7772f-3731-45dd-a1a3-09d98873de90",
   "metadata": {},
   "outputs": [],
   "source": []
  },
  {
   "cell_type": "code",
   "execution_count": 72,
   "id": "8dc3b335-47a2-488f-a6c2-25649bb0ceb4",
   "metadata": {},
   "outputs": [],
   "source": [
    "# curvaturas\n",
    "planc_tif = f'{cop}_plan_curvature_log.tif'\n",
    "profc_tif = f'{cop}_profile_curvature_log.tif'\n",
    "meanc_tif = f'{cop}_mean_curvature_log.tif'\n",
    "\n",
    "planc = wbe.plan_curvature(dem=dem, log_transform=True)\n",
    "profc = wbe.profile_curvature(dem=dem, log_transform=True)\n",
    "meanc = wbe.mean_curvature(dem=dem, log_transform=True)\n",
    "\n",
    "wbe.write_raster(planc, planc_tif, compress=True)\n",
    "wbe.write_raster(profc, profc_tif, compress=True)\n",
    "wbe.write_raster(meanc, meanc_tif, compress=True)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 73,
   "id": "1665ac5b-6a52-401c-85c6-3f003871fe56",
   "metadata": {},
   "outputs": [],
   "source": [
    "# rugosidade\n",
    "win = 11\n",
    "rough_tif = f'{cop}_rough_{win}x{win}.tif'\n",
    "rough = wbe.standard_deviation_of_slope(dem=dem, filter_size=win)\n",
    "\n",
    "wbe.write_raster(rough, rough_tif, compress=True)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 74,
   "id": "b9b862bc-d4f9-4a3a-89cb-05f3a8215384",
   "metadata": {},
   "outputs": [],
   "source": [
    "# geomorphons\n",
    "dist = 35\n",
    "gmorph_tif = f'{cop}_geomorphons_d{dist}.tif'\n",
    "gmorph = wbe.geomorphons(dem=dem, search_distance=dist, output_forms=True)\n",
    "\n",
    "wbe.write_raster(gmorph, gmorph_tif, compress=True)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 81,
   "id": "backed-holiday",
   "metadata": {},
   "outputs": [],
   "source": [
    "# landforms\n",
    "penn_tif = f'{cop}_pennock.tif'\n",
    "penn = wbe.pennock_landform_classification(dem=dem, slope_threshold=3.0, prof_curv_threshold=0.1, plan_curv_threshold=0.0)\n",
    "\n",
    "wbe.write_raster(penn[0], penn_tif, compress=True)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 82,
   "id": "75a40e3d-0a09-4d61-b650-4abcef51cae0",
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "(<Raster at 0x12606a69190>,\n",
       " 'CLASSIFICATION KEY\\nValue  Class\\n1      Convergent Footslope\\n2      Divergent Footslope\\n3      Convergent Shoulder\\n4      Divergent Shoulder\\n5      Convergent Backslope\\n6      Divergent Backslope\\n7      Level\\n')"
      ]
     },
     "execution_count": 82,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "penn"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "novel-timeline",
   "metadata": {},
   "outputs": [],
   "source": []
  },
  {
   "cell_type": "code",
   "execution_count": 83,
   "id": "compatible-ireland",
   "metadata": {},
   "outputs": [],
   "source": [
    "# slope vs elevation\n",
    "wbe.slope_vs_elev_plot(dem_rasters=[dem], output_html_file='cop_elev_slope.html', watershed_rasters=None)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 84,
   "id": "latter-occasion",
   "metadata": {},
   "outputs": [],
   "source": [
    "# analise hipsometrica\n",
    "wbe.hypsometric_analysis(dem_rasters=[dem], output_html_file='cop_hypsometric.html', watershed_rasters=None)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 85,
   "id": "imposed-award",
   "metadata": {},
   "outputs": [],
   "source": [
    "# histograma de raster\n",
    "rast = aspect\n",
    "r_name = 'aspect'\n",
    "wbe.raster_histogram(raster=rast, output_html_file=f'{r_name}_hist.html')"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "impaired-reunion",
   "metadata": {},
   "outputs": [],
   "source": []
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "neither-validation",
   "metadata": {},
   "outputs": [],
   "source": []
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "logical-monitoring",
   "metadata": {},
   "outputs": [],
   "source": []
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "pleased-bouquet",
   "metadata": {},
   "outputs": [],
   "source": []
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "least-september",
   "metadata": {},
   "outputs": [],
   "source": []
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "lasting-border",
   "metadata": {},
   "outputs": [],
   "source": []
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3 (ipykernel)",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.8.12"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 5
}