Appendix D: Command Output and Effects

It is sometimes difficult to know where the output of a particular command is placed: in the current data arrays, or in the ``memory'' arrays. Internally FIT2D follows a simple logic, but externally it may be difficult to know the effect of this logic. Where possible the output is in the current data arrays. All operations which involve only single pixel by pixel operations are ``in-place'' e.g CADD, CMULTIPLY, LOGARITHM, FUJI LINEARISATION, RAISE TO A POWER. Similarly all binary pixel by pixel operations produce output in the current data arrays e.g. ADD, SUBTRACT, DIVIDE, MULTIPLY. Operations which can swap pairs of pixels in a simple well defined manner e.g. TRANSPOSE, FLIP are also ``in-place''. Operations which in general can involve several input pixels contributing to one or more output pixels use the ``memory'' for output e.g. SPATIAL FILTER, REBIN, REFLECT, MOVE/ROTATE.

Whilst hopefully the logic is clear, it may still be difficult to know where the output appears as the programs internal needs may be unclear. Thus the following tables explain where the output appears. Additionally, the ``Memory'' Required column explains which commands need the ``memory'' data to be defined before they can be used. The Current Data Affected and the ``Memory'' Affected columns explain whether an operation over-writes the contents of either of the sets of program arrays.

The following variables are used in the tables.

BOTH Output in a general sense is in both the current data array and the ``memory'' array

CURRENT Output in current data array, the previous contents of the current data arrays are over-written, the ``memory'' may be changed (see ``Memory'' Affected entry)

FILE Output is in a named file, neither the current data nor the ``memory'' are affected

MEMORY Output in memory

NONE No output affecting either the current data arrays or the ``memory'' arrays, however minor changes such as the data title and axis labels may take place

NONE(*), NO(*) Commands which presently have no output nor effect on neither set of arrays, as they are not presently implemented

*EXIT* Commands which may lead to the destruction of all program arrays through the exiting of the program. User confirmation is demanded

*MACRO* Commands which run previously saved macros. The effect of such a macro depends on the contains of the macro

*MENU* Commands which enter a sub-menu which contains commands which produce a variety of different effects. See sub-menu table for details of which commands affect which arrays, and for position of output

Table 1: Main Menu Commands and Effects

Command	``Memory''& Output	Current Data	``Memory''
	Required	Position	Affected	Affected
?	NO	NONE	NO	NO
ADD	YES	CURRENT	YES	NO
ANNOTATION LABEL	NO	NONE	NO	NO
BLUR	NO	MEMORY	NO	YES
BRAGGS' EQUATION	NO	NONE	NO	NO
CADD	NO	CURRENT	YES	NO
CALCULATOR	NO	NONE	NO	NO
CALIBRATION	*MENU*	*MENU*	*MENU*	*MENU*
CDIVIDE	NO	CURRENT	YES	NO
CLEAR DATA	NO	CURRENT	YES	NO
CLOSE LOG	NO	NONE	NO	NO
CMULTIPLY	NO	CURRENT	YES	NO
COLOUR TABLE	NO	NONE	NO	NO
CONTOUR PLOT	NO	NONE	NO	NO
CREATE DATA	NO	CURRENT	YES	NO
CURVE STYLES	NO	NONE	NO	NO
DEFINE VARIABLE	NO	NONE	NO	NO
DIFFRACTION PATTERN	NO	NONE	NO	NO
DIMENSIONS	NO	NONE	YES	YES
DISPLAY LIMITS	NO	NONE	NO	NO
DIVIDE	YES	CURRENT	YES	NO
END GRAPHICS FILE	NO	NONE	NO	NO
EXCHANGE	YES	BOTH	YES	YES
EXIT	NO	*EXIT*	*EXIT*	*EXIT*
FAST IMAGE	NO	FILE	NO	NO
FILTER	NO	NONE(*)	NO	NO(*)
FIT	NO	*MENU*	*MENU*	*MENU*
FLIP	NO	CURRENT	YES	NO
FONT	NO	NONE	NO	NO
FUJI LINEARISATION	NO	CURRENT	YES	NO
FULL REGION	NO	NONE	NO	NO
GAUSSIAN	NO	CURRENT	YES	NO
GEOMETRY (EXPERIMENT)	NO	NONE	NO	NO
GRID	NO	NONE	NO	NO
HELP	NO	NONE	NO	NO

