XPROFILE MACRO AND PREFERENCE MANUAL

The purpose of this manual is to provide details on the operation of Macros and Preference files in Xprofile.

Both Macros and Prefenerences can be used to set various parameters in Xprofile before starting. Additionally, Macros can be used to recreate the steps taken to construct a complicated figure, and also can get Xprofile to perform simple tasks "automatically".

PREFERENCE FILES

Preferences are a bit simpler, so let's start with those. To set a certain parameter in Xprofile when it starts up, create a file containing lines with two columns, the first being the name of the parameter and the second being the value you wish to set this parameter to. Xprofile tries to do some checking to make sure these settings are not inappropriate, but be warned that this has not been thoroughly checked.

The name of the preference file is "Xprofile.prefs". Put it in the directory in which you are running the program. For example, if I want the default symbol to be a square (symbol 1) I would enter the following in my prefs file:

symbol 1

Note that a listing of all the variables that can be set, along with their current settings and ranges, can be obtained by typing Xprofile -d. Most will have the same names, defaults, and limits as those shown in the Macro table below.

MACRO FILES

Macro files consist of a series of commands followed by any number of parameter modifiers. The available commands are:

READ	Read in a file, and set parameters for the data file
SET_PLOT	Set arguments for the screen plot.
SET_MAP	Set arguments for mapping
SET_PS	Set arguments for Postscript plots
SET_CONT	Set arguments for contours
SET_DRAW	Set arguments for drawing on screen
SET_LABELS	Read in Labels
SECTIONS	Read in sections
SET_PAL	Select palette and read in user defined palette
ACTION	Allows Xprofile to do several canvas activities automatically
END	Exit the script

The following table shows which arguments can be set for these commands.

Command	Name	Description	Default	Range
READ
	filename	Name of Input file	None	N/A
	directory	Name of Directory of Input file	None	N/A
	data_x	X column	2	1-8
	data_y	Y column	1	1-8
	data_z	Z column	0	0-8
	data_v	Value column	0	0-8
	data_id	ASCII ID column	0	0-8
	data_map	Data file is a map	0	0-1
	data_contour	Data file is a full contour	0	0-1
	data_contourc	Data file is a compressed contour	0	0-1
	data_mech	Data file is focal mechanisms	0	0-1
	data_order	Reverse X and Y assignment	0	0-1
	xscale	Scale for X values	1	!=0
	yscale	Scale for Y values	1	!=0
	zscale	Scale for Z values	1	!=0
	xoff	Offset for X values	1	ALL
	yoff	Offset for Y values	1	ALL
	zoff	Offset for Z values	1	ALL
	pens	Pen width	0	0-9
	line_mode	Type of line	0	0 Solid line 1 Dotted line 2 Dashed line 3 Dot-dashed line 4 No line (shade only)
	shade	Map or Symbol color	0	0 No Shading 1 Black 2 White 3-18 0-15 Palette 19 Scale by Z (Regular files only) 19(+1) Red 20(+1) Green 21(+1) Blue 22(+1) Yellow 23(+1) OrangeRed 24(+1) HotPink 25(+1) RoyalBlue 26(+1) DarkOliveGreen 27(+1) LightCyan 28(+1) SaddleBrown
	lshade	Line Color	0	0 Black 1 White 2-17 0-15 Palette 18 Red 19 Green 20 Blue 21 Yellow 22 OrangeRed 23 HotPink 24 RoyalBlue 25 DarkOliveGreen 26 LightCyan 27 SaddleBrown
	mappattern	Map fill pattern	0	0 No Pattern 1 Open vert lines 2 Tight vert lines 3 Open horiz lines 4 Tight horiz lines 5 Backslash lines 6 Forslash lines 7 Limestone 8 Dolomite 9 Granite 10 Metamorphic 1 11 Metamorphic 2 12 Sandstone 13 Shale 14 Conglomerate 15 Volcanic 16 Igneous (+) 17 Igneous (x) 18 Evaporite 19 Dot 1 20 Dot 2 21 Dot 3
	symbol	Symbol type	0	0 cross 1 circle 2 square 3 triangle 4 diamond 5 no symbol 6 item number 7 Z entries 8 Value entries
	showid	ID size	0	0 Do not plot ID's 1 6 points 2 7 points 3 8 points 4 9 points 5 10 points 6 12 points 7 14 points 8 18 points 9 24 points 10 36 points
	connect	Point connection	0	0 Do not connect points 1 Connect points 2 Connect every second point
	symsize	Size of Symbol	4	0 0.01 1 0.02 2 0.03 3 0.04 4 0.05 5 0.06 6 0.07 7 0.08 8 0.09 9 0.10 10 Scale by Z
	tpens	Width of Thick Contour	4	0-9
	disp	Displacement of ID from symbol	0	0-9
	end	Terminates input for this option	No Argument	N/A
