class BaseRecon(name='BaseRecon')[source]
base_pre_process()[source]

This method is called after the plugin has been created by the pipeline framework as a pre-processing step.

base_process_frames_after(data)[source]

This method is called directly after each call to process frames and before returning the data to file.

base_process_frames_before(data)[source]

Reconstruct a single sinogram with the provided centre of rotation

br_array_pad(ctr, nPixels)[source]
crop_sino(sino, cor)[source]

Crop the sinogram so the centre of rotation is at the centre.

executive_summary()[source]

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

get_angles()[source]

Get the angles associated with the current sinogram(s).

Returns

Angles of the current frames.

Return type

np.ndarray

get_centre_offset(sino, cor, detX)[source]
get_centre_shift(sino, cor)[source]
get_cors()[source]

Get the centre of rotations associated with the current sinogram(s).

Returns

Centre of rotation values for the current frames.

Return type

np.ndarray

get_fov_fraction(sino, cor)[source]

Get the fraction of the original FOV that can be reconstructed due to offset centre

get_frame_params()[source]
get_frame_shifts()[source]
get_gpu_memory()[source]
get_initial_data()[source]

Get the initial data (if it is exists) associated with the current sinogram(s).

Returns

The section of the initialisation data associated with the current frames.

Return type

np.ndarray or None

get_max_frames()[source]

Number of data frames to pass to each instance of process_frames func

Returns

“single”, “multiple” or integer (only to be used if the number of

frames MUST be fixed.)

Return type

str or int

get_pad_amount()[source]
get_proj_shifts()[source]

Get the 2D (X-Y) shifts associated with every projection frame

Returns

projecton shifts for the current frames.

Return type

np.ndarray

get_reconstruction_alg()[source]
get_sino_centre_method()[source]
get_skipping_indices(in_text)[source]
get_slice_axis()[source]

Fix the fastest changing slice dimension

Returns

str should be the axis_label corresponding to the fastest changing dimension

Return type

str or None

get_vol_shape()[source]
keep_sino(sino, cor)[source]

No change to the sinogram

nInput_datasets()[source]

The number of datasets required as input to the plugin

Returns

Number of input datasets

nOutput_datasets()[source]

The number of datasets created by the plugin

Returns

Number of output datasets

pad_sino(sino, cor)[source]

Pad the sinogram so the centre of rotation is at the centre.

populate_metadata_to_output(inData, outData, mData, meta_list)[source]
reconstruct_pre_process()[source]

Should be overridden to perform pre-processing in a child class

set_centre_of_rotation(inData, outData, mData)[source]
set_function(pad_shape)[source]
set_mask(shape)[source]
set_projection_shifts(inData, outData, mData)[source]
setup()[source]

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