Skip to content

pam.samplers.time

apply_jitter_to_plan(plan, jitter, min_duration) #

Apply time jitter to activity durations in a plan, leg durations are kept the same. Activity durations are jittered in sequence order. At each step the activity is jittered according to the maximum jitter and minimum duration of all activities in the plan.

PARAMETER DESCRIPTION
plan

plan to be jittered

TYPE: Plan

jitter

maximum jitter

TYPE: timedelta

min_duration

minimum activity duration.

TYPE: timedelta

Source code in src/pam/samplers/time.py 
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
def apply_jitter_to_plan(plan: Plan, jitter: timedelta, min_duration: timedelta):
    """Apply time jitter to activity durations in a plan, leg durations are kept the same.
    Activity durations are jittered in sequence order. At each step the activity
    is jittered according to the maximum jitter and minimum duration of all activities
    in the plan.

    Args:
        plan (Plan): plan to be jittered
        jitter (timedelta): maximum jitter
        min_duration (timedelta): minimum activity duration.
    """
    if plan.length == 1:  # do nothing
        return None
    for i in range(0, plan.length - 1, 2):
        jitter_activity(plan, i, jitter=jitter, min_duration=min_duration)

jitter_activity(plan, i, jitter, min_duration) #

Jitter duration of given activity at index i.

Remaining activities and legs after activity are also shifted. Leg durations are not changed. Subsequent activity durations are equally change to maintain 24hr plan.

PARAMETER DESCRIPTION
plan

TYPE: Plan

i

TYPE: int

jitter

TYPE: timedelta

min_duration

TYPE: timedelta

RAISES DESCRIPTION
UserWarning

index i of plan must be of type Activity.
Source code in src/pam/samplers/time.py 
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
62
63
64
65
66
67
68
69
70
71
72
73
def jitter_activity(plan: Plan, i: int, jitter: timedelta, min_duration: timedelta):
    """Jitter duration of given activity at index i.

    Remaining activities and legs after activity are also shifted.
    Leg durations are not changed.
    Subsequent activity durations are equally change to maintain 24hr plan.

    Args:
        plan (Plan):
        i (int):
        jitter (timedelta):
        min_duration (timedelta):

    Raises:
        UserWarning: index `i` of `plan` must be of type `Activity`.
    """
    act = plan[i]
    if not isinstance(act, Activity):
        raise UserWarning(f"Expected type of Activity for act, not {type(act)}")

    prev_duration = act.duration
    tail = (len(plan) - i) / 2

    min_end = max(act.start_time + min_duration, act.end_time - jitter)

    allowance = plan[-1].end_time - act.end_time
    for j in range(i + 1, len(plan), 2):  # legs
        allowance = -plan[j].duration
    for j in range(i + 2, len(plan) + 1, 2):  # acts
        allowance = -min_duration

    max_end = min(plan[-1].end_time - allowance, act.end_time + jitter)
    jitter_range = max((max_end - min_end).seconds, 1)

    jitter = timedelta(seconds=randrange(jitter_range))
    new_duration = min_end - act.start_time + jitter
    change = (new_duration - prev_duration) / tail

    time = act.shift_duration(new_duration)
    time = plan[i + 1].shift_start_time(time)  # shift first tail leg

    for j in range(i + 2, len(plan) - 1, 2):  # tail acts
        time = plan[j].shift_start_time(time)
        time = plan[j].shift_duration(plan[j].duration - change)
        time = plan[j + 1].shift_start_time(time)  # leg

    # final act
    time = plan[-1].shift_start_time(time)
    plan[-1].end_time = END_OF_DAY