montage_wrapper.commands_extra.mCoverageCheck(in_table, out_table, mode, polygon=None, ra=None, dec=None, width=None, height=None, rotation=None, radius=None, header=None, status_file=None)[source]

mCoverageCheck can be used to subset an image metadata table (containing FITS/WCS information or image corners) by determining which records in the table represent images that overlap with a region definition (box or circle in the sky) given on the command line.

Parameters :

in_table : str

Input metadata table.

out_table : str

Output metadata table, to contain subset of in_table.

mode : str

How to check for coverage:

  • ‘points’: use a polygon with points specified by polygon=
  • ‘box’: use a rectangular box with center given by ra= and dec=, and the width given by width=. Optionally, the height and rotation can be given by height= and rotation=
  • ‘circle’: use a circle with center given by ra= and dec= and radius given by radius=
  • ‘point’: use a point given by ra= and dec=
  • ‘header’: use a header file given by header=

polygon : list

A polygon which should be given as [(ra1, dec1), (ra2, dec2), ..., (raN, decN)].

ra : float, optional

The right ascension of the box, circle, or point

dec : float, optional

The declination of the box, circle, or point

width : float, optional

The width of the box

height : float, optional

The height of the box

rotation : float, optional

The rotation of the box

radius : float, optional

The radius of the circle

header : str, optional

A header file

status_file : str, optional

Output and errors are sent to status_file instead of to stdout

Page Contents