~ubuntu-branches/ubuntu/precise/yagiuda/precise

« back to all changes in this revision

Viewing changes to man/man5/yagi.5

  • Committer: Bazaar Package Importer
  • Author(s): Joop Stakenborg
  • Date: 2005-08-22 20:20:13 UTC
  • Revision ID: james.westby@ubuntu.com-20050822202013-mhhxp4xirdxrdfx1
Tags: upstream-1.19
ImportĀ upstreamĀ versionĀ 1.19

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
'\" e
 
2
.\" -*- nroff -*-
 
3
.\" This man page must be preprocessed with eqn.
 
4
.ie \n(.g .ds ic \/
 
5
.el .ds ic \^
 
6
.TH YAGI 5 "24th October 2000" "Yagi version 1.16"
 
7
.SH NAME
 
8
yagi \- yagi binary output format
 
9
.SH DESCRIPTION
 
10
This manual page describes the output format of the file created by the
 
11
.IR Yagi-Uda 
 
12
project's 
 
13
.IR yagi
 
14
program. The file is a binary file with a header of 100 bytes. The
 
15
header consists of:
 
16
 
 
17
 
 
18
.nf
 
19
.ul
 
20
offset(bytes)              information          data-type 
 
21
 
 
22
0                          elements             int
 
23
4                          driven               int
 
24
8                          parasitic            int
 
25
12                         min_frequency        double
 
26
20                         max_frequency        double
 
27
28                         design frequency     double
 
28
36                         step_frequency       double
 
29
44                         angular_step         double
 
30
52                         0                    double
 
31
.                          .                      .
 
32
.                          .                      .
 
33
.                          .                      .
 
34
92                         0                    double
 
35
 
 
36
Following the header, there starts the coordinates(x,y,l) of each
 
37
element and the voltage applied to each element. Then we write
 
38
the element currents one after the other, at each frequency.
 
39
Hence the element currents will be written 12,000 times with a
 
40
3 element yagi analysed at 4,000 different frequencies. All complex
 
41
data is stored in a structure of type fcomplex, defined as:
 
42
 
 
43
struct fcomplex {double real, double imaginary};
 
44
 
 
45
.ul
 
46
offset(bytes)              information          data-type 
 
47
 
 
48
100                        x1                   double /* coordinates */
 
49
108                        y1                   double
 
50
116                        l1                   double
 
51
100+(n-1)*24               x_n                  double
 
52
100+(n-1)*24+8             y_n                  double
 
53
100+(n-1)*24+16            l_n                  double
 
54
.............. Repeated for each element.
 
55
100+24*elements            Voltage1             fcomplex  /* voltage */
 
56
100+24*elements+(n-1)*16   Voltage_n            fcomplex
 
57
.............. Repeated for each element n at each frequency step f.
 
58
100+40*elements            Current1@f1          fcomplex /* current */
 
59
100+40*elements+(n-1)*16   Current_n@f1         fcomplex
 
60
 
 
61
100+56*elements            Current@f2           fcomplex
 
62
100+40*elements+(n-1)*16   Current_n@f2         fcomplex
 
63
 
 
64
.SH FILES
 
65
 
 
66
        filename.out                        binary file
 
67
.SH SEE ALSO
 
68
 
 
69
yagi(1), output(1), input(1), optimise(1), first(1) and input(5).
 
70
 
 
71
.SH AUTHORS
 
72
 
 
73
Dr. David Kirkby G8WRB (david.kirkby@onetel.net), with 
 
74
help with converting to DOS from Dr. Joe Mack NA3T (mack@fcrfv2.ncifcrf.gov).