Catalogs

Catalogs plugin, just after name and image search Catalogs plugin, just after draw outline and catalog search

A plugin for plotting object locations from a catalog on an image.

Plugin Type: Local

Catalogs is a local plugin, which means it is associated with a channel. An instance can be opened for each channel.

Note

To use Catalogs, it is necessary to install the astroquery package.

Warning

Configuration of Catalogs via ginga_config.py technique in Ginga 3.2 or later is not officially supported and may not work as in previous releases. See the new user configuration instructions below.

Usage

Fetching an image

  • By name resolver: Using the Name Server box, choose a server and type a name into the “Name” field. Press “Search name”. If the name is resolved, the “ra” and “dec” fields in the Image Server box will be populated. Select a server, adjust width and/or height, and press “Get Image”.

  • By existing image in the channel: Draw a shape on the displayed image (“rectangle” or “circle” can be chosen at the bottom of the plugin GUI) and adjust search parameters as desired. When you are ready, press “Get Image” to perform the search.

Note

It can take some time for the image download to finish, depending on the size of the field, network conditions, etc. Normally, if the search or download fails then an error will be popped up in the Errors plugin.

If the image is downloaded successfully it should appear in the channel viewer.

Fetching and plotting objects from catalogs

To plot objects, the Catalogs plugin needs an image with a valid WCS loaded into the channel. You can either load your own image or fetch one from an image server as described in “Fetching an image” above.

Choosing a center:

  • By name resolver: Using the Name Server box, choose a server and type a name into the “Name” field. Press “Search name”. If the name is resolved, the “ra” and “dec” fields in the Catalog Server box will be populated. Select a server, adjust width and/or height, and press “Search catalog”.

  • By existing image in the channel: Draw a shape on the displayed image (“rectangle” or “circle” can be chosen at the bottom of the plugin GUI) and adjust search parameters as desired. When you are ready, press “Search catalog” to perform the search.

Note

It can take some time for the search result to finish, depending on the size of the field, network conditions, etc. Normally, if the search fails then an error will be popped up in the Errors plugin.

When search results are available, they will be displayed on the image and also listed in a table on the plugin GUI. You can click on either the table or the image to highlight selection.

User Configuration

It is customizable using ~/.ginga/plugin_Catalogs.cfg, where ~ is your HOME directory:

#
# Catalogs plugin preferences file
#
# Place this in file under ~/.ginga with the name "plugin_Catalogs.cfg"

draw_type = 'circle'

select_color = 'skyblue'

color_outline = 'aquamarine'

click_radius = 10


# NAME SOURCES
# Name resolvers for astronomical object names
#
# Format: list of dicts
# Each dict defines a source, and has the following fields:
#   shortname: str
#       the short name appearing in the control for selecting a source
#       in the plugin
#
#   fullname: str
#       the full name, should correspond *exactly* with the name required
#       by astroquery.vo_conesearch "catalog" parameter
#
#   type: str
#       should be "astroquery.names" for an astroquery.names function
#
name_sources = [
{'shortname': "SIMBAD", 'fullname': "SIMBAD",
'type': 'astroquery.names'},
{'shortname': "NED", 'fullname': "NED",
'type': 'astroquery.names'},
]


# CATALOG SOURCES
#
# Format: list of dicts
# Each dict defines a source, and has the following fields:
#   shortname: str
#       the short name appearing in the control for selecting a source
#       in the plugin
#
#   fullname: str
#       the full name, should correspond *exactly* with the name required
#       by astroquery.vo_conesearch "catalog" parameter
#
#   type: str
#       should be "astroquery.vo_conesearch" for an astroquery.vo_conesearch
#       function
#
#   mapping: dict
#       a nested dict providing the mapping for the return results to the GUI,
#       in terms of field name to Ginga table.
#       There must be keys for 'id', 'ra' and 'dec'. 'mag', if present, can be
#       a list of field names that define magnitudes of the elements in various
#       wavelengths.
#
catalog_sources = [
{'shortname': "GSC 2.3",
'fullname': "Guide Star Catalog 2.3 Cone Search 1",
'type': 'astroquery.vo_conesearch',
'mapping': {'id': 'objID', 'ra': 'ra', 'dec': 'dec', 'mag': ['Mag']}},
{'shortname': "USNO-A2.0 1",
'fullname': "The USNO-A2.0 Catalogue (Monet+ 1998) 1",
'type': 'astroquery.vo_conesearch',
'mapping': {'id': 'USNO-A2.0', 'ra': 'RAJ2000', 'dec': 'DEJ2000',
'mag': ['Bmag', 'Rmag']}},
{'shortname': "2MASS 1",
'fullname': "Two Micron All Sky Survey (2MASS) 1",
'type': 'astroquery.vo_conesearch',
'mapping': {'id': 'htmID', 'ra': 'ra', 'dec': 'dec',
'mag': ['h_m', 'j_m', 'k_m']}},
]


# IMAGE SOURCES
#
# Format: list of dicts
# Each dict defines a source, and has the following fields:
#   shortname: str
#       the string that should correspond *exactly* with the name required
#       by astroquery.skyview "survey" parameter for get_image_list()
#
#   fullname: str
#       the full name, mostly descriptive
#
#   type: str
#       should be "astroquery.image"
#
#   source: str
#       should be "skyview"
#
#
image_sources = [
{'shortname': "DSS",
'fullname': "Digital Sky Survey 1",
'type': 'astroquery.image',
'source': 'skyview'},
{'shortname': "DSS1 Blue",
'fullname': "Digital Sky Survey 1 Blue",
'type': 'astroquery.image',
'source': 'skyview'},
{'shortname': "DSS1 Red",
'fullname': "Digital Sky Survey 1 Red",
'type': 'astroquery.image',
'source': 'skyview'},
{'shortname': "DSS2 Red",
'fullname': "Digital Sky Survey 2 Red",
'type': 'astroquery.image',
'source': 'skyview'},
{'shortname': "DSS2 Blue",
'fullname': "Digital Sky Survey 2 Blue",
'type': 'astroquery.image',
'source': 'skyview'},
{'shortname': "DSS2 IR",
'fullname': "Digital Sky Survey 2 Infrared",
'type': 'astroquery.image',
'source': 'skyview'},
]