EqualAreaPenalty

class glotaran.model.clp_penalties.EqualAreaPenalty[source]

Bases: object

An equal area constraint adds a the differenc of the sum of a compartments in the e matrix in one ore 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.

Attributes Summary

`parameter`	ModelProperty is an extension of the property decorator.
`source`	ModelProperty is an extension of the property decorator.
`source_intervals`	ModelProperty is an extension of the property decorator.
`target`	ModelProperty is an extension of the property decorator.
`target_intervals`	ModelProperty is an extension of the property decorator.
`weight`	ModelProperty is an extension of the property decorator.

Methods Summary

`applies`	Returns true if the index is in one of the intervals.
`as_dict`
`fill`
`from_dict`
`markdown`
`validate`

Methods Documentation

applies(index: Any) → bool[source]

Returns true if the index is in one of the intervals.

Parameters: index –
Returns: applies
Return type: bool

as_dict() → dict

fill(model: Model, parameters: ParameterGroup) → cls

classmethod from_dict(values: dict) → cls

markdown(all_parameters: ParameterGroup = None, initial_parameters: ParameterGroup = None) → MarkdownStr

property parameter: model_property.glotaran_property_type

ModelProperty is an extension of the property decorator.