vamtoolbox.metrics

Module Contents

Functions

calcCV(target, recon[, layerwise])	Calculate coefficient of variance in target region
calcVER(target, recon[, layerwise])	Calculate volumetric error rate
calcPW(target, recon[, layerwise])	Calculate process window
calcIPDR(target, recon[, layerwise])	Calculate in-part dose range

vamtoolbox.metrics.calcCV(target, recon, layerwise=False)

Calculate coefficient of variance in target region

Parameters:

compared (target as the reference to which the reconstruction is) –

reconndarray

reconstruction to evaluate

layerwisebool, optional

if True, the CV is computed per z-slice

Returns:

if layerwise == True, ndarray will have size equal to the # of z slices

Return type:

float or ndarray

vamtoolbox.metrics.calcVER(target, recon, layerwise=False)

Calculate volumetric error rate

Parameters:

compared (target as the reference to which the reconstruction is) –

reconndarray

reconstruction to evaluate

layerwisebool, optional

if True, the VER is computed per z-slice

Returns:

if layerwise == True, ndarray will have size equal to the # of z slices

Return type:

float or ndarray

vamtoolbox.metrics.calcPW(target, recon, layerwise=False)

Calculate process window

Parameters:

compared (target as the reference to which the reconstruction is) –

reconndarray

reconstruction to evaluate

layerwisebool, optional

if True, the PW is computed per z-slice

Returns:

if layerwise == True, ndarray will have size equal to the # of z slices

Return type:

float or ndarray

vamtoolbox.metrics.calcIPDR(target, recon, layerwise=False)

Calculate in-part dose range

Parameters:

compared (target as the reference to which the reconstruction is) –

reconndarray

reconstruction to evaluate

layerwisebool, optional

if True, the IPDR is computed per z-slice

Returns:

if layerwise == True, ndarray will have size equal to the # of z slices

Return type:

float or ndarray