HEG_README_v2.11 by stariya


									HEG README: last updated 20-January-2011


The HDF-EOS To GeoTIFF Conversion Tool (HEG) is a tool developed to
allow a user
to reformat, re-project and perform stitching/mosaicing and subsetting
operations on
HDF-EOS objects. The output GeoTIFF file is ingestible into commonly
used GIS
applications. HEG will also write to HDF-EOS Grid & SWATH formats (i.e
for Subsetting purposes)
and native (or raw) binary. HEG presently works with MODIS (AQUA and
AMSR-E HDF-EOS data sets.

HEG Home Page:

Brief Summary of Features include:

- Reprojection
- Spatial (geolocation) subsetting
- Band and Parameter (aka Field) Subsetting of HDF-EOS datasets
- Support for MODIS, ASTER, MISR, AIRS, and AMSR-E
  (Check List of Supported Products for full details)
- Format Conversion of various output Format types: GeoTIFF, HDF-EOS
  MultiBand GeoTIFF, Multi-Band HDF-EOS GRID & SWATH, and native
- Format Conversions without reprojection or manipulation of input
  Allows data to remain in original unaltered state.
- Stitching (or mosaicing) HDF-EOS SWATH and GRID datasets
- Stitching with combinations of Reformatting/Reprojection/Subsetting
- Data subsampling
- Control of various parameters including output pixel resolution and
output projection parameters
- Metadata preservation and creation
- Java GUI
- Command-line interface (Useful for running batch jobs. This is
usually seen in automated production
  environments where large quantities of granules are processed.)
- Supported Platforms: LINUX, WINDOWS, SUN, and MAC OSX (built on
Darwin Kernel Version 8.10.0)

New Features/problem fixes for v2.11:
1) Numerous bug fixes concerning performance issues when default values
are used for some output
   projectuions such as Lambert Azimuthal, Lamber Conformal Conic,
Tranvscerse Mercator, Polar Streographic
2) Improvement in GUI error checking/user interaction.
3) Fixes for better handling of output UTM and State Plane Projection.

New Features/problem fixes for v2.10:
1) Added support for
      - AMSR-E Daily 25 Km Sea Ice AE_SI25
      - AMSR-E Daily land AE_Land3
            - MOD29E1D
            - Tested many new products and updated the list of Hegable
            products in HEG Users Guide and HEG web site
2) Added new projection Cylindrical Equa Area (CEA)to support AMSR-E
Daily Land product.
3) Made it possible to output all fields in a file to a single HDF-EOS
output when HDF-EOS output is requested.
4) Resolved problems with several products such as MOD43C3, MOD10CM,
MOD29P1N, AE_RnGd, AE_Rain,
5) Support for pixel resampling for gridded data with no reprojection
6) Correcting sphere raduis wrritten to outputs for MODIS SIN grids
7) Resolvong problems
     - with band selection in stitch GUI
     - with unneeded reseting of projection parameters for multiband
     - with ocasional core dump (runs that take long time to
complete)in Datapool HEGserver

New Features/problem fixes for v2.9:
1) Added support for
      - ASTER 07XT : ASTER On-Demand L2 Surface Reflectance VNIR
      - ASTER 09XT : ASTER On-Demand L2 Surface Radiance VNIR
      - AMSR-E Rain: AMSR-E/Aqua L2B Global Swath Rain Rate/Type GSFC
Profiling Algorithm
      - AMSR-E Weekly Ocean: AMSR-E/Aqua Weekly L3 Global
Ascending/Descending .25x.25 deg Ocean
      - AMSR-E Monthly Ocean: AMSR-E/Aqua Monthly L3 Global
Ascending/Descending .25x.25 deg Ocean Grids
      - AMSR-E 5 Day Smow: AMSR-E/Aqua 5 Day L3 Global Snow Water
Equivalent EASE-Grids
      - AMSR-E Monthly Snow: AMSR-E/Aqua Monthly L3 Global Snow Water
Equivalent EASE-Grids
      - AMSR-E Daily 12 Km Sea Ice: AMSR-E/Aqua daily L3 12.5 km Tb,
Sea Ice Conc., & Snow Depth Polar Grids
      - AMSR-E Daily 6 Km Sea Ice: AMSR-E/Aqua Daily L3 6.25 km 89 GHz
Brightness Temperature (Tb) Polar Grids
      - AMSR-E Rain Grid: AMSR-E/Aqua Monthly L3 5x5 deg Rainfall
