diff --git a/doc/iau208/Makefile b/doc/iau208/Makefile index 201a2cde5cb32f9fb2247f4c6ea569ddf522533e..9a493ac4fdef4dad9efb60ddd924a1ae027b4676 100644 --- a/doc/iau208/Makefile +++ b/doc/iau208/Makefile @@ -15,4 +15,4 @@ tar: ${FIGS} .SUFFIXES: .ps .png .png.ps: - convert $*.png pgm:- | pnminvert | pnmtops -noturn > $@+ && mv $@+ $@ + convert $*.png pgm:- | pnminvert | pnmtops -nosetpage -noturn > $@+ && mv $@+ $@ diff --git a/doc/partiview-1.html b/doc/partiview-1.html index 7206175146a98a17ef20f3cb1b9e909e1dc813cb..bfa84ff615e9b9ef85736dc6705deace8832e72d 100644 --- a/doc/partiview-1.html +++ b/doc/partiview-1.html @@ -1,7 +1,7 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> <HTML> <HEAD> - <META NAME="GENERATOR" CONTENT="SGML-Tools 1.0.9"> + <META NAME="GENERATOR" CONTENT="LinuxDoc-Tools 0.9.20"> <TITLE> Partiview (PC-VirDir): Installation</TITLE> <LINK HREF="partiview-2.html" REL=next> @@ -12,9 +12,9 @@ Previous <A HREF="partiview.html#toc1">Contents</A> <HR> -<H2><A NAME="s1">1. Installation</A></H2> +<H2><A NAME="s1">1.</A> <A HREF="partiview.html#toc1">Installation</A></H2> + -<P> <P>This assumes you have the July 2001 release (version 0.6 or later) of <B>partiview</B>, not the earlier "<B>gview</B>" release that was described in earlier versions of this document. We keep copies of some Linux support @@ -22,20 +22,20 @@ files (Mesa, FLTK) on our current <A HREF="http://www.astro.umd.edu/nemo/amnh">http://www.astro.umd.edu/nemo/amnh</A> website. Although more current versions of support libraries may be available, they may not have been tested out. This release has been tried on -Linux (red hat 6.2, 7.1, 7.2), Irix and Windows. +Linux (red hat 6.2, 7.1, 7.2), Irix and Windows.</P> <P>partiview needs two libraries to compile: OpenGL (or MESA) for the drawing operations, and FLTK for the graphical user interface. -These libraries are known to work on MS-Windows as well as many Unix flavors. -<P> -<P> -<H2><A NAME="ss1.1">1.1 MESA/OpenGL</A> +These libraries are known to work on MS-Windows as well as many Unix flavors.</P> + + +<H2><A NAME="ss1.1">1.1</A> <A HREF="partiview.html#toc1.1">MESA/OpenGL</A> </H2> -<P> + <P>First make sure <CODE>Mesa</CODE> is installed, for <CODE>redhat6.2</CODE> there are rpm files available. For <CODE>redhat7.1+</CODE> they are now included in the basic distribution. -Check if you have something like the following (version numbers may be different): +Check if you have something like the following (version numbers may be different):</P> <P> <BLOCKQUOTE><CODE> <HR> @@ -50,24 +50,26 @@ else: </PRE> <HR> </CODE></BLOCKQUOTE> +</P> <P>You should have both installed. Some packages will use <CODE>libMesaGL</CODE>, others <CODE>libGL</CODE>. Our <CODE>configure</CODE> script (see below) -should take care of the two possible options. +should take care of the two possible options.</P> <P>Homepage: -<A HREF="http://mesa3d.sourceforge.net/">http://mesa3d.sourceforge.net/</A><P> -<P>Redhat packages: (part of powertools I believe) -<P> +<A HREF="http://mesa3d.sourceforge.net/">http://mesa3d.sourceforge.net/</A></P> + +<P>Redhat packages: (part of powertools I believe)</P> + <P> Mesa3D is under continuous development. As of this writing the stable release is 4.0.1, but it has not been tested with the current partiview release. Redhat 7.1 comes with Mesa-3.4 and also works with partiview. -You can also use a CVS release of Mesa. -<P> -<H2><A NAME="ss1.2">1.2 FLTK</A> +You can also use a CVS release of Mesa.</P> + +<H2><A NAME="ss1.2">1.2</A> <A HREF="partiview.html#toc1.2">FLTK</A> </H2> <P>Also make sure <CODE>FLTK</CODE> is installed. If you got our version, do this (as -root) -<P> +root)</P> + <P> <BLOCKQUOTE><CODE> <HR> @@ -83,25 +85,29 @@ if they fail, then </PRE> <HR> </CODE></BLOCKQUOTE> +</P> <P>(you only need it if you want to recompile the program at some point, -not if you just want to run it) +not if you just want to run it)</P> <P>Homepage: -<A HREF="http://www.fltk.org/">http://www.fltk.org/</A><P>Redhat packages: -<A HREF="http://www.cs.cornell.edu/nogin/RPM/fltk-devel.html">http://www.cs.cornell.edu/nogin/RPM/fltk-devel.html</A><P>Find rpms: -<A HREF="http://rpmfind.net">http://rpmfind.net</A><P> +<A HREF="http://www.fltk.org/">http://www.fltk.org/</A></P> +<P>Redhat packages: +<A HREF="http://www.cs.cornell.edu/nogin/RPM/fltk-devel.html">http://www.cs.cornell.edu/nogin/RPM/fltk-devel.html</A></P> +<P>Find rpms: +<A HREF="http://rpmfind.net">http://rpmfind.net</A></P> + <P> FLTK is under continuous development. Versions from 1.0.9 through 1.1.0rc3 have been successfully tested with partiview. The upcoming 2.0 -version of FLTK is unlikely to work with partiview. -<P> -<P> -<H2><A NAME="ss1.3">1.3 partiview</A> +version of FLTK is unlikely to work with partiview.</P> + + +<H2><A NAME="ss1.3">1.3</A> <A HREF="partiview.html#toc1.3">partiview</A> </H2> -<P> + <P>You can decide to use a branded version, usually available as a tar or zip file, or use the CVS (see below). Extract the tarball, and install the program from within the -<CODE>src</CODE> directory: +<CODE>src</CODE> directory:</P> <P> <BLOCKQUOTE><CODE> <HR> @@ -116,16 +122,17 @@ Extract the tarball, and install the program from within the </PRE> <HR> </CODE></BLOCKQUOTE> -<P> +</P> + <P>If you encounter difficulties of locating either the FLTK or MESA/OpenGL libraries, configure script options can specify them: <CODE>--with-fltk=</CODE><I>dirname</I> names the directory which contains the <CODE>lib</CODE> and <CODE>FL</CODE> subdirectories, <CODE>--with-mesa=</CODE><I>dirname</I> can specify the Mesa installation directory [??], and <CODE>--with-kira=</CODE><I>dirname</I> names the Starlab directory, whose default -value is taken from environment variable STARLAB_PATH if that is set. -<P> -<H2><A NAME="ss1.4">1.4 CVS</A> +value is taken from environment variable STARLAB_PATH if that is set.</P> + +<H2><A NAME="ss1.4">1.4</A> <A HREF="partiview.html#toc1.4">CVS</A> </H2> <P>Since version 0.5 <CODE>partiview</CODE> is under CVS control, and occasionally we @@ -133,7 +140,7 @@ will stamp out a new release when we deem it stable. Anonymous or read-only CVS access is also offered. Currently the CVS repository machine is <CODE>cvs.astro.umd.edu</CODE> and you will need to setup your developers account with Peter (<CODE>teuben@astro.umd.edu</CODE>). Here's a sample session with some commonly -used CVS commands: +used CVS commands:</P> <P> <BLOCKQUOTE><CODE> <HR> @@ -165,16 +172,17 @@ used CVS commands: </PRE> <HR> </CODE></BLOCKQUOTE> -<P> -<H2><A NAME="ss1.5">1.5 Compiling under Windows</A> +</P> + +<H2><A NAME="ss1.5">1.5</A> <A HREF="partiview.html#toc1.5">Compiling under Windows</A> </H2> <P>Partiview can be compiled from the command line on Windows using either the Microsoft Visual C tools (<CODE>cl, nmake,</CODE> etc.) or using <CODE>gcc/g++</CODE> with <CODE>MinGW32, MSYS and w32api</CODE>. The MinGW route is currently the only way to compile with kira/Starlab support. There's no provision for building -partiview within the MS Visual Studio GUI. -<P>To compile with Microsoft C: +partiview within the MS Visual Studio GUI.</P> +<P>To compile with Microsoft C:</P> <P> <OL> <LI> Install FLTK using MS Visual C++ as described in its documentation.</LI> @@ -194,7 +202,8 @@ add the <CODE>Bin</CODE> directory to PATH, etc.</LI> Dependencies are <I>not</I> properly maintained by this Makefile, so use <CODE>nmake -f partiview.mak clean</CODE> if you change anything.</LI> </OL> -<P> +</P> + <P>To compile with MinGW and company, you'll need to: <OL> <LI> Install <CODE>MinGW</CODE> (gcc, etc.), its associated <CODE>w32api</CODE> @@ -273,7 +282,7 @@ to add MSYS and MinGW <CODE>bin</CODE> directories to it.</LI> the files <CODE>libdstar.a libdyn.a libnode.a librdc.a libsstar.a libstd.a libtdyn.a</CODE></LI> </OL> -<P> + </LI> <LI>Now, back in the <CODE>partiview/src</CODE> directory, use <CODE>configure</CODE> and <CODE>make</CODE> as under Unix. @@ -296,8 +305,9 @@ Note there's no need to specify the location of the OpenGL or other libraries; the configure script and MinGW tools already know where to find them.</LI> </OL> -<P> -<P> +</P> + + <HR> <A HREF="partiview-2.html">Next</A> Previous diff --git a/doc/partiview-2.html b/doc/partiview-2.html index 0d58ed57db3db46881b257792f2eef7fef031b7f..497b1d76741fe327d3f5db35ad0d2f2469f8e0b1 100644 --- a/doc/partiview-2.html +++ b/doc/partiview-2.html @@ -1,7 +1,7 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> <HTML> <HEAD> - <META NAME="GENERATOR" CONTENT="SGML-Tools 1.0.9"> + <META NAME="GENERATOR" CONTENT="LinuxDoc-Tools 0.9.20"> <TITLE> Partiview (PC-VirDir): Directory structure</TITLE> <LINK HREF="partiview-3.html" REL=next> <LINK HREF="partiview-1.html" REL=previous> @@ -12,11 +12,11 @@ <A HREF="partiview-1.html">Previous</A> <A HREF="partiview.html#toc2">Contents</A> <HR> -<H2><A NAME="s2">2. Directory structure</A></H2> +<H2><A NAME="s2">2.</A> <A HREF="partiview.html#toc2">Directory structure</A></H2> + + +<P>Here is the directory structure, as per version 0.1:</P> -<P> -<P>Here is the directory structure, as per version 0.1: -<P> <P> <BLOCKQUOTE><CODE> <PRE> @@ -31,7 +31,8 @@ </PRE> </CODE></BLOCKQUOTE> -<P> +</P> + <HR> <A HREF="partiview-3.html">Next</A> <A HREF="partiview-1.html">Previous</A> diff --git a/doc/partiview-3.html b/doc/partiview-3.html index 16512500e62c40581abc39fc1468a3bb5132f350..0a652344765503f31a4a0065df03674c4985746f 100644 --- a/doc/partiview-3.html +++ b/doc/partiview-3.html @@ -1,7 +1,7 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> <HTML> <HEAD> - <META NAME="GENERATOR" CONTENT="SGML-Tools 1.0.9"> + <META NAME="GENERATOR" CONTENT="LinuxDoc-Tools 0.9.20"> <TITLE> Partiview (PC-VirDir): Running the program</TITLE> <LINK HREF="partiview-4.html" REL=next> <LINK HREF="partiview-2.html" REL=previous> @@ -12,18 +12,18 @@ <A HREF="partiview-2.html">Previous</A> <A HREF="partiview.html#toc3">Contents</A> <HR> -<H2><A NAME="s3">3. Running the program</A></H2> +<H2><A NAME="s3">3.</A> <A HREF="partiview.html#toc3">Running the program</A></H2> <P>First we describe a simple example how to run <CODE>partiview</CODE> with a supplied sample dataset. Then we describe the different windows that <CODE>partiview</CODE> is made up of, and -the different commands and keystrokes it listens to. -<P> -<H2><A NAME="ss3.1">3.1 Example 1: Hipparcos Bright Star Catalogue 3-D viewing</A> +the different commands and keystrokes it listens to.</P> + +<H2><A NAME="ss3.1">3.1</A> <A HREF="partiview.html#toc3.1">Example 1: Hipparcos Bright Star Catalogue 3-D viewing</A> </H2> -<P> + <P>Start the program using one of the sample "speck" files in the -<CODE>data</CODE> directory: +<CODE>data</CODE> directory:</P> <P> <BLOCKQUOTE><CODE> <HR> @@ -35,15 +35,16 @@ or </PRE> <HR> </CODE></BLOCKQUOTE> +</P> <P>and this should come up with a display familiar to most of us who watch the skies. 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 :-) (Hint: the <CODE>.partiviewrc</CODE> file may contain commands like -<CODE>eval winsize 600 400</CODE>.) -<P> +<CODE>eval winsize 600 400</CODE>.)</P> + <P>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 +the log screen (top) and viewing screen (bottom). Type the commands</P> <P> <BLOCKQUOTE><CODE> <HR> @@ -55,18 +56,20 @@ the log screen (top) and viewing screen (bottom). Type the commands </PRE> <HR> </CODE></BLOCKQUOTE> +</P> <P>and it should give another nice comfy view :-) If you ever get lost, and this is not hard, use the <CODE>jump</CODE> command to go back to a known position and/or viewing -angle. +angle.</P> <P> <FIGURE> <IMG SRC="pv1.gif"> <CAPTION>partiview view</CAPTION> </FIGURE> -<P> +</P> + <P>Note that spatial units for this dataset are -parsecs, though angular units are degrees for any data in partiview. +parsecs, though angular units are degrees for any data in partiview.</P> <P>Now play with the display, use the 't', 'r', 'f' and 'o' keys (keys are case sensitive) in the viewing window and use the left and mouse buttons down to (carefully) move around a bit, and make @@ -78,20 +81,20 @@ see a green line flashing through the display. This is one of the RGB 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. +should see our Sun flash by with the red-green-blue axes.</P> <P>The RGB axes represent the XYZ axes in a (right-handed) cartesian system. For the Hipparcos 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. +plane, and the Z (blue) axis points to the equatorial north pole.</P> <P>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 :-) +in the same view :-)</P> <P>[NOTE: these Hipparcos data do not have reliably distance above -100-200 pc, so Orion's individual distances are probably uncertain to 30%] -<P> -<P>A little bit on the types of motion, and what the mouse buttons do +100-200 pc, so Orion's individual distances are probably uncertain to 30%]</P> + +<P>A little bit on the types of motion, and what the mouse buttons do</P> <P> <BLOCKQUOTE><CODE> <HR> @@ -107,11 +110,12 @@ t (translate) | translate 'pick' zoom </PRE> <HR> </CODE></BLOCKQUOTE> +</P> <P>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. -<P> -<P> +hit 'P' to make this point the new rotation center default.</P> + + <P> <BLOCKQUOTE><CODE> <HR> @@ -122,130 +126,134 @@ blue = Z axis </PRE> <HR> </CODE></BLOCKQUOTE> -<P>To choose an arbitrary center of rotation, use the <CODE>center</CODE> command. -<P> -<H2><A NAME="ss3.2">3.2 Top Row</A> +</P> +<P>To choose an arbitrary center of rotation, use the <CODE>center</CODE> command.</P> + +<H2><A NAME="ss3.2">3.2</A> <A HREF="partiview.html#toc3.2">Top Row</A> </H2> <P>The top row contains some shortcuts to some frequently used commands. -From left to right, it should show the following buttons: +From left to right, it should show the following buttons:</P> <P> <DL> -<P> + <DT><B> More </B><DD><P>Offers some mode switches as toggles: <CODE>inertia</CODE> for continues spin or motion, and an <CODE>H-R Diagram</CODE> to invoke a separate H-R diagram window -for datasets that support stellar evolution. -<P> +for datasets that support stellar evolution.</P> + <DT><B> [g1] </B><DD><P>Pulldown g1, g2, ... (or whichever group) is the currently selected group. See <CODE>object</CODE> 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. -<P> +the groups, and their aliases, so you can toggle them to be displayed.</P> + <DT><B> [f]ly </B><DD><P>Pulldown to select fly/orbit/rot/tran, which can also be activate -by pressing the f/o/r/t keys inside the viewing window. -<P> -<DT><B> point </B><DD><P>Toggle to turn the points on/off. See also the <CODE>points</CODE> command. -<P> -<DT><B> poly </B><DD><P>Toggle to turn polygons on/off. See also the <CODE>polygon</CODE> command. -<P> -<DT><B> lbl </B><DD><P>Toggle to turn labels on/off. See also the <CODE>label</CODE> command. -<P> -<DT><B> tex </B><DD><P>Toggle to turn textures on/off. See also the <CODE>texture</CODE> command. -<P> -<DT><B> box </B><DD><P>Toggle to turn boxes on/off. See also the <CODE>boxes</CODE> command. -<P> -<DT><B> #.### </B><DD><P>The current displayed value of the <CODE>logslum lum</CODE> slider (see next) -<P> +by pressing the f/o/r/t keys inside the viewing window.</P> + +<DT><B> point </B><DD><P>Toggle to turn the points on/off. See also the <CODE>points</CODE> command.</P> + +<DT><B> poly </B><DD><P>Toggle to turn polygons on/off. See also the <CODE>polygon</CODE> command.</P> + +<DT><B> lbl </B><DD><P>Toggle to turn labels on/off. See also the <CODE>label</CODE> command.</P> + +<DT><B> tex </B><DD><P>Toggle to turn textures on/off. See also the <CODE>texture</CODE> command.</P> + +<DT><B> box </B><DD><P>Toggle to turn boxes on/off. See also the <CODE>boxes</CODE> command.</P> + +<DT><B> #.### </B><DD><P>The current displayed value of the <CODE>logslum lum</CODE> slider (see next)</P> + <DT><B> logslum lum </B><DD><P>Slider controlling the logarithm of the <B>datavar</B> variable -selected as luminosity (with the <CODE>lum</CODE> command). -<P> +selected as luminosity (with the <CODE>lum</CODE> command).</P> + </DL> -<P> -<H2><A NAME="ss3.3">3.3 Group row (optional)</A> +</P> + +<H2><A NAME="ss3.3">3.3</A> <A HREF="partiview.html#toc3.3">Group row (optional)</A> </H2> <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. +a new Group Row will appear as the 2nd row.</P> <P>Left-clicking (button 1) on a button toggles the display of that group; right-clicking (button 3) enables display of the group, and also selects it as the current group for GUI controls and -text commands. -<P> -<H2><A NAME="ss3.4">3.4 Time Animation rows (Optional)</A> +text commands.</P> + +<H2><A NAME="ss3.4">3.4</A> <A HREF="partiview.html#toc3.4">Time Animation rows (Optional)</A> </H2> <P>For time-dependent data, the third and fourth row from the top control the currently displayed data-time. This time-control bar is only visible when the object -has a nonzero time range. +has a nonzero time range.</P> <P> <DL> -<P> + <DT><B> T </B><DD><P>Shows the current time (or offset from the tripmeter). The absolute time is the sum of the <B>T</B> and <B>+</B> fields. Both are editable. -See also the <CODE>step</CODE> control command. -<P> +See also the <CODE>step</CODE> control command.</P> + <DT><B>trip </B><DD><P>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. -<P> -<DT><B>back </B><DD><P>Press to return to reference time (sets T to 0). -<P> +offset from this reference time.</P> + +<DT><B>back </B><DD><P>Press to return to reference time (sets T to 0).</P> + <DT><B> + </B><DD><P>Current last time where tripmeter was set. You can reset to -the first frame with the command <CODE>step 0</CODE> -<P> +the first frame with the command <CODE>step 0</CODE></P> + <DT><B> dial </B><DD><P>Drag to adjust the current time. Sensitivity depends on the speed setting; dragging by one dial-width corresponds to 0.1 wall-clock second of animation, -i.e. 0.1 * <I>speed</I> in data time units. -<P> -<DT><B> |< </B><DD><P> +i.e. 0.1 * <I>speed</I> in data time units.</P> + +<DT><B> |< </B><DD> <DT><B> >| </B><DD><P>Step time backwards or forwards by 0.1 * <I>speed</I> data time units. -See also the <CODE><</CODE> and <CODE>></CODE> keyboard shortcuts. -<P> -<DT><B> << </B><DD><P> -<P> +See also the <CODE><</CODE> and <CODE>></CODE> keyboard shortcuts.</P> + +<DT><B> << </B><DD> + <DT><B> >> </B><DD><P>toggle movie move forwards in time Toggle animating backwards or forwards in time, by 1 * <I>speed</I> data time units per real-time second. -See also the <CODE>{</CODE>, <CODE>~</CODE>, and <CODE>}</CODE> keyboard shortcuts. -<P> +See also the <CODE>{</CODE>, <CODE>~</CODE>, and <CODE>}</CODE> keyboard shortcuts.</P> + <DT><B> #.#### </B><DD><P>(Logarithmic) value denoting <I>speed</I> of animation. -See also the <CODE>speed</CODE> control command. -<P> -<P> +See also the <CODE>speed</CODE> control command.</P> + + </DL> -<P> -<P> -<H2><A NAME="ss3.5">3.5 Camera (path) Animation row</A> +</P> + + +<H2><A NAME="ss3.5">3.5</A> <A HREF="partiview.html#toc3.5">Camera (path) Animation row</A> </H2> <P>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. +row from the top controls loading and playing sequences of moving through space.</P> <P> <DL> -<P> + <DT><B> Path... </B><DD><P>Brings up a filebrowser to load a <B>.wf</B> path file. This is a file with on each line 7 numbers: xyz location, RxRyRz viewing direction, and FOV (field of view). -The <CODE>rdata</CODE> command loads such path files too. -<P> +The <CODE>rdata</CODE> command loads such path files too.</P> + <DT><B> Play </B><DD><P>Play the viewpoint along the currently loaded path, as the <CODE>play</CODE> command does. -Right-click for a menu of play-speed options. -<P> +Right-click for a menu of play-speed options.</P> + <DT><B> << < [###] >>> </B><DD><P>Step through camera-path frames. -See also <CODE>frame</CODE> control command. -<P> -<DT><B> slider </B><DD><P>Slides through camera path, and displays current frame. -<P> +See also <CODE>frame</CODE> control command.</P> + +<DT><B> slider </B><DD><P>Slides through camera path, and displays current frame.</P> + </DL> -<P> -<H2><A NAME="ss3.6">3.6 Logfile window</A> +</P> + +<H2><A NAME="ss3.6">3.6</A> <A HREF="partiview.html#toc3.6">Logfile window</A> </H2> <P>The third window from the top contains a logfile of past commands @@ -253,10 +261,10 @@ 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. -<P> -<P> -<H2><A NAME="ss3.7">3.7 Command window</A> +command window. Using the arrow keys this command can then be edited.</P> + + +<H2><A NAME="ss3.7">3.7</A> <A HREF="partiview.html#toc3.7">Command window</A> </H2> <P>The Command window is a single line entry window, in which Control @@ -266,23 +274,23 @@ which show no feedback). You can still give Data Commands in this window by prefixing them with the <CODE>add</CODE> command. 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. -<P> -<P> -<H2><A NAME="ss3.8">3.8 Viewing window</A> +of the emacs control characters.</P> + + +<H2><A NAME="ss3.8">3.8</A> <A HREF="partiview.html#toc3.8">Viewing window</A> </H2> <P>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. -<P> -<H2><A NAME="ss3.9">3.9 Example 2: a (starlab) animation</A> +between Viewing window and Command window above.</P> + +<H2><A NAME="ss3.9">3.9</A> <A HREF="partiview.html#toc3.9">Example 2: a (starlab) animation</A> </H2> <P>Setting up a small animation in for example Starlab can be done quite simply as follows: -(see also the primbim16.mk makefile to create a standard one): +(see also the primbim16.mk makefile to create a standard one):</P> <P> <BLOCKQUOTE><CODE> <HR> @@ -301,8 +309,9 @@ between Viewing window and Command window above. </PRE> <HR> </CODE></BLOCKQUOTE> +</P> <P>Alternatively, if you had started up partiview without any arguments, the following -Control Command (see below) would have done the same +Control Command (see below) would have done the same</P> <P> <BLOCKQUOTE><CODE> <HR> @@ -312,17 +321,18 @@ Control Command (see below) would have done the same </PRE> <HR> </CODE></BLOCKQUOTE> -<P> -<H2><A NAME="ss3.10">3.10 Example 3: stereo viewing </A> +</P> + +<H2><A NAME="ss3.10">3.10</A> <A HREF="partiview.html#toc3.10">Example 3: stereo viewing </A> </H2> <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 will probably work too. Crosseyed viewing is also available if selected by <B>stereo cross</B>. -See <B>stereo</B> and <B>focallen</B> in the View Commands section. -<P> -<H2><A NAME="ss3.11">3.11 Example 4: subsetting</A> +See <B>stereo</B> and <B>focallen</B> in the View Commands section. </P> + +<H2><A NAME="ss3.11">3.11</A> <A HREF="partiview.html#toc3.11">Example 4: subsetting</A> </H2> <P>In the <CODE>data</CODE> directory, run @@ -361,10 +371,11 @@ or its complement with <PRE> see -thresh </PRE> -<P> -<P> -<P> -<P> +</P> + + + + <HR> <A HREF="partiview-4.html">Next</A> <A HREF="partiview-2.html">Previous</A> diff --git a/doc/partiview-4.html b/doc/partiview-4.html index b1e142523e3323c6faa052b04120a3a35c5a3e93..5a1f0a9827c3151178dd1fce3768a39c0f1cc045 100644 --- a/doc/partiview-4.html +++ b/doc/partiview-4.html @@ -1,7 +1,7 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> <HTML> <HEAD> - <META NAME="GENERATOR" CONTENT="SGML-Tools 1.0.9"> + <META NAME="GENERATOR" CONTENT="LinuxDoc-Tools 0.9.20"> <TITLE> Partiview (PC-VirDir): Commands</TITLE> <LINK HREF="partiview-5.html" REL=next> <LINK HREF="partiview-3.html" REL=previous> @@ -12,7 +12,7 @@ <A HREF="partiview-3.html">Previous</A> <A HREF="partiview.html#toc4">Contents</A> <HR> -<H2><A NAME="s4">4. Commands</A></H2> +<H2><A NAME="s4">4.</A> <A HREF="partiview.html#toc4">Commands</A></H2> <P>There are two types of commands in <CODE>partiview</CODE>: Control Commands and Data Commands. @@ -25,46 +25,46 @@ using the <CODE>add</CODE> command prefix. Likewise, a Control Command may be given where data is expected, using the <CODE>eval</CODE> prefix, e.g. in a data (or .cf) file. The <CODE>real</CODE> (Control) Command expects data commands, but if Control Commands are needed, they need to be preceded -with the <CODE>eval</CODE> command. See also the previous <B>starlab</B> example. -<P> -<P> -<P> -<P> -<P> -<P> -<P> -<P> -<H2><A NAME="ss4.1">4.1 Control Commands</A> +with the <CODE>eval</CODE> command. See also the previous <B>starlab</B> example.</P> + + + + + + + + +<H2><A NAME="ss4.1">4.1</A> <A HREF="partiview.html#toc4.1">Control Commands</A> </H2> -<P> -<P>(see partibrains.c::specks_parse_args) + +<P>(see partibrains.c::specks_parse_args)</P> <P>Control Commands are accepted in the Command window, and in some other contexts. Generally, <CODE>partiview</CODE> gives a response to every Control Command, -reporting the (possibly changed) status. -<P>Typically, if parameters are omitted, the current state is reported. +reporting the (possibly changed) status.</P> +<P>Typically, if parameters are omitted, the current state is reported.</P> <P>Some commands apply to particles in the current group (see Object group commands); -others affect global things, such as time or display settings. -<P>Data Commands can also be given, if prefixed with <CODE>add</CODE>. -<P> -<P> -<H2><A NAME="ss4.2">4.2 I/O Control Commands</A> +others affect global things, such as time or display settings.</P> +<P>Data Commands can also be given, if prefixed with <CODE>add</CODE>.</P> + + +<H2><A NAME="ss4.2">4.2</A> <A HREF="partiview.html#toc4.2">I/O Control Commands</A> </H2> -<P> + <P> <DL> -<DT><B>read <I>specks-file</I></B><DD><P>Read a file containing Data Commands (typical suffix <CODE>.cf</CODE> or <CODE>.speck</CODE>). -<P> -<P> +<DT><B>read <I>specks-file</I></B><DD><P>Read a file containing Data Commands (typical suffix <CODE>.cf</CODE> or <CODE>.speck</CODE>).</P> + + <DT><B>async <I>unix-command</I></B><DD><P>Run an arbitrary unix command (invoked via /bin/sh) as a subprocess of <CODE>partiview</CODE>. Its standard output is interpreted as a stream of control commands. Thus <CODE>partiview</CODE> can be driven externally, e.g. to record an animation (using the <CODE>snapshot</CODE> command), or to provide additional GUI controls. Several <CODE>async</CODE> commands can run concurrently. Examples are given later. Warning: you cannot interrupt a started command, -short of hitting ESC to exit partiview. -<P> +short of hitting ESC to exit partiview.</P> + <DT><B>add <I>data-command</I></B><DD><P>Enter a Data Command where a Control Command is expected, e.g. in the text input box. For example, <PRE> @@ -76,22 +76,23 @@ adds a new label "blah" at 10 15 -1, or add kira myrun.out </PRE> -loads a kira (starlab) output file. -<P> +loads a kira (starlab) output file.</P> + <DT><B>eval <I>control-command</I></B><DD><P>Processes that control command just as if the <CODE>eval</CODE> prefix weren't there. Provided for symmetry: wherever either a control command or a data command is expected, entering <CODE>eval</CODE> <I>control-command</I> ensures that it's -taken as a control command. -<P> -<P> +taken as a control command.</P> + + <DT><B>add filepath (data-command)</B><DD><P>Determines the list of directories where all data files, color maps, etc. are sought. See the <CODE>filepath</CODE> entry under - Data Commands. -<P> -<P> + Data Commands.</P> + + </DL> -<P> -<H2><A NAME="ss4.3">4.3 Object Group Control Commands</A> +</P> + +<H2><A NAME="ss4.3">4.3</A> <A HREF="partiview.html#toc4.3">Object Group Control Commands</A> </H2> <P><CODE>Partiview</CODE> can load multiple groups of particles, @@ -99,24 +100,24 @@ each with independent display settings, colormaps, etc. When more than one group is loaded, the Group Row appears on the GUI, with one toggle-button for each group. Toggling the button turns display of that group on or off. Right-clicking turns the group unconditionally on, -and selects that group as the current one for other GUI controls. -<P>Many Control Commands apply to the <I>currently selected</I> group. +and selects that group as the current one for other GUI controls.</P> +<P>Many Control Commands apply to the <I>currently selected</I> group.</P> <P>Groups always have names of the form g<I>N</I> for some small positive <I>N</I>; -each group may also have an alias. +each group may also have an alias.</P> <P> <DL> -<DT><B>g<I>N</I> </B><DD><P>Select group g<I>N</I>. Create a new group if it doesn't already exist. -<P> +<DT><B>g<I>N</I> </B><DD><P>Select group g<I>N</I>. Create a new group if it doesn't already exist.</P> + <DT><B>g<I>N</I>=<I>alias</I> </B><DD><P>Assign name <I>alias</I> to group g<I>N</I>. -Note there must be no blanks around the <CODE>=</CODE> sign. -<P> +Note there must be no blanks around the <CODE>=</CODE> sign.</P> + <DT><B>object <I>objectname</I></B><DD><P>Likewise, select object <I>objectname</I>, which may be either an alias name -or g<I>N</I>. -<P> -<DT><B>g<I>N</I> <I>control-command</I></B><DD><P> +or g<I>N</I>. </P> + +<DT><B>g<I>N</I> <I>control-command</I></B><DD> <DT><B>object <I>objectname</I> <I>control-command</I></B><DD><P>Either form may be used as a <I>prefix</I> to any control command -to act on the specified group, e.g. <CODE>object fred poly on</CODE> -<P> +to act on the specified group, e.g. <CODE>object fred poly on</CODE></P> + <DT><B>gall <I>control-command</I></B><DD><P>Invoke the given <I>control-command</I> in all groups. For example, to turn display of group 3 on and all others off, use: <BLOCKQUOTE><CODE> @@ -125,120 +126,122 @@ gall off g3 on </PRE> </CODE></BLOCKQUOTE> -<P> -<DT><B>on</B><DD><P> +</P> + +<DT><B>on</B><DD> <DT><B>enable</B><DD><P>Either one will -enable the display of the currently selected group (as it is by default). -<P> -<DT><B>off</B><DD><P> -<DT><B>disable</B><DD><P>Either one will turn off the display of the current group. -<P> +enable the display of the currently selected group (as it is by default).</P> + +<DT><B>off</B><DD> +<DT><B>disable</B><DD><P>Either one will turn off the display of the current group.</P> + </DL> -<P> -<H2><A NAME="ss4.4">4.4 View Control commands</A> +</P> + +<H2><A NAME="ss4.4">4.4</A> <A HREF="partiview.html#toc4.4">View Control commands</A> </H2> -<P>View commands affect the view; they aren't specific to data groups. +<P>View commands affect the view; they aren't specific to data groups.</P> <P> <DL> -<DT><B>fov <I>float</I></B><DD><P>Angular field of view (in degrees) in Y-direction. -<P> +<DT><B>fov <I>float</I></B><DD><P>Angular field of view (in degrees) in Y-direction.</P> + <DT><B>cen[ter] <I>X Y Z</I> [<I>RADIUS</I>]</B><DD><P>Set point of interest. This is the center of rotation in <CODE>[o]rbit</CODE> and <CODE>[r]otate</CODE> modes. Also, in <CODE>[o]rbit</CODE> mode, translation speed is proportional to the viewer's distance from this point. The optional <I>RADIUS</I> (also set by <CODE>censize</CODE>) determines the size -of the marker crosshair, initially 1 unit. -<P> +of the marker crosshair, initially 1 unit.</P> + <DT><B>cen[ter] [<I>X Y Z</I> [<I>RADIUS</I>]] int[erest] [<I>X Y Z</I> [<I>RADIUS</I>]]</B><DD><P>Set point of interest. This is the center of rotation in <CODE>[o]rbit</CODE> and <CODE>[r]otate</CODE> modes. And, in <CODE>[o]rbit</CODE> mode, translation speed is proportional to the viewer's distance from this point. The optional <I>RADIUS</I> (also set by <CODE>censize</CODE>) determines the size -of the marker crosshair, initially 1 unit. +of the marker crosshair, initially 1 unit.</P> <P>**** why is center/interest commented out in the first example. Originally -this command was documented twice, the first one has /interest commented out. -<P> -<DT><B>censize [<I>RADIUS</I>]</B><DD><P>Set size of point-of-interest marker. -<P> -<DT><B>where <I>(also)</I> w</B><DD><P>Report the 3-D camera position and forward direction vector. -<P> +this command was documented twice, the first one has /interest commented out.</P> + +<DT><B>censize [<I>RADIUS</I>]</B><DD><P>Set size of point-of-interest marker.</P> + +<DT><B>where <I>(also)</I> w</B><DD><P>Report the 3-D camera position and forward direction vector.</P> + <DT><B>clip <I>NEAR</I> <I>FAR</I></B><DD><P>Clipping distances. The computer graphics setup always requires drawing only objects in some finite range of distances in front of the viewpoint. Both values must be strictly positive, and their ratio is limited; depending on the graphics system in use, distant objects -may appear to blink if the <I>FAR</I>/<I>NEAR</I> ratio exceeds 10000 or so. +may appear to blink if the <I>FAR</I>/<I>NEAR</I> ratio exceeds 10000 or so.</P> <P>To set the far clip range without changing the near, use a non-numeric -near clip value, e.g. <CODE>clip - 1000</CODE>. -<P> -<P> -<DT><B>jump [<I>X Y Z</I>] [<I>Rx Ry Rz</I>]</B><DD><P>Get or set the current position (XYZ) and/or viewing (RxRyRz) angle. -<P> -<DT><B>readpath</B><DD><P>Read a Wavefront (<CODE>.wf</CODE>) file describing a path through space. -<P> -<DT><B>rdata</B><DD><P>Synonym for readpath. -<P> +near clip value, e.g. <CODE>clip - 1000</CODE>.</P> + + +<DT><B>jump [<I>X Y Z</I>] [<I>Rx Ry Rz</I>]</B><DD><P>Get or set the current position (XYZ) and/or viewing (RxRyRz) angle.</P> + +<DT><B>readpath</B><DD><P>Read a Wavefront (<CODE>.wf</CODE>) file describing a path through space.</P> + +<DT><B>rdata</B><DD><P>Synonym for readpath.</P> + <DT><B>play <I>speed</I>[f]</B><DD><P>Play the currently loaded (from <CODE>readpath</CODE>/<CODE>rdata</CODE>) camera animation path, at <I>speed</I> 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 <I>speed</I>-th frame, without regard to real -time. -<P> -<DT><B>frame [<I>frameno</I>]</B><DD><P>Get or set the current frame the <I>frameno</I>-th. -<P> +time.</P> + +<DT><B>frame [<I>frameno</I>]</B><DD><P>Get or set the current frame the <I>frameno</I>-th.</P> + <DT><B>update </B><DD><P>Ensures the display is updated, as before taking a snapshot. Probably only useful in a stream of control commands from an <CODE>async</CODE> -subprocess. -<P> -<DT><B>winsize [<I>XSIZE</I> [<I>YSIZE</I>]]</B><DD><P> +subprocess.</P> + +<DT><B>winsize [<I>XSIZE</I> [<I>YSIZE</I>]]</B><DD> <DT><B>winsize <I>XSIZE</I>x<I>YSIZE</I>+<I>XPOS</I>+<I>YPOS</I></B><DD><P>Resize graphics window. With no arguments, reports current size. With one argument, resizes to given width, preserving aspect ratio. With two arguments, reshapes window to that height and width. With complete X geometry specification (no embedded spaces), e.g. <CODE>winsize 400x350+20-10</CODE>, also sets position of graphics window, with +X and +Y measured from -left/top, -X and -Y measured from right/bottom of screen. -<P> +left/top, -X and -Y measured from right/bottom of screen.</P> + <DT><B>detach [full|hide] [<I>+XPOS+YPOS</I>]</B><DD><P>Detach graphics window from GUI control strip and optionally specify position of control strip. With <CODE>full</CODE> or <CODE>hide</CODE>, makes graphics window full-screen with GUI visible or hidden, respectively. With neither <CODE>full</CODE> nor <CODE>hide</CODE>, the graphics window -is detached but left at its current size. +is detached but left at its current size.</P> <P>The <I>+XPOS+YPOS</I> is a window position in X window geometry style, so e.g. <CODE>detach full -10+5</CODE> places the GUI near the upper right corner of the screen, 10 pixels in from the right -and 5 pixels down from the top edge. +and 5 pixels down from the top edge.</P> <P>If you don't mind typing blindly, it's still possible to enter text-box commands even with the controls hidden; press the <I>Tab</I> key before each command to ensure that input focus is in the text box. Use <I>Tab</I><CODE>detach full</CODE><I>Enter</I> -to un-hide a hidden control strip. -<P> -<DT><B>bgcolor <I>R G B</I></B><DD><P>Set window background color (three R G B numbers or one grayscale value). -<P> -<P> +to un-hide a hidden control strip.</P> + +<DT><B>bgcolor <I>R G B</I></B><DD><P>Set window background color (three R G B numbers or one grayscale value).</P> + + <DT><B>focallen <I>distance</I></B><DD><P>Focal length: distance from viewer to a typical object of interest. This affects stereo display (see below) and navigation: the speed of motion in <CODE>[t]ranslate</CODE> and <CODE>[f]ly</CODE> modes is proportional to this -distance. -<P> +distance.</P> + <DT><B>stereo [on|off|redcyan|glasses|cross|left|right] [<I>separation</I>]</B><DD><P>Stereo display. Also toggled on/off by typing <CODE>'s'</CODE> key in graphics window. Where hardware allows it, <CODE>stereo glasses</CODE> selects CrystalEyes-style quad-buffered stereo. All systems should be capable of <CODE>stereo redcyan</CODE>, which requires wearing red/green or red/blue glasses, and of <CODE>cross</CODE> (crosseyed), which splits the window horizontally. <CODE>left</CODE> and <CODE>right</CODE> show just that eye's view, -and may be handy for taking stereo snapshots. +and may be handy for taking stereo snapshots.</P> <P>Useful <I>separation</I> values might be 0.02 to 0.1, or -0.02 to -0.1 to swap eyes. See also <CODE>focallen</CODE> 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. +at that distance will coincide on the screen.</P> <P>Virtual-world eyes will be separated by distance 2 * <I>focallen * separation</I>, with convergence angle -2 * <CODE>arctan(</CODE><I>separation</I><CODE>)</CODE>. +2 * <CODE>arctan(</CODE><I>separation</I><CODE>)</CODE>.</P> <P>See also the <CODE>winsize</CODE> and <CODE>detach</CODE> commands -for control over graphics window size and placement. +for control over graphics window size and placement.</P> <P>Beware: some systems which support hardware ("glasses") stereo also require that the display be set to a stereo-capable video mode. Partiview does not do this @@ -248,36 +251,37 @@ you may need to type (to a unix shell) stereo viewing and something like <CODE>/usr/gfx/setmon -n 72</CODE> to revert. Otherwise, turning partiview's stereo on will just show the left eye's view -- displacing the viewpoint -but nothing else. -<P> +but nothing else.</P> + <DT><B>snapset [<CODE>-n</CODE> <I>FRAMENO</I>] <I>FILESTEM</I> [<I>FRAMENO</I>]</B><DD><P>Set parameters for future <CODE>snapshot</CODE> commands. <I>FILESTEM</I> may be a printf format string with frame number as argument, e.g. <CODE>snapset pix/%04d.ppm</CODE>, generating image names of <CODE>pix/0000.ppm</CODE>, <CODE>pix/0001.ppm</CODE>, etc. If <I>FILESTEM</I> contains no % sign, then <CODE>.%03d.ppm.gz</CODE> is appended to it, so <CODE>snapset ./pix/fred</CODE> -yields snapshot images named <CODE>./pix/fred.000.ppm.gz</CODE> etc. -<P>Frame number <I>FRAMENO</I> (default 0) increments with each snapshot taken. -<P> -<P> +yields snapshot images named <CODE>./pix/fred.000.ppm.gz</CODE> etc.</P> +<P>Frame number <I>FRAMENO</I> (default 0) increments with each snapshot taken.</P> + + <DT><B>snapshot [<I>FRAMENO</I>]</B><DD><P>Capture a snapshot image of the current view. Use <CODE>snapset</CODE> to specify the output image name. -Default format is <CODE>snap.%03d.tif</CODE>. +Default format is <CODE>snap.%03d.tif</CODE>.</P> <P><CODE>Partiview</CODE> generally invokes the ImageMagick program <CODE>convert(1)</CODE>, which must be installed and be on the user's $PATH. <CODE>Convert</CODE> determines -the type of image (jpeg, sgi, bmp, etc.) based on the file suffix. +the type of image (jpeg, sgi, bmp, etc.) based on the file suffix.</P> <P><CODE>Convert</CODE> is not needed if the <CODE>snapset</CODE> <I>FILESTEM</I> ends in <CODE>.ppm.gz</CODE> (invokes gzip rather than convert) or <CODE>.ppm</CODE> -(no external program required). -<P> +(no external program required).</P> + </DL> -<P> -<P> -<H2><A NAME="ss4.5">4.5 Particle Display Control Commands</A> +</P> + + +<H2><A NAME="ss4.5">4.5</A> <A HREF="partiview.html#toc4.5">Particle Display Control Commands</A> </H2> <P>These commands affect how particles (in the current group) are -displayed. +displayed.</P> <P> <DL> <DT><B>psize <I>scalefactor</I></B><DD><P>All particle luminosities (as specified by <CODE>lum</CODE> command) @@ -287,8 +291,8 @@ and a global factor given by <CODE>psize</CODE>. So the intrinsic brightness of a particle is <I>value-specified-by-</I><CODE>lum</CODE> * <I>slum-for-current-lumvar</I> -* <I>psize-scalefactor</I>. -<P> +* <I>psize-scalefactor</I>.</P> + <DT><B>slum <I>slumfactor</I></B><DD><P>Data-field specific luminosity scale factor, for current choice of <I>lumvar</I> as given by the <CODE>lum</CODE> command. A <I>slumfactor</I> is recorded independently for each data field, so @@ -304,19 +308,19 @@ slum 0.25 having chosen each variable's <I>slumfactor</I> for useful display, and then freely switch between <CODE>lum mass</CODE> and <CODE>lum energy</CODE> -without having to readjust particle brightness each time. -<P> -<P> +without having to readjust particle brightness each time.</P> + + <DT><B>ptsize <I>minpixels</I> <I>maxpixels</I></B><DD><P>Specifies the range of <I>apparent</I> sizes of points, in pixels. Typical values might be <CODE>ptsize 0.1 5</CODE>. The graphics system may silently impose an upper limit -of about 10 pixels. -<P> -<P> -<DT><B>polysize [on|off] [a|s|r]</B><DD><P> -<DT><B>polylum</B><DD><P> -<DT><B>polyminpixels</B><DD><P> -<DT><B>polymin <I>minradius</I> [<I>maxradius</I>]</B><DD><P> +of about 10 pixels.</P> + + +<DT><B>polysize [on|off] [a|s|r]</B><DD> +<DT><B>polylum</B><DD> +<DT><B>polyminpixels</B><DD> +<DT><B>polymin <I>minradius</I> [<I>maxradius</I>]</B><DD> <DT><B>color</B><DD><P>Specify how particles are colored. Generally, a linear function of some data field of each particle becomes an index into a colormap (see <CODE>cmap</CODE>, <CODE>cment</CODE>). @@ -326,42 +330,44 @@ or a 0-based integer column number) to determine color. Map <I>minval</I> to color index 1, and <I>maxval</I> to the next-to-last entry in the colormap (<I>Ncmap-2</I>). The 0th and last (<I>Ncmap-1</I>) colormap entry are used for -out-of-range data values. +out-of-range data values.</P> <P>If <I>minval</I> and <I>maxval</I> are omitted, the actual range of -values is used. -<P> +values is used.</P> + <DT><B> color <I>colorvar</I> exact [<I>baseval</I>] </B><DD><P>Don't consider field <I>colorvar</I> as a continuous variable; instead, it's integer-valued, and mapped one-to-one with color table slots. Data value <I>N</I> is mapped to -color index <I>N+baseval</I>. -<P> +color index <I>N+baseval</I>.</P> + <DT><B> color <I>colorvar</I> -exact </B><DD><P>Once the <CODE>exact</CODE> tag is set (for a particular data-field), it's sticky. To interpret that data field as a continuous, scalable -variable again, use <CODE>-exact</CODE>. -<P> +variable again, use <CODE>-exact</CODE>.</P> + <DT><B> color const <I>R G B</I> </B><DD><P>Show all particles as color <I>R G B</I>, each value in range 0 to 1, -independent of any data fields. +independent of any data fields.</P> </DL> -<P> +</P> + <DT><B>lum</B><DD><P>Specify how particles' intrinsic luminosity is computed: a linear function of some data field of each particle. <DL> <DT><B> lum <I>lumvar</I> [<I>minval maxval</I>] </B><DD><P>Map values of data field <I>lumvar</I> (<CODE>datavar</CODE> name or field number) to luminosity. The (linear) mapping takes field value <I>minval</I> to -luminosity 0 and <I>maxval</I> to luminosity 1.0. +luminosity 0 and <I>maxval</I> to luminosity 1.0.</P> <P>If <I>minval</I> and <I>maxval</I> are omitted, the actual range of values is mapped to the luminosity range -0 to 1. +0 to 1.</P> <P>Note that the resulting luminosities are then scaled by the <CODE>psize</CODE> and <CODE>slum</CODE> scale factors, and further scaled according to distance as specified by <CODE>fade</CODE>, to compute -apparent brightness of points. -<P> +apparent brightness of points.</P> + <DT><B> lum const <I>L</I> </B><DD><P>Specify constant particle luminosity <I>L</I> independent of -any data field values. +any data field values.</P> </DL> -<P> +</P> + <DT><B>fade [planar|spherical|linear <I>refdist</I>|const <I>refdist</I>]</B><DD><P>Determines how distance affects particles' apparent brightness (or "size"). The default <CODE>fade planar</CODE> gives 1/r^2 light falloff, with r measured as distance from the view plane. <CODE>fade spherical</CODE> is also 1/r^2, @@ -369,149 +375,150 @@ but with r measured as true distance from the viewpoint. <CODE>fade linear</CODE> <I>refdist</I> gives 1/r light falloff -- not physically accurate, but useful to get a limited sense of depth. <CODE>fade const</CODE> <I>refdist</I> gives constant apparent brightness -independent of distance, and may be appropriate for orthographic views. +independent of distance, and may be appropriate for orthographic views.</P> <P>The <I>refdist</I> for linear and const modes is that distance <I>r</I> at which apparent brightness should match that in the 1/r^2 modes -- -a distance to a "typical" particle. -<P> -<DT><B>labelminpixels</B><DD><P> -<DT><B>labelsize</B><DD><P> -<DT><B>lsize</B><DD><P> -<DT><B>point[s] [on|off]</B><DD><P>Turn display of points on or off. With no argument, toggles display. -<P> -<DT><B>poly[gons] [on|off]</B><DD><P>Turn display of points on or off. With no argument, toggles display. -<P> -<DT><B>texture [on|off]</B><DD><P>Turn display of textures on or off. With no argument, toggles. -<P> -<DT><B>label[s] [on|off]</B><DD><P>Turn display of label text on or off. With no argument, toggles. -<P> -<P> +a distance to a "typical" particle.</P> + +<DT><B>labelminpixels</B><DD> +<DT><B>labelsize</B><DD> +<DT><B>lsize</B><DD> +<DT><B>point[s] [on|off]</B><DD><P>Turn display of points on or off. With no argument, toggles display.</P> + +<DT><B>poly[gons] [on|off]</B><DD><P>Turn display of points on or off. With no argument, toggles display.</P> + +<DT><B>texture [on|off]</B><DD><P>Turn display of textures on or off. With no argument, toggles.</P> + +<DT><B>label[s] [on|off]</B><DD><P>Turn display of label text on or off. With no argument, toggles.</P> + + <DT><B>txscale <I>scalefactor</I></B><DD><P>Scale size of all textures relative to their polygons. A scale factor of 0.5 (default) make the texture square -just fill its polygon, if <CODE>polysides</CODE> is 4. -<P> -<DT><B>polyorivar</B><DD><P>Report setting of <CODE>polyorivar</CODE> data-command, which see. -<P> -<DT><B>texturevar</B><DD><P>Report setting of <CODE>texturevar</CODE> data-command, which see. -<P> +just fill its polygon, if <CODE>polysides</CODE> is 4.</P> + +<DT><B>polyorivar</B><DD><P>Report setting of <CODE>polyorivar</CODE> data-command, which see.</P> + +<DT><B>texturevar</B><DD><P>Report setting of <CODE>texturevar</CODE> data-command, which see.</P> + <DT><B>laxes [on|off]</B><DD><P>Toggle label axes. When on, and when labels are displayed, -shows a -<P> +shows a </P> + <DT><B>polyside(s)</B><DD><P>Number of sides a polygon should have. Default 11, for fairly round polygons. For textured polygons, <CODE>polysides 4</CODE> might do as well, -and be slightly speedier. -<P> -<DT><B>fast</B><DD><P>see also <CODE>ptsize</CODE> -<P> +and be slightly speedier.</P> + +<DT><B>fast</B><DD><P>see also <CODE>ptsize</CODE></P> + <DT><B>ptsize <I>minpixels</I> [<I>maxpixels</I>]</B><DD><P>Specifies range of apparent (pixel) size of points. Those with computed sizes (based on luminosity and distance) smaller than <I>minpixels</I> are randomly (but repeatably) subsampled -- i.e. some fraction of them are not drawn. Those computed to be larger than <I>maxpixels</I> are drawn at size -<I>maxpixels</I>. -<P> +<I>maxpixels</I>.</P> + <DT><B>gamma <I>displaygamma</I></B><DD><P>Tells the particle renderer how the display + OpenGL relates image values to visible lightness. You don't need to change this, but may adjust it to minimize the brightness glitches when particles change size. Typical values are <CODE>gamma 1</CODE> through <CODE>gamma 2.5</CODE> or so. -Larger values raise the apparent brightness of dim things. -<P> +Larger values raise the apparent brightness of dim things.</P> + <DT><B>alpha <I>alpha</I></B><DD><P>Get or set the alpha value, in the range 0 to 1; it determines -the opacity of polygons. -<P> +the opacity of polygons.</P> + <DT><B>speed</B><DD><P>For time-dependent data, advance datatime by this many time units -per wall-clock second. -<P> +per wall-clock second.</P> + <DT><B>step [<I>timestep</I>]</B><DD><P>For time-varying data, sets current timestep number. Real-valued times are meaningful for some kinds of data including those from Starlab/kira; for others, times are rounded to nearest integer. -If running, <CODE>step</CODE> also stops datatime animation. (See <CODE>run</CODE>.) -<P> -<DT><B>step [+|-]<I>deltatimestep</I></B><DD><P>If preceded with a plus or minus sign, adds that amount to current time. -<P> -<P>(note that <CODE>fspeed</CODE> has been deprecated) -<P> -<DT><B>run</B><DD><P>Continue a stopped animation (see also <CODE>step</CODE>). -<P> +If running, <CODE>step</CODE> also stops datatime animation. (See <CODE>run</CODE>.)</P> + +<DT><B>step [+|-]<I>deltatimestep</I></B><DD><P>If preceded with a plus or minus sign, adds that amount to current time.</P> + +<P>(note that <CODE>fspeed</CODE> has been deprecated)</P> + +<DT><B>run</B><DD><P>Continue a stopped animation (see also <CODE>step</CODE>).</P> + <DT><B>tfm [-v] [<I>numbers...</I>]</B><DD><P>Object-to-world transformation. May take 1, 6, 7, 9 or 16 parameters: either <I>scalefactor</I>, or <I>tx ty tz rx ry rz </I><I>scalefactor</I>>], or 16 numbers for 4x4 matrix, or 9 numbers for 3x3 matrix. -See <I>Coordinates and Coordinate Transformations</I>. +See <I>Coordinates and Coordinate Transformations</I>.</P> <P>With no numeric parameters, reports the current object-to-world transform. -Use <CODE>tfm -v</CODE> to see the transform and its inverse in several forms. -<P> +Use <CODE>tfm -v</CODE> to see the transform and its inverse in several forms.</P> + <DT><B>move [g<I>N</I>] {on|off}</B><DD><P>Normally, navigation modes <CODE>[r]otate</CODE> and <CODE>[t]ranslate</CODE> just adjust the viewpoint (camera). However, if you turn <CODE>move on</CODE>, then <CODE>[r]otate</CODE> and <CODE>[t]ranslate</CODE> move the currently-selected object group instead, e.g. to adjust its alignment relative to other groups. -(<CODE>[o]rbit</CODE> and <CODE>[f]ly</CODE> modes always move the camera.) +(<CODE>[o]rbit</CODE> and <CODE>[f]ly</CODE> modes always move the camera.)</P> <P>To indicate that <CODE>move</CODE> mode is enabled, the control strip shows the selected group's name in bold italics, as <B><I>[g3]</I></B>. Use <CODE>move off</CODE> to revert to normal. The <CODE>tfm</CODE> command reports the current object-group-to-global-world -transformation. -<P> -<DT><B>fwd</B><DD><P> +transformation.</P> + +<DT><B>fwd</B><DD> <DT><B>datawait on|off</B><DD><P>For asynchronously-loaded data (currently only <CODE>ieee</CODE> data command), say whether wait for current data step to be loaded. -(If not, then keep displaying previous data while loading new.) -<P> +(If not, then keep displaying previous data while loading new.)</P> + <DT><B>cmap <I>filename</I></B><DD><P>Load (ascii) filename with RGB values, for coloring particles. The <CODE>color</CODE> command selects which data field is mapped to color index -and how. +and how.</P> <P>Colormaps are text files, beginning with a number-of-entries line and followed by R G B or R G B A entries one per line; -see the <I>Colormaps</I> section. -<P> +see the <I>Colormaps</I> section.</P> + <DT><B>vcmap -v <I>fieldname</I> <I>filename</I></B><DD><P>Load colormap as with <CODE>cmap</CODE> command. But use this colormap only when the given data field is selected for coloring. Thus the <CODE>cmap</CODE> color map applies to all data fields for which -no <CODE>vcmap</CODE> has ever been specified. -<P> -<DT><B>cment <I>colorindex</I> [<I>R G B</I>]</B><DD><P>Report or set that colormap entry. -<P> +no <CODE>vcmap</CODE> has ever been specified.</P> + +<DT><B>cment <I>colorindex</I> [<I>R G B</I>]</B><DD><P>Report or set that colormap entry.</P> + <DT><B>rawdump <I>dump-filename</I></B><DD><P>All particle attributes (not positions though) are written to a <I>dump-filename</I>. Useful for debugging. -Warning: it will happily overwrite an existing file with that name. -<P> -<P> +Warning: it will happily overwrite an existing file with that name.</P> + + </DL> -<P> -<H2><A NAME="ss4.6">4.6 Particle subsetting & statistics</A> +</P> + +<H2><A NAME="ss4.6">4.6</A> <A HREF="partiview.html#toc4.6">Particle subsetting & statistics</A> </H2> -<P> + <P> <DL> -<P> -<DT><B>clipbox ...</B><DD><P>see <CODE>cb</CODE> below. -<P> + +<DT><B>clipbox ...</B><DD><P>see <CODE>cb</CODE> below.</P> + <DT><B>cb ....</B><DD><P>Display only a 3D subregion of the data -- the part lying within the clipbox. <DL> <DT><B>cb <I>xmin ymin zmin xmax ymax zmax</I> </B><DD><P>Specified by coordinate ranges. -Note only spaces are used to separate the 6 numbers. +Note only spaces are used to separate the 6 numbers.</P> <DT><B>cb <I>xcen,ycen,zcen xrad,yrad,zrad</I> </B><DD><P>Specified by center and "radius" of the box. -Note no spaces after the commas! -<DT><B>cb <I>xmin,xmax ymin,ymax zmin,zmax</I> </B><DD><P>Specified by coordinate ranges. -<DT><B>cb <CODE>off</CODE> </B><DD><P>Disable clipping. The entire dataset is again visible. +Note no spaces after the commas!</P> +<DT><B>cb <I>xmin,xmax ymin,ymax zmin,zmax</I> </B><DD><P>Specified by coordinate ranges.</P> +<DT><B>cb <CODE>off</CODE> </B><DD><P>Disable clipping. The entire dataset is again visible.</P> <DT><B>cb <CODE>on</CODE> </B><DD><P>Re-enable a previously defined clipbox setting. It will also -display the clipbox again +display the clipbox again</P> <DT><B>cb <CODE>hide</CODE> </B><DD><P>Hide the clipbox, but still discard objects whose centers -lie outside it. +lie outside it.</P> </DL> Note this command does not toggle clipping if no arguments given (that would be handy and more in line with similar commands). -If no arguments given, it reports the current clipbox. -<P> +If no arguments given, it reports the current clipbox.</P> + <DT><B>thresh</B><DD><P>Display a subset of particles, chosen by the value of some data field. Each <CODE>thresh</CODE> command overrides settings from previous commands, so it cannot be used to @@ -522,15 +529,16 @@ the <CODE>thresh</CODE> criterion applies to time-varying data. <DT><B>thresh <I>field</I> <I>minval</I> <I>maxval</I> </B><DD><P>Display only those particles where <I>minval</I> <= field <I>field</I> <= <I>maxval</I>. The <I>field</I> may be given by name (as from <CODE>datavar</CODE>) -or by field number. -<DT><B>thresh <I>field</I> <CODE><</CODE><I>maxval</I> </B><DD><P> +or by field number.</P> +<DT><B>thresh <I>field</I> <CODE><</CODE><I>maxval</I> </B><DD> <DT><B>thresh <I>field</I> <CODE>></CODE><I>minval</I> </B><DD><P>Show only particles where <I>field</I> is <= -or >= the given threshold. -<DT><B>thresh [off|on]</B><DD><P>Disable or re-enable a previously specified threshold. +or >= the given threshold.</P> +<DT><B>thresh [off|on]</B><DD><P>Disable or re-enable a previously specified threshold.</P> </DL> -<P> -<DT><B>only= <I>datafield</I> <I>value</I> <I>minvalue-maxvalue</I> <<I>value</I> ><I>value</I> ...</B><DD><P> -<DT><B>only+ <I>datafield</I> <I>value</I> <I>minvalue-maxvalue</I> <<I>value</I> ><I>value</I> ...</B><DD><P> +</P> + +<DT><B>only= <I>datafield</I> <I>value</I> <I>minvalue-maxvalue</I> <<I>value</I> ><I>value</I> ...</B><DD> +<DT><B>only+ <I>datafield</I> <I>value</I> <I>minvalue-maxvalue</I> <<I>value</I> ><I>value</I> ...</B><DD> <DT><B>only- <I>datafield</I> <I>value</I> <I>minvalue-maxvalue</I> <<I>value</I> ><I>value</I> ...</B><DD><P>Scans particles (in the current timestep only!), finding those where <I>datafield</I> has value <I>value</I>, or has a value in range <I>minvalue</I> <= value <= <I>maxvalue</I>, or whatever. @@ -538,39 +546,40 @@ Multiple value-ranges may be specified to select the union of several sets. The resulting set of particles is assigned to (<CODE>only=</CODE>), added to (<CODE>only+</CODE>) or subtracted from (<CODE>only-</CODE>) the <CODE>thresh</CODE> selection-set. Also display just particles in that selection-set, as if <CODE>see thresh</CODE> -had been typed. +had been typed.</P> <P>The net effect is illustrated by these examples: <DL> -<DT><B>only= type 1-3 5</B><DD><P>Show only particles of type 1, 2, 3 or 5. +<DT><B>only= type 1-3 5</B><DD><P>Show only particles of type 1, 2, 3 or 5.</P> <DT><B>only- mass <2.3 >3.5</B><DD><P>After the above command, shows only the subset of type 1/2/3/5 particles AND have mass between 2.3 and 3.5. (Note that to take the intersection of two conditions, you must subtract the complement of the latter one. -Maybe some day there'll be an <CODE>only&</CODE>. +Maybe some day there'll be an <CODE>only&</CODE>.</P> </DL> -<P> +</P> + <DT><B>see <CODE>selexpr</CODE></B><DD><P>Show just those particles in the selection-set <CODE>selexpr</CODE>. Predefined set names are <CODE>all</CODE>, <CODE>none</CODE>, <CODE>thresh</CODE> and <CODE>pick</CODE>, and other names may be defined by the <CODE>sel</CODE> command. The default is <CODE>see all</CODE>. Using the <CODE>thresh</CODE> or <CODE>only</CODE> -commands automatically switch to displaying <CODE>see thresh</CODE>. +commands automatically switch to displaying <CODE>see thresh</CODE>.</P> <P>Note that you can see the complement of a named set, e.g. all except the <CODE>thresh</CODE>-selected objects, with -<CODE>see -thresh</CODE>. -<P> +<CODE>see -thresh</CODE>.</P> + <DT><B>sel <CODE>selname = selexpr</CODE></B><DD><P>Compute a logical combination of selection-sets and assign them to another such set. The set membership is originally assigned by <CODE>thresh</CODE> or <CODE>only</CODE> commands. Yeah, I know this doesn't make sense. -Need a separate section to document selection-sets. -<P> -<DT><B>sel <CODE>selexpr</CODE></B><DD><P>Count the number of particles in the selection-set <CODE>selexpr</CODE>. -<P> -<DT><B>clearobj</B><DD><P>Erase all particles in this group. Useful for reloading on the fly. -<P> +Need a separate section to document selection-sets.</P> + +<DT><B>sel <CODE>selexpr</CODE></B><DD><P>Count the number of particles in the selection-set <CODE>selexpr</CODE>.</P> + +<DT><B>clearobj</B><DD><P>Erase all particles in this group. Useful for reloading on the fly.</P> + <DT><B>every <I>N</I></B><DD><P>Display a random subset (every <I>N</I>-th) of all particles. E.g. <CODE>every 1</CODE> shows all particles, <CODE>every 2</CODE> shows about half of them. -Reports current subsampling factor, and the current total number of particles. -<P> +Reports current subsampling factor, and the current total number of particles.</P> + <DT><B>hist <I>datafield</I> [-n <I>nbuckets</I>] [-l] [-c] [-t] [<I>minval</I>] [<I>maxval</I>]</B><DD><P>Generates a (numerical) histogram of values of <I>datafield</I>, which may be a named field (as from <CODE>datavar</CODE>) or a field index. Divides the value range (either <I>minval</I>..<I>maxval</I> @@ -579,43 +588,44 @@ equal buckets (11 by default). Uses logarithmically-spaced intervals if <CODE>-l</CODE> (so long as the data range doesn't include zero). If a clipbox is defined, use <CODE>-c</CODE> to count only particles within it. If a <CODE>thresh</CODE> or <CODE>only</CODE> -subset is defined, use <CODE>-t</CODE> to count only the chosen subset. -<P> +subset is defined, use <CODE>-t</CODE> to count only the chosen subset.</P> + <DT><B>bound [w]</B><DD><P>Reports 3D extent of the data. With <CODE>w</CODE>, reports it in -world coordinates, otherwise in object coordinates. -<P> -<DT><B>datavar</B><DD><P> +world coordinates, otherwise in object coordinates.</P> + +<DT><B>datavar</B><DD> <DT><B>dv</B><DD><P>Report names and value ranges (over all particles in current group) -of all named data fields. -<P> -<P> +of all named data fields.</P> + + </DL> -<P> -<H2><A NAME="ss4.7">4.7 Boxes</A> +</P> + +<H2><A NAME="ss4.7">4.7</A> <A HREF="partiview.html#toc4.7">Boxes</A> </H2> <P> <DL> -<DT><B>showbox <I>list of integer box level numbers...</I></B><DD><P> -<DT><B>hidebox <I>list of integer box level numbers...</I></B><DD><P> -<DT><B>box[es] [off|on|only]</B><DD><P>Turn box display off or on; or display boxes but hide all particles. -<P> +<DT><B>showbox <I>list of integer box level numbers...</I></B><DD> +<DT><B>hidebox <I>list of integer box level numbers...</I></B><DD> +<DT><B>box[es] [off|on|only]</B><DD><P>Turn box display off or on; or display boxes but hide all particles.</P> + <DT><B>boxcmap <I>filename</I></B><DD><P>Color boxes using that colormap. Each box's level number (set by <CODE>-l</CODE> option of <CODE>box</CODE> data-command, -default 0) is the color index. -<P> +default 0) is the color index.</P> + <DT><B>boxcment <I>colorindex</I> [<I>R G B</I>]</B><DD><P>Get or set the given box-colormap index. E.g. <CODE>boxcment 0</CODE> -reports the color of boxes created with no <CODE>-l</CODE> specified. -<P> +reports the color of boxes created with no <CODE>-l</CODE> specified.</P> + <DT><B>boxlabel [on|off]</B><DD><P>Label boxes by id number -(set by <CODE>-n</CODE> option of <CODE>box</CODE> data-command). -<P> -<DT><B>boxaxes [on|off]</B><DD><P>Toggle or set box axes display mode. -<P> -<DT><B>boxscale [float] [on|off] </B><DD><P> -<DT><B>gobox <I>boxnumber</I></B><DD><P> -<DT><B>goboxscale</B><DD><P> -<DT><B>menu fmenu</B><DD><P> +(set by <CODE>-n</CODE> option of <CODE>box</CODE> data-command).</P> + +<DT><B>boxaxes [on|off]</B><DD><P>Toggle or set box axes display mode.</P> + +<DT><B>boxscale [float] [on|off] </B><DD> +<DT><B>gobox <I>boxnumber</I></B><DD> +<DT><B>goboxscale</B><DD> +<DT><B>menu fmenu</B><DD> <P> <BLOCKQUOTE><CODE> <PRE> @@ -633,64 +643,92 @@ reports the color of boxes created with no <CODE>-l</CODE> specified. END CAVEMENU </PRE> </CODE></BLOCKQUOTE> -<P> -<P> -<DT><B>datascale</B><DD><P> +</P> + + +<DT><B>datascale</B><DD> </DL> -<P> -<H2><A NAME="ss4.8">4.8 Data commands </A> +</P> + +<H2><A NAME="ss4.8">4.8</A> <A HREF="partiview.html#toc4.8">Data commands </A> </H2> -<P> -<P>(see also partibrains.c::specks_read) + +<P>(see also partibrains.c::specks_read)</P> <P>Data Commands can be placed in a data file. -Lines starting with <CODE>#</CODE> will be skipped. -<P>Control Commands can also be given, if prefixed with the <CODE>eval</CODE> command. +Lines starting with <CODE>#</CODE> will be skipped. </P> +<P>Control Commands can also be given, if prefixed with the <CODE>eval</CODE> command.</P> <P> <DL> -<P> + <DT><B>read <I>file</I> </B><DD><P>read a <CODE>speck</CODE> formatted file. Recursive, commands can nest. (strtok ok??) -Note that <CODE>read</CODE> is also a Control Command, doing exactly the same thing. -<P> -<DT><B>include <I>file</I></B><DD><P>read a <CODE>speck</CODE> formatted file. -<P> +Note that <CODE>read</CODE> is also a Control Command, doing exactly the same thing.</P> + +<DT><B>include <I>file</I></B><DD><P>read a <CODE>speck</CODE> formatted file.</P> + <DT><B>ieee [-t time] <I>file</I></B><DD><P>read a IEEEIO formatted file, with optional timestep number (0 based). -Support for this type of data must be explicitly compiled into the program. -<P> +Support for this type of data must be explicitly compiled into the program.</P> + <DT><B>kira <I>file</I> </B><DD><P>read a <CODE>kira</CODE> formatted file. See the <CODE>kiractl</CODE> Control -Command to modify the looks of the objects. -<P> +Command to modify the looks of the objects.</P> + <DT><B>setenv name value</B><DD><P>Add (or change) a named variable of the environment variables space of partiview. Enviroment variables, like in the normal unix shell, can be referred to by prepending their name with a $. -<I>Note there probably is not an unsetenv command</I>. -<P> +<I>Note there probably is not an unsetenv command</I>.</P> + <DT><B>object <I>gN=ALIAS</I></B><DD><P>Defines/Selects a particular group number (N=1,2,3....) to an ALIAS. In command mode you can use <CODE>gN=ALIAS</CODE>. Any data following this command -will now belong to this group. -<P> -<DT><B>object <I>ObjectName</I></B><DD><P>Select an existing group. Following data will now belong to this group. -<P> +will now belong to this group.</P> + +<DT><B>object <I>ObjectName</I></B><DD><P>Select an existing group. Following data will now belong to this group.</P> + <DT><B>sdbvars <I>var</I></B><DD><P>Choose which data fields to extract from binary sdb files (any of: <CODE>mMcrogtxyzSn</CODE>) for subsequent -<CODE>sbd</CODE> commands. -<P> -<DT><B>sdb [-t time] <I>file</I></B><DD><P>Read an SDB (binary) formatted file, with optional timestep number (0 based). -<P> -<DT><B>box[es] <I>....</I></B><DD><P>Draw a box, using any of the following formats: +<CODE>sdb</CODE> commands.</P> + +<DT><B>sdb [-t time] <I>file</I></B><DD><P>Read an SDB (binary) formatted file, with optional timestep number. +(Default time is latest <CODE>datatime</CODE>, or 0.)</P> + +<DT><B>pb [-t time] <I>file</I></B><DD><P>Read a <CODE>.pb</CODE> (binary) particle file, with optional timestep number. +(Default time is latest <CODE>datatime</CODE>, or 0.) +A <CODE>.pb</CODE> file contains (all values 32-bit integer or 32-bit IEEE float): +<OL> +<LI>magic number, 0xFFFFFF98 (int32)</LI> +<LI>byte offset of first particle (int32)</LI> +<LI>number of attributes (int32)</LI> +<LI>sequence of null-terminated attribute name strings, +attributename0 \0 attributename1 \0 ...</LI> +<LI>possibly some pad bytes, enough to reach the specified +first-particle file offset</LI> +<LI>sequence of particle records, +each (number-of-attributes + 4)*4 bytes long: +<OL> +<LI>particle-id (int32)</LI> +<LI>particle X, Y, Z (3 float32's) </LI> +<LI>particle attributes (number-of-attributes float32's)</LI> +</OL> + +ending at the end of the file (i.e. there's no particle-count field).</LI> +</OL> + +Either big- or little-endian formats are accepted; the value of the +magic number determines endianness of all values in that file.</P> + +<DT><B>box[es] <I>....</I></B><DD><P>Draw a box, using any of the following formats:</P> <P> <DL> -<DT><B> <CODE>xmin ymin zmin xmax ymax zmax</CODE> </B><DD><P> -<DT><B> <CODE>xmin,xmax ymin,ymax zmin,zmax</CODE> </B><DD><P> -<DT><B> <CODE>xcen,ycen,zcen xrad,yrad,zrad</CODE> </B><DD><P> -<DT><B> <CODE>[-t time] [-n boxno] [-l level] xcen,ycen,zcen xrad,yrad,zrad </CODE> </B><DD><P> +<DT><B> <CODE>xmin ymin zmin xmax ymax zmax</CODE> </B><DD> +<DT><B> <CODE>xmin,xmax ymin,ymax zmin,zmax</CODE> </B><DD> +<DT><B> <CODE>xcen,ycen,zcen xrad,yrad,zrad</CODE> </B><DD> +<DT><B> <CODE>[-t time] [-n boxno] [-l level] xcen,ycen,zcen xrad,yrad,zrad </CODE> </B><DD> </DL> -<CODE>level</CODE> determines color. -<P> +<CODE>level</CODE> determines color.</P> + <DT><B><CODE>mesh</CODE> [<CODE>-t</CODE> <I>txno</I>] [<CODE>-c</CODE> <I>colorindex</I>] [<CODE>-s</CODE> <I>style</I>]</B><DD><P>Draw a quadrilateral mesh, optionally colored or textured. Following the <B>mesh</B> line, provide a line with the mesh dimensions: -nu nv +nu nv</P> <P>Following this comes the list of <I>nu</I>*<I>nv</I> mesh vertices, one vertex (specified by several blank-separated numbers) per line. (Blank lines and comments may be interspersed among them.) @@ -698,53 +736,58 @@ Note that the mesh connections are implicit: vertex number i*nu+j is adjacent to (i-1)*nu+j, (i+1)*nu+j, i*nu+(j-1), and i*nu+(j+1). Each vertex line has three or five numbers: the first three give its 3-D position, and if a <CODE>-t</CODE> texture was -specified, then two more fields give its u and v texture coordinates. -<P> +specified, then two more fields give its u and v texture coordinates.</P> + <P>Options: <DL> <DT><B> <CODE>-t</CODE> <I>txno</I> </B><DD><P>Apply texture number <I>txno</I> to surface. In this case, each mesh vertex should also include -u and v texture coordinates. +u and v texture coordinates.</P> <DT><B> <CODE>-c</CODE> <I>colorindex</I> </B><DD><P>Color surface with color from -integer cmap entry <I>colorindex</I>. +integer cmap entry <I>colorindex</I>.</P> <DT><B> <CODE>-s</CODE> <I>style</I> </B><DD><P>Drawing style: <DL> -<DT><B> <I>solid</I> </B><DD><P>filled polygonal surface (default) -<DT><B> <I>wire</I> </B><DD><P>just edges -<DT><B> <I>point</I> </B><DD><P>just points (one per mesh vertex) +<DT><B> <I>solid</I> </B><DD><P>filled polygonal surface (default)</P> +<DT><B> <I>wire</I> </B><DD><P>just edges</P> +<DT><B> <I>point</I> </B><DD><P>just points (one per mesh vertex)</P> </DL> +</P> </DL> -<P> +</P> + <DT><B><I>Xcen Ycen Zcen</I> ellipsoid <I>[options]... [transformation]</I></B><DD><P>Draw an ellipsoid, specified by: <DL> -<DT><B> <CODE>Xcen Ycen Zcen</CODE> </B><DD><P>Center position in world coordinates -<DT><B> <CODE>-c</CODE> <I>colorindex</I> </B><DD><P>Integer color index (default -1 => white) +<DT><B> <CODE>Xcen Ycen Zcen</CODE> </B><DD><P>Center position in world coordinates</P> +<DT><B> <CODE>-c</CODE> <I>colorindex</I> </B><DD><P>Integer color index (default -1 => white)</P> <DT><B> <CODE>-s</CODE> <I>style</I> </B><DD><P>Drawing style: <DL> -<DT><B> <I>solid</I> </B><DD><P>filled polygonal surface (default) -<DT><B> <I>plane</I> </B><DD><P>3 ellipses: XY, XZ, YZ planes -<DT><B> <I>wire</I> </B><DD><P>latitude/longitude ellipses -<DT><B> <I>point</I> </B><DD><P>point cloud: one per lat/lon intersection +<DT><B> <I>solid</I> </B><DD><P>filled polygonal surface (default)</P> +<DT><B> <I>plane</I> </B><DD><P>3 ellipses: XY, XZ, YZ planes</P> +<DT><B> <I>wire</I> </B><DD><P>latitude/longitude ellipses</P> +<DT><B> <I>point</I> </B><DD><P>point cloud: one per lat/lon intersection</P> </DL> -<DT><B> <CODE>-r</CODE> <I>Xradius</I>[,<I>Yradius</I>,<I>Zradius</I>] </B><DD><P>Radius (for sphere) or semimajor axes (for ellipsoid) +</P> +<DT><B> <CODE>-r</CODE> <I>Xradius</I>[,<I>Yradius</I>,<I>Zradius</I>] </B><DD><P>Radius (for sphere) or semimajor axes (for ellipsoid)</P> <DT><B> <CODE>-n</CODE> <I>nlat[,nlon]</I> </B><DD><P>Number of latitude and longitude divisions. Relevant even for <I>plane</I> style, where they determine how finely the polygonal curves approximate circles. -Default <I>nlon</I> = <I>nlat</I>/2 + 1. +Default <I>nlon</I> = <I>nlat</I>/2 + 1.</P> <DT><B> <I>transformation</I> </B><DD><P>Sets the spatial orientation of the ellipsoid. May take any of three forms: <DL> <DT><B> (nothing) </B><DD><P>If absent, the ellipsoid's coordinate axes are the same as the world axes -for the group it belongs to. +for the group it belongs to.</P> <DT><B> 9 blank-separated numbers </B><DD><P>A 3x3 transformation matrix T from ellipsoid coordinates to world coordinates, in the sense -Pworld = Pellipsoid * T + [Xcen, Ycen, Zcen]. +Pworld = Pellipsoid * T + [Xcen, Ycen, Zcen].</P> <DT><B> 16 blank-separated numbers </B><DD><P>A 4x4 transformation matrix, as above but for the -obvious changes. +obvious changes.</P> </DL> +</P> </DL> -<P> +</P> + <DT><B>waveobj [-time <I>timestep</I>] [-static] [-texture <I>number</I>] [-c <I>colorindex</I>] [-s <I>style</I>] <I>file.obj</I></B><DD><P>Load a Wavefront-style .obj model. Material properties are ignored; the surface is drawn in white unless <CODE>-c</CODE> <I>colorindex</I> in which case it's drawn using that color-table color. @@ -752,18 +795,36 @@ Also if <CODE>-texture</CODE> (alias <CODE>-tx</CODE>) is supplied, the surface is textured using whatever texture coordinates are supplied in the .obj file. The model is displayed at all times only if marked <CODE>-static</CODE>; otherwise it's displayed only -at the time given by <CODE>-time</CODE> <I>timestep</I> or by the most recent <I>datatime</I>. -<P> -<P> -<P> -<P> +at the time given by <CODE>-time</CODE> <I>timestep</I> or by the most recent <I>datatime</I>.</P> +<P>A subset of the .obj format is accepted: +<DL> +<DT><B>v <I>X Y Z</I></B><DD><P>-- vertex position</P> +<DT><B>vt <I>U V</I></B><DD><P>-- vertex texture coordinates</P> +<DT><B>vn <I>NX NY NZ</I></B><DD><P>-- vertex normal</P> +<DT><B>f <I>V1 V2 V3 ...</I></B><DD><P>-- face, listing just position indices for each vertex. +The first <CODE>v</CODE> line in the .obj file has index 1, etc.</P> +<DT><B>f <I>V1/T1 V2/T2 V3/T3 ...</I></B><DD><P>-- face, +listing position and texture coordinates for each vertex of the face.</P> +<DT><B>f <I>V1/T1/N1 V2/T2/N2 V3/T3/N3 ...</I></B><DD><P>-- face, +listing position, texture-coordinate, and normal indices for each vertex.</P> +</DL> + +Note that material properties (mtl) are ignored. Waveobj models are colored +according to the <CODE>-c</CODE> <I>colorindex</I> option (integer index +into the current <CODE>cmap</CODE> colormap), or white if no <CODE>-c</CODE> is used. +If texturing is enabled -- if the .obj model contains <CODE>vt</CODE> entries, +and the <CODE>-texture</CODE> option appears, and that numbered texture exists -- +then the given texture color multiplies or replaces the <CODE>-c</CODE> color, +according to the texture options.</P> + + <DT><B>tfm [camera] <I>numbers...</I></B><DD><P>Object-to-world transformation. May take 1, 6, 7, 9 or 16 numbers: either <I>scalefactor</I> or <I>tx ty tz rx ry rz </I>[it/scalefactor/] or 16 numbers for 4x4 matrix, or 9 numbers for 3x3 matrix. -See <I>Coordinates and Coordinate Transformations</I>. +See <I>Coordinates and Coordinate Transformations</I>.</P> <P>Normally the transform is to world coordinates; but with optional <CODE>camera</CODE> prefix, the object's position is specified relative to the camera, useful to place @@ -775,18 +836,19 @@ Try for example tfm camera -3 -3 -20 0 0 0 0 0 0 text -size 20 Legend </PRE> -<P> -<DT><B>eval <I>command</I></B><DD><P>execute a Control Command. -<P> -<DT><B>feed <I>command</I></B><DD><P>Synonym for <CODE>eval</CODE>. -<P> -<DT><B>VIRDIR <I>command</I></B><DD><P>Synonym for <CODE>eval</CODE>. -<P> -<P> +</P> + +<DT><B>eval <I>command</I></B><DD><P>execute a Control Command.</P> + +<DT><B>feed <I>command</I></B><DD><P>Synonym for <CODE>eval</CODE>.</P> + +<DT><B>VIRDIR <I>command</I></B><DD><P>Synonym for <CODE>eval</CODE>.</P> + + <DT><B>filepath <I>path</I></B><DD><P>A colon-separated list of directories in which datafiles, color maps, etc. will be searched for. If preceded with the <CODE>+</CODE> symbol, -this list will be appended to the current <I>filepath</I>. -<P> +this list will be appended to the current <I>filepath</I>.</P> + <DT><B>polyorivar <I>indexno</I></B><DD><P>By default, when polygons are drawn, they're parallel to the screen plane -- simple markers for the points. It's sometimes useful to give each polygon a fixed 3-D orientation (as for disk galaxies). To do this, @@ -795,64 +857,66 @@ vectors which span the plane of the disk. Then use <CODE>polyorivar </CODE><I>indexno</I> giving the data field number of the first of the 6 fields. The vectors define the X and Y directions on the disk, respectively -- -relevant if texturing is enabled. +relevant if texturing is enabled.</P> <P>Actually, unit vectors aren't essential; making them different lengths -yields non-circular polygonal disks. +yields non-circular polygonal disks. </P> <P>If <CODE>polyorivar</CODE> is specified for the group, but some polygons should -still lie in the screen plane, use values <CODE>9 9 9 9 9 9</CODE> for those polygons. -<P> +still lie in the screen plane, use values <CODE>9 9 9 9 9 9</CODE> for those polygons.</P> + <DT><B>texture [-aiAOlmnMDB] <I>txno file.sgi</I> </B><DD><P> <DL> <DT><B> -a(lpha) </B><DD><P>A single-channel image would normally be used as luminance data. With <CODE>-a</CODE>, the image is taken as opacity data instead -(GL_ALPHA texture format). +(GL_ALPHA texture format).</P> <DT><B> -i(ntensity) </B><DD><P>For 1- or 3-channel images, compute the intensity of each pixel -and use it to form an alpha (opacity) channel. +and use it to form an alpha (opacity) channel.</P> <DT><B> -A(dd) </B><DD><P>Use additive blending. This texture will add to, not obscure, -the brightness of whatever lies behind it (i.e. whatever is drawn later). +the brightness of whatever lies behind it (i.e. whatever is drawn later).</P> <DT><B> -O(ver) </B><DD><P>Use "over" compositing. This texture will obscure features lying -behind it according to alpha values at each point. -<P> -<P> +behind it according to alpha values at each point.</P> + + <DT><B> -M(odulate) </B><DD><P>Multiply texture brightness/color values by the colormap-determined -color of each particle. +color of each particle.</P> <DT><B> -D(ecal) </B><DD><P>The textured polygon's color is determined entirely by the texture, -suppressing any colormapped color. -<DT><B> -B(lend) </B><DD><P>Probably not very useful. +suppressing any colormapped color.</P> +<DT><B> -B(lend) </B><DD><P>Probably not very useful.</P> </DL> -<P> +</P> + <DT><B>texturevar <I>field</I></B><DD><P>If polygon-drawing and texturing are turned on, use the given <I>field</I> (datavar name or number) in each particle to select -which texture (if any) to draw on its polygon. -<P> -<DT><B>coord <I>name ... 16 world-to-coord tfm floats (GL order)</I></B><DD><P> +which texture (if any) to draw on its polygon.</P> + +<DT><B>coord <I>name ... 16 world-to-coord tfm floats (GL order)</I></B><DD> <DT><B>dataset <I>indexno datasetname</I></B><DD><P>Give names to multiple datasets in IEEEIO files (read with <CODE>ieee</CODE> command). -<I>indexno</I> is an integer, 0 being the first dataset. -<P> +<I>indexno</I> is an integer, 0 being the first dataset.</P> + <DT><B>datavar <I>indexno name [minval maxval]</I></B><DD><P>Name the variable in data field <I>indexno</I>. The first data field has <I>indexno</I> 0. If provided, <I>minval maxval</I> supply the nominal range of that data variable; some control commands (<CODE>lum</CODE>, <CODE>color</CODE>) need to know the range of data -values, and will use this instead of measuring the actual range. -<P> -<DT><B>datatime <I>time</I></B><DD><P>Label subsequent data with this <I>time</I> (a non-negative integer). -<P> +values, and will use this instead of measuring the actual range.</P> + +<DT><B>datatime <I>time</I></B><DD><P>Label subsequent data with this <I>time</I> (a non-negative integer).</P> + <DT><B><I>Xpos Ypos Zpos Var0 .... </I></B><DD><P>These lines, with XYZ positions in the first 3 columns, will make up the bulk of a typical dataset. The 4th and subsequent columns contain the values of the datavariables as named with the <B>datavar</B> commands. Note that -data variable (field) numbers are 0-based. -<P> +data variable (field) numbers are 0-based.</P> + </DL> -<P> -<P> -<H2><A NAME="ss4.9">4.9 Kira/Starlab </A> +</P> + + +<H2><A NAME="ss4.9">4.9</A> <A HREF="partiview.html#toc4.9">Kira/Starlab </A> </H2> -<P> + <P>To read Kira output, in human-readable or binary <B>tdyn</B> form, use the -``<CODE>kira</CODE> <I>kirafilename</I>'' data-command. -<P> -<P> +``<CODE>kira</CODE> <I>kirafilename</I>'' data-command.</P> + + <H3>Kira particle attributes </H3> <P>The particles read in have the following attributes: @@ -860,47 +924,49 @@ data variable (field) numbers are 0-based. <DT><B> id </B><DD><P>positive integer worldline index for single stars (matching the id in the kira stream). For non-leaf (center-of-mass) tree nodes, <CODE>id</CODE> is a -negative integer. -<DT><B> mass </B><DD><P>Mass, in solar mass units (see ``kira mscale'' control command). +negative integer.</P> +<DT><B> mass </B><DD><P>Mass, in solar mass units (see ``kira mscale'' control command).</P> <DT><B> nclump </B><DD><P>Number of stars in this particle's subtree. -1 for isolated stars, 2 for binaries, etc. -<DT><B> Tlog </B><DD><P>base-10 log of temperature (K) -<DT><B> Lum </B><DD><P>Luminosity in solar-mass units. (Note this is linear, not log luminosity.) +1 for isolated stars, 2 for binaries, etc.</P> +<DT><B> Tlog </B><DD><P>base-10 log of temperature (K)</P> +<DT><B> Lum </B><DD><P>Luminosity in solar-mass units. (Note this is linear, not log luminosity.)</P> <DT><B> stype </B><DD><P>Stellar type code (small integer). The [bracketed] message reported when picking (button-2 or p key) -on a star gives the corresponding human-readable stellar type too. -<DT><B> ismember </B><DD><P>Is this star still a member of (bound to) the cluster? -<DT><B> rootid </B><DD><P>id of root of subtree. For single stars, rootid = id. -<DT><B> treeaddr </B><DD><P>bit-encoded location of star in subtree. +on a star gives the corresponding human-readable stellar type too.</P> +<DT><B> ismember </B><DD><P>Is this star still a member of (bound to) the cluster?</P> +<DT><B> rootid </B><DD><P>id of root of subtree. For single stars, rootid = id.</P> +<DT><B> treeaddr </B><DD><P>bit-encoded location of star in subtree.</P> <DT><B> ringsize </B><DD><P>0 for stars. For nonleaf nodes, this is the semimajor axis or instantaneous separation (according to ``<CODE>kira sep</CODE>''). This field isn't multiplied by the scale factor given in -<CODE>kira sep</CODE>; it gives the actual distance in kira units. -<DT><B> sqrtmass </B><DD><P>Square root of mass/Msun. Might be useful for luminosity scaling. -<DT><B> mu </B><DD><P>Mass ratio for center-of-mass nodes. Zero for stars. +<CODE>kira sep</CODE>; it gives the actual distance in kira units.</P> +<DT><B> sqrtmass </B><DD><P>Square root of mass/Msun. Might be useful for luminosity scaling.</P> +<DT><B> mu </B><DD><P>Mass ratio for center-of-mass nodes. Zero for stars.</P> </DL> -<P> -<P> +</P> + + <H3>Hertzsprung-Russell diagram </H3> <P>The H-R diagram can be invoked via the <CODE>More...</CODE> menu (upper left) or by the <CODE>kira hrdiag on</CODE> control command. Axes for this plot are log temperature (initial range from 5 to 3) and log luminosity (initial range -4 to 6). Ranges may be changed -with the <CODE>kira hrdiag range</CODE> command or with keystrokes. +with the <CODE>kira hrdiag range</CODE> command or with keystrokes.</P> <P>Keystroke commands in the H-R window: <DL> <DT><B> b/B </B><DD><P>Adjust the (b)rightness (dot size) of the dots plotted for each star. -Small b brightens (enlarges); capital B shrinks. +Small b brightens (enlarges); capital B shrinks.</P> <DT><B> a/A </B><DD><P>Adjust (a)lpha (opacity) of dots plotted for each star. If many stars coincide in H-R, their brightnesses add. Thus reducing opacity may help clarify the relative L-T space -densities, if there are many stars. +densities, if there are many stars.</P> <DT><B> v/V </B><DD><P>Zoom out (v) or in (V) by 33%. The point under the cursor -becomes the center of the view. +becomes the center of the view.</P> </DL> -<P> +</P> + <H3>kira control commands </H3> <P>Viewing control options for kira/Starlab @@ -910,33 +976,33 @@ All control commands begin with <CODE>kira</CODE> too. <DL> <DT><B> kira node {on|off|root} </B><DD><P>Show or hide center-of-mass nodes for multiple stars. With <CODE>on</CODE>, show CM nodes for each level in a binary tree. -With <CODE>root</CODE>, show only the top-level CM node for each multiple. -<P> -<DT><B> kira ring {on|off|root} </B><DD><P>Show circles around multiple stars; <CODE>on</CODE> and <CODE>root</CODE> as above. -<P> +With <CODE>root</CODE>, show only the top-level CM node for each multiple.</P> + +<DT><B> kira ring {on|off|root} </B><DD><P>Show circles around multiple stars; <CODE>on</CODE> and <CODE>root</CODE> as above.</P> + <DT><B> kira tree {on|off|cross|tick} [<I>tickscale</I>] </B><DD><P>Show lines connecting pairs of stars at each binary-tree level in a multiple group. With <CODE>cross</CODE>, also show a perpendicular line -- a tick mark -- which crosses at the CM point, and whose length is <CODE>tickscale</CODE> (default 0.5) times the true separation of the pair. -With <CODE>tick</CODE>, just show the tick-mark with no connecting line. -<P> +With <CODE>tick</CODE>, just show the tick-mark with no connecting line.</P> + <DT><B> kira size [sep|semi] [<I>ringscalefactor</I>] </B><DD><P>Determines 3-D size of circles when <CODE>kira ring on</CODE>. With <CODE>kira size sep</CODE>, ring diameter is scalefactor * instanteous separation. With <CODE>kira size semi</CODE>, ring radius is scalefactor * a (the semimajor axis of the two-body system, or <CODE>|a|</CODE> for hyperbolic orbits). Using <CODE>semi</CODE> gives typically more stable-looking rings, though they will pop if they become marginally (un-)bound. -Default: <CODE>kira size semi 1.5</CODE>. -<P> -<DT><B>kira scale <I>ringscalefactor</I></B><DD><P>Synonym for <CODE>kira size</CODE> above. -<P> +Default: <CODE>kira size semi 1.5</CODE>.</P> + +<DT><B>kira scale <I>ringscalefactor</I></B><DD><P>Synonym for <CODE>kira size</CODE> above.</P> + <DT><B> kira span <I>minpix</I> <I>maxpix</I> </B><DD><P>Sets screen-space (pixel) size limits on rings. They'll never get smaller than radius <I>minpix</I> nor larger than <I>maxpix</I>, regardless of true 3-D size. Thus even vanishingly tight binaries can always be visibly marked. -Default: <CODE>kira span 2 50</CODE>. -<P> +Default: <CODE>kira span 2 50</CODE>.</P> + <DT><B> kira track <I>id</I>|on|off </B><DD><P>As particle <I>id</I> moves through time, move the viewpoint in the same way, so that (if you don't move the view by navigation) the particle remains fixed in apparent position. @@ -945,8 +1011,8 @@ re-enables it. Use the <CODE>p</CODE> key or mouse button 2 to pick a particle (or CM node if <CODE>kira node on</CODE>) to see its numeric <I>id</I>. Transient center-of-mass nodes (shown if <CODE>kira node on</CODE>) -can be tracked while they exist. -<P> +can be tracked while they exist.</P> + <DT><B> kira mscale <I>massscalefactor</I>[!] </B><DD><P>Set/check the mass scale factor. Starlab dynamical mass values are multiplied by this factor for reporting to the user. Normally <I>massscalefactor</I> @@ -955,8 +1021,8 @@ For some input files, starlab can determine what was specified in the original kira run. If so, ``kira mscale <I>number</I>'' will be ignored unless <I>number</I> ends with an exclamation point (!). So with no <CODE>!</CODE>, the user (or .cf script) provides a default value; -use <CODE>!</CODE> to override the original mass scale. -<P> +use <CODE>!</CODE> to override the original mass scale.</P> + <DT><B> kira int <I>seldest</I> [= <I>selsrc</I>] </B><DD><P>Track interactions between particles. As the cluster evolves, whenever any star matching selection-expression <I>selsrc</I> encounters (is a member of @@ -969,14 +1035,15 @@ Otherwise, only stars that encounter members of the initial <I>selsrc</I> set become members of the <I>seldest</I> set. Example: <DL> -<DT><B> click on some star </B><DD><P>The clicked-on star(s) become members of the <CODE>pick</CODE> set. -<DT><B> sel x = pick </B><DD><P>Save a copy in the new set named <CODE>x</CODE>. -<DT><B> kira int x </B><DD><P>Accumulate encounters in the set <CODE>x</CODE>. -<DT><B> emph x </B><DD><P>Increase brightness of members of <CODE>x</CODE>. -<DT><B> kira trail x </B><DD><P>Extend trails from these set members. +<DT><B> click on some star </B><DD><P>The clicked-on star(s) become members of the <CODE>pick</CODE> set.</P> +<DT><B> sel x = pick </B><DD><P>Save a copy in the new set named <CODE>x</CODE>.</P> +<DT><B> kira int x </B><DD><P>Accumulate encounters in the set <CODE>x</CODE>.</P> +<DT><B> emph x </B><DD><P>Increase brightness of members of <CODE>x</CODE>.</P> +<DT><B> kira trail x </B><DD><P>Extend trails from these set members.</P> </DL> -<P> -<P> +</P> + + <DT><B> kira trail <I>selexpression</I>|off </B><DD><P>Leave trails behind particles selected by <I>selexpression</I> (see the <CODE>sel</CODE> command). As (dynamical) time passes, for each display update, one sample point is added to the trail @@ -984,28 +1051,30 @@ for each selected particle. (If you reverse the direction of time, the trails will fold back on themselves.) Some examples: <DL> <DT><B> kira trail all </B><DD><P>Makes trails grow behind all particles -(including CM nodes, if they're displayed) +(including CM nodes, if they're displayed)</P> <DT><B> kira trail pick </B><DD><P>Clicking on a star will make a trail grow behind it. If several stars are within picking range (under the cursor), -trails will grow behind each of them. -<DT><B> thresh -s big mass > 1.5 </B><DD><P>threshold when masses are larger than 1.5 +trails will grow behind each of them.</P> +<DT><B> thresh -s big mass > 1.5 </B><DD><P>threshold when masses are larger than 1.5</P> <DT><B> kira trail big </B><DD><P>These two commands (a) select all stars exceeding -1.5 solar masses and (b) extend trails behind them. +1.5 solar masses and (b) extend trails behind them.</P> </DL> -<P> +</P> + <DT><B> kira trail clear </B><DD><P>Erase current trails, but let them continue to accumulate -as time passes. -<P> +as time passes.</P> + <DT><B> kira maxtrail <I>nsamples</I> </B><DD><P>Set how many time-points are kept for each particle's trail, -initially 50. -<P> -<DT><B> kira hrdiag on|off </B><DD><P>toggle to turn HD Diagram on or off. Initially off. -<DT><B> kira hrdiag range <I>logTleft logTright logLbottom logLtop</I> </B><DD><P>set limits on the HD Diagram axes. -<P> +initially 50.</P> + +<DT><B> kira hrdiag on|off </B><DD><P>toggle to turn HD Diagram on or off. Initially off.</P> +<DT><B> kira hrdiag range <I>logTleft logTright logLbottom logLtop</I> </B><DD><P>set limits on the HD Diagram axes.</P> + </DL> -<P> -<P> -<H2><A NAME="ss4.10">4.10 Textures </A> +</P> + + +<H2><A NAME="ss4.10">4.10</A> <A HREF="partiview.html#toc4.10">Textures </A> </H2> <P>To make polygons be textured: @@ -1023,13 +1092,13 @@ and to give the polygons nonzero size.</LI> 4-sided polygons -- a bit faster to draw than default 11-gons.</LI> </UL> -It doesn't matter whether the texture-index data field is given a datavar name. +It doesn't matter whether the texture-index data field is given a datavar name.</P> <P>For each particle, if the value of its <I>texturevar</I>'th field either (a) doesn't match the value in some <CODE>texture</CODE> command or (b) the file named in that <CODE>texture</CODE> command couldn't be read, -then its polygon is drawn as if texturing were disabled. -<P> -<H2><A NAME="ss4.11">4.11 Coordinates and Coordinate Transformations</A> +then its polygon is drawn as if texturing were disabled.</P> + +<H2><A NAME="ss4.11">4.11</A> <A HREF="partiview.html#toc4.11">Coordinates and Coordinate Transformations</A> </H2> <P>Matrices as for the <B>tfm</B> command @@ -1037,13 +1106,13 @@ are intended to be multiplied by an object-coordinate row vector on the left, so that 4x4 matrices specify a translation in their 13th through 15th entries. Generally they're -in the sense of an object-or-camera-to-world transform. +in the sense of an object-or-camera-to-world transform.</P> <P>The six- or seven-number transforms (<I>tx ty tz rx ry rz </I>[it/scalefactor/], as accepted by the <B>tfm</B> and <B>jump</B> commands) -are interpreted as -<P><I>Pworld = Pobject * scalefactor * </I>rotY(<I>ry</I>) * rotX(<I>rx</I>) * rotZ(<I>rz</I>) * translate(<I>tx,ty,tz</I>) -<P> -<H2><A NAME="ss4.12">4.12 Colormap Files</A> +are interpreted as</P> +<P><I>Pworld = Pobject * scalefactor * </I>rotY(<I>ry</I>) * rotX(<I>rx</I>) * rotZ(<I>rz</I>) * translate(<I>tx,ty,tz</I>)</P> + +<H2><A NAME="ss4.12">4.12</A> <A HREF="partiview.html#toc4.12">Colormap Files</A> </H2> <P>Colormap files, as read by the <CODE>cmap</CODE> and <CODE>vcmap</CODE> commands, @@ -1069,8 +1138,8 @@ and so on. Also, </PRE> copies the (previously-assigned) RGB value from <I>oldcolorindex</I> -and assigns it to <I>colorindex</I>. -<P> +and assigns it to <I>colorindex</I>.</P> + <HR> <A HREF="partiview-5.html">Next</A> <A HREF="partiview-3.html">Previous</A> diff --git a/doc/partiview-5.html b/doc/partiview-5.html index 19fdeaa026ac2289065584e5ed7f543c0ba9e4a5..add93bdf355e4d9f4b75f92d346973e2cc1e1692 100644 --- a/doc/partiview-5.html +++ b/doc/partiview-5.html @@ -1,7 +1,7 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> <HTML> <HEAD> - <META NAME="GENERATOR" CONTENT="SGML-Tools 1.0.9"> + <META NAME="GENERATOR" CONTENT="LinuxDoc-Tools 0.9.20"> <TITLE> Partiview (PC-VirDir): Viewing Window Keyboard Shortcuts </TITLE> <LINK HREF="partiview-6.html" REL=next> <LINK HREF="partiview-4.html" REL=previous> @@ -12,12 +12,12 @@ <A HREF="partiview-4.html">Previous</A> <A HREF="partiview.html#toc5">Contents</A> <HR> -<H2><A NAME="s5">5. Viewing Window Keyboard Shortcuts </A></H2> +<H2><A NAME="s5">5.</A> <A HREF="partiview.html#toc5">Viewing Window Keyboard Shortcuts </A></H2> + -<P> <P>Commands that you can give from within the viewing window are all single -keystroke commands, often combined with moving the mouse. -<P> +keystroke commands, often combined with moving the mouse.</P> + <P> <BLOCKQUOTE><CODE> <PRE> @@ -69,7 +69,8 @@ Gview.cpp : Fl_Gview::handle() </PRE> </CODE></BLOCKQUOTE> -<P> +</P> + <HR> <A HREF="partiview-6.html">Next</A> <A HREF="partiview-4.html">Previous</A> diff --git a/doc/partiview-6.html b/doc/partiview-6.html index a9a4021069ba6caf55d0ea58c7eb6607d03ff2f2..47a5e8d35b6578f3a08019b52d946eb70055e5ba 100644 --- a/doc/partiview-6.html +++ b/doc/partiview-6.html @@ -1,7 +1,7 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> <HTML> <HEAD> - <META NAME="GENERATOR" CONTENT="SGML-Tools 1.0.9"> + <META NAME="GENERATOR" CONTENT="LinuxDoc-Tools 0.9.20"> <TITLE> Partiview (PC-VirDir): Partiview and NEMO</TITLE> <LINK HREF="partiview-7.html" REL=next> <LINK HREF="partiview-5.html" REL=previous> @@ -12,7 +12,7 @@ <A HREF="partiview-5.html">Previous</A> <A HREF="partiview.html#toc6">Contents</A> <HR> -<H2><A NAME="s6">6. Partiview and NEMO</A></H2> +<H2><A NAME="s6">6.</A> <A HREF="partiview.html#toc6">Partiview and NEMO</A></H2> <P>The program <CODE>snapspecks</CODE> converts a NEMO snapshot to specks format that can be read in directly by partiview. The default viewing variables @@ -21,7 +21,7 @@ using the <B>options=</B> keyword. In fact, arbitrary <I>bodytrans</I> expressions can be used for output. In the following example a 32-body Plummer sphere is created, which is then given a power-law mass spectrum (with slope -2) -between 0.5 and 10 mass units, and animated: +between 0.5 and 10 mass units, and animated:</P> <P> <BLOCKQUOTE><CODE> <HR> @@ -45,8 +45,9 @@ between 0.5 and 10 mass units, and animated: </PRE> <HR> </CODE></BLOCKQUOTE> -<P> -<P> +</P> + + <HR> <A HREF="partiview-7.html">Next</A> <A HREF="partiview-5.html">Previous</A> diff --git a/doc/partiview-7.html b/doc/partiview-7.html index 41b1037a0d456453936e0ea6c0145f36cc65df12..f485f7d98c9c70c38a65788333dceedb10eddea7 100644 --- a/doc/partiview-7.html +++ b/doc/partiview-7.html @@ -1,7 +1,7 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> <HTML> <HEAD> - <META NAME="GENERATOR" CONTENT="SGML-Tools 1.0.9"> + <META NAME="GENERATOR" CONTENT="LinuxDoc-Tools 0.9.20"> <TITLE> Partiview (PC-VirDir): Tips</TITLE> <LINK HREF="partiview-8.html" REL=next> <LINK HREF="partiview-6.html" REL=previous> @@ -12,17 +12,17 @@ <A HREF="partiview-6.html">Previous</A> <A HREF="partiview.html#toc7">Contents</A> <HR> -<H2><A NAME="s7">7. Tips</A></H2> +<H2><A NAME="s7">7.</A> <A HREF="partiview.html#toc7">Tips</A></H2> + -<P> <P>During animation the trip/back buttons can effectively be used to return to a point in time where you want to return back to if you wanted to -browse around some specific point in time. +browse around some specific point in time.</P> <P>You can spend most of the time moving in [o]rbit mode. Left-button moves around chosen center; control-left pans around the sky. As opposed to switching to 't' mode to zoom and translate, you can also use SHIFT-Mouse-1 and SHIFT-Mouse-3 to achieve the same from -the other ('o', 'f') modes. +the other ('o', 'f') modes.</P> <P>To make an animation, create an executable shell script <CODE>movie1</CODE> with for example the following commands: <BLOCKQUOTE><CODE> @@ -57,6 +57,7 @@ can be shown: </PRE> <HR> </CODE></BLOCKQUOTE> +</P> <P>To make animated GIFs, here are some examples with common software, all with a default 0.1 sec delay between frames. Some animation software (e.g. xanim) can change these: @@ -68,11 +69,12 @@ software (e.g. xanim) can change these: </PRE> <HR> </CODE></BLOCKQUOTE> +</P> <P>The script will run asynchronously within partiview, so if you then use the mouse to change orientation or zoom, these actions (minus the location of the mouse of course) -will be nicely recorded in the snapshots. -<P> +will be nicely recorded in the snapshots.</P> + <HR> <A HREF="partiview-8.html">Next</A> <A HREF="partiview-6.html">Previous</A> diff --git a/doc/partiview-8.html b/doc/partiview-8.html index 65cbe6d31358f2cc375a61f5e119dbc48b570f30..a4cc3af5b44fc8378b8a79774aa9736fd0d30de6 100644 --- a/doc/partiview-8.html +++ b/doc/partiview-8.html @@ -1,7 +1,7 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> <HTML> <HEAD> - <META NAME="GENERATOR" CONTENT="SGML-Tools 1.0.9"> + <META NAME="GENERATOR" CONTENT="LinuxDoc-Tools 0.9.20"> <TITLE> Partiview (PC-VirDir): Bugs, Features and Limitations</TITLE> <LINK HREF="partiview-9.html" REL=next> <LINK HREF="partiview-7.html" REL=previous> @@ -12,17 +12,17 @@ <A HREF="partiview-7.html">Previous</A> <A HREF="partiview.html#toc8">Contents</A> <HR> -<H2><A NAME="s8">8. Bugs, Features and Limitations</A></H2> +<H2><A NAME="s8">8.</A> <A HREF="partiview.html#toc8">Bugs, Features and Limitations</A></H2> + -<P> <P>Here is a list of known peculiarities, some of them bugs, others just features and others limitations, and there is always that class of -things I simply have not understood how it works. -<P> -<H2><A NAME="ss8.1">8.1 Limitations w.r.t. VirDir:</A> +things I simply have not understood how it works.</P> + +<H2><A NAME="ss8.1">8.1</A> <A HREF="partiview.html#toc8.1">Limitations w.r.t. VirDir:</A> </H2> -<P> + <P> <OL> <LI>cannot set an auto-motion, as we can in the dome, although one could @@ -32,8 +32,9 @@ Now mostly solved via the <CODE>Inertia</CODE> toggle under the <CODE>More</CODE> button from the Top Row Window. </LI> </OL> -<P> -<H2><A NAME="ss8.2">8.2 Some notes for newcomers to VirDir</A> +</P> + +<H2><A NAME="ss8.2">8.2</A> <A HREF="partiview.html#toc8.2">Some notes for newcomers to VirDir</A> </H2> <P>Although starting <CODE>virdir</CODE> is very similar to <CODE>partiview</CODE>, @@ -61,7 +62,7 @@ type the commands (blindly) <HR> </CODE></BLOCKQUOTE> -which will put <CODE>virdir</CODE> in fly and animation mode. +which will put <CODE>virdir</CODE> in fly and animation mode.</P> <P>Here are some important modes, make sure you keep the mouse in the console window. It is easy to get it lost in any of the other 6 displays which are only visible on the dome. @@ -86,7 +87,8 @@ available screen-space (works like a zoom). </LI> </OL> -<P> +</P> + <HR> <A HREF="partiview-9.html">Next</A> <A HREF="partiview-7.html">Previous</A> diff --git a/doc/partiview-9.html b/doc/partiview-9.html index e94999a2a2bbe20686d923901396051bac9d0bb4..8e9d0052432a1db3b8908bbd9a57f8beb762bbe6 100644 --- a/doc/partiview-9.html +++ b/doc/partiview-9.html @@ -1,7 +1,7 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> <HTML> <HEAD> - <META NAME="GENERATOR" CONTENT="SGML-Tools 1.0.9"> + <META NAME="GENERATOR" CONTENT="LinuxDoc-Tools 0.9.20"> <TITLE> Partiview (PC-VirDir): Glossary</TITLE> <LINK HREF="partiview-8.html" REL=previous> <LINK HREF="partiview.html#toc9" REL=contents> @@ -11,9 +11,9 @@ Next <A HREF="partiview-8.html">Previous</A> <A HREF="partiview.html#toc9">Contents</A> <HR> -<H2><A NAME="s9">9. Glossary</A></H2> +<H2><A NAME="s9">9.</A> <A HREF="partiview.html#toc9">Glossary</A></H2> + -<P> <P> <OL> <LI>group: particles can be grouped with the <CODE>object</CODE> command. If multiple groups @@ -26,8 +26,9 @@ exist, a separate <CODE>Group</CODE> row will be activated automatically. <LI> </LI> </OL> -<P> -<P> +</P> + + <HR> Next <A HREF="partiview-8.html">Previous</A> diff --git a/doc/partiview.html b/doc/partiview.html index 0e7aadaa8fa21f45c47fecc46adc054b613bd7e5..e3ffa8f1bd2b93ba61bfdd62b2af62d052fed6fe 100644 --- a/doc/partiview.html +++ b/doc/partiview.html @@ -1,7 +1,7 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> <HTML> <HEAD> - <META NAME="GENERATOR" CONTENT="SGML-Tools 1.0.9"> + <META NAME="GENERATOR" CONTENT="LinuxDoc-Tools 0.9.20"> <TITLE> Partiview (PC-VirDir)</TITLE> <LINK HREF="partiview-1.html" REL=next> @@ -15,7 +15,7 @@ Contents <H1> Partiview (PC-VirDir)</H1> <H2>Peter Teuben, Stuart Levy</H2> 25 June 2002 -<P><HR> +<HR> <EM>partiview is a program that enables you to visualize and animate particle data. partiview runs on relatively simple desktops and laptops, but is mostly compatible with its big brother VirDir. @@ -25,11 +25,11 @@ This document helps you installing and running the development version of partiv <H2><A NAME="toc1">1.</A> <A HREF="partiview-1.html">Installation</A></H2> <UL> -<LI><A HREF="partiview-1.html#ss1.1">1.1 MESA/OpenGL</A> -<LI><A HREF="partiview-1.html#ss1.2">1.2 FLTK</A> -<LI><A HREF="partiview-1.html#ss1.3">1.3 partiview</A> -<LI><A HREF="partiview-1.html#ss1.4">1.4 CVS</A> -<LI><A HREF="partiview-1.html#ss1.5">1.5 Compiling under Windows</A> +<LI><A NAME="toc1.1">1.1</A> <A HREF="partiview-1.html#ss1.1">MESA/OpenGL</A> +<LI><A NAME="toc1.2">1.2</A> <A HREF="partiview-1.html#ss1.2">FLTK</A> +<LI><A NAME="toc1.3">1.3</A> <A HREF="partiview-1.html#ss1.3">partiview</A> +<LI><A NAME="toc1.4">1.4</A> <A HREF="partiview-1.html#ss1.4">CVS</A> +<LI><A NAME="toc1.5">1.5</A> <A HREF="partiview-1.html#ss1.5">Compiling under Windows</A> </UL> <P> <H2><A NAME="toc2">2.</A> <A HREF="partiview-2.html">Directory structure</A></H2> @@ -38,34 +38,34 @@ This document helps you installing and running the development version of partiv <H2><A NAME="toc3">3.</A> <A HREF="partiview-3.html">Running the program</A></H2> <UL> -<LI><A HREF="partiview-3.html#ss3.1">3.1 Example 1: Hipparcos Bright Star Catalogue 3-D viewing</A> -<LI><A HREF="partiview-3.html#ss3.2">3.2 Top Row</A> -<LI><A HREF="partiview-3.html#ss3.3">3.3 Group row (optional)</A> -<LI><A HREF="partiview-3.html#ss3.4">3.4 Time Animation rows (Optional)</A> -<LI><A HREF="partiview-3.html#ss3.5">3.5 Camera (path) Animation row</A> -<LI><A HREF="partiview-3.html#ss3.6">3.6 Logfile window</A> -<LI><A HREF="partiview-3.html#ss3.7">3.7 Command window</A> -<LI><A HREF="partiview-3.html#ss3.8">3.8 Viewing window</A> -<LI><A HREF="partiview-3.html#ss3.9">3.9 Example 2: a (starlab) animation</A> -<LI><A HREF="partiview-3.html#ss3.10">3.10 Example 3: stereo viewing </A> -<LI><A HREF="partiview-3.html#ss3.11">3.11 Example 4: subsetting</A> +<LI><A NAME="toc3.1">3.1</A> <A HREF="partiview-3.html#ss3.1">Example 1: Hipparcos Bright Star Catalogue 3-D viewing</A> +<LI><A NAME="toc3.2">3.2</A> <A HREF="partiview-3.html#ss3.2">Top Row</A> +<LI><A NAME="toc3.3">3.3</A> <A HREF="partiview-3.html#ss3.3">Group row (optional)</A> +<LI><A NAME="toc3.4">3.4</A> <A HREF="partiview-3.html#ss3.4">Time Animation rows (Optional)</A> +<LI><A NAME="toc3.5">3.5</A> <A HREF="partiview-3.html#ss3.5">Camera (path) Animation row</A> +<LI><A NAME="toc3.6">3.6</A> <A HREF="partiview-3.html#ss3.6">Logfile window</A> +<LI><A NAME="toc3.7">3.7</A> <A HREF="partiview-3.html#ss3.7">Command window</A> +<LI><A NAME="toc3.8">3.8</A> <A HREF="partiview-3.html#ss3.8">Viewing window</A> +<LI><A NAME="toc3.9">3.9</A> <A HREF="partiview-3.html#ss3.9">Example 2: a (starlab) animation</A> +<LI><A NAME="toc3.10">3.10</A> <A HREF="partiview-3.html#ss3.10">Example 3: stereo viewing </A> +<LI><A NAME="toc3.11">3.11</A> <A HREF="partiview-3.html#ss3.11">Example 4: subsetting</A> </UL> <P> <H2><A NAME="toc4">4.</A> <A HREF="partiview-4.html">Commands</A></H2> <UL> -<LI><A HREF="partiview-4.html#ss4.1">4.1 Control Commands</A> -<LI><A HREF="partiview-4.html#ss4.2">4.2 I/O Control Commands</A> -<LI><A HREF="partiview-4.html#ss4.3">4.3 Object Group Control Commands</A> -<LI><A HREF="partiview-4.html#ss4.4">4.4 View Control commands</A> -<LI><A HREF="partiview-4.html#ss4.5">4.5 Particle Display Control Commands</A> -<LI><A HREF="partiview-4.html#ss4.6">4.6 Particle subsetting & statistics</A> -<LI><A HREF="partiview-4.html#ss4.7">4.7 Boxes</A> -<LI><A HREF="partiview-4.html#ss4.8">4.8 Data commands </A> -<LI><A HREF="partiview-4.html#ss4.9">4.9 Kira/Starlab </A> -<LI><A HREF="partiview-4.html#ss4.10">4.10 Textures </A> -<LI><A HREF="partiview-4.html#ss4.11">4.11 Coordinates and Coordinate Transformations</A> -<LI><A HREF="partiview-4.html#ss4.12">4.12 Colormap Files</A> +<LI><A NAME="toc4.1">4.1</A> <A HREF="partiview-4.html#ss4.1">Control Commands</A> +<LI><A NAME="toc4.2">4.2</A> <A HREF="partiview-4.html#ss4.2">I/O Control Commands</A> +<LI><A NAME="toc4.3">4.3</A> <A HREF="partiview-4.html#ss4.3">Object Group Control Commands</A> +<LI><A NAME="toc4.4">4.4</A> <A HREF="partiview-4.html#ss4.4">View Control commands</A> +<LI><A NAME="toc4.5">4.5</A> <A HREF="partiview-4.html#ss4.5">Particle Display Control Commands</A> +<LI><A NAME="toc4.6">4.6</A> <A HREF="partiview-4.html#ss4.6">Particle subsetting & statistics</A> +<LI><A NAME="toc4.7">4.7</A> <A HREF="partiview-4.html#ss4.7">Boxes</A> +<LI><A NAME="toc4.8">4.8</A> <A HREF="partiview-4.html#ss4.8">Data commands </A> +<LI><A NAME="toc4.9">4.9</A> <A HREF="partiview-4.html#ss4.9">Kira/Starlab </A> +<LI><A NAME="toc4.10">4.10</A> <A HREF="partiview-4.html#ss4.10">Textures </A> +<LI><A NAME="toc4.11">4.11</A> <A HREF="partiview-4.html#ss4.11">Coordinates and Coordinate Transformations</A> +<LI><A NAME="toc4.12">4.12</A> <A HREF="partiview-4.html#ss4.12">Colormap Files</A> </UL> <P> <H2><A NAME="toc5">5.</A> <A HREF="partiview-5.html">Viewing Window Keyboard Shortcuts </A></H2> @@ -80,8 +80,8 @@ This document helps you installing and running the development version of partiv <H2><A NAME="toc8">8.</A> <A HREF="partiview-8.html">Bugs, Features and Limitations</A></H2> <UL> -<LI><A HREF="partiview-8.html#ss8.1">8.1 Limitations w.r.t. VirDir:</A> -<LI><A HREF="partiview-8.html#ss8.2">8.2 Some notes for newcomers to VirDir</A> +<LI><A NAME="toc8.1">8.1</A> <A HREF="partiview-8.html#ss8.1">Limitations w.r.t. VirDir:</A> +<LI><A NAME="toc8.2">8.2</A> <A HREF="partiview-8.html#ss8.2">Some notes for newcomers to VirDir</A> </UL> <P> <H2><A NAME="toc9">9.</A> <A HREF="partiview-9.html">Glossary</A></H2> diff --git a/doc/partiview.ps.gz b/doc/partiview.ps.gz index dc60a08ceb337484b60a9d242987361ee387b8c3..fc3ba98752d94ed9af8a64d6426993d8f5163cf8 100644 Binary files a/doc/partiview.ps.gz and b/doc/partiview.ps.gz differ diff --git a/doc/partiview.txt b/doc/partiview.txt index 3a8a3629d7a4738266362cd9438b511139efc762..e355a796719f5d5c9bfd693359a0606176ea63bb 100644 --- a/doc/partiview.txt +++ b/doc/partiview.txt @@ -11,61 +11,7 @@ Table of Contents - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 1. Installation - 1.1 MESA/OpenGL 1.2 FLTK 1.3 partiview @@ -73,9 +19,7 @@ 1.5 Compiling under Windows 2. Directory structure - 3. Running the program - 3.1 Example 1: Hipparcos Bright Star Catalogue 3-D viewing 3.2 Top Row 3.3 Group row (optional) @@ -89,7 +33,6 @@ 3.11 Example 4: subsetting 4. Commands - 4.1 Control Commands 4.2 I/O Control Commands 4.3 Object Group Control Commands @@ -107,27 +50,24 @@ 4.12 Colormap Files 5. Viewing Window Keyboard Shortcuts - 6. Partiview and NEMO - 7. Tips - 8. Bugs, Features and Limitations - 8.1 Limitations w.r.t. VirDir: 8.2 Some notes for newcomers to VirDir 9. Glossary - ______________________________________________________________________ - 11.. IInnssttaallllaattiioonn + + + [1m1. Installation[0m This assumes you have the July 2001 release (version 0.6 or later) of - ppaarrttiivviieeww, not the earlier "ggvviieeww" release that was described in + [1mpartiview[22m, not the earlier "[1mgview[22m" release that was described in earlier versions of this document. We keep copies of some Linux support files (Mesa, FLTK) on our current http://www.astro.umd.edu/nemo/amnh website. Although more current @@ -142,7 +82,7 @@ - 11..11.. MMEESSAA//OOppeennGGLL + [1m1.1. MESA/OpenGL[0m First make sure Mesa is installed, for redhat6.2 there are rpm files @@ -164,7 +104,6 @@ - You should have both installed. Some packages will use libMesaGL, others libGL. Our configure script (see below) should take care of the two possible options. @@ -181,21 +120,13 @@ partiview. You can also use a CVS release of Mesa. - 11..22.. FFLLTTKK + [1m1.2. FLTK[0m Also make sure FLTK is installed. If you got our version, do this (as root) - - - - - - - - ______________________________________________________________________ % locate libfltk.a % locate Fl_Slider.h @@ -209,7 +140,6 @@ - (you only need it if you want to recompile the program at some point, not if you just want to run it) @@ -226,7 +156,7 @@ - 11..33.. ppaarrttiivviieeww + [1m1.3. partiview[0m You can decide to use a branded version, usually available as a tar or @@ -247,18 +177,16 @@ - - If you encounter difficulties of locating either the FLTK or MESA/OpenGL libraries, configure script options can specify them: - --with-fltk=_d_i_r_n_a_m_e names the directory which contains the lib and FL - subdirectories, --with-mesa=_d_i_r_n_a_m_e can specify the Mesa installation - directory [??], and --with-kira=_d_i_r_n_a_m_e names the Starlab directory, + --with-fltk=[4mdirname[24m names the directory which contains the lib and FL + subdirectories, --with-mesa=[4mdirname[24m can specify the Mesa installation + directory [??], and --with-kira=[4mdirname[24m names the Starlab directory, whose default value is taken from environment variable STARLAB_PATH if that is set. - 11..44.. CCVVSS + [1m1.4. CVS[0m Since version 0.5 partiview is under CVS control, and occasionally we will stamp out a new release when we deem it stable. Anonymous or @@ -298,9 +226,7 @@ - - - 11..55.. CCoommppiilliinngg uunnddeerr WWiinnddoowwss + [1m1.5. Compiling under Windows[0m Partiview can be compiled from the command line on Windows using either the Microsoft Visual C tools (cl, nmake, etc.) or using gcc/g++ @@ -328,7 +254,7 @@ nmake -f partiview.mak - Dependencies are _n_o_t properly maintained by this Makefile, so use + Dependencies are [4mnot[24m properly maintained by this Makefile, so use nmake -f partiview.mak clean if you change anything. @@ -356,7 +282,6 @@ - or the analogous setting of PATH using (on WinNT/2000 at least) My Computer -> Control Panel -> System -> Environment to make a permanent change to PATH. @@ -369,8 +294,6 @@ - - 4. Build the Starlab libraries, if desired: a. You may need to install CVS for Windows. Binary packages are @@ -389,8 +312,6 @@ - - c. Copy templates\starlab_setup.bat to local\starlab_setup.bat, and edit it. Change the first two set commands: set STARLAB_PATH to the installation directory -- in the above example, set @@ -407,8 +328,6 @@ - - e. If successful, you should find in the lib directory the files libdstar.a libdyn.a libnode.a librdc.a libsstar.a libstd.a libtdyn.a @@ -419,7 +338,7 @@ under Unix. The MSYS package imposes its own UNIX-like syntax for Windows pathnames, which you'll need to use as arguments to configure and friends, with forward- instead of backslashes and a - /_d_r_i_v_e_-_l_e_t_t_e_r prefix. Also, if typing to a Windows command-window, + /[4mdrive-letter[24m prefix. Also, if typing to a Windows command-window, shell scripts like configure must be explicitly fed to sh. Thus for example if FLTK is installed in C:\util\fltk-1.1.0 and Starlab is in F:\src\starlab, then you might build partiview by typing @@ -430,21 +349,19 @@ - Note there's no need to specify the location of the OpenGL or other libraries; the configure script and MinGW tools already know where to find them. - 22.. DDiirreeccttoorryy ssttrruuccttuurree + [1m2. Directory structure[0m Here is the directory structure, as per version 0.1: - partiview/ root directory partiview/src source code partiview/data sample datafiles (e.g. Hipparcos Bright Star Catalogue) @@ -456,11 +373,7 @@ - - - - - 33.. RRuunnnniinngg tthhee pprrooggrraamm + [1m3. Running the program[0m First we describe a simple example how to run partiview with a supplied sample dataset. Then we describe the different windows that @@ -468,7 +381,7 @@ listens to. - 33..11.. EExxaammppllee 11:: HHiippppaarrccooss BBrriigghhtt SSttaarr CCaattaalloogguuee 33--DD vviieewwiinngg + [1m3.1. Example 1: Hipparcos Bright Star Catalogue 3-D viewing[0m Start the program using one of the sample "speck" files in the data @@ -485,7 +398,6 @@ - and this should come up with a display familiar to most of us who watch the skies. You should probably enlarge the window a bit. Mine comes up in roughly a 300 by 300 display window, which may be a bit @@ -508,7 +420,6 @@ - and it should give another nice comfy view :-) If you ever get lost, and this is not hard, use the jump command to go back to a known position and/or viewing angle. @@ -566,15 +477,12 @@ - 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. - - ______________________________________________________________________ red = X axis green = Y axis @@ -583,22 +491,21 @@ - To choose an arbitrary center of rotation, use the center command. - 33..22.. TToopp RRooww + [1m3.2. Top Row[0m The top row contains some shortcuts to some frequently used commands. From left to right, it should show the following buttons: - MMoorree + [1mMore[0m Offers some mode switches as toggles: inertia for continues spin or motion, and an H-R Diagram to invoke a separate H-R diagram window for datasets that support stellar evolution. - [[gg11]] + [1m[g1][0m Pulldown g1, g2, ... (or whichever group) is the currently selected group. See object command to make aliases which group is defined to what object. If multiple groups are defined, the @@ -606,42 +513,42 @@ aliases, so you can toggle them to be displayed. - [[ff]]llyy + [1m[f]ly[0m Pulldown to select fly/orbit/rot/tran, which can also be activate by pressing the f/o/r/t keys inside the viewing window. - ppooiinntt + [1mpoint[0m Toggle to turn the points on/off. See also the points command. - ppoollyy + [1mpoly[0m Toggle to turn polygons on/off. See also the polygon command. - llbbll + [1mlbl[0m Toggle to turn labels on/off. See also the label command. - tteexx + [1mtex[0m Toggle to turn textures on/off. See also the texture command. - bbooxx + [1mbox[0m Toggle to turn boxes on/off. See also the boxes command. - ##..###### + [1m#.###[0m The current displayed value of the logslum lum slider (see next) - llooggsslluumm lluumm - Slider controlling the logarithm of the ddaattaavvaarr variable + [1mlogslum lum[0m + Slider controlling the logarithm of the [1mdatavar [22mvariable selected as luminosity (with the lum command). - 33..33.. GGrroouupp rrooww ((ooppttiioonnaall)) + [1m3.3. Group row (optional)[0m When more than one group has been activated (groups of particles or objects can have their own display properties, and be turned on and @@ -653,62 +560,60 @@ commands. - 33..44.. TTiimmee AAnniimmaattiioonn rroowwss ((OOppttiioonnaall)) + [1m3.4. Time Animation rows (Optional)[0m For time-dependent data, the third and fourth row from the top control the currently displayed data-time. This time-control bar is only visible when the object has a nonzero time range. - TT Shows the current time (or offset from the tripmeter). The - absolute time is the sum of the TT and ++ fields. Both are + [1mT [22mShows the current time (or offset from the tripmeter). The + absolute time is the sum of the [1mT [22mand [1m+ [22mfields. Both are editable. See also the step control command. - ttrriipp + [1mtrip[0m 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. - bbaacckk + [1mback[0m Press to return to reference time (sets T to 0). - ++ Current last time where tripmeter was set. You can reset to the + [1m+ [22mCurrent last time where tripmeter was set. You can reset to the first frame with the command step 0 - ddiiaall + [1mdial[0m Drag to adjust the current time. Sensitivity depends on the speed setting; dragging by one dial-width corresponds to 0.1 - wall-clock second of animation, i.e. 0.1 * _s_p_e_e_d in data time + wall-clock second of animation, i.e. 0.1 * [4mspeed[24m in data time units. - ||<< + [1m|<[0m - >>|| - Step time backwards or forwards by 0.1 * _s_p_e_e_d data time units. + [1m>|[0m + Step time backwards or forwards by 0.1 * [4mspeed[24m data time units. See also the < and > keyboard shortcuts. - <<<< + [1m<<[0m - >>>> + [1m>>[0m toggle movie move forwards in time Toggle animating backwards or - forwards in time, by 1 * _s_p_e_e_d data time units per real-time + forwards in time, by 1 * [4mspeed[24m data time units per real-time second. See also the {, ~, and } keyboard shortcuts. - ##..######## - (Logarithmic) value denoting _s_p_e_e_d of animation. See also the + [1m#.####[0m + (Logarithmic) value denoting [4mspeed[24m of animation. See also the speed control command. - - - 33..55.. CCaammeerraa ((ppaatthh)) AAnniimmaattiioonn rrooww + [1m3.5. Camera (path) Animation row[0m 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 @@ -716,30 +621,30 @@ - PPaatthh...... - Brings up a filebrowser to load a ..wwff path file. This is a file + [1mPath...[0m + Brings up a filebrowser to load a [1m.wf [22mpath file. This is a file with on each line 7 numbers: xyz location, RxRyRz viewing direction, and FOV (field of view). The rdata command loads such path files too. - PPllaayy + [1mPlay[0m Play the viewpoint along the currently loaded path, as the play command does. Right-click for a menu of play-speed options. - <<<< << [[######]] >>>>>> + [1m<< < [###] >>>[0m Step through camera-path frames. See also frame control command. - sslliiddeerr + [1mslider[0m Slides through camera path, and displays current frame. - 33..66.. LLooggffiillee wwiinnddooww + [1m3.6. Logfile window[0m 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 @@ -750,7 +655,7 @@ - 33..77.. CCoommmmaanndd wwiinnddooww + [1m3.7. Command window[0m The Command window is a single line entry window, in which Control Commands can be given. Their responses appear in the Logfile window @@ -763,7 +668,7 @@ - 33..88.. VViieewwiinngg wwiinnddooww + [1m3.8. Viewing window[0m The (OpenGL) Viewing window is where all the action occurs. Typically this is where you give single keystroke commands and/or move the mouse @@ -772,7 +677,7 @@ between Viewing window and Command window above. - 33..99.. EExxaammppllee 22:: aa ((ssttaarrllaabb)) aanniimmaattiioonn + [1m3.9. Example 2: a (starlab) animation[0m Setting up a small animation in for example Starlab can be done quite simply as follows: (see also the primbim16.mk makefile to create a @@ -780,16 +685,6 @@ - - - - - - - - - - ______________________________________________________________________ % makeplummer -i -n 20 | makemass -l 0.5 -u 10.0 | scale -s | kira -d 2 -D x10 > run1 % partiview run1.cf @@ -806,7 +701,6 @@ - Alternatively, if you had started up partiview without any arguments, the following Control Command (see below) would have done the same @@ -819,26 +713,24 @@ - - - 33..1100.. EExxaammppllee 33:: sstteerreeoo vviieewwiinngg + [1m3.10. Example 3: stereo viewing[0m 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 will probably work too. Crosseyed viewing is also available if - selected by sstteerreeoo ccrroossss. See sstteerreeoo and ffooccaalllleenn in the View + selected by [1mstereo cross[22m. See [1mstereo [22mand [1mfocallen [22min the View Commands section. - 33..1111.. EExxaammppllee 44:: ssuubbsseettttiinngg + [1m3.11. Example 4: subsetting[0m In the data directory, run partiview hip.cf - One of the data fields for these stars is the _B_-_V color, colorb_v, + One of the data fields for these stars is the [4mB-V[24m color, colorb_v, abbreviatable to just color. Look at just the bluest stars: try thresh color < -.1 @@ -848,7 +740,7 @@ the logslum lum slider to brighten) and look at the distribution of these blue stars. The Orion spiral-arm spur, extending generally along the +Y (green) axis, has lots of them. Now look at more reddish - stars, those with .5 <= _B_-_V <= 1.5, with: + stars, those with .5 <= [4mB-V[24m <= 1.5, with: thresh color .5 1.5 @@ -870,11 +762,7 @@ - - - - - 44.. CCoommmmaannddss + [1m4. Commands[0m There are two types of commands in partiview: Control Commands and Data Commands. Probably the most important difference between the two @@ -886,17 +774,11 @@ expected, using the eval prefix, e.g. in a data (or .cf) file. The real (Control) Command expects data commands, but if Control Commands are needed, they need to be preceded with the eval command. See also - the previous ssttaarrllaabb example. - - + the previous [1mstarlab [22mexample. - - - - - 44..11.. CCoonnttrrooll CCoommmmaannddss + [1m4.1. Control Commands[0m (see partibrains.c::specks_parse_args) @@ -915,14 +797,14 @@ - 44..22.. II//OO CCoonnttrrooll CCoommmmaannddss + [1m4.2. I/O Control Commands[0m - rreeaadd _s_p_e_c_k_s_-_f_i_l_e + [1mread [4m[22mspecks-file[0m Read a file containing Data Commands (typical suffix .cf or .speck). - aassyynncc _u_n_i_x_-_c_o_m_m_a_n_d + [1masync [4m[22munix-command[0m Run an arbitrary unix command (invoked via /bin/sh) as a subprocess of partiview. Its standard output is interpreted as a stream of control commands. Thus partiview can be driven @@ -933,7 +815,7 @@ hitting ESC to exit partiview. - aadddd _d_a_t_a_-_c_o_m_m_a_n_d + [1madd [4m[22mdata-command[0m Enter a Data Command where a Control Command is expected, e.g. in the text input box. For example, @@ -948,23 +830,22 @@ loads a kira (starlab) output file. - eevvaall _c_o_n_t_r_o_l_-_c_o_m_m_a_n_d + [1meval [4m[22mcontrol-command[0m Processes that control command just as if the eval prefix weren't there. Provided for symmetry: wherever either a control - command or a data command is expected, entering eval _c_o_n_t_r_o_l_- - _c_o_m_m_a_n_d ensures that it's taken as a control command. + command or a data command is expected, entering eval [4mcontrol-[0m + [4mcommand[24m ensures that it's taken as a control command. - aadddd ffiilleeppaatthh ((ddaattaa--ccoommmmaanndd)) + [1madd filepath (data-command)[0m Determines the list of directories where all data files, color maps, etc. are sought. See the filepath entry under Data Commands. - - 44..33.. OObbjjeecctt GGrroouupp CCoonnttrrooll CCoommmmaannddss + [1m4.3. Object Group Control Commands[0m Partiview can load multiple groups of particles, each with independent display settings, colormaps, etc. When more than one group is loaded, @@ -973,35 +854,35 @@ Right-clicking turns the group unconditionally on, and selects that group as the current one for other GUI controls. - Many Control Commands apply to the _c_u_r_r_e_n_t_l_y _s_e_l_e_c_t_e_d group. + Many Control Commands apply to the [4mcurrently[24m [4mselected[24m group. - Groups always have names of the form g_N for some small positive _N; + Groups always have names of the form g[4mN[24m for some small positive [4mN[24m; each group may also have an alias. - gg_N Select group g_N. Create a new group if it doesn't already + [1mg[4m[22mN[24m Select group g[4mN[24m. Create a new group if it doesn't already exist. - gg_N=_a_l_i_a_s - Assign name _a_l_i_a_s to group g_N. Note there must be no blanks + [1mg[4m[22mN[24m=[4malias[0m + Assign name [4malias[24m to group g[4mN[24m. Note there must be no blanks around the = sign. - oobbjjeecctt _o_b_j_e_c_t_n_a_m_e - Likewise, select object _o_b_j_e_c_t_n_a_m_e, which may be either an alias - name or g_N. + [1mobject [4m[22mobjectname[0m + Likewise, select object [4mobjectname[24m, which may be either an alias + name or g[4mN[24m. - gg_N _c_o_n_t_r_o_l_-_c_o_m_m_a_n_d + [1mg[4m[22mN[24m [4mcontrol-command[0m - oobbjjeecctt _o_b_j_e_c_t_n_a_m_e _c_o_n_t_r_o_l_-_c_o_m_m_a_n_d - Either form may be used as a _p_r_e_f_i_x to any control command to + [1mobject [4m[22mobjectname[24m [4mcontrol-command[0m + Either form may be used as a [4mprefix[24m to any control command to act on the specified group, e.g. object fred poly on - ggaallll _c_o_n_t_r_o_l_-_c_o_m_m_a_n_d - Invoke the given _c_o_n_t_r_o_l_-_c_o_m_m_a_n_d in all groups. For example, to + [1mgall [4m[22mcontrol-command[0m + Invoke the given [4mcontrol-command[24m in all groups. For example, to turn display of group 3 on and all others off, use: @@ -1010,64 +891,62 @@ + [1mon[0m - - oonn - - eennaabbllee + [1menable[0m Either one will enable the display of the currently selected group (as it is by default). - ooffff + [1moff[0m - ddiissaabbllee + [1mdisable[0m Either one will turn off the display of the current group. - 44..44.. VViieeww CCoonnttrrooll ccoommmmaannddss + [1m4.4. View Control commands[0m View commands affect the view; they aren't specific to data groups. - ffoovv _f_l_o_a_t + [1mfov [4m[22mfloat[0m Angular field of view (in degrees) in Y-direction. - cceenn[[tteerr]] _X _Y _Z [_R_A_D_I_U_S] + [1mcen[ter] [4m[22mX[24m [4mY[24m [4mZ[24m [[4mRADIUS[24m] Set point of interest. This is the center of rotation in [o]rbit and [r]otate modes. Also, in [o]rbit mode, translation speed is proportional to the viewer's distance from this point. - The optional _R_A_D_I_U_S (also set by censize) determines the size of + The optional [4mRADIUS[24m (also set by censize) determines the size of the marker crosshair, initially 1 unit. - cceenn[[tteerr]] [[_X _Y _Z [_R_A_D_I_U_S]] - int[erest] [_X _Y _Z [_R_A_D_I_U_S]]" Set point of interest. This is the + [1mcen[ter] [[4m[22mX[24m [4mY[24m [4mZ[24m [[4mRADIUS[24m]] + int[erest] [[4mX[24m [4mY[24m [4mZ[24m [[4mRADIUS[24m]]" Set point of interest. This is the center of rotation in [o]rbit and [r]otate modes. And, in [o]rbit mode, translation speed is proportional to the viewer's - distance from this point. The optional _R_A_D_I_U_S (also set by + distance from this point. The optional [4mRADIUS[24m (also set by censize) determines the size of the marker crosshair, initially 1 unit. **** why is center/interest commented out in the first example. Originally this command was documented twice, the first one has /interest commented out. - cceennssiizzee [[_R_A_D_I_U_S] + [1mcensize [[4m[22mRADIUS[24m] Set size of point-of-interest marker. - wwhheerree _(_a_l_s_o_) w + [1mwhere [4m[22m(also)[24m w Report the 3-D camera position and forward direction vector. - cclliipp _N_E_A_R _F_A_R + [1mclip [4m[22mNEAR[24m [4mFAR[0m Clipping distances. The computer graphics setup always requires drawing only objects in some finite range of distances in front of the viewpoint. Both values must be strictly positive, and their ratio is limited; depending on the graphics system in use, - distant objects may appear to blink if the _F_A_R/_N_E_A_R ratio + distant objects may appear to blink if the [4mFAR[24m/[4mNEAR[24m ratio exceeds 10000 or so. To set the far clip range without changing the near, use a non- @@ -1075,40 +954,40 @@ - jjuummpp [[_X _Y _Z] [_R_x _R_y _R_z] + [1mjump [[4m[22mX[24m [4mY[24m [4mZ[24m] [[4mRx[24m [4mRy[24m [4mRz[24m] Get or set the current position (XYZ) and/or viewing (RxRyRz) angle. - rreeaaddppaatthh + [1mreadpath[0m Read a Wavefront (.wf) file describing a path through space. - rrddaattaa + [1mrdata[0m Synonym for readpath. - ppllaayy _s_p_e_e_d[f] + [1mplay [4m[22mspeed[24m[f] Play the currently loaded (from readpath/rdata) camera animation - path, at _s_p_e_e_d times normal speed, skipping frames as needed to + path, at [4mspeed[24m 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 _s_p_e_e_d-th frame, + second.) With "f" suffix, displays every [4mspeed[24m-th frame, without regard to real time. - ffrraammee [[_f_r_a_m_e_n_o] - Get or set the current frame the _f_r_a_m_e_n_o-th. + [1mframe [[4m[22mframeno[24m] + Get or set the current frame the [4mframeno[24m-th. - uuppddaattee + [1mupdate[0m Ensures the display is updated, as before taking a snapshot. Probably only useful in a stream of control commands from an async subprocess. - wwiinnssiizzee [[_X_S_I_Z_E [_Y_S_I_Z_E]] + [1mwinsize [[4m[22mXSIZE[24m [[4mYSIZE[24m]] - wwiinnssiizzee _X_S_I_Z_Ex_Y_S_I_Z_E+_X_P_O_S+_Y_P_O_S + [1mwinsize [4m[22mXSIZE[24mx[4mYSIZE[24m+[4mXPOS[24m+[4mYPOS[0m Resize graphics window. With no arguments, reports current size. With one argument, resizes to given width, preserving aspect ratio. With two arguments, reshapes window to that @@ -1118,39 +997,39 @@ and -Y measured from right/bottom of screen. - ddeettaacchh [[ffuullll||hhiiddee]] [[_+_X_P_O_S_+_Y_P_O_S] + [1mdetach [full|hide] [[4m[22m+XPOS+YPOS[24m] Detach graphics window from GUI control strip and optionally specify position of control strip. With full or hide, makes graphics window full-screen with GUI visible or hidden, respectively. With neither full nor hide, the graphics window is detached but left at its current size. - The _+_X_P_O_S_+_Y_P_O_S is a window position in X window geometry style, + The [4m+XPOS+YPOS[24m is a window position in X window geometry style, so e.g. detach full -10+5 places the GUI near the upper right corner of the screen, 10 pixels in from the right and 5 pixels down from the top edge. If you don't mind typing blindly, it's still possible to enter - text-box commands even with the controls hidden; press the _T_a_b + text-box commands even with the controls hidden; press the [4mTab[0m key before each command to ensure that input focus is in the - text box. Use _T_a_bdetach full_E_n_t_e_r to un-hide a hidden control + text box. Use [4mTab[24mdetach full[4mEnter[24m to un-hide a hidden control strip. - bbggccoolloorr _R _G _B + [1mbgcolor [4m[22mR[24m [4mG[24m [4mB[0m Set window background color (three R G B numbers or one grayscale value). - ffooccaalllleenn _d_i_s_t_a_n_c_e + [1mfocallen [4m[22mdistance[0m Focal length: distance from viewer to a typical object of interest. This affects stereo display (see below) and navigation: the speed of motion in [t]ranslate and [f]ly modes is proportional to this distance. - sstteerreeoo [[oonn||ooffff||rreeddccyyaann||ggllaasssseess||ccrroossss||lleefftt||rriigghhtt]] [[_s_e_p_a_r_a_t_i_o_n] + [1mstereo [on|off|redcyan|glasses|cross|left|right] [[4m[22mseparation[24m] Stereo display. Also toggled on/off by typing 's' key in graphics window. Where hardware allows it, stereo glasses selects CrystalEyes-style quad-buffered stereo. All systems @@ -1159,14 +1038,14 @@ splits the window horizontally. left and right show just that eye's view, and may be handy for taking stereo snapshots. - Useful _s_e_p_a_r_a_t_i_o_n values might be 0.02 to 0.1, or -0.02 to -0.1 + Useful [4mseparation[24m values might be 0.02 to 0.1, or -0.02 to -0.1 to swap eyes. See also 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. - Virtual-world eyes will be separated by distance 2 * _f_o_c_a_l_l_e_n _* - _s_e_p_a_r_a_t_i_o_n, with convergence angle 2 * arctan(_s_e_p_a_r_a_t_i_o_n). + Virtual-world eyes will be separated by distance 2 * [4mfocallen[24m [4m*[0m + [4mseparation[24m, with convergence angle 2 * arctan([4mseparation[24m). See also the winsize and detach commands for control over graphics window size and placement. @@ -1181,20 +1060,20 @@ eye's view -- displacing the viewpoint but nothing else. - ssnnaappsseett [[-n _F_R_A_M_E_N_O] _F_I_L_E_S_T_E_M [_F_R_A_M_E_N_O] - Set parameters for future snapshot commands. _F_I_L_E_S_T_E_M may be a + [1msnapset [[22m-n [4mFRAMENO[24m] [4mFILESTEM[24m [[4mFRAMENO[24m] + Set parameters for future snapshot commands. [4mFILESTEM[24m may be a printf format string with frame number as argument, e.g. snapset pix/%04d.ppm, generating image names of pix/0000.ppm, - pix/0001.ppm, etc. If _F_I_L_E_S_T_E_M contains no % sign, then + pix/0001.ppm, etc. If [4mFILESTEM[24m contains no % sign, then .%03d.ppm.gz is appended to it, so snapset ./pix/fred yields snapshot images named ./pix/fred.000.ppm.gz etc. - Frame number _F_R_A_M_E_N_O (default 0) increments with each snapshot + Frame number [4mFRAMENO[24m (default 0) increments with each snapshot taken. - ssnnaappsshhoott [[_F_R_A_M_E_N_O] + [1msnapshot [[4m[22mFRAMENO[24m] Capture a snapshot image of the current view. Use snapset to specify the output image name. Default format is snap.%03d.tif. @@ -1203,30 +1082,29 @@ determines the type of image (jpeg, sgi, bmp, etc.) based on the file suffix. - Convert is not needed if the snapset _F_I_L_E_S_T_E_M ends in .ppm.gz + Convert is not needed if the snapset [4mFILESTEM[24m ends in .ppm.gz (invokes gzip rather than convert) or .ppm (no external program required). - - 44..55.. PPaarrttiiccllee DDiissppllaayy CCoonnttrrooll CCoommmmaannddss + [1m4.5. Particle Display Control Commands[0m These commands affect how particles (in the current group) are displayed. - ppssiizzee _s_c_a_l_e_f_a_c_t_o_r + [1mpsize [4m[22mscalefactor[0m All particle luminosities (as specified by lum command) are - scaled by the product of two factors: a _l_u_m_v_a_r-specific factor + scaled by the product of two factors: a [4mlumvar[24m-specific factor given by slum, and a global factor given by psize. So the - intrinsic brightness of a particle is _v_a_l_u_e_-_s_p_e_c_i_f_i_e_d_-_b_y_-lum * - _s_l_u_m_-_f_o_r_-_c_u_r_r_e_n_t_-_l_u_m_v_a_r * _p_s_i_z_e_-_s_c_a_l_e_f_a_c_t_o_r. + intrinsic brightness of a particle is [4mvalue-specified-by-[24mlum * + [4mslum-for-current-lumvar[24m * [4mpsize-scalefactor[24m. - sslluumm _s_l_u_m_f_a_c_t_o_r + [1mslum [4m[22mslumfactor[0m Data-field specific luminosity scale factor, for current choice - of _l_u_m_v_a_r as given by the lum command. A _s_l_u_m_f_a_c_t_o_r is recorded + of [4mlumvar[24m as given by the lum command. A [4mslumfactor[24m is recorded independently for each data field, so if data fields mass and energy were defined, one might say @@ -1238,72 +1116,71 @@ - - having chosen each variable's _s_l_u_m_f_a_c_t_o_r for useful display, and + having chosen each variable's [4mslumfactor[24m for useful display, and then freely switch between lum mass and lum energy without having to readjust particle brightness each time. - ppttssiizzee _m_i_n_p_i_x_e_l_s _m_a_x_p_i_x_e_l_s - Specifies the range of _a_p_p_a_r_e_n_t sizes of points, in pixels. + [1mptsize [4m[22mminpixels[24m [4mmaxpixels[0m + Specifies the range of [4mapparent[24m sizes of points, in pixels. Typical values might be ptsize 0.1 5. The graphics system may silently impose an upper limit of about 10 pixels. - ppoollyyssiizzee [[oonn||ooffff]] [[aa||ss||rr]] + [1mpolysize [on|off] [a|s|r][0m - ppoollyylluumm + [1mpolylum[0m - ppoollyymmiinnppiixxeellss + [1mpolyminpixels[0m - ppoollyymmiinn _m_i_n_r_a_d_i_u_s [_m_a_x_r_a_d_i_u_s] + [1mpolymin [4m[22mminradius[24m [[4mmaxradius[24m] - ccoolloorr + [1mcolor[0m Specify how particles are colored. Generally, a linear function of some data field of each particle becomes an index into a colormap (see cmap, cment). - ccoolloorr _c_o_l_o_r_v_a_r [_m_i_n_v_a_l _m_a_x_v_a_l] - Use data field _c_o_l_o_r_v_a_r (either a name as set by datavar or a + [1mcolor [4m[22mcolorvar[24m [[4mminval[24m [4mmaxval[24m] + Use data field [4mcolorvar[24m (either a name as set by datavar or a 0-based integer column number) to determine color. Map - _m_i_n_v_a_l to color index 1, and _m_a_x_v_a_l to the next-to-last entry - in the colormap (_N_c_m_a_p_-_2). The 0th and last (_N_c_m_a_p_-_1) + [4mminval[24m to color index 1, and [4mmaxval[24m to the next-to-last entry + in the colormap ([4mNcmap-2[24m). The 0th and last ([4mNcmap-1[24m) colormap entry are used for out-of-range data values. - If _m_i_n_v_a_l and _m_a_x_v_a_l are omitted, the actual range of values + If [4mminval[24m and [4mmaxval[24m are omitted, the actual range of values is used. - ccoolloorr _c_o_l_o_r_v_a_r exact [_b_a_s_e_v_a_l] - Don't consider field _c_o_l_o_r_v_a_r as a continuous variable; + [1mcolor [4m[22mcolorvar[24m exact [[4mbaseval[24m] + Don't consider field [4mcolorvar[24m as a continuous variable; instead, it's integer-valued, and mapped one-to-one with - color table slots. Data value _N is mapped to color index - _N_+_b_a_s_e_v_a_l. + color table slots. Data value [4mN[24m is mapped to color index + [4mN+baseval[24m. - ccoolloorr _c_o_l_o_r_v_a_r -exact + [1mcolor [4m[22mcolorvar[24m -exact Once the exact tag is set (for a particular data-field), it's sticky. To interpret that data field as a continuous, scalable variable again, use -exact. - ccoolloorr ccoonnsstt _R _G _B - Show all particles as color _R _G _B, each value in range 0 to + [1mcolor const [4m[22mR[24m [4mG[24m [4mB[0m + Show all particles as color [4mR[24m [4mG[24m [4mB[24m, each value in range 0 to 1, independent of any data fields. - lluumm + [1mlum[0m Specify how particles' intrinsic luminosity is computed: a linear function of some data field of each particle. - lluumm _l_u_m_v_a_r [_m_i_n_v_a_l _m_a_x_v_a_l] - Map values of data field _l_u_m_v_a_r (datavar name or field + [1mlum [4m[22mlumvar[24m [[4mminval[24m [4mmaxval[24m] + Map values of data field [4mlumvar[24m (datavar name or field number) to luminosity. The (linear) mapping takes field - value _m_i_n_v_a_l to luminosity 0 and _m_a_x_v_a_l to luminosity 1.0. + value [4mminval[24m to luminosity 0 and [4mmaxval[24m to luminosity 1.0. - If _m_i_n_v_a_l and _m_a_x_v_a_l are omitted, the actual range of values + If [4mminval[24m and [4mmaxval[24m are omitted, the actual range of values is mapped to the luminosity range 0 to 1. Note that the resulting luminosities are then scaled by the @@ -1312,91 +1189,91 @@ of points. - lluumm ccoonnsstt _L - Specify constant particle luminosity _L independent of any + [1mlum const [4m[22mL[0m + Specify constant particle luminosity [4mL[24m independent of any data field values. - ffaaddee [[ppllaannaarr||sspphheerriiccaall||lliinneeaarr _r_e_f_d_i_s_t|const _r_e_f_d_i_s_t] + [1mfade [planar|spherical|linear [4m[22mrefdist[24m|const [4mrefdist[24m] Determines how distance affects particles' apparent brightness (or "size"). The default fade planar gives 1/r^2 light falloff, with r measured as distance from the view plane. fade spherical is also 1/r^2, but with r measured as true distance from the - viewpoint. fade linear _r_e_f_d_i_s_t gives 1/r light falloff -- not + viewpoint. fade linear [4mrefdist[24m gives 1/r light falloff -- not physically accurate, but useful to get a limited sense of depth. - fade const _r_e_f_d_i_s_t gives constant apparent brightness + fade const [4mrefdist[24m gives constant apparent brightness independent of distance, and may be appropriate for orthographic views. - The _r_e_f_d_i_s_t for linear and const modes is that distance _r at + The [4mrefdist[24m for linear and const modes is that distance [4mr[24m at which apparent brightness should match that in the 1/r^2 modes -- a distance to a "typical" particle. - llaabbeellmmiinnppiixxeellss + [1mlabelminpixels[0m - llaabbeellssiizzee + [1mlabelsize[0m - llssiizzee + [1mlsize[0m - ppooiinntt[[ss]] [[oonn||ooffff]] + [1mpoint[s] [on|off][0m Turn display of points on or off. With no argument, toggles display. - ppoollyy[[ggoonnss]] [[oonn||ooffff]] + [1mpoly[gons] [on|off][0m Turn display of points on or off. With no argument, toggles display. - tteexxttuurree [[oonn||ooffff]] + [1mtexture [on|off][0m Turn display of textures on or off. With no argument, toggles. - llaabbeell[[ss]] [[oonn||ooffff]] + [1mlabel[s] [on|off][0m Turn display of label text on or off. With no argument, toggles. - ttxxssccaallee _s_c_a_l_e_f_a_c_t_o_r + [1mtxscale [4m[22mscalefactor[0m Scale size of all textures relative to their polygons. A scale factor of 0.5 (default) make the texture square just fill its polygon, if polysides is 4. - ppoollyyoorriivvaarr + [1mpolyorivar[0m Report setting of polyorivar data-command, which see. - tteexxttuurreevvaarr + [1mtexturevar[0m Report setting of texturevar data-command, which see. - llaaxxeess [[oonn||ooffff]] + [1mlaxes [on|off][0m Toggle label axes. When on, and when labels are displayed, shows a - ppoollyyssiiddee((ss)) + [1mpolyside(s)[0m Number of sides a polygon should have. Default 11, for fairly round polygons. For textured polygons, polysides 4 might do as well, and be slightly speedier. - ffaasstt + [1mfast[0m see also ptsize - ppttssiizzee _m_i_n_p_i_x_e_l_s [_m_a_x_p_i_x_e_l_s] + [1mptsize [4m[22mminpixels[24m [[4mmaxpixels[24m] Specifies range of apparent (pixel) size of points. Those with computed sizes (based on luminosity and distance) smaller than - _m_i_n_p_i_x_e_l_s are randomly (but repeatably) subsampled -- i.e. some + [4mminpixels[24m are randomly (but repeatably) subsampled -- i.e. some fraction of them are not drawn. Those computed to be larger - than _m_a_x_p_i_x_e_l_s are drawn at size _m_a_x_p_i_x_e_l_s. + than [4mmaxpixels[24m are drawn at size [4mmaxpixels[24m. - ggaammmmaa _d_i_s_p_l_a_y_g_a_m_m_a + [1mgamma [4m[22mdisplaygamma[0m Tells the particle renderer how the display + OpenGL relates image values to visible lightness. You don't need to change this, but may adjust it to minimize the brightness glitches when @@ -1405,17 +1282,17 @@ things. - aallpphhaa _a_l_p_h_a + [1malpha [4m[22malpha[0m Get or set the alpha value, in the range 0 to 1; it determines the opacity of polygons. - ssppeeeedd + [1mspeed[0m For time-dependent data, advance datatime by this many time units per wall-clock second. - sstteepp [[_t_i_m_e_s_t_e_p] + [1mstep [[4m[22mtimestep[24m] For time-varying data, sets current timestep number. Real- valued times are meaningful for some kinds of data including those from Starlab/kira; for others, times are rounded to @@ -1423,7 +1300,7 @@ animation. (See run.) - sstteepp [[++||--]]_d_e_l_t_a_t_i_m_e_s_t_e_p + [1mstep [+|-][4m[22mdeltatimestep[0m If preceded with a plus or minus sign, adds that amount to current time. @@ -1431,22 +1308,22 @@ (note that fspeed has been deprecated) - rruunn + [1mrun[0m Continue a stopped animation (see also step). - ttffmm [[--vv]] [[_n_u_m_b_e_r_s_._._.] + [1mtfm [-v] [[4m[22mnumbers...[24m] Object-to-world transformation. May take 1, 6, 7, 9 or 16 - parameters: either _s_c_a_l_e_f_a_c_t_o_r, or _t_x _t_y _t_z _r_x _r_y _r_z - _s_c_a_l_e_f_a_c_t_o_r>], or 16 numbers for 4x4 matrix, or 9 numbers for - 3x3 matrix. See _C_o_o_r_d_i_n_a_t_e_s _a_n_d _C_o_o_r_d_i_n_a_t_e _T_r_a_n_s_f_o_r_m_a_t_i_o_n_s. + parameters: either [4mscalefactor[24m, or [4mtx[24m [4mty[24m [4mtz[24m [4mrx[24m [4mry[24m [4mrz[0m + [4mscalefactor[24m>], or 16 numbers for 4x4 matrix, or 9 numbers for + 3x3 matrix. See [4mCoordinates[24m [4mand[24m [4mCoordinate[24m [4mTransformations[24m. With no numeric parameters, reports the current object-to-world transform. Use tfm -v to see the transform and its inverse in several forms. - mmoovvee [[gg_N] {on|off} + [1mmove [g[4m[22mN[24m] {on|off} Normally, navigation modes [r]otate and [t]ranslate just adjust the viewpoint (camera). However, if you turn move on, then [r]otate and [t]ranslate move the currently-selected object @@ -1454,79 +1331,77 @@ groups. ([o]rbit and [f]ly modes always move the camera.) To indicate that move mode is enabled, the control strip shows - the selected group's name in bold italics, as _[_g_3_]. Use move + the selected group's name in bold italics, as [4m[g3][24m. Use move off to revert to normal. The tfm command reports the current object-group-to-global-world transformation. - ffwwdd + [1mfwd[0m - ddaattaawwaaiitt oonn||ooffff + [1mdatawait on|off[0m For asynchronously-loaded data (currently only ieee data command), say whether wait for current data step to be loaded. (If not, then keep displaying previous data while loading new.) - ccmmaapp _f_i_l_e_n_a_m_e + [1mcmap [4m[22mfilename[0m Load (ascii) filename with RGB values, for coloring particles. The color command selects which data field is mapped to color index and how. Colormaps are text files, beginning with a number-of-entries line and followed by R G B or R G B A entries one per line; see - the _C_o_l_o_r_m_a_p_s section. + the [4mColormaps[24m section. - vvccmmaapp --vv _f_i_e_l_d_n_a_m_e _f_i_l_e_n_a_m_e + [1mvcmap -v [4m[22mfieldname[24m [4mfilename[0m Load colormap as with cmap command. But use this colormap only when the given data field is selected for coloring. Thus the cmap color map applies to all data fields for which no vcmap has ever been specified. - ccmmeenntt _c_o_l_o_r_i_n_d_e_x [_R _G _B] + [1mcment [4m[22mcolorindex[24m [[4mR[24m [4mG[24m [4mB[24m] Report or set that colormap entry. - rraawwdduummpp _d_u_m_p_-_f_i_l_e_n_a_m_e + [1mrawdump [4m[22mdump-filename[0m All particle attributes (not positions though) are written to a - _d_u_m_p_-_f_i_l_e_n_a_m_e. Useful for debugging. Warning: it will happily + [4mdump-filename[24m. Useful for debugging. Warning: it will happily overwrite an existing file with that name. + [1m4.6. Particle subsetting & statistics[0m - 44..66.. PPaarrttiiccllee ssuubbsseettttiinngg && ssttaattiissttiiccss - - - cclliippbbooxx ...... + [1mclipbox ...[0m see cb below. - ccbb ........ + [1mcb ....[0m Display only a 3D subregion of the data -- the part lying within the clipbox. - ccbb _x_m_i_n _y_m_i_n _z_m_i_n _x_m_a_x _y_m_a_x _z_m_a_x + [1mcb [4m[22mxmin[24m [4mymin[24m [4mzmin[24m [4mxmax[24m [4mymax[24m [4mzmax[0m Specified by coordinate ranges. Note only spaces are used to separate the 6 numbers. - ccbb _x_c_e_n_,_y_c_e_n_,_z_c_e_n _x_r_a_d_,_y_r_a_d_,_z_r_a_d + [1mcb [4m[22mxcen,ycen,zcen[24m [4mxrad,yrad,zrad[0m Specified by center and "radius" of the box. Note no spaces after the commas! - ccbb _x_m_i_n_,_x_m_a_x _y_m_i_n_,_y_m_a_x _z_m_i_n_,_z_m_a_x + [1mcb [4m[22mxmin,xmax[24m [4mymin,ymax[24m [4mzmin,zmax[0m Specified by coordinate ranges. - ccbb off + [1mcb [22moff Disable clipping. The entire dataset is again visible. - ccbb on + [1mcb [22mon Re-enable a previously defined clipbox setting. It will also display the clipbox again - ccbb hide + [1mcb [22mhide Hide the clipbox, but still discard objects whose centers lie outside it. @@ -1535,36 +1410,36 @@ If no arguments given, it reports the current clipbox. - tthhrreesshh + [1mthresh[0m Display a subset of particles, chosen by the value of some data field. Each thresh command overrides settings from previous commands, so it cannot be used to show unions or intersections of multiple criteria. For that, see the only command. However, unlike only, the thresh criterion applies to time-varying data. - tthhrreesshh _f_i_e_l_d _m_i_n_v_a_l _m_a_x_v_a_l - Display only those particles where _m_i_n_v_a_l <= field _f_i_e_l_d <= - _m_a_x_v_a_l. The _f_i_e_l_d may be given by name (as from datavar) or + [1mthresh [4m[22mfield[24m [4mminval[24m [4mmaxval[0m + Display only those particles where [4mminval[24m <= field [4mfield[24m <= + [4mmaxval[24m. The [4mfield[24m may be given by name (as from datavar) or by field number. - tthhrreesshh _f_i_e_l_d <_m_a_x_v_a_l + [1mthresh [4m[22mfield[24m <[4mmaxval[0m - tthhrreesshh _f_i_e_l_d >_m_i_n_v_a_l - Show only particles where _f_i_e_l_d is <= or >= the given + [1mthresh [4m[22mfield[24m >[4mminval[0m + Show only particles where [4mfield[24m is <= or >= the given threshold. - tthhrreesshh [[ooffff||oonn]] + [1mthresh [off|on][0m Disable or re-enable a previously specified threshold. - oonnllyy== _d_a_t_a_f_i_e_l_d _v_a_l_u_e _m_i_n_v_a_l_u_e_-_m_a_x_v_a_l_u_e <_v_a_l_u_e >_v_a_l_u_e ... + [1monly= [4m[22mdatafield[24m [4mvalue[24m [4mminvalue-maxvalue[24m <[4mvalue[24m >[4mvalue[24m ... - oonnllyy++ _d_a_t_a_f_i_e_l_d _v_a_l_u_e _m_i_n_v_a_l_u_e_-_m_a_x_v_a_l_u_e <_v_a_l_u_e >_v_a_l_u_e ... + [1monly+ [4m[22mdatafield[24m [4mvalue[24m [4mminvalue-maxvalue[24m <[4mvalue[24m >[4mvalue[24m ... - oonnllyy-- _d_a_t_a_f_i_e_l_d _v_a_l_u_e _m_i_n_v_a_l_u_e_-_m_a_x_v_a_l_u_e <_v_a_l_u_e >_v_a_l_u_e ... + [1monly- [4m[22mdatafield[24m [4mvalue[24m [4mminvalue-maxvalue[24m <[4mvalue[24m >[4mvalue[24m ... Scans particles (in the current timestep only!), finding those - where _d_a_t_a_f_i_e_l_d has value _v_a_l_u_e, or has a value in range - _m_i_n_v_a_l_u_e <= value <= _m_a_x_v_a_l_u_e, or whatever. Multiple value- + where [4mdatafield[24m has value [4mvalue[24m, or has a value in range + [4mminvalue[24m <= value <= [4mmaxvalue[24m, or whatever. Multiple value- ranges may be specified to select the union of several sets. The resulting set of particles is assigned to (only=), added to (only+) or subtracted from (only-) the thresh selection-set. @@ -1573,16 +1448,16 @@ The net effect is illustrated by these examples: - oonnllyy== ttyyppee 11--33 55 + [1monly= type 1-3 5[0m Show only particles of type 1, 2, 3 or 5. - oonnllyy-- mmaassss <<22..33 >>33..55 + [1monly- mass <2.3 >3.5[0m After the above command, shows only the subset of type 1/2/3/5 particles AND have mass between 2.3 and 3.5. (Note that to take the intersection of two conditions, you must subtract the complement of the latter one. Maybe some day there'll be an only&. - sseeee selexpr + [1msee [22mselexpr Show just those particles in the selection-set selexpr. Predefined set names are all, none, thresh and pick, and other names may be defined by the sel command. The default is see @@ -1593,34 +1468,34 @@ except the thresh-selected objects, with see -thresh. - sseell selname = selexpr + [1msel [22mselname = selexpr Compute a logical combination of selection-sets and assign them to another such set. The set membership is originally assigned by thresh or only commands. Yeah, I know this doesn't make sense. Need a separate section to document selection-sets. - sseell selexpr + [1msel [22mselexpr Count the number of particles in the selection-set selexpr. - cclleeaarroobbjj + [1mclearobj[0m Erase all particles in this group. Useful for reloading on the fly. - eevveerryy _N - Display a random subset (every _N-th) of all particles. E.g. + [1mevery [4m[22mN[0m + Display a random subset (every [4mN[24m-th) of all particles. E.g. every 1 shows all particles, every 2 shows about half of them. Reports current subsampling factor, and the current total number of particles. - hhiisstt _d_a_t_a_f_i_e_l_d [-n _n_b_u_c_k_e_t_s] [-l] [-c] [-t] [_m_i_n_v_a_l] [_m_a_x_v_a_l] - Generates a (numerical) histogram of values of _d_a_t_a_f_i_e_l_d, which + [1mhist [4m[22mdatafield[24m [-n [4mnbuckets[24m] [-l] [-c] [-t] [[4mminval[24m] [[4mmaxval[24m] + Generates a (numerical) histogram of values of [4mdatafield[24m, which may be a named field (as from datavar) or a field index. - Divides the value range (either _m_i_n_v_a_l.._m_a_x_v_a_l or the actual - range of values for that field) into _n_b_u_c_k_e_t_s equal buckets (11 + Divides the value range (either [4mminval[24m..[4mmaxval[24m or the actual + range of values for that field) into [4mnbuckets[24m equal buckets (11 by default). Uses logarithmically-spaced intervals if -l (so long as the data range doesn't include zero). If a clipbox is defined, use -c to count only particles within it. If a thresh @@ -1628,57 +1503,55 @@ subset. - bboouunndd [[ww]] + [1mbound [w][0m Reports 3D extent of the data. With w, reports it in world coordinates, otherwise in object coordinates. - ddaattaavvaarr + [1mdatavar[0m - ddvv Report names and value ranges (over all particles in current + [1mdv [22mReport names and value ranges (over all particles in current group) of all named data fields. - - 44..77.. BBooxxeess + [1m4.7. Boxes[0m - sshhoowwbbooxx _l_i_s_t _o_f _i_n_t_e_g_e_r _b_o_x _l_e_v_e_l _n_u_m_b_e_r_s_._._. + [1mshowbox [4m[22mlist[24m [4mof[24m [4minteger[24m [4mbox[24m [4mlevel[24m [4mnumbers...[0m - hhiiddeebbooxx _l_i_s_t _o_f _i_n_t_e_g_e_r _b_o_x _l_e_v_e_l _n_u_m_b_e_r_s_._._. + [1mhidebox [4m[22mlist[24m [4mof[24m [4minteger[24m [4mbox[24m [4mlevel[24m [4mnumbers...[0m - bbooxx[[eess]] [[ooffff||oonn||oonnllyy]] + [1mbox[es] [off|on|only][0m Turn box display off or on; or display boxes but hide all particles. - bbooxxccmmaapp _f_i_l_e_n_a_m_e + [1mboxcmap [4m[22mfilename[0m Color boxes using that colormap. Each box's level number (set by -l option of box data-command, default 0) is the color index. - bbooxxccmmeenntt _c_o_l_o_r_i_n_d_e_x [_R _G _B] + [1mboxcment [4m[22mcolorindex[24m [[4mR[24m [4mG[24m [4mB[24m] Get or set the given box-colormap index. E.g. boxcment 0 reports the color of boxes created with no -l specified. - bbooxxllaabbeell [[oonn||ooffff]] + [1mboxlabel [on|off][0m Label boxes by id number (set by -n option of box data-command). - bbooxxaaxxeess [[oonn||ooffff]] + [1mboxaxes [on|off][0m Toggle or set box axes display mode. - bbooxxssccaallee [[ffllooaatt]] [[oonn||ooffff]] + [1mboxscale [float] [on|off][0m - ggoobbooxx _b_o_x_n_u_m_b_e_r + [1mgobox [4m[22mboxnumber[0m - ggoobbooxxssccaallee - - mmeennuu ffmmeennuu + [1mgoboxscale[0m + [1mmenu fmenu[0m @@ -1696,13 +1569,10 @@ + [1mdatascale[0m - - ddaattaassccaallee - - - 44..88.. DDaattaa ccoommmmaannddss + [1m4.8. Data commands[0m (see also partibrains.c::specks_read) @@ -1714,56 +1584,90 @@ - rreeaadd _f_i_l_e + [1mread [4m[22mfile[0m read a speck formatted file. Recursive, commands can nest. (strtok ok??) Note that read is also a Control Command, doing exactly the same thing. - iinncclluuddee _f_i_l_e + [1minclude [4m[22mfile[0m read a speck formatted file. - iieeeeee [[--tt ttiimmee]] _f_i_l_e + [1mieee [-t time] [4m[22mfile[0m read a IEEEIO formatted file, with optional timestep number (0 based). Support for this type of data must be explicitly compiled into the program. - kkiirraa _f_i_l_e + [1mkira [4m[22mfile[0m read a kira formatted file. See the kiractl Control Command to modify the looks of the objects. - sseetteennvv nnaammee vvaalluuee + [1msetenv name value[0m Add (or change) a named variable of the environment variables space of partiview. Enviroment variables, like in the normal unix shell, can be referred to by prepending their name with a - $. _N_o_t_e _t_h_e_r_e _p_r_o_b_a_b_l_y _i_s _n_o_t _a_n _u_n_s_e_t_e_n_v _c_o_m_m_a_n_d. + $. [4mNote[24m [4mthere[24m [4mprobably[24m [4mis[24m [4mnot[24m [4man[24m [4munsetenv[24m [4mcommand[24m. - oobbjjeecctt _g_N_=_A_L_I_A_S + [1mobject [4m[22mgN=ALIAS[0m Defines/Selects a particular group number (N=1,2,3....) to an ALIAS. In command mode you can use gN=ALIAS. Any data following this command will now belong to this group. - oobbjjeecctt _O_b_j_e_c_t_N_a_m_e + [1mobject [4m[22mObjectName[0m Select an existing group. Following data will now belong to this group. - ssddbbvvaarrss _v_a_r + [1msdbvars [4m[22mvar[0m Choose which data fields to extract from binary sdb files (any - of: mMcrogtxyzSn) for subsequent sbd commands. + of: mMcrogtxyzSn) for subsequent sdb commands. - ssddbb [[--tt ttiimmee]] _f_i_l_e + [1msdb [-t time] [4m[22mfile[0m Read an SDB (binary) formatted file, with optional timestep - number (0 based). + number. (Default time is latest datatime, or 0.) + + + [1mpb [-t time] [4m[22mfile[0m + Read a .pb (binary) particle file, with optional timestep + number. (Default time is latest datatime, or 0.) A .pb file + contains (all values 32-bit integer or 32-bit IEEE float): + + 1. magic number, 0xFFFFFF98 (int32) + + 2. byte offset of first particle (int32) + + 3. number of attributes (int32) + + 4. sequence of null-terminated attribute name strings, + attributename0 \0 attributename1 \0 ... + + 5. possibly some pad bytes, enough to reach the specified first- + particle file offset + 6. sequence of particle records, each (number-of-attributes + + 4)*4 bytes long: - bbooxx[[eess]] _._._._. + a. particle-id (int32) + + b. particle X, Y, Z (3 float32's) + + c. particle attributes (number-of-attributes float32's) + + ending at the end of the file (i.e. there's no particle-count + field). + + Either big- or little-endian formats are accepted; the value of + the magic number determines endianness of all values in that + file. + + + [1mbox[es] [4m[22m....[0m Draw a box, using any of the following formats: @@ -1778,12 +1682,12 @@ level determines color. - mesh [-t _t_x_n_o] [-c _c_o_l_o_r_i_n_d_e_x] [-s _s_t_y_l_e] + mesh [-t [4mtxno[24m] [-c [4mcolorindex[24m] [-s [4mstyle[24m] Draw a quadrilateral mesh, optionally colored or textured. - Following the mmeesshh line, provide a line with the mesh + Following the [1mmesh [22mline, provide a line with the mesh dimensions: nu nv - Following this comes the list of _n_u*_n_v mesh vertices, one vertex + Following this comes the list of [4mnu[24m*[4mnv[24m mesh vertices, one vertex (specified by several blank-separated numbers) per line. (Blank lines and comments may be interspersed among them.) Note that the mesh connections are implicit: vertex number i*nu+j is @@ -1795,97 +1699,127 @@ Options: - -t _t_x_n_o - Apply texture number _t_x_n_o to surface. In this case, each + -t [4mtxno[0m + Apply texture number [4mtxno[24m to surface. In this case, each mesh vertex should also include u and v texture coordinates. - -c _c_o_l_o_r_i_n_d_e_x - Color surface with color from integer cmap entry _c_o_l_o_r_i_n_d_e_x. + -c [4mcolorindex[0m + Color surface with color from integer cmap entry [4mcolorindex[24m. - -s _s_t_y_l_e + -s [4mstyle[0m Drawing style: - _s_o_l_i_d + [4msolid[0m filled polygonal surface (default) - _w_i_r_e + [4mwire[0m just edges - _p_o_i_n_t + + [4mpoint[0m just points (one per mesh vertex) - _X_c_e_n _Y_c_e_n _Z_c_e_n ellipsoid _[_o_p_t_i_o_n_s_]_._._. _[_t_r_a_n_s_f_o_r_m_a_t_i_o_n_] + [4mXcen[24m [4mYcen[24m [4mZcen[24m ellipsoid [4m[options]...[24m [4m[transformation][0m Draw an ellipsoid, specified by: Xcen Ycen Zcen Center position in world coordinates - -c _c_o_l_o_r_i_n_d_e_x + -c [4mcolorindex[0m Integer color index (default -1 => white) - -s _s_t_y_l_e + -s [4mstyle[0m Drawing style: - _s_o_l_i_d + [4msolid[0m filled polygonal surface (default) - _p_l_a_n_e + [4mplane[0m 3 ellipses: XY, XZ, YZ planes - _w_i_r_e + [4mwire[0m latitude/longitude ellipses - _p_o_i_n_t + [4mpoint[0m point cloud: one per lat/lon intersection - -r _X_r_a_d_i_u_s[,_Y_r_a_d_i_u_s,_Z_r_a_d_i_u_s] + -r [4mXradius[24m[,[4mYradius[24m,[4mZradius[24m] Radius (for sphere) or semimajor axes (for ellipsoid) - -n _n_l_a_t_[_,_n_l_o_n_] + -n [4mnlat[,nlon][0m Number of latitude and longitude divisions. Relevant even - for _p_l_a_n_e style, where they determine how finely the - polygonal curves approximate circles. Default _n_l_o_n = _n_l_a_t/2 + for [4mplane[24m style, where they determine how finely the + polygonal curves approximate circles. Default [4mnlon[24m = [4mnlat[24m/2 + 1. - _t_r_a_n_s_f_o_r_m_a_t_i_o_n + [4mtransformation[0m Sets the spatial orientation of the ellipsoid. May take any of three forms: - ((nnootthhiinngg)) + [1m(nothing)[0m If absent, the ellipsoid's coordinate axes are the same as the world axes for the group it belongs to. - 99 bbllaannkk--sseeppaarraatteedd nnuummbbeerrss + [1m9 blank-separated numbers[0m A 3x3 transformation matrix T from ellipsoid coordinates to world coordinates, in the sense Pworld = Pellipsoid * T + [Xcen, Ycen, Zcen]. - 1166 bbllaannkk--sseeppaarraatteedd nnuummbbeerrss + [1m16 blank-separated numbers[0m A 4x4 transformation matrix, as above but for the obvious changes. - wwaavveeoobbjj [[--ttiimmee _t_i_m_e_s_t_e_p] [-static] [-texture _n_u_m_b_e_r] [-c - _c_o_l_o_r_i_n_d_e_x] [-s _s_t_y_l_e] _f_i_l_e_._o_b_j + [1mwaveobj [-time [4m[22mtimestep[24m] [-static] [-texture [4mnumber[24m] [-c [4mcol-[0m + [4morindex[24m] [-s [4mstyle[24m] [4mfile.obj[0m Load a Wavefront-style .obj model. Material properties are - ignored; the surface is drawn in white unless -c _c_o_l_o_r_i_n_d_e_x in + ignored; the surface is drawn in white unless -c [4mcolorindex[24m in which case it's drawn using that color-table color. Also if -texture (alias -tx) is supplied, the surface is textured using whatever texture coordinates are supplied in the .obj file. The model is displayed at all times only if marked -static; otherwise it's displayed only at the time given by -time - _t_i_m_e_s_t_e_p or by the most recent _d_a_t_a_t_i_m_e. + [4mtimestep[24m or by the most recent [4mdatatime[24m. + + A subset of the .obj format is accepted: + + [1mv [4m[22mX[24m [4mY[24m [4mZ[0m + -- vertex position + + [1mvt [4m[22mU[24m [4mV[0m + -- vertex texture coordinates + + [1mvn [4m[22mNX[24m [4mNY[24m [4mNZ[0m + -- vertex normal + + [1mf [4m[22mV1[24m [4mV2[24m [4mV3[24m [4m...[0m + -- face, listing just position indices for each vertex. The + first v line in the .obj file has index 1, etc. + [1mf [4m[22mV1/T1[24m [4mV2/T2[24m [4mV3/T3[24m [4m...[0m + -- face, listing position and texture coordinates for each + vertex of the face. + [1mf [4m[22mV1/T1/N1[24m [4mV2/T2/N2[24m [4mV3/T3/N3[24m [4m...[0m + -- face, listing position, texture-coordinate, and normal + indices for each vertex. + Note that material properties (mtl) are ignored. Waveobj models + are colored according to the -c [4mcolorindex[24m option (integer index + into the current cmap colormap), or white if no -c is used. If + texturing is enabled -- if the .obj model contains vt entries, + and the -texture option appears, and that numbered texture + exists -- then the given texture color multiplies or replaces + the -c color, according to the texture options. - ttffmm [[ccaammeerraa]] _n_u_m_b_e_r_s_._._. + + [1mtfm [camera] [4m[22mnumbers...[0m Object-to-world transformation. May take 1, 6, 7, 9 or 16 - numbers: either _s_c_a_l_e_f_a_c_t_o_r or _t_x _t_y _t_z _r_x _r_y _r_z + numbers: either [4mscalefactor[24m or [4mtx[24m [4mty[24m [4mtz[24m [4mrx[24m [4mry[24m [4mrz[0m [it/scalefactor/] or 16 numbers for 4x4 matrix, or 9 numbers for - 3x3 matrix. See _C_o_o_r_d_i_n_a_t_e_s _a_n_d _C_o_o_r_d_i_n_a_t_e _T_r_a_n_s_f_o_r_m_a_t_i_o_n_s. + 3x3 matrix. See [4mCoordinates[24m [4mand[24m [4mCoordinate[24m [4mTransformations[24m. Normally the transform is to world coordinates; but with optional camera prefix, the object's position is specified @@ -1899,32 +1833,32 @@ - - eevvaall _c_o_m_m_a_n_d + [1meval [4m[22mcommand[0m execute a Control Command. - ffeeeedd _c_o_m_m_a_n_d + [1mfeed [4m[22mcommand[0m Synonym for eval. - VVIIRRDDIIRR _c_o_m_m_a_n_d + [1mVIRDIR [4m[22mcommand[0m Synonym for eval. - ffiilleeppaatthh _p_a_t_h + + [1mfilepath [4m[22mpath[0m A colon-separated list of directories in which datafiles, color maps, etc. will be searched for. If preceded with the + symbol, - this list will be appended to the current _f_i_l_e_p_a_t_h. + this list will be appended to the current [4mfilepath[24m. - ppoollyyoorriivvaarr _i_n_d_e_x_n_o + [1mpolyorivar [4m[22mindexno[0m By default, when polygons are drawn, they're parallel to the screen plane -- simple markers for the points. It's sometimes useful to give each polygon a fixed 3-D orientation (as for disk galaxies). To do this, provide 6 consecutive data fields, representing two 3-D orthogonal unit vectors which span the - plane of the disk. Then use polyorivar _i_n_d_e_x_n_o giving the data + plane of the disk. Then use polyorivar [4mindexno[24m giving the data field number of the first of the 6 fields. The vectors define the X and Y directions on the disk, respectively -- relevant if texturing is enabled. @@ -1937,138 +1871,137 @@ those polygons. - tteexxttuurree [[--aaiiAAOOllmmnnMMDDBB]] _t_x_n_o _f_i_l_e_._s_g_i + [1mtexture [-aiAOlmnMDB] [4m[22mtxno[24m [4mfile.sgi[0m - --aa((llpphhaa)) + [1m-a(lpha)[0m A single-channel image would normally be used as luminance data. With -a, the image is taken as opacity data instead (GL_ALPHA texture format). - --ii((nntteennssiittyy)) + [1m-i(ntensity)[0m For 1- or 3-channel images, compute the intensity of each pixel and use it to form an alpha (opacity) channel. - --AA((dddd)) + [1m-A(dd)[0m Use additive blending. This texture will add to, not obscure, the brightness of whatever lies behind it (i.e. whatever is drawn later). - --OO((vveerr)) + [1m-O(ver)[0m Use "over" compositing. This texture will obscure features lying behind it according to alpha values at each point. - --MM((oodduullaattee)) + [1m-M(odulate)[0m Multiply texture brightness/color values by the colormap- determined color of each particle. - --DD((eeccaall)) + [1m-D(ecal)[0m The textured polygon's color is determined entirely by the texture, suppressing any colormapped color. - --BB((lleenndd)) + [1m-B(lend)[0m Probably not very useful. - tteexxttuurreevvaarr _f_i_e_l_d + [1mtexturevar [4m[22mfield[0m If polygon-drawing and texturing are turned on, use the given - _f_i_e_l_d (datavar name or number) in each particle to select which + [4mfield[24m (datavar name or number) in each particle to select which texture (if any) to draw on its polygon. - ccoooorrdd _n_a_m_e _._._. _1_6 _w_o_r_l_d_-_t_o_-_c_o_o_r_d _t_f_m _f_l_o_a_t_s _(_G_L _o_r_d_e_r_) + [1mcoord [4m[22mname[24m [4m...[24m [4m16[24m [4mworld-to-coord[24m [4mtfm[24m [4mfloats[24m [4m(GL[24m [4morder)[0m - ddaattaasseett _i_n_d_e_x_n_o _d_a_t_a_s_e_t_n_a_m_e + [1mdataset [4m[22mindexno[24m [4mdatasetname[0m Give names to multiple datasets in IEEEIO files (read with ieee - command). _i_n_d_e_x_n_o is an integer, 0 being the first dataset. + command). [4mindexno[24m is an integer, 0 being the first dataset. - ddaattaavvaarr _i_n_d_e_x_n_o _n_a_m_e _[_m_i_n_v_a_l _m_a_x_v_a_l_] - Name the variable in data field _i_n_d_e_x_n_o. The first data field - has _i_n_d_e_x_n_o 0. If provided, _m_i_n_v_a_l _m_a_x_v_a_l supply the nominal + [1mdatavar [4m[22mindexno[24m [4mname[24m [4m[minval[24m [4mmaxval][0m + Name the variable in data field [4mindexno[24m. The first data field + has [4mindexno[24m 0. If provided, [4mminval[24m [4mmaxval[24m supply the nominal range of that data variable; some control commands (lum, color) need to know the range of data values, and will use this instead of measuring the actual range. - ddaattaattiimmee _t_i_m_e - Label subsequent data with this _t_i_m_e (a non-negative integer). + [1mdatatime [4m[22mtime[0m + Label subsequent data with this [4mtime[24m (a non-negative integer). - _X_p_o_s _Y_p_o_s _Z_p_o_s _V_a_r_0 _._._._. + [4mXpos[24m [4mYpos[24m [4mZpos[24m [4mVar0[24m [4m....[0m These lines, with XYZ positions in the first 3 columns, will make up the bulk of a typical dataset. The 4th and subsequent columns contain the values of the datavariables as named with - the ddaattaavvaarr commands. Note that data variable (field) numbers + the [1mdatavar [22mcommands. Note that data variable (field) numbers are 0-based. + [1m4.9. Kira/Starlab[0m - 44..99.. KKiirraa//SSttaarrllaabb + To read Kira output, in human-readable or binary [1mtdyn [22mform, use the + ``kira [4mkirafilename[24m'' data-command. - To read Kira output, in human-readable or binary ttddyynn form, use the - ``kira _k_i_r_a_f_i_l_e_n_a_m_e'' data-command. - - 44..99..11.. KKiirraa ppaarrttiiccllee aattttrriibbuutteess + [1m4.9.1. Kira particle attributes[0m The particles read in have the following attributes: - iidd + [1mid[0m positive integer worldline index for single stars (matching the id in the kira stream). For non-leaf (center-of-mass) tree nodes, id is a negative integer. - mmaassss + [1mmass[0m Mass, in solar mass units (see ``kira mscale'' control command). - nncclluummpp + [1mnclump[0m Number of stars in this particle's subtree. 1 for isolated stars, 2 for binaries, etc. - TTlloogg + [1mTlog[0m base-10 log of temperature (K) - LLuumm + [1mLum[0m Luminosity in solar-mass units. (Note this is linear, not log luminosity.) - ssttyyppee + [1mstype[0m Stellar type code (small integer). The [bracketed] message reported when picking (button-2 or p key) on a star gives the corresponding human-readable stellar type too. - iissmmeemmbbeerr + [1mismember[0m Is this star still a member of (bound to) the cluster? - rroooottiidd + [1mrootid[0m id of root of subtree. For single stars, rootid = id. - ttrreeeeaaddddrr + [1mtreeaddr[0m bit-encoded location of star in subtree. - rriinnggssiizzee + [1mringsize[0m 0 for stars. For nonleaf nodes, this is the semimajor axis or instantaneous separation (according to ``kira sep''). This field isn't multiplied by the scale factor given in kira sep; it gives the actual distance in kira units. - ssqqrrttmmaassss + [1msqrtmass[0m Square root of mass/Msun. Might be useful for luminosity scaling. - mmuu + [1mmu[0m Mass ratio for center-of-mass nodes. Zero for stars. - 44..99..22.. HHeerrttzzsspprruunngg--RRuusssseellll ddiiaaggrraamm + [1m4.9.2. Hertzsprung-Russell diagram[0m The H-R diagram can be invoked via the More... menu (upper left) or by the kira hrdiag on control command. Axes for this plot are log @@ -2078,39 +2011,39 @@ Keystroke commands in the H-R window: - bb//BB + [1mb/B[0m Adjust the (b)rightness (dot size) of the dots plotted for each star. Small b brightens (enlarges); capital B shrinks. - aa//AA + [1ma/A[0m Adjust (a)lpha (opacity) of dots plotted for each star. If many stars coincide in H-R, their brightnesses add. Thus reducing opacity may help clarify the relative L-T space densities, if there are many stars. - vv//VV + [1mv/V[0m Zoom out (v) or in (V) by 33%. The point under the cursor becomes the center of the view. - 44..99..33.. kkiirraa ccoonnttrrooll ccoommmmaannddss + [1m4.9.3. kira control commands[0m Viewing control options for kira/Starlab formatted data that have been read in with the kira Data Command. All control commands begin with kira too. - kkiirraa nnooddee {{oonn||ooffff||rroooott}} + [1mkira node {on|off|root}[0m Show or hide center-of-mass nodes for multiple stars. With on, show CM nodes for each level in a binary tree. With root, show only the top-level CM node for each multiple. - kkiirraa rriinngg {{oonn||ooffff||rroooott}} + [1mkira ring {on|off|root}[0m Show circles around multiple stars; on and root as above. - kkiirraa ttrreeee {{oonn||ooffff||ccrroossss||ttiicckk}} [[_t_i_c_k_s_c_a_l_e] + [1mkira tree {on|off|cross|tick} [[4m[22mtickscale[24m] Show lines connecting pairs of stars at each binary-tree level in a multiple group. With cross, also show a perpendicular line -- a tick mark -- which crosses at the CM point, and whose @@ -2119,7 +2052,7 @@ line. - kkiirraa ssiizzee [[sseepp||sseemmii]] [[_r_i_n_g_s_c_a_l_e_f_a_c_t_o_r] + [1mkira size [sep|semi] [[4m[22mringscalefactor[24m] Determines 3-D size of circles when kira ring on. With kira size sep, ring diameter is scalefactor * instanteous separation. With kira size semi, ring radius is scalefactor * a (the @@ -2129,120 +2062,119 @@ Default: kira size semi 1.5. - kkiirraa ssccaallee _r_i_n_g_s_c_a_l_e_f_a_c_t_o_r + [1mkira scale [4m[22mringscalefactor[0m Synonym for kira size above. - kkiirraa ssppaann _m_i_n_p_i_x _m_a_x_p_i_x + [1mkira span [4m[22mminpix[24m [4mmaxpix[0m Sets screen-space (pixel) size limits on rings. They'll never - get smaller than radius _m_i_n_p_i_x nor larger than _m_a_x_p_i_x, + get smaller than radius [4mminpix[24m nor larger than [4mmaxpix[24m, regardless of true 3-D size. Thus even vanishingly tight binaries can always be visibly marked. Default: kira span 2 50. - kkiirraa ttrraacckk _i_d|on|off - As particle _i_d moves through time, move the viewpoint in the + [1mkira track [4m[22mid[24m|on|off + As particle [4mid[24m moves through time, move the viewpoint in the same way, so that (if you don't move the view by navigation) the particle remains fixed in apparent position. kira track off disables tracking, and kira track on re-enables it. Use the p key or mouse button 2 to pick a particle (or CM node if kira - node on) to see its numeric _i_d. Transient center-of-mass nodes + node on) to see its numeric [4mid[24m. Transient center-of-mass nodes (shown if kira node on) can be tracked while they exist. - kkiirraa mmssccaallee _m_a_s_s_s_c_a_l_e_f_a_c_t_o_r[!] + [1mkira mscale [4m[22mmassscalefactor[24m[!] Set/check the mass scale factor. Starlab dynamical mass values are multiplied by this factor for reporting to the user. - Normally _m_a_s_s_s_c_a_l_e_f_a_c_t_o_r should equal the initial cluster mass + Normally [4mmassscalefactor[24m should equal the initial cluster mass in solar-mass units. For some input files, starlab can determine what was specified in the original kira run. If so, - ``kira mscale _n_u_m_b_e_r'' will be ignored unless _n_u_m_b_e_r ends with + ``kira mscale [4mnumber[24m'' will be ignored unless [4mnumber[24m ends with an exclamation point (!). So with no !, the user (or .cf script) provides a default value; use ! to override the original mass scale. - kkiirraa iinntt _s_e_l_d_e_s_t [= _s_e_l_s_r_c] + [1mkira int [4m[22mseldest[24m [= [4mselsrc[24m] Track interactions between particles. As the cluster evolves, - whenever any star matching selection-expression _s_e_l_s_r_c + whenever any star matching selection-expression [4mselsrc[0m encounters (is a member of the same kira tree as) another - particle, then the other particle is added to the _s_e_l_d_e_s_t set. - If _s_e_l_d_e_s_t and _s_e_l_s_r_c are the same (or if ``= _s_e_l_s_r_c'' is + particle, then the other particle is added to the [4mseldest[24m set. + If [4mseldest[24m and [4mselsrc[24m are the same (or if ``= [4mselsrc[24m'' is omitted), then kira int computes the transitive closure of the interaction set. Otherwise, only stars that encounter members - of the initial _s_e_l_s_r_c set become members of the _s_e_l_d_e_s_t set. + of the initial [4mselsrc[24m set become members of the [4mseldest[24m set. Example: - cclliicckk oonn ssoommee ssttaarr + [1mclick on some star[0m The clicked-on star(s) become members of the pick set. - sseell xx == ppiicckk + [1msel x = pick[0m Save a copy in the new set named x. - kkiirraa iinntt xx + [1mkira int x[0m Accumulate encounters in the set x. - eemmpphh xx + [1memph x[0m Increase brightness of members of x. - kkiirraa ttrraaiill xx + [1mkira trail x[0m Extend trails from these set members. - kkiirraa ttrraaiill _s_e_l_e_x_p_r_e_s_s_i_o_n|off - Leave trails behind particles selected by _s_e_l_e_x_p_r_e_s_s_i_o_n (see the + [1mkira trail [4m[22mselexpression[24m|off + Leave trails behind particles selected by [4mselexpression[24m (see the sel command). As (dynamical) time passes, for each display update, one sample point is added to the trail for each selected particle. (If you reverse the direction of time, the trails will fold back on themselves.) Some examples: - kkiirraa ttrraaiill aallll + [1mkira trail all[0m Makes trails grow behind all particles (including CM nodes, if they're displayed) - kkiirraa ttrraaiill ppiicckk + [1mkira trail pick[0m Clicking on a star will make a trail grow behind it. If several stars are within picking range (under the cursor), trails will grow behind each of them. - tthhrreesshh --ss bbiigg mmaassss >> 11..55 + [1mthresh -s big mass > 1.5[0m threshold when masses are larger than 1.5 - kkiirraa ttrraaiill bbiigg + [1mkira trail big[0m These two commands (a) select all stars exceeding 1.5 solar masses and (b) extend trails behind them. - kkiirraa ttrraaiill cclleeaarr + [1mkira trail clear[0m Erase current trails, but let them continue to accumulate as time passes. - kkiirraa mmaaxxttrraaiill _n_s_a_m_p_l_e_s + [1mkira maxtrail [4m[22mnsamples[0m Set how many time-points are kept for each particle's trail, initially 50. - kkiirraa hhrrddiiaagg oonn||ooffff + [1mkira hrdiag on|off[0m toggle to turn HD Diagram on or off. Initially off. - kkiirraa hhrrddiiaagg rraannggee _l_o_g_T_l_e_f_t _l_o_g_T_r_i_g_h_t _l_o_g_L_b_o_t_t_o_m _l_o_g_L_t_o_p + [1mkira hrdiag range [4m[22mlogTleft[24m [4mlogTright[24m [4mlogLbottom[24m [4mlogLtop[0m set limits on the HD Diagram axes. - - 44..1100.. TTeexxttuurreess + [1m4.10. Textures[0m To make polygons be textured: +o Use a series of texture data-commands to provide a table of - textures, each named by a small integer _t_e_x_t_u_r_e_-_i_n_d_e_x; + textures, each named by a small integer [4mtexture-index[24m; - +o Create a data field in each particle whose value is the _t_e_x_t_u_r_e_- - _i_n_d_e_x for that particle's polygon - +o Use data-command texturevar _f_i_e_l_d_n_o to specify which data field + +o Create a data field in each particle whose value is the [4mtexture-[0m + [4mindex[24m for that particle's polygon + +o Use data-command texturevar [4mfieldno[24m to specify which data field that is. +o Use control commands (poly, polylumvar, polysize) to enable drawing @@ -2254,56 +2186,56 @@ It doesn't matter whether the texture-index data field is given a datavar name. - For each particle, if the value of its _t_e_x_t_u_r_e_v_a_r'th field either (a) + For each particle, if the value of its [4mtexturevar[24m'th field either (a) doesn't match the value in some texture command or (b) the file named in that texture command couldn't be read, then its polygon is drawn as if texturing were disabled. - 44..1111.. CCoooorrddiinnaatteess aanndd CCoooorrddiinnaattee TTrraannssffoorrmmaattiioonnss + [1m4.11. Coordinates and Coordinate Transformations[0m - Matrices as for the ttffmm command are intended to be multiplied by an + Matrices as for the [1mtfm [22mcommand are intended to be multiplied by an object-coordinate row vector on the left, so that 4x4 matrices specify a translation in their 13th through 15th entries. Generally they're in the sense of an object-or-camera-to-world transform. - The six- or seven-number transforms (_t_x _t_y _t_z _r_x _r_y _r_z - [it/scalefactor/], as accepted by the ttffmm and jjuummpp commands) are + The six- or seven-number transforms ([4mtx[24m [4mty[24m [4mtz[24m [4mrx[24m [4mry[24m [4mrz[0m + [it/scalefactor/], as accepted by the [1mtfm [22mand [1mjump [22mcommands) are interpreted as - _P_w_o_r_l_d _= _P_o_b_j_e_c_t _* _s_c_a_l_e_f_a_c_t_o_r _* rotY(_r_y) * rotX(_r_x) * rotZ(_r_z) * - translate(_t_x_,_t_y_,_t_z) + [4mPworld[24m [4m=[24m [4mPobject[24m [4m*[24m [4mscalefactor[24m [4m*[24m rotY([4mry[24m) * rotX([4mrx[24m) * rotZ([4mrz[24m) * + translate([4mtx,ty,tz[24m) - 44..1122.. CCoolloorrmmaapp FFiilleess + [1m4.12. Colormap Files[0m Colormap files, as read by the cmap and vcmap commands, are line- oriented text files. Blank lines are ignored, as are # comments. The - first nonblank, non-comment line gives the colormap _s_i_z_e (number of + first nonblank, non-comment line gives the colormap [4msize[24m (number of entries). Later lines may have the form <it/R G B/ giving red, green, and blue, each in the range 0 .. 1. Typically - there will be _s_i_z_e of these lines. However the colormap need not be + there will be [4msize[24m of these lines. However the colormap need not be written sequentially; a line like <it/colorindex/: <it/R G B/ - places that RGB value at that _c_o_l_o_r_i_n_d_e_x, in the range 0 .. _s_i_z_e-1. - Later _R _G _B lines are assigned to _c_o_l_o_r_i_n_d_e_x_+_1, _c_o_l_o_r_i_n_d_e_x_+_2 and so + places that RGB value at that [4mcolorindex[24m, in the range 0 .. [4msize[24m-1. + Later [4mR[24m [4mG[24m [4mB[24m lines are assigned to [4mcolorindex+1[24m, [4mcolorindex+2[24m and so on. Also, <it/colorindex/ := <it/oldcolorindex/ - copies the (previously-assigned) RGB value from _o_l_d_c_o_l_o_r_i_n_d_e_x and - assigns it to _c_o_l_o_r_i_n_d_e_x. + copies the (previously-assigned) RGB value from [4moldcolorindex[24m and + assigns it to [4mcolorindex[24m. - 55.. VViieewwiinngg WWiinnddooww KKeeyybbooaarrdd SShhoorrttccuuttss + [1m5. Viewing Window Keyboard Shortcuts[0m Commands that you can give from within the viewing window are all @@ -2355,25 +2287,18 @@ - - - - 66.. PPaarrttiivviieeww aanndd NNEEMMOO + [1m6. Partiview and NEMO[0m The program snapspecks converts a NEMO snapshot to specks format that can be read in directly by partiview. The default viewing variables - are x,y,z,m, but you can add and changed them by using the ooppttiioonnss== - keyword. In fact, arbitrary _b_o_d_y_t_r_a_n_s expressions can be used for + are x,y,z,m, but you can add and changed them by using the [1moptions=[0m + keyword. In fact, arbitrary [4mbodytrans[24m expressions can be used for output. In the following example a 32-body Plummer sphere is created, which is then given a power-law mass spectrum (with slope -2) between 0.5 and 10 mass units, and animated: - - - - ______________________________________________________________________ % mkplummer - 32 |\ snapmass - - massname='n(m)' masspars=p,-2 massrange=0.5,10 |\ @@ -2395,10 +2320,7 @@ - - - - 77.. TTiippss + [1m7. Tips[0m During animation the trip/back buttons can effectively be used to @@ -2435,7 +2357,6 @@ - the Control Command async movie1, and it will create files snap.000.sgi, snap.001.sgi, .... and already with xv a movie can be shown: @@ -2446,7 +2367,6 @@ - To make animated GIFs, here are some examples with common software, all with a default 0.1 sec delay between frames. Some animation software (e.g. xanim) can change these: @@ -2459,14 +2379,13 @@ - The script will run asynchronously within partiview, so if you then use the mouse to change orientation or zoom, these actions (minus the location of the mouse of course) will be nicely recorded in the snapshots. - 88.. BBuuggss,, FFeeaattuurreess aanndd LLiimmiittaattiioonnss + [1m8. Bugs, Features and Limitations[0m Here is a list of known peculiarities, some of them bugs, others just @@ -2474,7 +2393,7 @@ things I simply have not understood how it works. - 88..11.. LLiimmiittaattiioonnss ww..rr..tt.. VViirrDDiirr:: + [1m8.1. Limitations w.r.t. VirDir:[0m @@ -2485,7 +2404,7 @@ Row Window. - 88..22.. SSoommee nnootteess ffoorr nneewwccoommeerrss ttoo VViirrDDiirr + [1m8.2. Some notes for newcomers to VirDir[0m Although starting virdir is very similar to partiview, @@ -2504,8 +2423,6 @@ - - ______________________________________________________________________ raise @@ -2515,7 +2432,6 @@ - which will put virdir in fly and animation mode. Here are some important modes, make sure you keep the mouse in the @@ -2542,7 +2458,7 @@ - 99.. GGlloossssaarryy + [1m9. Glossary[0m @@ -2558,17 +2474,3 @@ - - - - - - - - - - - - - -