Terrenus HRPT v2.2

terrenus.tools
Class hrptingest

java.lang.Object
  extended by terrenus.tools.hrptingest

public class hrptingest
extends java.lang.Object

The hrptingest program converts the high-resolution radiometer sensor data in a NOAA HRPT or CMA CHRPT raw capture station data file into calibrated, earth-located data in HDF or NetCDF.

Synopsis

hrptingest [OPTIONS] input output

Options:

-h, --help
-i, --informat=TYPE
-f, --outformat=TYPE
-m, --minvalid=COUNT
-o, --origin=STRING
-V, --version
-y, --year=YYYY
-d, --day=DDD
-c, --creationdate

Description

The hrptingest program converts the high-resolution radiometer sensor data in a NOAA HRPT or CMA CHRPT raw capture station data file into calibrated, earth-located data in HDF or NetCDF. Currently, only NOAA KLM and CMA FY1 satellites are supported, including NOAA-15, -16, -17, -18, -19, and FY-1D. AVHRR or MVISR sensor data is quality checked and re-calibrated every 5 lines. In some cases the output data may contain missing scan lines where the corresponding telemetry frame data was corrupt. The output HDF or NetCDF file contains all AVHRR or MVISR channels calibrated to scientific units, as well as earth locations and ancilliary angles. See the various TelemetryStream classes for descriptions of the input formats, and the CWHDFDataWriter and CWNCDataWriter classes for the output format.

Parameters

Main parameters:

input
The input data file name.
output
The output data file name.

Options:

-h, --help
Prints a brief help message.
-i, --informat=TYPE
The input format. The supported formats are:
-f, --outformat=TYPE
The output format. The supported formats are:
-m, --minvalid=COUNT
Specifies the minimum number of consecutive valid data lines at the start and end of the data. Data beyond this boundary is discarded. The default is to write all data lines to the output file. Invalid data lines are detected by examining the frame synchronization words and TIP data parity.
-o, --origin=STRING
Specifies the data origin string for the HDF 'origin' attribute. The default is to write 'unknown' for the origin, which is not very informative.
-V, --version
Prints the software version number.
-y, --year=YYYY
Specifies the four digit year of data capture. By default, the current year is assumed, unless the year can be determined from the input data contents. Currently, only the Quorum and 1A5 formats contain the year.
-d, --day=DDD
Specifies the three digit day of data capture (January 1 = 001). By default, the current day is assumed, unless the day can be determined from the input data contents. Currently, only raw CHRPT requires a day to be specified.
-c, --creationdate
Specifies that the values for year and day of data capture (see -y and -d above) should be obtained from the file creation date. By default the current year and day are assumed unless the date can be determined from the input data contents.

Exit status

0 on success, > 0 on failure. Possible causes of errors:

Examples

The following shows the ingest of HRPT data from a Quorum data file:

   phollema@bean<Data> hrptingest -V
   [hrpt 2.0] hrptingest
   Java 1.5.0_07 on Mac OS X 10.4.9 i386
   phollema@bean<Data> hrptingest 2006-07-14-1905-n18.QuorumHRPT 2006-07-14-1905-n18.hdf       
   hrptingest: Opened Quorum QTrack HRPT telemetry data file with 4426 frames
   hrptingest: Data capture year is 2006
   hrptingest: Detected spacecraft noaa-18 launched 2005/05/20 JD 140
   hrptingest: Data starts at 2006/07/14 JD 195 19:05:25.245 UTC
   hrptingest: Data ends at   2006/07/14 JD 195 19:17:42.745 UTC
   hrptingest: Decoding data from frames 0 through 4425
   hrptingest: Writing avhrr radiometer channel and angle data
 
The CoastWatch Utilities can then be used to query and analyze the data:
   phollema@bean<Data> cwinfo 2006-07-14-1905-n18.hdf
   Contents of file 2006-07-14-1905-n18.hdf
 
   Global information:
     Satellite:           noaa-18
     Sensor:              avhrr
     Date:                2006/07/14 JD 195
     Time:                19:05:25 UTC
     Scene time:          day
     Projection type:     swath
     Origin:              unknown
     Format:              CoastWatch HDF version 3.4
 
   Variable information:
     Variable       Type    Dimensions  Units          Scale     Offset   
     avhrr_ch1      short   4426x2048   percent        0.01      0        
     avhrr_ch2      short   4426x2048   percent        0.01      0        
     avhrr_ch3      short   4426x2048   celsius        0.01      0        
     avhrr_ch4      short   4426x2048   celsius        0.01      0        
     avhrr_ch5      short   4426x2048   celsius        0.01      0        
     avhrr_ch3a     short   4426x2048   percent        0.01      0        
     latitude       float   4426x2048   degrees        -         -        
     longitude      float   4426x2048   degrees        -         -        
     sat_zenith     short   4426x2048   degrees        0.01      0        
     sun_zenith     short   4426x2048   degrees        0.01      0        
     rel_azimuth    short   4426x2048   degrees        0.01      0        
 
   phollema@bean<Data> cwstats --sample 0.01 2006-07-14-1905-n18.hdf
   Variable       Count     Valid     Min        Max        Mean       Stdev    
   avhrr_ch1      90815     90815     1.93       106.77     15.970976  16.357994 
   avhrr_ch2      90815     90815     0.95       123.13     21.458364  15.816578 
   avhrr_ch3      90815     90815     -23.78     64.31      27.48028   13.601457 
   avhrr_ch4      90815     90815     -80.25     51.45      12.980522  20.530457 
   avhrr_ch5      90815     90815     -79.74     46.62      10.031554  20.063936 
   avhrr_ch3a     90815     0         NaN        NaN        NaN        NaN       
   latitude       90815     90815     13.350684  59.875427  37.012815  12.258589 
   longitude      90815     90815     -119.264236 -68.644142 -88.972349 8.879522  
   sat_zenith     90815     90815     0.21       69.11      32.621807  19.494969 
   sun_zenith     90815     90815     5.53       46         24.720583  7.579942  
   rel_azimuth    90815     90815     0          179.99     84.804809  60.840523
 


Constructor Summary
hrptingest()
           
 
Method Summary
static void main(java.lang.String[] argv)
          Performs the main function.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

hrptingest

public hrptingest()
Method Detail

main

public static void main(java.lang.String[] argv)
                 throws java.lang.Exception
Performs the main function.

Throws:
java.lang.Exception

Terrenus HRPT v2.2