Ctrl+K
SunPy

SUVIClient#

class sunpy.net.dataretriever.SUVIClient[source]#

Bases: GenericClient

Provides access to data from the GOES Solar Ultraviolet Imager (SUVI).

SUVI data are provided by NOAA.

The SUVI instrument was first included on GOES-16. It produces level 1b as well as level-2 data products. Level 2 data products are a weighted average of level 1b product files and therefore provide higher imaging dynamic range than individual images. The exposure time of level 1b images range from 1 s to 0.005 s.

SUVI supports the following wavelengths; 94, 131, 171, 195, 284, 304 angstrom. If no wavelength is specified, images from all wavelengths are returned.

Examples

>>> from sunpy.net import Fido, attrs as a
>>> import astropy.units as u
>>> results = Fido.search(a.Time("2020/7/10", "2020/7/10 00:10"), a.Instrument('suvi'),a.Level.two,
...                       a.goes.SatelliteNumber(16), a.Wavelength(304*u.Angstrom))  
>>> results  
<sunpy.net.fido_factory.UnifiedResponse object at ...>
Results from 1 Provider:

3 Results from the SUVIClient:
Source: https://data.ngdc.noaa.gov/platforms/solar-space-observing-satellites/goes

       Start Time               End Time        Instrument ... Level Wavelength
                                                           ...        Angstrom
----------------------- ----------------------- ---------- ... ----- ----------
2020-07-10 00:00:00.000 2020-07-10 00:04:00.000       SUVI ...     2      304.0
2020-07-10 00:04:00.000 2020-07-10 00:08:00.000       SUVI ...     2      304.0
2020-07-10 00:08:00.000 2020-07-10 00:12:00.000       SUVI ...     2      304.0

Attributes Summary

baseurl1b

baseurl2

info_url

This should return a string that is a URL to the data server or documentation on the data being served.

pattern1b

pattern2

Methods Summary

post_search_hook(i, matchdict)

Helper function used after search() which makes the extracted metadata representable in a query response table.

register_values()

This enables the client to register what kind of Attrs it can use directly.

search(*args, **kwargs)

Query this client for a list of results.

Attributes Documentation

baseurl1b = 'https://data.ngdc.noaa.gov/platforms/solar-space-observing-satellites/goes/goes{SatelliteNumber}/l1b/suvi-l1b-{elem:2}{wave:03}/%Y/%m/%d/OR_SUVI-L1b.*\\.fits.gz'#
baseurl2 = 'https://data.ngdc.noaa.gov/platforms/solar-space-observing-satellites/goes/goes{SatelliteNumber}/l2/data/suvi-l2-ci{wave:03}/%Y/%m/%d/dr_suvi-l2-ci{wave:03}_g{SatelliteNumber}_s%Y%m%dT%H%M%SZ_.*\\.fits'#
info_url#
pattern1b = '{}/goes/goes{SatelliteNumber:2d}/l{Level:2w}/suvi-l1b-{}{Wavelength:03d}/{year:4d}/{month:2d}/{day:2d}/{}_s{:7d}{hour:2d}{minute:2d}{second:2d}{:1d}_e{:7d}{ehour:2d}{eminute:2d}{esecond:2d}{:1d}_{}'#
pattern2 = '{}/goes/goes{SatelliteNumber:2d}/{}/dr_suvi-l{Level}-ci{Wavelength:03d}_g{SatelliteNumber:2d}_s{year:4d}{month:2d}{day:2d}T{hour:2d}{minute:2d}{second:2d}Z_e{eyear:4d}{emonth:2d}{eday:2d}T{ehour:2d}{eminute:2d}{esecond:2d}Z_{}'#

Methods Documentation

post_search_hook(i, matchdict)[source]#

Helper function used after search() which makes the extracted metadata representable in a query response table.

Parameters:

  • exdict (dict) – Represents metadata extracted from files.

  • matchdict (dict) – Contains attr values accessed from register_values() and the search query itself.

Returns:

rowdict (OrderedDict) – An Ordered Dictionary which is used by QueryResponse to show results.

classmethod register_values()[source]#

This enables the client to register what kind of Attrs it can use directly.

Returns:

dict – A dictionary with key values of Attrs and the values are a tuple of (“Attr Type”, “Name”, “Description”).

search(*args, **kwargs)[source]#

Query this client for a list of results.

Parameters:

  • *args (tuple) – sunpy.net.attrs objects representing the query.

  • **kwargs (dict) – Any extra keywords to refine the search.

Returns:

A QueryResponse instance containing the query result.

On this page