Skip to content

Updates SOLO RPW examples #173

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Hermanlrx wants to merge 1 commit into
base: main
Choose a base branch
from
+35 −4
Open

Updates SOLO RPW examples #173

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog/173.doc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Created docstring examples for ``RPWSpectrogram`` data.
38 changes: 34 additions & 4 deletions radiospectra/spectrogram/sources/rpw.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,14 @@

class RPWSpectrogram(GenericSpectrogram):
"""
Solar Orbiter Radio and Plasma Waves (RPW) RPW-HFR-SURV spectrogram.
Solar Orbiter Radio and Plasma Waves (RPW) spectrogram.

For more information on the instrument see `<https://rpw.lesia.obspm.fr>`__.
For more information on the instrument see `<https://rpw-datacenter.obspm.fr>`__.

Examples for accessing Level 2 HFR and Level 3 TNR/HFR (calibrated) data products.

**HFR Level 2 Example:**

Examples
--------
>>> import sunpy_soar
>>> from sunpy.net import Fido, attrs as a
>>> from radiospectra.spectrogram import Spectrogram
Expand All @@ -22,6 +24,34 @@ class RPWSpectrogram(GenericSpectrogram):
[<RPWSpectrogram SOLO, RPW, RPW-AGC1 375.0 kHz - 16375.0 kHz, 2020-07-11T00:00:39.352 to 2020-07-12T00:00:55.715>, <RPWSpectrogram SOLO, RPW, RPW-AGC2 375.0 kHz - 16375.0 kHz, 2020-07-11T00:00:39.352 to 2020-07-12T00:00:55.715>]
>>> spec[0] .plot() #doctest: +SKIP
<matplotlib.collections.QuadMesh object at ...>

**TNR Level 3 Example:**

>>> import sunpy_soar #doctest: +REMOTE_DATA
>>> from sunpy.net import Fido, attrs as a #doctest: +REMOTE_DATA
>>> from radiospectra.spectrogram import Spectrogram #doctest: +REMOTE_DATA
>>> query = Fido.search(a.Time('2024/03/23 00:00', '2024/03/23 23:59'), #doctest: +REMOTE_DATA
... a.Instrument.rpw, a.Level(3), a.Provider.soar) #doctest: +REMOTE_DATA
>>> downloaded = Fido.fetch(query[0][query[0]["Data product"]=='rpw-tnr-surv-flux'][0]) #doctest: +REMOTE_DATA
>>> spec = Spectrogram(downloaded[0]) #doctest: +REMOTE_DATA
>>> spec #doctest: +REMOTE_DATA
<RPWSpectrogram SOLO, RPW, RPW-TNR 3.992000102996826 kHz - 978.572021484375 kHz, 2024-03-23T00:04:32.873 to 2024-03-24T00:04:46.381>
>>> spec.plot() #doctest: +REMOTE_DATA
<matplotlib.collections.QuadMesh object at ...>

**HFR Level 3 Example:**

>>> import sunpy_soar #doctest: +REMOTE_DATA
>>> from sunpy.net import Fido, attrs as a #doctest: +REMOTE_DATA
>>> from radiospectra.spectrogram import Spectrogram #doctest: +REMOTE_DATA
>>> query = Fido.search(a.Time('2024/03/23 00:00', '2024/03/23 23:59'), #doctest: +REMOTE_DATA
... a.Instrument.rpw, a.Level(3), a.Provider.soar) #doctest: +REMOTE_DATA
>>> downloaded = Fido.fetch(query[0][query[0]["Data product"]=='rpw-hfr-surv-flux'][0]) #doctest: +REMOTE_DATA
>>> spec = Spectrogram(downloaded[0]) #doctest: +REMOTE_DATA
>>> spec #doctest: +REMOTE_DATA
<RPWSpectrogram SOLO, RPW, RPW-HFR 425.0000305175781 kHz - 16325.0009765625 kHz, 2024-03-23T00:04:14.063 to 2024-03-24T00:04:07.571>
>>> spec.plot() #doctest: +REMOTE_DATA
<matplotlib.collections.QuadMesh object at ...>
"""

@classmethod
Expand Down
Loading