pygwb.preprocessing.preprocessing_data_gwpy_timeseries

pygwb.preprocessing.preprocessing_data_gwpy_timeseries(gwpy_timeseries: TimeSeries, new_sample_rate: int, cutoff_frequency: float, number_cropped_seconds: int = 2, window_downsampling: str = 'hamming', ftype: str = 'fir', time_shift: int = 0)[source]

Function doing the pre-processing of a gwpy timeseries to be used in the remainder of the code.

Parameters:

  • gwpy_timeseries (gwpy.timeseries.TimeSeries) – Timeseries from gwpy.

  • new_sample_rate (int) – Sampling rate of the downsampled-timeseries in Hz.

  • cutoff_frequency (float) – Frequency (in Hz) from which to start applying the high pass filter.

  • number_cropped_seconds (int, optional) – Number of seconds to remove at the beginning and end of the high-passed data. Default is 2.

  • window_downsampling (str, optional) – Type of window used to downsample.Default value is “hamming”.

  • ftype (str, optional) – Type of filter to use in the downsampling. Default is “fir”.

  • time_shift (int, optional) – Value of the time shift (in seconds). Default is 0.

Returns:
pre_processed_data: gwpy.timeseries.TimeSeries

Timeseries containing the filtered and high passed data (shifted if time_shift>0).