(r85) DpHipePlugins < Public

Public Web>DpHipe>DpHipePlugins (revision 85) (raw view)~~EditAttach~~

<!-- ANALYTICS CODE - DO NOT EDIT -->
%INCLUDE{"%ATTACHURL%/GoogleAnalytics.txt" raw="on"}%
<!-- END OF ANALYTICS CODE -->
---+ !!HIPE Plug-ins

This page lists the plug-ins currently available for HIPE.<br/>

If you have created a plug-in, we encourage you to publish it here. Either add it directly, or send me an e-mail at paul.balm[[mailto:@esa.int][@esa.int]].

   * For an *introduction into plug-ins and how to use them*, see the [[DpHipePluginsUserManual][User Manual]]. See also our [[http://youtu.be/XPJdzRiReog][3-minute video tutorial]] for a quick introduction.
   * If you want to *create your own plug-ins*, read the [[DpHipePluginsDeveloperManual][Plug-in Author Manual]].
   * If you're interested in understanding the features available in the plug-in framework, you can read the [[DpHipePluginsDesignDocument][Design Document]].

| %X% *The plug-ins on this page are maintained by third-party developers. They are provided "as is", without any warranty and support by the Herschel Science Centre. Plug-in developers are solely responsible for testing and support.* |

The HSC also maintains a page with [[http://herschel.esac.esa.int/UserContributedSoftware.shtml][user contributed software]] -- these are typically stand-alone programs, not plug-ins for HIPE.

---
---++ !! Available Plug-ins
%TOC%
---

---++ Generic Utilities



---+++ Unit Conversion Tool

The Unit Conversion Tool converts between various units of Flux (e.g., erg/s/cm2), Flux Density (e.g., Jy), Intensity (e.g. Jy/sr, K), Integrated Intensity (e.g., K km/s), and Surface Area (e.g. Steradians). Constants are converted via a GUI, and arrays (of type Double1d) are converted via the HIPE command line. All conversion formulae are derived within the help.  

To install, select _Plug-ins_ from the _Tools_ menu. Click _Install new_ and enter the following URL:

<pre>
https://nhscsci.ipac.caltech.edu/common/DPsoftware/UnitConversionTool/UnitConversionTool_0.14.jar
</pre>

The tool will auto-update itself. The Unit Conversion Tool is provided by Steve Lord and Annie Hoac (NHSC).


---+++ Cosmology Plug-in

A HIPE plugin to perform common Cosmological calculations. Based on Dave Hogg's "Distance measures in Cosmology", and similar to Ned Wright's javascript Cosmology Calculator. 

<pre>
    https://nhscsci.ipac.caltech.edu/common/DPsoftware/Cosmology/Cosmology_1.3.jar
</pre>

---+++ !HerschelQuickLook Plug-in

Access the quick look data products from the Herschel Space Observatory, searching by target name, sky coordinates or observation identifier.

To install, select _Plug-ins_ from the _Tools_ menu. Click _Install new_ and enter the following URL:

   * HIPE 10 or earlier
<pre>
     http://herschel.be/twiki/pub/Public/DpHipePlugins/HerschelQuickLook_1.9.jar
</pre>

   * HIPE 11, 12
<pre>
     http://herschel.be/twiki/pub/Public/DpHipePlugins/HerschelQuickLook_1.10.jar
</pre>

Restart HIPE, go to "Tools" menu and select "HerschelQuickLook"


---+++ Dataset Reader: Load very large products, by loading only designated datasets

%INCLUDE{"DatasetReaderPlugin"}%

[[DatasetReaderPlugin][Go to the plug-in page]]



---++ Photometry


---+++ SPIA: SPIRE Photometric Interactive Analysis

The [[https://nhscsci.ipac.caltech.edu/sc/index.php/Spire/SPIA][SPIA package]] is a plug-in to allow for interactive GUI based data processing with full control over pipeline module parameters. The currently available tasks of this package focus on the SPIRE photometer, in particular artifact removal and making of SPIRE scan maps.

To install, select _Plug-ins_ from the _Tools_ menu. Click _Install new_ and enter the following URL:

<pre>
https://nhscsci.ipac.caltech.edu/spire/DPsoftware/spia/scripts/spia_1.11.1.jar
</pre>

The installation is automatic. Any further updates will be automatically offered when you re-start HIPE and are connected to the internet.

See the [[http://herschel.esac.esa.int/hcss-doc-11.0/index.jsp#spire_drg:spire_drg][SPIRE Data Reduction Guide]] and the [[https://nhscsci.ipac.caltech.edu/sc/index.php/Spire/SPIA][SPIA Homemage]] for more information and documentation. SPIA development is led by Bernhard Schulz (NHSC). Support is available via the [[http://nhsc.ipac.caltech.edu/helpdesk][NHSC Helpdesk]].


---+++ Photometric convolution

Task and script to convolve images to a common PSF.
To install, select _Plug-ins_ from the _Tools_ menu. Click _Install new_ and enter the following URL:
<pre>
http://herschel.esac.esa.int/twiki/pub/Public/DpHipePlugins/ConvolvePhotometric_1.2.jar
</pre>

%X% This plug-in is *not compatible with HIPE 9*. They are compatible with HIPE 10 from build 1500 onwards.

*[[%ATTACHURL%/Documentation.pdf][Documentation]]* for the tasks and scripts. After installing a plug-in, you can find the corresponding script under the _Tools_ menu in HIPE.


---+++ PACS Simple Aperture Photometry Plug-in

<p>
This task performs simple aperture photometry on a set of !SimpleImage. It compliments and uses the &#8216;annularSkyAperturePhotometryTask&#8217; interactive photometry tool already available in HIPE with added functionality catering to science needs. It is used to perform aperture photometry of unblended sources on single or multiple PACS frame. 
</P>

To install, select _Plug-ins_ from the _Tools_ menu. Click _Install new_ and enter the following URL:

<pre>
https://nhscsci.ipac.caltech.edu/pacs/scripts/Plugins/PacsSimpleAperturePhotometry_2.0.jar
</pre>

NOTE: This version of the plug-in works for any version of HIPE, effectively replacing version 1.0.

The tool will auto-update itself.



---++ Spectroscopy


---+++ Spectroscopic convolution

Task and script to convolve PACS line flux maps to a common PSF.
To install, select _Plug-ins_ from the _Tools_ menu. Click _Install new_ and enter any of the following URLs:

   * HIPE 10 & 11
<pre>
     http://herschel.esac.esa.int/twiki/pub/Public/DpHipePlugins/ConvolveSpectroscopic_1.1.1.jar
</pre>

   * HIPE 12
<pre>
     http://herschel.esac.esa.int/twiki/pub/Public/DpHipePlugins/ConvolveSpectroscopic_1.2.jar
</pre>

*[[%ATTACHURL%/Documentation.pdf][Documentation]]* for the tasks and scripts. After installing a plug-in, you can find the corresponding script under the _Tools_ menu in HIPE.


---+++ HI-PI: HIFI useful scripts plug-in

From the project page:

<BLOCKQUOTE>
We have collected scripts from various sources around the HIFI ICC that have proved useful to users when reducing their data. This useful software has been packaged up in the format of a HIPE plugin, which is easy to install and will auto-update when a new version of the plugin is available. 
</BLOCKQUOTE>

The plug-in is available at this URL:

https://nhscsci.ipac.caltech.edu/sc/index.php/Hifi/HIPI

---+++ CASSIS Plug-in

[[http://cassis.irap.omp.eu/][CASSIS]] is a spectral analysis tool-set containing:
   * Line Identification Tool
   * Prediction of spectra
   * Comparison of telescope or laboratory data with a wide variety of models
   * Tools to determine the physical parameters of the sources

(See the web-site for details.) The plug-in makes this functionality available directly in HIPE.

To install, select _Plug-ins_ from the _Tools_ menu. Click _Install new_ and enter the following URL:

<pre>
    http://cassis.irap.omp.eu/download/cassis_3.4.1.jar
</pre>


---++ Map-making


---+++ SUPREME: Super Resolution Map-maker for extended emission

From the [[http://www.ias.u-psud.fr/supreme/home.php][project homepage]]:

<BLOCKQUOTE>
SUPREME is a generic name for mapmakers for extended emission based on a realistic physical instrument model and regularized inversion. A first development has been performed by T. Rodet et al IEEE 2, 5 (2008) using a Bayesian framework for the infrared slit spectrograph on board the Spitzer Space Telescope. F. Orieux et al A&A 539, A38 (2012) have proposed the first super-resolution supervised Bayesian mapmaker for the SPIRE instrument of the Herschel observatory, tested for simulated and real data. The current version of SUPREME, developed by H. Ayasso et al (hal-00765929), is based on an unsupervised Bayesian approach with enhanced beam and offset models. B. Hasnoun, member of the Integrated Data And Operation Center at IAS (IDOC), has exported the original Matlab code to Java and prepared a HIPE plugin.

SUPREME is an ambitious pluridisciplinary research projet for mapmaking where several research codes have been already developed. For instance, the estimate of hyperparameters and instrument parameters has been presented by F. Orieux et al A&A 549, A83 (2013). Moreover, Ayasso et al proposed an unsupervised mapmaker for point and extend sources mixture. Furthermore other improvements are expected in the future (1/f corrections, use for other instruments, &#8230;).
</BLOCKQUOTE>

A plug-in for HIPE has been made available as the following URL:

http://www.ias.u-psud.fr/supreme/hipeplugin.php


---+++ !ScanAmorphos Plug-in

%INCLUDE{"ScanAmorphosPlugin"}%

[[ScanAmorphosPlugin][Go to the plug-in page]]



---++ Other/Engineering



---+++ MUST Plug-in

The MUST plug-in allows you to connect to ESOC's MUST database and process the housekeeping parameters.

%ICON{warning}% At the moment the MUST database can only be accessed within the ESA internal network_

---++++ !!Usage
After installation:
   *  Restart HIPE
   *  Go to menu *Edit -&gt; Preferences*.
   * Select Must from the tree at the left of the pop-up window.
   * Modify the user and password information (if you do not know your user or password for MUST, please ask your MUST contact person)/
   * Click *Apply*.
   * Go to the menu *Window -&gt; Show View -&gt; Must*.
   * In the Must View, click the button *Get Parameters*.
   * Now you can plot the parameters you want.

If you want to make your own script to modify the parameters:
   * Go to Workbench perspective
   * Load the default script(Go to the menu *Tools-&gt;must_herschel_plugin-composite.py*)
   * Modify this example script at your wish.
   * Run the script

---++++ !!Install
To install, select _Plug-ins_ from the _Tools_ menu. Click _Install new_ and enter the following URL:

<pre>
    %ATTACHURL%/must_herschel_plugin_0.4.jar
</pre>


---+++ Demonstration Plug-in

The demonstration plug-in is intended for plug-in developers. It shows some features of plug-in, such as including a license text, using a custom installer and custom configuration.

<pre>
    http://herschel.be/twiki/pub/Public/DpHipePlugins/demo_1.1.jar
</pre>

<hr/>
<!-- COMMENT BOX CODE - DO NOT EDIT -->
<div id="disqus_thread"></div>
<script type="text/javascript">
    var disqus_shortname = 'herscheltwiki'; // required: replace example with your forum shortname

    (function() {
        var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
        dsq.src = 'http://' + disqus_shortname + '.disqus.com/embed.js';
        (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
    })();
</script>
<noscript>Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
<a href="http://disqus.com" class="dsq-brlink">blog comments powered by <span class="logo-disqus">Disqus</span></a>
<!-- END OF COMMENT BOX CODE -->
<hr/>

<!--
   * Set ALLOWTOPICCHANGE = Main.RegisteredUsersGroup, Main.TWikiAdminGroup
-->

Attachments

Topic attachments
I	Attachment	History	Action	Size	Date	Who	Comment
jar	unitTestPlugin_1.0.jar	r1	manage	0.5 K	2010-07-15 - 07:48	PaulBalm
xml	ConvolveSpectroscopic_registry.xml	r2 r1	manage	1.4 K	2012-11-26 - 14:11	PaulBalm	Spectroscopy convolution plugin version registry
xml	must_herschel_plugin_registry.xml	r3 r2 r1	manage	1.4 K	2012-09-10 - 15:49	PaulBalm	Version registry of MUST plug-in
xml	ConvolvePhotometric_registry.xml	r3 r2 r1	manage	2.0 K	2012-11-26 - 14:11	PaulBalm	Photometry convolution plugin version registry
jar	ConvolvePhotometric_1.0.jar	r1	manage	3.8 K	2012-09-25 - 08:53	DavideRizzo	Photometry convolution plugin
jar	ConvolvePhotometric_1.1.jar	r1	manage	4.0 K	2012-09-25 - 10:08	PaulBalm	Photometry convolution plugin v1.1 -- add release notes, auto update
jar	ConvolveSpectroscopic_1.0.jar	r1	manage	4.3 K	2012-09-25 - 08:56	DavideRizzo	Spectroscopy convolution plugin
jar	demo_1.0.jar	r1	manage	5.8 K	2010-08-16 - 13:47	PaulBalm	Demonstration plug-in
jar	demo_1.1.jar	r1	manage	6.6 K	2010-09-13 - 11:53	PaulBalm	Demo plug-in v1.1 -- add source code for Installer
jar	ConvolvePhotometric_1.2.jar	r1	manage	8.0 K	2012-09-25 - 11:36	PaulBalm	Photometry convolution plugin v1.2 -- include script
jar	ConvolveSpectroscopic_1.1.jar	r1	manage	8.5 K	2012-09-25 - 11:30	PaulBalm	Spectroscopy convolution plugin v1.1 -- add release notes, auto update, include script
jar	ConvolveSpectroscopic-1.2.jar	r1	manage	8.6 K	2013-10-07 - 15:37	JaimeSaiz	Spectroscopy convolution plugin v1.2 -- adapted to HIPE 12 (stop extending JTask)
jar	ConvolveSpectroscopic_1.1.1.jar	r1	manage	8.6 K	2013-10-07 - 09:38	JaimeSaiz	Spectroscopy convolution plugin v1.1.1 -- set maximum HIPE version as 11.0
jar	ConvolveSpectroscopic_1.2.jar	r1	manage	8.6 K	2013-10-07 - 15:39	JaimeSaiz	Spectroscopy convolution plugin v1.2 -- adapted to HIPE 12 (stop extending JTask)
txt	hipe_conv_spec_script.py.txt	r1	manage	10.1 K	2012-09-25 - 08:57	DavideRizzo	Spectroscopy convolution script
jar	spia_0.6.jar	r1	manage	14.2 K	2010-07-19 - 09:02	PaulBalm
jar	spia_0.6.1.jar	r2 r1	manage	14.5 K	2010-07-23 - 10:18	PaulBalm
txt	hipe_conv_phot_script.py.txt	r1	manage	15.8 K	2012-09-25 - 08:55	DavideRizzo	Photometry convolution script
pdf	units1.pdf	r1	manage	37.9 K	2012-08-30 - 01:02	SteveLord
jar	spa_0.8.1.jar	r1	manage	44.8 K	2010-08-27 - 16:11	PaulBalm	Update relative to 0.8: Fix icon
jar	spia_0.8.1.jar	r1	manage	44.8 K	2010-08-27 - 16:17	PaulBalm	Update relative to 0.8: Fix icon
pdf	Documentation.pdf	r1	manage	85.0 K	2012-09-25 - 08:58	DavideRizzo	Documentation for photometry and spectroscopy convolution plugins
jar	HerschelQuickLook_1.10.jar	r1	manage	141.4 K	2013-04-19 - 12:53	JuanCarlosSegovia	HerschelQuickLook v1.10
jar	HerschelQuickLook_1.9.jar	r1	manage	142.7 K	2013-04-17 - 11:38	JuanCarlosSegovia	HerschelQuickLook
jar	HerschelQuickLook_1.8.jar	r1	manage	143.0 K	2012-03-02 - 15:42	JuanCarlosSegovia	HerschelQuickLook
jar	must_herschel_plugin_0.3.jar	r1	manage	741.7 K	2010-10-29 - 12:53	PaulBalm	MUST plug-in for HIPE v0.3
jar	must_herschel_plugin_0.4.jar	r2 r1	manage	742.2 K	2011-10-27 - 10:59	PaulBalm	MUST plug-in for HIPE v0.4

Topic revision: r85 - 2013-10-07 - JaimeSaiz

Public

Webs
Public
TWiki