Paganin Filter — Savu 4.2 documentation

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

Ratio:
    visibility: basic
    dtype: float
    description: Ratio of delta/beta.
    default: "250.0"

Energy:
    visibility: basic
    dtype: float
    description: Beam energy in keV.
    default: "53.0"

Distance:
    visibility: basic
    dtype: float
    description: Distance from sample to detector. Unit is metre.
    default: "1.0"

Resolution:
    visibility: basic
    dtype: float
    description: Pixel size. Unit is micron.
    default: "1.28"

Padtopbottom:
    visibility: intermediate
    dtype: int
    description: Pad to the top and bottom of projection.
    default: "100"

Padleftright:
    visibility: intermediate
    dtype: int
    description: Pad to the left and right of projection.
    default: "100"

Padmethod:
    visibility: intermediate
    dtype: str
    description: Numpy pad method.
    default: edge

increment:
    visibility: intermediate
    dtype: float
    description: Increment all values by this amount before taking the log.
    default: "0.0"

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

Simultaneous phase and amplitude extraction from a single defocused image of a homogeneous object by Paganin, David et al.

Bibtex

@article{paganin2002simultaneous,
title={Simultaneous phase and amplitude extraction from a single defocused image of a homogeneous object},
author={Paganin, David and Mayo, Sheridan C and Gureyev, Tim E and Miller, Peter R and Wilkins, Steve W},
journal={Journal of microscopy},
volume={206},
number={1},
pages={33--40},
year={2002},
publisher={Wiley Online Library}
}

Endnote

%0 Journal Article
%T Simultaneous phase and amplitude extraction from a single defocused image of a homogeneous object
%A Paganin, David
%A Mayo, Sheridan C
%A Gureyev, Tim E
%A Miller, Peter R
%A Wilkins, Steve W
%J Journal of microscopy
%V 206
%N 1
%P 33-40
%@ 0022-2720
%D 2002
%I Wiley Online Library

API

class PaganinFilter[source]

get_max_frames()[source]

pre_process()[source]: This method is called immediately after base_pre_process().

process_frames(data)[source]

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.

set_filter_padding(in_pData, out_pData)[source]: Should be overridden to define how wide the frame should be for each input data set

Paganin Filter¶

Description¶