Imported Upstream version 4.6.0
[debian/atlc] / man / man1 / create_bmp_for_stripline_coupler.1
1 .TH create_bmp_for_stripline_coupler 1 "atlc-.4.6.0  6th Dec 2003" "Dr. David Kirkby"
2 .ds n 5
3 .SH NAME
4 \fBcreate_bmp_for_stripline_coupler\fR - bitmap generator for coupler with thin striplines between two infinitely wide groundplanes (part of \fBatlc\fR)
5 .SH SYNOPSIS
6 \fBcreate_bmp_for_stripline_coupler [-C] [-b bitmapsize] [-v] H w s Er outputfile\fR
7 .br
8 .SH WARNING
9 This man page is not a complete set of documentation - the complexity of the atlc project makes man pages not an ideal way to document it, although out of completeness, man pages are produced. 
10 The best documentation that was current at the time the version was produced should be found on your
11 hard drive, usually at 
12 .br
13 /usr/local/share/atlc/docs/html\-docs/index.html 
14 .br
15 although it might be elsewhere if
16 your system administrator chose to install the package elsewhere. Sometimes, errors are corrected
17 in the documentation and placed at http://atlc.sourceforge.net/ before a new release of atlc is
18 released.  Please, if you notice a problem with the documentation - even spelling errors and typos,
19 please let me know. 
20
21 .SH DESCRIPTION
22 \fBcreate_bmp_for_stripline_coupler\fR is a pre-processor for \fBatlc\fR, the finite difference 
23 program that is used to calculate the 
24 properties of a two and three conductor electrical transmission lines of arbitrary 
25 cross section. The program \fBcreate_bmp_for_stripline_coupler\fR is used as a fast way of
26 generating bitmaps (there is no need to use a graphics program), for a
27 pair of 1 pixel thick conductors of width w, spaced a distance s apart, 
28 inside a pair of
29 groundplanes of  separation H. This has an exact analytical
30 answer, when the inner is infinitely thin and the overall width W is infinitely
31 wide. This theoretical impedance is calculated and printed to stderr if 
32 the -v option is given on create_bmp_for_stripline_coupler's command line.
33 .P
34 -----------------------------------------------------  ^
35 .br
36 |                                                   |  |
37 .br                                                     
38 |                  Er                               |  |
39 .br                                                     
40 |                                                   |  |
41 .br                                                     
42 |            -----------       -----------          |  H
43 .br
44 |            <----w----><--s--><----w---->          |  |
45 .br       
46 |                                                   |  |
47 .br
48 |                                                   |  |
49 .br
50 |                                                   |  |
51 .br
52 -----------------------------------------------------  v
53 .br
54 <-------------------------W------------------------->
55 .br
56
57 The overall width W is calculated internally to be large enough that
58 making it any larger will have negligible effect on the results.
59 The dielectric is assumed that of vacuum.
60 .PP 
61 .br
62 The bitmaps produced by \fBcreate_bmp_for_stripline_coupler\fR are 24-bit bit colour bitmaps, as are required by \fBatlc\fR.
63
64 .SH OPTIONS
65 .PP
66 \fB-C \fR
67 .br
68 Print the full copyright information and exit.
69 .PP
70 .br
71 \fB-b bitmapsize\fR
72 .br
73 is used to set the size of the bitmap, and so the accuracy to which atlc
74 is able to calculate the coupler's properties. The default
75 value for 'bitmapsize' is normally 18 although this can be set at
76 compile time. (see 'DEFAULT_COUPLER_BITMAP_SIZE' in definitions.h). The value can be set anywhere from 6 to 28. The size of bitmap produced will be
77 between 2^(bitmapsize-1) and 2^(bitmapsize+1), so if its set to 28 the
78 bitmap could be as big as 512 Mb, which would take an eternity to
79 compute. 
80 .PP
81 \fB-v \fR
82 .br
83 Print some extra data to stdout on the theoretical impedance of the
84 structure. This is useful to compare with the numerical result from
85 \fBatlc\fR
86 .SH EXAMPLES
87 .br
88 In the first example, a standard coupler is created, where the 
89
90
91 eg1. create_bmp_for_stripline_coupler  1.23 0.7 1.2 1.0  coupler.bmp
92 .br
93 eg2. create_bmp_for_stripline_coupler -b 8 1.23 0.7 3.3  small.bmp 
94 .br
95 eg3. create_bmp_for_stripline_coupler -v 12 1.23 0.7 4.8  theory.bmp  
96 .br
97
98
99
100
101
102
103
104
105
106
107
108
109
110 .P
111 .SH SEE ALSO
112 atlc(1)
113 create_bmp_for_circ_in_circ(1)
114 create_bmp_for_circ_in_rect(1)
115 create_bmp_for_microstrip_coupler(1)
116 create_bmp_for_rect_cen_in_rect(1)
117 create_bmp_for_rect_cen_in_rect_coupler(1)
118 create_bmp_for_rect_in_circ(1)
119 create_bmp_for_rect_in_rect(1)
120 create_bmp_for_symmetrical_stripline(1)
121 design_coupler(1)
122 find_optimal_dimensions_for_microstrip_coupler(1)
123 readbin(1)
124 .P 
125 .br
126 http://atlc.sourceforge.net                - Home page 
127 .br
128 http://sourceforge.net/projects/atlc       - Download area
129 .br
130 atlc-X.Y.Z/docs/html-docs/index.html       - HTML docs
131 .br
132 atlc-X.Y.Z/docs/qex-december-1996/atlc.pdf - theory paper
133 .br
134 atlc-X.Y.Z/examples                        - examples
135 .br
136 .SH AUTHOR
137 Dr. David Kirkby PhD, drkirkby at ntlworld.com 
138 .SH "COPYRIGHT"
139 .IX Header "COPYRIGHT"
140 Copyright (c) 2002 Dr. David Kirkby. 
141 .PP
142
143 This program is free software; you can redistribute it and/or
144 modify it under the terms of the GNU General Public License
145 as published by the Free Software Foundation; either version 2
146 of the License, or (at your option) any later version.
147 .pp
148 This program is distributed in the hope that it will be useful,
149 but WITHOUT ANY WARRANTY; without even the implied warranty of
150 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
151 GNU General Public License for more details.
152 .p
153 You should have received a copy of the GNU General Public License (in
154 the file COPYING) along with this program. You may get a full copy of it
155 by running the program with the -C option. Otherwise you can write to the 
156 Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, 
157 MA  02111-1307, USA.