NEW PRINTFIELD -- display data in a matrix format

Name

NEW PRINTFIELD -- display data in a matrix format

Author

Kathy Pearson, MCNC, kathyp@mcnc.org, (919) 248-9240

Summary

	Name		NEW PRINTFIELD	
	Type		mapper	
	Inputs		input field	 (field 2D uniform 1-vector float)	
			input slice axis (string)
	Outputs		(none)
	Parameters
			Name			Type	Def	Min	Max
			----			----	---	---	---
			output matrix		(text browser)
			format			(string) "%7.2f"
			file name		(string)
			invert dim2		(toggle)   0	0	1
			labels			(toggle)   0	0	1
			label width		(int)	   7	7	30
			display now		(toggle)   0	0	1

Description

The NEW PRINTFIELD module outputs to a text browser (and optionally to an

Output

file) the values of the input cropped slice of data.  The module
also requires that an input string specifying that the input data has been
sliced along the "X", "Y", or "Z" axis.  Each output value is written
in the C-language format set by the user with optional labeling.  The
separate "label width" parameter might seem unnecessary for cases where
the width can be determined from the format itself (as in the default
case of "%7.2f"); however, for more general use when the user selects
a different format (e.g., "%g", "%.2f", "  %e"), this parameter is needed
for proper alignment of labels with field data values.  The "display now"

Parameter

is included so that data will not be displayed without the user
explicitly requesting it.  If data were always displayed simply on the
basis of the module's inclusion in a network, it could slow down an
animation sequence dramatically.

Inputs

input field	data field for which values are reported
input slice
 axis		"X", "Y", or "Z" string indicating the way the input field
		has been sliced; this parameter is passed from the NEW SLICE
		module
OUTPUTS
(none)
PARAMETERS
output matrix	text browser where the values are reported
format		C-language format in which each individual value is written	
file name	file name to store output displayed in the text browser;
		the default name is "/tmp/matrix.PID" where PID is the
		id number of the running UNIX process, but the user can
		reset the name
invert dim2	toggle indicating whether the second dimension should be
		inverted; typically the slice is on Z, and X column values
		are displayed horizontally with decreasing Y rows so that
		the data in the text browser coincides with the cropped
		matrix of the same data displayed in the geometry viewer;
		for output the user may prefer to invert the Y dimension
		so that both X and Y are in increasing order, and this
		toggle provides such functionality
labels		switch indicating whether the data should have label headings
	
label width	the width for each label (should coincide with the format)
display now	switch indicating if the user would like to display the
		input data in the text browser

Example

Related modules

Limitations

See also

(MCNC Visualization Plan)						11/93
-------------------------------------------------------------------------
The MCNC Environmental Programs Group has created this module as part of a
suite of AVS demo modules, networks, and sample data sets to demonstrate 
the functionality of its visualization prototype for an Environmental 
Decision Support System (EDSS).  This system provides a unified method of 
analysis and visualization for data output from different environmental air 
quality models.  Remotely, standard output files from the following models 
can be read into AVS:
        ROM (Regional Oxidant Model)
        RADM (Regional Acid Deposition Model), low res and high res
        RADM (Regional Acid Depostion Model) Emissions, low res
        UAM (Urban Airshed Model, regulatory version)
        UAM (Urban Airshed Model, AREAL research version)
        UAM Wind (Urban Airshed Model, regulatory version)
        MCNC ALPHA-Prototype netCDF files
Alternatively, xdr portable binary AVS fields can be created from these
data types and accessed directly from the local workstation.
You can download these modules individually from the IAC using anonymous
ftp to the appropriate directories /avs_modules at avs.ncsc.org.  
If you would like to download the entire suite of modules, networks, and
sample datasets at the same time, the IAC recommends that you use 
anonymous ftp to grab the following file from avs.ncsc.org -
/sample_data/avs_data/MCNC_Env_Pgms/MCNC_Env_Pgms.tar.Z
This contains all source code to all local and remote modules, as well as
all of the sample datasets, networks, documentation, installation, and
usage notes.
-------------------------------------------------------------------------