Editing Guide to madagascar programs (section)

=Plotting programs (stable)=
The source files for these programs can be found under
[http://rsf.svn.sourceforge.net/viewvc/rsf/trunk/plot/main/ plot/main]
in the Madagascar distribution.

==sfbox==
{| class="wikitable" align="center" cellspacing="0" border="1"
! colspan="4" style="background:#ffdead;" | Draw a balloon-style label.
|-
! colspan="4" | sfbox lab_color=VP_WHITE lab_fat=0 pscale=1. pointer=y reverse=n lat=0. long=90. angle=0. x0=0. y0=0. scale0=1. xt=2. yt=0. x_oval=0. y_oval=0. boxit=y length= scalet= size=.25 label= > out.vpl
|-
| ''float  '' || '''angle=0.''' ||   || 	longitude of floating label in 3-D
|-
| ''bool   '' || '''boxit=y''' ||  [y/n] || 	if y, create a box around text
|-
| ''int    '' || '''lab_color=VP_WHITE''' ||   || 	label color
|-
| ''int    '' || '''lab_fat=0''' ||   || 	label fatness
|-
| ''string '' || '''label=''' ||   || 	text for label
|-
| ''float  '' || '''lat=0.''' ||   || 
|-
| ''float  '' || '''length=''' ||   || 	normalization for xt and yt
|-
| ''float  '' || '''long=90.''' ||   || 	latitude and longitude of viewpoint in 3-D
|-
| ''bool   '' || '''pointer=y''' ||  [y/n] || 	if y, create arrow pointer
|-
| ''float  '' || '''pscale=1.''' ||   || 	scale factor for width of pointer
|-
| ''bool   '' || '''reverse=n''' ||  [y/n] || 
|-
| ''float  '' || '''scale0=1.''' ||   || 	scale factor for x0 and y0
|-
| ''float  '' || '''scalet=''' ||   || 
|-
| ''float  '' || '''size=.25''' ||   || 	text height in inches
|-
| ''float  '' || '''x0=0.''' ||   || 
|-
| ''float  '' || '''x_oval=0.''' ||   || 
|-
| ''float  '' || '''xt=2.''' ||   || 
|-
| ''float  '' || '''y0=0.''' ||   || 	position of the pointer tip
|-
| ''float  '' || '''y_oval=0.''' ||   || 	size of the oval around pointer
|-
| ''float  '' || '''yt=0.''' ||   || 	relative position of text
|}
==sfcontour==
{| class="wikitable" align="center" cellspacing="0" border="1"
! colspan="4" style="background:#ffdead;" | Contour plot.
|-
! colspan="4" | sfcontour < in.rsf c= min1=o1 min2=o2 max1=o1+(n1-1)*d1 max2=o2+(n2-1)*d2 nc=50 dc= c0= transp=y minval= maxval= allpos=y barlabel= > plot.vpl
|-
|  colspan="4" | Run "sfdoc stdplot" for more parameters.
|-
| ''bool   '' || '''allpos=y''' ||  [y/n] || 	contour positive values only
|-
| ''string '' || '''barlabel=''' ||   || 
|-
| ''floats '' || '''c=''' ||   || 	 [nc]
|-
| ''float  '' || '''c0=''' ||   || 	first contour
|-
| ''float  '' || '''dc=''' ||   || 	contour increment
|-
| ''float  '' || '''max1=o1+(n1-1)*d1''' ||   || 
|-
| ''float  '' || '''max2=o2+(n2-1)*d2''' ||   || 	data window to plot
|-
| ''float  '' || '''maxval=''' ||   || 	maximum value for scalebar (default is the data maximum)
|-
| ''float  '' || '''min1=o1''' ||   || 
|-
| ''float  '' || '''min2=o2''' ||   || 
|-
| ''float  '' || '''minval=''' ||   || 	minimum value for scalebar (default is the data minimum)
|-
| ''int    '' || '''nc=50''' ||   || 	number of contours
|-
| ''bool   '' || '''transp=y''' ||  [y/n] || 	if y, transpose the axes
|}
==sfdots==
{| class="wikitable" align="center" cellspacing="0" border="1"
! colspan="4" style="background:#ffdead;" | Plot signal with lollipops.
|-
! colspan="4" | sfdots < in.rsf labels= dots=(n1 <= 130)? 1: 0 seemean=(bool) (n2 <= 30) strings=(bool) (n1 <= 400) connect=1 corners= silk=n gaineach=y labelsz=8 yreverse=n constsep=n seedead=n transp=n xxscale=1. yyscale=1. clip=-1. overlap=0.9 screenratio=VP_SCREEN_RATIO screenht=VP_STANDARD_HEIGHT screenwd=screenhigh / screenratio radius=dd1/3 label1= unit1= title= > plot.vpl
|-
| ''float  '' || '''clip=-1.''' ||   || 	data clip
|-
| ''int    '' || '''connect=1''' ||   || 	connection type: 1 - diagonal, 2 - bar, 4 - only for non-zero data
|-
| ''bool   '' || '''constsep=n''' ||  [y/n] || 	if y, use constant trace separation
|-
| ''int    '' || '''corners=''' ||   || 	number of polygon corners (default is 6)
|-
| ''int    '' || '''dots=(n1 <= 130)? 1: 0''' ||   || 	type of dots: 1 - baloon, 0 - no dots, 2 - only for non-zero data
|-
| ''bool   '' || '''gaineach=y''' ||  [y/n] || 	if y, gain each trace independently
|-
| ''string '' || '''label1=''' ||   || 
|-
| ''strings'' || '''labels=''' ||   || 	trace labels  [n2]
|-
| ''int    '' || '''labelsz=8''' ||   || 	label size
|-
| ''float  '' || '''overlap=0.9''' ||   || 	trace overlap
|-
| ''float  '' || '''radius=dd1/3''' ||   || 	dot radius
|-
| ''float  '' || '''screenht=VP_STANDARD_HEIGHT''' ||   || 	screen height
|-
| ''float  '' || '''screenratio=VP_SCREEN_RATIO''' ||   || 	screen aspect ratio
|-
| ''float  '' || '''screenwd=screenhigh / screenratio''' ||   || 	screen width
|-
| ''bool   '' || '''seedead=n''' ||  [y/n] || 	if y, show zero traces
|-
| ''bool   '' || '''seemean=(bool) (n2 <= 30)''' ||  [y/n] || 	if y, draw axis lines
|-
| ''bool   '' || '''silk=n''' ||  [y/n] || 	if y, silky plot
|-
| ''bool   '' || '''strings=(bool) (n1 <= 400)''' ||  [y/n] || 	if y, draw strings
|-
| ''string '' || '''title=''' ||   || 
|-
| ''bool   '' || '''transp=n''' ||  [y/n] || 	if y, transpose the axis
|-
| ''string '' || '''unit1=''' ||   || 
|-
| ''float  '' || '''xxscale=1.''' ||   || 	x scaling
|-
| ''bool   '' || '''yreverse=n''' ||  [y/n] || 	if y, reverse y axis
|-
| ''float  '' || '''yyscale=1.''' ||   || 	y scaling
|}
==sfgraph3==
{| class="wikitable" align="center" cellspacing="0" border="1"
! colspan="4" style="background:#ffdead;" | Generate 3-D cube plot for surfaces.
|-
! colspan="4" | sfgraph3 < in.rsf orient=1 min= max= point1=0.5 point2=0.5 frame1=0.5*(min+max) frame2=n1-1 frame3=0 movie=0 dframe=1 n1pix=n1/point1+n3/(1.-point1) n2pix=n2/point2+n3/(1.-point2) flat=y > plot.vpl
|-
| ''float  '' || '''dframe=1''' ||   || 	frame increment in a movie
|-
| ''bool   '' || '''flat=y''' ||  [y/n] || 	if n, display perspective view
|-
| ''float  '' || '''frame1=0.5*(min+max)''' ||   || 
|-
| ''int    '' || '''frame2=n1-1''' ||   || 
|-
| ''int    '' || '''frame3=0''' ||   || 	frame numbers for cube faces
|-
| ''float  '' || '''max=''' ||   || 	maximum function value
|-
| ''float  '' || '''min=''' ||   || 	minimum function value
|-
| ''int    '' || '''movie=0''' ||   || 	0: no movie, 1: movie over axis 1, 2: axis 2, 3: axis 3
|-
| ''int    '' || '''n1pix=n1/point1+n3/(1.-point1)''' ||   || 	number of vertical pixels
|-
| ''int    '' || '''n2pix=n2/point2+n3/(1.-point2)''' ||   || 	number of horizontal pixels
|-
| ''int    '' || '''orient=1''' ||   || 	function orientation
|-
| ''float  '' || '''point1=0.5''' ||   || 	fraction of the vertical axis for front face
|-
| ''float  '' || '''point2=0.5''' ||   || 	fraction of the horizontal axis for front face
|}
==sfgraph==
{| class="wikitable" align="center" cellspacing="0" border="1"
! colspan="4" style="background:#ffdead;" | Graph plot.
|-
! colspan="4" | sfgraph < in.rsf symbolsz= pclip=100. transp=n symbol= > plot.vpl
|-
|  colspan="4" | Run "sfdoc stdplot" for more parameters.
|-
| ''float  '' || '''pclip=100.''' ||   || 	clip percentile
|-
| ''string '' || '''symbol=''' ||   || 	if set, plot with symbols instead of lines
|-
| ''floats '' || '''symbolsz=''' ||   || 	symbol size (default is 2)  [n2]
|-
| ''bool   '' || '''transp=n''' ||  [y/n] || 	if y, transpose the axes
|}
==sfgrey3==
{| class="wikitable" align="center" cellspacing="0" border="1"
! colspan="4" style="background:#ffdead;" | Generate 3-D cube plot.
|-
! colspan="4" | sfgrey3 < in.rsf point1=0.5 point2=0.5 frame1=0 frame2=n2-1 frame3=0 movie=0 dframe=1 n1pix=n1/point1+n3/(1.-point1) n2pix=n2/point2+n3/(1.-point2) flat=y scalebar=n minval= maxval= barreverse=n nreserve=8 bar= color= > plot.vpl
|-
|  colspan="4" | Requires an "unsigned char" input (the output of sfbyte).
|-
| ''string '' || '''bar=''' ||   || 	file for scalebar data
|-
| ''bool   '' || '''barreverse=n''' ||  [y/n] || 	if y, go from small to large on the bar scale
|-
| ''string '' || '''color=''' ||   || 	color scheme (default is i)
|-
| ''int    '' || '''dframe=1''' ||   || 	frame increment in a movie
|-
| ''bool   '' || '''flat=y''' ||  [y/n] || 	if n, display perspective view
|-
| ''int    '' || '''frame1=0''' ||   || 
|-
| ''int    '' || '''frame2=n2-1''' ||   || 
|-
| ''int    '' || '''frame3=0''' ||   || 	frame numbers for cube faces
|-
| ''float  '' || '''maxval=''' ||   || 	maximum value for scalebar (default is the data maximum)
|-
| ''float  '' || '''minval=''' ||   || 	minimum value for scalebar (default is the data minimum)
|-
| ''int    '' || '''movie=0''' ||   || 	0: no movie, 1: movie over axis 1, 2: axis 2, 3: axis 3
|-
| ''int    '' || '''n1pix=n1/point1+n3/(1.-point1)''' ||   || 	number of vertical pixels
|-
| ''int    '' || '''n2pix=n2/point2+n3/(1.-point2)''' ||   || 	number of horizontal pixels
|-
| ''int    '' || '''nreserve=8''' ||   || 	reserved colors
|-
| ''float  '' || '''point1=0.5''' ||   || 	fraction of the vertical axis for front face
|-
| ''float  '' || '''point2=0.5''' ||   || 	fraction of the horizontal axis for front face
|-
| ''bool   '' || '''scalebar=n''' ||  [y/n] || 	if y, draw scalebar
|}

Different [https://ahay.org/blog/2005/03/28/color-schemes/ color schemes] are available
for sfgrey and sfgrey3. Examples are in the book at [https://ahay.org/RSF/book/rsf/rsf/sfgrey.html rsf/rsf/sfgrey].

==sfgrey==
{| class="wikitable" align="center" cellspacing="0" border="1"
! colspan="4" style="background:#ffdead;" | Generate raster plot.
|-
! colspan="4" | sfgrey < in.rsf > out.rsf bar=bar.rsf transp=y yreverse=y xreverse=n gpow= phalf= clip= pclip= gainstep=0.5+n1/256. allpos=n bias=0. polarity=n verb=n scalebar=n minval= maxval= barreverse=n wantframenum=(bool) (n3 > 1) nreserve=8 gainpanel= bar= color= > (plot.vpl | char.rsf)
|-
|  colspan="4" | Can input char values.<br>If called "byte", outputs char values.<br><br>Run "sfdoc stdplot" for more parameters.
|-
| ''bool   '' || '''allpos=n''' ||  [y/n] || 	if y, assume positive data
|-
| ''string '' || '''bar=''' ||   || 	file for scalebar data
|-
| ''bool   '' || '''barreverse=n''' ||  [y/n] || 	if y, go from small to large on the bar scale
|-
| ''float  '' || '''bias=0.''' ||   || 	subtract bias from data
|-
| ''float  '' || '''clip=''' ||   || 
|-
| ''string '' || '''color=''' ||   || 	color scheme (default is i)
|-
| ''string '' || '''gainpanel=''' ||   || 	gain reference: 'a' for all, 'e' for each, or number
|-
| ''int    '' || '''gainstep=0.5+n1/256.''' ||   || 	subsampling for gpow and clip estimation
|-
| ''float  '' || '''gpow=''' ||   || 
|-
| ''float  '' || '''maxval=''' ||   || 	maximum value for scalebar (default is the data maximum)
|-
| ''float  '' || '''minval=''' ||   || 	minimum value for scalebar (default is the data minimum)
|-
| ''int    '' || '''nreserve=8''' ||   || 	reserved colors
|-
| ''float  '' || '''pclip=''' ||   || 	data clip percentile (default is 99)
|-
| ''float  '' || '''phalf=''' ||   || 	percentage for estimating gpow
|-
| ''bool   '' || '''polarity=n''' ||  [y/n] || 	if y, reverse polarity (white is high by default)
|-
| ''bool   '' || '''scalebar=n''' ||  [y/n] || 
|-
| ''bool   '' || '''transp=y''' ||  [y/n] || 	if y, transpose the display axes
|-
| ''bool   '' || '''verb=n''' ||  [y/n] || 	verbosity flag
|-
| ''bool   '' || '''wantframenum=(bool) (n3 > 1)''' ||  [y/n] || 	if y, display third axis position in the corner
|-
| ''bool   '' || '''xreverse=n''' ||  [y/n] || 	if y, reverse the horizontal axis
|-
| ''bool   '' || '''yreverse=y''' ||  [y/n] || 	if y, reverse the vertical axis
|}

Different [https://ahay.org/blog/2005/03/28/color-schemes/ color schemes] are available, and examples are in the book at [https://ahay.org/RSF/book/rsf/rsf/sfgrey.html rsf/rsf/sfgrey].

==sfplas==
{| class="wikitable" align="center" cellspacing="0" border="1"
! colspan="4" style="background:#ffdead;" | Plot Assembler - convert ascii to vplot. 
|-
! colspan="4" | sfplas
|}
==sfpldb==
{| class="wikitable" align="center" cellspacing="0" border="1"
! colspan="4" style="background:#ffdead;" | Plot Debugger - convert vplot to ascii. 
|-
! colspan="4" | sfpldb
|}
==sfplotrays==
{| class="wikitable" align="center" cellspacing="0" border="1"
! colspan="4" style="background:#ffdead;" | Plot rays.
|-
! colspan="4" | sfplotrays frame=frame.rsf nt=n1*n2 jr=1 frame= < rays.rsf > plot.vpl
|-
|  colspan="4" | Run "sfdoc stdplot" for more parameters.
|-
| ''string '' || '''frame=''' ||   || 
|-
| ''int    '' || '''jr=1''' ||   || 	skip rays
|-
| ''int    '' || '''nt=n1*n2''' ||   || 	maximum ray length
|}
==sfthplot==
{| class="wikitable" align="center" cellspacing="0" border="1"
! colspan="4" style="background:#ffdead;" | Hidden-line surface plot.
|-
! colspan="4" | sfthplot < in.rsf uflag=y dflag=y alpha=45. titlsz=9 axissz=6 plotfat=0 titlefat=2 axisfat=2 plotcolup=VP_YELLOW plotcoldn=VP_RED axis=y axis1=y axis2=y axis3=y clip=0. pclip=100. gainstep=0.5+nx/256. bias=0. dclip=1. norm=y xc=1.5 zc=3 ratio=5. zmax= zmin= sz=6. label#= unit#= tpow=0 epow=0 gpow=1 title= > plot.vpl
|-
| ''float  '' || '''alpha=45.''' ||   || 	apparent angle in degrees, |alpha| < 89
|-
| ''bool   '' || '''axis=y''' ||  [y/n] || 
|-
| ''bool   '' || '''axis1=y''' ||  [y/n] || 
|-
| ''bool   '' || '''axis2=y''' ||  [y/n] || 
|-
| ''bool   '' || '''axis3=y''' ||  [y/n] || 	plot axis
|-
| ''int    '' || '''axisfat=2''' ||   || 	axes fatness
|-
| ''int    '' || '''axissz=6''' ||   || 	axes size
|-
| ''float  '' || '''bias=0.''' ||   || 	subtract bias from data
|-
| ''float  '' || '''clip=0.''' ||   || 	data clip
|-
| ''float  '' || '''dclip=1.''' ||   || 	change the clip: clip *= dclip
|-
| ''bool   '' || '''dflag=y''' ||  [y/n] || 	if y, plot down side of the surface
|-
| ''float  '' || '''epow=0''' ||   || 	exponential gain
|-
| ''int    '' || '''gainstep=0.5+nx/256.''' ||   || 	subsampling for gpow and clip estimation
|-
| ''float  '' || '''gpow=1''' ||   || 	power gain
|-
| ''string '' || '''label#=''' ||   || 	label on #-th axis
|-
| ''bool   '' || '''norm=y''' ||  [y/n] || 	normalize by the clip
|-
| ''float  '' || '''pclip=100.''' ||   || 	data clip percentile
|-
| ''int    '' || '''plotcoldn=VP_RED''' ||   || 	color of the lower side
|-
| ''int    '' || '''plotcolup=VP_YELLOW''' ||   || 	color of the upper side
|-
| ''int    '' || '''plotfat=0''' ||   || 	line fatness
|-
| ''float  '' || '''ratio=5.''' ||   || 	plot adjustment
|-
| ''float  '' || '''sz=6.''' ||   || 	vertical scale
|-
| ''string '' || '''title=''' ||   || 
|-
| ''int    '' || '''titlefat=2''' ||   || 	title fatness
|-
| ''int    '' || '''titlsz=9''' ||   || 	title size
|-
| ''string '' || '''tpow=0''' ||   || 	time power gain
|-
| ''bool   '' || '''uflag=y''' ||  [y/n] || 	if y, plot upper side of the surface
|-
| ''string '' || '''unit#=''' ||   || 	unit on #-th axis
|-
| ''float  '' || '''xc=1.5''' ||   || 
|-
| ''float  '' || '''zc=3''' ||   || 	lower left corner of the plot
|-
| ''float  '' || '''zmax=''' ||   || 
|-
| ''float  '' || '''zmin=''' ||   || 
|}
==sfwiggle==
{| class="wikitable" align="center" cellspacing="0" border="1"
! colspan="4" style="background:#ffdead;" | Plot data with wiggly traces. 
|-
! colspan="4" | sfwiggle < in.rsf xpos=xpos.rsf xmax= xmin= poly=n fatp=1 xmask=1 ymask=1 pclip=98. zplot=0.75 clip=0. seemean=n verb=n transp=n yreverse=n xreverse=n xpos= > plot.vpl
|-
|  colspan="4" | Run "sfdoc stdplot" for more parameters.
|-
| ''float  '' || '''clip=0.''' ||   || 	data clip (estimated from pclip by default
|-
| ''int    '' || '''fatp=1''' ||   || 
|-
| ''float  '' || '''pclip=98.''' ||   || 	clip percentile
|-
| ''bool   '' || '''poly=n''' ||  [y/n] || 
|-
| ''bool   '' || '''seemean=n''' ||  [y/n] || 	if y, plot mean lines of traces
|-
| ''bool   '' || '''transp=n''' ||  [y/n] || 	if y, transpose the axes
|-
| ''bool   '' || '''verb=n''' ||  [y/n] || 	verbosity flag
|-
| ''int    '' || '''xmask=1''' ||   || 
|-
| ''float  '' || '''xmax=''' ||   || 	maximum trace position (if using xpos)
|-
| ''float  '' || '''xmin=''' ||   || 	minimum trace position (if using xpos)
|-
| ''string '' || '''xpos=''' ||   || 	optional header file with trace positions
|-
| ''bool   '' || '''xreverse=n''' ||  [y/n] || 	if y, reverse the horizontal axis
|-
| ''int    '' || '''ymask=1''' ||   || 
|-
| ''bool   '' || '''yreverse=n''' ||  [y/n] || 	if y, reverse the vertical axis
|-
| ''float  '' || '''zplot=0.75''' ||   || 
|}