pyquantus.utc.results module

class pyquantus.utc.results.UtcData

Bases: object

Class to store UTC data and images after analysis.

This class supports both scan converted and non-scan converted images. Once analysis is completed in the UtcAnalysis class, the results are stored in this class for further evaluation and visualization.

utcAnalysis

UTC analysis object

Type:: UtcAnalysis

depth

Depth of the image in mm

Type:: float

width

Width of the image in mm

Type:: float

roiWidthScale

Width of the ROI window in pixels

Type:: int

roiDepthScale

Depth of the ROI window in pixels

Type:: int

rectCoords

Coordinates of each window in the ROI

Type:: List[int]

mbfIm

Midband fit parametric map

Type:: np.ndarray

ssIm

Spectral slope parametric map

Type:: np.ndarray

siIm

Spectral intercept parametric map

Type:: np.ndarray

attCoef

Attenuation coefficient parametric map

Type:: np.ndarray

bscIm

Backscatter coefficient parametric map

Type:: np.ndarray

uNakagamiIm

Nakagami shape parameter parametric map

Type:: np.ndarray

scMbfIm

Scan converted midband fit parametric map

Type:: np.ndarray

scSsIm

Scan converted spectral slope parametric map

Type:: np.ndarray

scSiIm

Scan converted spectral intercept parametric map

Type:: np.ndarray

scAttCoefIm

Scan converted attenuation coefficient parametric map

Type:: np.ndarray

scBscIm

Scan converted backscatter coefficient parametric map

Type:: np.ndarray

scUNakagamiIm

Scan converted Nakagami shape parameter parametric map

Type:: np.ndarray

minMbf

Minimum midband fit value in ROI

Type:: float

maxMbf

Maximum midband fit value in ROI

Type:: float

mbfArr

Midband fit values for each window in ROI

Type:: List[float]

minSs

Minimum spectral slope value in ROI

Type:: float

maxSs

Maximum spectral slope value in ROI

Type:: float

ssArr

Spectral slope values for each window in ROI

Type:: List[float]

minSi

Minimum spectral intercept value in ROI

Type:: float

maxSi

Maximum spectral intercept value in ROI

Type:: float

siArr

Spectral intercept values for each window in ROI

Type:: List[float]

scConfig

Scan conversion configuration

Type:: ScConfig

mbfCmap

Midband fit colormap used for parametric maps

Type:: list

ssCmap

Spectral slope colormap used for parametric maps

Type:: list

siCmap

Spectral intercept colormap used for parametric maps

Type:: list

attCoefCmap

Attenuation coefficient colormap used for parametric maps

Type:: list

bscCmap

Backscatter coefficient colormap used for parametric maps

Type:: list

uNakagamiCmap

Nakagami shape parameter colormap used for parametric maps

Type:: list

property analysisFreqBand: Getter for analysis frequency band stored in the UtcAnalysis class.

property axOverlap: Getter for axial overlap stored in the UtcAnalysis class.

property axWinSize: Getter for axial window size stored in the UtcAnalysis class.

property axialRes: Getter for axial resolution of the final image regardless of scan conversion.

property bmode: ndarray: Getter for RGB B-mode image (no scan conversion).

convertImagesToRGB(): Converts grayscale images to RGB for colormap application.

drawCmaps(): Generates parametric maps for midband fit, spectral slope, and spectral intercept.

property finalAttCoefIm: Getter for final attenuation coefficient parametric map regagrdless of scan conversion.

property finalBmode: ndarray: Getter for RGB B-mode image regardless of scan conversion.

property finalBscIm: Getter for final backscatter coefficient parametric map regardless of scan conversion.

property finalMbfIm: Getter for final midband fit parametric map regardless of scan conversion.

property finalSiIm: Getter for final spectral intercept parametric map regardless of scan conversion.

property finalSsIm: Getter for final spectral slope parametric map regardless of scan conversion.

property finalUNakagamiIm: Getter for final Nakagami shape parameter parametric map regardless of scan conversion.

property finalWindowIdxMap: Getter for final window index map regardless of scan conversion.

formatParamaps(): Adds colorbars to the parametric maps.

property latOverlap: Getter for lateral overlap stored in the UtcAnalysis class.

property latWinSize: Getter for lateral window size stored in the UtcAnalysis class.

property lateralRes: Getter for lateral resolution of the image regardless of scan conversion.

property numSamplesDrOut: Getter for number of samples in the scan converted image (used for Canon project-specific applications).

property pixDepth: Getter for pixel depth of the B-mode image regardless of scan conversion.

property pixWidth: Getter for pixel width of the B-mode image regardless of scan conversion.

plotPsData()

Plots the power spectrum data for each window in the ROI.

The power spectrum data is plotted along with the average power spectrum and a line of best fit used for the midband fit, spectral slope, and spectral intercept calculations. Also plots the frequency band used for analysis.

property roiWindowThreshold: Getter for ROI window threshold stored in the UtcAnalysis class.

property samplingFrequency: Getter for sampling frequency stored in the UtcAnalysis class.

property scBmode: Getter for scan converted RGB B-mode image.

scanConvertCmaps(): Scan converts the parametric maps to match the B-mode image.

scanConvertRGB(image: ndarray) → ndarray

Converts a scan-converted grayscale image to RGB.

Parameters:: image (np.ndarray) – Grayscale image to convert
Returns:: RGB image
Return type:: np.ndarray

property splineX: Getter for spline X coordinates regardless of scan conversion.

property splineY: Getter for spline Y coordinates regardless of scan conversion.

property transducerFreqBand: Getter for transducer frequency band stored in the UtcAnalysis class.

property waveLength: Getter for wavelength of the ultrasound signal stored in the UtcAnalysis class.