pytimber.Fundamentals
- class pytimber.Fundamentals(fundamental_pattern: str, dest_in: Optional[Iterable[str]] = None, dest_not_in: Optional[Iterable[str]] = None)
Represents fundamentals data.
- Parameters:
fundamental_pattern – The fundamental pattern in the format: <acc-pattern>:<lsa-cycle-pattern>:<timing-user-pattern>.
dest_in – An optional list of destination items to filter in.
dest_not_in – An optional list of destination items to filter out.
- acc
The acc pattern extracted from the fundamental pattern.
- Type:
str
- cycle
The lsa cycle pattern extracted from the fundamental pattern.
- Type:
str
- user
The timing user pattern extracted from the fundamental pattern.
- Type:
str
- Raises:
ValueError – If the provided fundamental pattern is not in the correct format.
Methods
Fundamentals.__init__
(fundamental_pattern[, ...])Fundamentals.apply_filter
(dataset)Apply fundamentals to a dataset.
Attributes
Get the fundamental pattern.