Camera Rot Correction

Description

A plugin to apply a rotation to projection images, for example to correct for missing camera alignment.

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: datasets
    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: "[]"

angle:
    visibility: basic
    dtype: float
    description: The rotation angle for the output image in degrees.
    default: "0.0"

crop_edges:
    visibility: intermediate
    dtype: int
    description: When a rotation is applied to any image, the result will contain unused values around the edges, which can be removed by cropping the edges by a specified number of pixels.
    default: "0"

auto_crop:
    visibility: basic
    dtype: bool
    description: If activated, this feature will automatically crop the image to eliminate any regions without data (because of the rotation).
    default: "False"

use_auto_centre:
    visibility: intermediate
    dtype: bool
    description: This parameter automatically sets the centre of rotation to the centre of the image. If set to False, the values from centre_x and centre_y are used. Note - The centre needs to be within the image dimensions.
    default: "True"

center_x:
    visibility: intermediate
    dtype: float
    description: If not use_auto_centre, this value determines the detector x coordinate for the centre of rotation.
    default: "1279.5"

centre_y:
    visibility: intermediate
    dtype: float
    description: If not use_auto_centre, this value determines the detector x coordinate for the centre of rotation.
    default: "1079.5"

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 CameraRotCorrection

post_process()

This method is called after the process function in the pipeline framework as a post-processing step. All processes will have finished performing the main processing at this stage.

Parameters

exp (experiment class instance) – An experiment object, holding input and output datasets

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).