Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
gautam-404 authored Oct 31, 2023
1 parent cbb0a01 commit 0da6d9d
Showing 1 changed file with 0 additions and 44 deletions.
44 changes: 0 additions & 44 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,47 +13,3 @@ pw = PreWhitener(name='HDxxxxx')
pw.auto()
```

## Available parameters
`name`: Default=None, Type: `str`
KIC/TIC/HD ID, will be used to download light curve if no `lc` is provided.

`lc`: Default=None, Type: `lightkurve.lightcurve.LightCurve` or `pandas.DataFrame` or tuple
Light curve, if already available. If not provided, the light curve will be downloaded using the `name` parameter.

`max_iterations`: Default=100, Type: `int`
Maximum number of iterations.

`snr_threshold`: Default=5, Type: `float`
Signal-to-Noise Ratio threshold.

`flag_harmonics`: Default=True, Type: `bool`
Flag harmonics of the fitted frequencies.

`harmonic_tolerance`: Default=0.001, Type: `float`
Tolerance for flagging harmonics.

`frequency_resolution`: Default=4/27, Type: `float`
Frequency resolution of the amplitude spectrum.

`fbounds`: Default=None, Type: `tuple` or `list`
Frequency bounds for the amplitude spectrum.

`nyq_mult`: Default=1, Type: `int`
Multiplier for the Nyquist frequency.

`oversample_factor`: Default=5, Type: `int`
Oversampling factor for the amplitude spectrum.

`mode`: Default='amplitude', Type: `str`
Mode of the spectrum. Can be 'amplitude' or 'power'.

## Available methods
```python
pw.auto(make_plot=True, save=True) ## Automatically pre-whiten the light curve
pw.interate() ## Iteratively pre-whiten the light curve once a PreWhitening object has been created
pw.post_pw(make_plot=True, save=True) ## Post-processing of the pre-whitened light curve
pw.post_pw_plot() ## Plot the pre-whitened light curve and the identified peaks in the amplitude spectrum
pw.amplitude_power_spectrum() ## Get the amplitude/power spectrum
pw.get_lightcurve() ## Get the pre-whitened light curve
```

0 comments on commit 0da6d9d

Please sign in to comment.