<-- Google Analytics script BEGIN -->

<-- Google Analytics script END -->

• Upgrade to Jython 2.5: Starting from version 8.0, HIPE includes a new version of Jython. You may have to adapt your scripts for them to work with the new version. See this page for the details.

• Documentation for the 9.x series of HIPE.

• Documentation for the 9.x series of HIPE (upcoming version, in testing).
• Documentation for the 10.x series of HIPE (next major version, in development).

<-- COMMENT BOX CODE - DO NOT EDIT -->

<-- END OF COMMENT BOX CODE -->

• Documentation for the 8.x series of HIPE.
• Documentation for the 9.x series of HIPE (next major version, in development).

• SPIRE Data Reduction Guide: The numbers quoted in Section 5.7, subsection "Aperture Photometry of Extended Sources in SPIRE maps", are outdated. The user should use the values given in the SPIRE Observers' Manual, Table 5.2. The correct beam areas are: (423, 751, 1587) arcsec² at (250, 350, 500) µm.

• URM categories: Some entries in the three instruments User's Reference Manuals have wrong or missing categories.
• URM examples: Some examples in the User's Reference Manuals may not work as expected. Please use the feedback icon in the HIPE Help System to let us know about broken examples.

• JIDE vs HIPE: The documentation shipped with HIPE may still mention JIDE in some places. JIDE was the data reduction application that came before HIPE and is no longer supported. All references to JIDE can be applied to HIPE.

• Documentation for the 7.x series of HIPE.
• Documentation for the 8.x series of HIPE (next major version, in development).

• Wrong example in plot chapter: In Section 3.2.9 of the Data Analysis Guide, the second line of example 9 is wrong. It should be chartType, with a lower case c, instead of ChartType. Fixed in HIPE 7.

• Upgrade to Jython 2.5: Starting from version 8.0, HIPE will include a new version of Jython. You may have to adapt your scripts for them to work with the new version. See this page for the details.
• Wrong example in plot chapter: In Section 3.2.9 of the Data Analysis Guide, the second line of example 9 is wrong. It should be chartType, with a lower case c, instead of ChartType. To be fixed in HIPE 7.

• Wrong example in plot chapter: in Section 3.2.9 of the Data Analysis Guide, the second line of example 9 is wrong. It should be chartType, with a lower case c, instead of ChartType. To be fixed in HIPE 7.

• JIDE vs HIPE: The documentation shipped with HIPE still mentions JIDE in some places. JIDE was the data reduction application that came before HIPE and is no longer supported. All references to JIDE can be applied to HIPE.

• URM categories: Most entries in the three instruments User's Reference Manuals have wrong or missing categories.

• Extra dashes in PDF code examples: examples in the PDF versions of the manuals sometimes have extra dashes added (for example, -XX:MaxPermSize=256m becomes --XX:MaxPermSize=256m). If an example or a command does not work as expected, try checking the HTML version of the documentation, which is not affected by this bug.

• Broken links to public PACS documents: In the online version of the documentation, the PACS Public Documents link in the PACS section is broken. The link works in the offline documentation version shipped with HIPE. You can access the PACS public documents at http://herschel.esac.esa.int/twiki/bin/view/Public/PacsDocumentation

• Documentation for the 6.x series of HIPE.

• JIDE vs HIPE: The documentation shipped with HIPE still mentions JIDE in several places. JIDE was the data reduction application that came before HIPE and is no longer supported. All references to JIDE can be applied to HIPE.

• URM categories: Most entries in the User's Reference Manuals have wrong or missing categories.
• URM examples: Several examples in the User's Reference Manuals do not work as expected. Please use the feedback icon in the HIPE Help System to let us know about broken examples.
• JIDE vs HIPE: The documentation shipped with HIPE still mentions JIDE in several places. JIDE was the data reduction application that came before HIPE and is no longer supported. With the exception of Appendix B of the Scripting and Data Mining guide, all references to JIDE can be applied to HIPE.
• Broken links to public PACS documents: In the online version of the documentation, the PACS Public Documents link in the PACS section is broken. The link works in the offline documentation version shipped with HIPE. You can access the PACS public documents at http://www.herschel.be/twiki/bin/view/Public/PacsDocumentation

• Documentation for the 6.x series of HIPE (now in testing, not yet released).
• Documentation for the 7.x series of HIPE (next major version, in development).

Current issues

These issues should be mostly solved for HIPE 6.0, to be released in the first half of 2011.

• Most entries in the User's Reference Manual have wrong or missing categories.
• Many examples in the User's Reference Manual do not work as expected. Please use the feedback icon in the HIPE Help System to let us know about broken examples.
• The documentation shipped with HIPE still mentions JIDE in several places. JIDE was the data reduction application that came before HIPE and is no longer supported. With the exception of Appendix B of the Scripting and Data Mining guide, all references to JIDE can be applied to HIPE.

