Skip to content

log_normal_distribution

LogNormalDistribution

Bases: BaseDistribution

This class represents a log-normal distribution, a type of statistical distribution where the logarithm of the values is normally distributed. A log-normal distribution is defined by two parameters: the mean and the standard deviation.

Parameters:

Name Type Description Default
mean float
  • The mean/mu of the log-normal distribution.
 required
std_dev float
  • The standard deviation/sigma/width of the log-normal distribution.
 required
Example

Create a LogNormalDistribution object.

lnd = LogNormalDistribution(0, 1)

The mean and std_dev attributes can be accessed and updated.

lnd.mean 0 lnd.std_dev 1 lnd.mean = 5 lnd.mean 5

Source code in emod_api/utils/distributions/log_normal_distribution.py 
 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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
class LogNormalDistribution(BaseDistribution):
    """
    This class represents a log-normal distribution, a type of statistical distribution where the logarithm of the
    values is normally distributed. A log-normal distribution is defined by two parameters: the mean and the standard
    deviation.

    Args:
        mean (float):
            - The mean/mu of the log-normal distribution.

        std_dev (float):
            - The standard deviation/sigma/width of the log-normal distribution.

    Example:
        >>> # Create a LogNormalDistribution object.
        >>> lnd = LogNormalDistribution(0, 1)
        >>> # The mean and std_dev attributes can be accessed and updated.
        >>> lnd.mean
        0
        >>> lnd.std_dev
        1
        >>> lnd.mean = 5
        >>> lnd.mean
        5
    """
    DEMOGRAPHIC_DISTRIBUTION_FLAG = DemographicDistributionFlag.LOG_NORMAL.value

    def __init__(self, mean: float, std_dev: float):
        super().__init__()
        self.mean = mean
        self.std_dev = std_dev

    def set_intervention_distribution(self, intervention_object: s2c.ReadOnlyDict, prefix: str):
        """
        Set the distribution parameters to the object.

        Args:
            intervention_object (s2c.ReadOnlyDict):
                - The object to set.
            prefix (str):
                - The prefix of the parameters.
        """
        self._set_parameters(intervention_object, f"{prefix}_Distribution",
                             DistributionType.LOG_NORMAL_DISTRIBUTION.value)
        self._set_parameters(intervention_object, f"{prefix}_Log_Normal_Mu", self.mean)
        self._set_parameters(intervention_object, f"{prefix}_Log_Normal_Sigma", self.std_dev)

    def get_demographic_distribution_parameters(self) -> dict:
        """
        Yield the flag and relevant values necessary for setting a demographics log normal distribution

        Returns:
            a dict of the form: {'flag': X, 'value1': Y, 'value2': Z}
        """
        return {"flag": self.DEMOGRAPHIC_DISTRIBUTION_FLAG, "value1": self.mean, "value2": self.std_dev}

get_demographic_distribution_parameters()

Yield the flag and relevant values necessary for setting a demographics log normal distribution

Returns:

Type Description
dict

a dict of the form: {'flag': X, 'value1': Y, 'value2': Z}
Source code in emod_api/utils/distributions/log_normal_distribution.py 
54
55
56
57
58
59
60
61
def get_demographic_distribution_parameters(self) -> dict:
    """
    Yield the flag and relevant values necessary for setting a demographics log normal distribution

    Returns:
        a dict of the form: {'flag': X, 'value1': Y, 'value2': Z}
    """
    return {"flag": self.DEMOGRAPHIC_DISTRIBUTION_FLAG, "value1": self.mean, "value2": self.std_dev}

set_intervention_distribution(intervention_object, prefix)

Set the distribution parameters to the object.

Parameters:

Name Type Description Default
intervention_object ReadOnlyDict
  • The object to set.
 required
prefix str
  • The prefix of the parameters.
 required
Source code in emod_api/utils/distributions/log_normal_distribution.py 
39
40
41
42
43
44
45
46
47
48
49
50
51
52
def set_intervention_distribution(self, intervention_object: s2c.ReadOnlyDict, prefix: str):
    """
    Set the distribution parameters to the object.

    Args:
        intervention_object (s2c.ReadOnlyDict):
            - The object to set.
        prefix (str):
            - The prefix of the parameters.
    """
    self._set_parameters(intervention_object, f"{prefix}_Distribution",
                         DistributionType.LOG_NORMAL_DISTRIBUTION.value)
    self._set_parameters(intervention_object, f"{prefix}_Log_Normal_Mu", self.mean)
    self._set_parameters(intervention_object, f"{prefix}_Log_Normal_Sigma", self.std_dev)