HK2D draws curves of HK/SED data as a function of time. It can draw up to four curves on the same time line. It also allows interactive adjustment of titles, labels, limits, and data content. It can produce a PostScript file as output.
To run HK2D use the "java" command:
java HK2D ...
Input data must be in HK-ASCII format (the human-readable
format created by HKQuery by default). These data must be in a single
file which is either specified on the command line or is assumed to be from
stdin if it is not.
The plot drawn by HK2D can be manipulated in a number of
ways using the Pop-up Menu. This menu is obtained by clicking anywhere on the
plot with the left mouse button. Drag the left mouse button to pick any of
the options.
The Pop-up Menu options are described in detail below.
This feature allows the title on the plot to be set (by default there
is no title). Left click anywhere on the plot, then choose the "Plot Title"
option to bring up the Plot Title Dialog. Enter a new title in the text
field and click "OK" to have it become the title of the plot. Clicking
"Cancel" will dismiss the window without changing the title.
The X Axis submenu is labeled with the HK/SED keyword used as the X data
("none" if there is no X data). Picking this menu will bring up the X Axis
Submenu which can be used to minipulate and/or change the X data:
Three menu items are available through the X Axis submenu:
This dialog allows the high and low limits, and the starting label to be
defined by year, day, hour, minute, and second. Label step sizes can be
chosen only in one of these units.
If the X data is not SCET, a limits dialog similar to those used for
the Y axis is used:
Each of the four data curves available on the plot has a submenu associated
with it through which the curve may be manipulated. The popup menu has a
selection for each curve which contains the HK/SED keyword of the data contained
in the curve ("none" if the curve has no data). Drag the left mouse button
through the popup menu selection to get to the submenu.
Four menu items are available on each curve submenu:
Note that the "SCET" is never an option on the "Curve" data menus. SCET can
only be plotted on the X axis.
The right mouse button can be pushed and dragged to define a region of interest
(the region will be drawn as a red overlay square). Once a region has been defined,
the "Zoom In" option can be chosen from the pop-up menu:
The plot will be redrawn with limits matching the defined area:
The "Zoom Out" option can be chosen to return to the previous limits. Repeated
"Zoom In" areas may be defined - HK2D will keep track of the entire
hierarchy so that old limits may be recovered.
If the "Zoom In" option is chosen without a defined region, HK2D will
return to the limits of the most recently defined zoom in area (if it exists).
Repeated calls to "Zoom In" without defining a region will step down in any
existing hierarchy.
By default, HK2D produces Encapsulated PostScript code on demand to stdout.
There are instances where this may not be entirely useful, so a "Print"
option is available from the pop-up menu. This option will bring up the
Print Output window, which allows the name of
the PostScript output to be specified (if you use the name "stdout", HK2D
will assume you want the output to stdout, and not a file called
"stdout"). The printout can be produced in "landscape" format using the
checkbox.
The PostScript file will only be created if the "OK" button is pushed.
Each operation creates a new PostScript file (it does not append to an existing
file), so if you make changes and print multiple times, make sure you specify
a new output file each time if you want to keep all of the print outs.
The HK-ASCII file format allows "events" to be
embedded in the HK/SED data. These events have time stamps, allowing HK2D
to plot them if the X axis corresponds to time (either SCET or SCLK).
Below is a "sample" event as part of an HK-ASCII file. When a commands file is
merged with HK/SED data using HKQuery, the commands are formatted as
events within the HK-ASCII output file. Besides the timestamp in SCET and SCLK
format, an event has three character fields: the "type", the "command", and the
"comment". These are described in more detail in the HK-ASCII
format documentation. In the example below, "SAMPLE" is the "type" field,
"LOOK_AT_THIS" is the "command" field, and "This is a sample command." is the
comment field.
Whether and how events are displayed is controlled from the "Events" menu, available
from the HK2D pop-up menu.
Four menu items are available from the Events Menu:
The plot will then be redrawn to contain all matching events (in this case, only
our one example event matches). Events are drawn on the time line according to their
SCLK value, and are labeled with their "command" field:
To examine the details of a specific event, use the right mouse button to
click on (or near) the event, below the x axis. A pop-up dialog containing
all of the known fields of the event nearest the mouse click will be generated:
While events have been designed to handle merged commands from a command file,
there is no reason they need to be limited to that. If a notation of some
sort is needed on a plot at a position corresponding to a particular time stamp,
a new event can be entered into the HK-ASCII file by hand (which is how the example
above was created). However, the event
must contain all three fields (type, command, and comment) in the proper format.
Consult the HK-ASCII format documentation for more
detail.
The following is a list of command line arguments and a brief
description of what they do:
Pop-up Menu
Plot Title
X Axis Submenu
Curve (1 - 4) Submenus
Zoom In/Out
Print (Encapsulated PostScript Output)
Plotting Events
D 706228949.1340000629 2002/138-22:42:29.134 10122 51191 51099 51172
D 706228979.1340000629 2002/138-22:42:59.134 10122 51190 51099 51173
D 706229009.1340000629 2002/138-22:43:29.134 10123 51190 51099 51173
E 706229009.1348300591 2002/138-16:09:34.496 SAMPLE LOOK_AT_THIS This is a sample command.
D 706229039.1340000629 2002/138-22:43:59.134 10123 51190 51099 51172
D 706229069.1340000629 2002/138-22:44:29.134 10122 51190 51099 51172
D 706229099.1340000629 2002/138-22:44:59.134 10123 51191 51099 51172
D 706229129.1340000629 2002/138-22:45:29.134 10122 51190 51098 51172
Other Features
Command Line Arguments