Imported Upstream version 4.6.0
[debian/atlc] / docs / html-docs / create_bmp_for_circ_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_circ_in_rect</B> - bitmap generator for a  circu-
9      lar conductor inside a rectangular conductor (part of <B>atlc</B>)
10
11
12 </PRE>
13 <H2>SYNOPSIS</H2><PRE>
14      <B>create_bmp_for_circ_in_rect</B> <B>[options...</B> <B>]</B>  <B>d</B>  <B>W</B>  <B>H</B>  <B>x</B>  <B>y</B>  <B>Er</B>
15      <B>outfile.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_circ_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-conductor electrical transmission  line  of
41      arbitrary       cross       section.       The       program
42      <B>create_bmp_for_circ_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 circular conductor inside a rectangular conduc-
45      tor, like this:
46
47      --------------------------------------------------------  ^
48      |                                                      |  |
49      |                                                      |  |
50      |                                                      |  |
51      |                                                      |  |
52      |                                                      |  |
53      |           Dielectric, permittivity=Er                |  |
54      |                                                      |  |
55      |                                                      |  |
56      |                                                      |  |
57      |                                                      |  |
58      |         &lt;------x------&gt; ^                            |  H
59      |       *****             |                            |  |
60      |    ***********          y                            |  |
61      |   *************         |                            |  |
62      |   **************        |                            |  |
63      |   &lt;-----d------&gt;        v                            |  |
64      |   **************                                     |  |
65      |   *************                                      |  |
66      |    ***********                                       |  |
67      |        ***                                           |  |
68      |                                                      |  |
69      -------------------------------------------------------   v
70      &lt;---------------------------W--------------------------&gt;
71
72      The parameters 'W' and 'H' and the inner dimensions  of  the
73      outer  conductor.  The inner conductor has a diameter of 'd'
74      and is offset from the centre of the outer conductor  by  an
75      amount  'x'  horizontally  and  'y'  vertically.   The space
76      between the inner and outer conductors is  a  dielectric  of
77      relative  permittivity  'Er'.  If  there  is  just  a vacuum
78      dielectric, then 'Er' should be set to 1.0
79
80      The bitmap is printed to standard output, which <B>MUST</B> be  re-
81      directed to either a file in one of the following two ways.
82
83      <B>create_bmp_for_circ_in_rect</B>  <B>d</B> <B>W</B> <B>H</B> <B>x</B> <B>y</B> <B>Er</B> <B>&gt;</B> <B>filename.bmp</B> OR
84      <B>create_bmp_for_circ_in_rect</B> <B>-f</B> <B>filename.bmp</B> <B>d</B> <B>W</B> <B>H</B> <B>x</B> <B>y</B> <B>Er</B>
85
86      The bitmaps produced by <B>create_bmp_for_circ_in_rect</B> are  24-
87      bit bit colour bitmaps, as are required by <B>atlc</B>.
88
89      The permittivities of the bitmap, set by 'Er', determine the
90      colours in the bitmap. If Er1 is 1.0, 1.006, 2.1, 2.2, 2.33,
91      2.5, 3.3, 3.335, 3.7, 4.8,  10.2  or  100  then  the  colour
92      corresponding  to that permittivity will be set according to
93      the colours defined in COLOURS below. If Er is  not  one  of
94      those  permittivities, the region of permittivity Er will be
95      set to the colour 0xCAFF00. The program <B>atlc</B> does  not  know
96      what these permittivites are, so <B>atlc</B>, must be told with the
97      -d command line option, as in example 4 below.
98
99
100 </PRE>
101 <H2>OPTIONS</H2><PRE>
102      <B>-b</B> <B>bitmapsize</B>
103      is used to set the size of the bitmap, and so  the  accuracy
104      to  which  atlc is able to calculate the transmission line's
105      properties. The default value for 'bitmapsize'  is  normally
106      4,  although  this  is set at compile time. The value can be
107      set anywhere from 1 to 15, but more than 8 is  probably  not
108      sensible.
109
110      <B>-f</B> <B>outfile</B>
111
112      <B>-v</B>
113      Causes <B>create_bmp_for_circ_in_rect</B> to  print  some  data  to
114      stderr. Note, nothing extra goes to standard output, as that
115      is expected to be redirected to a bitmap file.
116
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      The following conductors are recognised by atlc:
146      red    = 255,000,000 or 0xff0000 is the live conductor.
147      green  = 000,255,000 or 0x00ff00 is the grounded conductor.
148      black  = 000,000,000 or 0x000000 is the negative conductor
149
150      All bitmaps <B>must</B> have the live (red)  and  grounded  (green)
151      conductor.  The  black conductor is not currently supported,
152      but it will be used to indicate a negative conductor,  which
153      will  be needed if/when the program gets extended to analyse
154      directional couplers.
155
156      The following dielectrics are recognised by atlc <B>and</B> <B>so</B>  <B>are</B>
157      <B>produced</B> <B>by</B> create_bmp_for_circ_in_rect<B>.</B>
158
159      white     255,255,255 or 0xFFFFFF as Er=1.0   (vacuum)
160      white     255,202,202 or 0xFFCACA as Er=1.0006 (air)
161      blue      000,000,255 or 0x0000FF as Er=2.1   (PTFE)
162      Mid gray  142,242,142 or 0x8E8E8E as Er=2.2   (duroid 5880)
163      mauve     255.000,255 or 0xFF00FF as Er=2.33  (polyethylene)
164      yellow    255,255,000 or 0xFFFF00 as Er=2.5   (polystyrene)
165      sandy     239,203,027 or 0xEFCC1A as Er=3.3   (PVC)
166      brown     188,127,096 or 0xBC7F60 as Er=3.335 (epoxy resin)
167      Turquoise 026,239,179 or 0x1AEFB3 as Er=4.8   (glass PCB)
168      Dark gray 142,142,142 or ox696969 as Er=6.15  (duroid 6006)
169      L. gray   240,240,240 or 0xDCDCDC as Er=10.2  (duroid 6010)
170      D. Orange 213,160,077 or 0xD5A04D as Er=100   (for testing)
171      If the permittivity is one not in the above list, then those
172      parts  of  the  image  with Er1 will be set to 0xCAFF00, and
173      those parts with Er2 to 0xAC82AC.
174
175
176 </PRE>
177 <H2>EXAMPLES</H2><PRE>
178      Here   are    a    few    examples    of    the    use    of
179      <B>create_bmp_for_circ_in_rect</B>.  Again, see the html documenta-
180      tion in atlc-X.Y.Z/docs/html-docs for more examples.
181
182      In the first example, there is just an  air  dielectric,  so
183      Er1=Er2=1.0.   The inner of 1x1 inches (or mm, miles etc) is
184      placed centrally in an outer with dimensions 3 x 3 inches.
185
186      The exact place where the  dielectric  starts  (a)  and  its
187      width (d) are unimportant, but they must still be entered.
188
189      <B>%</B> <B>create_bmp_for_circ_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>
190      <B>%</B> <B>atlc</B> <B>ex1.bmp</B>
191
192      In this second example, an inner of 15.0 mm x 0.5 mm is sur-
193      rounded  by an outer with internal dimensions of 61.5 x 20.1
194      mm. There is a material with permittivity 2.1 (Er  of  PTFE)
195      below    the    inner    conductor.    The    output    from
196      <B>create_bmp_for_circ_in_rect</B> is sent to a file ex1.bmp, which
197      is then processed by <B>atlc</B>
198
199      <B>%</B> <B>create_bmp_for_circ_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>
200      <B>2.1</B> <B>&gt;</B> <B>ex2.bmp</B>
201      <B>%</B> <B>atlc</B> <B>ex2.bmp</B>
202
203      In example 3, the bitmap is made larger, to  increase  accu-
204      racy, but otherwise this is identical to the second example.
205      <B>%</B> <B>create_bmp_for_circ_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>
206      <B>1.0</B> <B>2.1</B> <B>&gt;</B> <B>ex3.bmp</B>
207      <B>%</B> <B>atlc</B> <B>ex3.bmp</B>
208
209      In   the   fourth   example,   instead    of    re-directing
210      <B>create_bmp_for_circ_in_rect's</B>  output  to  a file with the &gt;
211      sign, it is done using the -f option.
212      <B>%</B> <B>create_bmp_for_circ_in_rect</B> <B>-f</B> <B>ex4.bmp</B> <B>61.5</B> <B>20.1</B> <B>5</B> <B>22</B>  <B>0.5</B>
213      <B>50</B> <B>15</B> <B>5</B> <B>1.0</B> <B>2.1</B>
214      <B>%</B> <B>atlc</B> <B>ex4.bmp</B>
215
216      In the fifth example, materials with permittivites 2.78  and
217      7.89  are  used.  While  there  is  no  change in how to use
218      <B>create_bmp_for_circ_in_rect</B>, since these permittivities  are
219      not known, we must tell <B>atlc</B> what they are.
220
221      <B>%</B> <B>create_bmp_for_circ_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>
222      <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>
223
224      In the sixth and final example, the -v  option  is  used  to
225      print     some     extra     data     to     stderr     from
226      <B>create_bmp_for_circ_in_rect</B>.
227
228
229 </PRE>
230 <H2>SEE ALSO</H2><PRE>
231      <B>atlc(1)</B>                       <B>create_bmp_for_circ_in_circ(1)</B>
232      <B>create_bmp_for_microstrip_coupler(1)</B>
233      <B>create_bmp_for_rect_cen_in_rect(1)</B>
234      <B>create_bmp_for_rect_cen_in_rect_coupler(1)</B>
235      <B>create_bmp_for_rect_in_circ(1)</B>
236      <B>create_bmp_for_rect_in_rect(1)</B>
237      <B>create_bmp_for_stripline_coupler(1)</B>
238      <B>create_bmp_for_symmetrical_stripline(1)</B>    <B>design_coupler(1)</B>
239      <B>find_optimal_dimensions_for_microstrip_coupler(1)</B> <B>readbin(1)</B>
240
241      http://atlc.sourceforge.net                - Home page
242      http://sourceforge.net/projects/atlc       - Download area
243      atlc-X.Y.Z/docs/html-docs/index.html       - HTML docs
244      atlc-X.Y.Z/docs/qex-december-1996/atlc.pdf - theory paper
245      atlc-X.Y.Z/examples                        - examples
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
282 </PRE>
283 <HR>
284 <ADDRESS>
285 Man(1) output converted with
286 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
287 </ADDRESS>
288 </BODY>
289 </HTML>