RegistryResource

class pyvo.registry.regtap.RegistryResource(results, index, session=None)[source]

Bases: pyvo.dal.Record

a dictionary for the resource metadata returned in one record of a registry query.

A SimpleResource acts as a dictionary, so in general, all attributes can be accessed by name via the [] operator, and the attribute names can by returned via the keys() function. For convenience, it also stores key values as properties; these include:

Attributes Summary

access_url the URL that can be used to access the service resource.
content_levels a list of content level labels that describe the intended audience for this resource.
content_types list of natures or genres of the content of the resource.
creators The creator(s) of the resource in the ordergiven by the resource record author
ivoid the IVOA identifier for the resource.
reference_url URL pointing to a human-readable document describing this resource.
region_of_regard numeric value representing the angle, given in decimal degrees, by which a positional query against this resource should be “blurred” in order to get an appropriate match.
res_description the textual description of the resource.
res_title the title of the resource
res_type the resource types that characterize this resource.
service return an appropriate DALService subclass for this resource that can be used to search the resource.
short_name the short name for the resource
source_format The format of source_value.
standard_id the IVOA standard identifier
waveband a list of names of the wavebands that the resource provides data for

Methods Summary

describe(self[, verbose, width, file]) Print a summary description of this resource.
search(self, *args, **keys) assuming this resource refers to a searchable service, execute a search against the resource.

Attributes Documentation

access_url

the URL that can be used to access the service resource.

content_levels

a list of content level labels that describe the intended audience for this resource.

content_types

list of natures or genres of the content of the resource.

creators

The creator(s) of the resource in the ordergiven by the resource record author

ivoid

the IVOA identifier for the resource.

reference_url

URL pointing to a human-readable document describing this resource.

region_of_regard

numeric value representing the angle, given in decimal degrees, by which a positional query against this resource should be “blurred” in order to get an appropriate match.

res_description

the textual description of the resource.

See also

SimpleResource.describe
res_title

the title of the resource

res_type

the resource types that characterize this resource.

service

return an appropriate DALService subclass for this resource that can be used to search the resource. Return None if the resource is not a recognized DAL service. Currently, only Conesearch, SIA, SSA, and SLA services are supported.

short_name

the short name for the resource

source_format

The format of source_value.

standard_id

the IVOA standard identifier

waveband

a list of names of the wavebands that the resource provides data for

Methods Documentation

describe(self, verbose=False, width=78, file=None)[source]

Print a summary description of this resource.

Parameters:
verbose : bool

If false (default), only user-oriented information is printed; if true, additional information will be printed as well.

width : int

Format the description with given character-width.

out : writable file-like object

If provided, write information to this output stream. Otherwise, it is written to standard out.

search(self, *args, **keys)[source]

assuming this resource refers to a searchable service, execute a search against the resource. This is equivalent to:

self.to_service().search(*args, **keys)

The arguments provided should be appropriate for the service that the DAL service type would expect. See the documentation for the appropriate service type:

Service type Use the argument syntax for
catalog pyvo.dal.SCSService.search
image pyvo.dal.SIAService.search
spectrum pyvo.dal.SSAService.search
line pyvo.dal.SLAService.search
database not yet supported
Raises:
RuntimeError

if the resource does not describe a searchable service.