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