Image Saver

Description

A class to save tomography data to image files. Run the MaxAndMin plugin before this to rescale the data.

• Plugin documention and guidelines on use

Parameters

in_datasets:
    visibility: datasets
    dtype: "[list[],list[str]]"
    description:
        summary: A list of the dataset(s) to process.
        verbose: A list of strings, where each string gives the name of a dataset that was either specified by a loader plugin or created as output to a previous plugin.  The length of the list is the number of input datasets requested by the plugin.  If there is only one dataset and the list is left empty it will default to that dataset.
    default: "[]"

out_datasets:
    visibility: hidden
    dtype: "[list[],list[str]]"
    description:
        summary: A list of the dataset(s) to create.
        verbose: A list of strings, where each string is a name to be assigned to a dataset output by the plugin. If there is only one input dataset and one output dataset and the list is left empty, the output will take the name of the input dataset. The length of the list is the number of output datasets created by the plugin.
    default: "[]"

pattern:
    visibility: basic
    dtype: str
    description: How to slice the data.
    default: VOLUME_XZ

format:
    visibility: basic
    dtype: str
    description: Image format.
    default: tif

num_bit:
    visibility: basic
    dtype: int
    description: Bit depth of the tiff format (8, 16 or 32).
    default: "16"
    options: "[8, 16, 32]"

max:
    visibility: intermediate
    dtype: "[None,float]"
    description: Global max for tiff scaling.
    default: None

min:
    visibility: intermediate
    dtype: "[None,float]"
    description: Global min for tiff scaling.
    default: None

jpeg_quality:
    visibility: intermediate
    dtype: int
    description: JPEG encoding quality (1 is worst, 100 is best).
    default: "75"

prefix:
    visibility: intermediate
    dtype: "[None,str]"
    description: Override the default output jpg file prefix
    default: None

Key

visibility: The visibility level of the parameter
dtype: The type of data
description: A short explanation of the parameter
default: The default value
options: A list of permitted values
dependency: The name of the parameter and value which this parameter depends upon
range: A guide for the range of the parameter

Citations

No citations

API

class ImageSaver(name='ImageSaver')

executive_summary()

Provide a summary to the user for the result of the plugin.

e.g.

• Warning, the sample may have shifted during data collection

• Filter operated normally

Returns

A list of string summaries

pre_process()

This method is called immediately after base_pre_process().

process_frames(data)

This method is called after the plugin has been created by the pipeline framework and forms the main processing step

Parameters

data (list(np.array)) – A list of numpy arrays for each input dataset.

setup()

This method is first to be called after the plugin has been created. It determines input/output datasets and plugin specific dataset information such as the pattern (e.g. sinogram/projection).