EqualAreaPenalty

class glotaran.model.clp_penalties.EqualAreaPenalty(*, type: str = 'equal_area', source: str, source_intervals: list[tuple[float, float]], target: str, target_intervals: list[tuple[float, float]], parameter: Parameter | str, weight: float)[source]

Bases: ClpPenalty

Forces the area of 2 clp to be the same.

An equal area constraint adds a the difference of the sum of a compartments in the e matrix in one or more intervals to the scaled sum of the e matrix of one or more target compartments to residual. The additional residual is scaled with the weight.

Method generated by attrs for class EqualAreaPenalty.

Attributes Summary

`type`
`source`
`source_intervals`
`target`
`target_intervals`
`parameter`
`weight`

Methods Summary

`get_item_type`	Get the type string.
`get_item_type_class`	Get the type for a type string.
`get_item_types`	Get all type strings.

Methods Documentation

classmethod get_item_type() → str

Get the type string.

Return type:: str

classmethod get_item_type_class(item_type: str) → Type

Get the type for a type string.

Parameters:: item_type (str) – The type string.
Return type:: Type

classmethod get_item_types() → list[str]

Get all type strings.

Return type:: list[str]

parameter: ParameterType

source: str

source_intervals: list[tuple[float, float]]

target: str

target_intervals: list[tuple[float, float]]

type: str

weight: float