AEMKEHK (May 2007)             ftools.suzaku             AEMKEHK (May 2007)

NAME
    aemkehk -- create an extended HK file from orbit and attitude files

USAGE
    aemkehk outfile orbit attitude reference

DESCRIPTION

    Create an extended HK file for Suzaku,reading satellite
    attitude and orbit files.
    The output .ehk file has the following columns.

-- NAME ----  TYPE UNIT --- ---------- COMMENT-------------------------------
"TIME"        "1D" "s"      "mission time (s)" 
"YYYYMMDD"    "1J" ""       "year*10000 + month*100 + day"
"HHMMSS"      "1J" ""       "hour*10000 + minute*100 + second"
"EULER1"      "1E" "deg"    "satellite Euler angles phi (deg)"
"EULER2"      "1E" "deg"    "satellite Euler angles theta (deg)"
"EULER3"      "1E" "deg"    "satellite Euler angles psi (deg)"
"FOC_RA"      "1E" "deg"    "R.A.(J2000) of FOC center pos (deg)"
"FOC_DEC"     "1E" "deg"    "DEC.(J2000) of FOC center pos (deg)"
"FOC_ROLL"    "1E" "deg"    "roll angle of FOC coordinates (deg)"
"DLT_RA"      "1E" "arcmin" "difference from mean R.A. (arcmin)"
"DLT_DEC"     "1E" "arcmin" "difference from mean DEC. (arcmin)"
"DLT_ROLL"    "1E" "deg"    "difference from mean roll angle (deg)"
"ANG_DIST"    "1E" "arcmin" "distance from mean pointing pos (arcmin)"
"SAT_ALT"     "1E" "km"     "altitude of satellite orbit from earth (km)"
"SAT_LON"     "1E" "deg"    "longitude of satellite orbit (deg)"
"SAT_LAT"     "1E" "deg"    "latitude of satellite orbit (deg)"
"ELV"         "1E" "deg"    "earth elevation of FOC center pos (deg)"
"DYE_ELV"     "1E" "deg"    "day earth elev. of FOC center pos (deg)"
"NTE_ELV"     "1E" "deg"    "night earth elev. of FOC center pos (deg)"
"SUN_ALT"     "1E" "deg"    "altitude of the sun from the earth rim (deg)"
"T_DY_NT"     "1E" "s"      "time after day <-> night transision (s)"
"TN_DY_NT"    "1E" "s"      "time to next day <-> night transision (s)"
"COR"         "1E" "GV"     "cut off rigidity (GV) with old table"
"COR2"        "1E" "GV"     "cut off rigidity (GV) with new table"
"SAA"         "1B" ""       "passage of South Atlantic Anomaly (0->3:deep)"
"T_SAA"       "1E" "s"      "time after SAA passage (s)"
"TN_SAA"      "1E" "s"      "time to next SAA passage (s)"
"SAA_HXD      "1B" ""       "passage of South Atlantic Anomaly for HXD"
"T_SAA_HXD"   "1E" "s"      "time after SAA passage for HXD (s)"
"TN_SAA_HXD"  "1E" "s"      "time to next SAA passage for HXD (s)"
"ZGMAG_ANG"   "1E" "deg"    "z-axis angle of geomagnetic field (deg)"
"ZGMAG_PHI"   "1E" "deg"    "z-axis roll of geomagnetic field (deg)"
"ZE_ANG"      "1E" "deg"    "z-axis angle to center of the Earth (deg)"
"ZE_PHI"      "1E" "deg"    "z-axis roll to Earth center direction (deg)"},
-----------------------------------------------------------------------------

    Step of the TIME column is copied from a reference file,
    or specified by a user with start, stop and step time.
    The orbit file must cover the entire time range with abount
    +/- one day margin, in order to calculate T_SAA, TN_SAA, etc.


PARAMETERS

outfile [filename]
    Output .ehk file name.

orbit [filename]
    Input orbit file

attitude [filename]
    Input attitude file

reference [filename]
    Time reference file, or 'NONE' to specify start, stop and step time

(teldef = CALDB) [filename]
    Location of telescope definition file

(leapfile = CALDB;$ENV{LHEA_DATA}/leapsec.fits) [file name]
    Name of the leap second file. The default value is set to
    indicate that aemkehk will search for the file in CALDB first
    and then in the LHEA_DATA directory if necessary (the actual path
    for the HEADAS installation in use will be shown).

(rigidity = CALDB;$ENV{LHEA_DATA}/rigidity_20060421.fits) [file name]
    Location of the FITS rigidity data file for COR2 column, specified
    similarly to the leap second file.

(time_col_name = TIME) [string]
    Time column name of the time reference file.  Used when reference=filename

start_time [real]
    Start time (when reference=NONE), or 0.0 to get from input attitude file

stop_time [real]
    Stop time (when reference=NONE), or 0.0 to get from input attitude file

step_sec [real] 
    Step time in seconds (when reference=NONE)

margin_sec [real] 
    Margin time before and after the specified in seconds, when reference=NONE

(clobber = yes) [boolean]
    Overwrite output file if exists?

(anl_verbose = 0) [integer]
    ANL verbose level (-1:full, 0:minimum)

(anl_profile = no) [integer]
    Enable ANL module profiling

(num_event = -1) [integer]
    Number of event (-1=all, 0=exit)

(event_freq = 10000) [integer]
    Event number printout frequency

(chatter = 2) [integer]
    message chatter level (0:min,2:norm,5:max)


EXAMPLES

1    Create an .ehk file of "ae123456789.ehk",
     reading an orbit file of "ae123456789.orb"
     and an attitude file of "ae123456789.att".
     Step of the time column is copied from "reference.hk".

    % aemkehk output=ae123456789.ehk orbit=ae123456789.orb \ 
       attitude=ae123456789.att reference=reference.hk


2    Create an .ehk file of "ae123456789.ehk",
    reading an orbit file of "ae123456789.orb".
    and an attitude file of "ae123456789.att".
    Start and stop time are get from attitude file "ae123456789.att",
    and the step is specified as 1.0 seconds.

    % aemkehk output=ae123456789.ehk orbit=ae123456789.orb \
    attitude=ae123456789.att reference=none start_time=0 \
    end_time=0 step_sec=1.margin_sec=0

BUGS 

None reported

SEE ALSO 

    none

AUTHOR

    This program was developed primarily in the ASTRO-E ANL environment by 
    Yoshitaka Ishisaki (TMU).

LAST MODIFIED

    May 2007