UnifiedResponse

class sunpy.net.fido_factory.UnifiedResponse(*results)[source]

Bases: collections.abc.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.

Attributes Summary

all_colnames

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

file_num

The number of records returned in all responses.

responses

Deprecated since version 2.1.

tables

Deprecated since version 2.1.

Methods Summary

get_response(i)

Deprecated since version 2.1.

keys()

Names of the contained responses.

path_format_keys()

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

response_block_properties()

Deprecated since version 2.1.

show(*cols)

Displays response tables with desired columns for the Query.

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().

file_num

The number of records returned in all responses.

responses

Deprecated since version 2.1: The same behaviour can be obtained by iterating over the object directly

A generator of all the sunpy.net.dataretriever.client.QueryResponse objects contained in the UnifiedResponse object.

tables

Deprecated since version 2.1: All objects contained in the sequence are now Table objects

Returns a list of astropy.table.Table for all responses present in a specific UnifiedResponse object. They can then be used to perform key-based indexing of objects of either type sunpy.net.dataretriever.client.QueryResponse, sunpy.net.vso.QueryResponse or sunpy.net.jsoc.JSOCClient

Returns

list – A list of astropy.table.Table, consisting of data either from the sunpy.net.dataretriever.client.QueryResponse, sunpy.net.vso.QueryResponse or sunpy.net.jsoc.JSOCClient.

Methods Documentation

get_response(i)[source]

Deprecated since version 2.1: The same behaviour can now be obtained by indexing the object directly

Get the actual response rather than another UnifiedResponse object.

keys()[source]

Names of the contained responses.

One name may map to more than one response.

path_format_keys()[source]

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.

response_block_properties()[source]

Deprecated since version 2.1: The response_block_properties function is deprecated and may be removed in version 3.1. Use path_format_keys instead.

show(*cols)[source]

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.