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