dosma.core.quant_vals.QuantitativeValue

class dosma.core.quant_vals.QuantitativeValue(volumetric_map: Optional[dosma.core.med_volume.MedicalVolume] = None)[source]

This class handles tracking volumes associated with different quantitative values.

Quantitative MRI characterizes the relaxation profile of different regions in the volume. This profile is determined by the composition of the object and has been shown to be informative for early detection of pathology.

In practice, many of these quantitative relaxation parameters (\(T_1\), \(T_2\), \(T_2^*\), etc.) are computed per voxel by fitting to the exponential decay/recovery curves or by some analytical method. This results in a volume where different voxels have different relaxation parameters. These volumes are referred to as volumetric quantitative maps or quantitative maps.

These fitted/computed relaxation parameters are called quantitative values.

Parameters

volumetric_map (MedicalVolume, optional) – Volumetric quantitative map.

Variables

  • volumetric_map (MedicalVolume) – Volumetric quantitative map.

  • additional_volumes (Dict[str, MedicalVolume]) – Additional volumes associated with quantitative value. These are typically volumes associated with the goodness of fit of the value. For example, a volume could be pixel-wise r-squared, or error bounds, etc.

Note

This class is in alpha - signature and functionality changes are very likely.

__init__(volumetric_map: Optional[dosma.core.med_volume.MedicalVolume] = None)[source]

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__([volumetric_map])

Initialize self.

add_additional_volume(name, volume)

Add volume that corresponds to quantitative value.

get_qv(qv_id)

Find QuantitativeValue enum using id or name.

load_data(dir_path)

Load data from disk.

load_qvs(dir_path)

Load all quantitative values from directory.

save_data(dir_path[, data_format])

Save data to disk.

save_qvs(dir_path, qvs)

Save all quantitative values from directory.

to_metrics([mask, labels, bounds, closed])

Compute scalar metrics for quantitative values.

Attributes

ID

NAME

qv_type

quantitative value type.