Table 2: Main Menu Commands and Effects (Continued)

Command	``Memory''& Output	Current Data	``Memory''
	Required	Position	Affected	Affected
IMAGE	NO	NONE	NO	NO
INFORMATION	NO	NONE	NO	NO
INPUT DATA	NO	CURRENT	YES	NO
LINEARISE FILM	NO	CURRENT	YES	NO
LIST VARIABLES	NO	NONE	NO	NO
LOGARITHM	NO	CURRENT	YES	NO
MACRO	*MACRO*	*MACRO*	*MACRO*	*MACRO*
MEDIAN FILTER	NO	MEMORY	NO	YES
MOVE/ROTATE	NO	MEMORY	NO	YES
MULTIPLY	YES	CURRENT	YES	NO
NORMALISE	NO	CURRENT	YES	NO
OFFSET/SCALE	NO	NONE	NO	NO
OPEN LOG	NO	NONE	NO	NO
OUTPUT DATA	NO	FILE	NO	NO
PAGE POSITION	NO	NONE	NO	NO
PEEP	NO	NONE	NO	NO
PIXEL REGION	NO	NONE	NO	NO
PLOT DATA	NO	NONE	NO	NO
POISSONIAN NOISE	NO	CURRENT	YES	NO
POWER SPECTRUM	NO	NONE(*)	NO	NO(*)
PRINT GRAPHICS	NO	FILE	NO	NO
PUBLICATION QUALITY	NO	NONE	NO	NO
QUIT	NO	*EXIT*	*EXIT*	*EXIT*
RAISE TO A POWER	NO	CURRENT	YES	NO
REBIN	NO	MEMORY	NO	YES
RECALL	YES	CURRENT	YES	NO
REFLECT	NO	MEMORY	NO	YES
REGION	NO	NONE	NO	NO
ROI	NO	NONE	NO	NO
ROTATE LUT	NO	NONE	NO	NO
RUN MACRO	*MACRO	*MACRO*	*MACRO*	*MACRO*
SELECT PIXEL OPERATION	NO	CURRENT	YES	NO
SEQUENCE	*MACRO	*MACRO*	*MACRO*	*MACRO*

Table 3: Main Menu Commands and Effects (Continued)

Command	``Memory''& Output	Current Data	``Memory''
	Required	Position	Affected	Affected
SET ANNOTATION STYLE	NO	NONE	NO	NO
SET ARROW STYLE	NO	NONE	NO	NO
SET AXES STYLE	NO	NONE	NO	NO
SET BACKGROUND STYLE	NO	NONE	NO	NO
SET COLOUR	NO	NONE	NO	NO
SET CURVE STYLES	NO	NONE	NO	NO
SET ENUMERATION STYLE	NO	NONE	NO	NO
SET FONT	NO	NONE	NO	NO
SET GRID STYLE	NO	NONE	NO	NO
SET TICK POSITIONS	NO	NONE	NO	NO
SMOOTH	NO	MEMORY	NO	YES
SPATIAL FILTERING	NO	MEMORY	NO	YES
START MACRO	NO	FILE	NO	NO
STATISTICS	NO	NONE	NO	NO
STOP MACRO	NO	NONE	NO	NO
STORE	NO	MEMORY	NO	YES
SUBTRACT	YES	CURRENT	YES	NO
SURFACE INTERPOLATION	NO	MEMORY	NO	YES
SYMBOL	NO	NONE	NO	NO
SYMMETRIC FUNCTION	YES	CURRENT	YES	NO
TITLE	NO	NONE	NO	NO
THRESHOLD	NO	CURRENT	YES	NO
TRANSPOSE	NO	MEMORY	NO	YES
UN-DEFINE VARIABLE	NO	NONE	NO	NO
UNIT CELL PARAMETERS	NO	NONE	NO	NO
V2C	NO	CURRENT	YES	NO
VARIABLE	NO	NONE	NO	NO
VARIANCES DEFINITION	NO	CURRENT	YES	NO
WEIGHTED AVERAGE	YES	CURRENT	YES	NO
X-AXIS LABEL	NO	NONE	NO	NO
Y-AXIS LABEL	NO	NONE	NO	NO
Z-AXIS LABEL	NO	NONE	NO	NO
Z-SCALE	NO	NONE	NO	NO
1-D INTERPOLATION	NO	CURRENT	YES	NO
3-D SURFACE PLOT	NO	NONE	NO	NO

