1gout(1)                      Scotch user's manual                      gout(1)
2
3
4

NAME

6       gout - output graphics from matrices and graphs
7

SYNOPSIS

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

DESCRIPTION

12       The  gout program creates graphics files of various types, representing
13       the Scotch graph and mapping data which is passed to it.
14
15       Source graph file gfile can only be  a  centralized  graph  file.  File
16       xfile  stores  its  associated geometry, whenever necessary. File mfile
17       represents label information attached to each of  the  graph  vertices,
18       for  instance the index of the part to which each vertex belongs in the
19       case of a mapping file. File vfile is the  output  graphics  file,  the
20       type  of  which may differ according to the input parameters. When file
21       names are not specified, data is read from standard input  and  written
22       to standard output. Standard streams can also be explicitly represented
23       by a dash '-'.
24
25       When the proper libraries have been included at compile time, gtst  can
26       directly  handle  compressed graphs, both as input and output. A stream
27       is treated as compressed whenever its name is  postfixed  with  a  com‐
28       pressed  file  extension, such as in 'brol.grf.bz2' or '-.gz'. The com‐
29       pression formats which can be supported are the bzip2 format  ('.bz2'),
30       the gzip format ('.gz'), and the lzma format ('.lzma', on input only).
31

OPTIONS

33       -h     Display some help.
34
35       -ggeop Geometry  parameters,  which  can be an arbitrary combination of
36              any of the following code letters:
37
38              n      Do not read geometry data, when it is  not  available  or
39                     not required, such as when using the -om option.
40
41              p      Permute Y and Z geometry dimensions.
42
43              r      Rotate geometry by 90 degrees in the (X,Y) plane.
44
45       -h     Display some help.
46
47       -mn    Do  not  read  mapping  data,  when  it  is not available or not
48              required.
49
50       -ooutp Select the output file type and  allows  to  provide  additional
51              parameters between braces and separated by commas:
52
53              i      OpenInventor  3D mesh file, to be viewed by means of pro‐
54                     grams such as ivview. Additional parameters for this out‐
55                     put file type are:
56
57                     c      Color output.
58
59                     g      Gray level output.
60
61                     r      Remove cut edges.
62
63                     v      View cut edges.
64
65              m      PostScript matrix pattern file. Additional parameters for
66                     this output file type are:
67
68                     e      EPSF-type output.
69
70                     f      Full-page output.
71
72              p      PostScript 2D mesh file. This output module was  intended
73                     for  2D  meshes;  as a fallback, the Z coordinate is pro‐
74                     jected according  to  isometric  perspective  rules,  but
75                     drawings of full 3D objects are most likely to be unread‐
76                     able. Additional parameters for  this  output  file  type
77                     are:
78
79                     c      Color output.
80
81                     g      Gray level output.
82
83                     e      EPSF-type output.
84
85                     f      Full-page output.
86
87                     s      Short clipping (disks excluded).
88
89                     l      Large clipping (disks included).
90
91                     a      Avoid displaying disks.
92
93                     d      Display disks.
94
95                     r      Remove cut edges.
96
97                     v      View cut edges.
98
99                     X=rat  Maximum x clipping ratio (in [0.0;1.0]).
100
101                     x=rat  Minimum x clipping ratio.
102
103                     Y=rat  Maximum y clipping ratio.
104
105                     y=rat  Minimum y clipping ratio.
106
107              t      Tulip 3D mesh file. Additional parameters for this output
108                     file type are:
109
110                     b      Black and white output.
111
112                     c      Color output.
113
114                     a      Avoid displaying disks.
115
116                     d      Display disks.
117
118                     r      Remove cut edges.
119
120                     v      View cut edges.
121
122       -V     Display program version and copyright.
123

EXAMPLES

125       Build an OpenInventor file of the mapping of graph  brol.grf  contained
126       in file brol.map. Vertices with no mapping information attached to them
127       will be rendered in white, while distinct colors will be used to repre‐
128       sent the different parts. Cut edges will be removed:
129
130             $ gout '-oi{r}' brol.grf brol.xyz brol.map brol.iv
131             $ ivview brol.iv
132
133       Build  an OpenInventor file of graph brol.grf without any vertex infor‐
134       mation associated to it. Mapping data are not required and will not  be
135       read, but a file name has to be provided, hence the
136
137             $ gout -oi -mn brol.grf brol.xyz - brol.iv
138
139       Output  the pattern of matrix brol.grf on the form of a PostScript flat
140       drawing. Geometry and mapping data are not required  and  will  not  be
141       read, but file names have to be provided, hence the two '-'s:
142
143             $ gout -om -gn -mn brol.grf - - brol.ps
144
145       Output a PostScript 2D drawing of a rectangular portion graph brol.grf,
146       with disks representing mapping data:
147
148             $ 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
149
150
151

SEE ALSO

153       gmap(1), gout(1), gtst(1).
154
155       Scotch user's manual.
156

AUTHOR

158       Francois Pellegrini <francois.pellegrini@labri.fr>
159
160
161
162                              September 08, 2008                       gout(1)
Impressum