histopath_bim_des.config.batching module

Batching configuration module for the histopath simulation model.

class histopath_bim_des.config.batching.BatchSizes(*, deliver_reception_to_cut_up: int, deliver_cut_up_to_processing: int, deliver_processing_to_microtomy: int, deliver_microtomy_to_staining: int, deliver_staining_to_labelling: int, deliver_labelling_to_scanning: int, deliver_scanning_to_qc: int, bone_station: int, processing_regular: int, processing_megas: int, staining_regular: int, staining_megas: int, digital_scanning_regular: int, digital_scanning_megas: int)[source]

Bases: BaseModel

Information for tracking batch sizes in a model. This is the number of specimens, blocks, or slides in a machine or delivery batch. Batches in the model are homogeneous, i.e. all items in a batch are of the same type.

The field titles in this class MUST match the rows of the Excel input file (β€œBatch Sizes” tab).

deliver_reception_to_cut_up: int

Delivery batch size, reception to cut-up (specimens).

deliver_cut_up_to_processing: int

Delivery batch size, cut-up to processing (specimens).

deliver_processing_to_microtomy: int

Delivery batch size, processing to microtomy (specimens).

deliver_microtomy_to_staining: int

Delivery batch size, microtomy to staining (specimens).

deliver_staining_to_labelling: int

Delivery batch size, staining to labelling (specimens).

deliver_labelling_to_scanning: int

Delivery batch size, labelling to scanning (specimens).

deliver_scanning_to_qc: int

Delivery batch size, scanning to QC (specimens).

bone_station: int

Bone station (machine) batch size (blocks).

processing_regular: int

Processing machine batch size, regular blocks.

processing_megas: int

Processing machine batch size, mega blocks.

staining_regular: int

Staining machine batch size, regular slides.

staining_megas: int

Staining machine batch size, mega slides.

digital_scanning_regular: int

Scanning machine batch size, regular slides.

digital_scanning_megas: int

Scanning machine batch size, mega slides.

static from_workbook(wbook: Workbook) → BatchSizes[source]

Construct a dataclass instance from an Excel workbook.

Parameters:

wbook – The Excel workbook to parse.

Returns:

The parsed dataclass instance.