lattice_spheres#

lattice_spheres(shape: List, r: int = 5, spacing: int | None = None, offset: int | None = None, smooth: bool = True, lattice: Literal['sc', 'tri', 'fcc', 'bcc'] = 'sc')[source]#

Generate a cubic packing of spheres in a specified lattice arrangement.

Parameters:

  • shape (list) – The size of the image to generate in [Nx, Ny, Nz] where N is the number of voxels in each direction. For a 2D image, use [Nx, Ny].

  • radius (int) – The radius of spheres (circles) in the packing.

  • spacing (int or List[int]) – The spacing between unit cells. If the spacing is too small then spheres may overlap. If an int is given it will be applied in all directions, while a list of int will be interpreted to apply along each axis.

  • offset (int or List[int]) – The amount offset to add between sphere centers and the edges of the image. A single int will be applied in all directions, while a list of int will be interpreted to apply along each axis.

  • smooth (bool, default=True) – If True (default) the outer extremities of the sphere will not have the little bumps on each face.

  • lattice (str) –

    Specifies the type of lattice to create. Options are:

    option

    description

    ’sc’

    Simple cubic (default), works in both 2D and 3D.

    ’tri’

    Triangular, only works in 2D

    ’fcc’

    Face centered cubic, only works in 3D

    ’bcc’

    Body centered cubic, only works on 3D

Returns:

image – A boolean array with True values denoting the pore space.

Return type:

ndarray

Notes

For 2D images, ‘sc’ gives a square lattice and both ‘fcc’ and ‘bcc’ give a triangular lattice.

Examples

Click here to view online example.