Skip to main content

ContourInfo

ContourInfo (graphNameStr, contourWaveNameStr, instanceNumber)

The ContourInfo function returns a string containing a semicolon-separated list of information about the specified contour plot in the named graph.

Parameters

graphNameStr can be "" to refer to the top graph.

contourWaveNameStr is a string containing either the name of the wave displayed as a contour plot in the named graph, or a contour instance name (wave name with "#n" appended to distinguish the nth contour plot of the wave in the graph). You might get a contour instance name from the ContourNameList function.

If contourWaveNameStr contains a wave name, instanceNumber identifies which contour plot of contourWaveNameStr you want information about. instanceNumber is usually 0 because there is normally only one instance of a wave displayed as a contour plot in a graph. Set instanceNumber to 1 for information about the second contour plot of contourWaveNameStr , etc. If contourWaveNameStr contains "", then information is returned on the instanceNumberth contour plot in the graph.

If contourWaveNameStr contains an instance name, and instanceNumber is zero, the instance is taken from contourWaveNameStr . If instanceNumber is greater than zero, the wave name is extracted from contourWaveNameStr , and information is returned concerning the instanceNumberth instance of the wave.

Details

The string contains several groups of information. Each group is prefaced by a keyword and colon, and terminated with the semicolon. The keywords are as follows:

KeywordInformation Following Keyword
AXISFLAGSFlags used to specify the axes. Usually blank because /L and /B (left and bottom axes) are the defaults.
DATAFORMATEither XYZ or Matrix.
LEVELSA comma-separated list of the contour levels, including the final automatic levels, (or manual or from-wave levels), and the "more levels", all sorted into ascending Z order.
RECREATIONList of keyword commands as used by ModifyContour command. The format of these keyword commands is:
keyword (x)=modifyParameters;
TRACESFORMATFormat string used to name the contour traces (see AppendMatrixContour or AppendXYZContour).
XAXISX axis name.
XWAVEX wave name if any, else blank.
XWAVEDFThe full path to the data folder containing the X wave or blank if there is no X wave.
YAXISY axis name.
YWAVEY wave name if any, else blank.
YWAVEDFThe full path to the data folder containing the Y wave or blank if there is no Y wave.
ZWAVEName of wave containing Z data from which the contour plot was calculated.
ZWAVEDFThe full path to the data folder containing the Z data wave.

The format of the RECREATION information is designed so that you can extract a keyword command from the keyword and colon up to the ";", prepend "ModifyContour ", replace the "x" with the name of a contour plot ("data#1" for instance) and then Execute the resultant string as a command.

Examples

The following command lines create a very unlikely contour display. If you did this, you would most likely want to put each contour plot on different axes, and arrange the axes such that they don't overlap. That would greatly complicate the example.

Make/O/N=(20,20) jack=sin(x/5)+cos(y/4)
Display;AppendMatrixContour jack;DelayUpdate
AppendMatrixContour/T/R jack;DelayUpdate // Second instance of jack
ModifyContour jack labels=0;DelayUpdate // Don't print labels-
ModifyContour jack#1 labels=0 // they take a long time

This example accesses the contour information for the second contour plot of the wave "jack" (which has an instance number of 1) displayed in the top graph:

Print StringByKey("ZWAVE", ContourInfo("","jack",1))    // prints jack

See Also

Execute, ModifyContour