timelineplot

The timeline checking tool, timelineplot, was written in IDL by R Ewald and has a perl wrapper written by R Laher.
  1. The tool has a few requirements:
    1. The maximum length of planfile names is 22 characters.
    2. Planfile names must have one of these strings in the name to be recognised. The names may be upper or lower case; it doesn't matter.

      3. CALIB, LMC, SURV, SHAD, AIPRI1, AIPRI2, AIPRI3, FILL, SGFILL, CATCH, AUTO, IOC, IOCSCI, IOCAI, NOSLEW, GYROCAL, CONSTR, MCM, WAL, POK, IOCCAL
    3. The directory where the timeline files reside must have only one *.tdata.* and only one *.data.* file.
    4. You must know the path to the valid ADFsummary table that is to be used with the timelines you are checking. Right now, the ADFs are changing, so you will get wrong flags for duration violations if you use the wrong ADFsummary table.
  2. The colors are volatile; your session might not generate the same colors as mine. If your display is unsatisfactory, try getting rid of your netscape or other color intensive windows, display the timelineplot.ps file, and then start the other tools. This has been useful in some cases.
  3. To execute this tool, you may be in any directory that you have permissions to write in. You do not need to set environments or invoke IDL.
    4.                         timelineplot -tp /Pathtotimelinedata
                                     -ap /PathtoADFsummarytable
                                     -o outputpostscriptfilename
    The -tp and -ap command-line inputs are required. The -o command-line input is optional; if not specified, the default output file name is timelineplot.ps and is located in the current directory.
    If you are in the directory specified by -tp, and you use "." as the value for -tp, then the plot titles will end with a . instead of the version number. To get the correct directory in the title, use either the absolute path name, or ../dirofdata.