2) Creation of Multiband files in Datapool, when the field is multiband
3) Interpolation correction with AIRS products containing fillvale in
the data fields
4) Pixel size unit correctiom for (consistency) in conversion and
stitch GUIs.
5) Correction for droping a column when stitching MODIS SIN tiles.
6) Correction to ignoring of Geographic pixel size and processing with
default pixel size
7) Spatial subsetting fix for global AMSR-E garanules, and subsetting
support for other AMSR-E products
8) Correction for ignoring re-projection interpolation type NN after

New Features/problem fixes for v2.8:
1) Addition of Albers Projection.

New Features/problem fixes for v2.7:
1) Support for AMSR-E L3 GRID products in Polar Stereographic and EASE-
Grid projections.

New Features/problem fixes for v2.6:
1) Support for all AMSR-E L2 SWATH products and AMSR-E L3 GRID (in
Geographic projection).
2) Correction for ASTER DEM products. Presently, the sides of the
output GeoTIFF image are
   cut off due to missing data in the internal geolocation fields of
   Since the geolocations are in a path-oriented UTM GRID (even though
it's a SWATH product),
   the missing geolocations could then be accurately interpolated.
3) New "Subsetter" functionality for Parameters (aka Fields). This
results in:
   a) Output to HDF-EOS SWATH from input HDF-EOS SWATH (i.e. for ASTER
      This allows for output data which is unaltered from a projection
operation - for input
      of HDF-EOS SWATH data.
   b) Output to HDF-EOS GRID from input HDF-EOS GRID without any
projection operation or
      altering of input data.

   "Subsetter" functionality allows for the creation of smaller data
sets from large input
   HDF-EOS SWATH or GRID data sets. (Many HDF-EOS data granules are
quite large.)
   This is done by selecting a smaller selection of Fields from the
full list available
   in the input.    A NO_REPROJECTION option is performed so that output
data values are
   unaltered from the input.

   "Subsetter" functionality can also be used in combination with
reprojection, spatial subsetting,
   pixel size manipulation, etc.

4) Output of Multi-Band HDFEOS data sets (multiple bands in one output
HDF-EOS file; previously,
   HEG only outputs one band/field per HDF-EOS output file). Multiple
bands are placed
   in one Object in the HDF-EOS data set.
5) Support of HDF-EOS data which has slight (but important)
descrepancies in the HDF-EOS standard:

   - Support for MOD43C1, MOD43C2, MOD43C3, MCD43C1, MCD43C2, MCD43C3,
MOD12C1, MYD12C1,
     These data sets incorrectly define the corner points of the GRID
in DD instead of DMS units.
     HDF-EOS readers will not be able to read these data unless they
make modifications for this
     non-standard compliance.
   - Support of MOD11_L2. These data use incorrect fillvalues in the
Lat/Lon geolocations.
     The data incorrectly uses -999.0 when the internal metadata
specifies that fillvalues are -999.9.

6) Support for AIRS L3 products (in Geographic projection).
7) Support for MISR L3 products (in Geographic projection).

Possible upcoming new features (further in the future):
- Support of AIRS Level 2 Vis/NIR-Radiance product
- Feature to help work with bit fields in the MOD35_L2 Cloud Product
- MultiBandGeoTIFF for STITCH/MOSAIC output.
- "No Resample" type option (don't do interpolation such as Nearest
   only bin data into cells)
- Synchronize with the new MRT release

Let us know if you have particular interest in some of the above or if
have other suggestions! We appreciate your feedback.

-Abe Taaheri            Abe_Taaheri@raytheon.com
-general support        landover_PGSTLKIT@raytheon.com


Known Problems
Nothing major that we know of at this point.
If you find any bugs, please let us know ASAP. We like to keep the
code as stable as possible
which can be difficult with support of a large number of data products
and quite a bit
of functionality in the software. We appreciate your help!
Abe Taaheri        Abe_Taaheri@raytheon.com
Toolkit            landover_PGSTLKIT@raytheon.com


