Linux Certif

Toute la documentation sur la certification Linux LPI

osiv_draw

NAME

osiv_draw - visualize flow field data

SYNOPSIS

osiv_draw [ -o output] [ -p file] [ -t type ] [vector file]

DESCRIPTION

osiv_draw creates a vector map from the vectors represented in the input text file. While osiv_draw will choose default values for all parameters, an optional parameter allows the figure to be fine-tuned. If no input file is specified, or if the input file name is "-", data is read from standard in. Similarly, if no output file is specified, or if the output file name is "-", data is written as an EPS to standard out.

OPTIONS

-q

In quiet mode, osiv_draw doesn't print out the parameters it chooses.

-o FILE

The file to which the graphic is written. This is either an EPS file or an SVG file depending on the -t option.

-t TYPE

This is either the string "eps" or "svg", depending on which type of file you would like to generate.

-p FILE

The name of a file from which parameters are read. The same parameters can be specified either on the command line or read from this file. The file is simply more convienent for batch processing. The format of the file is "variable = value", where each line is a new assignment. White space is ignored, blank lines are okay, and commented lines begin with the "#" symbol. The variables names which may be specified in the file are identical to those which may be specified in the comand line.

VECTOR FILE

Vectors are input into osiv_draw as a text file with a very simple format: "x,y;u,v". Each vector receives its own line, blank lines are allowed.

PARAMETERS

There are four types of parameters which can be assigned: floating-point numbers, strings, colors, and types. Floating-point numbers are assigned just as you would expect. Strings should be quoted on the command line to preserve formatting. Colors can be assigned either by name (see the online documentation for a list of named colors), or by RGB specification. To specify the RGB value of a color, you should use the format "rgb(red,green,blue)" where red, green, and blue are values between 0.0 and 1.0. Types are specified by name, possible values are listed for each variable below.

--arrow-scale FLOAT

The size of an arrow in points, for a vector with a magnitude of one. You should probably start with the value osiv_draw calculates, and then modify it to taste.

--canvas-scale FLOAT

The number of points in the figure per spatial unit. Roughly, this controls the overall size of the figure. Let osiv_draw calculate a default value which you can then modify.

--xrange-lower FLOAT

The lowest x value which is to be present in the figure.

--xrange-upper FLOAT

The greatest x value which is to be present in the figure.

--yrange-lower FLOAT

The lowest y value which is to be present in the figure.

--yrange-upper FLOAT

The greatest y value which is to be present in the figure.

--background-type TYPE

There are presently only two available types: none, and solid.

--background-fill-color COLOR

The color of background, used only with a solid background type.

--background-stroke-color COLOR

The color of outline around background, used only with a solid background type.

--background-stroke-weight FLOAT

The width of the outline in points around the background, used only with a solid background type.

--arrowhead-type TYPE

There are presently four available types: none, lines, outline, and curvy. If the names aren't self-explanatory, then try each one out.

--arrowhead-width FLOAT

The ratio of the arrowhead width to the total arrow length.

--arrowhead-height FLOAT

The ratio of the arrowhead height to the total arrow length.

--arrowhead-angle FLOAT

The angle in degrees at the back of the arrowhead. A value of 90 causes an arrowhead with a flat back, and values less than 90 cause it to curve inwardly.

--arrowhead-fill-color COLOR

The color of the arrowhead.

--arrowhead-stroke-color COLOR

The color of the arrowhead outline.

--arrowhead-stroke-weight FLOAT

The width in points of the arrowhead outline.

--arrowtail-type TYPE

There are currently three types available: none, line, and block. The block is different then the line in that it makes use of the fill argument, and the width scales with the overall arrow size.

--arrowtail-width FLOAT

The ratio of the arrowtail width to total arrow length.

--arrowtail-fill-color COLOR

The color of the arrowtail fill.

--arrowtail-stroke-color COLOR

The color of the arrowtail outline.

--arrowtail-stroke-weight FLOAT

The width in points of the arrowtail outline.

--legend-type TYPE

There are currently two types available: none, and solid.

--legend-placement TYPE

There are currently four types available: top_left, top_right, bottom_left, and bottom_right.

--legend-horiz-margin FLOAT

The horizontal distance in points between the edge of the figure and the edge of the legend.

--legend-vert-margin FLOAT

The vertical distance in points between the edge of the figure and the edge of the legend.

--legend-horiz-inset FLOAT

The horizontal spacing in points between the components of the legend.

--legend-vert-inset FLOAT

The vertical spacing in points between the components of the legend.

--legend-fill-color COLOR

The color of the legend fill.

--legend-stroke-color COLOR

The color of the legend outline.

--legend-stroke-weight COLOR

The width in points of the legend outline.

--legend-arrow-length FLOAT

The magnitude of the arrow (in user coordinates) to be represented in the legend.

--legend-arrow-label STRING

The string to be associated with the arrow.

--legend-arrow-label-font TYPE

The font for the label; possible values are: courier, times, times_bold, times_italic, helvetica, helvetica_bold, helvetica_italic.

--legend-arrow-label-color COLOR

The color for the label.

--legend-arrow-label-size FLOAT

The size of the font in points.

--legend-arrowhead-type TYPE

Same as above, just as it pertains to the legend.

--legend-arrowhead-width FLOAT

Same as above, just as it pertains to the legend.

--legend-arrowhead-height FLOAT

Same as above, just as it pertains to the legend.

--legend-arrowhead-angle FLOAT

Same as above, just as it pertains to the legend.

--legend-arrowhead-fill-color COLOR

Same as above, just as it pertains to the legend.

--legend-arrowhead-stroke-color COLOR

Same as above, just as it pertains to the legend.

--legend-arrowhead-stroke-weight FLOAT

Same as above, just as it pertains to the legend.

--legend-arrowtail-type TYPE

Same as above, just as it pertains to the legend.

--legend-arrowtail-width FLOAT

Same as above, just as it pertains to the legend.

--legend-arrowtail-fill-color COLOR

Same as above, just as it pertains to the legend.

--legend-arrowtail-stroke-color COLOR

Same as above, just as it pertains to the legend.

--legend-arrowtail-stroke-weight FLOAT

Same as above, just as it pertains to the legend.

--legend-ruler-length FLOAT

The length of the ruler (in user coordinates) to be represented in the legend.

--legend-ruler-label STRING

The string to be associated with the ruler.

--legend-ruler-label-font TYPE

The font used for the label; possible values are: courier, times, times_bold, times_italic, helvetica, helvetica_bold, helvetica_italic.

--legend-ruler-label-color COLOR

The color of the string.

--legend-ruler-label-size FLOAT

The size of the font in points.

--legend-ruler-width FLOAT

The ratio of the width of the ruler to its overall length.

--legend-ruler-fill-color COLOR

The color of the ruler fill.

--legend-ruler-stroke-color COLOR

The color of the ruler outline.

--legend-ruler-stroke-weight FLOAT

The width in points of the ruler outline.

MORE INFO

Additional documentation can be found online at www.osiv.org.

SEE ALSO

osiv_corr(1), osiv_dump(1), osiv_tune(1), osiv_synth(1),
readovd(3).

BUGS

No known bugs. Please report bugs as www.osiv.org.

COPYRIGHT NOTICE

Copyright © 2003-2005 James Strother.