pygmt.filter1d

pygmt.filter1d(data, output_type='pandas', outfile=None, *, end=None, filter=None, **kwargs)

Time domain filtering of 1-D data tables

Filter a general time domain for multiple column time series data. The user specifies which column is the time (i.e., the independent variable). The fastest operation occurs when the input time series are equally spaced and have no gaps or outliers and the special options are not needed. Read a table and output as a numpy.ndarray, pandas.DataFrame, or ASCII file.

Full option list at https://docs.generic-mapping-tools.org/latest/filter1d.html

Aliases:

• E = end

• F = filter

Parameters ———-. output_type : str

Determine the format the xyz data will be returned in [Default is pandas]:

• numpy - numpy.ndarray

• pandas- pandas.DataFrame

• file - ASCII file (requires outfile)

outfilestr

The file name for the output ASCII file.

Returns

ret (pandas.DataFrame or numpy.ndarray or None) – Return type depends on outfile and output_type:

• None if outfile is set (output will be stored in file set by outfile)

• pandas.DataFrame or numpy.ndarray if outfile is not set (depends on output_type [Default is pandas.DataFrame])