Phase Class¶
- class sitesyncro.Phase.Phase(group: int, phase: int)¶
A class representing a chronological phase.
- Parameters:
group (int) – Stratigraphic group number.
phase (int) – Phase number.
- property end: ndarray | None¶
The probability distribution of the dating of the end of the phase.
- Returns:
An array representing the probability distribution of the dating of the end of the phase, where each element is the probability of the corresponding calendar year. Returns None if it’s not set.
- Return type:
np.ndarray or None
- property end_mean: float | None¶
The mean calendar age of the end of the phase in calendar years BP.
- Returns:
The mean calendar age of end of the phase or None if it’s not set.
- Return type:
float or None
- property end_range: float | None¶
The 2-sigma (95.45%) range of the dating of the end of the phase in calendar years BP.
- Returns:
A list containing the lower and upper bounds of the 2-sigma range, or [None, None] if it’s not set.
- Return type:
list
- property group: int¶
The stratigraphic group the phase belongs to
- Returns:
The number of the group
- Return type:
int
- property phase: int¶
The phase number.
- Returns:
The number of the phase
- Return type:
int
- populate(model: Model)¶
Populates the phase with probability distributions for start and end.
- Parameters:
model (Model) – Model object
- Returns:
True if successfully populated
- Return type:
bool
- property samples: List[str]¶
The list of samples that belong to the phase.
- Returns:
A list of samples that belong to the phase.
- Return type:
List[str]
- property start: ndarray | None¶
The probability distribution of the dating of the start of the phase.
- Returns:
An array representing the probability distribution of the dating of the start of the phase, where each element is the probability of the corresponding calendar year. Returns None if it’s not set.
- Return type:
np.ndarray or None
- property start_mean: float | None¶
The mean calendar age of the start of the phase in calendar years BP.
- Returns:
The mean calendar age of start of the phase or None if it’s not set.
- Return type:
float or None
- property start_range: float | None¶
The 2-sigma (95.45%) range of the dating of the start of the phase in calendar years BP.
- Returns:
A list containing the lower and upper bounds of the 2-sigma range, or [None, None] if it’s not set.
- Return type:
list
- property years: ndarray | None¶
Calendar years BP corresponding to the probability distributions.
- Returns:
An array of calendar years BP corresponding to the probability distributions or None if it’s not set.
- Return type:
np.ndarray or None