Examples#
The best way to learn OpenPNM (like anything) is to experiment. In this page, you can find lots of examples that will help you get started. The examples are categorized into the following categories:
General#
Generators#
blobsbordersthicknessmodebundle_of_tubescylinderscylindrical_pillars_arraycylindrical_pillars_meshcylindrical_plugfacesfractal_noiseinsert_shapelattice_spheresline_segmentoverlapping_spherespolydisperse_spherespseudo_electrostatic_packingphipseudo_gravity_packingramprandom_cantor_dustrandom_spheresrectangular_pillars_arraysierpinski_foamsierpinski_foam2spheres_from_coordsvoronoi_edges
Filters#
apply_chordsapply_chords_3Dapply_paddedchunked_funcdistance_transform_linfftmorphologyfill_blind_poresfind_disconnected_voxelsfind_dt_artifactsfind_peaksfind_trapped_regionsfloodflood_funchold_peakslocal_thicknessnl_means_layerednphase_borderpc_to_satnporosimetryprune_branchesreduce_peaksregion_sizesatn_to_seqseq_to_satnsize_to_satnsize_to_seqsnow_partitioningsnow_partitioning_nsnow_partitioning_paralleltrim_disconnected_blobstrim_extrematrim_floating_solidtrim_nearby_peakstrim_nonpercolating_pathstrim_saddle_pointstrim_small_clusters
Metrics#
boxcountchord_countschord_length_distributionfind_hlineal_path_distributionmesh_volumemesh_surface_areapc_curvephase_fractionpore_size_distributionporosityporosity_profileprops_to_DataFrameprops_to_imageradial_density_distributionregion_interface_areasregion_surface_areasregion_volumesregionprops_3Drepresentative_elementary_volumesatn_profiletwo_point_correlation
Networks#
Simulations#
Tools#
align_image_with_openpnmbbox_to_slicesextend_slice[WIP]extract_cylinderextract_regionsextract_subsectionget_borderget_planesinsert_cylinderinsert_sphereisolate_object[WIP]make_contiguousmarching_map[WIP]mesh_region[WIP]norm_to_uniformoverlayrandomize_colors[WIP]recombine[WIP]subdivideunpad