2.13.1.23 TwoDBinning

Contents

Menu Information

Statistics: Descriptive Statistics: 2D Frequency Count/Binning

Brief Information

Compute frequencies for bivariate data

Additional Information

Minimum Origin Version Required: 8 SR0; accessible from script since 8.6 SR0.

Command Line Usage

  1. twoDBinning iy:=col(B) x.bin:=0 x.order:=1 y.bin:=0 y.order:=1;
  2. twoDBinning iy:=col(B) x.periodical:=1 x.period:=36 x.border.outright:=1 y.periodical:=1 y.period:=44 y.border.outright:=1;
  3. twoDBinning iy:=col(b) x.min:=5 x.max:=65 x.inc:=10 y.min:=45 y.max:=90 y.inc:=10 stats:=max om:=<new> bar:=1 image:=1;
  4. twoDBinning iy:=(1,2) x.bin:=0 x.stepby:=1 x.intervals:=5 x.border.outright:=1 x.border.cmax:=1 x.order:=1 y.bin:=0 stats:=freq;

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 iy

Input

XYRange

<active>
 Specify the input XY data range for 2D binning.
X x

Input

TreeNode

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

Input

TreeNode

Specify the options for Y binning range. See More Information section below for more details.
Quantity to Compute stats

Input

int

5
 Specify which quantity to be computed.

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

1
 Available only when Count and Percent Frequency are not selected in the Quantity to Compute drop-down list. This drop-down list allows you to select a column to compute its quantity.

Option list:

  • x:X
    Compute the quantity for the X column.
  • y:Y
    Compute the quantity for the Y column.
  • specific:Customized
    Enable the Base Column parameter.
Base Column col

Input

Range

Available only when Column to Compute Quantity is set to Customized. This allows you choose an arbitrary column from the current worksheet.
Output Worksheet rd

Output

ReportData

<new>
 Choose whether or not to output the result to a specified worksheet.
Subtotal Count for Each Binned Y subcount

Input

int

0
 Specify whether or not to output the subtotal count for each binned Y to the Output Worksheet. Available when the Output Worksheet is specified, and the Quantity to Compute is Sum, Count, or Percent Frequency. The output quantity is in accordance with the specified Quantity to Compute.
Output Matrix om

Output

MatrixObject

<new>
 Choose whether to output the result to a specified matrix.
3D Bars bar

Input

int

0
 Indicates whether or not a 3D bar graph will be plotted from the Output Matrix.
Image Plot image

Input

int

0
 Indicates whether or not an image plot will be plotted from the Output Matrix.

More Information

Options Tree Details

Please refer to Details of TreeNodes in TwoDBinning for more information.


For more information, please refer to our User Guide.

Related X-Functions

freqcounts