BatchResult#

class zrad.batch.results.BatchResult(workflow: str, case_results: list)[source]#

Summary returned by batch workflows.

BatchResult provides shared aggregate reporting for preprocessing, filtering, and radiomics batch runs. The individual case-result objects are workflow-specific, but they all expose a status field and may expose an error field.

Parameters:

workflow (str) – Name of the batch workflow, such as "preprocessing", "filtering", or "radiomics".
case_results (list) – Workflow-specific case-result objects.

Properties

BatchResult.errors#

Case results that include an error message.

Returns:: errors – Case-result objects where error is not empty.
Return type:: list

BatchResult.failed_count#

Number of cases with status == "failed".

Returns:: count – Count of failed case results.
Return type:: int

BatchResult.processed_count#

Number of cases with status == "processed".

Returns:: count – Count of successfully processed case results.
Return type:: int

BatchResult.skipped_count#

Number of cases with status == "skipped".

Returns:: count – Count of skipped case results.
Return type:: int

BatchResult.total_count#

Total number of selected cases.

Returns:: count – Number of case results stored in case_results.
Return type:: int