ControlDesign#

class rojak.atmosphere.feature_composite.ControlDesign(label, *, observation_offset)[source]#

How to build one control: a resampling with the feature removed, used to estimate the counterfactual.

A centre at time t is paired with the observations made at t + observation_offset, at the centre’s place. The same features therefore see traffic from another time, e.g. a week earlier with observation_offset=np.timedelta64(-7, "D").

label#

Name of the control, e.g. "obs-7D". It labels the control dimension of the counts, so it must be unique among the controls of one composite.

Type:: str

observation_offset#

Offset from the centre’s time to the time the control’s observations were made. Keyword only.

Type:: numpy.timedelta64

Raises:

ValueError – If label is empty.
TypeError – If observation_offset is not a numpy.timedelta64.

Parameters:

label (str)
observation_offset (timedelta64)

__init__(label, *, observation_offset)[source]#

Parameters:

label (str)
observation_offset (timedelta64)

Return type:

None

Methods

__init__(label, *, observation_offset)

Attributes

`label`
`observation_offset`