Online documentation

• Documentation for the 5.x series of HIPE.
• Documentation for the 6.x series of HIPE (still in development).

What's New

Updates to What's New document (HIPE 3.0.x)

Please note the following amendments to the What's New document:

• Renaming of pools: Note that this does not work with pools created with versions earlier than 3.0, even if you have updated the pools to the new index format.
• Changes to SPIRE deglitching methods: Two deglitcher methods (one based on wavelet and a second based on a sigma-kappa algorithm) were called deglitchTimeline and simpleDeGlitcher until HIPE 2.x. From HIPE 3.0, these tasks are called waveletDeglitcher and sigmaKappaDeglitcher. The tasks with the old names are still present but deprecated; if you use them you will get a warning. If you used any of the developer builds leading to HIPE 3.0: note that, for a while, a deglitcher task called deglitcherReconstructor was added to developer builds, but has been removed for the final release.
• Improvements in HIFI frequency calibration: The motion of the spacecraft with respect to the Solar System Barycentre is computed with an accuracy of about 1m/s ( Earth motion by P. Stumpf, AASS 41,1,1980). The (Kinematic) LSR is defined with respect to the SSB by a constant velocity vector. A Lorentz transformation takes the HIFI frequency axes from detection frame to presentation frame (by default the LSR, see the doVelocityCorrection() task). By default, the HIFI pipeline produces Level2 frequency axes in the LSR frame for fixed targets, and the Herschel frame (no transformation) for Solar System Objects (SSOs). In the near future, transformation to the target-rest-frame will be the pipeline default for SSOs, as the necessary methods are added to HCSS. If you are interested in working directly with velocities at the spectrum dataset level:
  • The columns velocity_hso_{1,2,3} are the components of the spacecraft velocity in the SSB frame.
  • The column velocity is the component of HSO velocity in the direction of observation in the LSR frame, computed nonrelativisitically. This is not used in the HIFI pipeline, but may be of interest to you.

Data Analysis Guide

Missing figures 2.6 to 2.9 (HIPE 2.3.1)

Scripting and Data Mining

Wrong instructions on changing lstore directory (HIPE 2.3.1)

Instructions on how to change the default local store directory (Appendix A, Section A.3.1) are incorrect. Please follow these instructions instead:

By default, data is stored in a directory with the user-supplied store name in the following directory

[home]/.hcss/lstore/

This can be changed by changing the property hcss.ia.pal.pool.lstore.dir. There are two ways to do this:

1. Issue the following statement in the Console view of HIPE:

Configuration.setProperty("hcss.ia.pal.pool.lstore.dir", "${user.home}/.hcss/alternate_store/")

2. Add this line to the hipe.props file, located in the .hcss directory within your home directory:

hcss.ia.pal.pool.lstore.dir=${user.home}/.hcss/alternate_store/

If the hipe.props file does not exist, just create it.

If you use the first method, the property value will be reset to its original value the next time you start HIPE. If you use the second method, the property will be set permanently and will be available since HIPE start up.

• Read Me First
• Quick Start Guide
• Frequently Asked Questions
• HIPE Owner's Guide
• Data Analysis Guide
• Scripting and Data Mining
• The HIFI User's Manual
• HIFI Pipeline Specification
• SPIRE User''s Manual
• SPIRE Data User's Manual
• PACS Data Reduction Guide
• PACS Advanced User's Manual

Bleeding edge manuals

These are the PDF versions of the manuals included with the latest development version of HIPE. They are generally clearer and better organised than previous versions, but may also mention features not included in your version of HIPE. Use them at your risk!

Hyperlinks to be added soon.

• Read Me First
• Quick Start Guide
• Frequently Asked Questions
• HIPE Owner's Guide
• Data Analysis Guide
• Scripting and Data Mining
• The HIFI User's Manual
• HIFI Pipeline Specification
• SPIRE User''s Manual
• SPIRE Data User's Manual
• PACS Data Reduction Guide

Documentation errata and updates

This is why we have set up a page where you can get documentation fixes and updates without having to wait for the next HIPE version. Come back from time to time for new documentation goodies, and remember that we always appreciate your feedback through the Helpdesk.

Errata and updates for HIPE version 2.3

Data Analysis Guide

Figures 2.6 to 2.9 do not appear in the Data display chapter. They are reproduced below.

Figure 2.6. Additional controls for data cubes.

Figure 2.7. The Spectrum Explorer.

Figure 2.8. Filters on attributes.

Figure 2.9. The button bar.

Documentation errata

Under construction.