git.gag.com Git - debian/atlc/blob - docs/html-docs/create_bmp_for_rect_cen_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_cen_in_rect</B> - bitmap generator for  rec-
   9      tangular  conductor  inside  rectangular  conductor (part of
  10      <B>atlc</B>)
  11
  12
  13 </PRE>
  14 <H2>SYNOPSIS</H2><PRE>
  15      <B>create_bmp_for_rect_cen_in_rect</B> <B>[options...</B> <B>]</B> <B>W</B>  <B>H</B>  <B>w</B>  <B>h</B>  <B>Er</B>
  16      <B>outfile.bmp</B>
  17
  18
  19 </PRE>
  20 <H2>WARNING</H2><PRE>
  21      This man page is not a complete set of documentation  -  the
  22      complexity  of the atlc project makes man pages not an ideal
  23      way to document it, although out of completeness, man  pages
  24      are produced. The best documentation that was current at the
  25      time the version was produced should be found on  your  hard
  26      drive, usually at
  27      /usr/local/share/atlc/docs/html-docs/index.html
  28      although it might be elsewhere if your system  administrator
  29      chose  to  install  the package elsewhere. Sometimes, errors
  30      are  corrected  in   the   documentation   and   placed   at
  31      http://atlc.sourceforge.net/ before a new release of atlc is
  32      released.  Please, if you notice a problem with the documen-
  33      tation - even spelling errors and typos, please let me know.
  34
  35
  36
  37 </PRE>
  38 <H2>DESCRIPTION</H2><PRE>
  39      <B>create_bmp_for_rect_cen_in_rect</B> is a pre-processor for <B>atlc</B>,
  40      the  finite difference program that is used to calculate the
  41      properties of a two-conductor electrical  transmission  line
  42      of      arbitrary     cross     section.     The     program
  43      <B>create_bmp_for_rect_cen_in_rect</B> is used as  a  fast  way  of
  44      generating  bitmaps (there is no need to use a graphics pro-
  45      gram), for a rectangular conductor placed  centrally  inside
  46      another rectangular conductor, like this:
  47
  48      -----------------------------------------------------  ^
  49      |                                                   |  |
  50      |            Dielectric, permittivity=Er            |  |
  51      |                                                   |  |
  52      |                                                   |  |
  53      |                                                   |  |
  54      |             &lt;----------w-----------&gt;              |  |
  55      |             ------------------------   ^          |  |
  56      |             |                      |   |          |  |
  57      |             |  Metallic conductor  |   |          |  H
  58      |             |  conductor (must be  |   h          |  |
  59      |             |  in  the centre)     |   |          |  |
  60      |             |                      |   |          |  |
  61      |             ------------------------   ^          |  |
  62      |                                                   |  |
  63      |                                                   |  |
  64      |                                                   |  |
  65      |                                                   |  |
  66      |                                                   |  |
  67      |                                                   |  |
  68      -----------------------------------------------------  |
  69      &lt;---------------------------W-----------------------&gt;
  70
  71      The parameters 'W' and 'H' and the inner dimensions  of  the
  72      outer  conductor.  The outer dimensions of the inner conduc-
  73      tor are 'w' and 'h'. The inner conductor is  assumed  be  be
  74      placed  centrally  inside  the  outer  conductor. The spaced
  75      between the two conductors is filled with  a  dielectric  of
  76      relative permittivity Er
  77
  78      The bitmaps produced by <B>create_bmp_for_rect_cen_in_rect</B>  are
  79      24-bit bit colour bitmaps, as required by <B>atlc</B>.
  80
  81      The permittivity of the bitmap, set by 'Er',  determine  the
  82      colours  in  the  bitmap. If Er is 1.0, 2.1, 2.2, 2.33, 2.5,
  83      3.3, 3.335, 4.8 or 10.2, then the  colour  corresponding  to
  84      that  permittivity  will  be  set  according  to the colours
  85      defined in COLOURS below. If Er is not one of those  permit-
  86      tivities,  the  region of permittivity Er will be set to the
  87      colour 0xCAFF00. The program <B>atlc</B> does not know  what  these
  88      permittivites  are,  so  they  <B>atlc</B>,  must  be told with the
  89      comand line option -d, as in example 4 below.
  90
  91
  92 </PRE>
  93 <H2>OPTIONS</H2><PRE>
  94      <B>-b</B> <B>bitmapsize</B>
  95      is used to set the size of the bitmap, and so  the  accuracy
  96      to  which  atlc is able to calculate the transmission line's
  97      properties. The default value for 'bitmapsize'  is  normally
  98      4,  although  this  is set at compile time. The value can be
  99      set anywhere from 1 to 15, but more than 8 is  probably  not
 100      sensible.
 101
 102      <B>-f</B> <B>outfile</B>
 103      Set the output filename. By default, the bitmap is  sent  to
 104      stdout,  but  it *must* be sent to a file, with this option,
 105      or as described above.
 106
 107      <B>-v</B>
 108      Causes <B>create_bmp_for_rect_cen_in_rect</B> to print some data to
 109      stdout.
 110
 111
 112
 113 </PRE>
 114 <H2>COLOURS</H2><PRE>
 115      The 24-bit bitmaps that <B>atlc</B> expects, have 8  bits  assigned
 116      to  represent the amount of red, 8 for blue and 8 for green.
 117      Hence there are 256 levels of red, green and blue, making  a
 118      total of 256*256*256=16777216 colours. Every one of the pos-
 119      sible 16777216 colours can be defined precisely by the stat-
 120      ing the exact amount of red, green and blue, as in:
 121      red         = 255,000,000 or 0xff0000
 122      green       = 000,255,000 or 0x00ff00
 123      blue        = 000,000,255 or 0x0000ff
 124      black       = 000,000,000 or 0x000000
 125      white       = 255,255,255 or 0xffffff
 126      Brown       = 255,000,255 or 0xff00ff
 127      gray        = 142,142,142 or 0x8e8e8e
 128
 129      Some colours, such as pink, turquoise,  sandy,  brown,  gray
 130      etc  may mean slightly different things to different people.
 131      This is not so with <B>atlc</B>, as the program expects the colours
 132      below  to  be EXACTLY defined as given. Whether you feel the
 133      colour is sandy or yellow is up to you, but if you use it in
 134      your  bitmap, then it either needs to be a colour recognised
 135      by atlc, <B>or</B> you must define it with a  command  line  option
 136      (see OPTIONS and example 5 below).
 137      The following conductors are recognised by atlc:
 138      red    = 255,000,000 or 0xff0000 is the live conductor.
 139      green  = 000,255,000 or 0x00ff00 is the grounded conductor.
 140      blue   = 000,000,000 or 0x000000 is the negative conductor
 141
 142      All bitmaps <B>must</B> have the live (red)  and  grounded  (green)
 143      conductor.  The  blue  conductor is not currently supported,
 144      but it will be used to indicate a negative conductor,  which
 145      will  be needed if/when the program gets extended to analyse
 146      directional couplers.
 147
 148      The following dielectrics are recognised by atlc <B>and</B> <B>so</B>  <B>are</B>
 149      <B>produced</B> <B>by</B> create_bmp_for_rect_cen_in_rect<B>.</B>
 150
 151      white      255,255,255 or 0xFFFFFF as Er=1.0   (vacuum)
 152      pink       255,202,202 or 0xFFCACA as Er=1.0006 (air)
 153      light blue 130,052,255 or 0x8235Ef as Er=2.1   (PTFE)
 154      Mid gray   142,242,142 or 0x8E8E8E as Er=2.2   (duroid 5880)
 155      mauve         255.000,255    or    0xFF00FF    as    Er=2.33
 156      (polyethylene)  yellow     255,255,000 or 0xFFFF00 as Er=2.5
 157      (polystyrene)
 158      sandy      239,203,027 or 0xEFCC1A as Er=3.3   (PVC)
 159      brown      188,127,096 or 0xBC7F60 as Er=3.335 (epoxy resin)
 160      Turquoise  026,239,179 or 0x1AEFB3 as Er=4.8   (glass PCB)
 161      Dark gray  142,142,142 or ox696969 as Er=6.15  (duroid 6006)
 162      L. gray    240,240,240 or 0xDCDCDC as Er=10.2  (duroid 6010)
 163      D. orange  213,130,067 or 0xD5A04D as Er=100.0  (mainly  for
 164      test purposes)
 165      If the permittivity is one not in the above list, then those
 166      parts of the image with Er will be set to 0xCAFF00.
 167
 168
 169 </PRE>
 170 <H2>EXAMPLES</H2><PRE>
 171      Here   are    a    few    examples    of    the    use    of
 172      <B>create_bmp_for_rect_cen_in_rect</B>.  Again,  see the html docu-
 173      mentation in  atlc-X.Y.Z/docs/html-doc/index.html  for  more
 174      examples.
 175      1) In the first example, there is just a vacuum  dielectric,
 176      so  Er=1.0.   The  inner of 1x1 inches (or mm, miles etc) is
 177      placed centrally in an  outer  with  dimensions  3.3  x  3.9
 178      inches.
 179
 180      <B>%</B> <B>create_bmp_for_rect_cen_in_rect</B> <B>3.3</B> <B>3.9</B> <B>1</B> <B>1</B> <B>1</B> <B>&gt;</B> <B>1.bmp</B>
 181      <B>%</B> <B>atlc</B> <B>1.bmp</B>
 182
 183      2) In this second example, an inner of 15.0 mm x 5.0  mm  is
 184      surrounded  by  an  outer with internal dimensions of 71.5 x
 185      60.0 mm. There is a material with permittivity  2.1  (Er  of
 186      PTFE)   around   the   inner   conductor.  The  output  from
 187      <B>create_bmp_for_rect_cen_in_rect</B> is sent  to  a  file  2.bmp,
 188      which is then processed by <B>atlc</B>
 189
 190      <B>%</B> <B>create_bmp_for_rect_cen_in_rect</B> <B>71.5</B> <B>60.0</B> <B>15.0</B> <B>5.0</B>  <B>2.1</B>  <B>&gt;</B>
 191      <B>2.bmp</B>
 192      <B>%</B> <B>atlc</B> <B>2.bmp</B>
 193
 194      3) In example 3, the bitmap  is  made  larger,  to  increase
 195      accuracy,  but  otherwise  this  is  identical to the second
 196      example. <B>%</B> <B>create_bmp_for_rect_cen_in_rect</B> <B>-b7</B> <B>71.5</B> <B>60</B> <B>15</B>  <B>5</B>
 197      <B>2.1</B> <B>&gt;</B> <B>3.bmp</B>
 198      <B>%</B> <B>atlc</B> <B>3.bmp</B>
 199
 200      In   the   fourth   example,   instead    of    re-directing
 201      <B>create_bmp_for_rect_cen_in_rect's</B>  output to a file with the
 202      &gt; sign, it is done using the -f option.
 203      <B>%</B> <B>create_bmp_for_rect_cen_in_rect</B> <B>-f</B> <B>4.bmp</B> <B>61.5</B>  <B>28.1</B>  <B>5</B>  <B>22</B>
 204      <B>2.1</B>
 205      <B>%</B> <B>atlc</B> <B>4.bmp</B>
 206
 207
 208 </PRE>
 209 <H2>SEE ALSO</H2><PRE>
 210      <B>atlc(1)</B>                       <B>create_bmp_for_circ_in_circ(1)</B>
 211      <B>create_bmp_for_circ_in_rect(1)</B>
 212      <B>create_bmp_for_microstrip_coupler(1)</B>
 213      <B>create_bmp_for_rect_cen_in_rect_coupler(1)</B>
 214      <B>create_bmp_for_rect_in_circ(1)</B>
 215      <B>create_bmp_for_rect_in_rect(1)</B>
 216      <B>create_bmp_for_stripline_coupler(1)</B>
 217      <B>create_bmp_for_symmetrical_stripline(1)</B>    <B>design_coupler(1)</B>
 218      <B>find_optimal_dimensions_for_microstrip_coupler(1)</B> <B>readbin(1)</B>
 219
 220      http://atlc.sourceforge.net                - Home page
 221      http://sourceforge.net/projects/atlc       - Download area
 222      atlc-X.Y.Z/docs/html-docs/index.html       - HTML docs
 223      atlc-X.Y.Z/docs/qex-december-1996/atlc.pdf - theory paper
 224      atlc-X.Y.Z/examples                        - examples
 225
 226
 227
 228
 229 </PRE>
 230 <HR>
 231 <ADDRESS>
 232 Man(1) output converted with
 233 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
 234 </ADDRESS>
 235 </BODY>
 236 </HTML>