Skip to main content
Ctrl+K
PoreSpy documentation - Home PoreSpy documentation - Home
  • Installation
  • Examples
  • API Reference
  • Issue Tracker
  • Get Help
  • GitHub
  • Twitter
  • Installation
  • Examples
  • API Reference
  • Issue Tracker
  • Get Help
  • GitHub
  • Twitter

Section Navigation

  • General
    • Converting Greyscale Images to Binary
    • Getting Started
    • Opening and Preparing Images
  • Generators
    • Tutorials
      • Creating Multiscale Images
      • Generating fibrous mats
      • Generating Sphere Packings from Digital Rocks Portal
      • Making blobs
    • Reference
      • blobs
      • borders
      • shape
      • cylinders
      • cylindrical_pillars_array
      • cylindrical_pillars_mesh
      • cylindrical_plug
      • elevation
      • faces
      • fractal_noise
      • insert_shape
      • lattice_spheres
      • line_segment
      • overlapping_spheres
      • polydisperse_spheres
      • pseudo_electrostatic_packing
      • pseudo_gravity_packing
      • ramp
      • random_cantor_dust
      • random_spheres
      • rectangular_pillars_array
      • sierpinski_foam
      • spheres_from_coords
      • voronoi_edges
  • Filters
    • Tutorials
      • Applying chords to 2D and 3D images
      • Finding and Removing Invalid Voxels
      • Local thickness
      • SNOW partitioning
      • SNOW partitioning parallel
    • Reference
      • apply_chords
      • apply_chords_3D
      • apply_padded
      • chunked_func
      • distance_transform_lin
      • fftmorphology
      • fill_closed_pores
      • find_disconnected_voxels
      • find_dt_artifacts
      • find_peaks
      • find_small_clusters
      • find_trapped_clusters
      • flood
      • flood_func
      • hold_peaks
      • local_thickness
      • nl_means_layered
      • nphase_border
      • pc_to_satn
      • pc_to_seq
      • porosimetry
      • prune_branches
      • reduce_peaks
      • region_size
      • satn_to_seq
      • seq_to_satn
      • size_to_pc
      • size_to_satn
      • size_to_seq
      • snow_partitioning
      • snow_partitioning_n
      • snow_partitioning_parallel
      • trim_disconnected_voxels
      • trim_extrema
      • trim_floating_solid
      • trim_nearby_peaks
      • trim_nonpercolating_paths
      • trim_saddle_points
      • trim_small_clusters
  • Metrics
    • Tutorials
      • Measuring fractal dimension by box-counting
      • The lineal path function
      • Obtaining the porosity profile along each principle axis
      • Using regionprops_3d to analyze properties of each pore
    • Reference
      • bond_number
      • boxcount
      • chord_counts
      • chord_length_distribution
      • find_h
      • find_porosity_threshold
      • is_percolating
      • lineal_path_distribution
      • mesh_surface_area
      • mesh_volume
      • pc_map_to_pc_curve
      • percolating_porosity
      • phase_fraction
      • pore_size_distribution
      • porosity
      • porosity_by_type
      • porosity_profile
      • props_to_DataFrame
      • props_to_image
      • radial_density_distribution
      • region_interface_areas
      • region_surface_areas
      • region_volumes
      • regionprops_3D
      • rev_porosity
      • rev_tortuosity
      • satn_profile
      • two_point_correlation
  • Networks
    • Tutorials
      • Adding boundary pores
      • MAGNET Network Extraction
      • Predicting diffusive size factors of a rock sample
      • SNOW network extraction (advanced)
      • SNOW network extraction
      • Using AI based diffusive size factors for extracted networks
    • Reference
      • add_boundary_regions
      • diffusive_size_factor_AI
      • diffusive_size_factor_DNS
      • label_boundaries
      • label_phases
      • magnet
      • map_to_regions
      • regions_to_network
      • snow2
  • Simulations
    • Tutorials
      • Details of Drainage Simulations with and without Gravity
      • Basics of Peforming Drainage Simulations with and without Gravity
      • Finding the Tortuosity (\(\tau\)) of an Image Using tortuosity_fd
      • Overview of Image-Based Two-Phase Flow Simulations - Part 1: Drainage
      • Overview of Image-Based Two-Phase Flow Simulations - Part 2: Imbibition
      • Overview of Image-Based Two-Phase Flow Simulations - Part 3: Injection
      • Using the Injection Algorithm
      • Finding the REV for Tortuosity
    • Reference
      • drainage
      • hg_porosimetry
      • imbibition
      • injection
      • tortuosity_fd
  • Tools
    • Reference
      • align_image_with_openpnm
      • all_to_uniform
      • bbox_to_slices
      • extend_slice [WIP]
      • extract_cylinder
      • extract_regions
      • extract_subsection
      • get_planes
      • get_slices_grid
      • insert_cylinder
      • insert_sphere
      • isolate_object [WIP]
      • make_contiguous
      • marching_map [WIP]
      • mesh_region [WIP]
      • overlay
      • randomize_colors [WIP]
      • recombine [WIP]
      • unpad
  • Visualization
    • Tutorials
      • Visualizing a tif image in Paraview
    • Reference
      • bar
      • imshow
      • prep_for_imshow
      • satn_to_movie
      • satn_to_panels
      • sem
      • set_mpl_style
      • show_3D
      • show_mesh
      • show_panels
      • show_planes
      • xray
  • Converting Greyscale Images to Binary
  • Getting Started
  • Opening and Preparing Images
  • Creating Multiscale Images
  • Generating fibrous mats
  • Generating Sphere Packings from Digital Rocks Portal
  • Making blobs
  • blobs
  • borders
  • shape
  • cylinders
  • cylindrical_pillars_array
  • cylindrical_pillars_mesh
  • cylindrical_plug
  • elevation
  • faces
  • fractal_noise
  • insert_shape
  • lattice_spheres
  • line_segment
  • overlapping_spheres
  • polydisperse_spheres
  • pseudo_electrostatic_packing
  • pseudo_gravity_packing
  • ramp
  • random_cantor_dust
  • random_spheres
  • rectangular_pillars_array
  • sierpinski_foam
  • spheres_from_coords
  • voronoi_edges
  • Applying chords to 2D and 3D images
  • Finding and Removing Invalid Voxels
  • Local thickness
  • SNOW partitioning
  • SNOW partitioning parallel
  • apply_chords
  • apply_chords_3D
  • apply_padded
  • chunked_func
  • distance_transform_lin
  • fftmorphology
  • fill_closed_pores
  • find_disconnected_voxels
  • find_dt_artifacts
  • find_peaks
  • find_small_clusters
  • find_trapped_clusters
  • flood
  • flood_func
  • hold_peaks
  • local_thickness
  • nl_means_layered
  • nphase_border
  • pc_to_satn
  • pc_to_seq
  • porosimetry
  • prune_branches
  • reduce_peaks
  • region_size
  • satn_to_seq
  • seq_to_satn
  • size_to_pc
  • size_to_satn
  • size_to_seq
  • snow_partitioning
  • snow_partitioning_n
  • snow_partitioning_parallel
  • trim_disconnected_voxels
  • trim_extrema
  • trim_floating_solid
  • trim_nearby_peaks
  • trim_nonpercolating_paths
  • trim_saddle_points
  • trim_small_clusters
  • Measuring fractal dimension by box-counting
  • The lineal path function
  • Obtaining the porosity profile along each principle axis
  • Using regionprops_3d to analyze properties of each pore
  • bond_number
  • boxcount
  • chord_counts
  • chord_length_distribution
  • find_h
  • find_porosity_threshold
  • is_percolating
  • lineal_path_distribution
  • mesh_surface_area
  • mesh_volume
  • pc_map_to_pc_curve
  • percolating_porosity
  • phase_fraction
  • pore_size_distribution
  • porosity
  • porosity_by_type
  • porosity_profile
  • props_to_DataFrame
  • props_to_image
  • radial_density_distribution
  • region_interface_areas
  • region_surface_areas
  • region_volumes
  • regionprops_3D
  • rev_porosity
  • rev_tortuosity
  • satn_profile
  • two_point_correlation
  • Adding boundary pores
  • MAGNET Network Extraction
  • Predicting diffusive size factors of a rock sample
  • SNOW network extraction (advanced)
  • SNOW network extraction
  • Using AI based diffusive size factors for extracted networks
  • add_boundary_regions
  • diffusive_size_factor_AI
  • diffusive_size_factor_DNS
  • label_boundaries
  • label_phases
  • magnet
  • map_to_regions
  • regions_to_network
  • snow2
  • Details of Drainage Simulations with and without Gravity
  • Basics of Peforming Drainage Simulations with and without Gravity
  • Finding the Tortuosity (\(\tau\)) of an Image Using tortuosity_fd
  • Overview of Image-Based Two-Phase Flow Simulations - Part 1: Drainage
  • Overview of Image-Based Two-Phase Flow Simulations - Part 2: Imbibition
  • Overview of Image-Based Two-Phase Flow Simulations - Part 3: Injection
  • Using the Injection Algorithm
  • Finding the REV for Tortuosity
  • align_image_with_openpnm
  • all_to_uniform
  • bbox_to_slices
  • extend_slice [WIP]
  • extract_cylinder
  • extract_regions
  • extract_subsection
  • get_planes
  • get_slices_grid
  • insert_cylinder
  • insert_sphere
  • isolate_object [WIP]
  • make_contiguous
  • marching_map [WIP]
  • mesh_region [WIP]
  • overlay
  • randomize_colors [WIP]
  • recombine [WIP]
  • unpad
  • Visualizing a tif image in Paraview
  • bar
  • imshow
  • prep_for_imshow
  • satn_to_movie
  • satn_to_panels
  • sem
  • set_mpl_style
  • show_3D
  • show_mesh
  • show_panels
  • show_planes
  • xray
  • Examples
  • Generators
  • Reference

Reference#

  • blobs
  • borders
  • shape
  • r
  • axis
  • Notes
  • cylinders
  • cylindrical_pillars_array
  • cylindrical_pillars_mesh
  • cylindrical_plug
  • elevation
  • faces
  • fractal_noise
  • insert_shape
  • lattice_spheres
  • line_segment
  • overlapping_spheres
  • polydisperse_spheres
  • pseudo_electrostatic_packing
  • phi
  • pseudo_gravity_packing
  • ramp
  • random_cantor_dust
  • random_spheres
  • rectangular_pillars_array
  • sierpinski_foam
  • spheres_from_coords
  • voronoi_edges

© Copyright 2025, PMEAL.

Built with the PyData Sphinx Theme 0.16.1.