SvoFpsClass

class astroquery.svo_fps.SvoFpsClass

Bases: BaseQuery

Class for querying the Spanish Virtual Observatory filter profile service

Attributes Summary

SVO_MAIN_URL
TIMEOUT

Methods Summary

data_from_svo(*[, wavelength_ref_min, ...])	Get data in response to the query send to SVO FPS.
get_filter_index(wavelength_eff_min, ...)	Get master list (index) of all filters at SVO Optional parameters can be given to get filters data for specified Wavelength Effective range from SVO
get_filter_list(facility, *[, instrument])	Get filters data for requested facilty and instrument from SVO
get_filter_metadata(filter_id, *[, cache, ...])	Get metadata/parameters for the requested Filter ID from SVO
get_transmission_data(filter_id, **kwargs)	Get transmission data for the requested Filter ID from SVO
get_zeropoint(filter_id, *[, mag_system])	Get the zero point for a specififed filter in a specified system.

Attributes Documentation

SVO_MAIN_URL = 'https://svo2.cab.inta-csic.es/theory/fps/fps.php'

TIMEOUT = 60

Methods Documentation

data_from_svo(*, wavelength_ref_min=None, wavelength_ref_max=None, wavelength_mean_min=None, wavelength_mean_max=None, wavelength_eff_min=None, wavelength_eff_max=None, wavelength_min_min=None, wavelength_min_max=None, wavelength_max_min=None, wavelength_max_max=None, width_eff_min=None, width_eff_max=None, fwhm_min=None, fwhm_max=None, instrument=None, facility=None, phot_system=None, id=None, phot_cal_id=None, format=None, verb=2, cache=True, timeout=None, error_msg='No data found for requested query')

Get data in response to the query send to SVO FPS. This method is not generally intended for users, but it can be helpful if you want something very specific from the SVO FPS service. If you don’t know what you’re doing, try get_filter_index, get_filter_list, and get_transmission_data instead.

Description of search parameters can be found at https://svo2.cab.inta-csic.es/theory/fps/index.php?mode=voservice

Parameters:

wavelength_ref_minfloat, optional

Min value for WavelengthRef parameter

wavelength_ref_maxfloat, optional

Max value for WavelengthRef parameter

wavelength_mean_minfloat, optional

Min value for WavelengthMean parameter

wavelength_mean_maxfloat, optional

Max value for WavelengthMean parameter

wavelength_eff_minfloat, optional

Min value for WavelengthEff parameter

wavelength_eff_maxfloat, optional

Max value for WavelengthEff parameter

wavelength_min_minfloat, optional

Min value for WavelengthMin parameter

wavelength_min_maxfloat, optional

Max value for WavelengthMin parameter

wavelength_max_minfloat, optional

Min value for WavelengthMax parameter

wavelength_max_maxfloat, optional

Max value for WavelengthMax parameter

width_eff_minfloat, optional

Min value for WidthEff parameter

width_eff_maxfloat, optional

Max value for WidthEff parameter

fwhm_minfloat, optional

Min value for FWHM parameter

fwhm_maxfloat, optional

Max value for FWHM parameter

instrumentstr, optional

Instrument for filters (default is None). Leave empty if there are no instruments for specified facility

facilitystr, optional

Facility for filters (default is None)

phot_systemstr, optional

Photometric system for filters (default is None)

idstr, optional

Filter ID (default is None)

phot_cal_idstr, optional

Photometric calibration ID (default is None)

formatstr, optional

Format of the output. Default includes all data, metadata includes only metadata.

verb0, 1, or 2

0: The resulting VOTable won’t include the transmission curve or PARAM descriptions. 1: The resulting VOTable won’t include the transmission curve but it will include PARAM descriptions. 2: The resulting VOTable will include the transmission curve and PARAM descriptions.

error_msgstr, optional

Error message to be shown in case no table element found in the responded VOTable. Use this to make error message verbose in context of the query made (default is ‘No data found for requested query’)

cachebool

Defaults to True. If set overrides global caching behavior. See caching documentation.

Returns:

astropy.table.table.Table object

Table containing data fetched from SVO (in response to query)

get_filter_index(wavelength_eff_min, wavelength_eff_max, **kwargs)

Get master list (index) of all filters at SVO Optional parameters can be given to get filters data for specified Wavelength Effective range from SVO

Parameters:

wavelength_eff_minQuantity with units of length

Minimum value of Wavelength Effective

wavelength_eff_maxQuantity with units of length

Maximum value of Wavelength Effective

kwargsdict

Passed to data_from_svo. Relevant arguments include cache

Returns:

astropy.table.table.Table object

Table containing data fetched from SVO (in response to query)

get_filter_list(facility, *, instrument=None, **kwargs)

Get filters data for requested facilty and instrument from SVO

Parameters:

facilitystr

Facilty for filters

instrumentstr, optional

Instrument for filters (default is None). Leave empty if there are no instruments for specified facilty

kwargsdict

Passed to data_from_svo. Relevant arguments include cache

Returns:

astropy.table.table.Table object

Table containing data fetched from SVO (in response to query)

get_filter_metadata(filter_id, *, cache=True, timeout=None, **kwargs)

Get metadata/parameters for the requested Filter ID from SVO

Parameters:

filter_idstr

Filter ID in the format SVO specifies it: ‘facilty/instrument.filter’. This is returned by get_filter_list and get_filter_index as the filterID column.

cachebool

Defaults to True. If set overrides global caching behavior. See caching documentation.

timeoutint

Timeout in seconds. If not specified, defaults to conf.timeout.

kwargsdict

Appended to the query dictionary sent to SVO. See the API documentation of data_from_svo for the valid parameter names.

Returns:

paramsdict

Dictionary of VOTable PARAM names and values.

get_transmission_data(filter_id, **kwargs)

Get transmission data for the requested Filter ID from SVO

Parameters:

filter_idstr

Filter ID in the format SVO specifies it: ‘facilty/instrument.filter’. This is returned by get_filter_list and get_filter_index as the filterID column.

kwargsdict

Passed to data_from_svo. Relevant arguments include cache

Returns:

astropy.table.table.Table object

Table containing data fetched from SVO (in response to query)

get_zeropoint(filter_id, *, mag_system='Vega', **kwargs)

Get the zero point for a specififed filter in a specified system.

This is a highly-specific downselection of the metadata returned by get_filter_metadata; the full metadata includes the zero point with Vega as the default system.

Parameters:

filter_idstr

Filter ID in the format SVO specifies it: ‘facilty/instrument.filter’. This is returned by get_filter_list and get_filter_index as the filterID column.

mag_system‘Vega’ (default), ‘AB’, or ‘ST’

The magnitude system for which to return the zero point.

kwargsdict

Appended to the query dictionary sent to SVO. See the API documentation of data_from_svo for the valid parameter names.

Examples

>>> from astroquery.svo_fps import SvoFps
>>> SvoFps.get_zeropoint(filter_id='2MASS/2MASS.J', mag_system='AB')
{'MagSys': 'AB',
 'ZeroPoint': <Quantity 3631. Jy>,
 'ZeroPointUnit': 'Jy',
 'ZeroPointType': 'Pogson'}