pwspy.analysis.compilation.DynamicsRoiCompiler

class pwspy.analysis.compilation.DynamicsRoiCompiler(settings)[source]

Bases: pwspy.analysis.compilation._abstract.AbstractRoiCompiler

run(results, roi)[source]

Combine information from analysis results and an ROI to produce values averaged over the ROI.

Parameters
  • results (DynamicsAnalysisResults) – The analysis results to compile.

  • roi (Roi) – The ROI to used to segment out a section of the results.

Return type

Tuple[DynamicsRoiCompilationResults, List[AnalysisWarning]]