pyanno4rt.input_check.check_functions._check_dose_matrix

Dose-influence matrix checking.

Overview

Function

check_dose_matrix(dose_shape, dose_matrix_rows)

Check the equality between the number of dose voxels calculated from the dose resolution inputs and implied by the dose-influence matrix.

Functions

pyanno4rt.input_check.check_functions._check_dose_matrix.check_dose_matrix(dose_shape, dose_matrix_rows)[source]

Check the equality between the number of dose voxels calculated from the dose resolution inputs and implied by the dose-influence matrix.

Parameters:
  • dose_shape (tuple) – Tuple with the number of dose grid points per axis, calculated from the dose resolution inputs.

  • dose_matrix_rows (int) – Number of rows in the dose-influence matrix (the number of voxels in the dose grid).

Raises:

ValueError – If the product of the elements in dose_shape is not equal to the value of dose_matrix_rows.