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

  • porespy
    • porespy.beta
      • porespy.beta.df_to_tortuosity
      • porespy.beta.flux
      • porespy.beta.get_block_sizes
      • porespy.beta.local_diff
      • porespy.beta.polydisperse_cylinders
      • porespy.beta.rev_tortuosity
      • porespy.beta.tau_from_cmap
      • porespy.beta.tortuosity_bt
      • porespy.beta.walk
    • porespy.filters
      • porespy.filters.apply_chords
      • porespy.filters.apply_chords_3D
      • porespy.filters.apply_padded
      • porespy.filters.capillary_transform
      • porespy.filters.chunked_func
      • porespy.filters.dilate
      • porespy.filters.distance_transform_lin
      • porespy.filters.erode
      • porespy.filters.fftmorphology
      • porespy.filters.fill_closed_pores
      • porespy.filters.fill_invalid_pores
      • porespy.filters.fill_surface_pores
      • porespy.filters.find_closed_pores
      • porespy.filters.find_disconnected_voxels
      • porespy.filters.find_dt_artifacts
      • porespy.filters.find_floating_solid
      • porespy.filters.find_invalid_pores
      • porespy.filters.find_peaks
      • porespy.filters.find_small_clusters
      • porespy.filters.find_surface_pores
      • porespy.filters.find_trapped_clusters
      • porespy.filters.flood
      • porespy.filters.flood_func
      • porespy.filters.hold_peaks
      • porespy.filters.local_thickness
      • porespy.filters.local_thickness_bf
      • porespy.filters.local_thickness_conv
      • porespy.filters.local_thickness_dt
      • porespy.filters.local_thickness_imj
      • porespy.filters.nl_means_layered
      • porespy.filters.nphase_border
      • porespy.filters.pc_to_satn
      • porespy.filters.pc_to_seq
      • porespy.filters.porosimetry
      • porespy.filters.prune_branches
      • porespy.filters.reduce_peaks
      • porespy.filters.region_size
      • porespy.filters.satn_to_seq
      • porespy.filters.seq_to_satn
      • porespy.filters.size_to_pc
      • porespy.filters.size_to_satn
      • porespy.filters.size_to_seq
      • porespy.filters.snow_partitioning
      • porespy.filters.snow_partitioning_n
      • porespy.filters.snow_partitioning_parallel
      • porespy.filters.trim_disconnected_voxels
      • porespy.filters.trim_extrema
      • porespy.filters.trim_floating_solid
      • porespy.filters.trim_nearby_peaks
      • porespy.filters.trim_nonpercolating_paths
      • porespy.filters.trim_saddle_points
      • porespy.filters.trim_saddle_points_legacy
      • porespy.filters.trim_small_clusters
    • porespy.generators
      • porespy.generators.blobs
      • porespy.generators.borders
      • porespy.generators.bundle_of_tubes
      • porespy.generators.cylinders
      • porespy.generators.cylindrical_pillars_array
      • porespy.generators.cylindrical_pillars_mesh
      • porespy.generators.cylindrical_plug
      • porespy.generators.elevation
      • porespy.generators.faces
      • porespy.generators.fractal_noise
      • porespy.generators.insert_shape
      • porespy.generators.lattice_spheres
      • porespy.generators.line_segment
      • porespy.generators.overlapping_spheres
      • porespy.generators.polydisperse_spheres
      • porespy.generators.pseudo_electrostatic_packing
      • porespy.generators.pseudo_gravity_packing
      • porespy.generators.ramp
      • porespy.generators.random_cantor_dust
      • porespy.generators.random_spheres
      • porespy.generators.rectangular_pillars_array
      • porespy.generators.sierpinski_foam
      • porespy.generators.spheres_from_coords
      • porespy.generators.voronoi_edges
    • porespy.io
      • porespy.io.dict_to_vtk
      • porespy.io.folder_to_stack
      • porespy.io.open_paraview
      • porespy.io.to_palabos
      • porespy.io.to_paraview
      • porespy.io.to_stl
      • porespy.io.to_vtk
      • porespy.io.zip_to_stack
    • porespy.metrics
      • porespy.metrics.bond_number
      • porespy.metrics.boxcount
      • porespy.metrics.chord_counts
      • porespy.metrics.chord_length_distribution
      • porespy.metrics.find_h
      • porespy.metrics.find_porosity_threshold
      • porespy.metrics.find_porosity_threshold
      • porespy.metrics.is_percolating
      • porespy.metrics.lineal_path_distribution
      • porespy.metrics.mesh_surface_area
      • porespy.metrics.mesh_volume
      • porespy.metrics.pc_map_to_pc_curve
      • porespy.metrics.percolating_porosity
      • porespy.metrics.percolating_porosity
      • porespy.metrics.phase_fraction
      • porespy.metrics.phase_fraction
      • porespy.metrics.pore_size_distribution
      • porespy.metrics.pore_size_distribution
      • porespy.metrics.porosity
      • porespy.metrics.porosity
      • porespy.metrics.porosity_by_type
      • porespy.metrics.porosity_profile
      • porespy.metrics.porosity_profile
      • porespy.metrics.prop_to_image
      • porespy.metrics.props_to_DataFrame
      • porespy.metrics.radial_density_distribution
      • porespy.metrics.radial_density_distribution
      • porespy.metrics.region_interface_areas
      • porespy.metrics.region_surface_areas
      • porespy.metrics.region_volumes
      • porespy.metrics.regionprops_3D
      • porespy.metrics.rev_porosity
      • porespy.metrics.rev_tortuosity
      • porespy.metrics.satn_profile
      • porespy.metrics.satn_profile
      • porespy.metrics.two_point_correlation
      • porespy.metrics.two_point_correlation
    • porespy.networks
      • porespy.networks.add_boundary_regions
      • porespy.networks.create_model
      • porespy.networks.diffusive_size_factor_AI
      • porespy.networks.diffusive_size_factor_DNS
      • porespy.networks.find_conns
      • porespy.networks.find_junctions
      • porespy.networks.find_throat_junctions
      • porespy.networks.generate_voxel_image
      • porespy.networks.get_throat_area
      • porespy.networks.juncs_to_pore_centers
      • porespy.networks.junctions_to_network
      • porespy.networks.label_boundaries
      • porespy.networks.label_phases
      • porespy.networks.magnet
      • porespy.networks.map_to_regions
      • porespy.networks.merge_nearby_juncs
      • porespy.networks.partition_skeleton
      • porespy.networks.regions_to_network
      • porespy.networks.regions_to_network_parallel
      • porespy.networks.skeleton
      • porespy.networks.skeleton_parallel
      • porespy.networks.snow2
    • porespy.simulations
      • porespy.simulations.drainage
      • porespy.simulations.drainage_dsi
      • porespy.simulations.drainage_dt
      • porespy.simulations.drainage_dt_fft
      • porespy.simulations.drainage_fft
      • porespy.simulations.hg_porosimetry
      • porespy.simulations.ibip
      • porespy.simulations.imbibition
      • porespy.simulations.imbibition_dsi
      • porespy.simulations.imbibition_dt
      • porespy.simulations.imbibition_dt_fft
      • porespy.simulations.imbibition_fft
      • porespy.simulations.injection
      • porespy.simulations.qbip
      • porespy.simulations.tortuosity_fd
    • porespy.tools
      • porespy.tools.Results
      • porespy.tools.Settings
      • porespy.tools.align_image_with_openpnm
      • porespy.tools.all_to_uniform
      • porespy.tools.area_of_triangle
      • porespy.tools.ball
      • porespy.tools.bbox_to_slices
      • porespy.tools.block_size_to_divs
      • porespy.tools.calculate_area_and_volume
      • porespy.tools.center_of_mass
      • porespy.tools.create_mc_template_list
      • porespy.tools.cube
      • porespy.tools.disk
      • porespy.tools.extend_slice
      • porespy.tools.extract_cylinder
      • porespy.tools.extract_regions
      • porespy.tools.extract_subsection
      • porespy.tools.face_orientation
      • porespy.tools.find_bbox
      • porespy.tools.find_outer_region
      • porespy.tools.get_block_sizes
      • porespy.tools.get_edt
      • porespy.tools.get_fixtures_path
      • porespy.tools.get_planes
      • porespy.tools.get_skel
      • porespy.tools.get_slices_grid
      • porespy.tools.get_slices_multigrid
      • porespy.tools.get_slices_random
      • porespy.tools.get_slices_slabs
      • porespy.tools.get_strel
      • porespy.tools.get_tqdm
      • porespy.tools.in_hull
      • porespy.tools.insert_cylinder
      • porespy.tools.insert_sphere
      • porespy.tools.isolate_object
      • porespy.tools.jit_extend_slice
      • porespy.tools.jit_marching_cubes_area_and_volume
      • porespy.tools.jit_marching_squares_perimeter_and_area
      • porespy.tools.make_contiguous
      • porespy.tools.marching_cubes_area_and_volume
      • porespy.tools.marching_map
      • porespy.tools.mc_templates_generator
      • porespy.tools.mesh_region
      • porespy.tools.overlay
      • porespy.tools.pad
      • porespy.tools.parse_shape
      • porespy.tools.parse_steps
      • porespy.tools.points_to_spheres
      • porespy.tools.ps_ball
      • porespy.tools.ps_disk
      • porespy.tools.ps_rect
      • porespy.tools.ps_round
      • porespy.tools.randomize_colors
      • porespy.tools.recombine
      • porespy.tools.results_to_df
      • porespy.tools.sanitize_filename
      • porespy.tools.show_docstring
      • porespy.tools.square
      • porespy.tools.tic
      • porespy.tools.toc
      • porespy.tools.unpad
    • porespy.visualization
      • porespy.visualization.bar
      • porespy.visualization.imshow
      • porespy.visualization.prep_for_imshow
      • porespy.visualization.satn_to_movie
      • porespy.visualization.satn_to_panels
      • porespy.visualization.sem
      • porespy.visualization.set_mpl_style
      • porespy.visualization.show_3D
      • porespy.visualization.show_mesh
      • porespy.visualization.show_panels
      • porespy.visualization.show_planes
      • porespy.visualization.xray
    • porespy.imshow
  • API Reference

API Reference#

This page contains auto-generated API reference documentation [1].

  • porespy
    • porespy.beta
    • porespy.filters
    • porespy.generators
    • porespy.io
    • porespy.metrics
    • porespy.networks
    • porespy.simulations
    • porespy.tools
    • porespy.visualization
[1]

Created with sphinx-autoapi

© Copyright 2025, PMEAL.

Built with the PyData Sphinx Theme 0.16.1.