Parameters for plotting FITS images

The FITS viewer can take many, many possible parameters. Some parameters control how to get an image, a image can be retrieved from a service, a url, of a file on the server. Others control the zoom, stretch, and color, title, and default overlays. The are also parameters to pre-process an image, such as crop, rotate or flip. You can also specify three color parameters and the associated files.

All parameters and values are strings.

The following is a overview of possible plotting parameters by category. Almost all parameters are optional.

Categories of parameters:

• Parameters for specifying FITS file from a URL or on the server
• Parameters for specifying FITS files retrieved from a service
• Parameters that Color and Stretch
• Parameters that control Flipping
• Parameters that control Rotation
• Parameters that control Cropping
• Parameters that control Zoom
• Parameters that control the plot title
• The Type parameter
• Less commonly used parameters

###Parameters for specifying FITS file from a URL or on the server

If you specify URL and it is relative then one of two things happen:

• The url is made absolute based on the root path set in the method firefly.setRootPath(path) .
• The url is made absolute based on the host web page url.

###Parameters for specifying FITS files retrieved from a service

SurveyKey: The value of SurveyKey depends on the value of "Service". The possible values for SurveyKey are listed below for each service:

• IRIS: 12, 25, 60, 100
• ISSA: 12, 25, 60, 100
• DSS: poss2ukstu_red, poss2ukstu_ir, poss2ukstu_blue, poss1_red, poss1_blue, quickv, phase2_gsc2, phase2_gsc1
• SDSS: u, g, r, i, z
• TWOMASS: asky, askyw, sx, sxw, cal
• MSX: 3, 4, 5, 6
• WISE: Atlas, 1b, 3a
• ATLAS: spitzer.seip_science, spitzer.frontier_images, spitzer.s4g_images, spitzer.s_candels_images,

     spitzer.servs_images,spitzer.shela_images, spitzer.spies_images, spitzer.glimpsei_0_6,
     spitzer.glimpseii_0_6, spitzer.glimpse3d_0_6, spitzer.glimpse360_0_6,spitzer.glimpse_deepglimpse_0_6,
     spitzer.glimpse_velacar_0_6, spitzer.glimpse_smog_0_6, spitzer.glimpse_cygx_0_6, akari.akari_images

SurveyKeyBand: The value of SurveyKeyBand depends on the value of "Service". So far only used with Type=='SERVICE' and Service=='WISE', 'Service=='TWOMASS' or Service=='ATLAS'. The possible values for SurveyKeyBand are listed below for each service:

• WISE: 1, 2, 3, 4
• TWOMASS: j, h, k
• ATLAS: The possible values also depends on the value of SurveyKey:
  • spitzer.seip_science, spitzer.frontier_images: IRAC1, IRAC2, IRAC3, IRAC4, MIPS24
  • spitzer.s4g_images, spitzer.s_candels_images, spitzer.servs_images, spitzer.shela_images, spitzer.spies_images: IRAC1, IRAC2
  • spitzer.glimpsei_0_6, spitzer.glimpseii_0_6, spitzer.glimpse3d_0_6, spitzer.glimpse360_0_6, spitzer.glimpse_deepglimpse_0_6, spitzer.glimpse_velacar_0_6, spitzer.glimpse_smog_0_6, spitzer.glimpse_cygx_0_6: IRAC1, IRAC2, IRAC3, IRAC4
  • akari.akari_images: N60, WideS, WideL, N160

WorldPt: This is target for service request.

• WorldPt uses the format "12.33;45.66;EQ_J2000" for j2000.
• The general syntax is lon;lat;coordinate_sys, e.g. '12.2;33.4;EQ_J2000' or '11.1;22.2;GALACTIC'
• coordinate system can be: 'EQ_J2000', 'EQ_B1950', 'EC_J2000', 'EC_B1950', 'GALACTIC', or 'SUPERGALACTIC';

###Parameters that Color and Stretch

###Parameters that control Flipping

###Parameters that control Rotation

###Parameters that control Cropping

Notes-

• CropPt1 and CropPt2 are diagonal of each other and CropWorldPt1 and CropWorldPt2 are diagonal of each other.
• See documentation on WorldPt to find proper syntax

###Parameters that control Zoom

ZoomType: Set the zoom type, based on the ZoomType other zoom set methods may be required Notes for ZoomType:

• STANDARD - default, when set, you may optionally define 'InitZoomLevel' or the zoom will default to be 1x
• FORCE_STANDARD - Acts just like STANDARD but overrides automatic zooming when in expanded mode.
• TO_WIDTH - you must define ZoomToWidth and set a pixel width
• FULL_SCREEN - you must define ZoomToWidth with a width and 'ZoomToHeight' with a height
• ARCSEC_PER_SCREEN_PIX- you must define ZoomArcsecPerScreenPix

###Parameters that control the plot title TitleOptions: The parameter sets other ways to title the plot. The following 4 values are options for title:

• NONE - The default, use the value set in Title, if this is empty use the plot description that come from the server
• PLOT_DESC - Use the plot description set by the server. This is meaningful when the server is using a service, otherwise it will be an empty string. example- 2mass or IRIS
• FILE_NAME - Use the name of the FITS file. This is useful when plotting an uploaded file or a URL.
• HEADER_KEY - Use the value of a FITS header name key. The parameter HeaderForKeyTitle must be set to the FITS header card name
• PLOT_DESC_PLUS - Use the server plot description but append some string to it. The string is set in 'PlotDescAppend'

###The Type parameter

The request Type parameter can be set specifically or it is implied from the File, URL or Service parameters which are mutually exclusive. However, most of the type the type is inferred from these other parameters so it is unnecessary. It the Type is specified is will do some checking on the other parameters..

Type is required is you want to plot a BLANK image or an ALL_SKY image.

Type: Set the type of request. Based on the Type then one or more other parameters are required. Options are:

• SERVICE, for an image service
• FILE for file on the server
• URL for any url accessible FITS image file
• TRY_FILE_THEN_URL try a file on the server first then try the url
• BLANK make a blank image
• ALL_SKY

###Less commonly used parameters