2.10.12 plot_heatmapxyz

Contents

Menu Information

Plot > Contour: Heatmap
Plot > Contour: Heatmap with Split Tiles
Plot > Contour: Polar HeatMap θ(X)r(Y)

Brief Information

Create a Heatmap base on one XYZ data.

Create heatmap with split tiles base on multiple XYZ data.

Create a polar heatmap based on one XYZ data.

Additional Information

Minimum Origin Version Required: Origin 2019b

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>
 The input data range.

If multiple XYZ datasets have been selected, the multiple Z values at same XY coordinate will be plotted into one same heatmap cell.

X x

Input

TreeNode

Specify the options for X binning range. See More Information section below for more details.

Note： The treenode is disabled when X and Y input data are categorical/text data. In the case, each bin is a category

Y y

Input

TreeNode

<unassigned>
 Specify the options for Y binning range. See More Information section below for more details.

Note： The treenode is disabled when X and Y input data are categorical/text data. In the case, each bin is a category

Data Identifier label

Input

string

<unassigned>
 Specify the identifiers to be used for axis title
Quantity to Compute stats

Input

int

2

Option list:

  • min:Minimum
    Output minimum for each bin.
  • max:Maximum
    Output maximum for each bin.
  • mean:Mean
    Compute and output mean for each bin.
  • median:Median
    Output median for each bin.
  • sum:Sum
    Compute and output sum for each bin.
  • count:Count
    Compute and output count for each bin.
  • freq:Percent Frequency
    Compute and output percent frequency for each bin.
Column to Compute Quantity base

Input

int

2

Option list:

  • x:X
    Compute the quantity for the X column.
  • y:Y
    Compute the quantity for the Y column.
  • z:Z
    Compute the quantity for the Z column.
Output Worksheet rd

Output

ReportData

[<input>]<new>
 Worksheet of binned results
Template template

Input

string

Heat_Map
 Template to be used to create heatmap

More Information

Options Tree Details

x/y

The x tree specifies the options for X binning range. In the mean time, the y tree specifies the options for Y binning range.

Syntax: x.Treenode:=<value>

Example:

Treenode Label Type Default Description
bin Specify Binning Range by int 1 Specify how to define the X binning range. Options:
  • 0: Bin Centers
    X binning range is indicated by bin centers.
  • 1: Bin Ends
    X binning range is indicated by bin ends.
min Minimum Bin Center/Minimum Bin Beginning double <auto> Specify the minimum value for the X bin center/beginning.
max Maximum Bin Center/Maximum Bin End double <auto> Specify the maximum value for the X bin center/end.
stepby Step by int 0 Specify how to step the bins. Options:
  • 0: Bin Size
    Step the bins by bin size.
  • 1: Number of Bins
    Step the bins by number of bins.
inc Bin Size double <auto> Editable when Step by is Bin Size. Specifies the fixed step size for X bins.
intervals Number of Bins int <auto> Editable when Step by is Number of Bins. Specifies the number of X bins.

Related X-Functions

plot_heatmapxy