UnifiedResponse

class sunpy.net.fido_factory.UnifiedResponse(*results)

Bases: Sequence

The object used to store results from search.

The Fido object returns results from multiple different clients. So it is always possible to sub-select these results, you can index this object with two indices. The first index is the client index, i.e. corresponding to the results from the VSOClient. The second index can be used to select records from the results returned from that client, for instance if you only want every second result you could index the second dimension with ::2.

Parameters:

*results (sunpy.net.base_client.QueryResponseTable) – One or more QueryResponseTable objects.

Attributes Summary

all_colnames	Returns all the colnames in any of the tables in this response.
errors	Returns a list of errors for each client.
file_num	The number of records returned in all responses.

Methods Summary

keys()	Names of the contained responses.
path_format_keys()	Returns all the names that can be used to format filenames.
show(*cols)	Displays response tables with desired columns for the Query.
show_in_notebook(*cols, **kwargs)	Display the attrs tables as interactive grids in a Jupyter Notebook.

Attributes Documentation

all_colnames

Returns all the colnames in any of the tables in this response.

Any column names in this list are valid inputs to UnifiedResponse.show().

errors

Returns a list of errors for each client.

file_num

The number of records returned in all responses.

Methods Documentation

keys()

Names of the contained responses.

One name may map to more than one response.

path_format_keys()

Returns all the names that can be used to format filenames.

Only the keys which can be used to format all results from all responses contained in this UnifiedResponse are returned. Each individual response might have more keys available.

Each one corresponds to a single column in the table, and the format syntax should match the dtype of that column, i.e. for a Time object or a Quantity.

show(*cols)

Displays response tables with desired columns for the Query.

Parameters:

*cols (tuple) – Name of columns to be shown.

Returns:

list of astropy.table.Table – A list of tables showing values for specified columns.

show_in_notebook(*cols, **kwargs)

Display the attrs tables as interactive grids in a Jupyter Notebook.

This function utilizes the itables library to render tables as interactive grids.

Note

This function requires the optional dependency itables. Ensure it is installed before calling this method.

Parameters:

**kwargs (dict, optional) – Additional keyword arguments to customize the itables.show function.