Skip to content

Treatments

ChemotherapyProtocol = Dict[TreatmentTime, float] module-attribute

Alias for a chemotherapy protocol, mapping treatment times to dose values.

RadiotherapyProtocol = Dict[TreatmentTime, float] module-attribute

Alias for a radiotherapy protocol, mapping treatment times to dose values.

TreatmentTime = datetime module-attribute

Alias for how the data type we choose to represent the time of a treatment.

ChemotherapySpecification

Bases: BaseModel

Defines a chemotherapy treatment specification, including dose schedule and pharmacokinetic parameters.

Attributes:

Name Type Description
sensitivity float

The sensitivity parameter of the drug.

decay_rate float

The decay rate of the drug in the body.

times List[datetime]

Times of the treatments in the protocol.

doses List[float]

Doses corresponding to each treatment time.

protocol(ChemotherapyProtocol) List[float]

The complete mapping of treatment times to chemotherapy doses.

ChemotherapyTreatment

Bases: BaseModel

Represents a single chemotherapy treatment session.

Attributes:

Name Type Description
time TreatmentTime

The time of the treatment.

dose float

The dose delivered during the treatment.

units ChemotherapyUnit

The unit of the dose (e.g., mg).

ChemotherapyUnit

Bases: str, Enum

Enumeration of possible units for chemotherapy doses.

Attributes:

Name Type Description
mg str

Milligrams, a unit of mass.

RadiotherapySpecification

Bases: BaseModel

Defines a radiotherapy protocol, including dose schedule and biological parameters.

Attributes:

Name Type Description
alpha float

Tissue-specific radiosensitivity parameter (α).

alpha_beta_ratio float

Tissue-specific α/β ratio.

times List[TreatmentTime]

Times of the treatments in the protocol.

doses List[float]

Doses corresponding to each treatment time.

protocol(RadiotherapyProtocol) List[float]

The complete mapping of treatment times to radiotherapy doses.

RadiotherapyTreatment

Bases: BaseModel

Represents a single radiotherapy treatment session.

Attributes:

Name Type Description
time TreatmentTime

The time of the treatment.

dose float

The dose delivered during the treatment.

units RadiotherapyUnit

The unit of the dose (e.g., Gy).

RadiotherapyUnit

Bases: str, Enum

Enumeration of possible units for radiotherapy doses.

Attributes:

Name Type Description
Gy str

Gray, the SI unit of absorbed radiation dose.