mantidimaging.core.data.imagestack module

class mantidimaging.core.data.imagestack.ImageStack(data: ndarray | SharedArray, filenames: list[str] | None = None, indices: list[int] | Indices | None = None, metadata: dict[str, Any] | None = None, sinograms: bool = False, name: str | None = None)

Bases: object

clear_proj180deg() → None

copy(flip_axes: bool = False) → ImageStack

copy_roi(roi: SensibleROI) → ImageStack

count() → int

counts() → Counts | None

static create_empty_image_stack(shape: tuple[int, ...], dtype: npt.DTypeLike, metadata: dict[str, Any]) → ImageStack

property data: ndarray

property dtype: dtype

property filenames: list[str] | None

geometry: Geometry | None

property h_middle: float

Returns the horizontal middle (middle column) of the projections

has_proj180deg() → bool

property height: int

property id: UUID

property is_processed: bool

Returns:

True if any of the data has been processed, False otherwise.

property is_sinograms: bool

load_metadata(f: TextIO) → None

Load metadata json without overwriting existing values

property log_file: InstrumentLog | None

make_name_unique(existing_names: list[str]) → None

name: str

property num_images: int

property num_projections: int

property num_sinograms: int

property pixel_size: float

property proj180deg: ImageStack | None

proj_180_degree_shape_matches_images() → bool

projection(projection_idx: int) → ndarray

projection_angles(max_angle: float = 360.0) → ProjectionAngles

Return projection angles, in priority order: - From a log - From the manually loaded file with a list of angles - Automatically generated with equidistant step

Parameters:

max_angle – The maximum angle up to which the angles will be generated. Only used when the angles are generated, if they are provided via a log or a file the argument will be ignored.

property projections: ndarray

real_projection_angles() → ProjectionAngles | None

Return only the projection angles that are from a log file or have been manually loaded. :return: Real projection angles if they were found, None otherwise.

record_operation(func_name: str, display_name: str, *args, **kwargs) → None

save_metadata(f: TextIO, rescale_params: dict[str, str | float] | None = None) → None

set_geometry() → None

Creates an AcquisitionGeometry belonging to the ImageStack.

set_projection_angles(angles: ProjectionAngles) → None

property shared_array: SharedArray

property shutter_count_file: ShutterCount | None

sino(slice_idx: int) → ndarray

sino_as_image_stack(index: int) → ImageStack

A single sinogram slice as an ImageStack in projection ordering

property sinograms: ndarray

slice_as_array(index: int) → ndarray

slice_as_image_stack(index: int) → ImageStack

A slice, either projection or sinogram depending on current ordering

update_geometry(angles: list | ndarray, angle_unit: str, num_pixels: list | tuple, pixel_size: list | tuple) → None

Updates the configuration of the ImageStack’s Geometry object.

property uses_shared_memory: bool

property width: int