rockverse.voxel_image#

Handles the basic class for RockVerse Digital Rock Petrophysics, the VoxelImage class. It builds upon Zarr arrays, adding attributes and methods specifically designed for digital rock petrophysics in a high-performance, parallel computing environment. It can efficiently handle large images by leveraging Zarr’s chunked storage.

The VoxelImage class is designed for simplicity, handling complex computational abstractions under the hood, making it accessible and user-friendly for non-HPC specialists through high-level functions.

Classes#

VoxelImage(z)

The basic type for RockVerse Digital Rock Petrophysics, intended to contain voxelized 3D images and scalar fields in general.

Histogram(image, *[, bins, region, mask, ...])

Compute and manage histograms, probability density functions (PDFs), cumulative distribution functions (CDFs), and percentiles for VoxelImage data.

Basic creation functions#

create(shape, dtype[, chunks, store, path, ...])

Create empty voxel image.

empty(shape, dtype, **kwargs)

Create an empty voxel image with the given shape.

zeros(shape, dtype, **kwargs)

Create a voxel image filled with zeros.

ones(shape, dtype, **kwargs)

Create a voxel image filled with ones.

full(shape, dtype, fill_value, **kwargs)

Create a voxel image filled with a specified value.

empty_like(a, **kwargs)

Create empty voxel image with same shape, chunks, voxel_origin, voxel_length, and voxel_unit as the given image.

zeros_like(a, **kwargs)

Create voxel image filled with zeros with same shape, chunks, voxel_origin, voxel_length, and voxel_unit as the given image.

ones_like(a, **kwargs)

Create voxel image filled with ones with same shape, chunks, voxel_origin, voxel_length, and voxel_unit as the given image.

full_like(a, fill_value, **kwargs)

Create voxel image filled with a specified value with same shape, chunks, voxel_origin, voxel_length, and voxel_unit as the given image.

from_array(array, **kwargs)

Create a new VoxelImage object and copy array data into it.

Creating from other formats#

sphere_pack(shape[, dtype, xlim, ylim, ...])

Create a sphere pack image.

import_raw(rawfile, shape, dtype[, offset, ...])

Import raw file as a voxel image.