Skip to content

Cover Factory

Source

Convenience function to create covers for the BMZ.

create_cover(directory, array_in, array_out)

Create a cover image from input and output arrays.

Input and output arrays are expected to be SC(Z)YX. For images with a Z dimension, the middle slice is taken.

Parameters:

Name Type Description Default
directory Path

Directory in which to save the cover.

required
array_in ndarray

Array from which to create the cover image.

required
array_out ndarray

Array from which to create the cover image.

required

Returns:

Type Description
Path

Path to the saved cover image.