create_astrometric_catalog¶
- jwst.tweakreg.astrometric_utils.create_astrometric_catalog(input_models, catalog='GAIADR3', output='ref_cat.ecsv', gaia_only=False, table_format='ascii.ecsv', existing_wcs=None, num_sources=None, epoch=None)[source]¶
Create an astrometric catalog that covers the inputs’ field-of-view.
- Parameters:
input_models (list of
JwstDataModel
) – Each datamodel must have a ~gwcs.WCS object.catalog (str, optional) – Name of catalog to extract astrometric positions for sources in the input images’ field-of-view. Default: GAIADR3. Options available are documented on the catalog web page.
output (str, optional) – Filename to give to the astrometric catalog read in from the master catalog web service. If None, no file will be written out.
gaia_only (bool, optional) – Specify whether or not to only use sources from GAIA in output catalog
existing_wcs (model) – existing WCS object specified by the user as generated by
resample.resample_utils.make_output_wcs
num_sources (int) – Maximum number of brightest/faintest sources to return in catalog. If
num_sources
is negative, return that number of the faintest sources. By default, all sources are returned.epoch (float, optional) – Reference epoch used to update the coordinates for proper motion (in decimal year). If
None
then the epoch is obtained from the metadata.
Notes
This function will point to astrometric catalog web service defined through the use of the ASTROMETRIC_CATALOG_URL environment variable.
- Returns:
ref_table – Astropy Table object of the catalog
- Return type:
Table