Skip to content
Snippets Groups Projects
partiview.sgml 57.2 KiB
Newer Older
  • Learn to ignore specific revisions
  • teuben's avatar
    teuben committed
    </tag>
    
    Report setting of <tt/polyorivar/ data-command, which see.
    
    teuben's avatar
    teuben committed
    
    <tag>
    
    teuben's avatar
    teuben committed
    </tag>
    
    Report setting of <tt/texturevar/ data-command, which see.
    
    teuben's avatar
    teuben committed
    
    <tag>
    
    teuben's avatar
    teuben committed
    </tag>
    
    Toggle label axes.  When on, and when labels are displayed,
    shows a 
    
    teuben's avatar
    teuben committed
    
    <tag>
    
    teuben's avatar
    teuben committed
    </tag>
    
    Number of sides a polygon should have.  Default 11, for fairly round
    polygons.  For textured polygons, <tt/polysides 4/ might do as well,
    and be slightly speedier.
    
    teuben's avatar
    teuben committed
    
    <tag>
    
    teuben's avatar
    teuben committed
    </tag>
    
    teuben's avatar
    teuben committed
    
    <tag>
    
    ptsize  <it/minpixels/ [<it/maxpixels/]
    
    teuben's avatar
    teuben committed
    </tag>
    
    Specifies range of apparent (pixel) size of points.
    Those with computed sizes (based on luminosity
    and distance) smaller than <it/minpixels/ are
    randomly (but repeatably) subsampled -- i.e. some
    fraction of them are not drawn.  Those computed to be
    larger than <it/maxpixels/ are drawn at size
    <it/maxpixels/.
    
    teuben's avatar
    teuben committed
    
    <tag>
    
    teuben's avatar
    teuben committed
    </tag>
    
    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 <tt/gamma 1/ through <tt/gamma 2.5/ or so.
    Larger values raise the apparent brightness of dim things.
    
    teuben's avatar
    teuben committed
    
    <tag>
    
    teuben's avatar
    teuben committed
    </tag>
    
    Get or set the alpha value, in the range 0 to 1; it determines
    the opacity of polygons.
    
    teuben's avatar
    teuben committed
    
    <tag>
    
    teuben's avatar
    teuben committed
    </tag>
    
    For time-dependent data, advance datatime by this many time units
    per wall-clock second.
    
    teuben's avatar
    teuben committed
    
    <tag>
    
    teuben's avatar
    teuben committed
    </tag>
    
    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, <tt/step/ also stops datatime animation.  (See <tt/run/.)
    
    teuben's avatar
    teuben committed
    
    <tag>
    
    step [+|-]<it/deltatimestep/
    
    teuben's avatar
    teuben committed
    </tag>
    
    If preceded with a plus or minus sign, adds that amount to current time.
    
    
    (note that <tt/fspeed/ has been deprecated)
    
    teuben's avatar
    teuben committed
    
    <tag>
    
    teuben's avatar
    teuben committed
    </tag>
    
    
    <tag>
    
    teuben's avatar
    teuben committed
    
    <tag>
    
    teuben's avatar
    teuben committed
    </tag>
    
    
    teuben's avatar
    teuben committed
    <tag>
    
    teuben's avatar
    teuben committed
    </tag>
    
    For asynchronously-loaded data (currently only <tt/ieee/ data command),
    say whether wait for current data step to be loaded.
    (If not, then keep displaying previous data while loading new.)
    
    teuben's avatar
    teuben committed
    
    <tag>
    
    teuben's avatar
    teuben committed
    </tag>
    
    Load (ascii) filename with RGB values, for coloring particles.
    The <tt/color/ command selects which data field is mapped to color index
    and how.
    
    teuben's avatar
    teuben committed
    
    <tag>
    
    teuben's avatar
    teuben committed
    </tag>
    
    
    teuben's avatar
    teuben committed
    <tag>
    
    teuben's avatar
    teuben committed
    </tag>
    
    <tag>
    
    teuben's avatar
    teuben committed
    </tag>
    
    
    </descrip>
    
    <sect1>Particle subsetting & statistics
    <p>
    <descrip>
    
    
    teuben's avatar
    teuben committed
    <tag>
    
    teuben's avatar
    teuben committed
    </tag>
    
    Display only a 3D subregion of the data -- the part lying within the clipbox.
        <descrip>
        <tag>cb <it/xmin ymin zmin  xmax ymax zmax/ </tag> <p>
    	Specified by coordinate range.
        <tag>cb <it/xcen,ycen,zcen xrad,yrad,zrad/  </tag>
    	Specified by center and "radius" of the box.
    	Note no spaces after the commas!
        <tag>cb <tt/off/ </tag><p>
    	Disable clipping.  The entire dataset is again visible.
        <tag>cb <tt/on/  </tag><p>
    	Re-enable a previously defined clipbox setting.
        </descrip>
    
    teuben's avatar
    teuben committed
    
    <tag>
    
    teuben's avatar
    teuben committed
    </tag>
    
       Display a subset of particles, chosen by the value of
       some data field.  Each <tt/thresh/ command overrides
       settings from previous commands, so it cannot be used to
       show unions or intersections of multiple criteria.
       For that, see the <tt/only/ command.  However, unlike <tt/only/,
       the <tt/thresh/ criterion applies to time-varying data.
       <descrip>
       <tag>thresh <it/field/ <it/minval/ <it/maxval/ </tag>
    	Display only those particles where
    	<it/minval/ &lt;= field <it/field/ &lt;= <it/maxval/.
    	The <it/field/ may be given by name (as from <tt/datavar/)
    	or by field number.
       <tag>thresh <it/field/ <tt/&lt;/<it/maxval/ </tag> <p>
       <tag>thresh <it/field/ <tt/&gt;/<it/minval/ </tag>
    	Show only particles where <it/field/ is &lt;=
    	or &gt;= the given threshold.
       <tag>thresh [off|on]</tag>
    	Disable or re-enable a previously specified threshold.
       </descrip>
    
    teuben's avatar
    teuben committed
    
    <tag>
    
    only[=+-]  <it/fieldname/  <it/value/  <it/minvalue-maxvalue/  &lt;<it/value/ &gt;<it/value/ ...
    
    teuben's avatar
    teuben committed
    </tag>
    
    <tag>
    
    teuben's avatar
    teuben committed
    </tag>
    
    teuben's avatar
    teuben committed
    
    <tag>
    
    teuben's avatar
    teuben committed
    </tag>
    
    Erase all particles in this group.  Useful for reloading on the fly.
    
    teuben's avatar
    teuben committed
    
    <tag>
    
    teuben's avatar
    teuben committed
    </tag>
    
    Display a random subset (every <it/N/-th) of all particles.
    E.g. <tt/every 1/ shows all particles, <tt/every 2/ shows about half of them.
    Reports current subsampling factor, and the current total number of particles.
    
    teuben's avatar
    teuben committed
    
    
    <tag>
    hist <it/datafield/ [-n <it/nbuckets/] [-l] [-c] [-t] [<it/minval/] [<it/maxval/]
    </tag>
    Generates a (numerical) histogram of values of <it/datafield/,
    which may be a named field (as from <tt/datavar/) or a field index.
    Divides the value range (either <it/minval/..<it/maxval/
    or the actual range of values for that field) into <it/nbuckets/ 
    equal buckets (11 by default).  Uses logarithmically-spaced
    intervals if <tt/-l/ (so long as the data range doesn't include zero).
    If a clipbox is defined, use <tt/-c/ to count only
    particles within it.  If a <tt/thresh/ or <tt/only/
    subset is defined, use <tt/-t/ to count only the chosen subset.
    
    teuben's avatar
    teuben committed
    
    <tag>
    
    teuben's avatar
    teuben committed
    </tag>
    
    Reports 3D extent of the data.
    
    teuben's avatar
    teuben committed
    
    <tag>
    
    teuben's avatar
    teuben committed
    </tag>
    
    <tag>
    
    teuben's avatar
    teuben committed
    </tag>
    
    Report names and value ranges (over all particles in current group)
    of all named data fields.
    
    
    teuben's avatar
    teuben committed
    
    
    teuben's avatar
    teuben committed
    <tag>
    
    showbox  <it/list of integer box level numbers.../
    
    teuben's avatar
    teuben committed
    </tag>
    
    <tag>
    
    hidebox  <it/list of integer box level numbers.../
    
    teuben's avatar
    teuben committed
    </tag>
    
    <tag>
    
    teuben's avatar
    teuben committed
    </tag>
    
    Turn box display off or on; or display boxes but hide all particles.
    
    teuben's avatar
    teuben committed
    
    <tag>
    
    teuben's avatar
    teuben committed
    </tag>
    
    Color boxes using that colormap.
    Each box's level number (set by <tt/-l/ option of <tt/box/ data-command,
    default 0) is the color index.
    
    teuben's avatar
    teuben committed
    
    <tag>
    
    boxcment  <it/colorindex/  [<it/R G B/]
    
    teuben's avatar
    teuben committed
    </tag>
    
    Get or set the given box-colormap index.  E.g. <tt/boxcment 0/
    reports the color of boxes created with no <tt/-l/ specified.
    
    Label boxes by id number
    (set by <tt/-n/ option of <tt/box/ data-command).
    
    teuben's avatar
    teuben committed
    
    <tag>
    
    boxaxes [on|off]
    </tag>
    Toggle or set box axes display mode.
    
    <tag>
    boxscale [float] [on|off] 
    </tag>
    
    <tag>
    gobox <it/boxnumber/
    </tag>
    
    <tag>
    goboxscale
    
    teuben's avatar
    teuben committed
    </tag>
    
    <tag>
    menu fmenu
    </tag>
    
    <p>
    
    			BEGIN CAVEMENU
    	pos P1 P2
    	wall P1
    	hid [P1]
    	show [P1]
    	h  [P1]
    	demandfps [P1]
    	font
    	help
    	?
    			END CAVEMENU	
    <p>
    
    <tag>
    datascale
    </tag>
    
    </descrip>
    
    
    <!--------------------------------------------------------------------------- -->
    
    <sect1> <!-- label id="datacommands" --> Data commands </>
    
    teuben's avatar
    teuben committed
    <p>
    
    (see also partibrains.c::specks_read)
    <p>
    
    Lines starting with <tt/#/ will be skipped. The following Data Commands
    
    can be placed in a data file. 
    <p>
    Control Commands can be given, if prefixed with the <tt/eval/ command.
    
    
    teuben's avatar
    teuben committed
    
    <descrip>
    
    <tag> 
    read <it/file/ 
    </tag> 
    
    teuben's avatar
    teuben committed
    read a <tt/speck/ formatted file. Recursive, commands can nest. (strtok ok??)
    
    teuben's avatar
    teuben committed
    
    <tag> 
    include  <it/file/
    </tag>
    read a <tt/speck/ formatted file.
    
    <tag>
    
    teuben's avatar
    teuben committed
    ieee [-t time] <it/file/
    
    teuben's avatar
    teuben committed
    </tag>
    
    teuben's avatar
    teuben committed
    read a IEEEIO formatted file, with optional timestep number (0 based).
    
    Support for this type of data must be explicitly compiled into the program.
    
    teuben's avatar
    teuben committed
    
    
    <tag> 
    kira <it/file/ 
    </tag> 
    read a <tt/kira/ formatted file. See the <tt/kiractl/ Control
    Command to modify the looks of the objects.
    
    
    teuben's avatar
    teuben committed
    <tag>
    
    teuben's avatar
    teuben committed
    </tag>
    
    Defines/Selects a particular group number (N=1,2,3....) to an ALIAS. In
    command mode you can use <tt/gN=ALIAS/. Any data following this command
    will now belong to this group.
    
    teuben's avatar
    teuben committed
    
    <tag>
    
    teuben's avatar
    teuben committed
    </tag>
    
    Select an existing group. Following data will now belong to this group.
    
    teuben's avatar
    teuben committed
    
    <tag>
    sdbvars <it/var/
    </tag>
    
    Choose which data fields to
    extract from binary sdb files (any of: <tt/mMcrogtxyzSn/) for subsequent
    <tt/sbd/ commands.
    
    <tag>
    sdb [-t time] <it/file/
    </tag>
    Read an SDB (binary) formatted file, with optional timestep number (0 based).
    
    teuben's avatar
    teuben committed
    
    <tag>
    box[es] <it/..../
    </tag>
    
    Draw a box, using any of the following formats:
    
    teuben's avatar
    teuben committed
    <p>
        <descrip>
        <tag> <tt/xmin ymin zmin  xmax ymax zmax/ </tag> <p>
        <tag> <tt/xmin,xmax ymin,ymax zmin,zmax/   </tag><p>
        <tag> <tt/xcen,ycen,zcen xrad,yrad,zrad/  </tag><p>
        <tag> <tt/[-t time] [-n boxno] [-l level] xcen,ycen,zcen  xrad,yrad,zrad /  </tag><p>
        </descrip>
    
    teuben's avatar
    teuben committed
    
    
    <tag>
    <tt/mesh/ [<tt/-t/ <it/txno/] [<tt/-c/ <it/cindex/] [<tt/-s/ <it/style/]
    </tag>
    Draw a quadrilateral mesh, optionally colored or textured.
    Following the <bf/mesh/ line, provide a line with the mesh dimensions:
    <verb><it/nu nv/</verb>
    
    Following this comes the list of <it/nu/*<it/nv/ 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 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 <tt/-t/ texture was
    specified, then two more fields give its u and v texture coordinates.
    <p>
    
    Options:
      <descrip>
        <tag> <tt/-t/ <it/txno/ </tag> Apply texture number <it/txno/ to surface.
    	In this case, each mesh vertex should also include
    	u and v texture coordinates.
        <tag> <tt/-c/ <it/colorindex/ </tag> Color surface with color from
    	integer cmap entry <it/colorindex/.
        <tag> <tt/-s/ <it/style/ </tag>
    	Drawing style: <descrip>
    	  <tag> <it/solid/ </tag> filled polygonal surface (default)
    	  <tag> <it/wire/ </tag>  just edges
    	  <tag> <it/point/ </tag> just points (one per mesh vertex)
    	</descrip>
       </descrip>
    
    <tag>
    <it/Xcen Ycen Zcen/ ellipsoid <it/[options]... [transformation]/
    </tag>
    Draw an ellipsoid, specified by:
      <descrip>
      <tag> <tt/Xcen Ycen Zcen/ </tag>  Center position in world coordinates
      <tag> <tt/-c/ <it/colorindex/ </tag> Integer color index (default -1 => white)
      <tag> <tt/-s/ <it/style/ </tag>
    	Drawing style: <descrip>
    	  <tag> <it/solid/ </tag> filled polygonal surface (default)
    	  <tag> <it/plane/ </tag> 3 ellipses: XY, XZ, YZ planes
    	  <tag> <it/wire/ </tag> latitude/longitude ellipses
    	  <tag> <it/point/ </tag> point cloud: one per lat/lon intersection
    	</descrip>
      <tag> <tt/-r/ <it/Xradius/[,<it/Yradius/,<it/Zradius/] </tag>
    	Radius (for sphere) or semimajor axes (for ellipsoid)
      <tag> <tt/-n/ <it/nlat[,nlon]/ </tag>
    	Number of latitude and longitude divisions.
    	Relevant even for <it/plane/ style, where they determine
    	how finely the polygonal curves approximate circles.
    	Default <it/nlon/ = <it/nlat//2 + 1.
      <tag> <it/transformation/ </tag>
    	Sets the spatial orientation of the ellipsoid.
    	May take any of three forms:
    	<descrip>
    	  <tag> (nothing) </tag> If absent, the ellipsoid's
    		coordinate axes are the same as the world axes
    		for the group it belongs to.
    	  <tag> 9 blank-separated numbers </tag>
    		A 3x3 transformation matrix T from ellipsoid coordinates
    		to world coordinates, in the sense
    		Pworld = Pellipsoid * T  +  [Xcen, Ycen, Zcen].
    	  <tag> 16 blank-separated numbers </tag>
    		A 4x4 transformation matrix, as above but for the
    		obvious changes.
    	</descrip>
      </descrip>
    
    
    teuben's avatar
    teuben committed
    <tag>
    annot <it/[-t timestep] string .../
    </tag>
    
    
    teuben's avatar
    teuben committed
    <tag>
    size <it/float/
    </tag>
    
    teuben's avatar
    teuben committed
    
    
    teuben's avatar
    teuben committed
    <tag>
    scale <it/float/
    </tag>
    
    teuben's avatar
    teuben committed
    
    <tag>
    tfm 
    </tag>
    
    Object-to-world transformation. Either 
    <it/tx ty tz rx ry rz/ or 16 numbers for 4x4 matrix.
    
    (<it/something> must contain <tt/* / a e r/)
    
    teuben's avatar
    teuben committed
    
    <tag>
    eval <it/command/
    </tag>
    
    teuben's avatar
    teuben committed
    
    <tag>
    feed  <it/command/
    </tag>
    
    teuben's avatar
    teuben committed
    
    <tag>
    VIRDIR  <it/command/
    </tag>
    
    teuben's avatar
    teuben committed
    
    
    teuben's avatar
    teuben committed
    <tag>
    ignorefirst, ignorepgc
    </tag>
    
    teuben's avatar
    teuben committed
    
    <tag>
    filepath <it/path/
    </tag>
    
    A colon-separated list of directories in which datafiles, color maps, etc.
    
    teuben's avatar
    teuben committed
    will be searched for. If preceded with the <tt/+/ symbol,
    this list will be appended to the current <it/filepath/.
    
    
    <tag>
    polyorivar <it/indexno/
    </tag>
    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
    <tt/polyorivar /<it/indexno/
    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.
    <p>
    Actually, unit vectors aren't essential; making them different lengths
    yields non-circular polygonal disks. 
    <p>
    
    If <tt/polyorivar/ is specified for the group, but some polygons should
    still lie in the screen plane, use values <tt/9 9 9 9 9 9/ for those polygons.
    
    teuben's avatar
    teuben committed
    <tag>
    
    texture [-aiAOlmnMDB] <it/txno file.sgi/ 
    
    teuben's avatar
    teuben committed
    </tag>
        <descrip>
    
        <tag> -a(lpha) </tag>
    	A single-channel image would normally be used as luminance data.
    	With <tt/-a/, the image is taken as opacity data instead
    	(GL_ALPHA texture format).
        <tag> -i(ntensity) </tag>
    	For 1- or 3-channel images, compute the intensity of each pixel
    	and use it to form an alpha (opacity) channel.
        <tag> -A(dd) </tag>
    	Use additive blending.  This texture will add to, not obscure,
    	the brightness of whatever lies behind it (i.e. whatever is drawn later).
        <tag> -O(ver) </tag>
    	Use "over" compositing.  This texture will obscure features lying
    	behind it according to alpha values at each point.
    
    <!--
    
    teuben's avatar
    teuben committed
        <tag> -l(inear)  </tag> <p>
    
    teuben's avatar
    teuben committed
        <tag> -m(ipmap) </tag>  <p>
        <tag> -n(earest) </tag>  <p>
    
     -->
    
        <tag> -M(odulate) </tag>
    	Multiply texture brightness/color values by the colormap-determined
    	color of each particle.
    
    teuben's avatar
    teuben committed
        <tag> -D(ecal) </tag>  <p>
    
    	The textured polygon's color is determined entirely by the texture,
    	suppressing any colormapped color.
    
    teuben's avatar
    teuben committed
        <tag> -B(lend) </tag>  <p>
    
    teuben's avatar
    teuben committed
        </descrip>
    
    <tag>
    
    If polygon-drawing and texturing are turned on, use the given
    <it/field/ (datavar name or number) in each particle to select 
    which texture (if any) to draw on its polygon.
    
    teuben's avatar
    teuben committed
    
    <tag>
    coord <it/name ... 16 world-to-coord tfm floats (GL order)/
    </tag>
    
    <tag>
    dataset <it/indexno datasetname/
    </tag>
    
    Give names to multiple datasets in IEEEIO files (read with <tt/ieee/ command).
    <it/indexno/ is an integer, 0 being the first dataset.
    
    teuben's avatar
    teuben committed
    
    <tag>
    
    datavar <it/indexno name [minval maxval]/
    
    teuben's avatar
    teuben committed
    </tag>
    
    Name the variable in data field <it/indexno/.  The first data field is index 0.
    If provided, <it/minval maxval/ supply the nominal range of that data variable;
    some control commands (<tt/lum/, <tt/color/) need to know the range of data
    values, and will use this instead of measuring the actual range.
    
    teuben's avatar
    teuben committed
    
    <tag>
    
    datatime <it/time/
    
    teuben's avatar
    teuben committed
    </tag>
    
    Label subsequent data with this <it/time/ (a non-negative integer).
    
    teuben's avatar
    teuben committed
    
    <tag>
    
    <it/Xpos Ypos Zpos Var0 .... /
    
    teuben's avatar
    teuben committed
    </tag>
    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 <bf/datavar/ commands. Note that
    
    data variable (field) numbers are 0-based.
    
    teuben's avatar
    teuben committed
    
    </descrip>
    
    
    <!----------------------------------------------------------------------  -->
    
    <sect1> Kira/Starlab </>
    
    To read Kira output, in human-readable or binary <bf/tdyn/ form, use the
    ``<tt/kira/ <it/kirafilename/'' data-command.
    
    <p>
    <sect2> Kira particle attributes </>
    
    The particles read in have the following attributes:
    <descrip>
      <tag> id </>
    	positive integer worldline index for single stars
    		(matching the id in the kira stream).
    	For non-leaf (center-of-mass) tree nodes, <tt/id/ is a
    	negative integer.
      <tag> mass </>
    	Mass, in solar mass units (see ``kira mscale'' control command).
      <tag> nclump </>
    	Number of stars in this particle's subtree.
    	1 for isolated stars, 2 for binaries, etc.
      <tag> Tlog </>
    	base-10 log of temperature (K)
      <tag> Lum  </>
    	Luminosity in solar-mass units.  (Note this is linear, not log luminosity.)
      <tag> stype </>
    	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.
      <tag> rootid </>
    	id of root of subtree.  For single stars, rootid = id.
      <tag> treeaddr </>
    	bit-encoded location of star in subtree.
      <tag> ringsize </>
    	0 for stars.
    	For nonleaf nodes, this is the semimajor axis or instantaneous
    	separation (according to ``<tt/kira sep/'').
    	This field isn't multiplied by the scale factor given in
    	<tt/kira sep/; it gives the actual distance in kira units.
      <tag> sqrtmass </>
    	Square root of mass/Msun.  Might be useful for luminosity scaling.
      <tag> mu </>
    	Mass ratio for center-of-mass nodes.  Zero for stars.
    </descrip>
    <p>
    
    <sect2> Hertzsprung-Russell diagram </>
    The H-R diagram can be invoked via the <tt/More.../ menu (upper left)
    or by the <tt/kira hrdiag on/ 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 <tt/kira hrdiag range/ command or with keystrokes.
    <p>
    Keystroke commands in the H-R window:
    <descrip>
      <tag> b/B </>
    	Adjust the (b)rightness (dot size) of the dots plotted for each star.
    	Small b brightens (enlarges); capital B shrinks.
      <tag> a/A </>
    	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.
      <tag> v/V </>
    	Zoom out (v) or in (V) by 33%.  The point under the cursor
    	becomes the center of the view.
    </descrip>
    
    <sect2> kira control commands </>
    <p>
    Viewing control options for kira/Starlab
    formatted data that have been read in with
    the <tt/kira/ Data Command.
    All control commands begin with <tt/kira/ too.
        <descrip>
        <tag> kira node {on|off|root} </tag>
    	Show or hide center-of-mass nodes for multiple stars.
    	With <tt/on/, show CM nodes for each level in a binary tree.
    	With <tt/root/, show only the top-level CM node for each multiple.
    
        <tag> kira ring {on|off|root} </tag>
    	Show circles around multiple stars; <tt/on/ and <tt/root/ as above.
    
        <tag> kira tree {on|off|cross|tick} [<it/tickscale/]  </tag> <p>
    	Show lines connecting pairs of stars at each binary-tree level
    	in a multiple group.  With <tt/cross/, also show a perpendicular
    	line -- a tick mark -- which crosses at the CM point,
    	and whose length is <tt/tickscale/ (default 0.5) times the
    	true separation of the pair.
    	With <tt/tick/, just show the tick-mark with no connecting line.
    
        <tag> kira size [sep|semi] [<it/ringscalefactor/]  </tag>
    	Determines 3-D size of circles when <tt/kira ring on/.
    	With <tt/kira size sep/, ring diameter is scalefactor * instanteous
    	separation.  With <tt/kira size semi/, ring radius is scalefactor * a
    	(the semimajor axis of the two-body system, or <tt/|a|/ for
    	hyperbolic orbits).  Using <tt/semi/ gives typically more stable-looking
    	rings, though they will pop if they become marginally (un-)bound.
    	Default: <tt/kira size semi 1.5/.
    
        <tag>kira scale <it/ringscalefactor/</tag>
    	Synonym for <tt/kira size/ above.
    
        <tag> kira span <it/minpix/ <it/maxpix/ </tag>
    	Sets screen-space (pixel) size limits on rings.
    	They'll never get smaller than radius <it/minpix/ nor larger than
    	<it/maxpix/, regardless of true 3-D size.  Thus even vanishingly
    	tight binaries can always be visibly marked.
    	Default: <tt/kira span 2 50/.
    
        <tag> kira track <it/id/|on|off </tag>
    	As particle <it/id/ 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.
    	<tt/kira track off/ disables tracking, and <tt/kira track on/
    	re-enables it.
    	Use the <tt/p/ key or mouse button 2 to pick a particle
    	(or CM node if <tt/kira node on/) to see its numeric <it/id/.
    	Transient center-of-mass nodes (shown if <tt/kira node on/)
    	can be tracked while they exist.
    
        <tag> kira mscale <it/massscalefactor/[!] </tag>
    	Set/check the mass scale factor.
    	Starlab dynamical mass values are multiplied by this factor
    	for reporting to the user.  Normally <it/massscalefactor/
    	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 <it/number/''
    	will be ignored unless <it/number/ ends with an exclamation point (!).
    	So with no <tt/!/, the user (or .cf script) provides a default value;
    	use <tt/!/ to override the original mass scale.
    
        <tag> kira int <it/seldest/ [= <it/selsrc/] </tag>
    	Track interactions between particles.
    	As the cluster evolves, whenever any star matching
    	selection-expression <it/selsrc/ encounters (is a member of
    	the same kira tree as) another particle, then the other
    	particle is added to the <it/seldest/ set.  If <it/seldest/
    	and <it/selsrc/ are the same (or if ``= <it/selsrc/'' is omitted),
    	then <tt/kira int/ computes the transitive closure of the
    	interaction set.
    	Otherwise, only stars that encounter members of the initial
    	<it/selsrc/ set become members of the <it/seldest/ set.
    	Example:
    	<descrip>
    	 <tag> click on some star </tag>
    		The clicked-on star(s) become members of the <tt/pick/ set.
    	 <tag> sel x = pick </tag>
    		Save a copy in the new set named <tt/x/.
    	 <tag> kira int x </tag>
    		Accumulate encounters in the set <tt/x/.
    	 <tag> emph x </tag>
    		Increase brightness of members of <tt/x/.
    	 <tag> kira trail x </tag>
    		Extend trails from these set members.
    	</descrip>
    
    
        <tag> kira trail <it/selexpression/|off </tag>
    	Leave trails behind particles selected by <it/selexpression/
    	(see the <tt/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:
    	<descrip>
    	  <tag> kira trail all </tag>
    		Makes trails grow behind all particles
    		(including CM nodes, if they're displayed)
    	  <tag> kira trail pick </tag>
    		Clicking on a star will make a trail grow behind it.
    		If several stars are within picking range,
    		trails will grow behind each of them.
    	  <tag> thresh -s big  mass >1.5 </tag>
    	  <tag> kira trail big </tag>
    		These two commands (a) select all stars exceeding
    		1.5 solar masses and (b) extend trails behind them.
    	</descrip>
    
        <tag> kira trail clear </tag>
    	Erase current trails, but let them continue to accumulate
    	as time passes.
    
        <tag> kira maxtrail <it/nsamples/ </tag>
    	Set how many time-points are kept for each particle's trail,
    	initially 50.
    
        <tag> kira hrdiag on|off </tag>
        <tag> kira hrdiag range <it/logTleft logTright logLbottom logLtop/ </tag>
    	
        </descrip>
    
    
    <!----------------------------------------------------------------------  -->
    <sect1> Textures </>
    <p>
    To make polygons be textured:
      <itemize>
      <item>Use a series of <tt/texture/ data-commands to provide a table
    	of textures, each named by a small integer <it/texture-index/;
      <item>Create a data field in each particle whose value is the
    	<it/texture-index/ for that particle's polygon
      <item>Use data-command <tt/texturevar /<it/fieldno/ to specify which
    	data field that is.
      <item>Use control commands (<tt/poly/, <tt/polylumvar/, <tt/polysize/)
    	to enable drawing polygons and textures,
    	and to give the polygons nonzero size.
      <item>Possibly use control command <tt/polysides/ to specify
    	4-sided polygons -- a bit faster to draw than default 11-gons.
      </itemize>
    It doesn't matter whether the texture-index data field is given a datavar name.
    <p>
    For each particle, if the value of its <it/texturevar/'th field either
    (a) doesn't match the value in some <tt/texture/ command or
    (b) the file named in that <tt/texture/ command couldn't be read,
    then its polygon is drawn as if texturing were disabled.
    
    
    <!----------------------------------------------------------------------  -->
    <sect1> Coordinates and Coordinate Transformations
    <p>
    
    <!----------------------------------------------------------------------  -->
    <sect> Viewing Window Keyboard Shortcuts 
    
    teuben's avatar
    teuben committed
    <p>
    
    Commands that you can give from within the viewing window are all single
    keystroke commands, often combined with moving the mouse.
    
    
    <tscreen><verb>
    
    
    TAB		change focus to command window for Control Commands
    
    S/s		toggle STEREO mode (need blue/red glasses :-)
    
    teuben's avatar
    teuben committed
    		modes:	mono redcyan crosseyed glasses
    
                    See also the 'stereo' View Command
    
    >               single frame forward stepping, in time animation mode
    <               single frame backward stepping, in time animation mode
    
    Button-N            various translation/rotation/zoom, depending on mode (fly/orbit/rot/tran)
    
    SHIFT + Button-N    modifier to the usual Button-N action, to have more fine control
    
    CTRL + Button-N     modifier to orbit-mode, e.g. to do translations instead of rotations 
    
    teuben's avatar
    teuben committed
    
    playmodes:
    	s	playnow
    	l	loop (rock)
    	f,e	playevery=1
    	r,t	playevery=0
    
    Gview.cpp : Fl_Gview::handle()
    
    slevy's avatar
    slevy committed
    	p       identify nearest object under mouse cursor
    	P	pick that object as the new origin
    
    teuben's avatar
    teuben committed
    	f	FLY mode
    
    teuben's avatar
    teuben committed
    	t	TRANSLATE mode
    	O	toggle perspective mode
    	v	make field of view larger
    	V	make field of view smaller
    	^v	toggle debug output
    
    	@	report viewpoint position
    
    slevy's avatar
    slevy committed
    	=	show object-to-world, world-to-object 4x4 matrices
    		  (precede by object name, e.g. "c=", "g3=")
    
    teuben's avatar
    teuben committed
    	ESC	exit
    
    
    slevy's avatar
    slevy committed
    	PrintScreen  Take image snapshot of current view
    	<  >	Step backwards/forwards in dynamical time
    		   (numeric prefix sets time step)
    	{  }	Animate backwards/forwards in dynamical time
    	~	Fermionic dynamical-time animation toggle:
    		   cycle between stop/forward/stop/backward/...
    	z  Z    Halve/double animation speed (dyn units/sec)
    		   (numeric prefix sets animation speed)
    
    
    teuben's avatar
    teuben committed
    
    </verb></tscreen>
    
    
    <!--------------------------------------------------------------------------- -->
    
    teuben's avatar
    teuben committed
    <sect> Partiview and NEMO
    <p>
    The program <tt/snapspecks/  converts a NEMO snapshot to specks format
    that can be read in directly by partiview. The default viewing variables
    are <tt/x,y,z,m/, but those can be changed by using the <bf/options=/
    keyword. In fact, arbitrary <it/bodytrans/ expressions can be used
    to output.
    
    
    <tscreen><code>
      % mkplummer - 32 |\
            snapmass - - massname='n(m)' masspars=p,-2 massrange=0.5,10 |\
            hackcode1 - run1.dat
      % snapspecks run1.dat > run1.tab
      % partiview run1.cf
      % cat run1.cf
    
      read junk.tab
      eval labels off
      eval lum lum 0 1
      eval polylumvar point-size .1 area
      texturevar 4
      eval psize 5000
      eval slum 5
      eval every 1
           
    </code></tscreen>
    
    
    
    <!--------------------------------------------------------------------------- -->
    <sect> Tips
    <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.
    
    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.
    
    teuben's avatar
    teuben committed
    
    
    <!--------------------------------------------------------------------------- -->
    
    teuben's avatar
    teuben committed
    <sect> Bugs, Features and Limitations
    <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.
    
    teuben's avatar
    teuben committed
    <enum>
    
    item in rotate mode, if you change the center of rotation with 'P',
    
    Button-1 works fine, but Button-3 does not rotate around the
    
    teuben's avatar
    teuben committed
    new point correctly. It seems to remember the old (or 0,0,0)
    origin.
    
    No, this isn't true; not sure what you were seeing.  It does
    rotate about the center point with both button-1 and button-3.
    In Orbit mode, button-3 translation still translates straight
    forward; i.e. not toward the center point.  Maybe that's what you mean?
    -slevy.
    
    teuben's avatar
    teuben committed
    </enum>
    
    teuben's avatar
    teuben committed
    
    
    <!--------------------------------------------------------------------------- -->
    
    teuben's avatar
    teuben committed
    <sect1> Limitations w.r.t. VirDir:
    <p>
    
    <enum>
    <item>
    cannot set an auto-motion, as we can in the dome, although one could
    of course load a path and move through the dataset :-)
    I was able to make a path (*.wf) file and load that though.
    
    </enum>
    
    
    teuben's avatar
    teuben committed
    </article>