paleos.agemodel module#
Module to help resample or interpolate age models to new depths
Age models are assumed to be a pandas Series object with depth as index and age as value.
- paleos.agemodel.add_point(age_model: Series, depth: float = 0, age: float = 0, sort_result: bool = True) Series #
Add a point to an age model
- Parameters:
age_model (pd.Series) – The age model
depth (float) – The depth for the point. Defaults to 0.
age (float) – The age for the point. Defaults to 0.
sort_result (bool, optional) – Sort the result. Defaults to True.
- Returns:
Age model with point added
- Return type:
pd.Series
- paleos.agemodel.clip_age_reversals(age_model: Series) Series #
Remove reversals in age models
- Parameters:
age_model (pd.Series) – The age model
- Returns:
The age model with age reverals removed
- Return type:
pd.Series
- paleos.agemodel.resample_linear(age_model: Series, depths: ndarray) Series #
Resample age model onto new depths using linear interpolation
- Parameters:
age_model (pd.Series) – Age model
depths (np.ndarray) – Depths for which to calculate out ages
- Returns:
Ages for depths
- Return type:
pd.Series
- paleos.agemodel.resample_cubic(age_model: Series, depths: ndarray) Series #
Resample age model onto new depths using cubic interpolation
- Parameters:
age_model (pd.Series) – Age model
depths (np.ndarray) – Depths for which to calculate out ages
- Returns:
Ages for depths
- Return type:
pd.Series
- paleos.agemodel.resample_spline(age_model: Series, depths: ndarray)#
Resample age model onto new depths using spline interpolation
- Parameters:
age_model (pd.Series) – Age model
depths (np.ndarray) – Depths for which to calculate out ages
- Returns:
Ages for depths
- Return type:
pd.Series
- paleos.agemodel.resample_loess(age_model: Series, depths: ndarray, smoothing_factor: float = 0.33) Series #
Resample age model onto new depths using local linear regression
- Parameters:
age_model (pd.Series) – Age model
depths (np.ndarray) – Depths for which to calculate out ages
smoothing_factor (float, optional) – Smoothing factor to use. Defaults to 0.33.
- Returns:
Ages for depths
- Return type:
pd.Series
- paleos.agemodel.resample_lowess(age_model: Series, depths: ndarray, smoothing_factor: float = 0.33)#
Resample age model onto new depths using local weighted linear regression
- Parameters:
age_model (pd.Series) – Age model
depths (np.ndarray) – Depths for which to calculate out ages
smoothing_factor (float, optional) – Smoothing factor to use. Defaults to 0.33.
- Returns:
Ages for depths
- Return type:
pd.Series