savu.data.data_structures.data module

class Data(name, exp)

The Data class dynamically inherits from transport specific data class and holds the data array, along with associated information.

add_pattern(dtype, **kwargs)

Add a pattern.

Params str dtype

The type of pattern to add, which can be anything from the savu.data.data_structures.utils.pattern_list pattern_list savu.data.data_structures.utils.pattern_list pattern_list:

Keyword Arguments

• core_dims (tuple) – Dimension indices of core dimensions

• slice_dims (tuple) – Dimension indices of slice dimensions

add_volume_patterns(x, y, z)

Adds volume patterns

Params int x

dimension to be associated with x-axis

Params int y

dimension to be associated with y-axis

Params int z

dimension to be associated with z-axis

amend_axis_label_values(slice_list)

Amend all axis label values based on the slice_list parameter. This is required if the data is reduced.

get_axis_label_keys()

Get axis_label names

Returns

A list containing associated axis names for each dimension

Return type

list(str)

get_axis_labels()

Get axis labels.

Returns

Axis labels

Return type

list(dict)

get_core_dimensions()

Get the core data dimensions associated with the current pattern.

Returns

value associated with pattern key core_dims

Return type

tuple

get_data_dimension_by_axis_label(name, contains=False, exists=False)

Get the dimension of the data associated with a particular axis_label.

Parameters

name (str) – The name of the axis_label

Keyword Arguments

• contains (bool) – Set this flag to true if the name is only part of the axis_label name

• exists (bool) – Set to True to return False rather than Exception

Returns

The associated axis number

Return type

int

get_data_patterns()

Get data patterns associated with this data object.

Returns

A dictionary of associated patterns.

Return type

dict

get_itemsize()

Returns bytes per entry

get_name(orig=False)

Get data name.

Keyword Arguments

orig (bool) – Set this flag to true to return the original cloned dataset name if this dataset is a clone

Returns

the name associated with the dataset

Return type

str

get_original_shape()

Returns the original shape of the data before previewing

Returns

Original data shape.

Return type

tuple

get_preview()

Get the Preview instance associated with the data object

get_previous_pattern()

get_shape()

Get the dataset shape

Returns

data shape

Return type

tuple

get_slice_dimensions()

Get the slice data dimensions associated with the current pattern.

Returns

value associated with pattern key slice_dims

Return type

tuple

set_axis_labels(*args)

Set the axis labels associated with each data dimension.

Parameters

str – Each arg should be of the form name.unit. If name is a data_obj.meta_data entry, it will be output to the final .nxs file.

set_original_shape(shape)

Set the original data shape before previewing

set_shape(shape)

Set the dataset shape.