1) The very useful HDF-EOS Forum that has been shut
down for some time(http://hdfeos.gsfc.nasa.gov/hdfeos/forum/index.cfm)
is resurected
and users are be able to submit questions/answers since October 2009.
visit www.hdfeos.org for Forum registration.

Please also visit the HEG Home Page for announcements and helpful



The tar files follow this format:
hegSUNv2.11.tar.Z - built on Sun Solaris 2.10
hegLNXv2.11.tar.gz - built on Linux Red Hat Enterprise (Linux 2.6.9-
34.ELsmp X86-64 kernel)
hegMACv2.11.tar.gz - built on Macintosh OSX (Darwin Kernel Version
hegWINv2.11.zip    - built on Windows XP (works on Win98, NT, Win XP)

All Java code built using Java Version jdk1.5.0_17-b04 or higher- You
will need
Java jdk1.5.0_17-b04 or higher on your system to run HEG.

PRIMARY DOWNLOAD SITE (browser download):
   The primary download site is now at the HEG HOME Page:

ALTERNATE DOWNLOAD SITE (anonymous ftp download):
To begin download type:

ftp edhs1.gsfc.nasa.gov

Name: anonymous
Password: <your e-mail address>

ftp> cd edhs
ftp> cd HEG_Tool

In this directory are version 2.9 HEG release (9 files), besides some
old releases. They are as follows:

HEG_README_v2.11                  -   This Readme file.
README_INSTALL_Win_v2.11          -   Installation procedure for Windows
hegSUNv2.11.tar.Z                 -   HEG for the Sun/Solaris system.
hegLNXv2.11.tar.gz                -   HEG for the Linux system.
hegWINv2.11.zip                   -   HEG for Windows.
hegMACv2.11.tar.gz                -   HEG for MAC OSX system.
HEG_UsersGuide_v2.11.doc          -   HEG Users Guide in MS-Word format.
HEG_UsersGuide_v2.11.pdf          -   HEG Users Guide in PDF format.
Once in the directory set type to I, download the desired files (based
on your hardware/os), and exit.

ftp> bin
ftp> get heg<make>.tar.Z
ftp> bye

You are done downloading the HEG tar files.   If you want the HEG
Users Guide type:

ftp> get HEG_UsersGuide_v2.11.doc

The Users Guide is also in html format in the help section of the HEG


There are two ways to install HEG on your system:
1. Run the install script
2. Manually install HEG

IMPORTANT: Before installing HEG, make sure you have Java 1.3 or
greater installed on your system.

* Uncompress and extract the files contained in the tar file.

uncompress hegSUNv2.11.tar.Z
tar -xvf hegSUNv2.11.tar
gunzip hegLNXv2.11.tar.gz
tar -xvf hegLNXv2.11.tar
gunzip hegMACv2.11.tar.gz
tar -xvf hegMACv2.11.tar

NOTE: Once the install script runs, it will automatically remove
heg<SUN/LNX/MAC>.tar from your
current directory. If you want to backup this file, now is the time to
do so.

* Run the install script


NOTE: The install script will ask you a series of questions to assist
you in installing HEG on your system

* Once HEG is installed, go to the directory in which you installed
HEG, go to the bin directory, and invoke the HEG script to load up the

For example, if HEG is installed in /home/bob/heg,
cd /home/bob/heg/bin


Make a heg directory in your home directory:

cd $HOME
mkdir heg

Change to the heg directory and copy the tar file to that location.

cd heg
mv (location of tar file/heg<SUN/LNX/MAC>.tar.Z .

Uncompress and extract the files contained in the tar file.

uncompress hegSUNv2.11.tar.Z
tar -xvf hegSUNv2.11.tar
gunzip hegLNXv2.11.tar.gz
tar -xvf hegLNXv2.11.tar
gunzip hegMACv2.11.tar.gz
tar -xvf hegMACv2.11.tar

Please also note that you may uncompress and untar at the same time.
example, on the SUN platform, thi can be done as follows:
 "zcat hegSUNv2.11.tar.Z | tar xvf-"

After uncompressing and extracting, you will get two files, install and
Ignore the install file.

Extract the files contained in the heg.tar file and start HEG.

tar -xvf heg.tar

cd bin

HEG has been installed and should be running.

  NOTE: If you are having problems starting HEG (when typing HEG on the
command line,
         then check that the directory path to JAVA on the local machine
is correct.
         Also, check that the paths in the environment variables are
Installation on Windows XP/VISTA/WINDOWS 7

1. Place the zip file hegWINv2.11.zip or hegWIN2.11_FullCyg.zip in a
directory that does
    NOT HAVE SPACES in the directory pathname. HEG will be installed
under this path tree.
2. Install java (jdk1.4.* or newer windows version).
3. Unzip hegWINv2.10.zip to the current directory.
4. Double click on install.bat and follow the instruction in MS-DOS
window that appears.
5. A file HEGTool.bat will be created by the installation in
HEG\HEG_Win\bin directory.
6. Go to this bin directory, where HEGTool.bat file is, and right
click on HEGTool.bat.
    Click on the Create Shortcut. You can change the icon for this
shortcut as in step 7.
7. Right click on the HEGTool.bat Shortcut. Click on the Properties
and then click on the
    Change Icon. Now click on Browse and select the file "heg.ico" in
the HEG_Win\bin directory.
8. To run HEG Double click on the created shortcut(s) or the
HEGTool.bat in the HEG_Win\bin directory.

To top