Skip to content

condom_usage_parameters

CondomUsageParameters

Bases: Updateable

Source code in emodpy_hiv/demographics/condom_usage_parameters.py 
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
class CondomUsageParameters(Updateable):
    def __init__(self,
                 min: float = 0,
                 mid: float = 0,
                 max: float = 0,
                 rate: float = 0):
        """
        Parameterizes condom usage over time, a component of EMOD relationship parameters.
        See additional documentation on [Condom Usage](https://emod.idmod.org/emodpy-hiv/emod/sti-model-relationships/#condom-usage)
        and [Relationship Parameters](https://emod.idmod.org/emodpy-hiv/emod/parameter-demographics/#relationship_parameters).

        Args:
            min (float): minimum condom usage probability (pre-inflection point)
            mid (float): inflection point in condom usage (a year)
            max (float): maximum condom usage probability (post-inflection point)
            rate (float): slope of condom usage at inflection point
        """
        super().__init__()
        self.min = min
        self.mid = mid
        self.max = max
        self.rate = rate

    def to_dict(self) -> Dict:
        usage = {
            'Min': self.min,
            'Mid': self.mid,
            'Max': self.max,
            'Rate': self.rate
        }
        return usage

    @classmethod
    def from_dict(cls, d: Dict) -> '__class__':
        return cls(min=d['Min'], mid=d['Mid'], max=d['Max'], rate=d['Rate'])

__init__(min=0, mid=0, max=0, rate=0)

Parameterizes condom usage over time, a component of EMOD relationship parameters. See additional documentation on Condom Usage and Relationship Parameters.

Parameters:

Name Type Description Default
min float

minimum condom usage probability (pre-inflection point)

 0
mid float

inflection point in condom usage (a year)

 0
max float

maximum condom usage probability (post-inflection point)

 0
rate float

slope of condom usage at inflection point

 0
Source code in emodpy_hiv/demographics/condom_usage_parameters.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
def __init__(self,
             min: float = 0,
             mid: float = 0,
             max: float = 0,
             rate: float = 0):
    """
    Parameterizes condom usage over time, a component of EMOD relationship parameters.
    See additional documentation on [Condom Usage](https://emod.idmod.org/emodpy-hiv/emod/sti-model-relationships/#condom-usage)
    and [Relationship Parameters](https://emod.idmod.org/emodpy-hiv/emod/parameter-demographics/#relationship_parameters).

    Args:
        min (float): minimum condom usage probability (pre-inflection point)
        mid (float): inflection point in condom usage (a year)
        max (float): maximum condom usage probability (post-inflection point)
        rate (float): slope of condom usage at inflection point
    """
    super().__init__()
    self.min = min
    self.mid = mid
    self.max = max
    self.rate = rate