Command	Name	Description	Default	Range
SET_PLOT
	filename	Name of Input file	None	N/A
	directory	Name of Directory of Input file	None	N/A
	header	Plot header	PLOT	N/A
	xlabel	X axis label	X	N/A
	ylabel	Y axis label	X	N/A
	y_sys	Projection type	0	0 Linear XY 1 Short_Dist Projection 2 Azimuthal-Equidistant 3 UTM Projection 4 Hypit Projection
	grid_on	Draw a grid	0	0 No Grid 1 Major Tick Grid 2 Major/Minor Tick Grid
	scaling	Type of screen scaling	0	0 Equal X-Y Scaling 1 Full Screen
	x_right	X positive right	1	0-1
	y_up	Y positive up	1	0-1
	showlab	Show labels	1	0-1
	n_decx	Number of x decimals	2	0-3
	n_decy	Number of y decimals	2	0-3
	n_decz	Number of z decimals	2	0-3
	font_no	Type of Font	0	0 Helvetica 1 Helvetica Bold 2 Helvetica Oblique 3 Helvetica Bold-Oblique 4 Times 5 Times Bold 6 Times Italic 7 Times Bold Italic 8 Courier 9 Courier Bold 10 Courier Oblique 11 Courier Bold Oblique
	header_size	Header Font size	8	0 6 points 1 7 points 2 8 points 3 9 points 4 10 points 5 12 points 6 14 points 7 18 points 8 24 points 9 36 points
	label_size	Label Font size	5	0 6 points 1 7 points 2 8 points 3 9 points 4 10 points 5 12 points 6 14 points 7 18 points 8 24 points 9 36 points
	background	Color of background	0	0 White (None) 1-16 0-15 Palette 17 Red 18 Green 19 Blue 20 Yellow 21 OrangeRed 22 HotPink 23 RoyalBlue 24 DarkOliveGreen 25 LightCyan 26 SaddleBrown
	canhelp	Show canvas help windows	0	0-1
	c_mode	Draw in contour colormap	0	0 Contours Only 1 Color Map Only 2 Contours and Color Map
	showpal	Show palette on screen	0	0-1
	end	Terminates input for this option	No Argument	N/A
Command	Name	Description	Default	Range
SET_MAP
	short_lat	Short distance conversion Latitude	45	-90-90
	azeq_lat	Azimuthal Equidistance Lat	None	-90-90
	azeq_lon	Azimuthal Equidistance Lon	None	-180-180
	radius	Azimuthal Equidistance Circle Radius	None	> 0
	num_pies	Azimuthal Equidistance Angle Segments	None	> 0
	utm_lat	UTM Lat	None	-90-90
	utm_lon	UTM Lon	None	-180-180
	hyp_lat	HYPIT Lat	None	-90-90
	hyp_lon	HYPIT Lon	None	-180-180
	end	Terminates input for this option	No Argument	N/A
Command	Name	Description	Default	Range
SET_PS
	short_lat	Short distance conversion Latitude	45	-90-90
	ps1.x_scale ps2.x_scale	X scale for plot	1	!=0
	ps1.y_scale ps2.y_scale	Y scale for plot	1	!=0
	ps1.x_off ps2.x_off	X offset for plot	1.5 in	ALL
	ps1.y_off ps2.y_off	Y offset for plot	1.5 in	ALL
	ps1.overlay ps2.overlay	(Not Used in This Version)	-	-
	ps1.last_page ps2.last_page	(Not Used in This Version)	-	-
	ps1.spool ps2.spool	(Not Used in This Version)	-	-
	ps1.system ps2.system	Plot Orientation	0	0 Landscape mode 1 Portrait mode
	ps2.macro ps1.macro	(Not Used in This Version)	-	-
	ps1.x_axis ps2.x_axis	Length of X axis	8 in	ALL
	ps1.y_axis ps2.y_axis	Length of Y axis	5 in	ALL
	ps1.n_copies ps2.n_copies	(Not Used in This Version)	-	-
	ps1.dpi	(Not Used in This Version)	-	-
	ps1.unix_time	(Not Used in This Version)	-	-
	ps1.width	(Not Used in This Version)	-	-
	ps1.color	Colors Used	0	0 Gray Scale 1 Red Only 2 Full Color
	ps1.file ps2.file	Output file	Profile.ps Section.ps	N/A
	pix_scale	Pixel Scaling Factor	1.0	> 0
	end	Terminates input for this option	No Argument	N/A
