create_bmp...irc_in_rect(1)

📦 version 4.6.1, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu resolute, ubuntu stonking

💖 create_bmp_for_circ_in_rect 💖

okay so bestie, welcome to the General Commands Manual page for create_bmp...irc_in_rect(1) — yes that's the abbreviated title, the full name is create_bmp_for_circ_in_rect, iykyk. she's part of the atlc fam 💅

✨ NAME ✨

create_bmp_for_circ_in_rect — bitmap generator for a circular conductor inside a rectangular conductor (part of atlc) 🎀

🌸 SYNOPSIS 🌸

create_bmp_for_circ_in_rect [options... ] d W H x y Er outfile.bmp

⚠️ WARNING ⚠️

ngl this man page is not a complete set of documentation. the atlc project is just so complex that man pages are not an ideal way to document it — but for completeness, man pages get produced anyway. 🙈

the best documentation that was current at the time the version was produced should be chilling on your hard drive, usually at:

/usr/local/share/atlc/docs/html-docs/index.html

...though it might be somewhere else entirely if your system administrator chose to install the package in a different place. no cap.

sometimes errors get corrected in the documentation and dropped at http://atlc.sourceforge.net/ before a new release of atlc comes out. and please — if you notice a problem with the documentation, even spelling errors and typos, literally let me know. 🫶

🦋 DESCRIPTION 🦋

