Newer
Older
<!doctype linuxdoc system>
<!--
Changelog:
2000-09-25 created the changelog after a week of initial editing PJT
2000-10-10 made consistent with VERSION 0.1 release PJT
2000-12-28 document new movie features for the new CVS version
and lotsa more commands described now PJT
-->
<article>
<!-- Title information -->
<title> Partiview (PC-VirDir)
<author> Peter Teuben
<abstract>
This document helps you installing and running the development version
of partiview.
Quite a few things in this manual have not been fleshed
out, in particular the detailed description of all the commands.
</abstract>
<!-- Table of contents -->
<toc>
<!-- Begin the document -->
<!--------------------------------------------------------------------------- -->
This assumes you have the October 2000 release (version 0.1 or later) of
<bf/partiview/, not the earlier "<bf/gview/" release that was described
in earlier versions of this document. We keep copies of some support
<htmlurl url="http://www.astro.umd.edu/nemo/amnh"
name="http://www.astro.umd.edu/nemo/amnh"> website. Note that
this current development release is only documented for work under Linux,
although we expect it to work for at least SGI and maybe Solaris too.
<sect1> MESA/OpenGL
<p>
First make sure <tt/Mesa/ is installed, for <tt/redhat6.2/
there are rpm files
available. Check if you have the following:
<tscreen><code>
% rpm -qa | grep Mesa
Mesa-3.2-2
Mesa-devel-3.2-2
% rpm -i Mesa-3.2-2.i686.rpm Mesa-devel-3.2-2.i686.rpm
You should have both installed. Some packages will use <tt/libMesaGL/, others
<tt/libGL/. The <tt/configure/ script (see below)
should take care of the two possible options.
<p>
Homepage: <htmlurl url="http://mesa3d.sourceforge.org"
name="http://mesa3d.sourceforge.org">
<p>
Redhat packages: (part of powertools I believe)
<sect1> FLTK
<p>
Also make sure <tt/fltk/ is installed. If you got my version, do this (as
root)
% locate libfltk.a
% locate Fl_Slider.h
</code></tscreen>
(you only need it if you want to recompile the program at some point,
not if you just want to run it)
<p>
Homepage: <htmlurl url="http://www.fltk.org/"
name="http://www.fltk.org/">
<p>
Redhat packages: <htmlurl url="http://www.cs.cornell.edu/nogin/RPM/fltk-devel.html"
name="http://www.cs.cornell.edu/nogin/RPM/fltk-devel.html">
<sect1> partiview
<p>
Extract the tarball, and install the program from within the
<tt/src/ directory:
% tar zxf partiview-0.5.tar.gz
% cd partiview-0.5/src
% make depend (might need to make new local dependancies)
% make partiview (should not have to edit Makefile anymore)
Since <tt/partiview-0.3/ is under CVS control, and occasionally we
will stamp out a new release when we deem it stable. Anonymous CVS may also
be offered, but this is not currently enabled. Currently the
CVS repository machine is
<tt/grus.astro.umd.edu/ and you will need to setup your developers account with
Peter (<tt/teuben@astro.umd.edu/). Here's a sample session with some commonly
used CVS commands:
<tscreen><code>
setenv CVSROOT :pserver:pteuben@grus.astro.umd.edu:/grus/cvsroot
setenv CVS_RSH ssh (not needed for pserver access though)
cvs login (only needed once, and only for pserver type access)
mkdir ~/cvsstuff
cd ~/cvsstuff
cvs checkout partiview # get a new local sandbox to work in, or
cvs -n -q update partiview # check if others had made any changes
cvs update partiview # if so, update your sandbox and/or resolve conflicts
emacs partibrains.c # edit some files
./partiview # test the program
emacs partipanel.cc # edit another file
make all # check if it still compiles
cvs update # if so, update your sandbox again, resolve conflicts
cvs release partiview # if you want to release and remove this sandbox
<!--------------------------------------------------------------------------- -->
Here is the directory structure, as per version 0.1:
<p>
<tscreen><verb>
partiview/ root directory
partiview/src source code
partiview/data sample datafiles (e.g. Hipparcos Bright Star Catalogue)
partiview/doc manual (sgml, and derived html, txt, ps/dvi)
partiview/nemo NEMO specific converters/code
partiview/starlab STARLAB specific converters/code
partiview/windows windows executables/support (old)
</verb></tscreen>
<sect> Running the program
<p>
First we describe a simple example how to run <tt/partiview/ with a supplied sample
dataset. Then we describe the different windows that <tt/partiview/ is made up of, and
the different commands and keystrokes it listens to.
<sect1> Example 1: Hipparcos Bright Star Catalogue 3-D viewing
Start the program using one of the sample "speck" files in the
% cd partiview/data
and this should come up with a display. You should probably enlarge the
window a bit. Mine comes up in roughly a 300 by 300 display window,
which may be a bit small (certainly on my screen :-)
Hit the TAB key to bring focus to the (one line) command window inbetween
the log screen (top) and viewing screen (bottom). Type the commands
<tscreen><code>
fov 50 (field of view 50 degrees)
jump 0 0 0 80 70 60 (put yourself in the origin
and it should give a nice comfy view :-) If you ever get lost, use
the <tt/jump/ command to go back to a known position and/or viewing
angle, or just the <tt/center/ command.
<figure loc="tbp">
<img src="pv1.gif">
<caption>partiview view</caption>
</figure>
<p>
Now play with the display, use the 't', 'r', 'f' and 'o' keys in the viewing
window and use the
left and mouse buttons down to (carefully) move around a bit, and make
yourself comfortable with moving around. Using the 't' button you get
some idea of the distance of the stars by moving back and forth a little
(the parallax trick). In fact, if you 't' around a little bit, you may
see a green line flashing through the display. This is one of the RGB
(xyz) axes attached to the (0,0,0) [our sun] position. You should see
Procyon and Sirius exhibit pretty large parallaxes, but Orion is pretty
steady since it is several hundred parsecs away.
If you move the right mouse button you will zoom in/out and
should see our Sun flash by with the red-green-blue axes.
<p>
The RGB axes represent the XYZ axes in a cartesian system. For the Hipparchos
data the X (red) axis points to RA=0h, Y (green) axis to RA=6h, both in the equatorial
plane, and the Z (blue) axis points to the equatorial north pole.
Try and use the middle mouse button (or the 'p' key) to click on Sirius
or Procyon, and see if you can get it to view its properties. Now use
the 'P' key to switch center to rotation to that star. Sirius is
probably a good choice. Move around a bit, and try and get the sun and orion
in the same view :-)
<p>
[NOTE: these Hipparcos data do not have reliably distance above
100-200 pc, so Orion's distances are probably uncertain to 30%]
<p>
A little bit on the types of motion, and what the mouse buttons do
<tscreen><code>
| left middle right
| Button-1 Button-2 Button-3 Shift Button-1
------------------------------------------------------------------------------------
r (rotate) | rotate X/Y 'pick' rotate Z (+bug?) translate
t (translate) | translate 'pick' zoom
</code></tscreen>
The point of origin for rotations can be changed with the 'P' button.
First you can try and pick ('p' or Button-2) a point, and if found,
hit 'P' to make this point the new rotation center default.
<tscreen><code>
red = X axis
green = Y axis
blue = Z axis
</code></tscreen>
<sect1> Top Row
<p>
The top row, from left to right, shows the following buttons:
<p>
<descrip>
<tag> More </tag>
Pulldown g1, g2, ... (or whichever group)
is the currently selected group. See <tt/object/ command
to make aliases which group is defined to what object. If multiple
groups are defined, the next row below this contains a list of all
the groups, and their aliases, so you can toggle them to be displayed.
Pulldown to select fly/orbit/rot/tran, which can also be activate
by pressing the f/o/r/t keys inside the viewing window.
<tag> point </tag>
Toggle to turn the points on/off. See also the <tt/points/ command.
Toggle to turn polygons on/off. See also the <tt/polygon/ command.
Toggle to turn labels on/off. See also the <tt/label/ command.
Toggle to turn textures on/off. See also the <tt/texture/ command.
Toggle to turn boxes on/off. See also the <tt/boxes/ command.
<tag> #.### </tag>
The current displayed value of <tt/logslum lum/ (see below)
Slider controlling a <bf/datavar/ variable (the one selected as
luminosity)
</descrip>
<sect1> Group row (optional)
<p>
When more than one group has been activated (groups of particles or objects
can have their own display properties, and be turned on and off at will),
a new Group Row will appear as the 2nd row. You can then toggle the display
of these groups.
<sect1> Time Animation rows (Optional)
The third and fourth row from the top control playing sequences
of time, including a trip meter. This
time-control bar is only visible when the object has a nonzero
<descrip>
<tag> T </tag>
Shows the current time (or offset from the tripmeter).
The absolute time is the sum of the <bf/T/ and <bf/+/ fields.
Both are editable.
<tag>trip </tag>
Press to mark a reference point in time.
The T field becomes zero, and the + field (below)
is set to current time. As time passes, T shows the
offset from this reference time.
<tag>back </tag>
Press to return to reference time (sets T to 0).
<tag> dial </tag>
<tag> |< </tag>
<tag> >| </tag>
<tag> + </tag>
Current last time where tripmeter was set. You can reset to
the first frame with the command <tt/step 0/
<tag> #.#### </tag>
(Logarithmic) value denoting the speed of animation.
<tag> << </tag> toggle movie move backwards in time
<tag> >> </tag> toggle movie move forwards in time
The fifth (or 4th or 3rd, depending if Group and/or TIme rows are present)
row from the top controls loading and playing sequences of moving through space.
<p>
<descrip>
<tag> Load... </tag>
Brings up a filebrowser to load a <bf/.wf/ path file. This is a file with on each
line 7 numbers: xyz location, RxRyRz viewing direction, and FOV (field of view).
The <tt/rdata/ command loads such path files too.
Play the viewpoint along the currently loaded path,
as the <tt/play/ command does.
Right-click for a menu of play-speed options.
<tag> << < [###] >>> </tag>
Control individual path frames
<tag> slider </tag>
Slider
</descrip>
The third window from the top contains a logfile of past commands
and responses to them, and can be resized by dragging the bar between
command window and viewing window.
The Logfile window also has a scroll bar on the left. You can
direct the mouse to any previous command, and it will show up in the
command window. Using the arrow keys this command can then be edited.
The Command window is a single line entry window, in which Control
Commands can be given. Their responses appear in the Logfile
window and on the originating console. (unlike Data Commands,
which show no feedback).
The Up- and Down-arrow keys (not those on the keypad) scroll through
previous commands, and can be edited using the arrow keys and a subset
of the emacs control characters.
The (OpenGL) Viewing window is where all the action occurs. Typically
this is where you give single keystroke commands and/or move the mouse
for an interactive view of the data. It can be resized two ways:
either by resizing the master window, or by picking up the separator
between Viewing window and Command window above.
<sect1> Example 2: a (starlab) animation
<p>
Setting up a small animation in for example Starlab can be done quite simply as follows:
<tscreen><code>
mkplummer -i -n 20 | mkmass -l 0.5 -u 10.0 | scale -s | kira -d 2 -D x10 > run1
(lots of output from kira will still appear on the screen)
partiview run1.cf
cat run1.cf
eval every
eval lum mass 0 0.01
eval psize 100
eval cment 1 1 .7 .3
eval color clump exact
</code></tscreen>
Alternatively, if you had started up partiview without any arguments, the following
Control Command (see below) would have done the same
<tscreen><code>
<sect1> Example 3: stereo viewing
<p>
The 's' key within the viewing window toggles stereo viewing. By default each
object is split in a blue and a red part, that should be viewed with a pair
of red(left)/blue(right) glasses. Red/Green glasses are also popular in the
industry, and you need the change the color
<!--------------------------------------------------------------------------- -->
<sect> Commands
<p>
There are two types of commands in <tt/partiview/:
Control Commands and Data Commands.
Probably the most important difference between the two is that Control
Commands return feedback to the user, whereas Data Commands
are interpreted "as is". Control Commands are entered in the command window.
But once in Control Command mode,
you can still let commands become Data Commands (using the
<tt/add/ Control Command, and in Data Command mode one can
let a command be a Control Command by preceding it with the
<tt/eval/ command. Before we explain the two types of Commands in
more detail, a few other concepts are needed:
<!--------------------------------------------------------------------------- -->
<sect1> Textures
<p>
<!--------------------------------------------------------------------------- -->
<sect1> Coordinates and Coordinate Transformations
<p>
<!--------------------------------------------------------------------------- -->
<sect1> Grouping of objects
<p>
While the data are being read, particles can be grouped in different object
groups, each of which can be manipulated and displayed on its own. The Group
Row, which appears if more than one group is defined, allows easy access
to the different groups.
<!--------------------------------------------------------------------------- -->
<sect1> Control Commands
(see partibrains.c::specks_parse_args)
<p>
prefixed with a generic group designation, <tt/gN/, to which this command
applies. See the <tt/object/ Data Command how to place different data in
different groups.
<p>
Data Commands can also be given, if prefixed with the <tt/add/ command.
read a file containing data commands (typical suffix .cf or .speck).
NOTYET (would read a file containing control commands)
Enable display of currently selected group (as it is by default).
see the <tt/on/ command.
see the <tt/off/ command.
eval <it/control-command/
Invoke that control command just as if the <tt/eval/ prefix weren't there.
Provided for symmetry: wherever either a Control command or a Data command
is expected, <tt/eval/ <it/control-command/ ensures that it's
taken as a control command.
add <it/data-command/
This will enter a Data Command while in Control Command mode.
This will allow you to execute an arbitrary unix command, the subprocess
of which its <it/stdout/ will be taken as a stream of Control Commands.
Ensures the screen is updated, as before taking a snapshot.
hist <it/datavar/ [-n <it/nbuckets/][-l] [-c] [-t] [<it/minval/] [<it/maxval/]
Generates a histogram of values of the datafield named by <it/dataval/.
<p>
-l logarithmic, -c clipped, -t threshed.
Reports 3D extent of the data
For time-dependent data, advance datatime by this many time units
per wall-clock second.
(note that <tt/fspeed/ has been deprecated)
fade [planar|spherical|linear <it/refdist/|const <it/refdist/]
Determines how distance affects particles' apparent brightness (or "size").
The default <tt/fade planar/ gives 1/r^2 light falloff, with r measured
as distance from the view plane. <tt/fade spherical/ is also 1/r^2,
but with r measured as true distance from the viewpoint.
<tt/fade linear/ <it/refdist/ gives 1/r light falloff -- not physically
accurate, but useful to get a limited sense of depth.
<tt/fade const/ <it/refdist/ gives constant apparent brightness
independent of distance, and may be appropriate for orthographic views.
The <it/refdist/ for linear and const modes is that distance <it/r/
at which apparent brightness should match that in the 1/r^2 modes --
a distance to a "typical" particle.
Display only a 3D subregion of the data -- the part lying within the clipbox.
<descrip>
<tag> <it/xmin ymin zmin xmax ymax zmax/ </tag> <p>
<tag> <it/xcen,ycen,zcen xrad,yrad,zrad/ </tag><p>
<tag> <tt/on/ </tag><p>
<tag> <tt/off/ </tag><p>
</descrip>
<tag>
object
</tag>
<tag>
tfm
</tag>
<tag>
bgcolor
</tag>
Set window background color (three R G B numbers or one grayscale value).
<tag>
kiractl
</tag>
viewing control options for kira (starlab)
formatted data that have been read in with
the <tt/kira/ Data Command.
<descrip>
<tag> kira node {on|off|root} </tag> <p>
Show or hide center-of-mass nodes for multiple stars.
With <tt/on/, show CM nodes for each level in a binary tree.
With <tt/root/, show only the top-level CM node for each multiple.
<tag> kira ring {on|off|root} </tag> <p>
Show circles around multiple stars; <tt/on/ and <tt/root/ as above.
<tag> kira tree {on|off|cross|tick} [<it/tickscale/] </tag> <p>
Show lines connecting pairs of stars at each binary-tree level
in a multiple group. With <tt/cross/, also show a perpendicular
line -- a tick mark -- which crosses at the CM point,
and whose length is <tt/tickscale/ (default 0.5) times the
true separation of the pair.
With <tt/tick/, just show the tick-mark with no connecting line.
<tag> kira size <it/fac/ </tag> <p>
<tag> kira span <it/minpix/ <it/maxpix/ </tag> <p>
<tag> kira track <it/id/ </tag> <p>
<tag> ??? scale </tag> <p>
</descrip>
<tag>
gN <it/control-command/
</tag>
Generic prefix to any control command to act on the selected group <it/gN/ (N=1,2,3,....).
stereo [on|off|redcyan|glasses] [<it/separation/]
Stereo display. If hardware allows it, <tt/stereo glasses/ selects
CrystalEyes-style stereo. All systems should be capable of
<tt/stereo redcyan/, which requires wearing red/green or red/blue glasses.
Useful <it/separation/ values might be 0.02 to 0.1, or -0.02 to -0.1 to swap
eyes. See also <tt/focallen/ command, which gives the distance to
a typical object of interest: left- and right-eye images of an object
at that distance will coincide on the screen.
take a snapshot of the current viewport (uses convert(1))
clip NEAR FAR
</tag>
Set or get clipping distances
Angular field of view (in degrees) in Y-direction.
focal <it/distance/
focallen <it/distance/
stereo display. The focal length also determines the fly/tran speed.
jump [<it/X Y Z/] [<it/Rx Ry Rz/]
Get or set the current position (XYZ) and/or viewing (RxRyRz) angle.
Read a Wavefront (<tt/.wf/) file describing a path through space.
Play the currently loaded (from <tt/readpath//<tt/rdata/) camera animation
path, at <it/speed/ times normal speed,
skipping frames as needed to keep up with wall-clock time.
(Normal speed is 30 frames per second.)
With "f" suffix, displays every <it/speed/-th frame, without regard to real
time.
Get, or set the current frame the <it/frameno/-th.
cen[ter] [<it/X Y Z/ [<it/RADIUS/]]
int[erest] [<it/X Y Z/ [<it/RADIUS/]]
Set point of interest. This is the center of rotation in
<tt/[o]rbit/ and <tt/[r]otate/ modes. And, in <tt/[o]rbit/ mode,
translation speed is proportional to the viewer's distance from this point.
The optional <it/RADIUS/ (also set by <tt/censize/) determines the size
of the marker crosshair, initially 1 unit.
step [<it/timestep/]
step [+|-]<it/deltatimestep/
For time-varying data, sets current timestep number.
Real-valued times are meaningful for some kinds of data including those
from starlab; for others, times are rounded to nearest integer.
If preceded with a plus or minus sign, adds that amount to current time.
Erase all particles in this group. Useful for reloading on the fly.
Display a random subset (every <it/N/-th) of all particles.
Reports current subsetting factor, and the current total number of particles.
color <it/colorvar/ [<it/minval maxval/]
color <it/colorvar/ exact <it/baseval/
color <it/colorvar/ -exact
color const <it/R G B/
lum
lum <it/lumvar/ [<it/minval maxval/]
lum const <it/L/
Report names and value ranges (over all particles) of all named data fields
for the current group.
For asynchronously-loaded data (currently only <tt/ieee/ data command),
say whether wait for current data step to be loaded.
(If not, then keep displaying previous data while loading new.)
Load (ascii) filename with RGB values, for coloring particles.
The <tt/color/ command selects which data field is mapped to color index
and how.
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
</tag>
<tag>
cment
</tag>
<tag>
boxcment
</tag>
<tag>
only
</tag>
<tag>
thresh
</tag>
<tag>
rawdump
</tag>
<tag>
slum
</tag>
<tag>
scale-lum
</tag>
<tag>
see
</tag>
<tag>
show
</tag>
<tag>
showbox
</tag>
<tag>
hide
</tag>
<tag>
hidebox
</tag>
<tag>
Toggle box display between
<tt/off/, <tt/ON/, or <tt/ONLY/. (notice case sensitivity)
Toggle or set box label display mode.
</tag>
<tag>
go
</tag>
<tag>
gobox
</tag>
<tag>
goboxscale
</tag>
<tag>
<!-- DEPRECATED COMMAND
</tag>
<tag>
polylum
</tag>
<tag>
polyminpixels
</tag>
<tag>
labelminpixels
</tag>
<tag>
labelsize
</tag>
<tag>
lsize
</tag>
<tag>
Toggle the display status of points (the <tt/point/ status in the top row), or
explicitely set point display <tt/on/ or <tt/off/.
Toggle the display status of labels (the <tt/poly/ status in the top row), or
explicitely set polygon display <tt/on/ or <tt/off/.
Toggle the display status of textures (the <tt/tex/ status in the top row), or
explicitely set textures <tt/on/ or <tt/off/.
Toggle the display status of labels (the <tt/lbl/ status in the top row), or
explicitely set labels <tt/on/ or <tt/off/.
</tag>
<tag>
polyorivar
</tag>
<tag>
texturevar
</tag>
<tag>
polyside(s)
Number of sides a polygon should have