pyanno4rt.optimization.projections

Projections module.

This module aims to provide methods and classes for different types of forward and backward projections between fluence and dose.

Overview

Classes
`BackProjection`	Backprojection superclass.
`ConstantRBEProjection`	Constant RBE projection class.
`DoseProjection`	Dose projection class.

Attributes
`projection_map`	-

Classes

class pyanno4rt.optimization.projections.BackProjection[source]

Backprojection superclass.

This class provides caching attributes, methods to get/compute the dose and the fluence gradient, and abstract methods to implement projection rules within the inheriting classes.

__dose__

Current (cached) dose vector.

Type:: ndarray

__dose_gradient__

Current (cached) dose gradient.

Type:: ndarray

__fluence__

Current (cached) fluence vector.

Type:: ndarray

__fluence_gradient__

Current (cached) fluence gradient.

Type:: ndarray

Overview

Methods
`compute_dose`(fluence)	Compute the dose vector from the fluence and update the cache.
`compute_fluence_gradient`(dose_gradient)	Compute the fluence gradient from the dose gradient and update the cache.
`get_dose`()	Get the dose vector.
`get_fluence_gradient`()	Get the fluence gradient.
`compute_dose_result`(fluence)	abc Compute the dose projection from the fluence vector.
`compute_fluence_gradient_result`(dose_gradient)	abc Compute the fluence gradient projection from the dose gradient.

Members

compute_dose(fluence)[source]

Compute the dose vector from the fluence and update the cache.

Parameters:: fluence (ndarray) – Values of the fluence vector.
Returns:: Values of the dose vector.
Return type:: ndarray

compute_fluence_gradient(dose_gradient)[source]

Compute the fluence gradient from the dose gradient and update the cache.

Parameters:: dose_gradient (ndarray) – Values of the dose gradient.
Returns:: Values of the fluence gradient.
Return type:: ndarray

get_dose()[source]

Get the dose vector.

Returns:: Values of the dose vector.
Return type:: ndarray

get_fluence_gradient()[source]

Get the fluence gradient.

Returns:: Values of the fluence gradient.
Return type:: ndarray

abstract compute_dose_result(fluence)[source]

Compute the dose projection from the fluence vector.

Parameters:: fluence (ndarray) – Values of the fluence vector.
Returns:: Values of the dose vector.
Return type:: ndarray

abstract compute_fluence_gradient_result(dose_gradient)[source]

Compute the fluence gradient projection from the dose gradient.

Parameters:: dose_gradient (ndarray) – Values of the dose gradient.
Returns:: Values of the fluence gradient.
Return type:: ndarray

class pyanno4rt.optimization.projections.ConstantRBEProjection[source]

Bases: pyanno4rt.optimization.projections.BackProjection

Constant RBE projection class.

This class provides an implementation of the abstract forward and backward projection methods in Backprojection by a linear function with a constant RBE value of 1.1.

Overview

Methods
`compute_dose_result`(fluence)	Compute the dose projection from the fluence vector.
`compute_fluence_gradient_result`(dose_gradient)	Compute the fluence gradient projection from the dose gradient.

Members

compute_dose_result(fluence)[source]

Compute the dose projection from the fluence vector.

Parameters:: fluence (ndarray) – Values of the fluence vector.
Returns:: Values of the dose vector.
Return type:: ndarray

compute_fluence_gradient_result(dose_gradient)[source]

Compute the fluence gradient projection from the dose gradient.

Parameters:: dose_gradient (ndarray) – Values of the dose gradient.
Returns:: Values of the fluence gradient.
Return type:: ndarray

class pyanno4rt.optimization.projections.DoseProjection[source]

Bases: pyanno4rt.optimization.projections.BackProjection

Dose projection class.

This class provides an implementation of the abstract forward and backward projection methods in Backprojection by a linear function with a neutral RBE value of 1.0.

Overview

Methods
`compute_dose_result`(fluence)	Compute the dose projection from the fluence vector.
`compute_fluence_gradient_result`(dose_gradient)	Compute the fluence gradient projection from the dose gradient.

Members

compute_dose_result(fluence)[source]

Compute the dose projection from the fluence vector.

Parameters:: fluence (ndarray) – Values of the fluence vector.
Returns:: Values of the dose vector.
Return type:: ndarray

compute_fluence_gradient_result(dose_gradient)[source]

Compute the fluence gradient projection from the dose gradient.

Parameters:: dose_gradient (ndarray) – Values of the dose gradient.
Returns:: Values of the fluence gradient.
Return type:: ndarray

Attributes

pyanno4rt.optimization.projections.projection_map