get_volume_quality_summary#

VolumeSearch.get_volume_quality_summary(params)#

Gets the volume quality summary.

Diagnose volume quality for the given scope and cell quality measures provided in the VolumeQualitySummaryParams structure. Use default quality limit if the parameters are not specified.

Parameters:
paramsVolumeQualitySummaryParams

Volume quality summary parameters.

Returns:
VolumeQualitySummaryResults

Returns the VolumeQualitySummaryResults.

Return type:

VolumeQualitySummaryResults

Examples

>>> vol_search = VolumeSearch(model=model)
>>> results = vol_search.get_volume_quality_summary(VolumeQualitySummaryParams(model=model))