Imported Upstream version 4.6.0
[debian/atlc] / docs / html-docs / create_bmp_for_rect_in_rect.1.html
1 <HTML>
2 <BODY>
3 <PRE>
4 <!-- Manpage converted by man2html 3.0.1 -->
5
6 </PRE>
7 <H2>NAME</H2><PRE>
8      <B>create_bmp_for_rect_in_rect</B> - bitmap generator for rectangu-
9      lar conductor inside rectangular conductor (part of <B>atlc</B>)
10
11
12 </PRE>
13 <H2>SYNOPSIS</H2><PRE>
14      <B>create_bmp_for_rect_in_rect</B> <B>[options...</B> <B>]</B> <B>W</B> <B>H</B> <B>a</B> <B>b</B> <B>c</B>  <B>d</B>  <B>w</B>  <B>h</B>
15      <B>Er1</B> <B>Er2</B> <B>filename.bmp</B>
16
17
18 </PRE>
19 <H2>WARNING</H2><PRE>
20      This man page is not a complete set of documentation  -  the
21      complexity  of the atlc project makes man pages not an ideal
22      way to document it, although out of completeness, man  pages
23      are produced. The best documentation that was current at the
24      time the version was produced should be found on  your  hard
25      drive, usually at
26      /usr/local/share/atlc/docs/html-docs/index.html
27      although it might be elsewhere if your system  administrator
28      chose  to  install  the package elsewhere. Sometimes, errors
29      are  corrected  in   the   documentation   and   placed   at
30      http://atlc.sourceforge.net/ before a new release of atlc is
31      released.  Please, if you notice a problem with the documen-
32      tation - even spelling errors and typos, please let me know.
33
34
35
36 </PRE>
37 <H2>DESCRIPTION</H2><PRE>
38      <B>create_bmp_for_rect_in_rect</B> is a pre-processor for <B>atlc</B>, the
39      finite difference program that is used to calculate the pro-
40      perties of a two and three conductor electrical transmission
41      line    of    arbitrary    cross    section.   The   program
42      <B>create_bmp_for_rect_in_rect</B> is used as a fast  way  of  gen-
43      erating  bitmaps  (there  is  no need to use a graphics pro-
44      gram), for a rectangular conductor inside a rectangular con-
45      ductor, with two dieletrics, like this:
46
47      -----------------------------------------------------  ^
48      |                                                   |  |
49      |     &lt;--------------d-------------------&gt;          |  |
50      |                                                   |  |
51      |         &lt;----------w-----------&gt;                  |  |
52      |         ------------------------   ^              |  |
53      |         |                      |   |              |  |
54      |         |  Metallic conductor  |   |              |  H
55      |&lt;----b--&gt;|  conductor (can be   |   c   Er1        |  |
56      |         |  off-centre)         |   |              |  |
57      |         |                      |   |              |  |
58      |     ------------------------------------ ^        |  |
59      |     |..................................| |        |  |
60      |     |...Dielectric, permittivity=Er2...| |        |  |
61      |&lt;-a-&gt;|.....(can be off centre ).........| h        |  |
62      |     |..................................| |        |  |
63      |     |..................................| |        |  |
64      -----------------------------------------------------  |
65      &lt;---------------------------W-----------------------&gt;
66
67      The parameters 'W' and 'H' and the inner dimensions  of  the
68      outer  conductor.  The outer dimensions of the inner conduc-
69      tor are 'w' and 'c'. The inner conductor is assumed to  rest
70      on  a dielectric (Er2) which is 'd' wide and outer conductor
71      an the inner conductor is offset  'b'  from  the  left  hand
72      sidewall  of  the  outer conductor. The whole region is sur-
73      rounded by a dielectric of relative permittivity 'Er1'.  The
74      dielectrics 'Er1' and then 'Er1' and 'Er2' will both be 1.0
75
76      The bitmap is printed to the file  specifiled  as  the  last
77      argument
78
79      <B>create_bmp_for_rect_in_rect</B> <B>-f</B> <B>filename.bmp</B> <B>W</B> <B>H</B> <B>a</B> <B>b</B> <B>c</B> <B>d</B> <B>w</B>  <B>h</B>
80      <B>Er1</B> <B>Er2</B>
81
82      The bitmaps produced by <B>create_bmp_for_rect_in_rect</B> are  24-
83      bit bit colour bitmaps, as are required by <B>atlc</B>.
84
85      The permittivities of the bitmap, set by  'Er1'  and  'Er2',
86      determine  the  colours in the bitmap. If Er1 or Er2 is 1.0,
87      1.0006, 2.1, 2.2, 2.33, 2.5, 3.3, 3.335, 3.7, 4.8,  10.2  or
88      100, then the colour corresponding to that permittivity will
89      be set according to the colours defined in COLOURS below. If
90      Er1  is  not one of those permittivities, the region of per-
91      mittivity Er1 will be set to the colour 0xCAFF00. If Er2  is
92      not  one  of those values, then the region of the image will
93      be set to the colour 0xAC82AC. The  program  <B>atlc</B>  does  not
94      know  what  these  permittivites  are, so they <B>atlc</B>, must be
95      told with the comand line option -d, as in example 4 below.
96
97
98 </PRE>
99 <H2>OPTIONS</H2><PRE>
100      <B>-b</B> <B>bitmapsize</B>
101      is used to set the size of the bitmap, and so  the  accuracy
102      to  which  atlc is able to calculate the transmission line's
103      properties. The default value for 'bitmapsize'  is  normally
104      4,  although  this  is set at compile time. The value can be
105      set anywhere from 1 to 15, but more than 8 is  probably  not
106      sensible.
107
108      <B>-f</B> <B>outfile</B>
109      Set the output filename. By default, the bitmap is  sent  to
110      stdout,  but  it *must* be sent to a file, with this option,
111      or as described above.
112
113      <B>-v</B>
114      Causes <B>create_bmp_for_rect_in_rect</B> to  print  some  data  to
115      stderr. Note, nothing extra goes to standard output, as that
116      is expected to be redirected to a bitmap file.
117
118
119
120 </PRE>
121 <H2>COLOURS</H2><PRE>
122      The 24-bit bitmaps that <B>atlc</B> expects, have 8  bits  assigned
123      to  represent the amount of red, 8 for blue and 8 for green.
124      Hence there are 256 levels of red, green and blue, making  a
125      total of 256*256*256=16777216 colours. Every one of the pos-
126      sible 16777216 colours can be defined precisely by the stat-
127      ing the exact amount of red, green and blue, as in:
128
129      red         = 255,000,000 or 0xff0000
130      green       = 000,255,000 or 0x00ff00
131      blue        = 000,000,255 or 0x0000ff
132      black       = 000,000,000 or 0x000000
133      white       = 255,255,255 or 0xffffff
134      Brown       = 255,000,255 or 0xff00ff
135      gray        = 142,142,142 or 0x8e8e8e
136
137      Some colours, such as pink, turquoise,  sandy,  brown,  gray
138      etc  may mean slightly different things to different people.
139      This is not so with <B>atlc</B>, as the program expects the colours
140      below  to  be EXACTLY defined as given. Whether you feel the
141      colour is sandy or yellow is up to you, but if you use it in
142      your  bitmap, then it either needs to be a colour recognised
143      by atlc, <B>or</B> you must define it with a  command  line  option
144      (see OPTIONS and example 5 below).
145      red    = 255,000,000 or 0xFF0000 is the live conductor.
146      green  = 000,255,000 or 0x00FF00 is the grounded conductor.
147      blue   = 000,000,000 or 0x0000FF is the negative conductor
148
149      All bitmaps <B>must</B> have the live (red)  and  grounded  (green)
150      conductor.  The  blue  conductor is not currently supported,
151      but it will be used to indicate a negative conductor,  which
152      will  be needed if/when the program gets extended to analyse
153      directional couplers.
154
155      The following dielectrics are recognised by atlc <B>and</B> <B>so</B>  <B>are</B>
156      <B>produced</B> <B>by</B> create_bmp_for_rect_cen_in_rect<B>.</B>
157
158      white     255,255,255 or 0xFFFFFF as Er=1.0    (vacuum)
159      pink      255,202,202 or 0xFFCACA as Er=1.0006 (air)
160      L. blue   130,052,255 or 0x8235EF as Er=2.1    (PTFE)
161      Mid gray  142,242,142 or 0x8E8E8E as Er=2.2    (duroid 5880)
162      mauve     255.000,255 or 0xFF00FF as Er=2.33  (polyethylene)
163      yellow    255,255,000 or 0xFFFF00 as Er=2.5    (polystyrene)
164      sandy     239,203,027 or 0xEFCC1A as Er=3.3    (PVC)
165      brown     188,127,096 or 0xBC7F60 as Er=3.335  (epoxy resin)
166      Turquoise 026,239,179 or 0x1AEFB3 as Er=4.8    (glass PCB)
167      Dark gray 142,142,142 or 0x696969 as Er=6.15   (duroid 6006)
168      L. gray   240,240,240 or 0xDCDCDC as Er=10.2  (duroid 6010)
169      D. orange 213,160,067 or 0xD5A04D as  Er=100.0  (mainly  for
170      test purposes)
171
172
173
174 </PRE>
175 <H2>EXAMPLES</H2><PRE>
176      Here   are    a    few    examples    of    the    use    of
177      <B>create_bmp_for_rect_in_rect</B>.  Again, see the html documenta-
178      tion in atlc-X.Y.Z/docs/html-docs/index.html for more  exam-
179      ples.
180
181      In the first example, there is just an  air  dielectric,  so
182      Er1=Er2=1.0.   The inner of 1x1 inches (or mm, miles etc) is
183      placed centrally in an outer with dimensions 3 x 3 inches.
184
185      The exact place where the  dielectric  starts  (a)  and  its
186      width (d) are unimportant, but they must still be entered.
187
188      <B>%</B> <B>create_bmp_for_rect_in_rect</B> <B>3</B> <B>3</B> <B>1</B> <B>1</B> <B>1</B> <B>1</B> <B>1</B> <B>1</B> <B>&gt;</B> <B>ex1.bmp</B>
189      <B>%</B> <B>atlc</B> <B>ex1.bmp</B>
190
191      In this second example, an inner of 15.0 mm x 0.5 mm is sur-
192      rounded  by an outer with internal dimensions of 61.5 x 20.1
193      mm. There is a material with permittivity 2.1 (Er  of  PTFE)
194      below    the    inner    conductor.    The    output    from
195      <B>create_bmp_for_rect_in_rect</B> is sent to a file ex1.bmp, which
196      is then processed by <B>atlc</B>
197
198      <B>%</B> <B>create_bmp_for_rect_in_rect</B> <B>61.5</B> <B>20.1</B> <B>5</B> <B>22</B> <B>0.5</B> <B>50</B> <B>15</B> <B>5</B> <B>1.0</B>
199      <B>2.1</B> <B>&gt;</B> <B>ex2.bmp</B>
200      <B>%</B> <B>atlc</B> <B>ex2.bmp</B>
201
202      In example 3, the bitmap is made larger, to  increase  accu-
203      racy, but otherwise this is identical to the second example.
204      <B>%</B> <B>create_bmp_for_rect_in_rect</B> <B>-b7</B> <B>61.5</B> <B>20.1</B> <B>5</B> <B>22</B> <B>0.5</B> <B>50</B> <B>15</B> <B>5</B>
205      <B>1.0</B> <B>2.1</B> <B>&gt;</B> <B>ex3.bmp</B>
206      <B>%</B> <B>atlc</B> <B>ex3.bmp</B>
207
208      In the fourth example, materials with permittivites 2.78 and
209      7.89  are  used.  While  there  is  no  change in how to use
210      <B>create_bmp_for_rect_in_rect</B>, since these permittivities  are
211      not known, we must tell <B>atlc</B> what they are.
212
213      <B>%</B> <B>create_bmp_for_rect_in_rect</B> <B>61</B> <B>20</B> <B>1</B> <B>4</B> <B>22</B> <B>0.5</B> <B>50</B> <B>15</B> <B>5</B>  <B>2.78</B>
214      <B>7.89</B> <B>&gt;</B> <B>ex5.bmp</B> <B>%</B> <B>atlc</B> <B>-d</B> <B>CAFF00=2.78</B> <B>-d</B> <B>AC82AC=7.89</B> <B>ex5.bmp</B>
215
216      In the sixth and final example, the -v  option  is  used  to
217      print     some     extra     data     to     stderr     from
218      <B>create_bmp_for_rect_in_rect</B>.
219
220
221 </PRE>
222 <H2>SEE ALSO</H2><PRE>
223      <B>atlc(1)</B>                       <B>create_bmp_for_circ_in_circ(1)</B>
224      <B>create_bmp_for_circ_in_rect(1)</B>
225      <B>create_bmp_for_microstrip_coupler(1)</B>
226      <B>create_bmp_for_rect_cen_in_rect(1)</B>
227      <B>create_bmp_for_rect_cen_in_rect_coupler(1)</B>
228      <B>create_bmp_for_rect_in_circ(1)</B>
229      <B>create_bmp_for_stripline_coupler(1)</B>
230      <B>create_bmp_for_symmetrical_stripline(1)</B>    <B>design_coupler(1)</B>
231      <B>find_optimal_dimensions_for_microstrip_coupler(1)</B> <B>readbin(1)</B>
232
233      http://atlc.sourceforge.net                - Home page
234      http://sourceforge.net/projects/atlc       - Download area
235      atlc-X.Y.Z/docs/html-docs/index.html       - HTML docs
236      atlc-X.Y.Z/docs/qex-december-1996/atlc.pdf - theory paper
237      atlc-X.Y.Z/examples                        - examples
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281 </PRE>
282 <HR>
283 <ADDRESS>
284 Man(1) output converted with
285 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
286 </ADDRESS>
287 </BODY>
288 </HTML>