Imported Upstream version 4.6.0
[debian/atlc] / docs / html-docs / create_bmp_for_circ_in_circ.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_circ</B> - bitmap generator for  circular
9      conductor inside circular conductor (part of <B>atlc</B>)
10
11
12 </PRE>
13 <H2>SYNOPSIS</H2><PRE>
14      <B>create_bmp_for_circ_in_circ</B>  <B>[options...</B>  <B>]</B>   <B>D</B>   <B>d</B>   <B>O</B>   <B>Er</B>
15      <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_circ_in_circ</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_circ_in_circ</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 circular  conductor
45      (coaxial conductors), like this:
46
47
48                          *****************
49                      ****                 ****
50                   ****    &lt;-----d------&gt;     ****
51                 ***            *****            ***
52               ***           ***********           ***
53             ***            *************            ***
54            ***            ***************            ***
55           ***      ^      ***************             ***
56          ***       |      ***************              ***
57         ***        |       *************                ***
58         **         O        ***********                  **
59        ***         |            ***                      ***
60        **          |                                      **
61        *&lt;------------------------D------------------------&gt;*
62        **                                                 **
63        **                                                 **
64        **                                                 **
65        ***                                               ***
66         **                                               **
67         ***                                             ***
68          **                                             **
69           **                                           **
70            **                                         **
71             ***                                     ***
72              ****                                 ****
73                ****                             ****
74                  *****                       *****
75                     ******               ******
76                         *******************
77                                 ***
78
79      The parameter 'D' is the inner dimensions of the outer  con-
80      ductor and 'd' is the outer diameter of the inner conductor.
81      The inner conductor is offset 'h' from  the  centre  of  the
82      outer conductor. The whole region is surrounded by a dielec-
83      tric of relative permittivity 'Er'.
84
85      The bitmap is printed to 'outfile.bmp' -  the  last  command
86      line argument.
87
88      The bitmaps produced by <B>create_bmp_for_circ_in_circ</B> are  24-
89      bit bit colour bitmaps, as are required by <B>atlc</B>.
90
91      The permittivities of the  dielectric  'Er'  determines  the
92      colours  in the bitmap. If Er is 1.0, 1.006, 2.1, 2.2, 2.33,
93      2.5, 3.3, 3.335, 3,7, 4.8, 10.2  or  100,  then  the  colour
94      corresponding  to that permittivity will be set according to
95      the colours defined in COLOURS below. If Er is  not  one  of
96      those  permittivities, the region of permittivity Er will be
97      set to the colour 0xCAFF00. The program <B>atlc</B> does  not  know
98      what  this  permittivity  is, so <B>atlc</B>, must be told with the
99      command line option -d, as in example 4 below.
100
101
102 </PRE>
103 <H2>OPTIONS</H2><PRE>
104      <B>-b</B> <B>bitmapsize</B>
105      is used to set the size of the bitmap, and so  the  accuracy
106      to  which  atlc is able to calculate the transmission line's
107      properties. The default value for 'bitmapsize'  is  normally
108      4,  although  this  is set at compile time. The value can be
109      set anywhere from 1 to 15, but more than 8 is  probably  not
110      sensible.
111
112      <B>-f</B> <B>outfile</B>
113      Set the output filename. By default, the bitmap is  sent  to
114      stdout,  but  it *must* be sent to a file, with this option,
115      or as described above.
116
117      <B>-v</B>
118      Causes <B>create_bmp_for_circ_in_circ</B> to  print  some  data  to
119      stderr. Note, nothing extra goes to standard output, as that
120      is expected to be redirected to a bitmap file.
121
122
123
124 </PRE>
125 <H2>COLOURS</H2><PRE>
126      The 24-bit bitmaps that <B>atlc</B> expects, have 8  bits  assigned
127      to  represent the amount of red, 8 for blue and 8 for green.
128      Hence there are 256 levels of red, green and blue, making  a
129      total of 256*256*256=16777216 colours. Every one of the pos-
130      sible 16777216 colours can be defined precisely by the stat-
131      ing the exact amount of red, green and blue, as in:
132
133      red         = 255,000,000 or 0xff0000
134      green       = 000,255,000 or 0x00ff00
135      blue        = 000,000,255 or 0x0000ff
136      black       = 000,000,000 or 0x000000
137      white       = 255,255,255 or 0xffffff
138      Brown       = 255,000,255 or 0xff00ff
139      gray        = 142,142,142 or 0x8e8e8e
140
141      Some colours, such as pink, turquoise,  sandy,  brown,  gray
142      etc  may mean slightly different things to different people.
143      This is not so with <B>atlc</B>, as the program expects the colours
144      below  to  be EXACTLY defined as given. Whether you feel the
145      colour is sandy or yellow is up to you, but if you use it in
146      your  bitmap,  then it either needs to be a colour reconised
147      by atlc, <B>or</B> you must define it with a  command  line  option
148      (see OPTIONS and example 5 below).
149      The following conductors are reconised by atlc:
150      red    = 255,000,000 or 0xff0000 is the live conductor.
151      green  = 000,255,000 or 0x00ff00 is the grounded conductor.
152      blue   = 000,000,000 or 0x000000 is the negative conductor
153
154      All bitmaps <B>must</B> have the live (red)  and  grounded  (green)
155      conductor.  The  blue  conductor is not currently supported,
156      but it will be used to indicate a negative conductor,  which
157      will  be needed if/when the program gets extended to analyse
158      directional couplers.
159
160      The following dielectrics are reconised by atlc <B>and</B>  <B>so</B>  <B>are</B>
161      <B>produced</B> <B>by</B> create_bmp_for_circ_in_circ<B>.</B>
162
163      white     255,255,255 or 0xFFFFFF as Er=1.0   (vacuum)
164      pink      255,202,202 or 0xFFCACA as Er=1.0006 (air)
165      blue      000,000,255 or 0x0000FF as Er=2.1   (PTFE)
166      Mid gray  142,242,142 or 0x8E8E8E as Er=2.2   (duroid 5880)
167      mauve     255.000,255 or 0xFF00FF as Er=2.33  (polyethylene)
168      yellow    255,255,000 or 0xFFFF00 as Er=2.5   (polystyrene)
169      sandy     239,203,027 or 0xEFCC1A as Er=3.3   (PVC)
170      brown     188,127,096 or 0xBC7F60 as Er=3.335 (epoxy resin)
171      Turquoise 026,239,179 or 0x1AEFB3 as Er=4.8   (glass PCB)
172      Dark gray 142,142,142 or ox696969 as Er=6.15  (duroid 6006)
173      L. gray   240,240,240 or 0xDCDCDC as Er=10.2  (duroid 6010)
174
175
176 </PRE>
177 <H2>NOTE</H2><PRE>
178      Although <B>create_bmp_for_circ_in_circ</B> is  used  for  circular
179      inner and outer conductors, the outside of the outer conduc-
180      tor is drawn as a square. This is for convenience and  makes
181      no  difference  to  the  calculations.  The inside is of the
182      outer conductor is drawn as a circle.
183
184
185 </PRE>
186 <H2>EXAMPLES</H2><PRE>
187      Here   are    a    few    examples    of    the    use    of
188      <B>create_bmp_for_circ_in_circ</B>.  Again, see the html documenta-
189      tion in atlc-X.Y.Z/docs/html-docs/index.html for more  exam-
190      ples.
191
192      1) In the first example, the outer conductor has  an  inside
193      diameter  of 12 units (inches, mm, feet etc.), the inner has
194      an outside diameter of 3.9 units.  The inner is placed  cen-
195      trally (h=0) and the dielectric is vacuum (Er=1.0).
196      <B>%</B> <B>create_bmp_for_circ_in_circ</B> <B>12</B> <B>3.9</B> <B>0</B> <B>1.0</B> <B>coaxial_1.bmp</B>
197      <B>%</B> <B>atlc</B> <B>coaxial_1.bmp</B>
198      <B>atlc</B> will indicate the correct  value  of  impedance  to  be
199      67.3667  Ohms,  whereas an exact analysis will show the true
200      value to be 67.4358 Ohms, so <B>atlc</B> has an error of 0.102%.
201
202      2) In this second example, the conductor sizes are the sames
203      as  in  example  1,  but the inner is located 3.5 units off-
204      centre and the dielectric has a relative permittivity of 2.1
205      (Er  of PTFE) The output is sent to a file not_in_centre.bmp
206      which is then processed by <B>atlc</B>
207      <B>%</B>    <B>create_bmp_for_circ_in_circ</B>    <B>12</B>    <B>3.9</B>    <B>3.5</B>     <B>2.1</B>
208      <B>not_in_centre.bmp</B>
209      <B>%</B> <B>atlc</B> <B>not_in_centre.bmp</B>
210      The impedance of this is theoretically  24.315342  Ohms,  as
211      create_bmp_for_circ_in_circ  will  calculate for you. atlc's
212      estimate is 24.2493 Ohms, an error of only -0.271 %.
213
214      3) In the third  example  the  bitmap  is  made  larger,  to
215      increase  accuracy,  but  otherwise this is identical to the
216      previous one.
217      <B>%</B>   <B>create_bmp_for_circ_in_circ</B>   <B>-b8</B>   <B>12</B>   <B>3.9</B>   <B>3.5</B>   <B>2.1</B>
218      <B>bigger_not_in_centre.bmp</B>
219      <B>%</B> <B>atlc</B> <B>bigger_not_in_centre.bmp</B>
220      This time atlc will take much longer to calculate Zo,  since
221      the  bitmap  is  larger  and so it needs to do more calcula-
222      tions. However, the final result should be more accurate. In
223      this  case,  the  result  reported is 24.2461 Ohms, an error
224      that's marginally smaller than before at  0.285  %.   It  is
225      possible  there  may be something to be gained by decreasing
226      the cutoff at larger grids, so this is  being  investigated.
227      However,  errors  almost always below 0.25 %, no matter what
228      is being analysed.
229      In the fourth example, a material with a relativity  permit-
230      tivity  7.89  of  is  used. There is no change in how to use
231      <B>create_bmp_for_circ_in_circ</B>, but since this permittivity  is
232      not  one  of  the  pre-defined values (see COLOURS), we must
233      tell <B>atlc</B> what it is.  The colour will be set an olive green
234      one, with a hexacidcal representation of red=0xCA, blue=OxFF
235      and green = 0x00. This just happens to be the default colour
236      used when the permittivity is unknown. So atlc must be given
237      this information, like thisL
238      <B>%</B> <B>create_bmp_for_circ_in_circ</B> <B>23</B> <B>9</B> <B>0</B> <B>7.89</B> <B>an_odd_er.bmp</B>
239      <B>%</B> <B>atlc</B> <B>-d</B> <B>CAFF00=7.89</B> <B>an_odd_er.bmp</B>
240
241      This has a theoretical impedance of 20.041970 Ohms, but atlc
242      version  3.0.1  will calculate it to be 20.0300, an error of
243      -0.058 % !!! If you look at the file  an_odd_er.bmp  with  a
244      graphics  package,  you will see there are 3 colours in it -
245      the red inner conductor, the green outer and an  olive-green
246      dielectric.
247
248
249
250 </PRE>
251 <H2>SEE ALSO</H2><PRE>
252      <B>atlc(1)</B>
253      <B>create_bmp_for_circ_in_rect(1)</B>
254      <B>create_bmp_for_microstrip_coupler(1)</B>
255      <B>create_bmp_for_rect_cen_in_rect(1)</B>
256      <B>create_bmp_for_rect_cen_in_rect_coupler(1)</B>
257      <B>create_bmp_for_rect_in_circ(1)</B>
258      <B>create_bmp_for_rect_in_rect(1)</B>
259      <B>create_bmp_for_stripline_coupler(1)</B>
260      <B>create_bmp_for_symmetrical_stripline(1)</B>
261      <B>design_coupler(1)</B>
262      <B>find_optimal_dimensions_for_microstrip_coupler(1)</B> <B>readbin(1)</B>
263
264      http://atlc.sourceforge.net                - Home page
265      http://sourceforge.net/projects/atlc       - Download area
266      atlc-X.Y.Z/docs/html-docs/index.html       - HTML docs
267      atlc-X.Y.Z/docs/qex-december-1996/atlc.pdf - theory paper
268      atlc-X.Y.Z/examples                        - examples
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283 </PRE>
284 <HR>
285 <ADDRESS>
286 Man(1) output converted with
287 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
288 </ADDRESS>
289 </BODY>
290 </HTML>