2.2.1.13 XYZ2MatLog
Menu Information
Worksheet: Convert to Matrix: XYZ Log Gridding
Brief Information
Convert XYZ data to matrix with logarithmic gridding
Additional Information
Minimum Origin Version Required: 8.5.1 SR0
Command Line Usage
1. XYZ2MatLog iz:=(col(a),col(b),col(c)) settings.ConvertToMatrix:=2 ovm:=<new: RenkaCline>;
X-Function Execution Options
Please refer to the page for additional option switches when accessing the x-function from script
Variables
Display Name
|
Variable Name
|
I/O and Type
|
Default Value
|
Description
|
Input
|
iz
|
Input
XYZRange
|
<active>
|
Source XYZ worksheet data to convert into matrix by log gridding. If multiple Z columns are specified, each Z column will be converted to a matrix object of the same matrix sheet.
|
Gridding Settings
|
settings
|
Input
TreeNode
|
<unassigned>
|
Settings for log gridding XYZ worksheet data. Please refer to More Information section below for more details.
|
Output Matrix
|
om
|
Output
MatrixLayer
|
<new>
|
If the associated check-box is selected, this option allows specifying a matrix for the output log gridding data. If the input contains n Z columns, the output matrix sheet will have n objects. Only one of Output Matrix and Output Virtual Matrix can be selected.
See the syntax of Output Notations.
|
Output Virtual Matrix
|
ovm
|
Output
Worksheet
|
<new>
|
If the associated check-box is selected, this option allows specifying a worksheet for the output log gridding data. And the output worksheet is arranged as a virtual matrix. Only one of Output Matrix and Output Virtual Matrix can be selected. And if the input contains multiple sets of Z columns, virtual matrix is not supported.
See the syntax of Output Notations.
|
Description
This X-Function will first calculate the logarithmic values for X and Y values, and then perform XYZ Gridding just as XYZ2Mat does. Both X-Functions have the same input and output settings. This is equivalent to the following two steps:
- Calculate the logarithmic values for the input X and Y, get the results as Log(X) and Log(Y) respectively.
- Perform XYZ gridding on (Log(X), Log(Y), Z) by using XYZ2Mat X-Function.
For more information, please refer to our User Guide: XYZ Gridding Methods Description
More Information
settings (Gridding Settings)
The settings (Gridding Settings) tree specifies the XYZ gridding settings.
Syntax: settings.Treenode:=<value>
Example: settings.ConvertToMatrix:=2
|
Treenode
|
Type
|
Default
|
Description
|
ExamData (Data Examination)
|
XStepTol (Tolerance for Even X Step)
|
doule
|
1E-8
|
ExamData (Data Examination)
|
YStepTol (Tolerancce for Even Y Step)
|
double
|
1E-8
|
XPrecision (Tolerance for Duplicate X)
|
double
|
1E-8
|
YPrecision (Tolerance for Duplicate Y)
|
double
|
1E-8
|
RemoveDuplicate (Replace Duplicate With)
|
int
|
0
|
ConvertToMatrix (Gridding Method and Parameters)
|
columns (Columns)
|
int
|
20
|
Gridding Method and Parameters
|
rows (Rows)
|
int
|
20
|
QILF (Quadratic Interpolant Locality Factor)
|
double
|
18
|
WFLF (Weight Function Locality Factor)
|
double
|
9
|
searchradiu (Search Radius)
|
doule
|
2
|
averadius
|
double
|
2
|
minipoints (Minimum Points)
|
double
|
10
|
maxipoints (Maximum Points)
|
double
|
100
|
CorrelationSmoothing (Smoothing)
|
int
|
1
|
TPSSmoothing (Smoothing)
|
int
|
0
|
extrapolation (Extrapolation)
|
int
|
0
|
outsizevalue (Outside Value)
|
int
|
0
|
tolerance (Tolerance)
|
double
|
0.005
|
advanced (Advanced)
|
SelectRange (Range Restriction)
|
treenode
|
- xmin (X Minimum): 0
- xmax (X Maximum): 0
- ymin (Y Minimum): 0
- ymax (Y Maximum): 0
|
Advanced
|
noextrapolation (No Extrapolation outside Boundary)
|
|
int
|
0
|
No Extrapolation outside Boundary
|
previewplottype (Preview Plot Type)
|
|
int
|
1
|
Preview Plot Type
|
Algorithm
References
Related X-Functions
w2m, m2w, r2m, wexpand2m, xyz_regular, xyz_sparse, xyz_shep, xyz_shep_nag, xyz_renka, xyz_renka_nag, xyz_tps
Keywords:worksheet
|