protoclass API¶
This is the full API documentation of the protoclass toolbox.
Data management module¶
The protoclass.data_management modules allows to handle medical
data format.
Classes¶
data_management.ADCModality([path_data]) |
Class to handle ADC modality. |
data_management.T2WModality([path_data]) |
Class to handle T2W-MRI modality. |
data_management.DWIModality([path_data]) |
Class to handle DWI modality. |
data_management.DCEModality([path_data]) |
Class to handle DCE-MRI modality. |
data_management.RDAModality(bandwidth[, ...]) |
Class to handle RDA-MRSI modality. |
data_management.GTModality([path_data]) |
Class to handle GT modality. |
data_management.OCTModality([path_data]) |
Class to handle OCT modality. |
Pre-processing module¶
MRSI related methods¶
preprocessing.MRSIPhaseCorrection |
|
preprocessing.MRSIFrequencyCorrection |
|
preprocessing.MRSIBaselineCorrection |
Extraction module¶
The protoclass.extraction modules allows to extract features which later
will be used during classification.
Standalone related methods¶
extraction.IntensitySignalExtraction(...) |
Intensity signal extraction from standalone modality. |
extraction.EdgeSignalExtraction(base_modality) |
Edge signal extraction from standalone modality. |
extraction.HaralickExtraction(base_modality) |
Haralick extraction from standalone modality. |
extraction.PhaseCongruencyExtraction(...[, ...]) |
Edge signal extraction from standalone modality. |
extraction.GaborBankExtraction(...) |
Edge signal extraction from standalone modality. |
extraction.DCTExtraction(base_modality[, ...]) |
DCT extraction from standalone modality. |
extraction.SpatialExtraction(base_modality) |
Spatial extraction from standalone modality. |
extraction.LBPExtraction(base_modality[, p, ...]) |
LBP extraction from standalone modality. |
extraction.gabor_filter_3d(frequency[, ...]) |
Return complex 3D Gabor filter kernel. |
Temporal related methods¶
extraction.EnhancementSignalExtraction(...) |
Enhancement signal extraction from temporal modality. |
extraction.BrixQuantificationExtraction(...) |
Enhancement signal extraction from temporal modality. |
extraction.PUNQuantificationExtraction(...) |
Enhancement signal extraction from temporal modality. |
extraction.SemiQuantificationExtraction(...) |
Enhancement signal extraction from temporal modality. |
extraction.ToftsQuantificationExtraction(...) |
Enhancement signal extraction from temporal modality. |
extraction.WeibullQuantificationExtraction(...) |
Enhancement signal extraction from temporal modality. |
MRSI related methods¶
extraction.RelativeQuantificationExtraction(...) |
Relative quantification extraction from MRSI modality. |
extraction.MRSISpectraExtraction(base_modality) |
MRSI spectra extraction from MRSI modality. |
Utils module¶
The protoclass.utils module includes various utilities.
Functions¶
utils.find_nearest(array, value) |
Find the nearest value and index inside an ndarray. |
utils.check_path_data(path_data) |
Check if the path data exist. |
utils.check_modality(modality, template_modality) |
Check the modality class is the same than a template modality. |
utils.check_img_filename(filename) |
Method to check that the filename is an img file. |
utils.check_npy_filename(filename) |
Method to check that the filename is an npy file. |
utils.check_filename_pickle_load(filename) |
Method to check if the filename corresponds to a pickle file. |
utils.check_filename_pickle_save(filename) |
Function to check the extension of the pickle file. |
utils.check_modality_inherit(child_modality, ...) |
Check if a modality inherit from another one. |
utils.check_modality_gt(modality, ...) |
Check the consistency of the modality with the ground-truth. |