Visualisation#

class pydicer.visualise.data.VisualiseData(working_directory='.')#

Class that facilitates the visualisation of the data once converted

Parameters:

working_directory (str|pathlib.Path, optional) – Main working directory for pydicer. Defaults to “.”.

visualise(dataset_name: str = 'data', patient: Optional[Union[list, str]] = None, force: bool = True)#

Visualise the data in the working directory. PNG files are generates providing a snapshot of the various data objects.

Parameters:
  • dataset_name (str, optional) – The name of the dataset to compute DVHs on. Defaults to “data” (runs on all data).

  • patient (list|str, optional) – A patient ID (or list of patient IDs) to visualise. Defaults to None.

  • force (bool, optional) – When True objects will be visualised even if the output files already exist. Defaults to True.