WISE/NEOWISE Coadder: Program Interface

Introduction  

NOTE (Apr 19, 2018): With the 2018 release of new NEOWISE data, the program-line interface is becoming less useful, because of the increased numbers of images and the current connection time limit (see Note 1 below). Use of the web page with submission of an e-mail for notification purposes is recommended.

In interactive mode, the WISE/NEOWISE Coadder requires filling in the web form or uploading a table to the web page. In program mode, it can be run via the command-line. The result is an XML file containing URL links to the resulting data.

Here is how to do a simple request with the commonly available curl and wget commands.

curl -o out.xml "https://irsa.ipac.caltech.edu/cgi-bin/ICORE/nph-icore?locstr=ngc1398&band=1&date1=07Jan2010+01:45:14&date2=14Dec2014+00:00:00&mode=PI"

wget -O out.xml "https://irsa.ipac.caltech.edu/cgi-bin/ICORE/nph-icore?locstr=ngc1398&band=1&date1=07Jan2010+01:45:14&date2=14Dec2014+00:00:00&mode=PI"

Note 1: There is a time limit (currently about 6 min) on how long the server will keep the connection open for an HTTP/GET call. If your Coadd task takes longer, it will need to be done through the web interface. One can limit the time by limiting the time range, or making small coadds.

Note 2: Currently you cannot upload a table through the program interface.

Note 3: You can load these same commands without the "mode=PI" into any browser window and get the same HTML output as interactive mode. However, you won't see the time monitor web page that comes up in interactive mode, along with its option to go to background and alert you by e-mail.

  

WISE/NEOWISE Coadder Input Parameters  

The input parameters are entered as standard HTTP "parameter=value" pairs in HTTP/GET syntax. No extra spaces are allowed. If the value contains any spaces, or special characters that might cause ambiguities, they have to be encoded as shown in any URL reference (e.g. here). Spaces can be encoded as "+" signs. The pairs are separated by ampersand (&) characters.

Parameter ParameterRange Default Description
locstr (examples) Center location of mosaic (required). This can be coordinates or an object name resolvable by NED or SIMBAD.
band 1,2,3, or 4 1 WISE band number.
sizeX 0.003-3.0
(<0.25 for HiRes) 		0.03 Size of X axis of output mosaic (deg).
sizeY 0.003-3.0
(<0.25 for HiRes) 		0.03 Size of Y axis of output mosaic (deg).
rot 0-360 0.0 Rotation angle of output (deg) = the angle of the positive Y-axis, measured W of N.
pix ≥0.3 1.0 Output pixel size (arcsec). No bigger than sizeX, sizeY.
Image Selection (if needed):
qframe 5 or 10 5 Minimum allowed frame quality. qual_frame has values 0(worst), 5, 10(best) and 0 is currently excluded.
moon 0-180 20.0 Exclude images with distance less than this from the moon (deg).
saa -25-180 0.0 Exclude images with distance less than this from the South Atlantic Anomaly edge (deg). Note: a negative value would be inside, so should be avoided.
date1 (see Description) Set this for a new lower limit to the time range of data to include. The default is 07Jan2010 01:45:14. Note the format.
date2 (see Description) Set this for a new upper limit to the time range of data to include. The default is blank, which indicates the latest time for which an image is available. Note the format. (For W3 this should be less than 29Sep2010 18:39:37 and for W4 less than 06Aug2010 10:22:03.)
sccoad area or prf area Mosaics can be created with simple area weighting or using the Point Response Function (PRF) to weight the interpolation. Note: The PRF option will force the output pixel size to 1.375 arcsec. The PRF option is not available with the HiRes option.
prodtype coadd or hires coadd Setting "hires" attempts resolution enhancement.
mode PI The mode must be set to "PI" to return results in XML. Otherwise it will be in HTML.
  
Example      