Table 4: Calibration Sub-Menu Commands and Effects

Command	``Memory''& Output	Current Data	``Memory''
	Required	Position	Affected	Affected
?	NO	NONE	NO	NO
CALCULATE FITTED DISTORTION	NO	MEMORY	NO	YES
DECAY CORRECTION	NO	CURRENT	YES	NO
DESTROY GRID PEAKS	NO	NONE	NO	NO
DISPLAY DISTORTION	NO	NONE	NO	NO
EXIT	NO	NONE	NO	NO
FIND PEAKS	NO	NONE	NO	NO
FIT GRID PEAKS	NO	NONE	NO	NO
FLAT-FIELD CORRECTION	NO	CURRENT	YES	NO
HELP	NO	NONE	NO	NO
INPUT SPATIAL FUNCTION	NO	NONE	NO	NO
INVERSE DISTORTED/IDEAL	NO	NONE	NO	NO
LEARN HOLE PROFILE	NO	MEMORY	NO	YES
LINEARISE INTENSITIES	NO	CURRENT	YES	NO
OUTPUT SPATIAL FUNCTION	NO	FILE	NO	NO
PLATYPUS CORRECTION FILE	NO	FILE	NO	NO
QUIT	NO	NONE	NO	NO
RE-CALCULATE DISTORTION	NO	NONE	NO	NO
RESIDUALS OF FIT	NO	MEMORY	NO	YES
SAVE PEAKS	NO	FILE	NO	NO
SIZE (IMAGE DISPLAY)	NO	NONE	NO	NO
SPATIAL CORRECTION	NO	MEMORY	NO	YES
TRANSFER DISTORTION	NO	MEMORY	NO	YES
VIEW PEAKS	NO	NONE	NO	NO
XRII FLAT-FIELD	NO	MEMORY	NO	YES

Table 5: Fit Sub-Menu Commands and Effects

Command	``Memory''& Output	Current Data	``Memory''
	Required	Position	Affected	Affected
CHANGE SCALE	NO	NONE	NO	NO
CLEAR MASK	NO	NONE	NO	NO
CONSTRAIN	NO	NONE	NO	NO
COVARIANCE	NO	NONE	NO	NO
DEFINE MASK	NO	NONE	NO	NO
EXIT	NO	NONE	NO	NO
INPUT PARAMETERS	NO	NONE	NO	NO
MASK STATISTICS	NO	NONE	NO	NO
MINIMISE	NO	MEMORY	NO	YES
MODEL	NO	MEMORY	NO	YES
NORMALISATION	NO	MEMORY	NO	YES
OUTPUT PARAMETERS	NO	FILE	NO	NO
POWDER DIFFRACTION	NO	MEMORY	NO	YES
QUIT	NO	NONE	NO	NO
R/THETA RE-BINNING	NO	MEMORY	NO	YES
RADIAL PROFILE	NO	MEMORY	NO	YES
RESULTS	NO	NONE	NO	NO
SET MASK COLOUR	NO	NONE	NO	NO
SET UP	NO	NONE	NO	NO
SURFACE POLYNOMIAL	NO	MEMORY	NO	YES
THRESHOLD MASKING	NO	NONE	NO	NO
TILT/BEAM CENTRE	NO	NONE	NO	NO
TRANSFER MASK TO MEMORY	NO	MEMORY	NO	YES