UPDATE 19 FEB 1999
Timelineplot now has many of the features you've been asking for.
  1. You asked for the day of the timeline

    2. Just above the first table, there is a line that says "Scheduled Tiles beginning at x.xxxxx day of timeline" X.xxxxx is the decimal day of the timeline. In other words, the integer part indicates which part of the timelinefile, (like I99058REGOTL.0X) and the decimal indicates the END of the first tile. (This is how the tile is assigned to an orbit, by where it ends (not where it begins). Each tile is only in one orbit, so if you are looking for one around the ascending node and don't see it, it may be on the previous or next orbit.)
  2. You wanted to know whether the flagged duration was too large or too small.

    3. Now you will notice that in addition to a different color (hopefully red) there is either a "v" or a "^" next to the duration. The "v" indicates the duration was too short, and the "^" indicates it is too long. Right now, we do not have correct upper values, so it is my understanding that you can ignore durations flagged with an "^".
  3. Nobody noticed the missing orbits!!!

    4. In some of the timelines (ok, in at least one) there were no files planned for some of the orbits. Of course, the scheduler correctly put in auto-filler tiles, but timelineplot did not display these orbits. I have fixed this, and you may see some odd plots with nothing at all in the upper box, and all auto-fillers in the lower box. This is correct. There is also a note in red at the bottom of the page, telling you there were no tiles planned, just so you know it's not an accident.
UPDATE 16 MAR 1999
This software is being wrapped up and put away. Maybe it will be revived for another mission - "WIRE II"? or perhaps some other. These are the programmer notes, I hope these will help whomever inherits this software. Sorry about the lack of structure in the software; also there may be some variables that never actually get used. We were developing in a hurry!Also, to find out how we defined "MJD" look at mjd notes MJD stands for Modified Julian Day, but it is defined in a peculiar way. This was an endless source of confusion for quite a while!

Top level (0):

timelineplot is a perl routine developed by Russ Laher to wrap around my idl code. There are three inputs, -tp, -ap, and -o.
-o is optional, and is the path of where to put the output ps file
-tp is required, and is the path of where to find the data files
-ap is required, and is the path of where to find the ADFsummary.tbl3 file

timelineplot produces a temporary file called timelineplot.inp which contains the paths the user specifies. This file is used by the next level IDL routine, and deleted as the perl program exits. timelineplot also creates a logfile, which the user may delete when the script runs sastisfactorily. The primary output file is called timelineplot.ps by default (unless the -o switch is specified). This is a standard (color) postscript file, and may be viewed or printed as such. Be aware that there will be ~15 pages per day of the timeline.

Next level (1):

timelineplot.pro is a mainlevel IDL routine. It reads the timelineplot.inp file to determine where to find the various files it needs to pass on to subtimelineplot.pro. This routine is merely another wrapper to enable subtimelineplot.pro and its subroutines to run from the command line.

Next level (2):

subtimelineplot.pro is the workhorse of this group. It calls:
readplan.pro
readcol.pro *
boxboy.pro
info.pro
summary.pro
key.pro
plancolor.pro

* readcol.pro is in the astrolib library of IDL routines. All other routines were written by me.

Details about level (2):

subtimelineplot.pro
first reads all the input files. tfile is the planned data file, sfile is the scheduled datafile, and adffile is the ADFsummary.tbl3 file. Then, for each orbit, it sequentially selects, orders, and otherwise manipulates the variables read in from the data files. It also determines the name of the timeline directory and the first day of the timeline.
It first plots the planned data (if any) and color codes it by planfile, and positions it by priority and position angle on the orbit. Next, the scheduled data is plotted in the same manner. Each tile is marked with an index number which is consistent between the plots within the orbit, and the tables printed on the page. The two tables are printed by subroutines.
Summary.pro prints the information about the scheduled tiles, and info.pro prints the information about the planned but unscheduled tiles below. Finally, a key indicating the color code for each planfile is printed.

readplan.pro
was written to read the files created by David Henderson which are in spreadsheet format. The columns are tab-separated, and there may be comments. This routine handles both conditions.

readcol
is from the astrolib idl library. It is simple and easy to run. Although it is not very fast for large files, in the right situations it is better than creating new code.

boxboy.pro
is a utility to quickly determine the parameters of a box (tile) to be drawn. Given the two x coordinates (beg, last), the priority, and the half-height, it will return two vectors of x, y, and the center of the box.

info.pro
prints a table of information about the tiles that didn't get scheduled. The index for each line corresponds to the numbers on the tiles in the upper plot.
The table headings are:
Ind - the index number
AreaID - given by the planners
RA, DEC - regular coordinates
ObsID - this is an incomplete obsid because the tile has not been scheduled
Beg, End, Dur - are in degrees of orbit angle as given in tfile. Beg corresponds to "lambda_beginsettle_d", End corresponds to "lambda_term_d" and Dur is the difference. These will differ from reports by Fan and Wen. See Fan's notes on duration.
Planfile - source_planfile
Note - first two characters of the Note field
Truncatable - 0=no, 1=yes. Not the same as Truncated.

summary.pro
Similar to info, except it gives information about the tiles that were scheduled. Since it is the first table on the page, it also lists what day of the timeline this orbit is for. It runs timecheck, to see if the durations (in seconds) are within the allowed range. The allowed range is in the file ADFsummary.tbl3. The index for each line corresponds to the numbers on the tiles in both plots.
The table headings are:
Ind - the index number
AreaID - given by the planners
Planned angles (beg, end, dur) - Same as in info.pro
Scheduled angles (beg, end, dur) - Same is in info.pro, except these are taken from sfile.
Scheduled times (daynumber)(beg, end, dur) - Corresponds to mjd_beginsettle, mjd_term, and the difference. Beg and End both are mod 360 so that the integer part of the day corresponds to an actual day of year number. Dur is obtained by finding the difference (before doing the mod360) and multiplying it by 86400(number of seconds in a day). The Dur column is shown with some numbers in red (we hope it's red) and either a caret (^) or lower case "v" next to it. The red indicates if it is out of the allowed range, and the ^ indicates if the duration is too great, while the "v" indicates if it is too small.

key.pro
is a very simple utility that creates the color key for the plot. Because the colors change from terminal to terminal, we need to have a current key. This key shows what color each plan file is coded.

plancolor.pro
looks at the planfile associated with the particular tile and assigns it a color for plotting.
 

Next level (3):

timecheck.pro
is the utility that checks the allowed range of duration (seconds) in summary.pro. It compares the durations to the values in the ADFsummary.tbl3 file, and assigns flags (of color) and adds a string of " ^" or " v" to the offending values.

This page last updated March 17, 1999. Component pages may have been updated since.

Page maintained by Rosalie Ewald

URL: http://spider.ipac.caltech.edu/staff/rosalie/fin_timelineplot.html
 

Return to Home Page