pynetdesign.modelling.io.decimate_geometry#
- pynetdesign.modelling.io.decimate_geometry(geometry_df, step)[source]#
Decimate a non-combined geometry by keeping every
step-th station.This is useful for checking how the channel spacing of a dense DAS array affects sensitivity, by thinning an existing geometry rather than regenerating it.
- Parameters:
- geometry_df
pandas.DataFrame The input geometry, with one row per station and metadata in
attrs.- step
int Decimation factor, so that
step=5keeps rows 0, 5, 10 and so on.
- geometry_df
- Returns:
- decimated_geometry_df
pandas.DataFrame New geometry with every
step-th station, the index reset and all originalattrspreserved.
- decimated_geometry_df
- Raises:
- ValueError
If
stepis not a positive integer, or if the geometry is combined.