mantidimaging.core.utility.data_containers module¶
Containers for data. They don’t do much apart from storing the data, and optionally provide helpful operations.
The biggest benefit is explicitly marking what the value represents (e.g. Degrees), and helps the type hints to tell you that you might be passing the wrong value (e.g. ScalarCoR to a VectorCoR), while they’re both Float underneath and the value can be used, it just will produce nonsense.
- class mantidimaging.core.utility.data_containers.Counts(value: numpy.ndarray)[source]¶
Bases:
SingleValue
- value: ndarray¶
- class mantidimaging.core.utility.data_containers.Degrees(value: float)[source]¶
Bases:
SingleValue
- class mantidimaging.core.utility.data_containers.ImageParameters(input_path: str, format: str, prefix: str, indices: mantidimaging.core.utility.data_containers.Indices | None = None, log_file: str | None = None)[source]¶
Bases:
object
- class mantidimaging.core.utility.data_containers.Indices(start, end, step)¶
Bases:
tuple
- end¶
Alias for field number 1
- start¶
Alias for field number 0
- step¶
Alias for field number 2
- class mantidimaging.core.utility.data_containers.LoadingParameters[source]¶
Bases:
object
- dark_after: ImageParameters | None = None¶
- dark_before: ImageParameters | None = None¶
- flat_after: ImageParameters | None = None¶
- flat_before: ImageParameters | None = None¶
- proj_180deg: ImageParameters | None = None¶
- sample: ImageParameters¶
- class mantidimaging.core.utility.data_containers.Micron(value: int)[source]¶
Bases:
SingleValue
- class mantidimaging.core.utility.data_containers.ProjectionAngles(value: numpy.ndarray)[source]¶
Bases:
SingleValue
- value: ndarray¶
- class mantidimaging.core.utility.data_containers.ReconstructionParameters(algorithm: str, filter_name: str, num_iter: int = 1, cor: mantidimaging.core.utility.data_containers.ScalarCoR | None = None, tilt: mantidimaging.core.utility.data_containers.Degrees | None = None, pixel_size: float = 0.0, alpha: float = 0.0, max_projection_angle: float = 360.0, beam_hardening_coefs: List[float] | None = None)[source]¶
Bases:
object
- class mantidimaging.core.utility.data_containers.ScalarCoR(value: float)[source]¶
Bases:
SingleValue
- class mantidimaging.core.utility.data_containers.Slope(value: float)[source]¶
Bases:
SingleValue