QueryResponse

class sunpy.net.vso.QueryResponse(lst, queryresult=None)[source]

Bases: sunpy.net.base_client.BaseQueryResponse

A container for VSO Records returned from VSO Searches.

Attributes Summary

blocks

A collections.abc.Sequence object which contains the records contained within the Query Response.

client

An instance of BaseClient used to generate the results.

Methods Summary

add_error(exception)

build_table()

Create a human readable table.

create(queryresult)

response_block_properties()

Returns a set of class attributes on all the response blocks.

search(*query)

Furtherly reduce the query response by matching it against another query, e.g.

time_range()

Return total time-range all records span across.

total_size()

Total size of data in KB.

Attributes Documentation

blocks

A collections.abc.Sequence object which contains the records contained within the Query Response.

client

An instance of BaseClient used to generate the results.

Generally this is used to fetch the results later.

Note

In general, this doesn’t have to be the same instance of BaseClient, this is left to the client developer. If there is a significant connection overhead in creating an instance of a client you might want it to be the same instance as used for the search.

Methods Documentation

add_error(exception)[source]
build_table()[source]

Create a human readable table.

Returns

table (astropy.table.QTable)

classmethod create(queryresult)[source]
response_block_properties()[source]

Returns a set of class attributes on all the response blocks.

Returns

s (set) – List of strings, containing attribute names in the response blocks.

search(*query)[source]

Furtherly reduce the query response by matching it against another query, e.g. response.search(attrs.Instrument(‘aia’)).

time_range()[source]

Return total time-range all records span across.

total_size()[source]

Total size of data in KB. May be less than the actual size because of inaccurate data providers.