savu.data.structures

class savu.data.structures.Data

Bases: object

Baseclass for all data

complete()

Closes the backing file and completes work

external_link()

get_slice_list(frame_type)

class savu.data.structures.PassThrough

Bases: object

Interface Class describing when the input data of a plugin is also the output

class savu.data.structures.ProjectionData

Bases: savu.data.structures.Data

Descriptor for corrected projection data

create_backing_h5(path, group_name, data, mpi=False)

Create a h5 backend for this ProjectionData

Parameters:

• path (str) – The full path of the NeXus file to use as a backend
• data (savu.structure) – The structure from which this can be created
• mpi – if an MPI process, provide MPI package here, default None

get_data_shape()

Gets the real number projections

Returns:integer number of projection frames

get_number_of_projections()

Gets the real number projections

Returns:integer number of projection frames

get_number_of_sinograms()

Gets the real number sinograms

Returns:integer number of sinogram frames

populate_from_h5(path)

Populate the contents of this object from a file

Parameters:path (str) – The full path of the h5 file to load.

class savu.data.structures.RawTimeseriesData

Bases: savu.data.structures.Data

Descriptor for raw timeseries data

create_backing_h5(path, group_name, data, mpi=False)

Create a h5 backend for this RawTimeseriesData

Parameters:

• path (str) – The full path of the NeXus file to use as a backend
• data (savu.structure.RawTimeseriesData) – The structure from which this can be created
• mpi (package) – if an MPI process, provide MPI package here, default None

get_clusterd_frame_list()

Gets a list of index arrays grouped by sequential image_key

Returns:a list of integer index arrays

get_number_of_projections()

Gets the real number of projections excluding calibration data

Returns:integer number of data frames

get_projection_shape()

Gets the shape of a projection

Returns:a tuple of the shape of a single projection

populate_from_nx_tomo(path)

Populate the RawTimeseriesData from an NXTomo defined NeXus file

Parameters:path (str) – The full path of the NeXus file to load.

class savu.data.structures.SliceAlwaysAvailableWrapper(data)

Bases: savu.data.structures.SliceAvailableWrapper

This class takes 1 data ndarray. Its purpose is to provide slices from the data array in the same way as the SliceAvailableWrapper but assuming the data is always available (for example in the case of the input file)

class savu.data.structures.SliceAvailableWrapper(avail, data)

Bases: object

This class takes 2 datasets, one avaialble boolean ndarray, and 1 data ndarray. Its purpose is to provide slices from the data array only if data has been put there, and to allow a convinient way to put slices into the data array, and set the available array to True

class savu.data.structures.VolumeData

Bases: savu.data.structures.Data

Descriptor for volume data

create_backing_h5(path, group_name, data_shape, data_type, mpi=False)

Create a h5 backend for this ProjectionData

Parameters:

• path (str) – The full path of the NeXus file to use as a backend
• data_shape – The shape of the data block
• data_type – The type of the data block
• mpi (package) – if an MPI process, provide MPI package here, default None

get_volume_shape()

Gets the real number sinograms

Returns:integer number of sinogram frames