Skip to content

porestore.tools.structure

Structural measurements of pores and interfaces, matching the PoreStore UI.

pore_size(im: Image | str, *, refresh: bool = False, client: Client | None = None, idempotency_key: str | None = None, **kwargs) -> Job

Measure local pore sizes and their distribution.

Common keywords are steps, queue_name and compute_tier. Radius bins and the local-thickness method are selected by the service. Results retain the API's voxel or physical units.

porosity_profile(im: Image | str, *, refresh: bool = False, client: Client | None = None, idempotency_key: str | None = None, **kwargs) -> Job

Measure porosity along one axis or all axes.

Pass axis="all", 0, 1 or 2. queue_name and compute_tier follow the service schema. Profile coordinates retain the API's voxel or physical units.

interfacial_surface_area(im: Image | str, *, refresh: bool = False, client: Client | None = None, idempotency_key: str | None = None, **kwargs) -> Job

Measure the pore-solid interface on a 3-D image.

queue_name and compute_tier follow the service schema. Optional cleanup_singletons is subject to its existing server-side audience. Smoothing controls are fixed by the service, not client defaults.