Examples

You can download the examples in IPython format from our GitHub repo, which can be browsed here.

---

Generators

Tutorials

• Generating fibrous mats
• Making blobs

Reference

• blobs
• borders
• thickness
• mode
• bundle_of_tubes
• cylinders
• cylindrical_plug
• faces
• fractal_noise
• insert_shape
• lattice_spheres
• line_segment
• overlapping_spheres
• polydisperse_spheres
• pseudo_electrostatic_packing
• pseudo_gravity_packing
• random_cantor_dust
• rsa
• sierpinski_foam
• voronoi_edges

Filters

Tutorials

• Applying chords to 2D and 3D images
• Local thickness
• SNOW partitioning
• SNOW partitioning parallel
• Image-based invasion percoalation

Reference

• apply_chords
• apply_chords_3D
• apply_padded
• chunked_func
• distance_transform_lin
• fftmorphology
• fill_blind_pores
• find_disconnected_voxels
• find_dt_artifacts
• find_peaks
• find_trapped_regions
• flood
• flood_func
• hold_peaks
• ibip
• local_thickness
• nl_means_layered
• nphase_border
• pc_to_satn
• porosimetry
• prune_branches
• reduce_peaks
• region_size
• satn_to_seq
• seq_to_satn
• size_to_satn
• size_to_seq
• snow_partitioning
• snow_partitioning_n
• snow_partitioning_parallel
• trim_disconnected_blobs
• trim_extrema
• trim_floating_solid
• trim_nearby_peaks
• trim_nonpercolating_paths
• trim_saddle_points
• trim_small_clusters
• unpad

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

• boxcount
• chord_counts
• chord_length_distribution
• find_h
• lineal_path_distribution
• mesh_volume
• mesh_surface_area
• pc_curve
• phase_fraction
• pore_size_distribution
• porosity
• porosity_profile
• props_to_DataFrame
• props_to_image
• radial_density_distribution
• region_interface_areas
• region_surface_areas
• region_volumes
• regionprops_3D
• representative_elementary_volume
• satn_profile
• two_point_correlation

Networks

Tutorials

• Adding boundary pores
• SNOW network extraction (advanced)
• SNOW network extraction
• Using AI based diffusive size factors for extracted networks
• Trained model and supplementary materials

Reference

• add_boundary_regions
• diffusive_size_factor_AI
• label_boundaries
• label_phases [WIP]
• map_to_regions
• regions_to_network [WIP]
• snow2 [WIP]

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

Tools

Reference

• align_image_with_openpnm
• bbox_to_slices
• extend_slice [WIP]
• extract_cylinder
• extract_regions
• extract_subsection
• get_border
• get_planes
• insert_cylinder
• insert_sphere
• isolate_object [WIP]
• make_contiguous
• marching_map [WIP]
• mesh_region [WIP]
• norm_to_uniform
• overlay
• randomize_colors [WIP]
• recombine [WIP]
• subdivide
• 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_planes
• xray