11.12 2D Integration Gadget (Pro Only)

Contents

Overview

The 2D Integration Gadget tool (uses the addtool_integ2 X-Function) allows you to calculate the 2D integration for a contour or image graph created from uniformly spaced matrix or non-uniformly spaced virtual matrix or XYZ worksheet data.

To use this gadget tool, create a contour plot from your data, activate the graph and select Gadgets:2D Integrate from top menu.

2d integrate.png
Notes: The options for the X-Function of gadget is organized as tree variable, the tree node names to be called for each options/branches are listed in the bracket next to the option name(tree node labels).

ROI Box (roi)

The ROI (region of interest) box defines the area for surface integration calculation.

Shape

Define the shape of ROI box.

Rectangle Specify the shape and postion of the rectangle ROI in Shape Postion below.
Circle Specify the shape and postion of the circle ROI in Shape Position below.
Arbitray Shape After clicking OK button, a Create ROI mini dialog box will open, allowing you to choose the drawing tool to draw arbitrary shape on the graph to add ROI box.

Create ROI Dialog.png

  • RectangleButton Rectangle Tool.png && CircleButton Circle Tool.png button: draw a square/rectangle/circle/oval object to add ROI. Refer to this page for detailed use of these tools.
  • PolygonButton Polygon Tool.png && RegionButton Region Tool.png button: draw a freestyle object to add ROI. Refer to this page for detailed use of these tools.
  • Curve button Button Curve Tool.png: draw a closed curve to add ROI. Refer to this page for detailed use of this tool.


Note:After adding a ROI to the graph, you can always click the triangle button at the top-right corner of the ROI box and select Modify ROI menu to open the Create ROI dialog to change the ROI shape again.

Shape Position (shapeProp)

You can define the position of ROI box by giving values for XY coordinates.

X1 (xFrom) Enter a value for the X coordinate for the leftmost line in the ROI box.
X2 (xTo) Enter a value for the X coordinate for the rightmost line in the ROI box.
Y1 (yFrom) Enter a value for the Y coordinate for the bottom line in the ROI box.
Y2 (yTo) Enter a value for the Y coordinate for the top line in the ROI box.
Fixed(Prevent moving by ROI) (fix_roi_loc) Specify whether to prevent manually moving the ROI box.


Show Tool Name (toolname)

Specify whether to show a tool name at the top left corner of the ROI box. The tool name can be further specified in the text box if this check box is selected.


Show on Center-Top of ROI Box (showtop)

Specify whether to show the results of corresponding quantity on center top of the ROI box.

Volume (topVolume) The volume integrated from base to the source surface.
FWHM (topFwhm) The full width at half the height of the source surface.
N (topN) The number of data points.
Minimum (topMinimum) The minimum Z value.
Maximum (topMaximum) The maximum Z value.
Mean (topMean) The mean of Z values.
Median (topMedian) The median of Z values.
SD (topSD) The standard deviation of all Z values.
Sum (topSum) The sum of Z values.

Fill Color (rectcolor)

Specify the fill color for the ROI box.

Baseline (baseline)

Mode (method) Select a mode for the base.
  • None
    There will be no baseline, the integration will be from the zero plane.
  • Constant
    Use a flat plane parallel to the XY plane at the pre-defined Z value.
  • Plane
    Create a fitted plane as baseline using boundary points.
Constant (constantMode) This is only available when the Mode is set to Constant. It is used to specify the Z value for the baseline plane.
  • Custom
    Use a custom Z value, this is defined in the Z= text box.
  • Minimum
    Use the minimum Z value.
  • Maximum
    Use the maximum Z value.
Z= (zvalue) This is only available when Constant is set to Custom. It is used to specify a custom Z value for baseline plane.
Boundary Tolerance (%) (boundtor) This is only available when Mode is set to Plane. The boundary is determined by the option selected for Range. The tolerance in percentage decides a tolerance width or height. The points whose distance from the boundary is less than the tolerance width or height. Tolerance width/height = Tolerance (%) * Width/Height.
Range (range) This is not available when the Mode is set to None or Custom is selected for the Constant drop-down menu. It is used to specify the data range considered when determining base plane.
  • Full Plot Range
    The full plot range boundary is used to fit base plane, or the min/max value is found within the full plot range.
  • Plot Within ROI
    Only the boundary of the plot within the ROI box is used to fit base plane, or the min/max value is found within the data range defined by ROI box.

