EDDIE Cut-out Image Service Help
The EDDIE Cut-out Image Service is intended for the generation of high resolution astronomy images given a particular Field Of View (FOV), a HiPS map and a specific projection.
The output image format is configurable, as well as the zoom level (HealPix nOrder) and the size of the output images, with the goal of providing a versatile and customizable service.
Service URL: //sky.esa.int/esasky-tap/skyimage
Supported url parameters
polygon
OPTIONAL PARAMETER
Defines the area of the sky to be drawn.
This polygon must be represented as an Aladin polygon.
RA,DEC list separated by commas and with the middle coordinates included between corners.
IE: polygon=58.57861685142285,47.62802297237037,10.73787309008084,56.174587334131616,322.87931753349244,
47.66301173930289,333.2172792026612,34.89010805533716,338.44876901273096,20.70164345690472,10.717755898470926,
26.424139728893707,42.98946929171742,20.676455798639196,48.228408355997644,34.86267054437926
target
OPTIONAL PARAMETER
In addition to the "fov" parameter defines the area of the sky to be drawn.
This target must be represented as an ESASky target or coordinates.
RA DEC separated by blank space
If target parameter is used, also the "fov" parameter must be passed.
IE: target=10.684708333333333%2041.268750000000004
fov
OPTIONAL PARAMETER
In addition to the "target" parameter defines the area of the sky to be drawn.
This fov must be represented as an ESASky fov with values between 180.0 and 0.0000001
If fov parameter is used, also the "target" parameter must be passed.
IE: fov=0.7440329441279633
aspectratio
OPTIONAL PARAMETER
Defines the aspect ratio (width/height) of the output image.
If aspectratio parameter is used, also the "target" and "fov" parameters must be passed.
The default value in case this parameter is not passed is: 16/9 -> 1.777
IE: aspectratio=2.5
If not polygon or target and fov parameters are passed all sky coverage will be drawn.
norder
OPTIONAL PARAMETER
Defines the nOrder to use for downloading the images required for generating the output image.
This nOrder is an integer that will be cropped between the minimum (usually 3) and maximum (usually 9 or 13) values supported in the information retrieved with the passed hips parameter.
In case that no nOrder parameter is passed, the service will automatically calculate the apropiate nOrder for that area of sky and image resolution.
IE: norder=6
hips
OPTIONAL PARAMETER
Defines the sky survey or hips survey to use for downloading the images required for generating the output image.
This hips value represents the "surveyId" parameter of each menuEntry of the list of menuEntries returned by this JSON endpoint: //sky.esa.int/esasky-tap/hips-sources
In case that no hips parameter is passed, the default value will be "DSS2 color".
IE: hips=XMM-Newton%20UV%20color
hipsfmt
OPTIONAL PARAMETER
Defines the format or extension of hips images that will be downloaded for generating the output image.
This value must be "PNG", "JPG" or "JPEG".
In case that no hipsfmt parameter is passed, the default value will be taken from the "imgFormat" parameter specified in the menuEntry selected by the hips parameter from the list returned by this JSON endpoint: //sky.esa.int/esasky-tap/hips-sources .
IE: hipsfmt=PNG
size
OPTIONAL PARAMETER
Defines the size in pixels of the longest side of generated image.
The final aspect ratio of the generated image will be defined by the polygon parameter if passed, or by the aspectratio parameter.
In case that no size parameter is passed, 1024px will be used. The maximum value supported at the moment is 8192px.
IE: size=2048
proj
OPTIONAL PARAMETER
Defines the projection to use for generating the output image.
The supported values are "ALADIN_ORTOGRAPHIC", "MERCATOR", "ORTOGRAPHIC" (Experimental)
-
ALADIN_ORTOGRAPHIC: The same projection that uses aladin or ESASky to draw the sky, also called spherical projection.
-
MERCATOR: Or cylindrical projection, where the meridians are equally spaced parallel vertical lines, and the parallels of latitude are parallel horizontal straight lines.
-
ORTOGRAPHIC: (Experimental) Sometimes called orthogonal projection, in which all the projection lines are orthogonal to the projection plane.
In case that no proj parameter is passed, "ALADIN_ORTOGRAPHIC" will be used.
IE: proj=MERCATOR
fmt
OPTIONAL PARAMETER
Defines the format or extension of the generated output image.
This value must be "PNG", "JPG" or "JPEG".
In case that no fmt parameter is passed, the default value will be "PNG".
IE: fmt=JPG
crop
OPTIONAL PARAMETER, DEBUG ONLY
Only for debbugin purpouses. Tells to the service that we want to see all the steps taken for generating the output image.
This value must be "true" or "false"
In case that no crop parameter is passed, the default value will be "false".
IE: crop=true
timeout
OPTIONAL PARAMETER
Defines the maximum time in milliseconds for generating the output image.
In case that no timeout parameter is passed, the default value will be 15000.
But for generating images of high resolution or with bigger nOrders you need to specify a bigger timeout.
IE: timeout=90000
bgcolor
OPTIONAL PARAMETER
Defines the background color to use for generating the output image.
This value must be a hexadecimal color.
In case that no bgcolor parameter is passed, the default value will be "BLACK".
IE: bgcolor=%23999999
catalogs
OPTIONAL PARAMETER
Defines the list of catalogs to draw in the generated output image.
This value must be a JSON and is recommended to use the POST method to pass this data to the EDDIE service.
JSON DATA NO ENCODED FOR URL
IE: catalogs=[
{
"id":"CircleCatalog",
"shape":{
"@class":"esac.archive.esasky.sl.skyimage.catalogs.shapes.CircleShape",
"radious":2,
"color":"#ff0000",
"alpha":1.0,
"type":"CIRCLE"
},
"drawSourceNames":false,
"sources":[
{
"name":"Mrk 334",
"ra":0.7901,
"dec":21.96025
},{
"name":"Mrk 335",
"ra":1.581591666666667,
"dec":20.202938888888887
},{
"name":"NGC 34",
"ra":2.77755,
"dec":-12.107869444444443
}
]
},
{
"id":"SquareCatalog",
"shape":{
"@class":"esac.archive.esasky.sl.skyimage.catalogs.shapes.SquareShape",
"size":5,
"color":"#0000ff",
"alpha":0.5,
"type":"SQUARE"
},
"drawSourceNames":true,
"sources":[
{
"name":"NGC 7733",
"ra":355.6372666666667,
"dec":-65.95650555555557
},{
"name":"2MASX J23484171+0214229",
"ra":357.1738291666667,
"dec":2.2397166666666672
}
]
}]