create_bmp_for_circ_in_rect is a pre-processor for atlc, the finite difference program used to calculate the properties of a two-conductor electrical transmission line of arbitrary cross section. this program is the fast way of generating bitmaps (no need to open a graphics program, we don't do that here 💅) for a circular conductor inside a rectangular conductor, like this:

--------------------------------------------------------  ^
|                                                      |  |
|                                                      |  |
|                                                      |  |
|                                                      |  |
|                                                      |  |
|           Dielectric, permittivity=Er                |  |
|                                                      |  |
|                                                      |  |
|                                                      |  |
|                                                      |  |
|         <------x------> ^                            |  H
|       *****             |                            |  |
|    ***********          y                            |  |
|   *************         |                            |  |
|   **************        |                            |  |
|   <-----d------>        v                            |  |
|   **************                                     |  |
|   *************                                      |  |
|    ***********                                       |  |
|        ***                                           |  |
|                                                      |  |
-------------------------------------------------------   v
<---------------------------W-------------------------->

so W and H are the inner dimensions of the outer conductor. the inner conductor has a diameter of d and is offset from the centre of the outer conductor by an amount x horizontally and y vertically. the space between the inner and outer conductors is a dielectric of relative permittivity Er. and if it's just a vacuum dielectric in there, then Er should be set to 1.0. ✨

the bitmap gets printed to standard output, which MUST be re-directed to a file, one of these two ways:

create_bmp_for_circ_in_rect  d W H x y Er > filename.bmp OR
create_bmp_for_circ_in_rect -f filename.bmp d W H x y Er

the bitmaps produced by create_bmp_for_circ_in_rect are 24-bit bit colour bitmaps, exactly as required by atlc. 💖

the permittivities of the bitmap, set by Er, determine the colours in the bitmap. if Er1 is 1.0, 1.006, 2.1, 2.2, 2.33, 2.5, 3.3, 3.335, 3.7, 4.8, 10.2 or 100 then the colour corresponding to that permittivity will be set according to the colours defined in COLOURS below. if Er is not one of those permittivities, the region of permittivity Er will be set to the colour 0xCAFF00. the program atlc does not know what these permittivites are, so atlc must be told with the -d command line option, as in example 4 below. 👑

💅 OPTIONS 💅

  • -b bitmapsize — sets the size of the bitmap, and therefore the accuracy to which atlc is able to calculate the transmission line's properties. the default value for bitmapsize is normally 4, although this is set at compile time. the value can be set anywhere from 1 to 15, but more than 8 is probably not sensible.
  • -f outfile — writes the output to outfile.
  • -v — causes create_bmp_for_circ_in_rect to print some data to stderr. note: nothing extra goes to standard output, because that's expected to be redirected to a bitmap file. 🙈

🌈 COLOURS 🌈

the 24-bit bitmaps that atlc expects have 8 bits assigned to represent the amount of red, 8 for blue and 8 for green. hence there are 256 levels of red, green and blue, making a total of 256*256*256=16777216 colours. every single one of those possible 16777216 colours can be defined precisely by stating the exact amount of red, green and blue, as in:

red         = 255,000,000 or 0xff0000
green       = 000,255,000 or 0x00ff00
blue        = 000,000,255 or 0x0000ff
black       = 000,000,000 or 0x000000
white       = 255,255,255 or 0xffffff
Brown       = 255,000,255 or 0xff00ff
gray        = 142,142,142 or 0x8e8e8e

some colours, like pink, turquoise, sandy, brown, gray etc, may mean slightly different things to different people. that is not the case with atlc — the program expects the colours below to be EXACTLY defined as given. whether you feel the colour is sandy or yellow is up to you, but if you use it in your bitmap, then it either needs to be a colour recognised by atlc, or you must define it with a command line option (see OPTIONS and example 5 below).

the following conductors are recognised by atlc:

  • red = 255,000,000 or 0xff0000 is the live conductor.
  • green = 000,255,000 or 0x00ff00 is the grounded conductor.
  • black = 000,000,000 or 0x000000 is the negative conductor

all bitmaps must have the live (red) and grounded (green) conductor. the black conductor is not currently supported, but it will be used to indicate a negative conductor, which will be needed if/when the program gets extended to analyse directional couplers.

the following dielectrics are recognised by atlc and so are produced by create_bmp_for_circ_in_rect.

white     255,255,255 or 0xFFFFFF as Er=1.0   (vacuum)
white     255,202,202 or 0xFFCACA as Er=1.0006 (air)
blue      000,000,255 or 0x0000FF as Er=2.1   (PTFE)
Mid gray  142,242,142 or 0x8E8E8E as Er=2.2   (duroid 5880)
mauve     255.000,255 or 0xFF00FF as Er=2.33  (polyethylene)
yellow    255,255,000 or 0xFFFF00 as Er=2.5   (polystyrene)
sandy     239,203,027 or 0xEFCC1A as Er=3.3   (PVC)
brown     188,127,096 or 0xBC7F60 as Er=3.335 (epoxy resin)
Turquoise 026,239,179 or 0x1AEFB3 as Er=4.8   (glass PCB)
Dark gray 142,142,142 or ox696969 as Er=6.15  (duroid 6006)
L. gray   240,240,240 or 0xDCDCDC as Er=10.2  (duroid 6010)
D. Orange 213,160,077 or 0xD5A04D as Er=100   (for testing)

if the permittivity is one not in the above list, then those parts of the image with Er1 will be set to 0xCAFF00, and those parts with Er2 to 0xAC82AC. 💀 (yes bestie, remember those two hex codes, they come back in example 5.)

🎀 EXAMPLES 🎀

here are a few examples of the use of create_bmp_for_circ_in_rect. again, see the html documentation in atlc-X.Y.Z/docs/html-docs for more examples.

example 1 — there's just an air dielectric, so Er1=Er2=1.0. the inner of 1x1 inches (or mm, miles etc) is placed centrally in an outer with dimensions 3 x 3 inches.

the exact place where the dielectric starts (a) and its width (d) are unimportant, but they must still be entered.

% create_bmp_for_circ_in_rect 3 3 1 1 1 1 1 1 > ex1.bmp
% atlc ex1.bmp

example 2 — an inner of 15.0 mm x 0.5 mm is surrounded by an outer with internal dimensions of 61.5 x 20.1 mm. there is a material with permittivity 2.1 (Er of PTFE) below the inner conductor. the output from create_bmp_for_circ_in_rect is sent to a file ex1.bmp, which is then processed by atlc.

% create_bmp_for_circ_in_rect 61.5 20.1 5 22 0.5 50 15 5 1.0 2.1 > ex2.bmp
% atlc ex2.bmp

example 3 — the bitmap is made larger, to increase accuracy, but otherwise this is identical to the second example.

% create_bmp_for_circ_in_rect -b7 61.5 20.1 5 22 0.5 50 15 5 1.0 2.1 > ex3.bmp
% atlc ex3.bmp

example 4 — instead of re-directing create_bmp_for_circ_in_rect's output to a file with the > sign, it's done using the -f option.

% create_bmp_for_circ_in_rect -f ex4.bmp 61.5 20.1 5 22 0.5 50 15 5 1.0 2.1
% atlc ex4.bmp

example 5 — materials with permittivites 2.78 and 7.89 are used. while there's no change in how to use create_bmp_for_circ_in_rect, since these permittivities are not known, we must tell atlc what they are.

% create_bmp_for_circ_in_rect 61 20 1 4 22 0.5 50 15 5 2.78 7.89 > ex5.bmp
% atlc -d CAFF00=2.78 -d AC82AC=7.89 ex5.bmp

example 6 — the sixth and final example, the -v option is used to print some extra data to stderr from create_bmp_for_circ_in_rect.

👑 SEE ALSO 👑

atlc(1) create_bmp_for_circ_in_circ(1) create_bmp_for_microstrip_coupler(1) create_bmp_for_rect_cen_in_rect(1) create_bmp_for_rect_cen_in_rect_coupler(1) create_bmp_for_rect_in_circ(1) create_bmp_for_rect_in_rect(1) create_bmp_for_stripline_coupler(1) create_bmp_for_symmetrical_stripline(1) design_coupler(1) find_optimal_dimensions_for_microstrip_coupler(1) readbin(1)

http://atlc.sourceforge.net                - Home page
http://sourceforge.net/projects/atlc       - Download area
atlc-X.Y.Z/docs/html-docs/index.html       - HTML docs
atlc-X.Y.Z/docs/qex-december-1996/atlc.pdf - theory paper
atlc-X.Y.Z/examples                        - examples

and that's the whole page bestie, slay ✨

this was written by Dr. David Kirkby, and it's from atlc version atlc-4.4.2, dated 10/09/03 — and yeah, the footer's abbreviated title is create_bmp...irc_in_rect(1), same as the top. iconic symmetry, periodt 💖

📦 where this page comes from