Documentation errata and updates

HIPE is being heavily used and heavily improved at the same time. For the documentation team it is not always easy to keep up with all the latest features and bugfixes.

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.

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!

• 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

Data Analysis Guide

Missing figures 2.6 to 2.9 (HIPE 2.3.1)

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.

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.

What's New

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

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

• 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.