protoclass.extraction.RelativeQuantificationExtraction

class protoclass.extraction.RelativeQuantificationExtraction(base_modality, normalization='l2', output='ratio', fitting=True)

Relative quantification extraction from MRSI modality.

Parameters:

base_modality : object

The base modality on which the normalization will be applied. The base modality should inherate from StandaloneModality class.

normalization : None or str, optional (default=’l2’)

Apply a normalization or not. Choice are None, ‘l2’, or ‘l1’.

output : str, optional (default=’ratio’)

The type of output. Either return the ratio citrate over choline using ‘ratio’ or the integral citrate and choline using ‘integral’.

fitting : bool, optional (default=True)

Quantification by fitting or just on the original signal.

Attributes

base_modality_	(object) The base modality on which the normalization will be applied. The base modality should inherate from StandaloneModality class.
roi_data_	(ndarray, shape flexible) Corresponds to the index to consider in order to fit the data.

Methods

fit(modality[, ground_truth, cat])	Find the parameters needed to apply the extraction.
load_from_pickles(filename)	Function to load a normalization object.
save_to_pickles(filename)	Function to save a normalizatio object using pickles.
transform(modality[, ground_truth, cat])	Extract the data from the given modality.

__init__(base_modality, normalization='l2', output='ratio', fitting=True)

Methods

__init__(base_modality[, normalization, ...])
fit(modality[, ground_truth, cat])	Find the parameters needed to apply the extraction.
load_from_pickles(filename)	Function to load a normalization object.
save_to_pickles(filename)	Function to save a normalizatio object using pickles.
transform(modality[, ground_truth, cat])	Extract the data from the given modality.

fit(modality, ground_truth=None, cat=None)

Find the parameters needed to apply the extraction.

Parameters:

modality : object of type TemporalModality

The modality object of interest.

ground-truth : object of type GTModality or None

The ground-truth of GTModality. If None, the whole data will be considered.

cat : str or None

String corresponding at the ground-truth of interest. Cannot be None if ground-truth is not None.

load_from_pickles(filename)

Function to load a normalization object.

Parameters:

filename : str

Filename to the pickle file. The extension should be .p.

Returns:

bpp : object

Returns the loaded object.

save_to_pickles(filename)

Function to save a normalizatio object using pickles.

Parameters:

filename : str

Filename to the pickle file. The extension should be .p.

Returns:

None

transform(modality, ground_truth=None, cat=None)

Extract the data from the given modality.

Parameters:

modality : object of type StandaloneModality

The modality object of interest.

ground-truth : object of type GTModality or None

The ground-truth of GTModality. If None, the whole data will be considered.

cat : str or None

String corresponding at the ground-truth of interest. Cannot be None if ground-truth is not None.

Returns

——

data : ndarray, shape (n_sample, n_feature)

A matrix containing the features extracted. The number of samples is equal to the number of positive label in the ground-truth.