savu.plugins.loaders.full_field_loaders.tomo_phantom_loader_tools

Complexity

Total Complexity

1

Size/Duplication

Total Lines	12
Duplicated Lines	0 %

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
A	TomoPhantomLoaderTools.define_parameters()	0	2	1

from savu.plugins.plugin_tools import PluginTools

class TomoPhantomLoaderTools(PluginTools):
    """A hdf5 dataset of a specified size is created at runtime using Tomophantom
    to generate synthetic data , saved with relevant meta_data to a NeXus
    file, and used as input. It recreates the behaviour of the nxtomo loader
    but with synthetic data.  The input file path passed to Savu will be ignored
    (use a dummy).
    """
    def define_parameters(self):
        """
        axis_labels:
            visibility: basic
            dtype: list[str]
            description: A list of axis labels.
            default: "['rotation_angle.degrees', 'detector_y.pixels', 'detector_x.pixels']"
        axis_labels_phantom:
            visibility: hidden
            dtype: list[str]
            description: A list of axis labels.
            default: "['detector_z.pixels', 'detector_y.pixels', 'detector_x.pixels']"
        patterns:
            visibility: hidden
            dtype: list[str]
            description: Patterns.
            default: "['SINOGRAM.0c.1s.2c', 'PROJECTION.0s.1c.2c']"
        patterns_tomo:
            visibility: hidden
            dtype: list[str]
            description: Patterns.
            default: "['VOLUME_XZ.0c.1s.2c']"
        out_datasets:
            visibility: basic
            dtype: list[str]
            description: The names assigned to the datasets.
            default: "['synth_proj_data', 'phantom']"
        """