Imported Upstream version 4.6.0
[debian/atlc] / man / man1 / create_bmp_for_rect_in_rect.1
1 .TH create_bmp_for_rect_in_rect 1 "atlc-4.5.0 28th Sept 2003" "Dr. David Kirkby"
2 .ds n 5
3 .SH NAME
4 \fBcreate_bmp_for_rect_in_rect\fR - bitmap generator for rectangular conductor inside rectangular conductor (part of \fBatlc\fR)
5 .SH SYNOPSIS
6 \fBcreate_bmp_for_rect_in_rect [options... ] W H a b c d w h Er1 Er2 filename.bmp\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_rect_in_rect\fR is a pre-processor for \fBatlc\fR, the finite difference program that is used to calculate the 
23 properties of a two and three conductor electrical transmission line of arbitrary 
24 cross section. The program \fBcreate_bmp_for_rect_in_rect\fR is used as a fast way of
25 generating bitmaps (there is no need to use a graphics program), for a rectangular conductor inside a rectangular conductor, with two dieletrics, like this:
26 .P
27 -----------------------------------------------------  ^
28 .br
29 |                                                   |  |
30 .br
31 |     <--------------d------------------->          |  |
32 .br
33 |                                                   |  |
34 .br
35 |         <----------w----------->                  |  |
36 .br
37 |         ------------------------   ^              |  |
38 .br
39 |         |                      |   |              |  |
40 .br
41 |         |  Metallic conductor  |   |              |  H
42 .br
43 |<----b-->|  conductor (can be   |   c   Er1        |  |
44 .br
45 |         |  off-centre)         |   |              |  |
46 .br
47 |         |                      |   |              |  |
48 .br
49 |     ------------------------------------ ^        |  |
50 .br
51 |     |..................................| |        |  |
52 .br
53 |     |...Dielectric, permittivity=Er2...| |        |  |
54 .br
55 |<-a->|.....(can be off centre ).........| h        |  |
56 .br
57 |     |..................................| |        |  |
58 .br
59 |     |..................................| |        |  |
60 .br
61 -----------------------------------------------------  |
62 .br
63 <---------------------------W----------------------->
64 .br
65
66 The parameters 'W' and 'H' and the inner dimensions of the outer conductor.
67 The outer dimensions of the inner conductor are 'w' and 'c'. The inner
68 conductor is assumed to rest on a dielectric (Er2) which is 'd' wide and
69 'h' tall. The dielectric is offset 'a' from the left hand side wall of the
70 outer conductor an the inner conductor is offset 'b' from the left hand
71 sidewall of the outer conductor. The whole region is surrounded by a
72 dielectric of relative permittivity 'Er1'. The dielectrics 'Er1' and
73 'Er2' can be different, or the same. If there is just an air dilectric,
74 then 'Er1' and 'Er2' will both be 1.0 
75 .PP 
76 .br
77 The bitmap is printed to the file specifiled as the last argument
78 .P
79 \fBcreate_bmp_for_rect_in_rect -f filename.bmp W H a b c d w h Er1 Er2\fR
80 .P
81 .br
82 The bitmaps produced by \fBcreate_bmp_for_rect_in_rect\fR are 24-bit bit colour bitmaps, as are required by \fBatlc\fR. 
83
84 The permittivities of the bitmap, set by 'Er1' and 'Er2', determine the
85 colours in the bitmap. If Er1 or Er2 is 1.0, 1.0006, 2.1, 2.2, 2.33, 2.5, 3.3,
86 3.335, 3.7, 4.8, 10.2 or 100, then the colour corresponding to that permittivity
87 will be set according to the colours defined in COLOURS below. If Er1
88 is not one of those permittivities, the region of permittivity Er1
89 will be set to the colour 0xCAFF00. If Er2 is not one of those values,
90 then the region of the image will be set to the colour 0xAC82AC. The
91 program \fBatlc\fR does not know what these permittivites are, so they
92 \fBatlc\fR, must be told with the comand line option -d, as in example 4
93 below.
94 .P
95 .SH OPTIONS
96 \fB-b bitmapsize\fR
97 .br
98 is used to set the size of the bitmap, and so the accuracy to which atlc
99 is able to calculate the transmission line's properties. The default
100 value for 'bitmapsize' is normally 4, although this is set at compile
101 time. The value can be set anywhere from 1 to 15, but more than 8 is
102 probably not sensible. 
103 .PP
104 \fB-f outfile\fR
105 .br
106 Set the output filename. By default, the bitmap is sent to stdout, but
107 it *must* be sent to a file, with this option, or as described above. 
108 .P
109 \fB-v \fR
110 .br
111 Causes \fBcreate_bmp_for_rect_in_rect\fR to print some data to stderr. Note, nothing
112 extra goes to standard output, as that is expected to be redirected to a
113 bitmap file.
114
115 .SH COLOURS
116 The 24-bit bitmaps that \fBatlc\fR expects, have 8 bits assigned 
117 to represent the amount of red, 8 for blue and 8 for green. Hence there are 
118 256 levels of red, green and blue, making a total of 256*256*256=16777216 colours. 
119 Every one of the possible 16777216 colours can be defined precisely by the stating the exact amount 
120 of red, green and blue, as in:
121 .PP
122 .br
123 red         = 255,000,000 or 0xff0000
124 .br
125 green       = 000,255,000 or 0x00ff00
126 .br
127 blue        = 000,000,255 or 0x0000ff
128 .br
129 black       = 000,000,000 or 0x000000
130 .br
131 white       = 255,255,255 or 0xffffff
132 .br
133 Brown       = 255,000,255 or 0xff00ff 
134 .br
135 gray        = 142,142,142 or 0x8e8e8e
136 .PP
137 Some colours, such as pink, turquoise, sandy, brown, gray etc may mean slightly
138 different things to different people. This is not so with \fBatlc\fR, as the 
139 program expects the colours below to be EXACTLY defined as given. Whether 
140 you feel the colour is sandy or yellow is up to you, but if you use it in 
141 your bitmap, then it either needs to be a colour recognised by atlc, \fBor\fR
142 you must define it with a command line option (see OPTIONS and example 5
143 below).
144 .br
145 red    = 255,000,000 or 0xFF0000 is the live conductor. 
146 .br
147 green  = 000,255,000 or 0x00FF00 is the grounded conductor. 
148 .br
149 blue   = 000,000,000 or 0x0000FF is the negative conductor 
150 .PP
151 All bitmaps \fBmust\fR have the live (red) and grounded (green) conductor. The blue
152 conductor is not currently supported, but it will be used to indicate a 
153 negative conductor, which will be needed if/when the program gets extended 
154 to analyse directional couplers. 
155 .PP
156 The following dielectrics are recognised by \fRatlc\fB and so are
157 produced by \fRcreate_bmp_for_rect_cen_in_rect\fB. 
158 .PP
159 .br
160 white     255,255,255 or 0xFFFFFF as Er=1.0    (vacuum)
161 .br
162 pink      255,202,202 or 0xFFCACA as Er=1.0006 (air)
163 .br
164 L. blue   130,052,255 or 0x8235EF as Er=2.1    (PTFE)
165 .br
166 Mid gray  142,242,142 or 0x8E8E8E as Er=2.2    (duroid 5880)
167 .br
168 mauve     255.000,255 or 0xFF00FF as Er=2.33  (polyethylene)
169 .br
170 yellow    255,255,000 or 0xFFFF00 as Er=2.5    (polystyrene)
171 .br
172 sandy     239,203,027 or 0xEFCC1A as Er=3.3    (PVC)
173 .br
174 brown     188,127,096 or 0xBC7F60 as Er=3.335  (epoxy resin)
175 .br
176 Turquoise 026,239,179 or 0x1AEFB3 as Er=4.8    (glass PCB)
177 .br
178 Dark gray 142,142,142 or 0x696969 as Er=6.15   (duroid 6006)
179 .br
180 L. gray   240,240,240 or 0xDCDCDC as Er=10.2  (duroid 6010)
181 .br
182 D. orange 213,160,067 or 0xD5A04D as Er=100.0 (mainly for test purposes)
183 .br
184 .br
185 .SH EXAMPLES
186 Here are a few examples of the use of \fBcreate_bmp_for_rect_in_rect\fR. Again, see the html documentation in atlc-X.Y.Z/docs/html-docs/index.html for more examples.     
187 .P
188 In the first example, there is just an air dielectric, so Er1=Er2=1.0.
189 The inner of 1x1 inches (or mm, miles etc) is placed centrally in an
190 outer with dimensions 3 x 3 inches. 
191
192 The exact place where the dielectric starts (a) and its width (d) are
193 unimportant, but they must still be entered. 
194
195 \fB% create_bmp_for_rect_in_rect 3 3 1 1 1 1 1 1 > ex1.bmp
196 .br
197 % atlc ex1.bmp\fR
198
199 In this second example, an inner of 15.0 mm x 0.5 mm is surrounded by an
200 outer with internal dimensions of 61.5 x 20.1 mm. There is a material
201 with permittivity 2.1 (Er of PTFE) below the inner conductor. The output
202 from \fBcreate_bmp_for_rect_in_rect\fR is sent to a file ex1.bmp, which is then processed by
203 \fBatlc\fR 
204
205 \fB% create_bmp_for_rect_in_rect 61.5 20.1 5 22 0.5 50 15 5 1.0 2.1 > ex2.bmp\fR
206 .br
207 \fB% atlc ex2.bmp\fR
208 .br
209
210 In example 3, the bitmap is made larger, to increase accuracy, but
211 otherwise this is identical to the second example. 
212 \fB% create_bmp_for_rect_in_rect -b7 61.5 20.1 5 22 0.5 50 15 5 1.0 2.1 > ex3.bmp\fR
213 .br
214 \fB% atlc ex3.bmp\fR
215 .br
216 .P
217 In the fourth example, materials with permittivites 2.78 and 7.89 are
218 used. While there is no change in how to use \fBcreate_bmp_for_rect_in_rect\fR, since
219 these permittivities are not known, we must tell \fBatlc\fR what they
220 are.
221 \fB
222 % create_bmp_for_rect_in_rect 61 20 1 4 22 0.5 50 15 5 2.78 7.89 > ex5.bmp
223 % atlc -d CAFF00=2.78 -d AC82AC=7.89 ex5.bmp
224 \fR
225 In the sixth and final example, the -v option is used to print some
226 extra data to stderr from \fBcreate_bmp_for_rect_in_rect\fR. 
227 .
228 .SH SEE ALSO
229 atlc(1)
230 create_bmp_for_circ_in_circ(1)
231 create_bmp_for_circ_in_rect(1)
232 create_bmp_for_microstrip_coupler(1)
233 create_bmp_for_rect_cen_in_rect(1)
234 create_bmp_for_rect_cen_in_rect_coupler(1)
235 create_bmp_for_rect_in_circ(1)
236 create_bmp_for_stripline_coupler(1)
237 create_bmp_for_symmetrical_stripline(1)
238 design_coupler(1)
239 find_optimal_dimensions_for_microstrip_coupler(1)
240 readbin(1)
241 .P 
242 .br
243 http://atlc.sourceforge.net                - Home page 
244 .br
245 http://sourceforge.net/projects/atlc       - Download area
246 .br
247 atlc-X.Y.Z/docs/html-docs/index.html       - HTML docs
248 .br
249 atlc-X.Y.Z/docs/qex-december-1996/atlc.pdf - theory paper
250 .br
251 atlc-X.Y.Z/examples                        - examples