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