Integration (integration)

You can specify options for integration in this tab.

If Interpolate for Missing Values (interpmissing) is checked, the interpolation will also taken consideration the missing values.

If Show Baseline-Subtracted Surface (showsurface) is checked, the subtracted surface (subtracted from source data and baseline plane) will be shown.

Output (Output)

Output Quantities to (outputQuantitiesTo)

Customize the output results.

Script Window (script) Specify whether to output the results to the Script window.
Results Log (reslog) Specify whether to output the result to the Results Log.
Append to Worksheet (appendwks) Specify whether to append the results to a worksheet.
Result Worksheet Name (wbkName) This is only available when Append to Worksheet (appendwks) is selected.

If you choose to send output to a Worksheet, you have these options:

  • When you generate new output, results are output to [%H-Integ2d]Result by default (here %H means the Short Name of source graph), but other books and sheets can be specified. If the book and sheet do not exist, they will be created on output.
  • Alternately, you can click the flyout button Gadget flyout button.png to the right of Result Worksheet Name and choose Sheet in Input Book. This fills the edit box with [<input>]Result. When you generate new output, results are output to a sheet named Result in the source book.

Quantities Branch (quantities)

Specify the quantities to be outputted.

Dataset Identifier (name) Specify a dataset identifier in the drop-down list.
Index Range (index_rng) Specify whether to output the indices for the dimension limited by the ROI box. This is only available when the input data is not XYZ range.
X Range (x_rng) Specify whether to output the indices for X range.
Y Range (y_rng) Specify whether to output the indices for Y range.
Max Height (max_height) Specify whether to output the maximum height from source surface to baseline.
Volume (volume) Specify whether to output The volume integrated from base to the source surface.
Area of Surface (area) Specify whether to output the area of the source surface.
Centroid (centroid) Specify whether to output the coordinate of centroid for the selected region.
FWHM (fwhm) Specify whether to output the full width at half the height of the source surface.
Half Width (half_width) Specify whether to output the half width.
Z Max (zmax) Specify whether to output the maximum value of Z.
Index at ZMax (index_zmax) Specify whether to output the column/row index for the data point at maximum Z value.
(x,y) at ZMax (xy_zmax) Specify whether to output the X and Y values for the data point at maximum Z value.
Statistics (QStatistics) Specify whether to output the statistic results based on Z values, available quantities are:
  • N (qsN):Number of data points.
  • Minimum (qsMinimum):Minimum of Z values.
  • Maximum (qsMaximum):Maximum of Z values.
  • Mean (qsMean):Mean of Z values
  • Median (qsMedian):Median of Z values.
  • SD (qsSD):Standard deviation of Z values.
  • Sum (qsSum):Sum of Z values.

Baseline (baselineOutput)

Baseline (baseline) Specify whether to output the baseline information.
Output To (OutputTo) Specify where to output the result .


Notes: The name in the brackets is the tree node name, and the name outside is the tree node label. When an X-function executes by script, you have to assign values to tree nodes using their names. Special characters and spaces are not allowed in tree node names. However, you can use special characters and white space in the tree node label.

The Fly-out Menu

Click the triangle button ROI menu.png near the top right corner of the ROI to open a fly-out menu that offers the following options:

New Output Output the result.
Go to Report Worksheet Go to the result worksheet once the result has been output to worksheet.
Output to Clipboard When selected (menu item checked) New Output will be placed on the Clipboard.
Change Data Change the input data.
  • By default, Auto mode is enabled. When Auto is enabled, plot selection is controlled by clicking on a plot in the graph window or Object Manager. Prior to Origin 2019, Origin did not support Auto; to change target plot/data in older versions, you must select a plot from the fly-out menu.
  • Place a check mark in front of any plot to select that plot.
  • Click Select... or More ... to open the Select Plot(s) dialog and change selection.
Expand to Full Plot(s) Range Expand the ROI box to the full Plots range.
Expand to Full Layer Width Expand the ROI box to the full layer width.
Expand to Full Layer Height Expand the ROI box to the full layer height.
Save Theme Save the settings in this dialog as a dialog theme.
Save as <default> Save the setting in this dialog as <default> theme.
Load Theme Load the dialog theme pre-saved.
Preferences Open the Preferences dialog.