SIARecord

class pyvo.dal.SIARecord(results, index, session=None)[source]

Bases: pyvo.dal.adhoc.SodaRecordMixin, pyvo.dal.adhoc.DatalinkRecordMixin, pyvo.dal.Record

a dictionary-like container for data in a record from the results of an image (SIA) search, describing an available image.

The commonly accessed metadata which are stadardized by the SIA protocol are available as attributes. If the metadatum accessible via an attribute is not available, the value of that attribute will be None. All metadata, including non-standard metadata, are acessible via the get( key ) function (or the [key] operator) where key is table column name.

Attributes Summary

acref the URL that can be used to retrieve the image
acref_ttl the minimum time to live in seconds of the access reference
bandpass_hilimit the upper limit of the bandpass as astropy Quantity in bandpass_unit
bandpass_id the bandpass by name (e.g., “V”, “SDSS_U”, “K”, “K-Band”, etc.)
bandpass_lolimit the lower limit of the bandpass as astropy Quantity in bandpass_unit
bandpass_refvalue the characteristic (reference) wavelength, frequency or energy for the bandpass model, as an astropy Quantity of bandpass_unit
bandpass_unit the astropy unit used to represent spectral values.
cdmatrix the WCS CD matrix defining the scale and rotation (among other things) of the image.
coord_equinox the equinox of the used coordinate system
coord_frame the coordinate system reference frame, one of the following: “ICRS”, “FK5”, “FK4”, “ECL”, “GAL”, and “SGAL”.
coord_projection the celestial projection (TAN / ARC / SIN / etc.)
coord_refpixel the image pixel coordinates of the WCS reference pixel
coord_refvalue the world coordinates of the WCS reference pixel.
dateobs the modified Julien date (MJD) of the mid-point of the observational data that went into the image, as an astropy.time.Time instance
filesize the (estimated) size of the image in bytes
format the format of the image
instr the name of the instrument (or instruments) that produced the data that went into this image.
naxes the number of axes in this image.
naxis the lengths of the sides along each axis, in pix, as a astropy Quantity pix
pixflags the type of processing done by the image service to produce an output image pixel
pos the position of the object or observation described by this record.
scale the scale of the pixels in each image axis, in degrees/pixel, as a astropy Quantity deg / pix
title the title of the image

Methods Summary

broadcast_samp(self[, client_name]) Broadcast the image to client_name via SAMP
getdataformat(self) return the mimetype of the dataset described by this record.
getdataurl(self) return the URL contained in the access URL column which can be used to retrieve the dataset described by this record.
suggest_dataset_basename(self) return a default base filename that the dataset available via getdataset() can be saved as.
suggest_extension(self[, default]) returns a recommended filename extension for the dataset described by this record.

Attributes Documentation

acref

the URL that can be used to retrieve the image

acref_ttl

the minimum time to live in seconds of the access reference

bandpass_hilimit

the upper limit of the bandpass as astropy Quantity in bandpass_unit

bandpass_id

the bandpass by name (e.g., “V”, “SDSS_U”, “K”, “K-Band”, etc.)

bandpass_lolimit

the lower limit of the bandpass as astropy Quantity in bandpass_unit

bandpass_refvalue

the characteristic (reference) wavelength, frequency or energy for the bandpass model, as an astropy Quantity of bandpass_unit

bandpass_unit

the astropy unit used to represent spectral values.

cdmatrix

the WCS CD matrix defining the scale and rotation (among other things) of the image. ordered as CD[i,j] = [0,0], [0,1], [1,0], [1,1].

coord_equinox

the equinox of the used coordinate system

coord_frame

the coordinate system reference frame, one of the following: “ICRS”, “FK5”, “FK4”, “ECL”, “GAL”, and “SGAL”.

coord_projection

the celestial projection (TAN / ARC / SIN / etc.)

coord_refpixel

the image pixel coordinates of the WCS reference pixel

coord_refvalue

the world coordinates of the WCS reference pixel.

dateobs

the modified Julien date (MJD) of the mid-point of the observational data that went into the image, as an astropy.time.Time instance

filesize

the (estimated) size of the image in bytes

format

the format of the image

instr

the name of the instrument (or instruments) that produced the data that went into this image.

naxes

the number of axes in this image.

naxis

the lengths of the sides along each axis, in pix, as a astropy Quantity pix

pixflags

the type of processing done by the image service to produce an output image pixel

a string of one or more of the following values:

  • C – The image pixels were copied from a source image without change,
    as when an atlas image or cutout is returned.
  • F – The image pixels were computed by resampling an existing image,
    e.g., to rescale or reproject the data, and were filtered by an interpolator.
  • X – The image pixels were computed by the service directly from a
    primary data set hence were not filtered by an interpolator.
  • Z – The image pixels contain valid flux (intensity) values, e.g., if
    the pixels were resampled with a flux-preserving interpolator.
  • V – The image pixels contain some unspecified visualization of the
    data, hence are suitable for display but not for numerical analysis.
pos

the position of the object or observation described by this record.

scale

the scale of the pixels in each image axis, in degrees/pixel, as a astropy Quantity deg / pix

title

the title of the image

Methods Documentation

broadcast_samp(self, client_name=None)[source]

Broadcast the image to client_name via SAMP

getdataformat(self)[source]

return the mimetype of the dataset described by this record.

getdataurl(self)[source]

return the URL contained in the access URL column which can be used to retrieve the dataset described by this record. None is returned if no such column exists.

suggest_dataset_basename(self)[source]

return a default base filename that the dataset available via getdataset() can be saved as. This function is specialized for a particular service type this record originates from so that it can be used by cachedataset() via make_dataset_filename().

suggest_extension(self, default=None)[source]

returns a recommended filename extension for the dataset described by this record. Typically, this would look at the column describing the format and choose an extension accordingly.