2.16.4.3 Details of TreeNodes in TwoDBinning


x

The x tree specifies the options for X 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.
periodical Periodical int 0 Specify whether or not the data is periodic.
period Period double <auto> Specify a period for the X data. Available when Periodical is checked.
border.outleft Include Outliers < Minimum int 0 Specify whether outliers which are less than minimum should be included in the lowest bin. Available when Periodical is unchecked.
border.outright Include Outliers/Include Outliers >= Maximum int 0 Include Outliers is available when Periodical is selected, and specifies whether outliers should be included in the additional bin. Include Outliers >= Maximum is available when Periodical is not selected, and specifies whether outliers which are not less than maximum should be included in the highest bin.
border.cmin Separately Count Minimum int 0 Specify whether or not the minimum value is counted separately.
border.cmax Separately Count Maximum int 0 Specify whether or not the maximum value is counted separately.
order Output Binning Order int 0 Specify the sorted order of the output binning. Options:
  • 0: Ascending
    Output binning in ascending order.
  • 1: Descending
    Output binning in descending order.

y

The y tree specifies the options for Y binning range.

Syntax: y.Treenode:=<value>

Example:

Treenode Label Type Default Description
bin Specify Binning Range by int 1 Specify how to define the Y binning range. Options:
  • 0: Bin Centers
    Y binning range is indicated by bin centers.
  • 1: Bin Ends
    Y binning range is indicated by bin ends.
min Minimum Bin Center/Minimum Bin Beginning double <auto> Specify the minimum value for the Y bin center/beginning.
max Maximum Bin Center/Maximum Bin End double <auto> Specify the maximum value for the Y bin center/end.
stepby Step by int 0 Specify how to step the bins. Options list:
  • 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. It specifies the fixed step size for Y bins.
intervals Number of Bins int <auto> Editable when Step by is Number of Bins. It specifies the number of Y bins.
periodical Periodical int 0 Specify whether or not the data is periodic.
period Period double <auto> Specify a period for the Y data. It is available when Periodical is checked.
border.outleft Include Outliers < Minimum int 0 Specify whether outliers which are less than minimum should be included in the lowest bin. Available when Periodical is not selected.
border.outright Include Outliers/Include Outliers >= Maximum int 0 Include Outliers is available when Periodical is selected, and specifies whether outliers should be included in the additional bin. Include Outliers >= Maximum is available when Periodical is not selected, and specifies whether outliers which are not less than maximum should be included in the highest bin.
border.cmin Separately Count Minimum int 0 Specify whether or not the minimum value is counted separately.
border.cmax Separately Count Maximum int 0 Specify whether or not the maximum value is counted separately.
order Output Binning Order int 0 Specify the sorted order of the output binning. Options list:
  • 0: Ascending
    Output binning in ascending order.
  • 1: Descending
    Output binning in descending order.

bins

The bin tree specifies the bin labeling options.

Syntax: bin.Treenode:=<value>

Example:

Treenode Label Type Default Description
range Bin int 0 Output bins as bin end value or as a range of values. Options:
  • 0:
    Bins are denoted in worksheet data area only by bin end value. Range of low to high values added to worksheet Comments.
  • 1:
    Bins are denoted in worksheet data area by a range of low to high values as "Bins of...".
begin Bin Begin int 0 Output bin beginning value. Options:
  • 0:
    Bins are denoted in worksheet data area only by bin end value. Bin beginning values added to worksheet User-parameter row labeled "Bin Begins...".
  • 1:
    Bins are denoted in worksheet data area as "Bin Begins...".
endOrCenter Bin Center int 0 Output bin center value. Options:
  • 0:
    Bins are denoted in worksheet data area only by bin end value. Bin center values added to worksheet User-parameter row labeled "Bin Centers...".
  • 1:
    Bins are denoted in worksheet data area as "Bin Centers...".