Difference: WhereIsPlugin (7 vs. 8)

Revision 82015-09-24 - IvanV

Line: 1 to 1
 

whereIs Plugin

This is the documentation for the whereIs plugin.

Changed:
<
<
The current version v1.6 available here.
>
>
The current version v1.7 available here.
 

PURPOSE:

Returns a list of OBSIDs where a sky location (ra,dec) can be found in Herschel SPIRE and/or PACS maps.

Line: 15 to 13
 
task = whereIsTask()
Changed:
<
<
result = task(ra=123.456,dec=20.00,doPacs=True, doSpire=True, showIt=False, verbose=False,covMapsDir='/home/user/PhotCoveragePLW/')
>
>
result = task(ra=123.456, dec=20.00, doPacs=True, doSpire=True, showIt=False, verbose=False, covMapsDir='/home/user/PhotCoveragePLW/', cropDisplayMap=True)
 # print result

Changed:
<
<
After the plugin is installed, the task will appear in Task -> All. Double click on whereIs to open the GUI of the task. You can click on HELP button to get to this page.
>
>
After the plugin is installed, the task will appear in Task -> All. Double click on whereIs to open the GUI of the task. You can click on HELP button to get to this page.
  Help A zip with all SPIRE 500 Ám coverage maps is available and can be provided upon request (total 408 MB, 6878 files).

Line: 34 to 31
 doSpire - True/False, if SPIRE maps should be searched (default is True) showIt - True/False, if to display the results. Default (False). Warning! it can be very slow as is access the Herschel Science Archive. verbose - True/False, if to be verbose (default False).
Changed:
<
<
>
>
cropDisplayMap - True/False, only if showIt=True, if level3 or leve2-5 maps exists then they are cropped to +/- 100 pixels around ra,dec
 

OUTPUT:

A dictionary with keys PACS and SPIRE each one with Long1d() arrays with the list

Line: 40 to 36
  A dictionary with keys PACS and SPIRE each one with Long1d() arrays with the list of the obsids where the coverage at (ra, dec) is greater than zero
Deleted:
<
<
 

TASK DEFS:

Deleted:
<
<
 
whereIsInPacsPhot
Changed:
<
<
whereIsInSpirePhot
>
>
whereIsInSpirePhot
 

CAVEATS:

Line: 68 to 60
 # v1.4 (30 Oct 2014): minor bug fix, added option to allow reading the coverage maps from a folder instead of HSA # v1.5 (10 Dec 2014): minor fix: changing the link to the help URL as the plugin is now public. # v1.6 (10 Jun 2015): minor fix: PACS coverage in verbose mode was shown as integer, which in some cases resulted in zero
Changed:
<
<
>
>
# v1.7 (24 Sep 2015): fixed PACS display, only one login to the HAIO (avoid getObservation in loops) # improvements for speed and memory, allow for large maps to be cropped for display (cropDisplayMaps=True)
 

Example run:

Deleted:
<
<
 
Changed:
<
<
result = task(ra=40.0,dec=-1.5667,doPacs=True, doSpire=True, showIt=True, verbose=True)
>
>
result = task(ra=40.0,dec=-1.5667,doPacs=True, doSpire=True, showIt=True, verbose=True)
  The output in HIPE will look like this, note the verbose is on and the maps will also be displayed:
Line: 140 to 130
 Coverage at 500 um in pixel column=16.411225, row=41.472156: value=44 in OBSID 1342201311 HIPE> print result {'SPIRE': [1342248004,1342248003,1342248002,1342201318,1342201317,1342201316,1342201315,1342201313,1342201311], 'PACS': [1342223333,1342223332]}
Changed:
<
<
HIPE>
>
>
HIPE>
  The input coordinates will be shown in the displayed maps as a blue circle. The maps will be centred on the input position and zoomed in.

Note that if there are level-3 (or level-2.5) maps only this big map will be shown, the display window title have an information if the level of the map.

  • Screen_Shot_2014-05-07_at_17.23.10.png:
Changed:
<
<
Screen_Shot_2014-05-07_at_17.23.10.png
>
>
Screen_Shot_2014-05-07_at_17.23.10.png
  -- IvanV - 07 May 2014
Changed:
<
<
META FILEATTACHMENT attr="" autoattached="1" comment="" date="1433926384" name="whereIs_registry.xml" path="whereIs_registry.xml" size="805" user="Main.IvanV" version="1"
>
>
META FILEATTACHMENT attachment="whereIs_registry.xml" attr="" comment="" date="1443104053" name="whereIs_registry.xml" path="whereIs_registry.xml" size="805" user="IvanV" version="2"
 
META FILEATTACHMENT attr="" autoattached="1" comment="" date="1399479998" name="Screen_Shot_2014-05-07_at_17.23.10.png" path="Screen_Shot_2014-05-07_at_17.23.10.png" size="525692" user="Main.IvanV" version="1"
META FILEATTACHMENT attr="" autoattached="1" comment="Version 1.5 of the whereIs plugin" date="1418204433" name="whereIs_1.5.jar" path="whereIs_1.5.jar" size="897421" user="Main.IvanV" version="1"
META FILEATTACHMENT attr="" autoattached="1" comment="" date="1399477800" name="whereIs_1.2.jar" path="whereIs_1.2.jar" size="895536" user="Main.IvanV" version="1"
META FILEATTACHMENT attr="" autoattached="1" comment="" date="1399478610" name="whereIs_1.3.jar" path="whereIs_1.3.jar" size="896351" user="Main.IvanV" version="2"
META FILEATTACHMENT attachment="whereIs_1.6.jar" attr="" comment="Version 1.6 of the plugin" date="1433927147" name="whereIs_1.6.jar" path="whereIs_1.6.jar" size="896824" stream="whereIs_1.6.jar" user="Main.IvanV" version="3"
META FILEATTACHMENT attr="" autoattached="1" comment="Version 1.4 of the plugin" date="1414685387" name="whereIs_1.4.jar" path="whereIs_1.4.jar" size="897369" user="Main.IvanV" version="1"
Added:
>
>
META FILEATTACHMENT attachment="whereIs_1.7.jar" attr="" comment="Version 1.7 of the plugin" date="1443104011" name="whereIs_1.7.jar" path="whereIs_1.7.jar" size="897862" user="IvanV" version="1"
 
META TOPICMOVED by="IvanV" date="1418131033" from="Sandbox.WhereIsPlugin" to="Public.WhereIsPlugin"
 
This site is powered by the TWiki collaboration platform Powered by Perl