gout(1)

🌸 NAME 🌸

hey bestie 💖 welcome to gout(1), straight out of the Scotch user's manual, and honestly? it's giving graph-glamour. no cap.

gout — output graphics from matrices and graphs ✨

---

🦋 SYNOPSIS 🦋

gout [options] [gfile] [xfile] [mfile] [vfile]

---

💅 DESCRIPTION 💅

so gout literally creates graphics files of various types, and those files represent the Scotch graph and mapping data that you pass to it. it's the glow-up your data deserves 👑

here's the cast of characters:

• gfile — the source graph file, and heads up: it can only be a centralized graph file. that's it, periodt.
• xfile — stores its associated geometry, whenever necessary.
• mfile — the label information attached to each of the graph vertices, for instance the index of the part to which each vertex belongs in the case of a mapping file.
• vfile — the output graphics file, and its type may differ according to the input parameters.

when file names are not specified, data is read from standard input and written to standard output. standard streams can also be explicitly represented by a dash '-'.

when the proper libraries have been included at compile time, gtst can directly handle compressed graphs, both as input and output 🔥. a stream is treated as compressed whenever its name is postfixed with a compressed file extension, such as in 'brol.grf.bz2' or '-.gz'. the compression formats which can be supported are the bzip2 format ('.bz2'), the gzip format ('.gz'), and the lzma format ('.lzma').

---

✨ OPTIONS ✨

• -h — display some help 🫶
• -ggeop — geometry parameters, which can be an arbitrary combination of any of the following code letters:
  • n — do not read geometry data, when it is not available or not required, such as when using the -om option.
  • p — permute Y and Z geometry dimensions.
  • r — rotate geometry by 90 degrees in the (X,Y) plane.
• -h — display some help. (yes, it's listed again, that's just how the page is 💀)
• -mn — do not read mapping data, when it is not available or not required.
• -ooutp — select the output file type, and it also allows you to provide additional parameters between braces and separated by commas:
  • i — OpenInventor 3D mesh file, to be viewed by means of programs such as ivview. additional parameters for this output file type are:
    • c — color output.
    • g — gray level output.
    • r — remove cut edges.
    • v — view cut edges.
  • m — PostScript matrix pattern file. additional parameters for this output file type are:
    • e — EPSF-type output.
    • f — full-page output.
  • p — PostScript 2D mesh file. this output module was intended for 2D meshes; as a fallback, the Z coordinate is projected according to isometric perspective rules, but drawings of full 3D objects are most likely to be unreadable 😭. additional parameters for this output file type are:
    • c — color output.
    • g — gray level output.
    • e — EPSF-type output.
    • f — full-page output.
    • s — short clipping (disks excluded).
    • l — large clipping (disks included).
    • a — avoid displaying disks.
    • d — display disks.
    • r — remove cut edges.
    • v — view cut edges.
    • X=rat — maximum x clipping ratio (in [0.0;1.0]).
    • x=rat — minimum x clipping ratio.
    • Y=rat — maximum y clipping ratio.
    • y=rat — minimum y clipping ratio.
  • t — Tulip 3D mesh file. additional parameters for this output file type are:
    • b — black and white output.
    • c — color output.
    • a — avoid displaying disks.
    • d — display disks.
    • r — remove cut edges.
    • v — view cut edges.
• -V — display program version and copyright.

---

🎀 EXAMPLES 🎀

1. build an OpenInventor file of the mapping of graph brol.grf contained in file brol.map. vertices with no mapping information attached to them will be rendered in white, while distinct colors will be used to represent the different parts. cut edges will be removed:

$ gout '-oi{r}' brol.grf brol.xyz brol.map brol.iv
$ ivview brol.iv

2. build an OpenInventor file of graph brol.grf without any vertex information associated to it. mapping data are not required and will not be read, but a file name has to be provided, hence the '-':

$ gout -oi -mn brol.grf brol.xyz - brol.iv

3. output the pattern of matrix brol.grf on the form of a PostScript flat drawing. geometry and mapping data are not required and will not be read, but file names have to be provided, hence the two '-'s:

$ gout -om -gn -mn brol.grf - - brol.ps

4. output a PostScript 2D drawing of a rectangular portion graph brol.grf, with disks representing mapping data:

$ gout '-op{c,e,d,x=0.3,X=0.6,y=0.2,Y=0.5}' brol.grf brol.xyz brol.map brol.ps

---

👀 SEE ALSO 👀

gmap(1), gout(1), gtst(1).

Scotch user's manual.

---

💜 AUTHOR 💜

Francois Pellegrini <francois.pellegrini@labri.fr>

---

and that's the whole page, bestie 🫶 this was gout(1) from the Scotch user's manual, dated 23 November 2019 — go forth and make some iconic graphics, you ate 💅✨