pyanno4rt.tools._snapshot

Instance snapshot.

Overview

Function

snapshot(instance, path, include_patient_data, include_dose_matrix, include_model_data)

Take a snapshot of a treatment plan.

Functions

pyanno4rt.tools._snapshot.snapshot(instance, path, include_patient_data=False, include_dose_matrix=False, include_model_data=False)[source]

Take a snapshot of a treatment plan.

Parameters:

  • instance (object of class from base) – The base treatment plan class from which to take a snapshot.

  • path (str) –

    Directory path for the snapshot (folder).

    Note

    If the specified path does not reference an existing folder, one is created automatically.

  • include_patient_data (bool, default=False) – Indicator for the storage of the external patient data, i.e., computed tomography and segmentation data.

  • include_dose_matrix (bool, default=False) – Indicator for the storage of the dose-influence matrix.

  • include_model_data (bool, default=False) – Indicator for the storage of the outcome model-related dataset(s).

Raises:

AttributeError – If the treatment plan instance has not been configured yet.