Command	Name	Description	Default	Range
SET_CONT
	dv	Thin Line Contour Interval	None	> 0
	dvl	Thick Line Contour Interval	None	> 0
	vzero	Base level	None	ALL
	zmin	Minimum Z value	None	ALL
	zmax	Maximum Z value	None	ALL
	pix_xres	X pixel resolution	None	> 0
	pix_yres	Y pixel resolution	None	> 0
	C.mode	Draw in contour colormap	0	0 Contours Only 1 Color Map Only 2 Contours and Color Map
	end	Terminates input for this option	No Argument	N/A
Command	Name	Description	Default	Range
SET_DRAW
	data_x_min	Minimum of X	None	ALL
	data_x_max	Maximum of X	None	ALL
	data_y_min	Minimum of Y	None	ALL
	data_y_max	Maximum of Y	None	ALL
	data_x_tick	Major X tick interval	None	!=0
	data_y_tick	Major Y tick interval	None	!=0
	data_xm_tick	Minor X tick interval	None	!=0
	data_ym_tick	Minor Y tick interval	None	!=0
	data_xb_tick	Begin X tick	None	ALL
	data_yb_tick	Begin Y tick	None	ALL
	data_xr_tick	Repeat X tick	None	ALL
	data_yr_tick	Repeat Y tick	None	ALL
	header	Plot header	PLOT	N/A
	xlabel	X axis label	X	N/A
	ylabel	Y axis label	X	N/A
	D.showpal	Show palette on screen	0	0-1
	end	Terminates input for this option	No Argument	N/A
Command	Name	Description	Default	Range
SET_LABELS
	text	Text of Label	None	All
	x1	X coordinate of Label beginning	None	All
	y1	Y coordinate of Label beginning	None	All
	x2	X coordinate of Label end	None	All
	y2	Y coordinate of Label end	None	All
	size	Size of Label	None	0 6 points 1 7 points 2 8 points 3 9 points 4 10 points 5 12 points 6 14 points 7 18 points 8 24 points 9 36 points
	just	Label Justification	None	0 Lower left 1 Lower middle 2 Lower right 3 Center left 4 Center middle 5 Center right 6 Upper left 7 Upper middle 8 Upper right
	end	Terminates input for this option	No Argument	N/A
Command	Name	Description	Default	Range
SECTIONS
	xend	X coordinate of Section Anchor	None	All
	yend	Y coordinate of Section Anchor	None	All
	angle	Angle of Rotation (degrees clockwise)	None	ALL
	length	Length of Section	None	ALL
	width	Width of Section	None	ALL
	end	Terminates input for this option	No Argument	N/A
Command	Name	Description	Default	Range
SET_PAL
	pal	Define which Palette to use	0	0 Grey Scale 1 Red-White-Blue 2 Red-Green-Blue 3 16-Color 4 User-Defined 5 Reverse Pal
	sp_xo	X bit origin for palette display	100	> 0
	sp_yo	Y bit origin for palette display	100	> 0
	sp_length	Bit length of displayed palette	300	> 0
	sp_width	Bit width of displayed palette	100	> 0
	SP.mode	Pallete orientation	0	0 Vertical 1 Horizontal
	userpal	Name of User Defined Palette	None	ALL
	end	Terminates input for this option	No Argument	N/A
Command	Name	Description	Default	Range
ACTION
	create_screen	Draw on Screen	N/A	N/A
	create_ps	Make PostScript Output	N/A	N/A
	select_section (N)	Seletion Section	None	# Sections
	examine_section	Bring up section plot	None	N/A
	create_ps2	Make PostScript Output of Section	N/A	N/A
	pause	Pause the running of the program	N/A	N/A
	select (N)	Select a file	N/A	0 Make current file active 1 Make current file inactive 2 Make only current file active 3 Make only current file inactive
	delete	Delete the current file	N/A	N/A
	select_map (N)	Selet a Map	N/A	0 Make current map active 1 Make current map inactive 2 Make only current map active 3 Make only current map inactive
	delete_map	Delete the current Map	N/A	N/A
	delete_label	Delete the current Label	N/A	N/A
	end	Terminates input for this option	No Argument	N/A
Command	Name	Description	Default	Range

NOTES

1. Some variables appear as a subcommand to more than one command. This is partly for historical reasons. Just remember that the last invocation is the one that will be used.

2. Typically, a macro file will contain a number of READ segments, followed by PLOT, DRAW, or other commands, and finally (if desired) ACTION statements. You can specify as much or as little as you wish.

3. A great thing to do with macros is document the settings used to produce a given picture, either by constructing your own macro or using the WRITE MACRO option after the picture is completed.

Send bug reports to: roecks@rpi.edu