protoclass.data_management.RDAModality

class protoclass.data_management.RDAModality(bandwidth, path_data=None)[source]

Class to handle RDA-MRSI modality.

Parameters:

bandwidth : float,

The frequency bandwidth of the range.

path_data : str, optional (default=None)

The folder in which the data are stored.

Attributes

path_data_ (string) Location of the data.
data_ (ndarray, shape (n_samples, Y, X, Z)) The different volume of the RDA volume. The data are saved in n_samples, Y, X, Z ordered. n_samples corresponds to number of sample in the MRSI spectra.
metadata_ (dict) Dictionnary which contain the MRI sequence information. Note that the information are given in the original ordering (X, Y, Z), which is different from the organisation of data_ which is (Y, X, Z).

Methods

is_read() Function to know if the data have been read.
read_data_from_path([path_data]) Read T2W images which represent a single 3D volume.
update_histogram([nb_bins]) Method to compute some histogram.
__init__(bandwidth, path_data=None)[source]

Methods

__init__(bandwidth[, path_data])
is_read() Function to know if the data have been read.
read_data_from_path([path_data]) Read T2W images which represent a single 3D volume.
update_histogram([nb_bins]) Method to compute some histogram.
is_read()

Function to know if the data have been read.

Returns:

is_read : bool

If True, the data have been read at least once.

read_data_from_path(path_data=None)[source]

Read T2W images which represent a single 3D volume.

Parameters:

path_data : str or None, optional (default=None)

Path to the standalone modality data.

Returns:

self : object

Returns self.

update_histogram(nb_bins=None)[source]

Method to compute some histogram.