Browse Source

Reference links to figures seems hard to do in markdown, removed them.

master
Bob Eldering 3 months ago
parent
commit
3081d10e26
1 changed files with 16 additions and 24 deletions
  1. +16
    -24
      README.md

+ 16
- 24
README.md View File

@@ -3,7 +3,7 @@ Introduction

Antab editor is a program to help identify and fix problems with ANTAB
files generated by stations. This document will walk you through the
basic uses of antab editor.
basic uses of antab editor. It is also available in PDF form [here](./README.pdf).

How to start
============
@@ -53,9 +53,6 @@ stations in it, this will be saved to\
The GUI
=======

Figure [1](#fig:overview)
shows the initial window.

![Initial window](doc/overview.png)

Note the tabs at the top of the window: Overview, Polys and one tab for
@@ -67,22 +64,21 @@ Station
![Station tab](doc/station.png)

The station tab has a plot of the ANTAB values on the left and on the
right three section, see Figure [2](#fig:station). The top section shows
the ANTAB header and makes it available for editing. The bottom shows
the ANTAB values in a table. The middle section gives generic options to
edit the ANTAB values.
right three section. The top section shows the ANTAB header and makes it
available for editing. The bottom shows the ANTAB values in a table. The
middle section gives generic options to edit the ANTAB values.

The plot has all the default toolbar buttons of a matplotlib plot to
allow zooming, panning, etc. It has one extra button, represented by the
scissors, which is selected by default. When this tool is selected, you
can drag an area in the plot using the left mouse button to mark the
values to be deleted, see Figure [3](#fig:select).
values to be deleted.

![Marking points to blank](doc/selection.png)

Pressing the delete key, when you are satisfied with the selection, will
blank all values in the selected area. This will be reflected in the
table, see Figure [4](#fig:remove).
table.

![After pressing delete](doc/removed.png)

@@ -97,16 +93,14 @@ play. The top row of that section allows you to fill in missing values
(or just replace all values) for certain columns. The methods available
to do so are interpolation, using the nominal values or copying from
another column. The next row allows you to create new timestamps for
ANTAB values (which will be blank initially). For example, in Figure
[5](#fig:interpolate),
a timestamp was added every 15 seconds, with the new values filled using
interpolation.
ANTAB values (which will be blank initially). For example, in the next
figure, a timestamp was added every 15 seconds, with the new values
filled using interpolation.

![Interpolating every 15 seconds](doc/interpolate.png)

It is also possible to do editing directly in the table. For example you
can select multiple time rows (see Figure [6](#fig:time-select))
and press the delete key to blank these values.
can select multiple time rows and press the delete key to blank these values.

![Selecting multiple time rows](doc/time-selection.png)

@@ -129,8 +123,7 @@ the `<experiment><station>.editor` file, for just this station.
Polys
=====

The "Polys" tab will display each station's gain polynomial in plots,
see Figure [7](#fig:poly).
The "Polys" tab will display each station's gain polynomial in plots.

![The polys tab](doc/poly.png)

@@ -142,12 +135,11 @@ Editing the "Poly" values in the station tab will update the plot in the
Overview
========

With the last tab to discuss, we return to the "Overview" tab, see
Figure [1](#fig:overview). At the top of this tab are two buttons. The
"Generate ANTAB" button will generate the `<experiment>.antab` file from
the current values in all the station tabs. The "Save all" button will
act like pushing the "Save" button in all station tabs, saving all the
`<experiment><station>.editor` files.
With the last tab to discuss, we return to the "Overview" tab. At the top
of this tab are two buttons. The "Generate ANTAB" button will generate
the `<experiment>.antab` file from the current values in all the station
tabs. The "Save all" button will act like pushing the "Save" button in
all station tabs, saving all the `<experiment><station>.editor` files.

The table below those buttons is used to warn for potential problems
with a station: a red box signals such a problem, a green box signals no


Loading…
Cancel
Save