curl -o out.xml "https://irsa.ipac.caltech.edu/cgi-bin/ICORE/nph-icore?locstr=54.717208+-26.337833&band=1&sizeX=0.03&sizeY=0.03&rot=0.0&pix=1.0&qframe=5&moon=20.0&saa=0.0&date1=07Jan2010+01:45:14&date2=14Dec2014+00:00:00&sccoad=area&prodtype=coadd&mode=PI"
  
XML Output    

Below is the example XML output. 


    <?xml version="1.0"?>
    <result status="ok">
      <description>
        <ra>   54.717210000</ra>
        <dec>   -26.337830000</dec>
        <band>1</band>
        <sizeX>0.03</sizeX>
        <sizeY>0.03</sizeY>
        <rot>0.0</rot>
        <pix>1.0</pix>
        <qframe>5</qframe>
        <moon>20.0</moon>
        <saa>0.0</saa>
        <date1>07Jan2010 01:45:14</date1>
        <date2>01Feb2011 11:03:02</date2>
        <sccoad>area</sccoad>
        <prodtype>coadd</prodtype>
      </description>
      <summary>
        <ngood>
           1
        </ngood>
        <resultHtml>
	 https://irsa.ipac.caltech.edu/workspace/TMP_AAAylaqUG/ICORE/54.717208_-26.337833.v0001/result.html
        </resultHtml>
        <framesused>
	 https://irsa.ipac.caltech.edu/workspace/TMP_AAAylaqUG/ICORE/54.717208_-26.337833.v0001/results/ICORE_0001_W1_query_used.tbl
        </framesused>
      </summary>
      <images>
           <fits>
https://irsa.ipac.caltech.edu/workspace/TMP_AAAylaqUG/ICORE/54.717208_-26.337833.v0001/results/ICORE_0001_W1_mosaic-int.fits
           </fits>
           <jpg>
https://irsa.ipac.caltech.edu/workspace/TMP_AAAylaqUG/ICORE/54.717208_-26.337833.v0001/results/ICORE_0001_W1_mosaic-int.jpg
           </jpg>
           <fits>
https://irsa.ipac.caltech.edu/workspace/TMP_AAAylaqUG/ICORE/54.717208_-26.337833.v0001/results/ICORE_0001_W1_mosaic-unc.fits
           </fits>
           <jpg>
https://irsa.ipac.caltech.edu/workspace/TMP_AAAylaqUG/ICORE/54.717208_-26.337833.v0001/results/ICORE_0001_W1_mosaic-unc.jpg
           </jpg>
           <fits>
https://irsa.ipac.caltech.edu/workspace/TMP_AAAylaqUG/ICORE/54.717208_-26.337833.v0001/results/ICORE_0001_W1_mosaic-cov.fits
           </fits>
           <jpg>
https://irsa.ipac.caltech.edu/workspace/TMP_AAAylaqUG/ICORE/54.717208_-26.337833.v0001/results/ICORE_0001_W1_mosaic-cov.jpg
           </jpg>
           <fits>
https://irsa.ipac.caltech.edu/workspace/TMP_AAAylaqUG/ICORE/54.717208_-26.337833.v0001/results/ICORE_0001_W1_mosaic-std.fits
           </fits>
           <jpg>
https://irsa.ipac.caltech.edu/workspace/TMP_AAAylaqUG/ICORE/54.717208_-26.337833.v0001/results/ICORE_0001_W1_mosaic-std.jpg
           </jpg>
      </images>
    </result>
Description of XML Tags    

Tag name description
result This is the top tag of the XML file, it contains a variable "status" indicating whether the query is successful.
message This tag contains the error message when the query status = "error" or "warning".
description This series of tags contains input parameter information, location of search, size of mosaic, etc.
summary This section contains files that show the overall search results.
ngood The number of successful positions. There will be 3 mosaics for the normal coadding, and 4 for Hires.
resultHtml An HTML page that contains the entire set of search results, which includes the search location, number of successful positions, information on how to download the results and table of the mosaics with QuickLook previews.
framesused Table with frames used in the coadding.
images This section contains the links to the science, uncertainty, and coverage mosaics, in FITS and JPG.

WISE/NEOWISE Coadder Main Page