diff --git a/.vs/VisionEdit/v14/.suo b/.vs/VisionEdit/v14/.suo index afcfa15..5d1114d 100644 Binary files a/.vs/VisionEdit/v14/.suo and b/.vs/VisionEdit/v14/.suo differ diff --git a/CaliperTool/CaliperTool.cs b/CaliperTool/CaliperTool.cs index 2656ec5..52776b8 100644 --- a/CaliperTool/CaliperTool.cs +++ b/CaliperTool/CaliperTool.cs @@ -223,7 +223,7 @@ namespace CaliperTool } //把点显示出来 - HOperatorSet.GenCrossContourXld(out crossDisp, ResulttRow, ResultCol, new HTuple(60), new HTuple(0)); + HOperatorSet.GenCrossContourXld(out crossDisp, ResulttRow, ResultCol, new HTuple(80), new HTuple(0)); if(softwareRunState == SoftwareRunState.Debug) { DispMainWindow(FormCaliper.Instance.myHwindow); @@ -275,7 +275,7 @@ namespace CaliperTool // 显示交点 if (dispCross) { - window.DispObj(crossDisp, "yellow"); + window.DispObj(crossDisp, "green"); } //显示找到的线 // window.DispObj(LineDisp, "green"); diff --git a/CaliperTool/bin/Debug/CaliperTool.dll b/CaliperTool/bin/Debug/CaliperTool.dll index 1831ccf..287aade 100644 Binary files a/CaliperTool/bin/Debug/CaliperTool.dll and b/CaliperTool/bin/Debug/CaliperTool.dll differ diff --git a/CaliperTool/bin/Debug/CaliperTool.pdb b/CaliperTool/bin/Debug/CaliperTool.pdb index e818d20..885d879 100644 Binary files a/CaliperTool/bin/Debug/CaliperTool.pdb and b/CaliperTool/bin/Debug/CaliperTool.pdb differ diff --git a/CaliperTool/bin/Debug/CommonMethods.dll b/CaliperTool/bin/Debug/CommonMethods.dll index f0d1ddc..11b7275 100644 Binary files a/CaliperTool/bin/Debug/CommonMethods.dll and b/CaliperTool/bin/Debug/CommonMethods.dll differ diff --git a/CaliperTool/bin/Debug/CommonMethods.pdb b/CaliperTool/bin/Debug/CommonMethods.pdb index 8f9602f..13bff77 100644 Binary files a/CaliperTool/bin/Debug/CommonMethods.pdb and b/CaliperTool/bin/Debug/CommonMethods.pdb differ diff --git a/CaliperTool/bin/Debug/DataStruct.dll b/CaliperTool/bin/Debug/DataStruct.dll index 162524c..4fad34e 100644 Binary files a/CaliperTool/bin/Debug/DataStruct.dll and b/CaliperTool/bin/Debug/DataStruct.dll differ diff --git a/CaliperTool/bin/Debug/DataStruct.pdb b/CaliperTool/bin/Debug/DataStruct.pdb index 1e699d2..13e0531 100644 Binary files a/CaliperTool/bin/Debug/DataStruct.pdb and b/CaliperTool/bin/Debug/DataStruct.pdb differ diff --git a/CaliperTool/bin/Debug/HalconWindow.exe b/CaliperTool/bin/Debug/HalconWindow.exe index 8772b38..cd7cd1a 100644 Binary files a/CaliperTool/bin/Debug/HalconWindow.exe and b/CaliperTool/bin/Debug/HalconWindow.exe differ diff --git a/CaliperTool/bin/Debug/HalconWindow.pdb b/CaliperTool/bin/Debug/HalconWindow.pdb index a82c59d..db55f5a 100644 Binary files a/CaliperTool/bin/Debug/HalconWindow.pdb and b/CaliperTool/bin/Debug/HalconWindow.pdb differ diff --git a/CaliperTool/bin/Debug/ToolBase.dll b/CaliperTool/bin/Debug/ToolBase.dll index a83f146..ad1ac8f 100644 Binary files a/CaliperTool/bin/Debug/ToolBase.dll and b/CaliperTool/bin/Debug/ToolBase.dll differ diff --git a/CaliperTool/bin/Debug/ToolBase.pdb b/CaliperTool/bin/Debug/ToolBase.pdb index e60866c..cb221d8 100644 Binary files a/CaliperTool/bin/Debug/ToolBase.pdb and b/CaliperTool/bin/Debug/ToolBase.pdb differ diff --git a/CaliperTool/obj/Debug/CaliperTool.csproj.FileListAbsolute.txt b/CaliperTool/obj/Debug/CaliperTool.csproj.FileListAbsolute.txt index a6fe011..78eca59 100644 Binary files a/CaliperTool/obj/Debug/CaliperTool.csproj.FileListAbsolute.txt and b/CaliperTool/obj/Debug/CaliperTool.csproj.FileListAbsolute.txt differ diff --git a/CaliperTool/obj/Debug/CaliperTool.csprojResolveAssemblyReference.cache b/CaliperTool/obj/Debug/CaliperTool.csprojResolveAssemblyReference.cache index d077685..c8c84a1 100644 Binary files a/CaliperTool/obj/Debug/CaliperTool.csprojResolveAssemblyReference.cache and b/CaliperTool/obj/Debug/CaliperTool.csprojResolveAssemblyReference.cache differ diff --git a/CaliperTool/obj/Debug/CaliperTool.dll b/CaliperTool/obj/Debug/CaliperTool.dll index 1831ccf..287aade 100644 Binary files a/CaliperTool/obj/Debug/CaliperTool.dll and b/CaliperTool/obj/Debug/CaliperTool.dll differ diff --git a/CaliperTool/obj/Debug/CaliperTool.pdb b/CaliperTool/obj/Debug/CaliperTool.pdb index e818d20..885d879 100644 Binary files a/CaliperTool/obj/Debug/CaliperTool.pdb and b/CaliperTool/obj/Debug/CaliperTool.pdb differ diff --git a/CaliperTool/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache b/CaliperTool/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache index 8db68d3..62713e5 100644 Binary files a/CaliperTool/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache and b/CaliperTool/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache differ diff --git a/CaliperTool/obj/Debug/build.force b/CaliperTool/obj/Debug/build.force new file mode 100644 index 0000000..e69de29 diff --git a/CommonMethods/CommonHelper.csproj b/CommonMethods/CommonHelper.csproj index 9b97432..eef45a8 100644 --- a/CommonMethods/CommonHelper.csproj +++ b/CommonMethods/CommonHelper.csproj @@ -45,7 +45,6 @@ - diff --git a/CommonMethods/bin/Debug/CommonMethods.dll b/CommonMethods/bin/Debug/CommonMethods.dll index f0d1ddc..11b7275 100644 Binary files a/CommonMethods/bin/Debug/CommonMethods.dll and b/CommonMethods/bin/Debug/CommonMethods.dll differ diff --git a/CommonMethods/bin/Debug/CommonMethods.pdb b/CommonMethods/bin/Debug/CommonMethods.pdb index 8f9602f..13bff77 100644 Binary files a/CommonMethods/bin/Debug/CommonMethods.pdb and b/CommonMethods/bin/Debug/CommonMethods.pdb differ diff --git a/CommonMethods/obj/Debug/CommonHelper.csproj.FileListAbsolute.txt b/CommonMethods/obj/Debug/CommonHelper.csproj.FileListAbsolute.txt index 8152463..b80578a 100644 Binary files a/CommonMethods/obj/Debug/CommonHelper.csproj.FileListAbsolute.txt and b/CommonMethods/obj/Debug/CommonHelper.csproj.FileListAbsolute.txt differ diff --git a/CommonMethods/obj/Debug/CommonHelper.csprojResolveAssemblyReference.cache b/CommonMethods/obj/Debug/CommonHelper.csprojResolveAssemblyReference.cache new file mode 100644 index 0000000..193c4be Binary files /dev/null and b/CommonMethods/obj/Debug/CommonHelper.csprojResolveAssemblyReference.cache differ diff --git a/CommonMethods/obj/Debug/CommonMethods.dll b/CommonMethods/obj/Debug/CommonMethods.dll index f0d1ddc..11b7275 100644 Binary files a/CommonMethods/obj/Debug/CommonMethods.dll and b/CommonMethods/obj/Debug/CommonMethods.dll differ diff --git a/CommonMethods/obj/Debug/CommonMethods.pdb b/CommonMethods/obj/Debug/CommonMethods.pdb index 8f9602f..13bff77 100644 Binary files a/CommonMethods/obj/Debug/CommonMethods.pdb and b/CommonMethods/obj/Debug/CommonMethods.pdb differ diff --git a/CommonMethods/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache b/CommonMethods/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache index c721060..6766d00 100644 Binary files a/CommonMethods/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache and b/CommonMethods/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache differ diff --git a/DataStruct/bin/Debug/DataStruct.dll b/DataStruct/bin/Debug/DataStruct.dll index 162524c..4fad34e 100644 Binary files a/DataStruct/bin/Debug/DataStruct.dll and b/DataStruct/bin/Debug/DataStruct.dll differ diff --git a/DataStruct/bin/Debug/DataStruct.pdb b/DataStruct/bin/Debug/DataStruct.pdb index 1e699d2..13e0531 100644 Binary files a/DataStruct/bin/Debug/DataStruct.pdb and b/DataStruct/bin/Debug/DataStruct.pdb differ diff --git a/DataStruct/obj/Debug/DataStruct.csproj.FileListAbsolute.txt b/DataStruct/obj/Debug/DataStruct.csproj.FileListAbsolute.txt index caf68e8..30b2ba3 100644 Binary files a/DataStruct/obj/Debug/DataStruct.csproj.FileListAbsolute.txt and b/DataStruct/obj/Debug/DataStruct.csproj.FileListAbsolute.txt differ diff --git a/DataStruct/obj/Debug/DataStruct.csprojResolveAssemblyReference.cache b/DataStruct/obj/Debug/DataStruct.csprojResolveAssemblyReference.cache new file mode 100644 index 0000000..c0ae63b Binary files /dev/null and b/DataStruct/obj/Debug/DataStruct.csprojResolveAssemblyReference.cache differ diff --git a/DataStruct/obj/Debug/DataStruct.dll b/DataStruct/obj/Debug/DataStruct.dll index 162524c..4fad34e 100644 Binary files a/DataStruct/obj/Debug/DataStruct.dll and b/DataStruct/obj/Debug/DataStruct.dll differ diff --git a/DataStruct/obj/Debug/DataStruct.pdb b/DataStruct/obj/Debug/DataStruct.pdb index 1e699d2..13e0531 100644 Binary files a/DataStruct/obj/Debug/DataStruct.pdb and b/DataStruct/obj/Debug/DataStruct.pdb differ diff --git a/DataStruct/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache b/DataStruct/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache index 6080d9d..0a8d563 100644 Binary files a/DataStruct/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache and b/DataStruct/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache differ diff --git a/FindCircle/bin/Debug/DataStruct.dll b/FindCircle/bin/Debug/DataStruct.dll index 9179ad7..4fad34e 100644 Binary files a/FindCircle/bin/Debug/DataStruct.dll and b/FindCircle/bin/Debug/DataStruct.dll differ diff --git a/FindCircle/bin/Debug/DataStruct.pdb b/FindCircle/bin/Debug/DataStruct.pdb index ba96465..13e0531 100644 Binary files a/FindCircle/bin/Debug/DataStruct.pdb and b/FindCircle/bin/Debug/DataStruct.pdb differ diff --git a/FindCircle/bin/Debug/FindCircleTool.dll b/FindCircle/bin/Debug/FindCircleTool.dll index 9b2a176..58b0ed2 100644 Binary files a/FindCircle/bin/Debug/FindCircleTool.dll and b/FindCircle/bin/Debug/FindCircleTool.dll differ diff --git a/FindCircle/bin/Debug/FindCircleTool.pdb b/FindCircle/bin/Debug/FindCircleTool.pdb index f913fc1..31a158d 100644 Binary files a/FindCircle/bin/Debug/FindCircleTool.pdb and b/FindCircle/bin/Debug/FindCircleTool.pdb differ diff --git a/FindCircle/bin/Debug/HalconWindow.exe b/FindCircle/bin/Debug/HalconWindow.exe index bd0485e..cd7cd1a 100644 Binary files a/FindCircle/bin/Debug/HalconWindow.exe and b/FindCircle/bin/Debug/HalconWindow.exe differ diff --git a/FindCircle/bin/Debug/HalconWindow.pdb b/FindCircle/bin/Debug/HalconWindow.pdb index 554ca39..db55f5a 100644 Binary files a/FindCircle/bin/Debug/HalconWindow.pdb and b/FindCircle/bin/Debug/HalconWindow.pdb differ diff --git a/FindCircle/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache b/FindCircle/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache index 6a4c63f..9bb4169 100644 Binary files a/FindCircle/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache and b/FindCircle/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache differ diff --git a/FindCircle/obj/Debug/FindCircleTool.csproj.FileListAbsolute.txt b/FindCircle/obj/Debug/FindCircleTool.csproj.FileListAbsolute.txt index 16c910f..e98b23c 100644 Binary files a/FindCircle/obj/Debug/FindCircleTool.csproj.FileListAbsolute.txt and b/FindCircle/obj/Debug/FindCircleTool.csproj.FileListAbsolute.txt differ diff --git a/FindCircle/obj/Debug/FindCircleTool.csprojResolveAssemblyReference.cache b/FindCircle/obj/Debug/FindCircleTool.csprojResolveAssemblyReference.cache index 2c24d0a..6d1ef81 100644 Binary files a/FindCircle/obj/Debug/FindCircleTool.csprojResolveAssemblyReference.cache and b/FindCircle/obj/Debug/FindCircleTool.csprojResolveAssemblyReference.cache differ diff --git a/FindCircle/obj/Debug/FindCircleTool.dll b/FindCircle/obj/Debug/FindCircleTool.dll index 9b2a176..58b0ed2 100644 Binary files a/FindCircle/obj/Debug/FindCircleTool.dll and b/FindCircle/obj/Debug/FindCircleTool.dll differ diff --git a/FindCircle/obj/Debug/FindCircleTool.pdb b/FindCircle/obj/Debug/FindCircleTool.pdb index f913fc1..31a158d 100644 Binary files a/FindCircle/obj/Debug/FindCircleTool.pdb and b/FindCircle/obj/Debug/FindCircleTool.pdb differ diff --git a/FindCircle/obj/Debug/build.force b/FindCircle/obj/Debug/build.force new file mode 100644 index 0000000..e69de29 diff --git a/FindLine/FormFindLine.cs b/FindLine/FormFindLine.cs index 215a5a4..9552c7b 100644 Binary files a/FindLine/FormFindLine.cs and b/FindLine/FormFindLine.cs differ diff --git a/FindLine/bin/Debug/CommonMethods.dll b/FindLine/bin/Debug/CommonMethods.dll index 998e514..11b7275 100644 Binary files a/FindLine/bin/Debug/CommonMethods.dll and b/FindLine/bin/Debug/CommonMethods.dll differ diff --git a/FindLine/bin/Debug/CommonMethods.pdb b/FindLine/bin/Debug/CommonMethods.pdb index 557a6ba..13bff77 100644 Binary files a/FindLine/bin/Debug/CommonMethods.pdb and b/FindLine/bin/Debug/CommonMethods.pdb differ diff --git a/FindLine/bin/Debug/DataStruct.dll b/FindLine/bin/Debug/DataStruct.dll index 9179ad7..4fad34e 100644 Binary files a/FindLine/bin/Debug/DataStruct.dll and b/FindLine/bin/Debug/DataStruct.dll differ diff --git a/FindLine/bin/Debug/DataStruct.pdb b/FindLine/bin/Debug/DataStruct.pdb index ba96465..13e0531 100644 Binary files a/FindLine/bin/Debug/DataStruct.pdb and b/FindLine/bin/Debug/DataStruct.pdb differ diff --git a/FindLine/bin/Debug/FindLineTool.dll b/FindLine/bin/Debug/FindLineTool.dll index 9a6e389..c89895e 100644 Binary files a/FindLine/bin/Debug/FindLineTool.dll and b/FindLine/bin/Debug/FindLineTool.dll differ diff --git a/FindLine/bin/Debug/FindLineTool.pdb b/FindLine/bin/Debug/FindLineTool.pdb index 06c8b4d..4b7d93d 100644 Binary files a/FindLine/bin/Debug/FindLineTool.pdb and b/FindLine/bin/Debug/FindLineTool.pdb differ diff --git a/FindLine/bin/Debug/HalconWindow.exe b/FindLine/bin/Debug/HalconWindow.exe index bd0485e..cd7cd1a 100644 Binary files a/FindLine/bin/Debug/HalconWindow.exe and b/FindLine/bin/Debug/HalconWindow.exe differ diff --git a/FindLine/bin/Debug/HalconWindow.pdb b/FindLine/bin/Debug/HalconWindow.pdb index 554ca39..db55f5a 100644 Binary files a/FindLine/bin/Debug/HalconWindow.pdb and b/FindLine/bin/Debug/HalconWindow.pdb differ diff --git a/FindLine/bin/Debug/ToolBase.dll b/FindLine/bin/Debug/ToolBase.dll index 8deeade..ad1ac8f 100644 Binary files a/FindLine/bin/Debug/ToolBase.dll and b/FindLine/bin/Debug/ToolBase.dll differ diff --git a/FindLine/bin/Debug/ToolBase.pdb b/FindLine/bin/Debug/ToolBase.pdb index 221e97e..cb221d8 100644 Binary files a/FindLine/bin/Debug/ToolBase.pdb and b/FindLine/bin/Debug/ToolBase.pdb differ diff --git a/FindLine/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache b/FindLine/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache index 114b649..42766ef 100644 Binary files a/FindLine/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache and b/FindLine/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache differ diff --git a/FindLine/obj/Debug/FindLineTool.csproj.FileListAbsolute.txt b/FindLine/obj/Debug/FindLineTool.csproj.FileListAbsolute.txt index 3108561..45151c7 100644 Binary files a/FindLine/obj/Debug/FindLineTool.csproj.FileListAbsolute.txt and b/FindLine/obj/Debug/FindLineTool.csproj.FileListAbsolute.txt differ diff --git a/FindLine/obj/Debug/FindLineTool.csprojResolveAssemblyReference.cache b/FindLine/obj/Debug/FindLineTool.csprojResolveAssemblyReference.cache index c884158..c8c84a1 100644 Binary files a/FindLine/obj/Debug/FindLineTool.csprojResolveAssemblyReference.cache and b/FindLine/obj/Debug/FindLineTool.csprojResolveAssemblyReference.cache differ diff --git a/FindLine/obj/Debug/FindLineTool.dll b/FindLine/obj/Debug/FindLineTool.dll index 9a6e389..c89895e 100644 Binary files a/FindLine/obj/Debug/FindLineTool.dll and b/FindLine/obj/Debug/FindLineTool.dll differ diff --git a/FindLine/obj/Debug/FindLineTool.pdb b/FindLine/obj/Debug/FindLineTool.pdb index 06c8b4d..4b7d93d 100644 Binary files a/FindLine/obj/Debug/FindLineTool.pdb and b/FindLine/obj/Debug/FindLineTool.pdb differ diff --git a/FindLine/obj/Debug/build.force b/FindLine/obj/Debug/build.force new file mode 100644 index 0000000..e69de29 diff --git a/HalconTool/bin/Debug/CommonMethods.dll b/HalconTool/bin/Debug/CommonMethods.dll index 998e514..11b7275 100644 Binary files a/HalconTool/bin/Debug/CommonMethods.dll and b/HalconTool/bin/Debug/CommonMethods.dll differ diff --git a/HalconTool/bin/Debug/CommonMethods.pdb b/HalconTool/bin/Debug/CommonMethods.pdb index 557a6ba..13bff77 100644 Binary files a/HalconTool/bin/Debug/CommonMethods.pdb and b/HalconTool/bin/Debug/CommonMethods.pdb differ diff --git a/HalconTool/bin/Debug/HalconTool.dll b/HalconTool/bin/Debug/HalconTool.dll index eeb932f..910a501 100644 Binary files a/HalconTool/bin/Debug/HalconTool.dll and b/HalconTool/bin/Debug/HalconTool.dll differ diff --git a/HalconTool/bin/Debug/HalconTool.pdb b/HalconTool/bin/Debug/HalconTool.pdb index 9fb4e45..c2f4bdd 100644 Binary files a/HalconTool/bin/Debug/HalconTool.pdb and b/HalconTool/bin/Debug/HalconTool.pdb differ diff --git a/HalconTool/bin/Debug/HalconWindow.exe b/HalconTool/bin/Debug/HalconWindow.exe index bd0485e..cd7cd1a 100644 Binary files a/HalconTool/bin/Debug/HalconWindow.exe and b/HalconTool/bin/Debug/HalconWindow.exe differ diff --git a/HalconTool/bin/Debug/HalconWindow.pdb b/HalconTool/bin/Debug/HalconWindow.pdb index 554ca39..db55f5a 100644 Binary files a/HalconTool/bin/Debug/HalconWindow.pdb and b/HalconTool/bin/Debug/HalconWindow.pdb differ diff --git a/HalconTool/bin/Debug/ToolBase.dll b/HalconTool/bin/Debug/ToolBase.dll index 8deeade..ad1ac8f 100644 Binary files a/HalconTool/bin/Debug/ToolBase.dll and b/HalconTool/bin/Debug/ToolBase.dll differ diff --git a/HalconTool/bin/Debug/ToolBase.pdb b/HalconTool/bin/Debug/ToolBase.pdb index 221e97e..cb221d8 100644 Binary files a/HalconTool/bin/Debug/ToolBase.pdb and b/HalconTool/bin/Debug/ToolBase.pdb differ diff --git a/HalconTool/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache b/HalconTool/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache index 228bfb8..869959b 100644 Binary files a/HalconTool/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache and b/HalconTool/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache differ diff --git a/HalconTool/obj/Debug/HalconTool.csproj.FileListAbsolute.txt b/HalconTool/obj/Debug/HalconTool.csproj.FileListAbsolute.txt index ef432d2..1a224d2 100644 Binary files a/HalconTool/obj/Debug/HalconTool.csproj.FileListAbsolute.txt and b/HalconTool/obj/Debug/HalconTool.csproj.FileListAbsolute.txt differ diff --git a/HalconTool/obj/Debug/HalconTool.csprojResolveAssemblyReference.cache b/HalconTool/obj/Debug/HalconTool.csprojResolveAssemblyReference.cache index 5705ec7..6e19e90 100644 Binary files a/HalconTool/obj/Debug/HalconTool.csprojResolveAssemblyReference.cache and b/HalconTool/obj/Debug/HalconTool.csprojResolveAssemblyReference.cache differ diff --git a/HalconTool/obj/Debug/HalconTool.dll b/HalconTool/obj/Debug/HalconTool.dll index eeb932f..910a501 100644 Binary files a/HalconTool/obj/Debug/HalconTool.dll and b/HalconTool/obj/Debug/HalconTool.dll differ diff --git a/HalconTool/obj/Debug/HalconTool.pdb b/HalconTool/obj/Debug/HalconTool.pdb index 9fb4e45..c2f4bdd 100644 Binary files a/HalconTool/obj/Debug/HalconTool.pdb and b/HalconTool/obj/Debug/HalconTool.pdb differ diff --git a/HalconTool/obj/Debug/build.force b/HalconTool/obj/Debug/build.force new file mode 100644 index 0000000..e69de29 diff --git a/HalconWindowTest/HWindowSmart.Designer.cs b/HalconWindowTest/HWindowSmart.Designer.cs new file mode 100644 index 0000000..578e78f --- /dev/null +++ b/HalconWindowTest/HWindowSmart.Designer.cs @@ -0,0 +1,69 @@ +namespace HalconWindow +{ + partial class HWindowSmart + { + /// + /// 必需的设计器变量。 + /// + private System.ComponentModel.IContainer components = null; + + /// + /// 清理所有正在使用的资源。 + /// + /// 如果应释放托管资源，为 true；否则为 false。 + protected override void Dispose(bool disposing) + { + if (disposing && (components != null)) + { + components.Dispose(); + } + base.Dispose(disposing); + } + + #region 组件设计器生成的代码 + + /// + /// 设计器支持所需的方法 - 不要修改 + /// 使用代码编辑器修改此方法的内容。 + /// + private void InitializeComponent() + { + this.hSmartWindowControl = new HalconDotNet.HSmartWindowControl(); + this.SuspendLayout(); + // + // hSmartWindowControl + // + this.hSmartWindowControl.Anchor = ((System.Windows.Forms.AnchorStyles)((((System.Windows.Forms.AnchorStyles.Top | System.Windows.Forms.AnchorStyles.Bottom) + | System.Windows.Forms.AnchorStyles.Left) + | System.Windows.Forms.AnchorStyles.Right))); + this.hSmartWindowControl.AutoSizeMode = System.Windows.Forms.AutoSizeMode.GrowAndShrink; + this.hSmartWindowControl.AutoValidate = System.Windows.Forms.AutoValidate.EnableAllowFocusChange; + this.hSmartWindowControl.HDoubleClickToFitContent = true; + this.hSmartWindowControl.HDrawingObjectsModifier = HalconDotNet.HSmartWindowControl.DrawingObjectsModifier.None; + this.hSmartWindowControl.HImagePart = new System.Drawing.Rectangle(0, 0, 640, 480); + this.hSmartWindowControl.HKeepAspectRatio = true; + this.hSmartWindowControl.HMoveContent = true; + this.hSmartWindowControl.HZoomContent = HalconDotNet.HSmartWindowControl.ZoomContent.WheelForwardZoomsIn; + this.hSmartWindowControl.Location = new System.Drawing.Point(0, 0); + this.hSmartWindowControl.Margin = new System.Windows.Forms.Padding(0); + this.hSmartWindowControl.Name = "hSmartWindowControl"; + this.hSmartWindowControl.Size = new System.Drawing.Size(652, 498); + this.hSmartWindowControl.TabIndex = 0; + this.hSmartWindowControl.WindowSize = new System.Drawing.Size(652, 498); + // + // HWindowSmart + // + this.AutoScaleDimensions = new System.Drawing.SizeF(6F, 12F); + this.AutoScaleMode = System.Windows.Forms.AutoScaleMode.Font; + this.Controls.Add(this.hSmartWindowControl); + this.Name = "HWindowSmart"; + this.Size = new System.Drawing.Size(652, 522); + this.ResumeLayout(false); + + } + + #endregion + + public HalconDotNet.HSmartWindowControl hSmartWindowControl; + } +} diff --git a/HalconWindowTest/HWindowSmart.cs b/HalconWindowTest/HWindowSmart.cs new file mode 100644 index 0000000..c36639a --- /dev/null +++ b/HalconWindowTest/HWindowSmart.cs @@ -0,0 +1,20 @@ +using System; +using System.Collections.Generic; +using System.ComponentModel; +using System.Drawing; +using System.Data; +using System.Linq; +using System.Text; +using System.Threading.Tasks; +using System.Windows.Forms; + +namespace HalconWindow +{ + public partial class HWindowSmart : UserControl + { + public HWindowSmart() + { + InitializeComponent(); + } + } +} diff --git a/HalconWindowTest/HWindowSmart.resx b/HalconWindowTest/HWindowSmart.resx new file mode 100644 index 0000000..1af7de1 --- /dev/null +++ b/HalconWindowTest/HWindowSmart.resx @@ -0,0 +1,120 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + text/microsoft-resx + + + 2.0 + + + System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + + System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + \ No newline at end of file diff --git a/HalconWindowTest/HalconWindow.csproj b/HalconWindowTest/HalconWindow.csproj index a4fdaaf..2e5f1cc 100644 --- a/HalconWindowTest/HalconWindow.csproj +++ b/HalconWindowTest/HalconWindow.csproj @@ -100,6 +100,12 @@ HWindow_Final.cs + + UserControl + + + HWindowSmart.cs + Form @@ -111,6 +117,9 @@ HWindow_Final.cs + + HWindowSmart.cs + MainForm.cs diff --git a/HalconWindowTest/HalconWindow/HWindow_Final.Designer.cs b/HalconWindowTest/HalconWindow/HWindow_Final.Designer.cs index 95c0273..197d00d 100644 --- a/HalconWindowTest/HalconWindow/HWindow_Final.Designer.cs +++ b/HalconWindowTest/HalconWindow/HWindow_Final.Designer.cs @@ -55,8 +55,7 @@ // // HWindow_Final // - this.AutoScaleDimensions = new System.Drawing.SizeF(6F, 12F); - this.AutoScaleMode = System.Windows.Forms.AutoScaleMode.Font; + this.AutoScaleMode = System.Windows.Forms.AutoScaleMode.None; this.Controls.Add(this.m_CtrlHStatusLabelCtrl); this.Controls.Add(this.mCtrl_HWindow); this.Name = "HWindow_Final"; diff --git a/HalconWindowTest/HalconWindow/HWindow_Final.cs b/HalconWindowTest/HalconWindow/HWindow_Final.cs index 211f001..6d32cd6 100644 --- a/HalconWindowTest/HalconWindow/HWindow_Final.cs +++ b/HalconWindowTest/HalconWindow/HWindow_Final.cs @@ -20,7 +20,6 @@ namespace HalconWindow.HalconWindow private HImage /**/ hv_image; //缩放时操作的图片 此处千万不要使用hv_image = new HImage(),不然在生成控件dll的时候,会导致无法序列化,去你妈隔壁,还好老子有版本控制,不然都找不到这种恶心问题 private int /**/ hv_imageWidth, hv_imageHeight; //图片宽,高 private string /**/ str_imgSize; //图片尺寸大小 5120X3840 - private HTuple str_channel; //通道数 private bool /**/ drawModel = false; //绘制模式下,不允许缩放和鼠标右键菜单 public ViewWindow.ViewWindow viewWindow; /**/ //ViewWindow @@ -44,7 +43,7 @@ namespace HalconWindow.HalconWindow // 'arrow' 'default' 'crosshair' 'text I-beam' 'Slashed circle' 'Size All' // 'Size NESW' 'Size S' 'Size NWSE' 'Size WE' 'Vertical Arrow' 'Hourglass' // - // hv_window.SetMshape("Hourglass"); + // hv_window.SetMshape("Hourglass"); fit_strip = new ToolStripMenuItem("适应窗口"); fit_strip.Click += new EventHandler((s, e) => DispImageFit(mCtrl_HWindow)); @@ -108,19 +107,6 @@ namespace HalconWindow.HalconWindow drawModel = value; } } - private bool _EditModel = true;//绘制的图形是否可以编辑 - public bool EditModel - { - get - { - return _EditModel; - } - set - { - viewWindow.setEditModel(value); - _EditModel = value; - } - } /// /// 设置image,初始化控件参数 @@ -142,9 +128,7 @@ namespace HalconWindow.HalconWindow this.hv_image = value; hv_image.GetImageSize(out hv_imageWidth, out hv_imageHeight); - HOperatorSet.CountChannels(hv_image, out str_channel); str_imgSize = String.Format("{0}X{1}", hv_imageWidth, hv_imageHeight); - // str_channel = string.Format("C{0}", str_channel); //DispImageFit(mCtrl_HWindow); try @@ -289,7 +273,7 @@ namespace HalconWindow.HalconWindow HOperatorSet.CountChannels(hv_image, out channel_count); hv_window.GetMpositionSubPix(out positionY, out positionX, out button_state); - str_position = String.Format("R: {0:0000.0}, C: {1:0000.0}", positionY, positionX); + str_position = String.Format("ROW: {0:0000.0}, COLUMN: {1:0000.0}", positionY, positionX); _isXOut = (positionX < 0 || positionX >= hv_imageWidth); _isYOut = (positionY < 0 || positionY >= hv_imageHeight); @@ -298,9 +282,9 @@ namespace HalconWindow.HalconWindow { if ((int)channel_count == 1) { - int grayVal; + double grayVal; grayVal = hv_image.GetGrayval((int)positionY, (int)positionX); - str_value = String.Format("V: {0:000}", grayVal); + str_value = String.Format("Val: {0:000.0}", grayVal); } else if ((int)channel_count == 3) { @@ -320,13 +304,13 @@ namespace HalconWindow.HalconWindow _GreenChannel.Dispose(); _BlueChannel.Dispose(); - str_value = String.Format("V: ({0:000.0}, {1:000.0}, {2:000.0})", grayValRed, grayValGreen, grayValBlue); + str_value = String.Format("Val: ({0:000.0}, {1:000.0}, {2:000.0})", grayValRed, grayValGreen, grayValBlue); } else { str_value = ""; } - m_CtrlHStatusLabelCtrl.Text = str_channel + " " + str_imgSize + " " + str_position + " " + str_value; + m_CtrlHStatusLabelCtrl.Text = str_imgSize + " " + str_position + " " + str_value; } } catch (Exception ex) @@ -416,6 +400,7 @@ namespace HalconWindow.HalconWindow } + #endregion /// diff --git a/HalconWindowTest/HalconWindow/ViewWindow.cs b/HalconWindowTest/HalconWindow/ViewWindow.cs index 2808c31..241f3f0 100644 --- a/HalconWindowTest/HalconWindow/ViewWindow.cs +++ b/HalconWindowTest/HalconWindow/ViewWindow.cs @@ -3,12 +3,13 @@ using System.Collections.Generic; using System.Linq; using System.Text; using HalconDotNet; +using ViewWindow.Model; namespace ViewWindow { public class ViewWindow : Model.IViewWindow { - public Model.HWndCtrl _hWndControl; + private Model.HWndCtrl _hWndControl; private Model.ROIController _roiController; @@ -36,11 +37,11 @@ namespace ViewWindow //清空roi容器,不让roi显示 this._roiController.reset(); //显示图片 - this._roiController.resetWindowImage(); + this._roiController.resetWindowImage(); //this._hWndControl.resetWindow(); - // this._hWndControl.resetAll(); + // this._hWndControl.resetAll(); //this._hWndControl.repaint(); } public void notDisplayRoi() @@ -61,12 +62,6 @@ namespace ViewWindow { _hWndControl.drawModel = flag; } - //是否开启编辑事件 - public void setEditModel(bool flag) - { - _roiController.EditModel = flag; - // _hWndControl.drawModel = flag; - } public void resetWindowImage() { this._hWndControl.resetWindow(); @@ -107,10 +102,7 @@ namespace ViewWindow { this._roiController.genCircle(row, col, radius, ref rois); } - public void genCircularArc(double row, double col, double radius, double startPhi, double extentPhi, string direct,ref List rois) - { - this._roiController.genCircularArc(row, col, radius, startPhi, extentPhi,direct,ref rois); - } + public void genLine(double beginRow, double beginCol, double endRow, double endCol, ref List rois) { this._roiController.genLine(beginRow, beginCol, endRow, endCol, ref rois); @@ -118,10 +110,10 @@ namespace ViewWindow public List smallestActiveROI(out string name, out int index) { - List resual = this._roiController.smallestActiveROI(out name,out index); + List resual = this._roiController.smallestActiveROI(out name, out index); return resual; } - + public Model.ROI smallestActiveROI(out List data, out int index) { Model.ROI roi = this._roiController.smallestActiveROI(out data, out index); @@ -133,10 +125,10 @@ namespace ViewWindow this._roiController.selectROI(index); } - public void selectROI( List rois, int index) + public void selectROI(List rois, int index) { //this._roiController.selectROI(index); - if ((rois.Count > index)&&(index>=0)) + if ((rois.Count > index) && (index >= 0)) { this._hWndControl.resetAll(); this._hWndControl.repaint(); @@ -167,13 +159,6 @@ namespace ViewWindow this._roiController.displayCircle(rois[index].Color, m_roiData[0].D, m_roiData[1].D, m_roiData[2].D); } break; - case "ROICircularArc": - - if (m_roiData != null) - { - this._roiController.displayCircularArc(rois[index].Color, m_roiData[0].D, m_roiData[1].D, m_roiData[2].D, m_roiData[3].D, m_roiData[4].D); - } - break; case "ROILine": if (m_roiData != null) @@ -215,7 +200,7 @@ namespace ViewWindow if (m_roiData != null) { this._roiController.displayRect2(roi.Color, m_roiData[0].D, m_roiData[1].D, m_roiData[2].D, m_roiData[3].D, m_roiData[4].D); - + } break; case "ROICircle": @@ -296,15 +281,20 @@ namespace ViewWindow } #region 专门用于 显示region 和xld的方法 - public void displayHobject(HObject obj,string color) + public void displayHobject(HObject obj, string color) { _hWndControl.DispObj(obj, color); - + } public void displayHobject(HObject obj) { _hWndControl.DispObj(obj, null); } + + public void genCircularArc(double row, double col, double radius, double startPhi, double extentPhi, string direct, ref List rois) + { + throw new NotImplementedException(); + } #endregion } } diff --git a/HalconWindowTest/MainForm.Designer.cs b/HalconWindowTest/MainForm.Designer.cs index 276335d..2348365 100644 --- a/HalconWindowTest/MainForm.Designer.cs +++ b/HalconWindowTest/MainForm.Designer.cs @@ -30,18 +30,22 @@ { this.panel1 = new System.Windows.Forms.Panel(); this.button1 = new System.Windows.Forms.Button(); + this.label1 = new System.Windows.Forms.Label(); + this.panel1.SuspendLayout(); this.SuspendLayout(); // // panel1 // - this.panel1.Location = new System.Drawing.Point(27, 53); + this.panel1.Controls.Add(this.label1); + this.panel1.Dock = System.Windows.Forms.DockStyle.Fill; + this.panel1.Location = new System.Drawing.Point(0, 0); this.panel1.Name = "panel1"; - this.panel1.Size = new System.Drawing.Size(521, 501); + this.panel1.Size = new System.Drawing.Size(807, 600); this.panel1.TabIndex = 0; // // button1 // - this.button1.Location = new System.Drawing.Point(600, 106); + this.button1.Location = new System.Drawing.Point(597, 173); this.button1.Name = "button1"; this.button1.Size = new System.Drawing.Size(89, 57); this.button1.TabIndex = 1; @@ -49,6 +53,16 @@ this.button1.UseVisualStyleBackColor = true; this.button1.Click += new System.EventHandler(this.button1_Click); // + // label1 + // + this.label1.Anchor = ((System.Windows.Forms.AnchorStyles)((System.Windows.Forms.AnchorStyles.Bottom | System.Windows.Forms.AnchorStyles.Right))); + this.label1.AutoSize = true; + this.label1.Location = new System.Drawing.Point(747, 567); + this.label1.Name = "label1"; + this.label1.Size = new System.Drawing.Size(41, 12); + this.label1.TabIndex = 0; + this.label1.Text = "label1"; + // // MainForm // this.AutoScaleDimensions = new System.Drawing.SizeF(6F, 12F); @@ -57,8 +71,9 @@ this.Controls.Add(this.button1); this.Controls.Add(this.panel1); this.Name = "MainForm"; - this.Text = "MainForm"; this.Load += new System.EventHandler(this.MainForm_Load); + this.panel1.ResumeLayout(false); + this.panel1.PerformLayout(); this.ResumeLayout(false); } @@ -67,5 +82,6 @@ private System.Windows.Forms.Panel panel1; private System.Windows.Forms.Button button1; + private System.Windows.Forms.Label label1; } } \ No newline at end of file diff --git a/HalconWindowTest/MainForm.cs b/HalconWindowTest/MainForm.cs index 1659d0e..ae9243a 100644 --- a/HalconWindowTest/MainForm.cs +++ b/HalconWindowTest/MainForm.cs @@ -14,7 +14,7 @@ namespace HalconWindow { public partial class MainForm : Form { - HWindow_Final myWindow = new HWindow_Final(); + HWindowSmart myWindow = new HWindowSmart(); public MainForm() { InitializeComponent(); @@ -23,13 +23,18 @@ namespace HalconWindow private void MainForm_Load(object sender, EventArgs e) { this.panel1.Controls.Add(myWindow); + myWindow.Dock = DockStyle.Fill; + HObject image = new HObject(); + HOperatorSet.ReadImage(out image, @"G:\Outer_HB.bmp"); + myWindow.hSmartWindowControl.HalconWindow.DispObj(image); } private void button1_Click(object sender, EventArgs e) { HObject image = new HObject(); HOperatorSet.ReadImage(out image, @"G:\Outer_HB.bmp"); - myWindow.HobjectToHimage(image); + myWindow.hSmartWindowControl.HalconWindow.DispObj(image); + // myWindow.HobjectToHimage(image); } } } diff --git a/HalconWindowTest/bin/Debug/HalconWindow.exe b/HalconWindowTest/bin/Debug/HalconWindow.exe index 8772b38..cd7cd1a 100644 Binary files a/HalconWindowTest/bin/Debug/HalconWindow.exe and b/HalconWindowTest/bin/Debug/HalconWindow.exe differ diff --git a/HalconWindowTest/bin/Debug/HalconWindow.pdb b/HalconWindowTest/bin/Debug/HalconWindow.pdb index a82c59d..db55f5a 100644 Binary files a/HalconWindowTest/bin/Debug/HalconWindow.pdb and b/HalconWindowTest/bin/Debug/HalconWindow.pdb differ diff --git a/HalconWindowTest/obj/Debug/DesignTimeResolveAssemblyReferences.cache b/HalconWindowTest/obj/Debug/DesignTimeResolveAssemblyReferences.cache index 57f1959..19e2f56 100644 Binary files a/HalconWindowTest/obj/Debug/DesignTimeResolveAssemblyReferences.cache and b/HalconWindowTest/obj/Debug/DesignTimeResolveAssemblyReferences.cache differ diff --git a/HalconWindowTest/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache b/HalconWindowTest/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache index 35b0eae..fec89d1 100644 Binary files a/HalconWindowTest/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache and b/HalconWindowTest/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache differ diff --git a/HalconWindowTest/obj/Debug/HalconWindow.HWindowSmart.resources b/HalconWindowTest/obj/Debug/HalconWindow.HWindowSmart.resources new file mode 100644 index 0000000..6c05a97 Binary files /dev/null and b/HalconWindowTest/obj/Debug/HalconWindow.HWindowSmart.resources differ diff --git a/HalconWindowTest/obj/Debug/HalconWindow.csproj.FileListAbsolute.txt b/HalconWindowTest/obj/Debug/HalconWindow.csproj.FileListAbsolute.txt index 9760aed..4d7ce5d 100644 Binary files a/HalconWindowTest/obj/Debug/HalconWindow.csproj.FileListAbsolute.txt and b/HalconWindowTest/obj/Debug/HalconWindow.csproj.FileListAbsolute.txt differ diff --git a/HalconWindowTest/obj/Debug/HalconWindow.csproj.GenerateResource.Cache b/HalconWindowTest/obj/Debug/HalconWindow.csproj.GenerateResource.Cache index b0f4341..70ddc56 100644 Binary files a/HalconWindowTest/obj/Debug/HalconWindow.csproj.GenerateResource.Cache and b/HalconWindowTest/obj/Debug/HalconWindow.csproj.GenerateResource.Cache differ diff --git a/HalconWindowTest/obj/Debug/HalconWindow.exe b/HalconWindowTest/obj/Debug/HalconWindow.exe index 8772b38..cd7cd1a 100644 Binary files a/HalconWindowTest/obj/Debug/HalconWindow.exe and b/HalconWindowTest/obj/Debug/HalconWindow.exe differ diff --git a/HalconWindowTest/obj/Debug/HalconWindow.pdb b/HalconWindowTest/obj/Debug/HalconWindow.pdb index a82c59d..db55f5a 100644 Binary files a/HalconWindowTest/obj/Debug/HalconWindow.pdb and b/HalconWindowTest/obj/Debug/HalconWindow.pdb differ diff --git a/ToolBase/bin/Debug/CommonMethods.dll b/ToolBase/bin/Debug/CommonMethods.dll index f0d1ddc..11b7275 100644 Binary files a/ToolBase/bin/Debug/CommonMethods.dll and b/ToolBase/bin/Debug/CommonMethods.dll differ diff --git a/ToolBase/bin/Debug/CommonMethods.pdb b/ToolBase/bin/Debug/CommonMethods.pdb index 8f9602f..13bff77 100644 Binary files a/ToolBase/bin/Debug/CommonMethods.pdb and b/ToolBase/bin/Debug/CommonMethods.pdb differ diff --git a/ToolBase/bin/Debug/ToolBase.dll b/ToolBase/bin/Debug/ToolBase.dll index a83f146..ad1ac8f 100644 Binary files a/ToolBase/bin/Debug/ToolBase.dll and b/ToolBase/bin/Debug/ToolBase.dll differ diff --git a/ToolBase/bin/Debug/ToolBase.pdb b/ToolBase/bin/Debug/ToolBase.pdb index e60866c..cb221d8 100644 Binary files a/ToolBase/bin/Debug/ToolBase.pdb and b/ToolBase/bin/Debug/ToolBase.pdb differ diff --git a/ToolBase/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache b/ToolBase/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache index 73a61ae..93a4486 100644 Binary files a/ToolBase/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache and b/ToolBase/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache differ diff --git a/ToolBase/obj/Debug/ToolBase.csprojResolveAssemblyReference.cache b/ToolBase/obj/Debug/ToolBase.csprojResolveAssemblyReference.cache index e1c58a6..a25c3bd 100644 Binary files a/ToolBase/obj/Debug/ToolBase.csprojResolveAssemblyReference.cache and b/ToolBase/obj/Debug/ToolBase.csprojResolveAssemblyReference.cache differ diff --git a/ToolBase/obj/Debug/ToolBase.dll b/ToolBase/obj/Debug/ToolBase.dll index a83f146..ad1ac8f 100644 Binary files a/ToolBase/obj/Debug/ToolBase.dll and b/ToolBase/obj/Debug/ToolBase.dll differ diff --git a/ToolBase/obj/Debug/ToolBase.pdb b/ToolBase/obj/Debug/ToolBase.pdb index e60866c..cb221d8 100644 Binary files a/ToolBase/obj/Debug/ToolBase.pdb and b/ToolBase/obj/Debug/ToolBase.pdb differ diff --git a/ToolBase/obj/Debug/build.force b/ToolBase/obj/Debug/build.force new file mode 100644 index 0000000..e69de29 diff --git a/ToolListRun/CaliperRun.cs b/ToolListRun/CaliperRun.cs new file mode 100644 index 0000000..3ffccf7 --- /dev/null +++ b/ToolListRun/CaliperRun.cs @@ -0,0 +1,71 @@ +using System; +using System.Collections.Generic; +using System.Drawing; +using System.Linq; +using System.Text; +using System.Text.RegularExpressions; +using System.Threading.Tasks; +using System.Windows.Forms; +using CaliperTool; +using CommonMethods; +using HalconDotNet; +using VisionEdit; +using VisionEdit.FormLib; + +namespace ToolListRun +{ + public class CaliperRun + { + public void ToolRun(int toolIndex, int inputItemNum, TreeNode selectNode, FormLog myFormLog, FormImageWindow myFormWindow, List L_toolList, VisionJob myVisionJob) + { + Caliper myCaliper = (Caliper)L_toolList[toolIndex].tool; + for (int j = 0; j < inputItemNum; j++) + { + if (L_toolList[toolIndex].toolInput[j].IOName == "InputImage" && L_toolList[toolIndex].GetInput(L_toolList[toolIndex].toolInput[j].IOName).value == null) + { + selectNode.ForeColor = Color.Red; + myFormLog.ShowLog(L_toolList[toolIndex].toolName + " 无输入图像"); + break; + } + else + { + if (L_toolList[toolIndex].GetInput(L_toolList[toolIndex].toolInput[j].IOName).value != null) + { + string sourceFrom = L_toolList[toolIndex].GetInput(L_toolList[toolIndex].toolInput[j].IOName).value.ToString(); + string sourceToolName = Regex.Split(sourceFrom, " . ")[0]; + sourceToolName = sourceToolName.Substring(3, Regex.Split(sourceFrom, " . ")[0].Length - 3); + string toolItem = Regex.Split(sourceFrom, " . ")[1]; + if (L_toolList[toolIndex].toolInput[j].IOName == "InputImage") + { + myCaliper.inputImage = myVisionJob.GetToolInfoByToolName(myVisionJob.JobName, sourceToolName).GetOutput(toolItem).value as HObject; + } + if (L_toolList[toolIndex].toolInput[j].IOName == "inputCenterRow") + { + myCaliper.expectRecStartRow = myVisionJob.GetToolInfoByToolName(myVisionJob.JobName, sourceToolName).GetOutput(toolItem).value as HTuple; + } + if (L_toolList[toolIndex].toolInput[j].IOName == "inputCenterCol") + { + myCaliper.expectRecStartColumn = myVisionJob.GetToolInfoByToolName(myVisionJob.JobName, sourceToolName).GetOutput(toolItem).value as HTuple; + } + if (L_toolList[toolIndex].toolInput[j].IOName == "inputPhi") + { + myCaliper.expectAngle = myVisionJob.GetToolInfoByToolName(myVisionJob.JobName, sourceToolName).GetOutput(toolItem).value as HTuple; + } + + } + } + } + myCaliper.Run(SoftwareRunState.Release); + if (myCaliper.toolRunStatu == ToolRunStatu.Succeed) + { + myCaliper.DispMainWindow(myFormWindow.myHWindow); + myVisionJob.FormLogDisp(L_toolList[toolIndex].toolName + " 运行成功", Color.Green, selectNode); + } + else + { + myVisionJob.FormLogDisp(L_toolList[toolIndex].toolName + " 运行失败", Color.Red, selectNode); + } + } + + } +} diff --git a/ToolListRun/Properties/AssemblyInfo.cs b/ToolListRun/Properties/AssemblyInfo.cs new file mode 100644 index 0000000..efe591d --- /dev/null +++ b/ToolListRun/Properties/AssemblyInfo.cs @@ -0,0 +1,36 @@ +using System.Reflection; +using System.Runtime.CompilerServices; +using System.Runtime.InteropServices; + +// 有关程序集的一般信息由以下 +// 控制。更改这些特性值可修改 +// 与程序集关联的信息。 +[assembly: AssemblyTitle("ToolListRun")] +[assembly: AssemblyDescription("")] +[assembly: AssemblyConfiguration("")] +[assembly: AssemblyCompany("")] +[assembly: AssemblyProduct("ToolListRun")] +[assembly: AssemblyCopyright("Copyright © 2019")] +[assembly: AssemblyTrademark("")] +[assembly: AssemblyCulture("")] + +//将 ComVisible 设置为 false 将使此程序集中的类型 +//对 COM 组件不可见。 如果需要从 COM 访问此程序集中的类型， +//请将此类型的 ComVisible 特性设置为 true。 +[assembly: ComVisible(false)] + +// 如果此项目向 COM 公开，则下列 GUID 用于类型库的 ID +[assembly: Guid("cdb92f0e-2065-4116-874d-3142fa19c2e6")] + +// 程序集的版本信息由下列四个值组成: +// +// 主版本 +// 次版本 +// 生成号 +// 修订号 +// +//可以指定所有这些值，也可以使用“生成号”和“修订号”的默认值， +// 方法是按如下所示使用“*”: : +// [assembly: AssemblyVersion("1.0.*")] +[assembly: AssemblyVersion("1.0.0.0")] +[assembly: AssemblyFileVersion("1.0.0.0")] diff --git a/ToolListRun/ToolListRun.csproj b/ToolListRun/ToolListRun.csproj new file mode 100644 index 0000000..34a5186 --- /dev/null +++ b/ToolListRun/ToolListRun.csproj @@ -0,0 +1,81 @@ + + + + + Debug + AnyCPU + {CDB92F0E-2065-4116-874D-3142FA19C2E6} + Library + Properties + ToolListRun + ToolListRun + v4.5.2 + 512 + + + true + full + false + bin\Debug\ + DEBUG;TRACE + prompt + 4 + + + pdbonly + true + bin\Release\ + TRACE + prompt + 4 + + + + C:\Program Files\MVTec\HALCON-19.05-Progress\bin\dotnet20\halcondotnet.dll + + + + + + + + + + + + + + E:\VisionAndMotionPro V0.0.0.3\VisionAndMotionPro V0.0.0.3\VisionAndMotion\bin\Debug\WeifenLuo.WinFormsUI.Docking.dll + + + + + + + + + {AABF8D49-FA00-4E25-9410-4A573D48DAB1} + CaliperTool + + + {1C8D0DDC-2086-48A9-9586-F2B643E2FC54} + CommonHelper + + + {4ADC75AE-59C7-4D36-B675-A6CE51B6F5BA} + HalconWindow + + + {2CD1B0C2-D64A-4DA4-8A9E-64D5AB35DE25} + VisionEdit + + + + + \ No newline at end of file diff --git a/ToolListRun/bin/Debug/CaliperTool.dll b/ToolListRun/bin/Debug/CaliperTool.dll new file mode 100644 index 0000000..bcce671 Binary files /dev/null and b/ToolListRun/bin/Debug/CaliperTool.dll differ diff --git a/ToolListRun/bin/Debug/CaliperTool.pdb b/ToolListRun/bin/Debug/CaliperTool.pdb new file mode 100644 index 0000000..a470bfb Binary files /dev/null and b/ToolListRun/bin/Debug/CaliperTool.pdb differ diff --git a/ToolListRun/bin/Debug/CommonMethods.dll b/ToolListRun/bin/Debug/CommonMethods.dll new file mode 100644 index 0000000..515b730 Binary files /dev/null and b/ToolListRun/bin/Debug/CommonMethods.dll differ diff --git a/ToolListRun/bin/Debug/CommonMethods.pdb b/ToolListRun/bin/Debug/CommonMethods.pdb new file mode 100644 index 0000000..77133ea Binary files /dev/null and b/ToolListRun/bin/Debug/CommonMethods.pdb differ diff --git a/ToolListRun/bin/Debug/DataStruct.dll b/ToolListRun/bin/Debug/DataStruct.dll new file mode 100644 index 0000000..9b259a9 Binary files /dev/null and b/ToolListRun/bin/Debug/DataStruct.dll differ diff --git a/ToolListRun/bin/Debug/DataStruct.pdb b/ToolListRun/bin/Debug/DataStruct.pdb new file mode 100644 index 0000000..abc46fb Binary files /dev/null and b/ToolListRun/bin/Debug/DataStruct.pdb differ diff --git a/ToolListRun/bin/Debug/DevComponents.DotNetBar2.dll b/ToolListRun/bin/Debug/DevComponents.DotNetBar2.dll new file mode 100644 index 0000000..c9ac128 Binary files /dev/null and b/ToolListRun/bin/Debug/DevComponents.DotNetBar2.dll differ diff --git a/ToolListRun/bin/Debug/DevComponents.DotNetBar2.xml b/ToolListRun/bin/Debug/DevComponents.DotNetBar2.xml new file mode 100644 index 0000000..7605853 --- /dev/null +++ b/ToolListRun/bin/Debug/DevComponents.DotNetBar2.xml @@ -0,0 +1,81015 @@ + + + + DevComponents.DotNetBar2 + + + + + Represents advanced multi-column Tree control. + + + + + Specifies the notification interface that node uses to communicate status changes to it's parent tree. + + + + Called when Node.Expanded property has changed. + Node which Expanded property has changed. + + + Called before node is collapsed + Context information. + + + Called before node is expanded + Context information. + + + Called after node is collapsed. + Context information. + + + Called after node is expanded + Context information + + + + Required designer variable. + + + + + Raises Render event. + + Provides event arguments. + + + Creates new instance of the class. + + + + Clean up any resources being used. + + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Gets the current renderer used by the control. + + Reference to the TreeRenderer used by the control. + + + + Creates the Graphics object for the control. + + The Graphics object for the control. + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Invalidates node bounds on canvas. + + Reference node. + + + + Invalidates node bounds on canvas. + + Reference node. + + + + Finds the node based on the Node.Name property. + + Name of the node to find. + Reference to a node with given name or null if node cannot be found. + + + + Finds the node based on the Node.DataKey property. + + Data key to look for. + Reference to a node with given key or null if node cannot be found. + + + + Finds the node based on the Node.BindingIndex property. + + Index to look for. + Reference to a node with given key or null if node cannot be found. + + + + Finds the first node that starts with the specified text. Node.Text property is searched. + + Partial text to look for + Reference to a node or null if no node is found. + + + + Finds the first node where each Node.Cell[0:n].Text value starts with the + respective value found in the comma delimited 'text' string. + + Comma delimited partial text to look for + Reference to a node or null if no node is found. + + + + Finds the first node that starts with the specified text. Node.Text property is searched. + + Partial text to look for + Controls whether case insensitive search is performed + Reference to a node or null if no node is found. + + + + Finds the first node where each Node.Cell[0:n].Text value starts with the + respective value found in the comma delimited 'text' string. + + Comma delimited partial text to look for + Controls whether case insensitive search is performed + Reference to a node or null if no node is found. + + + + Finds the first node that starts with the specified text. Node.Text property is searched. + + Partial text to look for + Reference node to start searching from + Controls whether case insensitive search is performed + Reference to a node or null if no node is found. + + + + Finds the first node where each Node.Cell[0:n].Text value starts with the + respective value found in the comma delimited 'text' string. + + Comma delimited partial text to look for + Reference node to start searching from + Controls whether case insensitive search is performed + Reference to a node or null if no node is found. + + + + Indicates whether SelectionBoxFillColor should be serialized. Used by windows forms designer design-time support. + + + + + Resets SelectionBoxFillColor to it's default value. Used by windows forms designer design-time support. + + + + + Indicates whether ExpandBorderColor should be serialized. Used by windows forms designer design-time support. + + + + + Resets ExpandBorderColor to it's default value. Used by windows forms designer design-time support. + + + + + Indicates whether ExpandBackColor should be serialized. Used by windows forms designer design-time support. + + + + + Resets ExpandBackColor to it's default value. Used by windows forms designer design-time support. + + + + + Indicates whether ExpandBackColor2 should be serialized. Used by windows forms designer design-time support. + + + + + Resets ExpandBackColor2 to it's default value. Used by windows forms designer design-time support. + + + + + Indicates whether ExpandLineColor should be serialized. Used by windows forms designer design-time support. + + + + + Resets ExpandLineColor to it's default value. Used by windows forms designer design-time support. + + + + + Indicates whether CommandBackColor should be serialized. Used by windows forms designer design-time support. + + + + + Resets CommandBackColor to it's default value. Used by windows forms designer design-time support. + + + + + Indicates whether CommandBackColor2 should be serialized. Used by windows forms designer design-time support. + + + + + Resets CommandBackColor2 to it's default value. Used by windows forms designer design-time support. + + + + + Indicates whether CommandForeColor should be serialized. Used by windows forms designer design-time support. + + + + + Resets CommandForeColor to it's default value. Used by windows forms designer design-time support. + + + + + Indicates whether CommandMouseOverBackColor should be serialized. Used by windows forms designer design-time support. + + + + + Resets CommandMouseOverBackColor to it's default value. Used by windows forms designer design-time support. + + + + + Indicates whether CommandMouseOverBackColor2 should be serialized. Used by windows forms designer design-time support. + + + + + Resets CommandMouseOverBackColor2 to it's default value. Used by windows forms designer design-time support. + + + + + Indicates whether CommandMouseOverForeColor should be serialized. Used by windows forms designer design-time support. + + + + + Resets CommandMouseOverForeColor to it's default value. Used by windows forms designer design-time support. + + + + + Returns the zero based flat index of the node. Flat index is the index of the node as if tree structure + has been flattened into the list. + + Reference to the node to return index for. + Zero based node index or -1 if index cannot be determined. + + + + Returns node based on the flat index. Flat index is the index of the node as if tree structure + has been flattened into the list. + + Index to return node for. + Reference to a node or null if node at specified index cannot be found. + + + + Returns color scheme part color if set otherwise returns color passed in. + + Color. + Color scheme part. + Color. + + + + Collapses all nodes in a tree. + + + + + Expands all the tree nodes. + + + + + Paints control to canvas. This method might be used for print output. + + Graphics object to paint control to. + Indicates whether to paint control background. + + + + Paints control to canvas. This method might be used for print output. + + Graphics object to paint control to. + Indicates whether to paint control background. + Indicates clipping rectangle. Nodes outside of clipping rectangle will not be painted. You can pass Rectangle.Empty and all nodes will be painted. + + + + Processes the keyboard character and executes the search through the nodes. + + Character to process. + + + + + Raises ColumnResized event. + + ColumnHeader that was resized. + Event arguments + + + + Raises ColumnMoved event. + + ColumnHeader that was moved. + Provides event arguments. + + + + Raises ColumnResizing event. + + Column being resized + Event arguments + + + + Deselect specified node. Use this method when multiple node selection is enabled to deselect single node or all nodes. + + Reference to node to select or null to deselect all selected nodes. + Action that is selecting the node. + + + + Raises SelectionChanged event. + + Event arguments + + + + Raises CellSelected event. + + Event arguments. + + + + Raises CellUnselected event. + + Event arguments. + + + + Selected specified node. + + Node to select. + Action that is selecting the node. + + + + Invalidates the size for all top-level nodes and their sub-nodes. + + + + + Invalidates the size for a node and its sub-nodes. + + Node to invalidate size for. + + + + Ensures that selected node is visible i.e. that all parents of the selected node are expanded. If not selects the first parent node not expanded. + + + + + Starts editing specified cell, places the cell into the edit mode. + + Cell to start editing. + Action that is a cause for the edit. + + + + Starts editing specified cell, places the cell into the edit mode. + + Cell to start editing. + Action that is a cause for the edit. + Specifies the text to be edited instead of the text of the cell. Passing the NULL value will edit the text of the cell. + + + + Called just before cell editor is released for editing. + + Reference to the cell being edited. + Reference to the editor control. + + + + Raises the ProvideCustomCellEditor event. + + Event arguments. + + + + Ends cell editing. + + Specifies which action is cause for end of the editing. + Returns true if edits were applied to the cell or false otherwise. + + + + Ends cell editing. + + Specifies which action is cause for end of the editing. + Returns true if edits were applied to the cell or false otherwise. + + + + Raises the AfterCellEditComplete event. + + Provides information about event. + + + + Cancels the cell editing if it is in progress. + + Specifies which action is cause for canceling of editing. + + + + Raises BeforeNodeInsert event + + Node that is about to be inserted + Source of the event + + + + Raises AfterNodeInsert event + + Node that is inserted + Source of the event + + + + Raises BeforeNodeRemove event + + Node that is about to be removed + Source of the event + + + + Raises AfterNodeRemove event + + Node that is removed + Source of the event + + + + Called after node has been removed + + Node that is removed + Source of the event + + + + Invokes BeforeNodeDrop event. If overriden base implementation must be called in order for event to fire. + + Provides information about event + + + + Invokes AfterNodeDrop event. If overridden base implementation must be called in order for event to fire. + + Provides information about event + + + + Invokes NodeMouseDown event. If overridden base implementation must be called in order for event to fire. + + Provides information about event + + + + Invokes NodeMouseUp event. If overridden base implementation must be called in order for event to fire. + + Provides information about event + + + + Invokes NodeMouseMove event. If overridden base implementation must be called in order for event to fire. + + Provides information about event + + + + Invokes NodeClick event. If overridden base implementation must be called in order for event to fire. + + Provides information about event + + + + Invokes NodeDoubleClick event. If overridden base implementation must be called in order for event to fire. + + Provides information about event + + + + Invokes NodeMouseEnter event. If overriden base implementation must be called in order for event to fire. + + Provides information about event + + + + Invokes NodeMouseLeave event. If overriden base implementation must be called in order for event to fire. + + Provides information about event + + + + Invokes NodeMouseHover event. If overriden base implementation must be called in order for event to fire. + + Provides information about event + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Save nodes to XmlDocument. New Node AdvTree is created and nodes are serialized into it. + + Reference to an instance of XmlDocument object + + + + Saves nodes to a file. + + File name to save nodes to. + + + + Saves nodes to specified stream. + + Stream to save nodes to. + + + + Saves nodes to specified writer. + + Writer to save nodes to. + + + + Saves nodes to specified writer. + + Writer to save nodes to. + + + + Load nodes from file. + + File to load nodes from + + + + Load nodes from stream. + + Stream to load from + + + + Load nodes from reader. + + Reader to load from. + + + + Load nodes from reader. + + Reader to load from. + + + + Load nodes from an XmlDocument object. + + Document to load Nodes from. + + + + Forces the control to invalidate its client area and immediately redraw itself + and any child controls. Note however that this method will node do anything if refresh + is suspended as result of call to BeginUpdate method without corresponding EndUpdate + call or if SuspendPaint property is set to true. + + + + + Disables any redrawing of the tree control. To maintain performance while items + are added one at a time to the control, call the BeginUpdate method. The BeginUpdate + method prevents the control from painting until the + EndUpdate method is called. + + + + + Enables the redrawing of the tree view. To maintain performance while items are + added one at a time to the control, call the BeginUpdate + method. The BeginUpdate method prevents the control from painting until the EndUpdate + method is called. + + + Call to EndUpdate will enable the layout and painting in tree control. If there + are any pending layouts the EndUpdate will call + RecalcLayout method to perform the layout and it will + repaint the control. + + + + + Enables the redrawing of the tree view. To maintain performance while items are + added one at a time to the control, call the BeginUpdate + method. The BeginUpdate method prevents the control from painting until the EndUpdate + method is called. + + Gets or sets whether layout and refresh of control is performed if there are no other update blocks pending. + + + + Retrieves the tree node that is at the specified location. + + The Node at the specified point, in tree view coordinates. + + You can pass the MouseEventArgs.X and MouseEventArgs.Y coordinates of the + MouseDown event as the x and y parameters. + + The Point to evaluate and retrieve the node from. + + + + Retrieves the tree node that is at the specified location. + + The TreeNode at the specified location, in tree view coordinates. + + You can pass the MouseEventArgs.X and MouseEventArgs.Y coordinates of the + MouseDown event as the x and y parameters. + + The X position to evaluate and retrieve the node from. + The Y position to evaluate and retrieve the node from. + + + + Retrieves the tree node that is at the specified location. + + The TreeNode at the specified location, in tree view coordinates. + + You can pass the MouseEventArgs.X and MouseEventArgs.Y coordinates of the + MouseDown event as the x and y parameters. + + The X position to evaluate and retrieve the node from. + The Y position to evaluate and retrieve the node from. + Whether to enumerated displayed nodes only. + + + + Retrieves the tree node that is at the specified vertical location. + + The TreeNode at the specified location, in tree view coordinates. + + You can pass the MouseEventArgs.Y coordinates of the + MouseDown event as the y parameter. + + The Y position to evaluate and retrieve the node from. + + + + Retrieves the node cell that is at the specified location. + + The Point to evaluate and retrieve the cell from. + The Cell at the specified point, in tree view coordinates. + + + + Retrieves the node cell that is at the specified location. + + The X position to evaluate and retrieve the cell from. + The Y position to evaluate and retrieve the cell from. + The Cell at the specified point, in tree view coordinates. + + + + Retrieves the node cell that is at the specified location. + + The X position to evaluate and retrieve the cell from. + The Y position to evaluate and retrieve the cell from. + Whether to enumerated displayed nodes only. + The Cell at the specified point, in tree view coordinates. + + + Applies any layout changes to the tree control. + + Layout will not be performed if BeginUpdate is called. Any calls to the + RecalcLayout will return without executing requested layout operation. + + + + + Recalculates layout for the tree control. Not affected by BeginUpdate call. + + + + + Returns translation matrix for current Zoom. Translation matrix is used to translate internal node coordinates to screen + coordinates when Zoom is not set to 1. + + Returns new instance of Matrix object. + + + + Returns layout based rectangle from screen rectangle. Layout based rectangle will be different + from screen rectangle when Zoom is not set to 1. This method will translate the screen rectangle enlarged by Zoom + to layout rectangle which does not have Zoom applied. + + Screen rectangle + Layout rectangle + + + + Returns mouse position which is translated if control Zoom is not equal 1 + + Mouse event arguments + Returns translated position + + + + Returns mouse position which is translated if control Zoom is not equal 1 + + Mouse position + Returns translated position + + + + Returns mouse position which is translated if control Zoom is not equal 1 + + X coordinate + Y coordinate + + + + + Returns rectangle translated to screen rectangle if Zoom is not equal 1. + + Rectangle to translate + Screen Rectangle + + + + Returns size translated to screen dimension if Zoom is not equal 1. + + Size to translate + Screen Size + + + + Raises ColumnHeaderMouseUp event. + + Reference to ColumnHeader + Event arguments + + + + Raises ColumnHeaderMouseDown event. + + Reference to ColumnHeader + Event arguments + + + + Calls OnBeforeCheck method which fired + OnBeforeCheck event. + + Event arguments. + + + Raises the BeforeCheck event. + + A AdvTreeCellBeforeCheckEventArgs that contains the event + data. + + + + + Calls OnAfterCheck method which fired + AfterCheck event. + + Event arguments. + + + Raises the AfterCheck event. + + A AdvTreeEventArgs that contains the event + data. + + + + + Invokes CommandButtonClick event. + + Context node. + Event arguments. + + + + Invokes DeserializeNode event. + + Provides more information about the event + + + + Invokes SerializeNode event. + + Provides more information about the event + + + + Invokes the MarkupLinkClick evcent. + + Sender of the event, usually instance Cell object. + Event arguments + + + + Raises the NodeDragFeedback event. + + Provides event arguments. + + + + Processes drag over event. + + Drag event arguments. + + + + Raises the NodeDragStart event. + + Reference to node being dragged. + Event parameters + + + + Raises BeforeNodeDragStart event. + + Provides event arguments. + + + + Returns the display root node. + + Instance of node or null if there is no display root node. + + + + Returns reference to the node involved in drag-drop operation if any. + + Reference to node object or null if there is no drag node. + + + + + This member supports the .NET Framework infrastructure and is not intended to be + used directly from your code. + + + + + This member supports the .NET Framework infrastructure and is not intended to be + used directly from your code. + + + + + Raises FormattingEnabledChanged event. + + Event arguments. + + + + Raises FormatStringChanged event. + + Event arguments. + + + + Raises FormatInfoChanged event. + + Event arguments. + + + + Raises the DataSourceChanged event. + + An EventArgs that contains the event data. + + + + Raises the DisplayMemberChanged event. + + An EventArgs that contains the event data. + + + + When overridden in a derived class, resynchronizes the item data with the contents of the data source. + + + + + Disposes all nodes in Nodes collection and clears it. + + + + + When overridden in a derived class, sets the specified array of objects in a collection in the derived class. + + An array of items. + + + + Raises the DataColumnCreated event. + + Provides event arguments. + + + + Raises the DataNodeCreated event. + + Provides event arguments. + + + + Creates a new node for the data item. + + Item to create node for. + New instance of the node. + + + + Raises the DataNodeCreated event. + + Provides event arguments. + + + + When overridden in a derived class, sets the object with the specified index in the derived class. + + The array index of the object. + The object. + + + + Called when ParentFieldName property has changed. + + + + + Called when GroupingMembers property has changed. + + + + + Raises the Format event. + + Event parameters + + + + Clears internal property descriptors cache when data-binding is used. In most cases it is not needed that you call this method. Do so only if instructed by DevComponents support. + + + + + Raises the SelectedIndexChanged event. + + Event arguments. + + + + Raises the ValueMemberChanged event. + + Event arguments. + + + + Raises the SelectedValueChanged event. + + Event arguments. + + + + Called when TouchEnabled property has changed. + + Old property value + New property value + + + + Occurs just before cell editor is released for editing. It allows you to customize any properties on edit control. + + + + + Occurs when mouse button is pressed over the column header. + + + + + Occurs when mouse button is released over the column header. + + + + + Occurs after the cell check box is checked. + + + + + Occurs before the cell check box is checked and provides opportunity to cancel the event. + + + + + Occurs after the tree node is collapsed. + + + + + Occurs before the tree node is collapsed. + + + + + Occurs after the tree node is expanded. + + + + + Occurs before the tree node is expanded. + + + + + Occurs when command button on node is clicked. + + + + + Occurs before cell is edited. The order of the cell editing events is as follows: + BeforeCellEdit, CellEditEnding, AfterCellEdit, AfterCellEditComplete. + + + + + Occurs just before the cell editing is ended. The text box for editing is still visible and you can cancel + the exit out of editing mode at this point. The order of the cell editing events is as follows: + BeforeCellEdit, CellEditEnding, AfterCellEdit, AfterCellEditComplete. + + + + + Occurs after cell editing has ended and before the new text entered by the user is assigned to the cell. You can abort the edits in this event. + The order of the cell editing events is as follows: + BeforeCellEdit, CellEditEnding, AfterCellEdit, AfterCellEditComplete. + + + + + Occurs after cell editing has been completed. This event cannot be canceled. + + + + + Occurs after node selection has changed. + + + + + Occurs before Node has been selected by user or through the SelectedNode property. Event can be cancelled. + + + + + Occurs after node has been selected by user or through the SelectedNode property. + + + + + Occurs after node has been deselected by user or through the SelectedNode or SelectedNodes properties. + + + + + Occurs before node has been removed from its parent. + + + + + Occurs after node has been removed from its parent. + + + + + Occurs before node is inserted or added as child node to parent node. + + + + + Occurs after node is inserted or added as child node. + + + + + Occurs when node drag & drop operation is initiated. + + + + + Occurs before internal node drag & drop support is initiated and allows you to cancel the drag & drop. + + + + + Occurs before Drag-Drop of a node is completed and gives you information about new parent of the node that is being dragged + as well as opportunity to cancel the operation. + + + + + Occurs while node is being dragged. You can handle this event to disable the drop at specific nodes or to even change the + drop location for the node by modifying event arguments. + + + + + Occurs after Drag-Drop of a node is completed. This operation cannot be cancelled. + + + + + Occurs when the mouse pointer is over the node and a mouse button is pressed. + + + + + Occurs when the mouse pointer is over the node and a mouse button is released. + + + + + Occurs when the mouse pointer is moved over the node. + + + + + Occurs when the mouse enters the node. + + + + + Occurs when the mouse leaves the node. + + + + + Occurs when the mouse hovers over the node. + + + + + Occurs when the node is clicked with left mouse button. If you need to know more information like if another mouse button is clicked etc. use + NodeMouseDown event. + + + + + Occurs when the node is double-clicked. + + + + + Occurs after an node has been serialized to XmlElement and provides you with opportunity to add any custom data + to serialized XML. This allows you to serialize any data associated with the node and load it back up in DeserializeNode event. + + + To serialize custom data to XML definition control creates handle this event and use CustomXmlElement + property on SerializeNodeEventArgs to add new nodes or set attributes with custom data you want saved. + + + + + Occurs after an node has been de-serialized (loaded) from XmlElement and provides you with opportunity to load any custom data + you have serialized during SerializeItem event. + + + To de-serialize custom data from XML definition handle this event and use CustomXmlElement + property on SerializeItemEventArgs to retrieve any data you saved in SerializeNode event. + + + + + Occurs when hyperlink in text-markup is clicked. + + + + + Occurs when cell with custom editor type is about to be edited by user. Handle this event to provide + custom editors. + + + + + Occurs when the DataSource changes. + + + + + Occurs when the DisplayMembers property changes. + + + + + Occurs when the control is bound to a data value that need to be converted. + + + + + Occurs when FormattingEnabled property changes. + + + + + Occurs when FormatString property changes. + + + + + Occurs when FormatInfo property has changed. + + + + + Occurs when a Node for an data-bound object item has been created and provides you with opportunity to modify the node. + + + + + Occurs when a group Node is created as result of GroupingMembers property setting and provides you with opportunity to modify the node. + + + + + Occurs when value of ValueMember property has changed. + + + + + Occurs when value of SelectedValue property has changed. + + + + + Occurs when value of SelectedIndex property has changed. + + + + + Occurs when ColumnHeader is automatically created by control as result of data binding and provides you with opportunity to modify it. + + + + + Occurs after column has been resized by end-user. + + + + + Occurs while column is being resized by end-user. + + + + + Occurs after cell has been selected. + + + + + Occurs after cell has been unselected. + + + + + Occurs after users has moved the column. + + + + + Occurs while tree control is being rendered. + + + + + Indicates whether nodes are disposed when control is disposed. + + + + + Indicates whether sorting of node collection sorts child nodes as well. Default value is false. + + + + + Gets or sets whether tooltips are shown when mouse is over the cell when Tooltip property is set. + + + + + Gets the column header control which renderes the columns. + + + + + Gets or sets the scroll-bar visual style. + + + + + Gets or sets the proposed size of the tile in Tile view. The size of the tile might be larger than specified if Style assigned to node, cells adds padding, margins etc. or if Node.Image or font is greater than width or height specified here. + + + + + Gets or sets a value indicating whether the selected tree node remains highlighted even when the tree control has lost the focus. + + + + + Gets whether keyboard focus is within the control. + + + + + Gets or sets whether cell editing is completed when control loses input focus. Default value is true. + + + + + Gets or sets the reference to DotNetBar ContextMenuBar component which is used to provide context menu for nodes. This property + is automatically maintained by AdvTree. + + + + + Gets or sets zoom factor for the control. Default value is 1. To zoom display of the nodes for 20% set zoom factor to 1.2 + To zoom view 2 times set zoom factor to 2. Value must be greater than 0. Zoom is supported only when non-column tree setup is used. + Please note that Zoom functionality is designed only for very special use cases and only for + plain tree control setup which does not use editing, alternating row colors, drag & drop or any other + advanced functionality. + + + + + Gets the size of the tree. + + + + + Gets or sets custom node renderer. You can set this property to your custom renderer. When set the RenderMode should be set to Custom to enable + your custom renderer. To choose one of the system renderer use RenderMode property. Default value is null. + + + + + Gets or sets the render mode used to render all nodes. Default value is eNodeRenderMode.Default which indicates that system default renderer is used. + Note that if you specify custom renderer you need to set AdvTree.NodeRenderer property to your custom renderer. + + + + + Gets the style for the background of the control. + + + + + Gets or sets internal layout cell horizontal spacing. This property is for advanced internal use and you should not set it. + + + + + Gets or sets whether automatic drag and drop is enabled. Default value is true. + + + + + Gets or sets whether anti-alias smoothing is used while painting the tree. + + + + + Gets or sets the delimiter string that the tree node path uses. + + + + + Gets or sets whether user can resize the columns. Default value is true. + + + + + Gets or sets whether user can reorder the columns. Default value is false. + + + + + Gets the collection of column headers that appear in the tree. + + + By default there are no column headers defined. In that case tree control + functions as regular tree control where text has unrestricted width. + If you want to restrict the horizontal width of the text but not display + column header you can create one column and set its width to the width desired and + set its Visible property to false. + + + + + Gets or sets whether column headers are visible if they are defined through Columns collection. Default value is true. + + + + + Gets the collection of all style elements created for the tree. + + + + + Gets or sets default style for the node cell. + + + + + Gets or sets default style for the node cell when mouse is pressed. + + + + + Gets or sets default style for the node cell when mouse is over the cell. + + + + + Gets or sets default style for the node cell when cell is selected. + + + + + Gets or sets default style for the node cell when cell is disabled. + + + + + Gets or sets default style for the node when node is expanded. + + + + + Gets or sets default style for all nodes where style is not specified + explicity. + + + Name of the style assigned or null value indicating that no style is used. + Default value is null. + + + + + Gets or sets style for the node when node is selected. Note that this style is applied to the default node style. + + + Reference to the style assigned or null value indicating that no style is used. + Default value is null. + + + + + Gets or sets style for the node when mouse is over node. Note that this style is applied to the default node style. + + + Reference to the style assigned or null value indicating that no style is used. + Default value is null. + + + + + Gets the collection of tree nodes that are assigned to the tree view control. + + + A NodeCollection that represents the tree nodes + assigned to the tree control. + + + The Nodes property holds a collection of Node objects, each of which has a + Nodes property that can contain its own NodeCollection. + + + + + Gets or sets the vertical spacing between nodes in pixels. Default value is 3. + + + + + Gets or sets the horizontal spacing between nodes in pixels when control is in Tile layout. Default value is 4. + + + + + Gets or sets whether horizontal grid lines between each row are displayed. Default value is false. + + + + + Gets or sets whether column can be resized when mouse is over the column grid line and outside of the column header. + GridColumnLines must be set to true to make column lines visible. + + + + + Gets or sets whether grid lines are displayed when columns are defined. Default value is true. + + + + + Gets or sets the grid lines color. + + + + + Gets or sets the alternate row color applied to every other row. Default value is Color.Empty. + + + + + Gets or sets the background style for the child nodes columns. Background style defines the appearance of the column header background. + + + Reference to the style assigned to the column header. + + + + + Gets or sets the background style for the columns. Background style defines the appearance of the column header background. + + + Reference to the style assigned to the column header. + + ColumnStyleNormal Property + ColumnStyleMouseDown Property + ColumnStyleMouseOver Property + + + + Gets or sets the default style class assigned to the column headers. + + + Reference to the style assigned to the column header. + + + When style is not set on ColumnHeader objects then style setting from this property is used instead. + + ColumnStyleMouseDown Property + ColumnStyleMouseOver Property + + + + Gets or sets default style class assigned to the column which is applied when mouse + button is pressed over the header. + + + Name of the style assigned to the column. + + + When style is not set on ColumnHeader objects then style setting from this property is used instead. + + ColumnStyleNormal Property + ColumnStyleMouseOver Property + + + + Gets or sets default style class assigned to the column which is applied when mouse is + over the column. + + + Name of the style assigned to the column. + + + When style is not set on ColumnHeader objects then style setting from this property is used instead. + + ColumnStyleNormal Property + ColumnStyleMouseDown Property + + + + Gets collection that holds definition of column headers associated with nodes. + + + + + Gets or sets the tree node that is currently selected in the tree control. + + + If no Node is currently selected, the + SelectedNode property is a null reference (Nothing in Visual + Basic). + + + + + Gets or sets the collection of currently selected nodes in tree control. + + + + + Gets or sets whether multi-node selection is enabled. Default value is false. When + multi-selection is enabled use SelectedNodes property to retrive collection of selected nodes. + Use MultiSelectRule property to change the multi-node selection rule. + + + + + Gets or sets the rule that governs the multiple node selection. Default value indicates that only nodes + belonging to same parent can be multi-selected. + + + + + Returns reference to node layout object. + + + + + Returns reference to node display object. + + + + + Gets whether layout is suspended for tree control. Layout is suspended after + call to BeginUpdate method and it is resumed after the + call to EndUpdate method. + + + + + Gets whether control has layout operation pending on next paint or update. + + + + + Gets or sets whether paint operations are suspended for the control. You should use this method + if you need the RecalcLayout operations to proceed but you want to stop painting of the control. + + + + + Gets or sets the ImageList that contains the Image objects used by the tree nodes. + + + + + Gets or sets the image-list index value of the default image that is displayed by the tree nodes. + + + + + Gets or sets the custom image that is displayed instead default check box representation when check box in cell is checked. + + + + + Gets or sets the custom image that is displayed instead default check box representation when check box in cell is unchecked. + + + + + Gets or sets the custom image that is displayed instead default check box representation when check box in cell is in indeterminate state. + + + + + Gets or sets the NodeConnector object that describes the type of the connector used for + displaying connection between nested nodes. RootConnector property specifies the connector + between root node and it's imidate nested nodes. This property specifies connector for all other nested levels. + Default value is null. + + + You can use + Node.ParentConnector + property to specify per node connectors. + + + + + Gets or sets the NodeConnector object that describes the type of the connector used for + displaying connection between linked nodes. Connector specified here is used to display the connection + between nodes that are on the path to the selected node. When set you can use it to visually indicate the path to the currently selected node. + Default value is null. + + + + + Gets or sets the layout of the cells inside the node. Default value is Horizontal layout which + means that cell are positioned horizontally next to each other. + + + You can specify cell layout on each node by using + Node.CellLayout + property. + + + + + Gets or sets the layout of the cells inside the node. Default value is Horizontal layout which + means that cell are positioned horizontally next to each other. + + + You can specify cell layout on each node by using + Node.CellLayout + property. + + + + + Gets or sets the color scheme style. Color scheme provides predefined colors based on popular visual styles. + We recommend that you use "SchemePart" color settings since they maintain consistant look that is + based on target system color scheme setting. + + + + + Gets the reference to the color scheme object. + + + + + Gets or sets whether the content of the control is centered within the bounds of control. Default value is true. + + + + + Gets or sets whether per cell selection mode is enabled. In cell selection mode the selection box is drawn over selected cell only + instead of all cells in the node. + Default value is false. + + + + + Gets or sets whether selection appearance changes depending on whether control has input focus. Default value is true. Setting this value to false causes selection box to be rendered as if control has focus all the time. + + + + + Gets or sets the node selection box style. + + SelectionBox Property + SelectionBoxSize Property + SelectionBoxFillColor Property + SelectionBoxBorderColor Property + + + + Gets or sets the value that indicates whether selection box is drawn around the + selected node. Default value is true. Another way to provide the visual indication that + node is selected is by using selected state style properties like + NodeStyleSelected + and + CellStyleSelected. + + CellStyleSelected Property + NodeStyleSelected Property + + + + Gets or sets the size/thickness in pixel of the selection box drawn around selected + node. + + + + + Gets or sets whether node is selected when mouse is pressed anywhere within node vertical bounds. Default value is true. + + + When set to false the node is selected only when mouse is pressed over the node content. + + + + + Gets or sets the total node expand area width in pixels. The expand button with ExpandButtonSize is fitted into this area. Default value is 24. + + + + + Gets or sets the size of the expand button that is used to expand/collapse node. Default value is 8,8. + + + + + Gets or sets expand button border color. Note that setting ExpandBorderColorSchemePart property will override the value that you set here. + + + + + Gets or sets expand button color scheme border color. Setting + this property overrides the setting of the corresponding ExpandBorderColor property. + Color scheme colors are automatically managed and are based on current system colors. + That means if colors on the system change the color scheme will ensure that it's colors + are changed as well to fit in the color scheme of target system. Set this property to + eColorSchemePart.None to + specify explicit color to use through ExpandBorderColor property. + + + + + Gets or sets expand button back color. Note that setting ExpandBackColorSchemePart property will override the value that you set here. + + + + + Gets or sets expand button color scheme back color. Setting + this property overrides the setting of the corresponding ExpandBackColor property. + Color scheme colors are automatically managed and are based on current system colors. + That means if colors on the system change the color scheme will ensure that it's colors + are changed as well to fit in the color scheme of target system. Set this property to + eColorSchemePart.None to + specify explicit color to use through ExpandBackColor property. + + + + + Gets or sets expand button target gradientback color. Note that setting ExpandBackColor2SchemePart property will override the value that you set here. + + + + + Gets or sets expand button color scheme target gradient back color. Setting + this property overrides the setting of the corresponding ExpandBackColor2 property. + Color scheme colors are automatically managed and are based on current system colors. + That means if colors on the system change the color scheme will ensure that it's colors + are changed as well to fit in the color scheme of target system. Set this property to + eColorSchemePart.None to + specify explicit color to use through ExpandBackColor2 property. + + + + + Gets or sets expand button line color. Note that setting ExpandLineColorSchemePart property will override the value that you set here. + + + + + Gets or sets expand button color scheme line color. Setting + this property overrides the setting of the corresponding ExpandLineColor property. + Color scheme colors are automatically managed and are based on current system colors. + That means if colors on the system change the color scheme will ensure that it's colors + are changed as well to fit in the color scheme of target system. Set this property to + eColorSchemePart.None to + specify explicit color to use through ExpandLineColor property. + + + + + Gets or sets the expand button background gradient angle. + + + + + Gets or sets the expand button image which is used to indicate that node will be expanded. To use images as expand buttons you also need to set ExpandButtonType=eExpandButtonType.Image. + + + + + Gets or sets the expand button image which is used to indicate that node will be collapsed. To use images as expand buttons you also need to set ExpandButtonType=eExpandButtonType.Image. + + + + + Gets or sets the type of the expand button used to expand/collapse nodes. + + + + + Gets or sets the display root node. Setting this property allows you to use any + Node as root display node. Default value is Null which means that first node from + AdvTree.Nodes collection is used as display root node. + + + + + Gets or sets the width of the command button. Default value is 10 pixels. + + + + + Gets or sets command button back color. Note that setting CommandBackColorSchemePart property will override the value that you set here. + + + + + Gets or sets command button color scheme back color. Setting + this property overrides the setting of the corresponding CommandBackColor property. + Color scheme colors are automatically managed and are based on current system colors. + That means if colors on the system change the color scheme will ensure that it's colors + are changed as well to fit in the color scheme of target system. Set this property to + eColorSchemePart.None to + specify explicit color to use through CommandBackColor property. + + + + + Gets or sets command button target gradient back color. Note that setting CommandBackColor2SchemePart property will override the value that you set here. + + + + + Gets or sets command button color scheme target gradient back color. Setting + this property overrides the setting of the corresponding CommandBackColor2 property. + Color scheme colors are automatically managed and are based on current system colors. + That means if colors on the system change the color scheme will ensure that it's colors + are changed as well to fit in the color scheme of target system. Set this property to + eColorSchemePart.None to + specify explicit color to use through CommandBackColor2 property. + + + + + Gets or sets command button foreground color. Note that setting CommandForeColorSchemePart property will override the value that you set here. + + + + + Gets or sets command button color scheme foreground color. Setting + this property overrides the setting of the corresponding CommandForeColor property. + Color scheme colors are automatically managed and are based on current system colors. + That means if colors on the system change the color scheme will ensure that it's colors + are changed as well to fit in the color scheme of target system. Set this property to + eColorSchemePart.None to + specify explicit color to use through CommandForeColor property. + + + + + Gets or sets the command button background gradient angle. + + + + + Gets or sets command button mouse over back color. Note that setting CommandMouseOverBackColorSchemePart property will override the value that you set here. + + + + + Gets or sets command button color scheme mouse over back color. Setting + this property overrides the setting of the corresponding CommandMouseOverBackColor property. + Color scheme colors are automatically managed and are based on current system colors. + That means if colors on the system change the color scheme will ensure that it's colors + are changed as well to fit in the color scheme of target system. Set this property to + eColorSchemePart.None to + specify explicit color to use through CommandMouseOverBackColor property. + + + + + Gets or sets command button mouse over target gradient back color. Note that setting CommandMouseOverBackColor2SchemePart property will override the value that you set here. + + + + + Gets or sets command button mouse over color scheme target gradient back color. Setting + this property overrides the setting of the corresponding CommandMouseOverBackColor2 property. + Color scheme colors are automatically managed and are based on current system colors. + That means if colors on the system change the color scheme will ensure that it's colors + are changed as well to fit in the color scheme of target system. Set this property to + eColorSchemePart.None to + specify explicit color to use through CommandMouseOverBackColor2 property. + + + + + Gets or sets command button mouse over foreground color. Note that setting CommandMouseOverForeColorSchemePart property will override the value that you set here. + + + + + Gets or sets command button mouse over color scheme foreground color. Setting + this property overrides the setting of the corresponding CommandMouseOverForeColor property. + Color scheme colors are automatically managed and are based on current system colors. + That means if colors on the system change the color scheme will ensure that it's colors + are changed as well to fit in the color scheme of target system. Set this property to + eColorSchemePart.None to + specify explicit color to use through CommandMouseOverForeColor property. + + + + + Gets or sets the command button mouse over background gradient angle. + + + + + Gets or sets a value indicating whether the label text of the node cells can be edited. Default value is false. + + + + + Returns whether cell editing is in progress. + + + + + Gets or sets whether keyboard incremental search through Node.Text property is enabled. Default value is true. + + + + + Gets or sets the keyboard search buffer expiration timeout. Default value is 1000 which indicates that + key pressed within 1 second will add to the search buffer and control will be searched for node text + that begins with resulting string. Setting this value to 0 will disable the search buffer. + + + + + Indicates whether search buffer is auto-cleared regardless of the expiration timeout if node is not found using current buffer content. + + + + + Gets or sets whether double-clicking the node will toggle its expanded state. Default value is true. + + + + + Gets or sets whether node is highlighted when mouse enters the node. Default value is false. + + + There are two ways to enable the node hot-tracking. You can set the HotTracking property to true in which case the + mouse tracking is enabled using system colors specified in TreeColorTable. You can also define the NodeStyleMouseOver + style which gets applied to the node when mouse is over the node. + + + + + Gets whether tree is in process of moving the column in response to user finishing the column move action. + + + + + Gets or sets how control positions the items. Default value is standard TreeView layout. + + + + + Gets or sets the color of the group divider line when in tile view. + + + + + Returns the reference to the node mouse is currently over or null (Nothing) if mouse is not over any node in tree. + + + + + Specifies the mouse cursor displayed when mouse is over the cell. Default value + is null which means that default control cursor is used. + + + To specify cursor for each individual cell use + Cell.Cursor property. + + + + + Gets reference to array of Cell objects that have HostedControl property set. + + + + + Gets or sets whether hosted controls are clipped so they don't overlap the control borders. Default value is true. + + + + + Gets or sets whether control border needs to be updated by calling UpdateControlBorderPanel() + + + + + Gets the reference to internal vertical scroll-bar control if one is created or null if no scrollbar is visible. + + + + + Gets or sets whether Vertical Scroll-bar is shown if needed because content of the control exceeds available height. Default value is true. + + + + + Gets or sets whether Horizontal Scroll-bar is shown if needed because content of the control exceeds available width. Default value is true. + + + + + Gets the reference to internal horizontal scroll-bar control if one is created or null if no scrollbar is visible. + + + + + Gets or sets a value indicating whether the tree control enables the user to scroll to any nodes placed outside of its visible boundaries. + This property is managed internally by AdvTree control and should not be modified. + + + + + Gets or sets the minimum size of the auto-scroll. Returns a Size that represents the minimum height and width of the scrolling area in pixels. + This property is managed internally by AdvTree control and should not be modified. + + + + + Gets or sets the location of the auto-scroll position. + + + + + Gets the list of all checked nodes in tree including child nodes. + + + + + Gets or sets the offset in pixels from node's X position that is used during drag & drop operation to indicate that + dragged node is dropped as child node of the parent's node. + + + + + Gets or sets whether drag & drop internal implementation allows the copying of the node being dragged when CTRL key is pressed. + + + + + Gets or sets whether control accepts the dragged nodes from other AdvTree controls. Default value is true. + + + + + Gets or sets the distance to indent each of the child tree node levels. Default value is 16. + + + + + Indicates whether drop marker is displayed during drag-drop operation. + + + + + Gets or sets whether drag and drop operation is in progress. This member supports + the AdvTree infrastructure and is not intended to be used directly from your + code. + + + + + Gets or sets whether number of nodes being dragged is displayed on drag node preview. Default value is true. + + + + + Gets or sets whether multiple nodes drag & drop is enabled. Default value is true. + + + + + Indicates whether AutoScrollPosition is reset to 0,0 when all nodes are cleared from the tree. Default value is true. + + + + + Gets or sets the comma separated list of property or column names to display on popup tree control. + + + + + Gets or sets the data source for the ComboTree. Expected is an object that implements the IList or IListSource interfaces, + such as a DataSet or an Array. The default is null. + + + + + Gets or sets a value indicating whether formatting is applied to the DisplayMembers property of the control. + + + + + Gets or sets the format-specifier characters that indicate how a value is to be displayed. + + + + + Gets or sets the IFormatProvider that provides custom formatting behavior. + + + + + Gets or sets comma separated field or property names that holds the value that is used to identify node and parent node. Format expected is: FieldNodeId,ParentNodeFieldId. For example if your table represents departments, you have DepartmentId field which uniquely identifies a department and ParentDepartmentId field which identifies parent of the department if any you would set this property to DepartmentId,ParentDepartmentId. + Note that you can only use ParentFieldNames or GroupingMembers property but not both. If both are set ParentFieldName take precedence. + + + + + Gets or sets comma separated list of field or property names that are used for grouping when data-binding is used. Note that you can only use ParentFieldName or GroupingMembers property but not both. If both are set ParentFieldName take precedence. + + + + + Gets or sets style for automatically created group nodes when data-binding is used and GroupingMembers property is set. + + + Name of the style assigned or null value indicating that no style is used. + Default value is null. + + + + + Gets or sets the index specifying the currently selected item. + + + + + Gets or sets the property to use as the actual value for the items in the control. Applies to data-binding scenarios. SelectedValue property will return the value of selected node as indicated by this property. + + + + + Gets or sets the value of the member property specified by the ValueMember property. + + + + + Indicates whether control changes the CurrencyManager.DataPosition when selected node is changed during data binding. + Default value is true. + + + + + Indicates whether touch support for scrolling is enabled. + + + + + Static class that holds AdvTree settings that are not commonly used. + + + + + Gets or sets whether tree control is scrolled horizontally so selected node is brought into the view. Default value is false. + You can set this property to false to disable the horizontal scrolling of tree control when selected node has changed. + + + + + Gets or sets whether AdvTree node comparer that provides column sorting uses standard text comparer instead of default + hybrid alpha-numeric comparer. Default value is false. + + + + + Defines an interface for cell edit control that allows custom controls to be used as cell editors. AdvTree control + expects that editing control inherits from System.Windows.Forms.Control. + + + + + Called when edit operation is started. The AdvTree control will first set CurrentValue, then call BeginEdit and will call EditComplete once + editing is completed. + + + + + Called when edit operation is completed. + + + + + Gets or sets current edit value. + + + + + AdvTree control subscribes to this event to be notified when edit operation is completed. For example when Enter key is + pressed the edit control might raise this event to indicate the completion of editing operation. + + + + + AdvTree control subscribes to this event to be notified that user has cancelled the editing. For example when Escape key is + pressed the edit control might raise this event to indicate that editing has been cancelled. + + + + + Gets or sets whether cell requests the word-wrap based on the current cell style. If your editor does not support + word-wrap functionality this can be ignored. + + + + + Defines delegate for PrepareCellEditor event. + + + + + + + Event arguments for PrepareCellEditor event. + + + + + Gets reference to the cell being edited. + + + + + Gets reference to the cell editor control. + + + + + Initializes a new instance of the PrepareCellEditorEventArgs class. + + + + + + + Defines delegate for PrepareCellEditor event. + + + + + + + Event arguments for AdvTree.Render event. + + + + + Indicates the rendering operation being performed. + + + + + Indicates graphics canvas to render on. + + + + + Initializes a new instance of the AdvTreeRenderEventArgs class. + + Specifies rendering type + Specifies graphics canvas to render on + + + + Specifies the rendering type being performed on AdvTree control Render event. + + + + + Control background is being painted. + + + + Represents a cell assigned to the Node. + + The Cell with Index 0 (zero) always exists for a Node and it is a cell that + you can interact with through the properties on a node, which are forwarding to the + Cell(0), or you can go directly to the Cell(0). + When Node has multiple columns defined each column corresponds to Cell in + Node's Cells collection. The first Column has Index 0, second Column Index 1 and so + forth. + Note that there is always at least one Cell in a Node even if multiple + columns are not used. + + + + + Initializes new instance of Cell class. + + + + + Initializes new instance of Cell class. + + Cell text. + + + + Initializes new instance of Cell class. + + Cell text. + + + + Initializes new instance of Cell class. + + Cell text. + + + + Releases the resources used by the Component. + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Occurs after Tooltip text has changed. + + + + + Called when tooltip is shown and hidden. + + true if tooltip is being shown otherwise false. + + + + Shows tooltip for this item. + + + + + Destroys tooltip window. + + + + + Sets the bounds of the cell. + + New cell bounds. + + + + Sets the bounds of the image inside of the cell. + + New cell bounds. + + + + Sets the bounds of the check box inside of the cell. + + New cell bounds. + + + + Sets whether cells is visible or not. This is set by node layout manager and it is based on column visibility. + + True if visible otherwise false. + + + + Sets the parent of the cell. + + Parent node. + + + + Occurs after text has changed. + + + + + Sets the Images to the new CellImages object. + + CellImages object. + + + + Returns whether Images property should be serialized. Used internally for windows forms designer support. + + + + + Sets the Checked or CheckState properties. + + New value for checked state. + Action source. + + + + Sets the Checked or CheckState properties. + + New value for checked state. + Action source. + + + + Sets the mouse over flag. + + true if mouse is over the cell otherwise false. + + + + Sets the mouse down flag. + + true if left mouse button is pressed while over the cell otherwise false. + + + + Returns effective editor type used for cell editing. + + Editor type. + + + Makes a copy of a Cell. + + + + Ensures that the cell is visible, expanding nodes and scrolling the control as necessary. + + + + + Occurs when any image property for the cell has changed. + + + + + Invokes AfterCheck event on AdvTree + control. + + + + + Invokes BeforeCheck event on AdvTree + control. + + + + + Called just before cell layout is to be performed. + + + + + Occurs when text markup link is clicked. + + + + + Gets/Sets informational text (tooltip) for the cell. + + + + + Gets whether tooltip is visible or not. + + + + + Occurs when item's tooltip visibility has changed. + + + + + Gets or sets whether tooltips are shown when mouse is over the cell when Tooltip property is set. + + + + + Gets or sets whether cell content is editable when cell editing is enabled on tree control. Default value is true. + + + + + Gets whether cell can be edited. Cell can be edited if both Editable property is set to true and ColumnHeader.Editable property is set to true. + + + + + Gets or sets the item hosted inside of the cell. Only items that do not generate + popups are supported. Note that cell can only host either HostedItem or HostedControl but not both. + + + + + Gets or sets the control hosted inside of the cell. Note that cell can only host either HostedItem or HostedControl but not both. + + + When control is hosted inside of the cell, cell size is determined by the + size of the control hosted inside of it. The cell will not display its text but it will display any image assigned + or check box when control is hosted inside of it. The Style settings like Margin + and Padding will still apply. + + + + + Gets or sets whether hosted control size change event is ignored. + + + + + Gets or sets the hosted control size. Property is used to correctly scale control when AdvTree.Zoom is used to zoom view. + + + + + Returns name of the cell that can be used to identify it from the code. + + + + + Gets the relative bounds of the cell. + + + + + Gets the bounds of the cell. + + + + + Gets or sets the available content bounds for the text. Text will fitted into these bounds + but it's true location can be obtained only after it is displayed. + + + + + Gets the bounds of the text inside of cell. + + + + + Gets the relative bounds of the image inside of cell. + + + + + Gets the bounds of the image inside of cell. + + + + + Gets the bounds of the image inside of cell. + + + + + Gets the bounds of the check box inside of cell. + + + + + Gets a value indicating whether the cell is in an editable state. true if the cell is in editable state; otherwise, false. + + + + + Gets a value indicating whether the cell is in the selected state. true if the cell is in the selected state; otherwise, false. + + + + + Gets a value indicating whether the cell is visible. Cell is considered to be visible when it's parent column is visible. + + + + + Gets the parent node of the current cell. + + + + + Gets or sets the object that contains data about the cell. Any Object derived type can be assigned to this property. If this property is being set through the Windows Forms designer, only text can be assigned. + + + + + Gets or sets the object that contains data about the cell. Any Object derived type can be assigned to this property. If this property is being set through the Windows Forms designer, only text can be assigned. + + + + + Gets or sets the format that is applied to the value of Text property for display purposes. See "Formatting Overview" in MSDN + for description on available format strings. For example you can specify "C" to format text as currency, or "D" to format text as decimal number etc. + + + + + + Gets the formatted display text. + + + + + Gets or sets the text displayed in the cell. + + + + + Gets the parent tree control that the cell belongs to. + + + + + Gets or sets the style class assigned to the cell. Null value indicates that + default style is used as specified on cell's parent. + + + Reference to the style assigned to the cell or null (VB Nothing) indicating that default + style setting from tree control is applied. Default value is null. + + + When property is set to null (VB Nothing) the style setting from parent tree + controls is used. CellStyleNormal on AdvTree control is a root style for a cell. + + StyleDisabled Property + StyleMouseDown Property + StyleMouseOver Property + StyleSelected Property + + + + Gets or sets the style name used by cell. This member is provided for internal use only. To set or get the style use StyleNormal property instead. + + + + + Gets or sets the style class that is to when cell is selected. Null value indicates that + default style is used as specified on cell's parent. + + + Reference to the style assigned to the cell or null value indicating that default + style setting from tree control is applied. Default is null value. + + + When property is set to null value the style setting from parent tree + controls is used. CellStyleSelected on AdvTree control is a root style for a cell. + + StyleNormal Property + StyleDisabled Property + StyleMouseDown Property + StyleMouseOver Property + + + + Gets or sets the selected style name used by cell. This member is provided for internal use only. To set or get the style use StyleSelected property instead. + + + + + Gets or sets the disabled style class assigned to the cell. Null value indicates + that default style is used as specified on cell's parent. + + + Reference to the style assigned to the cell or null value indicating that default + style setting from tree control is applied. Default value is null. + + + When property is set to null value the style setting from parent tree + controls is used. CellStyleDisabled on AdvTree control is a root style for a + cell. + + StyleNormal Property + StyleMouseDown Property + StyleMouseOver Property + StyleSelected Property + + + + Gets or sets the disabled style name used by cell. This member is provided for internal use only. To set or get the style use StyleDisabled property instead. + + + + + Gets or sets the style class assigned to the cell which is applied when mouse + button is pressed while mouse is over the cell. Null value indicates that default + style is used as specified on cell's parent. + + + Reference to the style assigned to the cell or null value indicating that default + style setting from tree control is applied. Default value is null. + + + When property is set to null value style setting from parent tree + controls is used. CellStyleMouseDown on AdvTree control is a root style for a + cell. + + StyleNormal Property + StyleDisabled Property + StyleMouseOver Property + StyleSelected Property + + + + Gets or sets the mouse down style name used by cell. This member is provided for internal use only. To set or get the style use StyleMouseDown property instead. + + + + + Gets or sets the style class assigned to the cell which is applied when mouse is + over the cell. Null value indicates that default style is used as specified on cell's + parent. + + + Reference to the style assigned to the cell or null value indicating that default + style setting from tree control is applied. Default value is null. + + + When property is set to null value the style setting from parent tree + controls is used. CellStyleMouseOver on AdvTree control is a root style for a + cell. + + StyleNormal Property + StyleDisabled Property + StyleMouseDown Property + StyleSelected Property + + + + Gets or sets the mouse over style name used by cell. This member is provided for internal use only. To set or get the style use StyleMouseOver property instead. + + + + + Gets or sets whether cell is enabled or not. + + + + + Gets the reference to images associated with this cell. + + + + + Gets or sets the image alignment in relation to the text displayed by cell. + + + + + Gets or sets the checkbox alignment in relation to the text displayed by cell. + + + + + Gets or sets whether check box is visible inside the cell. + + + + + Gets or set a value indicating whether the check box is in the checked state. + + + + + Gets or sets a value indicating whether the CheckBox will allow three check states rather than two. If the ThreeState property is set to true + CheckState property should be used instead of Checked property to set the extended state of the control. + + + + + Specifies the state of a control, such as a check box, that can be checked, unchecked, or set to an indeterminate state. + + + + + Gets or sets the appearance style of the item. Default value is CheckBox. Item can also assume the style of radio-button. + + + + + Gets whether mouse is over the cell. + + + + + Gets whether left mouse button is pressed while over the cell. + + + + + Gets or sets the layout of the cell parts like check box, image and text. Layout can be horizontal (default) + where parts of the cell are positioned next to each other horizontally, or vertical where + parts of the cell are positioned on top of each other vertically. + Alignment of the each part is controlled by alignment properties. + + ImageAlignment Property + CheckBoxAlignment Property + + + + Specifies the mouse cursor displayed when mouse is over the cell. + + + + + Gets or sets whether cell wrapped the text during the layout. + + + + + Gets or sets the editor type used to edit the cell. Setting this property to value other than Default + overrides the cell editor type specified on column cell belongs to. + + + + + Gets or sets whether cell can be selected by user by clicking it with the mouse or using keyboard. Default value is true. + + + + + Gets whether cell can be selected. Cell must be Visible, Enabled and Selectable in order for it to be selected. + + + + + Returns ColumnHeader cell is under if one is defined and cell is already parented to the tree. Otherwise it returns null/nothing. + + + + + Gets reference to parsed markup body element if text was markup otherwise returns null. + + + + + Gets or sets whether cell supports and renders text markup. Default value is true. + + + + + Gets whether item supports text markup. Default is false. + + + + + A strongly-typed collection of objects. + + + + Creates new instance of the class. + + + + Adds new object to the collection. + + Object to add. + Index of newly added object. + + + + Gets the cell based on the column name. Node must be able to reach AdvTree control for this method to work. + + Column name. + Cell object or null. + + + + Inserts new object into the collection. + + Position of the object. + Object to insert. + + + + Returns index of the object inside of the collection. + + Reference to the object. + Index of the object. + + + + Returns whether collection contains specified object. + + Object to look for. + true if object is part of the collection, otherwise false. + + + + Removes specified object from the collection. + + + + + + Copies collection into the specified array. + + Array to copy collection to. + Starting index. + + + + Copies contained items to the Cell array. + + Array to copy to. + + + + Sets the node collection belongs to. + + Cell that is parent of this collection. + + + + Returns reference to the object in collection based on it's index. + + + + + Returns reference to the object in collection based on it's name. Returns null/nothing if cell with given name is not found. + + + + + Gets or sets the node this collection is associated with. + + + + + Represents event arguments for cell editing events. + + + + + Indicates the action that caused the event. + + + + + Indicates the cell that is affected. + + + + + Indicates new text that will be assigned to the cell if one is appropriate for given event. + + + + + Indicates whether the current action is cancelled. For BeforeCellEdit event setting this + property to true will cancel the editing. For AfterCellEdit event setting this property to + true will cancel any changes made to the text and edits will not be accepted. For CellEditEnding + event setting this property to true will keep the cell in edit mode. + + + + + Indicates whether editing operation was canceled by the end user, usually by pressing ESCAPE key. + + + + + Initializes new instance of CellEditEventArgs class. + + Reference to Cell this event is raised for. + Indicates the action that caused the event. + Indicates new text of the cell if it applies to given event. + + + + Initializes new instance of CellEditEventArgs class. + + Reference to Cell this event is raised for. + Indicates the action that caused the event. + Indicates new text of the cell if it applies to given event. + + + + Initializes new instance of CellEditEventArgs class. + + Reference to Cell this event is raised for. + Indicates the action that caused the event. + Indicates new text of the cell if it applies to given event. + Indicates whether action is canceled by the end user. + + + + Initializes new instance of CellEditEventArgs class. + + Reference to Cell this event is raised for. + Indicates the action that caused the event. + Indicates new text of the cell if it applies to given event. + Indicates whether action is canceled by the end user. + + + + Gets reference to the cell editor control. + + + + + Represents class that holds images for a cell. + + + If you plan to use alpha-blended images we recommend using PNG-24 format which + supports alpha-blending. As of this writing .NET Framework 1.0 and 1.1 do not support + alpha-blending when used through Image class. + + + + + Initializes new instance of CellImages class. + + Reference to parent cell. + + + + Resets Image property to it's default value (null, VB nothing). + + + + + Resets ImageMouseOver to it's default value (null, VB nothing). + + + + + Resets ImageDisabled to it's default value (null, VB nothing). + + + + + Resets ImageExpanded to it's default value (null, VB nothing). + + + + Makes a copy of a CellImages object. + + + + Changes the image and invokes largest image size calculation if the + image size truly changed. + + + + + + + Returns image from image list based on the image index. + + Index of the image to return. + Image object from image list. + + + + Returns image from image list based on the image key. + + Key of the image to return. + Image object from image list. + + + + Gets or sets default cell image. Setting this property to valid image will + override any setting of ImageIndex property. + + + The image set through this property will be serialized with the cell. If you + plan to use ImageList then use ImageIndex + property. + + If you plan to use alpha-blended images we recommend using PNG-24 format + which supports alpha-blending. As of this writing .NET Framework 1.0 and 1.1 + do not support alpha-blending when used through Image class. + + + Image object or null (Nothing) if no image is assigned. + + + + Gets or sets the image that is displayed when mouse is over the cell. Setting + this property to valid image will override any setting of ImageMouseOverIndex + property. + + + If you plan to use alpha-blended images we recommend using PNG-24 format which + supports alpha-blending. As of this writting .NET Framework 1.0 and 1.1 do not support + alpha-blending when used through Image class. + + + + + Gets or sets the image that is displayed when cell is disabled. If not assigned + disabled image is created from default cell image. Setting this property to valid image + will override any setting of ImageDisabledIndex property. + + + If you plan to use alpha-blended images we recommend using PNG-24 format which + supports alpha-blending. As of this writing .NET Framework 1.0 and 1.1 do not support + alpha-blending when used through Image class. + + + + + Gets or sets image that is displayed when Node that this cell belongs to is + expanded. Setting this property to valid image will override any setting of + ImageExpandedIndex property. + + + If you plan to use alpha-blended images we recommend using PNG-24 format which + supports alpha-blending. As of this writing .NET Framework 1.0 and 1.1 do not support + alpha-blending when used through Image class. + + + + + Gets or sets the Index of default cell image from ImageList specified on AdvTree + control. + + + If you plan to use alpha-blended images we recommend using PNG-24 format which + supports alpha-blending. As of this writing .NET Framework 1.0 and 1.1 do not support + alpha-blending when used through Image class. + + + + + Gets or sets the key of the default cell image from ImageList specified on AdvTree control. + + + + + Property Editor support for ImageIndex selection + + + + + If you plan to use alpha-blended images we recommend using PNG-24 format which + supports alpha-blending. As of this writing .NET Framework 1.0 and 1.1 do not support + alpha-blending when used through Image class. + + + Gets or sets the Index of cell image when mouse is over the cell from ImageList + specified on AdvTree control. + + + + + If you plan to use alpha-blended images we recommend using PNG-24 format which + supports alpha-blending. As of this writing .NET Framework 1.0 and 1.1 do not support + alpha-blending when used through Image class. + + + Gets or sets the key of cell image when mouse is over the cell from ImageList + specified on AdvTree control. + + + + + If you plan to use alpha-blended images we recommend using PNG-24 format which + supports alpha-blending. As of this writing .NET Framework 1.0 and 1.1 do not support + alpha-blending when used through Image class. + + + Gets or sets the Index of disabled cell image from ImageList specified on AdvTree + control. + + + + + If you plan to use alpha-blended images we recommend using PNG-24 format which + supports alpha-blending. As of this writing .NET Framework 1.0 and 1.1 do not support + alpha-blending when used through Image class. + + + Gets or sets the key of disabled cell image from ImageList specified on AdvTree + control. + + + + + If you plan to use alpha-blended images we recommend using PNG-24 format which + supports alpha-blending. As of this writing .NET Framework 1.0 and 1.1 do not support + alpha-blending when used through Image class. + + + Gets or sets the Index of cell image from ImageList specified on AdvTree control + that is used when Node associated with this cell is expanded + + + + + If you plan to use alpha-blended images we recommend using PNG-24 format which + supports alpha-blending. As of this writing .NET Framework 1.0 and 1.1 do not support + alpha-blending when used through Image class. + + + Gets or sets the key of cell image from ImageList specified on AdvTree control + that is used when Node associated with this cell is expanded + + + + + Gets or sets the parent node of the cell. + + + + + Gets whether CellImages object should be serialized or not. If object has all + default values then this property will return false. + + + + + Returns largest image size in this set of images. + + + + + Indicates whether assigned images are automatically disposed when the cell and node are disposed. Default value is false. + + + + Represents the node or tree ColumnHeader. + + + + Creates new instance of the object. + + + + + Creates new instance of the object and initializes it with text. + + Text to initialize object with. + + + + Makes a copy of ColumnHeader object. + + Returns new instance of column header object. + + + + Sets the column bounds. + + + + + Resets Image property to it's default value (null, VB nothing). + + + + + Called when DataFieldName property has changed. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Called when SortingEnabled property has changed. + + Old property value + New property value + + + + Called when SortDirection property has changed. + + Old property value + New property value + + + + Invalidates the appearance of column header. + + + + + Occurs after Tooltip text has changed. + + + + + Called when tooltip is shown and hidden. + + true if tooltip is being shown otherwise false. + + + + Shows tooltip for this item. + + + + + Destroys tooltip window. + + + + + Automatically sets the column width (Width.Absolute) property based on the content of the column. + This will perform the one-time auto sizing of the column. To make column auto-size all the time + set Width.AutoSize=true. + + + + + Raises MouseMove event. + + Provides event arguments. + + + + Raises MouseEnter event. + + Provides event arguments. + + + + Raises MouseLeave event. + + Provides event arguments. + + + + Raises MouseHover event. + + Provides event arguments. + + + + Sort first level nodes that belong directly to this column. Calling this method repeatedly will + alternate between A-Z and Z-A sorting. + + + + + Sort first level nodes that belong directly to this column. + + true to use reverse Z-A sorting, false to sort from A-Z + + + + Called when SortComparer property has changed. + + Old property value + New property value + + + + Called when SortComparerReverse property has changed. + + Old property value + New property value + + + + Occurs when header size has changed due to the user resizing the column. + + + + + Occurs when mouse button is pressed over the column header. + + + + + Occurs when mouse button is released over the column header. + + + + + Occurs when header is double clicked. + + + + + Occurs when header is clicked. + + + + + Gets or sets whether cells content in this column is editable when cell editing is enabled on tree control. Default value is true. + + + + + Gets or sets the maximum number of characters the user can type or paste when editing cells in this column. + + + + + Returns name of the column header that can be used to identify it from the code. + + + + + Returns rectangle that this column occupies. If the layout has not been performed on the column the return value will be Rectangle.Empty. + + + + + Gets the reference to the object that represents width of the column as either + absolute or relative value. + + + Set Width using Absolute or Relative properties of ColumnWidth object. + + Absolute Property (DevComponents.AdvTree.ColumnWidth) + Relative Property (DevComponents.AdvTree.ColumnWidth) + + + + Gets or sets the minimum column width in pixels that is enforced when user is resizing the columns using mouse. + Default value is 0 which indicates that there is no minimum size constraint. + + + + + Gets or sets whether column is stretched to fill any empty space horizontally in tree when all columns consume less width than available. + Only one column in tree may have this property set to true and only last column with this property set will be stretched. + You should always set the Width for the column since Width will be used when columns consume more space in tree horizontally than available. + Applies to top-level columns only. + + + + + Gets or sets the style class assigned to the column. Empty value indicates that + default style is used as specified on cell's parent's control. + + + Name of the style assigned to the cell or an empty string indicating that default + style setting from tree control is applied. Default is empty string. + + + When property is set to an empty string the style setting from parent tree + controls is used. ColumnStyleNormal on AdvTree control is a root style for a cell. + + StyleMouseDown Property + StyleMouseOver Property + + + + Gets or sets the style class assigned to the column which is applied when mouse + button is pressed over the header. Empty value indicates that default + style is used as specified on column's parent. + + + Name of the style assigned to the column or an empty string indicating that default + style setting from tree control is applied. Default is empty string. + + + When property is set to an empty string the style setting from parent tree + controls is used. ColumnStyleMouseDown on AdvTree control is a root style for a + cell. + + StyleNormal Property + StyleMouseOver Property + + + + Gets or sets the style class assigned to the column which is applied when mouse is + over the column. Empty value indicates that default style is used as specified on column's + parent control. + + + Name of the style assigned to the column or an empty string indicating that default + style setting from tree control is applied. Default is empty string. + + + When property is set to an empty string the style setting from parent tree + controls is used. ColumnStyleMouseOver on AdvTree control is a root style for a + cell. + + StyleNormal Property + StyleMouseDown Property + + + + Gets or sets the name of the column in the ColumnHeaderCollection. + + + + + Gets or sets the column caption. + + + + + Gets or sets whether column is visible. Hiding the header column will also hide corresponding data column. + + + + + + Gets or sets Image alignment inside of column. Default value is Left. + + + + + Gets or sets the data-field or property name that is used as source of data for this column when data-binding is used. + + + + + Gets or sets additional custom data associated with the column. + + + + + Gets or sets the color of the cells background for this column. + + + + + Gets or sets display index of the column. -1 indicates default value and is modified to actual display index when the column is added to a ColumnHeaderCollection. + + + A lower display index means a column will appear first (to the left) of columns with a higher display index. + Allowable values are from 0 to num columns - 1. (-1 is legal only as the default value and is modified to something else + when the column is added to a AdvTree's column collection). AdvTree enforces that no two columns have the same display index; + changing the display index of a column will cause the index of other columns to adjust as well. + + + + + Gets or sets whether user can sort by this column by clicking it. + + + + + Gets or sets the sort direction. Sort direction can be changed by clicking the column header if SortingEnabled=true. + + + + + Gets/Sets informational text (tooltip) for the cell. + + + + + Gets whether tooltip is visible or not. + + + + + Occurs when item's tooltip visibility has changed. + + + + + Gets or sets whether tooltips are shown when mouse is over the cell when Tooltip property is set. + + + + + Returns reference to AdvTree control this column belongs to. + + + + + Gets or sets whether column is automatically sized to the content when user double-clicks the column + on the column resize line. Column resizing must be enabled in order for this property to function. + Default value is true which indicates that column will be auto-sized to content when user double-clicks the + column resize marker. + + + + + Gets or sets whether column size has changed and it's layout needs to be recalculated. + + + + + Gets whether mouse left button is pressed on the column. + + + + + Gets whether mouse is over the column. + + + + + Occurs when mouse is moving over the column header. + + + + + Occurs when mouse enters column header. + + + + + Occurs when mouse leaves the column header. + + + + + Occurs when mouse hovers over the column. + + + + + Gets or sets the editor type used to edit the cell. Setting this property to value other than Default + overrides the cell editor type specified on column cell belongs to. + + + + + Gets or sets ascending (A-Z) column comparer used to sort nodes when this column is clicked. Your comparer will be passed to NodeCollection.Sort method and should know how to sort by appropriate column. + + + + + Gets or sets descending (Z-A) column comparer used to sort nodes when this column is clicked. Your comparer will be passed to NodeCollection.Sort method and should know how to sort by appropriate column. + + + + + Gets or sets whether to cancel internal sorting performed by AdvTree. + + + + + Gets or sets the column header being sorted. + + + + + Gets or sets the IComparer used for sorting. + + + + + Defines column related event arguments. + + + + + Gets reference to the column. + + + + + Initializes a new instance of the ColumnEventArgs class. + + + + + + Defines delegate for ColumnMoved event. + + + + + Defines column moved event arguments. + + + + + Gets the column display index before the column was moved. + + + + + Gets the column display index before the column was moved. + + + + + Initializes a new instance of the ColumnMovedEventArgs class. + + Column affected + Old display index + New display index + + + + Represents collection for ColumnHeader objects. + + + + + Default constructor. + + + + + Sets the node collection belongs to. + + ColumnHeader that is parent of this collection. + + + + Adds new object to the collection. + + Object to add. + Index of newly added object. + + + + Inserts new object into the collection. + + Position of the object. + Object to insert. + + + + Returns index of the object inside of the collection. + + Reference to the object. + Index of the object. + + + + Returns index of the object inside of the collection. + + Name of column to return index for. + Index of the column or -1 if column not found. + + + + Returns index of the object inside of the collection based on column DataFieldName. + + DataFieldName of column to return index for. + Index of the column or -1 if column not found. + + + + Returns index of the object inside of the collection based on column DataFieldName. + + DataFieldName of column to return index for. + Index of the column or -1 if column not found. + + + + Returns whether collection contains specified object. + + Object to look for. + true if object is part of the collection, otherwise false. + + + + Removes specified object from the collection. + + + + + + Called when SortDirection property on column header is set to value other than None. + + Ref to column header + + + + Copies collection into the specified array. + + Array to copy collection to. + Starting index. + + + + Copies contained items to the ColumnHeader array. + + Array to copy to. + + + + Gets the display index for specified column. + + Column that is part f ColumnHeaderCollection + Display index or -1 column is not part of this collection. + + + + Returns the column that is displayed at specified display index.. + + 0 based display index. + ColumnHeader + + + + Invalidates the display indexes and causes them to be re-evaluated on next layout. + + + + + Gets or sets the node this collection is associated with. + + + + + Returns reference to the object in collection based on it's index. + + + + + Returns reference to the object in collection based on it's name. + + + + + Occurs before the cells are sorted. + + + + + Gets whether a column that is part of this collection has SortDirection set. + + + + + A map of display index (key) to index in the column collection (value). Used to quickly find a column from its display index. + + + + + Gets reference to last visible column or null if there is no last visible column. + + + + + Gets reference to first visible column or null if there is no first visible column. + + + + + Gets the column header rendering bounds. + + + + + Initializes a new instance of the IndexToDisplayIndex class. + + + + + + + Initializes a new instance of the ColumnHeaderControl class. + + + + + Returns mouse position which is translated if control Zoom is not equal 1 + + X coordinate + Y coordinate + + + + + Gets or sets the column move marker that marks insertion point for column that is dragged. Marker is drawn before the column specified by this index. + + + + + Gets or sets the column header collection to be rendered. + + + + + Represents the width of the Column. Supports absolute width in Pixels and + relative width as percentage of the width of parent control. + + + + + Creates new instance of the object. + + + + + Gets or sets relative width expressed as percentage between 1-100. 0 indicates that + absolute width will be used. + + + Relative width is expressed as percentage between 1-100 of the parent controls + width. 0 indicates that absolute width will be used. Absolute width always takes + priority over relative width. For example value of 30 assigned to this property + indicates that width of the column will be 30% of the total client width of the + control. + + + + Gets or sets the absolute width of the column in pixels. + + Absolute width always takes precedence over the relative width of the + column. + + + + + Gets or sets whether column width is automatically set based on the column's content. Default value is false. + When set absolute and relative size values are ignored. + + + + + Gets or sets whether column auto-width is set to minimum of the column header text width. Applies to AutoSize=true only. + + + + + Gets the auto-size calculated width of the column after tree layout is performed and column has AutoSize=true. + + + + + Provides event arguments for command button events. + + + + + Default constructor. + + Action type. + Context node. + + + + Indicates the action type that caused the event. + + + + + Indicates the node action is peformed on. + + + + + Represents collection of connector points for a node. + + + + + Default constructor. + + + + + Sets the node collection belongs to. + + Node that is parent of this collection. + + + + Adds new object to the collection. + + Object to add. + Index of newly added object. + + + + Adds range of objects to the array. + + Array to add. + + + + Copies objects of the collection to the array. + + + + + + Inserts new object into the collection. + + Position of the object. + Object to insert. + + + + Returns index of the object inside of the collection. + + Reference to the object. + Index of the object. + + + + Returns whether collection contains specified object. + + Object to look for. + true if object is part of the collection, otherwise false. + + + + Removes specified object from the collection. + + + + + + Copies collection into the specified array. + + Array to copy collection to. + Starting index. + + + + Copies contained items to the ColumnHeader array. + + Array to copy to. + + + + Gets or sets the node this collection is associated with. + + + + + Returns reference to the object in collection based on it's index. + + + + + Control for input of the integer value. + + + + + Represents an control that allows numeric input. + + + + + Closes all popups managed by the owner control. + + + + + Defines interface that should be implemented by controls that support per control renderers. + + + + + Gets the renderer control will be rendered with. This can be either custom renderer set on the control or the + Rendering.GlobalManager specified renderer. + + + + + + Gets or sets the redering mode used by control. Default value is eRenderMode.Global which means that static GlobalManager.Renderer is used. If set to Custom then Renderer property must + also be set to the custom renderer that will be used. + + + + + Gets or sets the custom renderer used by the items on this control. RenderMode property must also be set to eRenderMode.Custom in order renderer + specified here to be used. + + + + + Defines interface for internal accessibility support for DotNetBar control. + + + + + Gets or sets the item default accesibility action will be performed on. + + + + + Provides support for custom localization. + + + + + Notifies the accessibility client applications of the specified AccessibleEvents for the specified child control. + + The AccessibleEvents object to notify the accessibility client applications of. + The child Control to notify of the accessible event. + + + + Forces the button to perform internal layout. + + + + + Creates the Graphics object for the control. + + The Graphics object for the control. + + + + Returns the renderer control will be rendered with. + + The current renderer. + + + + Sets up timer that watches when active window changes. + + + + + Called after change of active window has been detected. SetupActiveWindowTimer must be called to enable detection. + + + + + Releases and disposes the active window watcher timer. + + + + + Generates a Click event for the control. + + + + + Returns the collection of items with the specified name. This member is not implemented and should not be used. + + Item name to look for. + + + + + Returns the collection of items with the specified name and type. This member is not implemented and should not be used. + + Item name to look for. + Item type to look for. + + + + + Returns the collection of items with the specified name and type. This member is not implemented and should not be used. + + Item name to look for. + Item type to look for. + Indicates whether GlobalName property is used for searching. + + + + + Returns the first item that matches specified name. This member is not implemented and should not be used. + + Item name to look for. + + + + + Invokes the DotNetBar Customize dialog. + + + + + Occurs when popup of type container is loading. + + + + + Occurs when popup of type container is unloading. + + + + + Occurs when popup item is about to open. + + + + + Occurs when popup item is closing. + + + + + Occurs just before popup window is shown. + + + + + Occurs when Control is looking for translated text for one of the internal text that are + displayed on menus, toolbars and customize forms. You need to set Handled=true if you want + your custom text to be used instead of the built-in system value. + + + + + Gets/Sets the visual style for the button. + + + + + Gets or sets the rendering mode used by control. Default value is eRenderMode.Global which means that static GlobalManager.Renderer is used. If set to Custom then Renderer property must + also be set to the custom renderer that will be used. + + + + + Gets or sets the custom renderer used by the items on this control. RenderMode property must also be set to eRenderMode.Custom in order renderer + specified here to be used. + + + + + Gets or sets whether anti-alias smoothing is used while painting. Default value is false. + + + + + Gets or sets button Color Scheme. ColorScheme does not apply to Office2007 styled buttons. + + + + + Specifies whether button is drawn using Windows Themes when running on OS that supports themes like Windows XP. + + + + + Gets whether Windows Themes should be used to draw the button. + + + + + Gets or sets whether hooks are used for internal DotNetBar system functionality. Using hooks is recommended only if DotNetBar is used in hybrid environments like Visual Studio designers or IE. + + + + + Gets or sets the form button is attached to. + + + + + Indicates whether Reset buttons is shown that allows end-user to reset the toolbar state. + + + + + ImageList for images used on Items. Images specified here will always be used on menu-items and are by default used on all Bars. + + + + + ImageList for medium-sized images used on Items. + + + + + ImageList for large-sized images used on Items. + + + + + Indicates whether Tooltips are shown on Bars and menus. + + + + + Indicates whether item shortcut is displayed in Tooltips. + + + + + Gets or sets whether gray-scale algorithm is used to create automatic gray-scale images. Default is true. + + + + + Creates new instance of the class. + + + + + Resets the input position so the new input overwrites current value. + + + + + Called when InputHorizontalAlignment property value has changed. + + Old value. + New Value. + + + + Indicates whether property should be serialized by Windows Forms designer. + + + + + Resets the property to default value. + + + + + Resets style to default value. Used by windows forms designer. + + + + + Selects next input field if possible. + + true if next input field was selected otherwise false. + + + + Selects previous input field if possible. + + true if previous input field was selected otherwise false. + + + + ISupportInitialize.BeginInit implementation. While initialization is in progress ValueChanged events will not be fired. + + + + + ISupportInitialize.EndInit implementation. + + + + + Occurs when ButtonCustom control is clicked. + + + + + Occurs when ButtonCustom2 control is clicked. + + + + + Gets or sets whether control system buttons are rendered. Default value is true. + + + + + Gets or sets whether during painting OnPaintBackground on base control is called when BackColor=Transparent. + + + + + Gets whether watermark text should be rendered. + + + + + Gets or sets whether mouse wheel affects the input control. Default value is true. + + + + + Gets whether keyboard focus is within the control. + + + + + Gets the reference to internal visual item used as the root visual for the control. Using this property is in all cases not necessary except for some + very advanced usage scenarios. + + + + + Gets or sets the input field alignment inside the control + + + + + Gets or sets the watermark font. + + + + + Gets or sets the watermark text color. + + + + + Gets or sets whether watermark text is displayed if set for the input items. Default value is true. + + + + + Gets or sets the watermark text displayed on the input control when control is empty. + + + + + Gets or sets the watermark text alignment. Default value is left. + + + + + Gets or sets whether FocusHighlightColor is used as background color to highlight text box when it has input focus. Default value is false. + + + + + Gets or sets the color used as background color to highlight text box when it has input focus and focus highlight is enabled. + + + + + Gets the object that describes the settings for the custom button that can execute an custom action of your choosing when clicked. + + + + + Gets the object that describes the settings for the custom button that can execute an custom action of your choosing when clicked. + + + + + Specifies the background style of the control. + + + + + Gets the preferred height of the control. + + + + + Gets or sets the keys used to navigate between the input fields provided by this control. + + + + + Gets or sets the control background color when control is disabled. Default value is an empty color which indicates that background is not changed when control is disabled. + + + + + Gets or sets the control text color when control is disabled. Default value is an empty color which indicates that background is not changed when control is disabled. + + + + + Gets the system colors used by the control. + + + + + Defines an interface for the object that knows how to invoke a command. + + + + + Gets or sets the command that will be executed when the command source is invoked. + + + + + Gets or sets user defined data value that can be passed to the command when it is executed. + + + + + Initializes a new instance of the NumericInputBase class. + + + + + Raises the LockUpdateChanged event. + + Provides event data./ + + + + Gets or sets a value indicating whether a spin button control (up-down control) is used to adjust the current value. The default is false. + + When the ShowUpDown property is set to true, a spin button control is shown to adjust value of currently focused input item. + The value can be adjusted by using the up and down buttons to change the value. + + + + + + Decreases value of the control. + + + + + Increases the value of the control. + + + + + Shows drop-down popup. Note that popup will be shown only if there is a DropDownControl assigned or DropDownItems collection has at least one item. + + + + + Closes the drop-down popup if it is open. + + + + + Raises the ButtonClearClick event. + + + + + + Raises the ButtonDropDownClick event. + + + + + + Raises the ValueChanged event. + + Provides event arguments. + + + + Raises the ValueChanged event. + + Provides event arguments. + + + + Called when Command property value changes. + + + + + + + + + + + Occurs when the Value or IsEmpty property changes. + + This event is not raised when the entered date is earlier than MinDateTime or later than MaxDateTime. + + + + + + Occurs when the Value or IsEmpty property changes. This event occurs at the same time and has same function as ValueChanged event. It is provided for binding support. + + + + + Occurs when Clear button is clicked and allows you to cancel the default action performed by the button. + + + + + Occurs when Drop-Down button that shows calendar is clicked and allows you to cancel showing of the popup. + + + + + Occurs when ShowCheckBox property is set to true and user changes the lock status of the control by clicking the check-box. + + + + + Gets or sets whether input part of the control is read-only. When set to true the input part of the control becomes read-only and does not allow the typing. However, drop-down and up/down buttons part if visible still allows user to possibly change the value of the control through the method you can provide on drop-down or through up/down buttons. Use this property to allow change of the value through drop-down or up/down buttons only. + + + + + Gets or sets a value indicating whether a check box is displayed to the left of the input value. + Set to true if a check box is displayed to the left of the input value; otherwise, false. The default is false. + + When the ShowCheckBox property is set to true, a check box is displayed to the left of the input in the control. When the check box is selected, the value can be updated. When the check box is cleared, the value is unable to be changed. + You can handle the LockUpdateChanged event to be notified when this check box is checked and unchecked. Use LockUpdateChecked property + to get or sets whether check box is checked. + + + + + + Gets or sets whether check box shown using ShowCheckBox property which locks/unlocks the control update is checked. + + + + + Gets the object that describes the settings for the button that shows drop-down when clicked. + + + + + Gets the object that describes the settings for the button that clears the content of the control when clicked. + + + + + Gets the object that describes the settings for the button that switches the control into the free-text entry mode when clicked. + + + + + Gets the object that describes the settings for the button that displays popup calculator. + + + + + Gets or sets the Numeric String Format that is used to format the numeric value entered for display purpose. Read more about + available formats in MSDN under "Standard Numeric Format Strings" and "Custom Numeric Format Strings" topics. + + The format specified here indicates the format for display purpose only, not for the input purpose. + For example to display the number in system Currency format set the DisplayFormat to 'C'. + + + + + + Gets or sets whether empty null/nothing state of the control is allowed. Default value is true which means that IsEmpty property + may return true if input value is resets or ValueObject set to null/nothing. + + + + + Gets or sets whether control is empty i.e. it does not hold a valid value. + + + + + Specifies the behavior of ValueChanged event triggering. + + + + + Gets or sets the input field alignment inside the control + + + + + Gets or sets the reference of the control that will be displayed on popup that is shown when drop-down button is clicked. + + + + + Gets the collection of BaseItem derived items displayed on popup menu. + + + + + Gets or sets whether auto-overwrite functionality for input is enabled. When in auto-overwrite mode input field will erase existing entry + and start new one if typing is continued after InputComplete method is called. + + + + + Gets or sets the command assigned to the item. Default value is null. + Note that if this property is set to null Enabled property will be set to false automatically to disable the item. + + + + + Gets or sets user defined data value that can be passed to the command when it is executed. + + + + + Gets or sets the keyboard key that will toggle FreeTextEntryMode. Default value is Keys.None. + + + + + Occurs if Free-Text entry value is not natively recognized by the control and provides you with opportunity to convert that value to the + value control expects. + + + + + Occurs when Free-Text button is clicked and allows you to cancel its default action. + + + + + Gets or sets whether free text entries are attempted to be auto-resolved to dates like Today to today's date or Now to date and time now etc. Default value is true. + + + + + Gets or sets whether free-text entry is automatically turned off when control loses input focus. Default value is false. + + + + + Gets or sets whether control input is in free-text input mode. Default value is false. + + + + + Decreases value of the control. + + + + + Increases the value of the control. + + + + + Copies the current value in the control to the Clipboard. + + + + + Pastes the current Clipboard content if possible as the value into the control. + + + + + Moves the current control value to the Clipboard. + + + + + Raises the ParseValue event. + + Provides event arguments. + + + + Occurs when ValueObject property is set and it allows you to provide custom parsing for the values. + + + + + Gets or sets whether mouse wheel increases or decreases the input value when used. + + + + + Gets or sets the value displayed in the control. + + + + + Gets or sets the value of the control as an object. This property allows you to bind to the database fields and supports + null values. Expected value is int type or null. + + + + + Gets or sets the maximum value that can be entered. + + + + + Gets or sets the minimum value that can be entered. + + + + + Gets or sets the value to increment or decrement the value of the control when the up or down buttons are clicked. + + + + + Control for input of the integer value. + + + + + Copies the current value in the control to the Clipboard. + + + + + Pastes the current Clipboard content if possible as the value into the control. + + + + + Moves the current control value to the Clipboard. + + + + + Raises the ParseValue event. + + Provides event arguments. + + + + Decreases value of the control. + + + + + Increases the value of the control. + + + + + Occurs when ValueObject property is set and it allows you to provide custom parsing for the values. + + + + + Gets or sets whether mouse wheel increases or decreases the input value when used. + + + + + Gets or sets the value displayed in the control. + + + + + Gets or sets the value of the control as an object. This property allows you to bind to the database fields and supports + null values. Expected value is int type or null. + + + + + Gets or sets the maximum value that can be entered. + + + + + Gets or sets the minimum value that can be entered. + + + + + Gets or sets the value to increment or decrement the value of the control when the up or down buttons are clicked. + + + + + Initializes a new instance of the DateTimeInput class. + + + + + Copies the current value in the control to the Clipboard. + + + + + Pastes the current Clipboard content if possible as the value into the control. + + + + + Moves the current control value to the Clipboard. + + + + + Gets or sets the default date-time values that are used by the control. + + + + + Gets or sets a value indicating whether a spin button control (up-down control) is used to adjust the date/time value. The default is false. + + When the ShowUpDown property is set to true, a spin button control is shown to adjust value of currently focused input item. + The date and time can be adjusted by selecting each element individually and using the up and down buttons to change the value. + + + + + + Gets whether Value property should be serialized by Windows Forms designer. + + true if value serialized otherwise false. + + + + Resets Value property to default value. Used by Windows Forms designer. + + + + + Raises the ParseValue event. + + Provides event arguments. + + + + Gets whether Value property should be serialized by Windows Forms designer. + + true if value serialized otherwise false. + + + + Reset the MinDate property to its default value. + + + + + Gets whether Value property should be serialized by Windows Forms designer. + + true if value serialized otherwise false. + + + + Reset the MaxDate property to its default value. + + + + + Gets the Culture used by the date time input and month calendar controls + + reference to CultureInfo + + + + Raises the LockUpdateChanged event. + + Provides event data./ + + + + Raises the ValueChanged event. + + Provides event arguments. + + + + Raises the ButtonClearClick event. + + + + + + Raises the ButtonDropDownClick event. + + + + + + Called when DateTimeSelectorVisibility property has changed. + + Old property value + New property value + + + + Called when TimeFormat property has changed. + + Old property value + New property value + + + + Called when TimeSelectorType property has changed. + + Old property value + New property value + + + + Called when Command property value changes. + + + + + + + + + + + Occurs when the Value or IsEmpty property changes. + + This event is not raised when the entered date is earlier than MinDateTime or later than MaxDateTime. + + + + + + Occurs when the Value or IsEmpty property changes. This event occurs at the same time and has same function as ValueChanged event. It is provided for binding support. + + + + + Occurs when the Format property value has changed. + + + + + Occurs when Clear button is clicked and allows you to cancel the default action performed by the button. + + + + + Occurs when Drop-Down button that shows calendar is clicked and allows you to cancel showing of the popup. + + + + + Occurs when ValueObject property is set and it allows you to provide custom parsing for the values. + + + + + Occurs when ShowCheckBox property is set to true and user changes the lock status of the control by clicking the check-box. + + + + + Gets whether popup calendar is open. + + + + + Gets or sets whether selected date on popup calendar can be changed using keyboard arrow keys. + + + + + Gets or sets a value indicating whether a check box is displayed to the left of the selected date. + Set to true if a check box is displayed to the left of the selected date; otherwise, false. The default is false. + + When the ShowCheckBox property is set to true, a check box is displayed to the left of the date in the control. When the check box is selected, the date/time value can be updated. When the check box is cleared, the date/time value is unable to be changed. + You can handle the LockUpdateChanged event to be notified when this check box is checked and unchecked. Use LockUpdateChecked property + to get or sets whether check box is checked. + + + + + + Gets or sets the date time value of the control. You can use IsEmpty property to check whether control holds an empty value. + Setting this property to System.DateTime(0) will also make the control Empty if AllowEmptyState=true. + + + + + Gets or sets the date/time value of the control as an object. This property allows you to bind to the database fields and supports + null values. Expected value is DateTime object or null to indicate no date selected. + + + + + Gets or sets the values of the nested DateTimeGroup items. + + When nested date-time groups are used note that some of the features of the control are disabled, notably minimum and maximum values + for nested date-times. + + + + + + Gets or sets whether empty null/nothing state of the control is allowed. Default value is true which means that IsEmpty property + may return true if input value is resets or ValueObject set to null/nothing. + + + + + Gets or sets whether control is empty i.e. it does not hold a valid DateTime value. + + + + + Gets or sets the minimum date and time that can be selected in the control. + + + + + Gets or sets the maximum date and time that can be selected in the control. + + + + + Gets or sets the format date/time is displayed in. To specify custom format set this value to Custom and specify custom format using CustomFormat property. + + + + + Gets or sets the custom date/time format string. + + + + To display string literals that contain date and time separators or format strings listed below, + you must use escape characters in the substring. For example, to display the date as "June 15 at 12:00 PM", + set the CustomFormat property to "MMMM dd 'at' t:mm tt". If the "at" substring is not enclosed by escape characters, + the result is "June 15 aP 12:00PM" because the "t" character is read as the one-letter A.M./P.M. format string (see the format string table below). + + + To display single quote in custom format use two single quotes characters like so '' after each other and they will be displayed as single quote. + + The following list shows all the valid format strings and their descriptions: + + + Format String + Description + + + d + The one- or two-digit day. + + + dd + The two-digit day. Single-digit day values are preceded by a 0. + + + ddd + The three-character day-of-week abbreviation. + + + dddd + The full day-of-week name. + + + jjj + The three-digit day-of-year day. Single and two-digit values are preceded by 0. + + + j + The three-digit day-of-year day. + + + h + The one- or two-digit hour in 12-hour format. + + + hh + The two-digit hour in 12-hour format. Single digit values are preceded by a 0. + + + H + The one- or two-digit hour in 24-hour format. + + + HH + The two-digit hour in 24-hour format. Single digit values are preceded by a 0. + + + m + The one- or two-digit minute. + + + mm + The two-digit minute. Single digit values are preceded by a 0. + + + M + The one- or two-digit month number. + + + MM + The two-digit month number. Single digit values are preceded by a 0. + + + MMM + The three-character month abbreviation. + + + MMMM + The full month name. + + + s + The one- or two-digit seconds. + + + ss + The two-digit seconds. Single digit values are preceded by a 0. + + + t + The one-letter A.M./P.M. abbreviation (A.M. is displayed as "A"). + + + tt + The two-letter A.M./P.M. abbreviation (A.M. is displayed as "AM"). + + + y + The one-digit year (2001 is displayed as "1"). + + + yy + The last two digits of the year (2001 is displayed as "01"). + + + yyyy + The full year (2001 is displayed as "2001"). + + + { + Starts the nested date-time group inside of the control. Note that nested groups must always be closed. + Nested date-time groups can be used to represent range of input date/time values in the control + To access nested values use Values property. For example to have control represent the input from two time values you could set + CustomFormat to 'from' {HH:mm} 'to' {HH:mm} which will create two nested date/time groups that represent the time value. Entered + time values can be accessed through Values property which return an array of all input values. + + + } + Ends the nested date-time input group. + + + + + + + Gets or sets the CultureInfo for the culture used by the DateTime Input controls and Month Calendar controls. + Default value is null which indicates that controls will use CurrentUICulture. + + + + + Gets or sets whether auto-overwrite functionality for input is enabled. When in auto-overwrite mode input field will erase existing entry + and start new one if typing is continued after InputComplete method is called. + + + + + Gets or sets whether check box shown using ShowCheckBox property which locks/unlocks the control update is checked. + + + + + Gets the object that describes the settings for the button that shows drop-down calendar when clicked. + + + + + Gets the object that describes the settings for the button that clears the content of the control when clicked. + + + + + Gets the object that describes the settings for the button that switches the control into the free-text entry mode when clicked. + + + + + Gets or sets whether input part of the control is read-only. When set to true the input part of the control becomes + read-only and does not allow the typing. However, drop-down part if visible still allows user to change the value of the control + Use this property to allow change of the value through drop-down picker only. + + + + + Gets or sets whether empty input values (year, month or day) are set to defaults while user is entering data. Default value is true. + + + + + Gets the reference to the internal MonthCalendarItem control which is used to display calendar when drop-down is open. + + + + + Gets or sets whether first day in month is automatically selected on popup date picker when month or year is changed. + + + + + Gets or sets whether input focus is automatically advanced to next input field when input is complete in current one. + + + + + List of characters that when pressed would select next input field. For example if you are + allowing time input you could set this property to : so when user presses the : character, + the input is forwarded to the next input field. + + + + + Gets or sets the date-time selectors visibility on popup. Default value is Auto which will select selector visibility based on Format property setting. + + + + + Returns reference to internal time selector item which is used on drop-down to select time when control is used in time entry mode. + + + + + Gets or sets the popup time selector time format used to present time by the selector i.e. 12H or 24H format. + + + + + Indicates the type of popup time selector used. + + + + + Gets or sets the command assigned to the item. Default value is null. + Note that if this property is set to null Enabled property will be set to false automatically to disable the item. + + + + + Gets or sets user defined data value that can be passed to the command when it is executed. + + + + + Occurs if Free-Text entry value is not natively recognized by the control and provides you with opportunity to convert that value to the + value control expects. + + + + + Occurs when Free-Text button is clicked and allows you to cancel its default action. + + + + + Gets or sets whether free text entries are attempted to be auto-resolved to dates like Today to today's date or Now to date and time now etc. Default value is true. + + + + + Gets or sets whether free-text entry is automatically turned off when control loses input focus. Default value is false. + + + + + Gets or sets whether control input is in free-text input mode. Default value is false. + + + + + Initializes a new instance of the DateTimeCellEditor class. + + + + + Represents cell display class. + + + + + Represents information necessary to paint the cell on canvas. + + + + + Initializes the tree color tables. + + + + + Provides data for RenderColumnHeader event. + + + + + Gets the column header that is rendered. + + + + + Target Graphics canvas. + + + + + Gets the bounds of the column header. + + + + + Gets the effective style for the column. + + + + + Gets the AdvTree control header is rendered for. + + + + + Gets or sets the color of the column sort indicator. + + + + + Initializes a new instance of the ColumnHeaderRendererEventArgs class. + + + + + Initializes a new instance of the ColumnHeaderRendererEventArgs class. + + + + + + + + + Represents helper class for node connector display. + + + + + From node reference. + + + + + From node style reference. + + + + + To node reference. + + + + + To node style reference. + + + + + Graphics object used for drawing. + + + + + Node offset since some node coordinates are relative. + + + + + Indicates whether from node is a root node. + + + + + Reference to node connector object that describes connector type. + + + + + Gets or sets whether connector is link connector. + + + + + Reference to the collection of the connector path points. Default value is null indicating there are no path points. + + + + + Provides data for the NodeRenderer.RenderDragDropMarker event. + + + + + Gets or sets reference to Graphics object, canvas node is rendered on. + + + + + Gets or sets the selection bounds. + + + + + Initializes a new instance of the DragDropMarkerRendererEventArgs class. + + + + + Initializes a new instance of the DragDropMarkerRendererEventArgs class. + + + + + + + Represents the line connector display class. + + + + + Base class for drawing node connectors. + + + + + Creates new instance of the object. + + + + + Draws connector line between two nodes. + + Connector context information. + + + + Returns new instance of pen object for node connector line. Caller is responsible for + disposing of this object. + + Node connector display info. + New instance of Pen object. + + + + Draws connector line between two nodes. + + Connector context information. + + + + Provides information for cell rendering methods and events. + + + + + Summary description for NodeRendererEventArgs. + + + + + Gets or sets reference to Graphics object, canvas node is rendered on. + + + + + Gets or sets the reference to Node object being rendered. + + + + + Gets or sets the absolute node bounds. + + + + + Gets or sets the reference to element style for rendered node or cell. Style provided here is the style + for current node or cell state. + + + + + Gets or sets color that is passed to renderer. May be Color.Empty. + + + + + Creates new instance of the class. + + + + + Gets or sets the cell being rendered. + + + + + Gets or sets absolute cell bounds. + + + + + Gets or sets the internal cell offset. + + + + + Gets or sets the color scheme. + + + + + Creates new instance of the class. + + + + + Creates new instance of the class and initializes it with default values. + + Reference to graphics object. + Reference to context node. + Reference to node bounds + Reference to cell style + Reference to cell + Reference to cell bounds + + + + Represents custom connector path info. + + + + + Summary description for NodeDisplay. + + + + Creates new instance of the class + Object to initialize class with. + + + + Paints the layout on canvas. + + + + + Sets locked offset to specific value. Point.Empty means there is no locked offset set. + + New locked offset. + + + + + + + + + + Gets or sets the offset of the tree content relative to the size of the container control. + + + + Gets or sets whether offset is locked, i.e. cannot be changed. + + + + Returns the default offset for the tree content relative to the size of the container. + + + + + Gets or sets the reference to the tree control managed by display class. + + + + + Base class for node expand button display. + + + + Creates new instance of the class + + + Draws expand button. + Context parameters for drawing expand button. + + + + Represents class that paints elliptical expand button. + + + + Draws ellipse type expand button. + Expand context drawing information. + + + + Represents expand button display using predefined images. + + + + + Draws image type expand button. + + Expand context information + + + + Represents event arguments for RenderExpandPart event. + + + + + Gets or sets reference to Graphics object, canvas node is rendered on. + + + + + Gets or sets the reference to Node object being rendered. + + + + Expand part bounds + + + Expand part border color + + + Expand part line color + + + Expand part background color + + + Expand part target gradient background color + + + Gradient angle + + + Expand part image when node is expanded + + + Expand part image when node is collapsed + + + Internal support for expand button types + + + Gets whether mouse is over expand part + + + + Creates new instance of the class and initializes it with default values. + + Reference to graphics object. + + + + Represents class that paints rectangular expand button. + + + + + Draw rectangular type expand button. + + Expand button context information. + + + + Draw triangular type expand button. + + Expand button context information. + + + + Represent class that paints selection around node. + + + + + Represents default system node and cell renderer. + + + + + Represents abstract renderer class for node objects. + + + + + Draws node background. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderNodeBackground method so events can occur. + + Information provided for rendering. + + + + Raises RenderNodeBackground event. + + Event arguments. + + + + Draws node expand part. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderNodeExpandPart method so events can occur. + + Information provided for rendering. + + + + Raises RenderNodeExpandPart event. + + + + + + Draws cell background. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderCellBackground method so events can occur. + + Information provided for rendering. + + + + Raises RenderCellBackground event. + + Event arguments + + + + Draws cell check box. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderCellCheckBox method so events can occur. + + Information provided for rendering. + + + + Raises RenderCellCheckBox event. + + Event arguments + + + + Draws cell image. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderCellImage method so events can occur. + + Information provided for rendering. + + + + Raises RenderCellImage event. + + Event arguments + + + + Draws cell text. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderCellText method so events can occur. + + Information provided for rendering. + + + + Raises RenderCellImage event. + + Event arguments + + + + Draws selection for SelectedNode. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderSelection method so events can occur. + + Information provided for rendering. + + + + Raises RenderSelection event. + + Event data. + + + + Draws hot-tracking marker for mouse over node. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderHotTracking method so events can occur. + + Information provided for rendering. + + + + Raises RenderHotTracking event. + + Event data. + + + + Draws connector between nodes. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderConnector method so events can occur. + + Information provided for rendering. + + + + Raises RenderConnector event. + + Event data. + + + + Draws the tree background. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderTreeBackground method so events can occur. + + Information provided for rendering. + + + + Raises RenderTreeBackground event. + + Event data. + + + + Draws the drag & drop marker that indicates the insertion point for the node. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderDragDropMarker method so events can occur. + + Information provided for rendering. + + + + Raises RenderDragDropMarker event. + + Event data. + + + + Draws the column header. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderColumnHeader method so events can occur. + + Information provided for rendering. + + + + Raises RenderDragDropMarker event. + + Event data. + + + + Draws node group line when in tile view. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderTileGroupLine method so events can occur. + + Information provided for rendering. + + + + Raises RenderNodeBackground event. + + Event arguments. + + + + Occurs when node background is being drawn. + + + + + Occurs when node expand part is being drawn. + + + + + Occurs when cell background is being drawn. + + + + + Occurs when cell check-box is being drawn. + + + + + Occurs when cell image is being drawn. + + + + + Occurs when cell text is being drawn. + + + + + Occurs when node selection marker is rendered. + + + + + Occurs when node hot-tracking marker is rendered. + + + + + Occurs when node connector is being drawn. + + + + + Occurs when tree background is rendered. + + + + + + Renders the Column Header. + + + + + Occurs when node group line is being rendered while control is in tile view. + + + + + Gets or sets the color table used by the renderer. + + + + + Gets or sets the color table used by the renderer. + + + + + Returns ElementStyleDisplayInfo class that provides information for ElementStyle rendering. + + Reference to style. + Reference to graphics object. + Style bounds + New instance of ElementStyleDisplayInfo + + + + Draws node background. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderNodeBackground method so events can occur. + + Information provided for rendering. + + + + Draws node expand part. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderNodeExpandPart method so events can occur. + + Information provided for rendering. + + + + Draws cell background. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderCellBackground method so events can occur. + + Information provided for rendering. + + + + Draws cell check box. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderCellCheckBox method so events can occur. + + Information provided for rendering. + + + + Draws cell image. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderCellImage method so events can occur. + + Information provided for rendering. + + + + Draws cell text. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderCellText method so events can occur. + + Information provided for rendering. + + + + Draws selection for SelectedNode. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderSelection method so events can occur. + + Information provided for rendering. + + + + Draws hot-tracking marker for mouse over node. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderHotTracking method so events can occur. + + Information provided for rendering. + + + + Draws connector between nodes. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderConnector method so events can occur. + + Information provided for rendering. + + + + Draws the tree background. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderTreeBackground method so events can occur. + + Information provided for rendering. + + + + Draws the drag & drop marker that indicates the insertion point for the node. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderDragDropMarker method so events can occur. + + Information provided for rendering. + + + + Draws the column header. If you need to provide custom rendering this is the method that you should override in your custom renderer. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderColumnHeader method so events can occur. + + Information provided for rendering. + + + + Draws node group line when in tile view. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderTileGroupLine method so events can occur. + + Information provided for rendering. + + + + Summary description for NodeTreeDisplay. + + + + Creates new instance of the class + Object to initialize class with. + + + + Paints the tree on canvas. + + + + + Defines the color table for tree selection. + + + + + Gets or sets the outer border for the selection. + + + + + Gets or sets the outer border corner radius. + + + + + Gets or sets the inner border for the selection. + + + + + Gets or sets the selection fill. + + + + + Gets or sets the selection text color. + + + + + Data form RenderSelection event. + + + + + Gets or sets reference to Graphics object, canvas node is rendered on. + + + + + Gets or sets the reference to selected Node object. + + + + + Gets or sets the selection bounds. + + + + + Gets or sets the node selection box style. + + + + + Gets or sets whether tree control is active, focused. + + + + + Provides data for tree background rendering events. + + + + + Gets or sets reference to Graphics object, canvas tree background is rendered on. + + + + + Gets or sets the reference to AdvTree control. + + + + + Creates new instance of the class and initializes it with default values. + + Reference to graphics object. + + + + Defines the Tree color table. + + + + + Gets or sets the color table used for the node selection display. + + + + + Gets or sets the color for node drag & drop marker. + + + + + Gets or sets the color of tree expand button type of rectangle. + + + + + Gets or sets the color of tree expand button type of Ellipse. + + + + + Gets or sets the color of tree expand button type of Triangle. + + + + + Gets or sets the color for tree grid lines. + + + + + Gets or sets the color of the column sort indicator which is rendered on columns when sorted. + + + + + Defines the color table for node expand button. + + + + + Gets or sets the border for the expand button which expands the node. + + + + + Gets or sets the expand button fill for button that expands the node. + + + + + Gets or sets the expand button foreground for button that expands the node. + + + + + Gets or sets the border for the expand button which expands the node. + + + + + Gets or sets the expand button fill for button that expands the node. + + + + + Gets or sets the expand button foreground for button that expands the node. + + + + + Gets or sets the border for the expand button which collapses the node. + + + + + Gets or sets the expand button fill for button that collapses the node. + + + + + Gets or sets the expand button foreground for button that expands the node. + + + + + Gets or sets the border for the expand button which collapses the node. + + + + + Gets or sets the expand button fill for button that collapses the node. + + + + + Gets or sets the expand button foreground for button that expands the node. + + + + + Defines the color table for tree selection. + + + + + Gets or sets the color table for FullRowSelect selection type. + + + + + Gets or sets the color table for FullRowSelect selection type when tree control is inactive. + + + + + Gets or sets the color table for HighlightCells selection type. + + + + + Gets or sets the color table for HighlightCells selection type when tree control is inactive. + + + + + Gets or sets the color table for NodeMarker selection type. + + + + + Gets or sets the color table for NodeMarker selection type when tree control is inactive. + + + + + Gets or sets the color table used for node hot-tracking. + + + + + Creates the pen for the border. + + Returns pen or null if pen cannot be created. + + + + Gets or sets the border width. Default value is 0. + + + + + Represents Collection for the ColorStop objects. + + + + Creates new instance of the class. + + + + Adds new object to the collection. + + Object to add. + Index of newly added object. + + + + Adds array of new objects to the collection. + + Array of object to add. + + + + Inserts new object into the collection. + + Position of the object. + Object to insert. + + + + Returns index of the object inside of the collection. + + Reference to the object. + Index of the object. + + + + Returns whether collection contains specified object. + + Object to look for. + true if object is part of the collection, otherwise false. + + + + Removes specified object from the collection. + + + + + + Copies collection into the specified array. + + Array to copy collection to. + Starting index. + + + + Copies contained items to the ColorStop array. + + Array to copy to. + + + + Creates ColorBlend object based on the members of the collection. ColorBlend object will be valid only if all members of the collection + represents relative/percentage based color blends. + + + + + + Adds the ColorStop objects from the collection. + + Collection to copy objects from + + + + Initializes the collection with the two color blend. + + Collection to initialize. + Start color. + End color. + + + + Returns reference to the object in collection based on it's index. + + + + + Defines single color blend point for the multicolor gradient fills. + + + + + Creates new instance of the class. When defining multicolor gradient blends and using the percentage positions the positions created + must start with 0f and end with 1f. + + + + + Creates new instance of the class and initialize it with default values. + + + + + Gets or sets Color to use in multicolor gradient blend at specified position. + + + + + Gets or sets the color position in multicolor gradient blend. Values less or equal to 1 are used as percentage specifing percentages of distance along the gradient line. + Values greater than 1 are used as absolute pixel values of distance along the gradient line. + + + + + Represents BackgroundColorBlend object converter. + + + + + Creates the brush for fill. + + Bounds for the brush + Returns brush or null if brush cannot be created for given bounds or colors are not set. It is responsibility of caller to Dispose the brush. + + + + Creates a pen based on fill parameters. + + Width of the pen to create + new instance of pen or null if pen cannot be created. + + + + Initializes a new instance of the GradientFill class. + + + + + Initializes a new instance of the GradientFill class. + + + + + + + Initializes a new instance of the GradientFill class. + + + + + + + + Initializes a new instance of the GradientFill class. + + + + + + Initializes a new instance of the GradientFill class. + + + + + + Creates the brush for fill. + + Bounds for the brush + Returns brush or null if brush cannot be created for given bounds or colors are not set. It is responsibility of caller to Dispose the brush. + + + + Gets whether property should be serialized. + + true if property should be serialized + + + + Sets the property to its default value. + + + + + Gets whether property should be serialized. + + true if property should be serialized + + + + Sets the property to its default value. + + + + + Creates a pen based on fill parameters. + + Width of the pen to create + new instance of pen or null if pen cannot be created. + + + + Gets or sets the starting gradient fill color. + + + + + Gets or sets the end gradient fill color. + + + + + Gets the collection that defines the multicolor gradient background. + + + Setting this property creates a multicolor gradient with one color at each position along the gradient line. Setting this property nullifies all previous color, position, and falloff settings for this gradient fill. + + + + + Gets or sets the gradient fill angle. Default value is 90. + + + + + Defines a visual shape. + + + + + Renders shape on canvas. + + Target graphics to render shape on. + Shape bounds. + + + + Gets or sets the single piece of content inside of the shape. + + + + + Gets or sets whether to clip the Content of this shape. Default value is false. + + + + + Renders rectangle on canvas. + + Target graphics to render shape on. + Shape bounds. + + + + Gets whether property should be serialized. + + + + + Resets the property to its default value. + + + + + Gets or sets shape border. + + + + + Gets or sets the shape fill. + + + + + Gets or sets the CornerRadius. + + + + + Initializes a new instance of the SolidBorder class. + + + + + + + Initializes a new instance of the SolidBorder class. + + + + + + Initializes a new instance of the SolidBorder class. + + + + + Creates the pen for the border. + + Returns pen or null if pen cannot be created. + + + + Gets whether property should be serialized. + + true if property should be serialized + + + + Sets the property to its default value. + + + + + Gets or sets the fill color. + + + + + Initializes a new instance of the SolidFill class. + + + + + + Initializes a new instance of the SolidFill class. + + + + + Creates the brush for fill. + + Bounds for the brush + Returns brush or null if brush cannot be created for given bounds or colors are not set. It is responsibility of caller to Dispose the brush. + + + + Gets whether property should be serialized. + + true if property should be serialized + + + + Sets the property to its default value. + + + + + Gets or sets the fill color. + + + + + Specifies layout of the items in AdvTree control. + + + + + Standard TreeView layout. + + + + + ListView style tile layout. + + + + Specifies the way background image is displayed on background. + + + Image is stretched to fill the background + + + Image is centered inside the background + + + Image is tiled inside the background + + + + Image is drawn in top left corner of container space. + + + + + Image is drawn in top right corner of container space. + + + + + Image is drawn in bottom left corner of container space. + + + + + Image is drawn in bottom right corner of container space. + + + + Indicates alignment of a part of the cell like image or check box in relation to the text. + + + + Part is aligned to the left center of the text assuming left-to-right + orientation. + + + + + Part is aligned to the right center of the text assuming left-to-right + orientation. + + + + + Part is aligned to the top left of the text assuming left-to-right + orientation. + + + + Part is aligned above the text and centered. + + + + Part is aligned to the top right of the text assuming left-to-right + orientation. + + + + + Part is aligned to the bottom left of the text assuming left-to-right + orientation. + + + + Part is aligned below the text and centered. + + + + Part is aligned to the bottom right of the text assuming left-to-right + orientation. + + + + + Part has default alignment that depends on the parent control view. + + + + + Specifies how to trim characters from a text that does not completely fit into a element's shape. + + + + + Specifies that the text is trimmed to the nearest character. + + + + + Specifies that the text is trimmed to the nearest character, and an ellipsis is inserted at the end of a trimmed line. + + + + + The center is removed from trimmed lines and replaced by an ellipsis. The algorithm keeps as much of the last slash-delimited segment of the line as possible. + + + + + Specifies that text is trimmed to the nearest word, and an ellipsis is inserted at the end of a trimmed line. + + + + + Specifies no trimming. + + + + + Specifies that text is trimmed to the nearest word. + + + + + Indicates absolute vertical alignment of the content. + + + + + Content is aligned to the top + + + + + Content is aligned in the middle + + + + + Content is aligned at the bottom + + + + + Indicates absolute horizontal alignment + + + + + Content is left aligned + + + + + Content is centered + + + + + Content is right aligned + + + + + Indicates prefered node layout position on Map tree layout when node is the child node of the top-level root node. + + + + + Node is positioned based on default algorithm. + + + + + Sub-root node and all nodes after it are positioned to the left of the root. + + + + + Sub-root node and all nodes before it are positioned to the right of the root. + + + + + Specifies the column header visibility for the node. + + + + + Column header is automatically shown/hidden based on the node's position in the tree. When + Node is first child node i.e. with index=0 the header will be shown, otherwise header will + be hidden. + + + + + Column header is always displayed regardless of node's position. + + + + + Column header is always hidden regardless of node's position. + + + + + Indicates the part of the node. + + + + + Bounds of complete node content except expand button. This also includes the child node bounds if node is expanded. + + + + + Bounds of the expand button which collapses/expands the node. + + + + + Hit test bounds of the expand button which collapses/expands the node used by mouse routines to trigger node expansion/collapse. + + + + + Bounds of all child nodes of give node. + + + + + Bounds for cells inside a node. + + + + + Complete node bounds including expand button. + + + + + Bounds of the command button. + + + + + Bounds of child node columns if node has columns defined. + + + + + Indicates the part of the cell. + + + + + Bounds of check box or Rectangle.Empty if there is no check-box. + + + + + Bounds of image inside the cell or Rectangle.Empty if there is no image. + + + + + Text bounds inside of cell. + + + + + Cell bounds + + + + + Indicates part of the node mouse is placed over. + + + + + Mouse is not over any node part. + + + + + Mouse is placed over the node. + + + + + Mouse is placed over node expand button. + + + + + Mouse is placed over the cell. + + + + + Mouse is placed over the command button. + + + + + Indicates the visibility of node expand part which allows user to expand/collaps node. + + + + + Default setting which indicates that when node has child nodes expand part is visible otherwise it is hidden. + + + + + Expand part is always visible regardless of whether child nodes are present or not. + + + + + Expand part is always hidden regardless of whether child nodes are present or not. + + + + + Specifies the action that raised a AdvTreeEventArgs event + + + + + The event was caused by a keystroke. + + + + + The event was caused by a mouse operation. + + + + + The event was caused by the Node collapsing. + + + + + The event was caused by the Node expanding. + + + + + The event is caused programmatically from user code. + + + + + Specifies node connector type. Node connector is the type of the line/connection that is drawn to connect child node to it's parent node. + + + + + Straight line connector type. + + + + + Specifies the layout type used to position the cells within the nodes. + + + + + Specifies that default setting is to be used for cell layout. Default is Horizontal. When set to default on the Node, setting from Tree control is used. + + + + Horizontal layout positions the cells horizontally next to each other. + + + + Vertical layout positions cell vertically on top of each other. + + + + + Specifies the layout type used to position the parts of the cell like image, checkbox and text. + + + + + Specifies that default setting is to be used for cell parts layout. Default is Horizontal. When set to default on the Cell, setting from Tree control is used. + + + + Horizontal layout positions the parts of the cell horizontally next to each other. + + + + Vertical layout positions parts of the cell vertically on top of each other. + + + + + Specifies the color scheme loaded by ColorScheme object. + + + + + Indicates Office 2003 like color scheme. + + + + + Indicates VS.NET 2005 like color scheme. + + + + + Indicates Office 2007 like color scheme. + + + + + Specifies the currently selected system color scheme if running on Windows XP. + + + + + Color scheme cannot be determined. + + + + + Blue color scheme. + + + + + Olive green color scheme. + + + + + Silver color scheme. + + + + + Specifies the flow of diagram layout related to the root node. + + + + + Nodes are positioned from left to right with root node being the left-most node. + + + + + Nodes are positioned from right to left with root node being the right-most + node. + + + + + Nodes are positioned from top to bottom with root node being the top node. + + + + + Nodes are positioned from bottom to top with root node being bottom node. + + + + + Specifies the flow of the map layout. + + + + + Nodes are arranged around the root node. + + + + + Nodes are arranged from below the root node. + + + + + Nodes are arranged above the root node. + + + + + Nodes are arranged to the right of the root node. + + + + + Nodes are arranged to the left of the root node. + + + + + Specifies the type of the expand button. + + + + + Indicates elliptical expand button. + + + + + Indicates rectangular expand button. + + + + + Indicates that images are used for expand button. + + + + + Indicates the Windows Vista style expand button. + + + + + Specifies the visual style for the tree control. + + + + + Indicates default visual style. + + + + + Specifies the layout type for the nodes. + + + + + Nodes are arranged around root node in map format. + + + + + Nodes are arranged from left-to-right in diagram format. + + + + + Specifies renderer type used to render nodes. + + + + + Specifies default renderer which allows most customization through AdvTree + properties. Default renderer integrates with the Style architecture to provide + customization on renderer behavior. + + + + + Specifies that custom renderer is used. When set you must also set NodeRenderer + to renderer you want to use. + + + + + Specifies the node selection style. + + + + + Node selector highlights the complete node row when node is selected. + + + + + Node selector draws the rectangle that highlights the node content. Appearance similar to system tree view in Windows Vista. + + + + + Node selector draws hollow selection rectangle around the node. + + + + + Specifies the rule for multi-node selection. + + + + + Allows multiple selection of nodes with same parent node only. + + + + + Allows multiple selection of any node. + + + + + Gets or sets the image alignment inside of column header. + + + + + Image is left aligned. + + + + + Image is right aligned. + + + + + Specifies the editor type used when cell is edited. + + + + + Indicates default, text based editor. + + + + + Indicates that Integer numeric editor will be used for editing the value of the cell or column. + + + + + Indicates that Double numeric editor will be used for editing the value of the cell or column. + + + + + Indicates that Currency numeric editor will be used for editing the value of the cell or column. + + + + + Indicates that date editor will be used for editing the value of the cell or column. + + + + + Indicates that time editor will be used for editing the value of the cell or column. + + + + + Indicates that date and time editor will be used for editing the value of the cell or column. + + + + + Indicates that cell will use custom editor that you provide by handling AdvTree.ProvideCustomCellEditor event. + + + + + Specifies the sort direction for the column header. + + + + + No sort is specified. + + + + + Ascending sorting is in effect, i.e. A-Z + + + + + Descending sorting is in effect, i.e. Z-A + + + + + Defines the delegate for AdvTree cell based action events. + + + + + Defines the delegate for AdvTree cell based action events. + + + + + Defines the delegate for AdvTree node based action events that can be cancelled. + + + + + Defines the delegate for AdvTree node based action events. + + + + + Defines delegate for Command button events. + + + + + Defines delegate for label editing events. + + + + + Defines the delegate for AdvTree node based action events. + + + + + Defines the delegate for BeforeNodeDrop and AfterNodeDrop events + + + + + Defines the delegate for NodeDragFeedback event. + + + + + Defines the delegate for mouse based node events + + + + + Defines delegate for node rendering events. + + + + + Defines delegate for cell rendering events. + + + + + Defines delegate for RenderExpandPart event. + + + + + Defines delegate for RenderExpandPart event. + + + + + Defines delegate for RenderConnector event. + + + + + Defines delegate for TreeBackgroundRenderer events. + + + + + Defines delegate for RenderDragDropMarker event. + + + + + Defines delegate for RenderColumnHeader event. + + + + + Provides data for the ProvideCustomCellEditor event. + + + + + Gets or sets the cell editor. You must set this property in your event handler to the custom + editor to be used for cell editing. + + + + + Gets the cell editor will be used for. + + + + + Initializes a new instance of the CustomCellEditorEventArgs class. + + + + + + Defines delegate for ProvideCustomCellEditor event. + + + + + Provides more information about MarkupLinkClick event. + + + + + Gets the value of href attribute from the markup link that was clicked. + + + + + Gets the value of name attribute from the markup link that was clicked. + + + + + Creates new instance of the object. + + Value of name attribute. + Value of href attribute. + + + + Defines delegate for MarkupLinkClick event. + + + + + Represents arguments for SerializeNode event which allows you to add custom serialization data to definitions saved by control. + + + + + Gets reference to the node being serialized or de-serialized. + + + + + Gets reference to instance of XmlElement that item is serialized to or is being de-serialized from. You should not change any data directly on this element. + + + + + Gets the reference to XmlElement that you can serialize to or de-serialize any custom data from. You can add child elements or set the attributes on + this XmlElement when handling SerializeItem event. When handling DeserializeItem event you can load your data from this element. + + + + + Defines delegate for SerializeItem event. + + + + + Represents the table header. + + + + + Default constructor. + + + + + Gets the reference to the collection that contains the columns associated with header. + + + + + Gets or sets the name associated with this header definition. + + + + + Represents collection for HeaderDefinition objects. + + + + + Sets the node collection belongs to. + + HeaderDefinition that is parent of this collection. + + + + Adds new object to the collection. + + Object to add. + Index of newly added object. + + + + Inserts new object into the collection. + + Position of the object. + Object to insert. + + + + Returns index of the object inside of the collection. + + Reference to the object. + Index of the object. + + + + Returns whether collection contains specified object. + + Object to look for. + true if object is part of the collection, otherwise false. + + + + Removes specified object from the collection. + + + + + + Copies collection into the specified array. + + Array to copy collection to. + Starting index. + + + + Copies contained items to the HeaderDefinition array. + + Array to copy to. + + + + Gets or sets the node this collection is associated with. + + + + + Returns reference to the object in collection based on it's index. + + + + + Provides WinApi functions to rest of the application. + + + + + Resets Hoover timer for specified control. + + + + + Provides AdvTree Keyboard handling. + + + + + Represents class for Node's cell layout. + + + + + Offset cell bounds, check box bounds, image bounds and text bounds by specified offset. + + Cell to offset. + Horizontal offset in pixels. + Vertical offset in pixels. + + + + Returns spacing between check box and image if both are displayed + + + + + Returns spacing between image or checkbox and text + + + + + Returns vertical spacing between cells in a node + + + + + Spacing between different parts of the cell, like image, option button, text and expand button area + + + + + Initializes a new instance of the CellTileLayout class. + + + + + Class that is used to layout column header. + + + + + Gets or sets the vertical spacing between nodes in pixels. + + + + + Gets or sets the horizontal spacing between nodes in pixels. + + + + + Returns horizontal spacing between cells in a node + + + + + Returns width of the expand button area. Default is 24 pixels. + + + + + Gets or sets the size of the expand part that is expanding/collapsing the node. Default value is 8,8. + + + + + Gets or sets width of command button area. Default is 8 pixels. + + + + + Summary description for NodeLayout. + + + + + Performs layout of the nodes inside of the tree control. + + + + + Performs layout for single unassigned node. Node does not have to be part of the tree control. + + Node to perform layout on. + + + + Resizes all styles and prepares them for layout. + + + + + Returns default top-level columns for tree control. + + Returns array list of ColumnInfo objects. + + + + Returns column information for a given node. + + Node to return column information for + Returns array list of ColumnInfo objects or null if there are no columns defined. + + + + Returns column header collection for the given column template name. + + Name of the column template. + Column header collection or null if template name cannot be found. + + + + Sets the position and size of the node command button. + + Node layout context information + + + + Determines the rectangle of the +/- part of the tree node that is used to expand node. + + Node layout context information + + + + Returns the size of the node expand part. + + Size of the expand part, default 8,8. + + + + Provides the layout for single node. + + Layout information. + + + + Returns true if given node has expand part. + + Layout context information. + + + + + Returns whether given node has command part. + + Layout context information. + True if command part should be drawn otherwise false. + + + + Returns class responsible for cell layout. + + Cell layout class. + + + + Offsets node location and location of it's child nodes bounds. + + Node to offset. + Horizontal offset. + Vertical offset. + + + + Gets or sets layout settings. + + + + + Gets or sets the child node indent in pixels. + + + + + Returns true if root node should have expanded part + + + + + Returns true if expand part space should be accounted for even if they expand part is not visible or need to be displayed. Default value is false. + + + + + Initializes a new instance of the NodeColumnInfo structure. + + + + + + + Gets or sets the list of column info object for the columns. + + + + + Gets or sets whether columns have auto-size column. + + + + + Used to pass node contextual information used for layout of the node. + + + + + Performs ListView Tile style layout. + + + + + Returns default top-level columns for tree control. + + Returns array list of ColumnInfo objects. + + + + Gets whether the expand part of the node +/- is aligned to the left of the node in left-to-right layout. + + Node to get expand part alignment for + true if node expand part is aligned to the left in left-to-right layout. + + + + Returns column information for a given node. + + Node to return column information for + Returns array list of ColumnInfo objects or null if there are no columns defined. + + + + Returns true if given node has expand part. + + Layout context information. + + + + + Returns class responsible for cell layout. + + Cell layout class. + + + + Returns true if expand part space should be accounted for even if they expand part is not visible or need to be displayed. Default value is false. + + + + + Gets or sets whether parent/child node relationship is displayed as groups. + + + + + Performs classic TreeView layout. + + + + + Gets whether the expand part of the node +/- is aligned to the left of the node in left-to-right layout. + + Node to get expand part alignment for + true if node expand part is aligned to the left in left-to-right layout. + + + + Returns true if expand part space should be accounted for even if they expand part is not visible or need to be displayed. Default value is false. + + + + + Represents the Node in Tree control. + + + + Default Constructor. + + + + Creates node and initializes its text. + + + + + Creates node and initializes its text and Style property. + + + + + Sets the bounds of the node. + + New location and size of the node. + + + + Sets the content bounds of the node. Content bound is bound for the the cells inside the node + and it excludes the expand rectangle. Bounds also include the node style padding and + reflect node margin. + + New location and size of the node. + + + + Sets cell bounds. + + New cells bounds. + + + + Sets node parent. + + Parent node object. + + + + Called when Parent of the node has changed. + + + + + Sets the bounds of the expand part. + + New part bounds. + + + + Sets the Checked or CheckState properties. + + New value for checked state. + Action source. + + + + Sets the Checked or CheckState properties. + + New value for checked state. + Action source. + + + + Sets whether node is in edit mode or not. + + True indicating that node is in edit mode false otherwise. + + + + Sets selected cell and provides information on the action that caused the selection change. + + New selected cell. + Action source. + + + + Resets image to its default value. Windows Forms designer support. + + + + + Resets image to its default value. Windows Forms designer support. + + + + + Resets ImageMouseOver to its default value. Windows Forms designer support. + + + + + Resets ImageExpanded to its default value. Windows Forms designer support. + + + + + Called after node has been deselected. + + Provides information on how selection was performed + + + + Called after node has been selected. + + Provides information on how selection was performed + + + + Returns cell within a node which contains specified coordinates. + + + + Cell which contains specified coordinates or null/nothing if no cell contains coordinates. + + + + Invalidates the layout for this node and causes the layout to be performed on next layout request. + + + + + Invalidates the layout for this node and causes the layout to be performed on next layout request. + + Indicates whether to invalidate layout for all child nodes as well. + + + + Invalidates node and causes a paint message to be sent to the tree. + + + + Initiates the editing of node text. + + This method by default edits text stored in Node.Text. Call to this method is + same as calling the overload method BeginData(0) with zero as parameter. Use BeginData + overload method to begin editing the specific column for multi-column nodes. + + + + Initiates the editing of node text. + + The initial text to be entered into the edit TextBox. Specify null to use existing text. + + + + Initiates text editing of certain Node column. + + Zero based index of a column to begin editing for. Column 0 always corresponds to + Node.Text property. + + + + Initiates text editing of certain Node column. + + Zero based index of a column to begin editing for. Column 0 always corresponds to + Node.Text property. + + + The initial text to be entered into the edit TextBox. Specify null to edit existing text. + + + + + Creates new instance of the node for the Copy() and DeepCopy() methods. Allows you to returns your own node type copy if you inherit from node to add custom properties. + + New instance of a node. + + + Makes a "shallow" copy of a Node. + + Shallow copy of a Node is a exact copy of Node but without copy + of all child nodes in Nodes collection. + + + + + Copies this node properties to a node. + + Node top copy properties to. + + + Makes a "deep" copy of a node. + + Deep copy of Node is a exact copy of Node including exact copies of all child nodes + in this node's Nodes collection. + + + + + Collapses the tree node. + + + + + Collapses the tree node. + + Action that caused the event + + + + Collapses all the child tree nodes. + + + + + Ends the editing of the node text or column. + + true if the editing of the tree node label text was canceled without being saved; otherwise, false. + + + + Ensures that the node is visible, expanding nodes and scrolling the control as necessary. + + + + + Ensures that the node is visible, expanding nodes and scrolling the control as necessary. + + Indicates the position within a tree visible area node is scrolled to + + + + Expands the node. + + + The Expand method expands the current Node down to the next level of nodes. + The state of a Node is persisted. For example, if the next level of child nodes was not collapsed previously, when the Expand method is called, the child nodes appear in their previously expanded state. + + + + + Expands the node. + + + The Expand method expands the current Node down to the next level of nodes. + The state of a Node is persisted. For example, if the next level of child nodes was not collapsed previously, when the Expand method is called, the child nodes appear in their previously expanded state. + + Action that caused the event. + + + + Expands all the child tree nodes. + + + + + Expands all the child tree nodes. + + + + + Removes the current node from the control. + + + When the Remove method is called, the node and any child nodes assigned to the Node are removed from the Tree. The removed child nodes are removed from the Tree, but are still attached to this node. + + + + + Removes the current node from the control and provides information about source of action + + + When the Remove method is called, the node and any child nodes assigned to the Node are removed from the Tree. The removed child nodes are removed from the Tree, but are still attached to this node. + + + + + Toggles the node to either the expanded or collapsed state. + + + + + Toggles the node to either the expanded or collapsed state. + + Action that caused the event. + + + Returns string representation of the Node. + + + + Called after new cell has been added to Cells collection. + + Reference to the new cell added. + + + + Called after cell has been removed from Cells collection. + + Reference to the removed cell. + + + + Occurs when property on the node has changed that influences the size of the node. + + + + + Occurs when any image property for the cell has changed. + + + + + Occurs when size of the child nodes has changed. + + + + + Called before Expanded state of the node has changed. + + New Expand State + Action Source + + + + Called when visual part of the node has changed due to the changes of its properties or properties of the cells contained by node. + + + + + Called after new node has been added to Nodes collection. + + Reference to the new node. + + + + Called after node has been removed from Nodes collection. + + Reference to the node that is removed. + + + + Creates new cells based on the columns defined on either parent node or the columns in tree control. Node + must be parented so it can get reference to a parent tree control. + + + + + Raises the Click event on node and parent tree if available. + + + + + Provides implementation for IComparable interface. This is used for sorting and it compares the Text property on nodes. + + + + + + + Occurs when the mouse pointer is over the node and a mouse button is pressed. + + + + + Occurs when the mouse pointer is over the node and a mouse button is released. + + + + + Occurs when the mouse pointer is moved over the node. + + + + + Occurs when the mouse enters the node. + + + + + Occurs when the mouse leaves the node. + + + + + Occurs when the mouse hovers over the node. + + + + + Occurs when the node is clicked with left mouse button. If you need to know more information like if another mouse button is clicked etc. use + NodeMouseDown event. + + + + + Occurs when the node is double-clicked. + + + + + Occurs when hyperlink in text-markup is clicked. + + + + + Gets whether node has child nodes. + + + + + Gets or sets the context menu assigned to this node. Standard Context Menus, VS.NET 2005 Context Menus and DotNetBar Suite context menus are supported. + Default value is null (Nothing) which indicates that no context menu is assigned. + + + + + Gets whether any of the cells inside the node has HostedControl property set. + + + + + Gets or sets custom node renderer. You can set this property to your custom renderer. When set the RenderMode should be set to custom to enable + your custom renderer. To choose one of the system renderer use RenderMode property. Default value is null. + + + + + Gets or sets the render mode used to render the node. Default value is eNodeRenderMode.Default which indicates that system default renderer is used. + Note that if you specify custom renderer you need to set either AdvTree.NodeRenderer or Node.NodeRenderer property. + + + + + Gets or sets whether node is expanded. Expanded node shows it's child nodes. + + + + + Returns name of the node that can be used to identify it from the code. + + + + + Gets or sets whether node can be dragged and dropped. Default value is true. + + + + + Gets or sets visibility of the expand button. Default value is Auto meaning that + expand button is displayed only if node has at least one child node. + + + You can use this property for example to dynamically load the child nodes when user + tries to expand the node. You could for example handle BeforeExpand event to load child + nodes into the node. + + + + + Gets or sets whether any operation on the node has been performed that would affect node's size. Size changed flag + internally indicates that node's size needs to be recalculated because it has changed + due to the changes in data. + + + + + Gets the relative bounds of the tree node including the expand part of the node. + + + + + Gets the absolute bounds of the tree node including the expand part of the node. + + + + + Gets the node content bounds. + + + + + Gets the bounds for all the cells inside the node. The bounds do not include the expand part. + + + + + Gets the bounds for all the cells inside the node. The bounds do not include the expand part. + + + + + Gets or sets the bounds of child nodes. + + + + + Gets the expand part rectangle. Expand part is used to expand/collapse node. + + + + + Gets the expand part rectangle. Expand part is used to expand/collapse node. + + + + + Indicates vertical alignment within the node bounds of expand part of the node, if one is visible. + + + + + Gets or sets the Command part bounds if command part is visible. + + + + + Gets or sets a value indicating whether the tree node is in a checked state. + + + + + Gets or sets the checkbox alignment in relation to the text displayed by first default cell. + + + + + Gets or sets whether check box is visible inside the cell. + + + + + Gets or sets the appearance style of the item. Default value is CheckBox. Item can also assume the style of radio-button. + + + + + Gets or sets a value indicating whether the CheckBox will allow three check states rather than two. If the ThreeState property is set to true + CheckState property should be used instead of Checked property to set the extended state of the control. + + + + + Specifies the state of a control, such as a check box, that can be checked, unchecked, or set to an indeterminate state. + + + + + Gets or sets whether first cell content is editable when cell editing is enabled on tree control. Default value is true. + + + + + Gets the path from the root tree node to the current tree node. The path consists of the labels of all the tree nodes that must be navigated to get to this tree node, starting at the root tree node. The node labels are separated by the delimiter character specified in the PathSeparator property of the Tree control that contains this node. + + + + + Gets the zero based index of position of the tree node in the tree node collection. -1 is returned if node is not parented. If node is root node + the index of node in AdvTree.Nodes collection is returned. + + + + + Gets a value indicating whether the tree node is in an editable state. true if the tree node is in editable state; otherwise, false. + + + + + Gets whether left mouse button is pressed on any cell contained by this node. + + + + + Gets whether mouse cursor is over on any cell contained by this node. + + + + + Gets a value indicating whether the tree node is in the selected state. true if the tree node is in the selected state; otherwise, false. + + + + + Gets or sets whether node can be selected by user by clicking it with the mouse or using keyboard. Default value is true. + + + + + Gets whether node can be selected. Node must be Visible, Enabled and Selectable in order for it to be selected. + + + + + Gets or sets a cell that is in selected state otherwise it returns null. + + + + + Gets a value indicating whether the tree node is visible. Node is considered to be visible when it's Visible property is set to true and path to the node is available i.e. all parent nodes are expanded. + + + + + Returns whether node is displayed on the screen and visible to the user. When node is outside of the viewable area this property will return false. It will also return false if node is not visible. + + + + + Gets the last child tree node. The LastNode is the last child Node in the NodeCollection stored in the Nodes property of the current tree node. If the Node has no child tree node, the LastNode property returns a null reference (Nothing in Visual Basic). + + + + + Gets the next sibling tree node. The NextNode is the next sibling Node in the NodeCollection stored in the Nodes property of the tree node's parent Node. If there is no next tree node, the NextNode property returns a null reference (Nothing in Visual Basic). + + + + + Gets the next visible tree node. The NextVisibleNode can be a child, sibling, or a tree node from another branch. If there is no next tree node, the NextVisibleNode property returns a null reference (Nothing in Visual Basic). + + + + + Gets the zero-based depth of the tree node in the tree control. The root node is considered the first level of nesting and returns 0. + + + + + Gets the collection of Node objects assigned to the current tree node. The Nodes property can hold a collection of other Node objects. Each of the tree node in the collection has a Nodes property that can contain its own NodeCollection. Nesting of tree nodes can make it difficult to navigate a tree structure. The FullPath property makes it easier to determine your location in a tree. + + + + + Gets whether there is at least one child node that has its Visible property set to true. + + + + + Gets the parent tree node of the current tree node. If the tree node is at the root level, the Parent property returns a null reference (Nothing in Visual Basic). + + + + + Gets the previous sibling tree node. The PrevNode is the previous sibling Node in the NodeCollection stored in the Nodes property of the tree node's parent Node. If there is no previous tree node, the PrevNode property returns a null reference (Nothing in Visual Basic). + + + + + Gets the previous visible tree node. The PrevVisibleNode can be a child, sibling, or a tree node from another branch. If there is no previous tree node, the PrevVisibleNode property returns a null reference (Nothing in Visual Basic). + + + + + Gets or sets the object that contains data about the tree node. Any Object derived type can be assigned to this property. If this property is being set through the Windows Forms designer, only text can be assigned. + + + + + Gets or sets the object that contains data about the tree node. Any Object derived type can be assigned to this property. If this property is being set through the Windows Forms designer, only text can be assigned. + + + + + Gets or sets the Binding index in CurrencyManager list if node is bound. You should not change this value directly since + it is used internally by the control for data binding scenarios. + + + + + Gets or sets the object that contains additional data about the tree node. Any Object derived type can be assigned to this property. If this property is being set through the Windows Forms designer, only text can be assigned. + This property has same function as Tag property and provides you with additional separate storage of data. + + + + + Gets or sets the object that contains additional data about the tree node. Any Object derived type can be assigned to this property. If this property is being set through the Windows Forms designer, only text can be assigned. + This property has same function as Tag property and provides you with additional separate storage of data. + + + + + Gets or sets the format that is applied to the value of Text property for display purposes (applies to first cell in a node, i.e. Cells[0]). See "Formatting Overview" in MSDN + for description on available format strings. For example you can specify "C" to format text as currency, or "D" to format text as decimal number etc. + + + + + + Gets or sets the text displayed in the tree node. + + + + + Gets or sets the control hosted inside of the first node cell. + + + When control is hosted inside of the cell, cell size is determined by the + size of the control hosted inside of it. The cell will not display its text but it will display any image assigned + or check box when control is hosted inside of it. The Style settings like Margin + and Padding will still apply. + + + + + Gets or sets the item hosted inside of the first cell. Only items that do not generate + popups are supported. Note that cell can only host either HostedItem or HostedControl but not both. + + + + + Gets the parent tree control that the tree node is assigned to. + + + + + Gets or sets the layout of the cells inside the node. Default value is Horizontal layout which + means that cell are positioned horizontally next to each other. + + + + + Gets or sets the cell alignment when CellLayout=Vertical. Default value is center which means that cells are center aligned. + + + + + Gets or sets the layout of the cell parts like check box, image and text. Layout can be horizontal (default) + where parts of the cell are positioned next to each other horizontally, or vertical where + parts of the cell are positioned on top of each other vertically. + Alignment of the each part is controlled by alignment properties. This property affects only the first cell inside of the node. + Use Cell.Layout property to change the part layout on each cell contained by node. + + + + + Gets/Sets informational text (tooltip) for the cell. + + + + + Gets the collection of all Cells assigned to this node. There should be always at least one cell in a node which is default cell. Default + collection contains a single cell. + + + + + Gets or sets whether column header for child nodes if defined is visible. Default value is true. + + + + + Gets whether node has child nodes columns defined. + + + + + Get collection of child node columns. + + + + Gets or sets the style of the cells when node is expanded. + + Reference to the style assigned to the node/cell or null value indicating that + default style setting from tree control is applied. Default value is null. + + + When node is expanded the style specified here will be used on all cells + associated with this node instead of the + Cell.StyleNormal. That way you can give + different appearance to your node's cells when node is expanded. + When property is set to null value the style setting from parent tree + controls is used. NodeStyleExpanded on + AdvTree control is a root style for a cell. + + + + + Gets or sets the expanded style name used by node. This member is provided for internal use only. To set or get the style use StyleExpanded property instead. + + + + + Gets or sets the style used when Node is selected. Default value is NULL (VB + Nothing) + + + + + Gets or sets the selected style name used by node. This member is provided for internal use only. To set or get the style use StyleSelected property instead. + + + + + Gets or sets the style used when mouse is over the Node. Default value is NULL + (VB Nothing) + + + + + Gets or sets the mouse over style name used by node. This member is provided for internal use only. To set or get the style use StyleMouseOver property instead. + + + + + Gets or sets the node style. + + + Reference to the style assigned to the node or null value indicating that default + style setting from tree control is applied. Default value is null. + + + Style specified by this property will be used as default style for the node. + Each cell within the node can also specify it's own style. Since node contains the + cells using this style property can you for example create a border around all cell + contained by the node. + When this property is set to null value (default value) NodeStyle + property on AdvTree control is used. + + + + + Gets or sets the style name used by node. This member is provided for internal use only. To set or get the style use Style property instead. + + + + + Gets or sets the part of the node mouse is over. + + + + + Gets or sets the node horizontal offset from the position determined by the layout manager. + + + + + Gets or sets the image alignment in relation to the text displayed by cell. This property affects only first default cell inside the node. + Property with same name is available on each cell and you can use it to affect each cell individually. + + + + + Gets or sets whether node is enabled. Default value is true. Setting this value to false will set Enabled=false on all child cells. + + + + + Gets or sets the image displayed when the tree node is disabled. If image is not specified control will create + gray-scale disabled image automatically. + + + Image specified will be used as image when node is disabled. + + + + + Gets or sets the image-list index value of the disabled image. + + + + + Gets or sets the image displayed when the tree node is in the unselected state. + + + Image specified will be used as a default image for any other node state where + different image is not specified. + + + + + Gets or sets the image-list key value of the default image that is displayed by the tree nodes. + + + + + Gets or sets the image-list index value of the default image that is displayed by the tree nodes. + + + + + Gets or sets the image displayed when mouse is over the tree node. + + + + + Gets or sets the image-list index value of the image that is displayed by the tree nodes when mouse is over the node. + + + + + Gets or sets the image-list key value of the image that is displayed by the tree nodes when mouse is over the node. + + + + + Gets or sets the image displayed when node is expanded. + + + + + Gets or sets the image-list index value of the image that is displayed by the tree nodes when node is expanded. + + + + + Gets or sets the image-list key value of the image that is displayed by the tree nodes when node is expanded. + + + + + Property Editor support for ImageIndex selection + + + + + Gets or sets the NodeConnector object that describes the type of the connector used for + displaying connection between current node and its parent node. + Default value is null which means that settings from AdvTree control are used. + + RootConnector Property (DevComponents.AdvTree.AdvTree) + NodesConnector Property (DevComponents.AdvTree.AdvTree) + + + + Gets or sets whether node is visible. + + + + + Gets or sets whether command button is visible. Default value is false. + Command button can be used to display for example popup menu with commands for node, + or to display the list of linked nodes. + + + + + Gets or sets internal value that indicates that node is on "path" of the selected node. + + + + + + Gets or sets whether node selection is visible in UI when node is selected. Default value is true. You can + set this value to false to temporary disable the display of selection for a node. + + + + + Gets or sets the additional indent for the child nodes that is added to the AdvTree.Indent value when performing child node layout. Default value i 0. + + + + + Gets or sets whether Left/Right navigation through the cells when SingleCellSelection on tree is set is enabled. Default value is true. + + + + + Gets or sets whether style background that is applied to the node is drawn across the width of the tree control instead of only + behind the node content. Default value is false. + + + + + Gets or sets the child column header height. + + + + + Gets the AccessibleObject assigned to the item. + + + + + Gets or sets the default action description of the control for use by accessibility client applications. + + + + + Gets or sets the description of the control used by accessibility client applications. + + + + + Gets or sets the name of the control used by accessibility client applications. + + + + + Gets or sets the accessible role of the item. + + + + + Gets or sets a value indicating whether the node is visible to accessibility applications. + + + + + Represents collection for Node objects. + + + + + Sets the node collection belongs to. + + Node that is parent of this collection. + + + + Adds new object to the collection. + + Object to add. + Index of newly added object. + + + + Adds new object to the collection and provides information about the source of the command + + Node to add + Source action + + + + + Adds an array of objects to the collection. + + Array of Node objects. + + + + Inserts new object into the collection. + + Position of the object. + Object to insert. + + + + Inserts new object into the collection. + + Position of the object. + Object to insert. + Action that is causing the event + + + + Returns index of the object inside of the collection. + + Reference to the object. + Index of the object. + + + + Returns whether collection contains specified object. + + Object to look for. + true if object is part of the collection, otherwise false. + + + + Removes specified object from the collection. + + + + + + Removes specified object from the collection and provides information about source of the command + + Node to remove + Source action + + + + Copies collection into the specified array. + + Array to copy collection to. + Starting index. + + + + Copies contained items to the Node array. + + Array to copy to. + + + + Sorts the elements in the entire collection using the IComparable implementation of each element. + + + + + Sorts the elements in the entire collection using the specified comparer. + + The IComparer implementation to use when comparing elements.-or- null to use the IComparable implementation of each element. + + + + Sorts the elements in a range of elements in collection using the specified comparer. + + + + + + + + Finds the tree nodes with specified key, optionally searching sub-nodes. + + The name of the tree node to search for. + true to search child nodes of tree nodes; otherwise, false. + An array of Node objects whose Name property matches the specified key. + + + + Gets or sets the node this collection is associated with. + + + + + Returns reference to the object in collection based on it's index. + + + + + Creates new instance of NodeComparer class. You can use NodeComparer to sort the nodes by specific column/cell by calling + NodeCollection.Sort method and pass new instance of NodeComparer class. + + + + + Creates new instance of NodeComparer class. You can use NodeComparer to sort the nodes by specific column/cell by calling + NodeCollection.Sort method and pass new instance of NodeComparer class. + + Column/Cell index to use for sorting. + + + + Gets or sets the Column/Cell index that is used for sorting. + + + + + Reverse sort nodes. + + + + + Creates new instance of NodeComparer class. You can use NodeComparer to sort the nodes by specific column/cell by calling + NodeCollection.Sort method and pass new instance of NodeComparer class. + + Column/Cell index to use for sorting. + + + + Sort by flat node index. + + + + + Creates new instance of NodeComparer class. You can use NodeComparer to sort the nodes by specific column/cell by calling + NodeCollection.Sort method and pass new instance of NodeComparer class. + + + + + Represents node connector. Node connector is the line that is drawn to indicate connection between child and parent node. + + + + + Default Constructor. + + + + + Creates new instance of the object with specified parameters. + + Connector line width. + Connector type. + + + + Returns true if editor should serialize LineColor property. + + + + + Occurs when appearance of the connector has changed as result of changed settings on the connector. + + + + + Gets or sets the connector line width. + + + + + Gets or sets the color of the connector line. + + + + + Gets or sets the type of the connector. + + + See eNodeConnectorType enum for list of + available connectors. + + eNodeConnectorType Enumeration + + + + Gets or sets the DashStyle for the connector line. Default value is DashStyle.Dot. + + + + + Represents node operations. + + + + + Returns full path to the given node. + + Node to return path to. + Full path to the node. + + + + Gets the last child tree node. The LastNode is the last child Node in the NodeCollection stored in the Nodes property of the current tree node. If the Node has no child tree node, the LastNode property returns a null reference (Nothing in Visual Basic). + + Reference node. + Last node if found or null if there is no last node. + + + + Returns last rendered node on screen. + + Tree control. + Last rendered node or null + + + + Returns first rendered node on screen. + + Tree control. + Last rendered node or null + + + + Gets first visible node. + + Reference to tree. + Last visible node found or null + + + + Gets last visible node in tree control. + + Reference to tree. + Last visible node found or null + + + + Gets last visible top-level node in tree control. + + Reference to tree. + Last visible node found or null + + + + Gets the next sibling tree node. The NextNode is the next sibling Node in the NodeCollection stored in the Nodes property of the tree node's parent Node. If there is no next tree node, the NextNode property returns a null reference (Nothing in Visual Basic). + + Reference node. + Node object or null if node cannot be found. + + + + Returns next visible sibling tree node. + + Reference node + Node object or null if next visible node cannot be found + + + + Gets the next visible tree node. The NextVisibleNode can be a child, sibling, or a tree node from another branch. If there is no next tree node, the NextVisibleNode property returns a null reference (Nothing in Visual Basic). + + Reference node. + Node object or null if node cannot be found. + + + + Gets the next visible tree node. The NextVisibleNode can be a child, sibling, or a tree node from another branch. If there is no next tree node, the NextVisibleNode property returns a null reference (Nothing in Visual Basic). + + Reference node. + Node object or null if node cannot be found. + + + + Gets a value indicating whether the tree node is visible. Node is considered to be visible when it's Visible property is set to true and path to the node is available i.e. all parent nodes are expanded. + + + + + + + Returns whether node is displayed on the screen and visible to the user. When node is outside of the viewable area this property will return false. It will also return false if node is not visible. + + + + + + + Gets the zero based index of position of the tree node in the tree node collection. -1 is returned if node is not added to the nodes collection. + + Reference node. + Zero based index or -1 if node is not in collection. + + + + Gets the previous sibling tree node. The PrevNode is the previous sibling Node in the NodeCollection stored in the Nodes property of the tree node's parent Node. If there is no previous tree node, the PrevNode property returns a null reference (Nothing in Visual Basic). + + Reference node. + Node object or null if node cannot be found. + + + + Gets the previous visible tree node. The PrevVisibleNode can be a child, sibling, or a tree node from another branch. If there is no previous tree node, the PrevVisibleNode property returns a null reference (Nothing in Visual Basic). + + Reference node. + Node object or null if node cannot be found. + + + + Gets the previous tree node. The Previous Node can be a child, sibling, or a tree node from another branch. If there is no previous tree node, the PrevNode property returns a null reference (Nothing in Visual Basic). + + Reference node. + Node object or null if node cannot be found. + + + + Returns true if node passed is considered root node for display purposes. + + Reference to the tree control. + Node to test. + true if node is root node for display purposes otherwise false. + + + + Ensures that the cell is visible, expanding nodes and scrolling the control as necessary. + + Cell to be made visible. + + + + Ensures that the node is visible, expanding nodes and scrolling the control as necessary. + + Node to be made visible. + + + + Ensures that the node is visible, expanding nodes and scrolling the control as necessary. + + Node to be made visible. + + + + Returns number of visible child nodes for given node. + + Reference node. + Number of visible child nodes. + + + + Returns true if node has at least single visible child node. + + Reference node. + True if at least single child node is visible otherwise false. + + + + Retrieves the tree node that is at the specified location. + + The Node at the specified point, in tree view coordinates. + + You can pass the MouseEventArgs.X and MouseEventArgs.Y coordinates of the + MouseDown event as the x and y parameters. + + The Point to evaluate and retrieve the node from. + Tree control to find node at. + + + + Retrieves the tree node that is at the specified location. + + The TreeNode at the specified location, in tree view coordinates. + + You can pass the MouseEventArgs.X and MouseEventArgs.Y coordinates of the + MouseDown event as the x and y parameters. + + The X position to evaluate and retrieve the node from. + The Y position to evaluate and retrieve the node from. + Tree control to find node at. + + + + Retrieves the tree node that is at the specified location. + + The TreeNode at the specified location, in tree view coordinates. + + You can pass the MouseEventArgs.X and MouseEventArgs.Y coordinates of the + MouseDown event as the x and y parameters. + + Tree control to find node at. + The X position to evaluate and retrieve the node from. + The Y position to evaluate and retrieve the node from. + Enumerates rendered nodes only. + + + + Retrieves the tree node that is at the specified location. + + The TreeNode at the specified location, in tree view coordinates. + + You can pass the MouseEventArgs.X and MouseEventArgs.Y coordinates of the + MouseDown event as the x and y parameters. + + Tree control to find node at. + The X position to evaluate and retrieve the node from. + The Y position to evaluate and retrieve the node from. + Enumerates rendered nodes only. + + + + Retrieves the tree node that is at the specified vertical location. + + The TreeNode at the specified location, in tree view coordinates. + + You can pass the MouseEventArgs.X and MouseEventArgs.Y coordinates of the + MouseDown event as the x and y parameters. + + The Y position to evaluate and retrieve the node from. + Tree control to find node at. + + + + Retrieves the tree node that is at the specified vertical location. + + The TreeNode at the specified location, in tree view coordinates. + + You can pass the MouseEventArgs.X and MouseEventArgs.Y coordinates of the + MouseDown event as the x and y parameters. + + The Y position to evaluate and retrieve the node from. + Tree control to find node at. + Enumerates rendered nodes only. + + + + Retrieves the tree node that is at the specified vertical location. + + The TreeNode at the specified location, in tree view coordinates. + + You can pass the MouseEventArgs.X and MouseEventArgs.Y coordinates of the + MouseDown event as the x and y parameters. + + The Y position to evaluate and retrieve the node from. + Tree control to find node at. + Enumerates rendered nodes only. + + + + Gets the count of visible child nodes (Visible=true) for given node. + + Reference to Node object. + Number of visible nodes. + + + + Gets the first visible child node or returns null if node cannot be found. + + Reference to Node object. + First visible node or null if node cannot be found. + + + + Gets the last visible child node or returns null if node cannot be found. + + Reference to Node object. + Last visible node or null if node cannot be found. + + + + Gets whether any node from array is child node of parent on any level. + + Reference to parent node. + Reference to child nodes. + + + + + Gets whether node is child node of parent on any level. + + Reference to parent node. + Reference to child node. + + + + + Returns true if child node is child of any parent node at any level. + + Parent nodes array + Child node + true if child otherwise false + + + + Finds the node based on the Node.Name property. + + Reference to a tree control. + Reference to a node with given name or null if node cannot be found. + + + + Finds the node based on the Node.DataKey property. + + Reference to a tree control. + Reference to a node with given key or null if node cannot be found. + + + + Finds the node based on the Node.BindingIndex property. + + Reference to a tree control. + Index to look for + + + + Returns next visible cell in node. + + Reference to a node + The index at which to start search. + Reference to cell or null if there are no visible cells + + + + Returns previous visible cell in node. + + Reference to a node + The index at which to start search. + Reference to cell or null if there are no visible cells + + + + Returns the zero based flat index of the node. Flat index is the index of the node as if tree structure + has been flattened into the list. + + Reference to parent tree control. + Reference to the node to return index for. + Zero based node index or -1 if index cannot be determined. + + + + Returns node based on the flat index. Flat index is the index of the node as if tree structure + has been flattened into the list. + + Parent tree control. + Index to return node for. + Reference to a node or null if node at specified index cannot be found. + + + + Finds the first node that starts with the specified text. Node.Text property is searched. + + Parent tree control. + Partial text to look for + Reference node to start searching from + Gets or sets whether search ignores the letter case + Reference to a node or null if no node is found. + + + + Returned as information about the node or its column header at given coordinates. + + + + + Defines options for EnsureVisible method which brings node into the view. + + + + + Scrolls the tree so node is displayed at the bottom of the tree, if possible. + + + + + Scrolls the tree so node is displayed in the middle of the tree, if possible. + + + + + Scrolls the tree so node is displayed at the top of the tree, if possible. + + + + + Class that provides predefined styles for the nodes. Styles are defined as static memeber of the class + + + + + Returns Apple element style + + + + + Returns Blue element style + + + + + Returns BlueLight element style + + + + + Returns BlueNight element style + + + + + Returns BlueMist element style + + + + + Returns Cyan element style + + + + + Returns Green element style + + + + + Returns Lemon element style + + + + + Returns Magenta element style + + + + + Returns Orange element style + + + + + Returns OrangeLight element style + + + + + Returns Purple element style + + + + + Returns PurpleMist element style + + + + + Returns Red element style + + + + + Returns Silver element style + + + + + Returns SilverMist element style + + + + + Returns Tan element style + + + + + Returns Teal element style + + + + + Returns Yellow element style + + + + + Returns Gray element style + + + + + Indicates predefined element style. + + + + + Represents the selected nodes collection. + + + + + Initializes a new instance of the SelectedNodesCollection class. + + + + + Adds new object to the collection and provides information about the source of the command + + Node to add + Source action + + + + + Adds an array of objects to the collection. + + Array of Node objects. + + + + Represents the text box for editing cell's text. + + + + + Gets or sets whether the editing is in word-wrap mode. + + + + + Gets or sets whether control prevents Beep sound when Enter key is pressed. + + + + + Summary description for TreeAreaInfo. + + + + + Reference to parent node in which child bounds the coordinates are. Can be null if no parent node contains given coordinates. + + + + + Node which contains specified coordinates. Can be null if no node contains coordinates. + + + + + Previous reference node for given coordinates. If coordinates fall between two nodes this will indicate previous node or null. + + + + + Next reference node for given coordinates. If coordinates fall between two nodes this will indicate next node or null. + + + + + Gets or sets the parent node drag node will be added to. When null the drag node is being added as top-level node. + + + + + Gets or sets the insert index of drag node into the parent's node Nodes collection. + + + + + Initializes a new instance of the NodeDragInfo class. + + + + + Initializes a new instance of the NodeDragInfo class. + + + + + + + Provides data for AdvTree Cell events that can be canceled. + + + + + Provides data for AdvTree Cell events. + + + + + Default constructor for event data. + + Type of the action event is raised for. + Cell that event is raised for. + + + + Indicates the type of the action performed on a cell. + + + + + Indicates the cell that action is performed on. + + + + + Default constructor for event data. + + Type of the action event is raised for. + Cell that event is raised for. + + + + Indicates that event action should be canceled. + + + + + Provides data for AdvTree.BeforeCheck event. + + + + + Initializes a new instance of the AdvTreeCellBeforeCheckEventArgs class. + + + + + + Represents event arguments for BeforeNodeDrop and AfterNodeDrop events + + + + + Provides data for AdvTree Node events that can be cancelled. + + + + + Provides data for AdvTree Node events that can be cancelled. + + + + + Provides data for AdvTree Node events. + + + + + Default constructor. + + Default action + Default node. + + + + Indicates the type of the action performed on a node. + + + + + Indicates the node that action is performed on. + + + + + Default constructor. + + Default action + Default node. + + + + Indicates that event action should be canceled. + + + + + Default constructor. + + Default action + Default node. + + + + Indicates the array of nodes that action is performed on. + + + + + Returns reference to the old parent node. + + + + + Reference to the new parent node if event is not cancelled. + + + + + Gets or sets whether drag node is being copied instead of moved. + + + + + Gets or sets the new insert position inside of NewParentNode.Nodes collection for the node being dragged. If InsertPosition is -1 + the ParentNode refers to the current mouse over node and drag & drop node will be added as child node to it. + + + + + Defines the data for NodeDragFeedback event. + + + + + Gets or sets whether this drop location is accepted. Default value is true. You can set this to false to disable drop at this location. + + + + + Gets or sets the parent node for the node that is being dragged. This can be null/nothing value to indicate a root top-level node that + is in AdvTree.Nodes collection. + + + + + Gets or sets the new insert position inside of ParentNode.Nodes collection for the node being dragged. If InsertPosition is -1 + the ParentNode refers to the current mouse over node and drag & drop node will be added as child node to it. + + + + + Initializes a new instance of the TreeDragFeedbackEventArgs class. + + + + + + + Initializes a new instance of the TreeDragFeedbackEventArgs class. + + + + + + + Initializes a new instance of the TreeDragFeedbackEventArgs class. + + + + + Gets reference to the node being dragged. + + + + + Gets or sets the drop effect for the drag-drop operation. + + + + + Initializes a new instance of the TreeDragFeedbackEventArgs class. + + + + + + + Initializes a new instance of the TreeDragFeedbackEventArgs class. + + + + + + + Gets reference to the node being dragged. + + + + + Represents event arguments for NodeCollection based events, like BeforeNodeInsert, AfterNodeInsert etc. + + + + + Creates new instance of the class. + + Source action + Affected node + Parent of the node if any + + + + Indicates parent node of the affected node. For example if event handled is BeforeNodeInsert parent of the Node is has + not been set yet so this property provides information on the node that will become parent. If this property returns null + then node is being added or removed from the main AdvTree.Nodes collection. + + + + + Represents event arguments for node mouse based events. + + + + + Gets node affected by mouse action. + + + + + Gets which mouse button was pressed. + + + + + Gets the number of times the mouse button was pressed and released. + + + + + Gets a signed count of the number of detents the mouse wheel has rotated. A detent is one notch of the mouse wheel. + + + + + Gets the x-coordinate of the mouse. + + + + + Gets the y-coordinate of the mouse. + + + + + Provides means for AdvTree serialization. + + + + + Saves Nodes to specified file. + + AdvTree to save + Target file name + + + + Saves Nodes to stream. + + AdvTree to save + Stream to save nodes to. + + + + Saves Nodes to TextWriter + + AdvTree to save + TextWriter to write nodes to. + + + + Saves nodes to XmlWriter. + + AdvTree to save + XmlWriter to write nodes to + + + + + Saves AdvTree to an existing XmlDocument. New node AdvTree is created in document and Nodes are serialized into it. + + AdvTree to serialize + XmlDocument instance. + + + + Serializes AdvTree object to XmlElement object. + + Instance of AdvTree to serialize. + XmlElement to serialize to. + + + + Serializes Node and all child nodes to XmlElement object. + + Node to serialize. + Provides serialization context. + + + + Load AdvTree Nodes from file. + + Reference to AdvTree to populate + File name. + + + + Load AdvTree Nodes from stream. + + Reference to AdvTree to populate + Reference to stream + + + + Load AdvTree Nodes from reader. + + Reference to AdvTree to populate + Reference to reader. + + + + Load AdvTree Nodes from reader. + + Reference to AdvTree to populate + Reference to reader. + + + + Load AdvTree from XmlDocument that was created by Save method. + + Tree Control to load + XmlDocument to load control from + + + + Load nodes from XmlElement. + + Reference to AdvTree to be populated. + XmlElement that tree was serialized to. + + + + Load single node and it's child nodes if any. + + New instance of node that is populated with loaded data. + Provides deserialization context. + + + + Provides context information for serialization. + + + + + Gets or sets reference to context parent XmlElement when serializing or actual Node element when deserializing. + + + + + Gets or sets whether SerializeNode event handler has been defined and whether event should be fired. + + + + + Gets or sets whether DeserializeNode event handler has been defined and whether event should be fired. + + + + + Provides access to serializer. + + + + + Represents class for static tree utilities. + + + + + Initializes control with default settings for connectors and nodes. + + Control to initialize. + + + + Initializes control with default settings for connectors and nodes. + + Control to initialize. + Factory to use to create new instances of objects. + + + + Creates new style and adds it to styles collection + + Tree to assign style to + Style factory + + + + + + + + Returns reference to a node that is hosting given control. + + Reference to the AdvTree control instance + Control instance to look for + Reference to a node hosting control or null if node could not be found + + + + Represents internal component factory with design-time support. + + + + + Creates new instance of the class. + + Reference to DesignerHost to use for creation of new components. + + + + Creates new instance of the class. + + + + + Creates component and returns reference to the new instance. + + Type that identifies component to create. + New instance of the component. + + + + Represents class that holds padding information for user interface elements. + + + + + Gets or sets padding on left side. Default value is 0 + + + + + Gets or sets padding on right side. Default value is 0 + + + + + Gets or sets padding on top side. Default value is 0 + + + + + Gets or sets padding on bottom side. Default value is 0 + + + + + Creates new instance of the class and initializes it. + + Left padding + Right padding + Top padding + Bottom padding + + + + Gets amount of horizontal padding (Left+Right) + + + + + Gets amount of vertical padding (Top+Bottom) + + + + + Gets whether Padding is empty. + + + + + Analog clock control. + + + + + Resets the property to default value. + + + + + Raises ValueChanging event. + + Provides event arguments. + + + + Raises ValueChanged event. + + Provides event arguments. + + + + Resets the property to default value. + + + + + Initializes a new instance of the ClockControl class + + + + + Releases all resources used by the class. + + + + + Renders the clock's center cap. + + Graphics object used for rendering. + Bounding rectangle. + + + + Renders the clock's glass overlay. + + Graphics object used for rendering. + Bounding rectangle. + + + + Renders the clock's hands. + + Graphics object used for rendering. + Bounding rectangle. + True if this is the rending pass after the cap has been rendered. + + + + Renders the clock's numeric hour indicators. + + Graphics object used for rendering. + Bounding rectangle. + + + + Renders the clock's tick hour/minute indicators. + + Graphics object used for rendering. + Bounding rectangle. + + + + Called when TimeZone property has changed. + + Old property value + New property value + + + + Default minimum size. Defaults to 100, 100. + + + + + Gets or sets whether anti-aliasing is used when rendering the control. Default value is true. + + + + + Gets or sets the state for automatic mode. When true the clock will auto redraw once a second and display the current date/time. Default value is false. + + + + + Gets or sets clock style for this control. + + + + + Gets or sets the clock style data elements for this control. + + + + + Gets or sets a the indicator style the clock control. Default value is Ticks. + + + + + Gets or sets whether the time can be changed by moving the clock hands. Default value is false. + + + + + Gets or sets a value indicating whether to display the glass overlay on the clock control. Default value is true. + + + + + Gets or sets a value indicating whether to display the second hand on the clock control. Default value is true. + + + + + Occurs while user is dragging the mouse in order to change time. + + + + + Occurs when Value i.e. time clock is displaying has changed. + + + + + Gets or sets the current date/time value for this control. + + + + + Gets or sets the time-zone string identifier that is used to display the time when AutomaticMode=true and clock is displaying current time. + + + + + Enumeration containing the available hour/minute indicators. + + + + + Control will use ticks for hour/minute indicators. + + + + + Control will use numbers for hour indicators. + + + + + Enumeration containing the available mouse edit states. + + + + + Control is not currently in an edit state. + + + + + Control is currently in an hour edit state. + + + + + Control is currently in an minute edit state. + + + + + Control is currently in an second edit state. + + + + + Provides event arguments for TimeValueChanging event. + + + + + Gets the current time represented by the control. + + + + + Initializes a new instance of the TimeValueChangingEventArgs class. + + + + + + Defines delegate for TimeValueChanging event. + + Source of event. + Event arguments + + + + Data storage class for clock hand visual style. + + + + + Resets the property to default value. + + + + + Initializes a new instance of the ClockHand class. + + + + + Initializes a new instance of the ClockHand class. + + The hand style for this item. + The length of this clock hand as a percentage value ranging from 0.0 to 1.0, with 1.0 being half the width/height of the bounding rectangle + The width of this clock hand as a percentage value ranging from 0.0 to 1.0, with 1.0 being half the width/height of the bounding rectangle. + + + + Indicates whether the specified point is contained within the bounds of this hand. + + The bounding rectangle of the parent clock control. + The clockwise angle for this clock hand in degrees from the 12 o'clock position. + A Point that represents the point to test. + + + + + Generates a scaled and rotated graphics path based on the given style, rectangle and angle. + + The bounding rectangle of the parent clock control. + The clockwise angle for this clock hand in degrees from the 12 o'clock position. + + + + + Raises the PropertyChanged event. + + Event arguments + + + + Gets or sets a value indicating whether the hand is drawn over the cap. + + + + + Gets or sets the hand color data for this hand. + + + + + Gets or sets the hand style for this clock hand. Default value is Style1. + + + + + Gets or sets the length of this clock hand as a percentage value ranging from 0.0 to 1.0, with 1.0 being half the width/height of the bounding rectangle. Default value is 1.0. + + + + + Gets or sets the width of this clock hand as a percentage value ranging from 0.0 to 1.0, with 1.0 being half the width/height of the bounding rectangle. Default value is 0.1. + + + + + Occurs when property value has changed. + + + + + Enumeration containing the available hand styles. + + + + + Style 1. + + + + + Style 2. + + + + + Style 3. + + + + + Style 4. + + + + + Data storage class for clock visual styles. + + + + + Resets the property to default value. + + + + + Resets the property to default value. + + + + + Resets the property to default value. + + + + + Resets the property to default value. + + + + + Resets the property to default value. + + + + + Resets the property to default value. + + + + + Resets the property to default value. + + + + + Resets the property to default value. + + + + + Resets the property to default value. + + + + + Initializes a new instance of the ClockStyle class. + + + + + Initializes a new instance of the ClockStyle class. + + Predefined style from the PredefinedStyles enum. + + + + Initializes a new instance of the ClockStyle class. + + Predefined style from the PredefinedStyles enum. + + + + Releases all resources used by the class. + + + + + Loads a predefined style + + The predefined style to load. + + + + Raises the PropertyChanged event. + + Event arguments + + + + Gets or sets the PredefinedStyles value for this style. + + + + + Gets or sets the clock shape value for this style. + + + + + Gets or sets the bezel color data for this style. + + + + + Gets or sets the width of clock bezel as a percentage value ranging from 0.0 to 1.0. + + + + + Gets or sets the face color data for this style. + + + + + Gets or sets the face background image for this style. + + + + + Gets or sets the hour hand style for this style. + + + + + Gets or sets the minute hand style for this style. + + + + + Gets or sets the second hand style for this style. + + + + + Gets or sets the center cap color data for this style. + + + + + Gets or sets the center cap diameter as a percentage value ranging from 0.0 to 1.0. + + + + + Gets or sets the face number color for this style. + + + + + Gets or sets the center cap color data for this style. + + + + + Gets or sets the large tick color data for this style. + + + + + Gets or sets the large tick length as a percentage value ranging from 0.0 to 1.0. + + + + + Gets or sets the large tick width as a percentage value ranging from 0.0 to 1.0. + + + + + Gets or sets the small tick color data for this style. + + + + + Gets or sets the small tick length as a percentage value ranging from 0.0 to 1.0. + + + + + Gets or sets the small tick width as a percentage value ranging from 0.0 to 1.0. + + + + + Gets or sets the overlay glass angle, in degrees for this style. + + + + + Occurs when property value has changed. + + + + + Gets the parent of the style. + + + + + Enumeration containing the predefined clock styles. + + + + + Style 1. Default style, + + + + + Style 2. + + + + + No predefined style. + + + + + Enumeration containing the predefined clock shapes. + + + + + Round clock shape. + + + + + Data storage and utility class for defining gradient colors. + + + + + Creates new instance of the object. + + + + + Creates new instance of the object. + + The first color for this entry. + The second color for this entry. + + + + Creates new instance of the object. + + The first color for this entry. + The second color for this entry. + The border color for this entry. + The border width for this entry. + + + + Creates new instance of the object. + + The first color for this entry. + The second color for this entry. + The border color for this entry. + The border width for this entry. + The gradient angle. + + + + Creates new instance of the object. + + The first color for this entry. + The second color for this entry. + The border color for this entry. + The border width for this entry. + The focus for the SigmaBellShape. + The scale for the SigmaBellShape. + + + + Loads data into the class, called by constructors. + + The first color for this entry. + The second color for this entry. + The border color for this entry. + The border width for this entry. + The focus for the SigmaBellShape. + The scale for the SigmaBellShape. + + + + Creates Pen object using the BorderColor and BorderWidth properties. + + + + + Creates a brush of the type specified by BrushType. + + The graphics path used to construct the brush. + + + + Creates a brush of the type specified by BrushType. + + The graphics path used to construct the brush. + The angle used for the gradients, allowing an override of BrushAngle + + + + Creates a brush of the type specified by BrushType. + + The graphics path used to construct the brush. + The center point of the gradient as a percentage value typically ranging from 0.0 to 1.0. + + + + Creates a brush of the type specified by BrushType. + + The graphics path used to construct the brush. + The center point of the gradient as a percentage value typically ranging from 0.0 to 1.0. + The angle used for the gradients, allowing an override of BrushAngle + + + + Creates SolidBrushObject using Color1. + + + + + Creates a LinearGradientBrush object. + + The graphics path used to construct the brush. + The gradient angle. + + + + Creates a PathGradientBrush object. + + The graphics path used to construct the brush. + The center point of the gradient. + + + + Creates a LinearGradientBrush object. + + The graphics path used to construct the brush. + The gradient angle. + + + + Creates a LinearGradientBrush object. + + The graphics path used to construct the brush. + The gradient angle. + The focus for the SigmaBellShape. + + + + Creates a LinearGradientBrush object. + + The graphics path used to construct the brush. + The gradient angle. + The focus for the SigmaBellShape. + The scale for the SigmaBellShape. + + + + Raises the PropertyChanged event. + + Event arguments + + + + Gets or sets the border color for this item. Default value is white. + + + + + Gets or sets the border width for this item. Default value is 0. + + + + + Gets or sets the brush angle for this item. Only applies to Linear and Reflected brush types. Default value is 0. + + + + + Gets or sets the brush SigmaBellShape focus for this item. Only applies to Reflected brush types. Default value is 0.5. + + + + + Gets or sets the brush SigmaBellShape scale for this item. Only applies to Reflected brush types. Default value is 0.5. + + + + + Gets or sets the brush type for this item. Default value is Solid. + + + + + Gets or sets the first color for this item. Default value is white. + + + + + Gets or sets the second color for this item. Default value is white. + + + + + Occurs when property value has changed. + + + + + Enumeration containing predefined brush types for the ColorData class. + + + + + Solid brush. + + + + + Linear gradient brush. + + + + + Centered path gradient brush. + + + + + Reflected linear gradient brush. + + + + + Math helper class + + + + + Converts radians to degrees. + + Value to be converted in radians. + Converted value in degrees. + + + + Converts degrees to radians. + + Value to be converted in degrees. + Converted value in radians. + + + + Raises AnimationCompleted event. + + Provides event arguments. + + + + Initializes a new instance of the Animation class. + + Target object for animation + Target property name for animation + + + + Initializes a new instance of the Animation class. + + Target object for animation + Target property name for animation + + + + Initializes a new instance of the Animation class. + + Target object for animation + Target property name for animation + + + + Stops animation if one is currently running. + + + + + Sets the method which is called each time value on target object property is set. This method may execute the visual updates on animation client. + + Method to call + + + + Occurs after animation has completed. + + + + + Gets or sets whether animation is auto-disposed once its completed. Default value is false. + + + + + Gets whether animation run is complete. + + + + + Gets the animation duration in milliseconds. + + + + + Gets the animation easing function. + + + + + Gets or sets the number of fixed steps animation will perform from star to finish instead of using the easing function in time. + Stepped animation executes specified number of steps always with Duration specifying delays between each step. + + + + + Initializes a new instance of the AnimationRequest class. + + Target object for animation. + Target property name for animation. + From value. + To value. + + + + Initializes a new instance of the AnimationRequest class. + + Target object for animation. + Target property name for animation. + From value. + To value. + + + + Target object for animation. + + + + + Animation from value. + + + + + Animation to value. + + + + + Specifies the animation easing function + + + + + Initializes a new instance of the Animation class. + + Target object for animation + Target property name for animation + + + + Initializes a new instance of the Animation class. + + Target object for animation + Target property name for animation + + + + Initializes a new instance of the Animation class. + + Target object for animation + Target property name for animation + + + + Initializes a new instance of the Animation class. + + Target object for animation + Target property name for animation + + + + Initializes a new instance of the Animation class. + + Target object for animation + Target property name for animation + + + + Initializes a new instance of the Animation class. + + Target object for animation + Target property name for animation + + + + Initializes a new instance of the Animation class. + + Target object for animation + Target property name for animation + + + + Initializes a new instance of the Animation class. + + Target object for animation + Target property name for animation + + + + Initializes a new instance of the Animation class. + + Target object for animation + Target property name for animation + + + + Initializes a new instance of the Animation class. + + Target object for animation + Target property name for animation + + + + Initializes a new instance of the Animation class. + + Target object for animation + Target property name for animation + + + + Initializes a new instance of the Animation class. + + Target object for animation + Target property name for animation + + + + Runs all animations from Animations list. + + + + + Returns whether Storyline is disposed. + + + + + Gets the list of animations to run using this storyline. + + + + + Gets or sets number of times storyline is repeated. Default value is 0 which indicates that storyline is run only once meaning not repeated. + + + + + Gets or sets whether storyline is auto-disposed when finished. + + + + + Clean up any resources being used. + + + + + Returns the reference to DockContainerItem tab if any under specified coordinates. + + X - client mouse coordinate + Y - client mouse coordinate + Reference to DockContainerItem whose tab is at specified coordinates or null if there is no tab at given coordinates + + + + Sets bars position on the auto-hide panel. + + Bar for which position should be changed. + New indexed position of the bar. + + + + Gets or sets whether anti-alias smoothing is used while painting. Default value is false. + + + + + Gets or sets the timeout in milliseconds for auto hide/show action. + When timeout has elapsed and mouse has left the bar the bar will be automatically hidden. + If mouse is hovering over the collapsed bar and timeout has elapsed the bar will be displayed. + + + + + Gets or sets whether bars on auto-hide panel are displayed when mouse hovers over the tab. + + + + + Gets or sets whether bars that have focus are collapsed automatically or not. + + + + + Gets or sets the style of auto-hide panel. + + + + + Gets or sets the ColorScheme object used by this panel. Default value is null which means that ColorScheme is + automatically created as specified by Style property. Note that if your DotNetBarManager has UseGlobalColorScheme set to true + ColorScheme from DotNetBarManager will be used. + + + + + Creates new instance of the class. + + + + + Creates new instance of the class. + + + + + Indicates the Balloon tip position. + + + + + Tip is on the top. + + + + + Tip is on the left side. + + + + + Tip is on the right side. + + + + + Tip is on the bottom. + + + + + Indicates the style of the balloon. + + + + + Indicates type of Alert animation performed when alert is displayed. + + + + + No animation take place when alert is displayed. + + + + + Alert is animated from bottom to top. (Default) + + + + + Alert is animated from top to bottom. + + + + + Alert is animated from left to right. + + + + + Alert is animated from right to left. + + + + + Delegate for custom paint event handler. + + + + + Summary description for Balloon. + + + + + Clean up any resources being used. + + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Auto resize balloon to the content. Balloon width is calculated so image and caption text can fit in single line. + + + + + Recalculates layout of the balloon. + + + + + Displays balloon using control to automatically calculate balloon location. Method is usually used display balloon that is showing information for the certain control. + + Control used for balloon positioning. + + + + Displays balloon using control to automatically calculate balloon location. Method is usually used display balloon that is showing information for the certain control. + + Control used for balloon positioning. + Indicates whether balloon receives input focus. + + + + Displays balloon using rectangle to automatically calculate balloon location. Method is usually used display balloon that is showing information for the certain screen region. + + Rectangle in screen coordinates used for balloon positioning. + Indicates whether balloon receives input focus. + + + + Displays balloon using item to automatically calculate balloon location. Method is usually used display balloon that is showing information for the certain item. + + Item used for balloon positioning. + Indicates whether balloon receives input focus. + + + + Display balloon. + + Indicates whether balloon receives input focus. + + + + Displays balloon. + + + + + Called when balloon is hidden. + + + + + Hides balloon. + + + + + Occurs when background is redrawn. + + + + + Occurs when caption image is redrawn. + + + + + Occurs when caption text is redrawn. + + + + + Occurs when text is redrawn. + + + + + Occurs when close button is clicked. + + + + + Occurs when TipPosition property has changed. + + + + + Gets or sets whether anti-alias smoothing is used while painting. Default value is false. + + + + + Gets or sets the minimum balloon width when auto sizing balloon. Default value is 180. + + + + + Occurs when text markup link is clicked. Markup links can be created using "a" tag, for example: + Markup link + + + + + Gets or sets the target gradient background color. + + + + + Gets or sets gradient fill angle. + + + + + Specifies the transparency of background image. + + + + + Specifies background image position when container is larger than image. + + + + + Gets or sets the border color.. + + + + + Specifies balloon style. + + + + + Gets or sets whether the Close button is displayed. + + + + + Gets or sets the animation type used to display Alert type balloon. + + + + + Gets or sets the total time in milliseconds alert animation takes. + Default value is 200. + + + + + Gets or sets whether balloon will close automatically when user click the close button. + + + + + Gets or sets time period in seconds after balloon closes automatically. + + + + + Gets or sets the custom image for Close Button. + + + + + Gets or sets the custom image for Close Button when mouse is over the button. + + + + + Gets or sets the custom image for Close Button when button is pressed. + + + + + Gets or sets the Caption image. + + + + + Gets or sets the Caption icon. Icon is used to provide support for alpha-blended images in caption. + + + + + Gets or sets the Caption font. + + + + + Gets or sets text displayed in caption. + + + + + Gets or sets color of caption text. + + + + + Gets or set position of the balloon tip. + + + + + Gets or sets tip distance from the edge of the balloon. + + + + + Returns length of the tip. + + + + + Gets/Sets whether Balloon is visible. + + + + + Represents a balloon style pop-up window that displays a brief description of a control's purpose when the mouse hovers over the control or when controls receives input focus. + + + + + Initializes a new instance of the BalloonTip class. + + + + + Clean up any resources being used. + + + + + Retrieves the Balloon Caption text associated with the specified control. + + + + + Associates Balloon Caption text with the specified control. + + The Control to associate the Balloon Caption text with. + The Balloon Caption text to display on the Balloon. + + + + Retrieves the Balloon text associated with the specified control. + + + + + Associates Balloon text with the specified control. + + The Control to associate the Balloon text with. + The Balloon text to display on the Balloon. + + + + Removes all Balloon texts currently associated with the BalloonTip control. + + + + + Removes specific Balloon texts currently associated with the BalloonTip control. + + Control that has Balloon texts associated. + + + + Shows Balloon for specific control. Control must have Balloon already assigned to it. + + Control that has Balloon already assigned. + + + + Closes Balloon control if visible. + + + + + Occurs before balloon is displayed. + + + + + Occurs before balloon is closed and allows to cancel the action. + + + + + Gets or sets whether anti-alias smoothing is used while painting. Default value is false. + + + + + Gets or sets a value indicating whether the BalloonTip is currently active. + true if the BalloonTip is currently active; otherwise, false. The default is true. + + + + + Returns reference to the control that triggered balloon. + + + + + Gets or sets the minimum balloon width when auto sizing balloon. Default value is 180. + + + + + Gets or sets a value indicating whether Balloon receives input focus when displayed. + Default value is false. + + + + + Gets or sets the time (in milliseconds) that passes before the BalloonTip appears. + + + + + Gets or sets a value indicating whether a Balloon window is displayed even when its parent form is not active. Default value is false. + + + + + Gets or sets the internal Balloon control that is used to display Balloon. + This property will have valid value only during time Balloon is actually + displayed on the screen. Value will also be valid during BalloonDisplaying event. + You can use this property to further customize Balloon control before it is + displayed to the user. You can also set it to your own instance of the Balloon + control (or the control that is inheriting it) for ultimate customization options. + Note that new instance of Balloon control is created each time Balloon needs to be displayed. + Once Balloon is closed control is disposed. + + + + + Specifies balloon style. + + + + + Gets or sets the animation type used to display Alert type balloon. + + + + + Gets or sets the total time in milliseconds alert animation takes. + Default value is 200. + + + + + Gets or sets whether balloon will close automatically when user click the close button. + + + + + Gets or sets time period in seconds after balloon closes automatically. + + + + + Gets or sets whether Balloon is shown after control receives input focus. Default value is false. When set to true Balloon will not be displayed on mouse hover. + + + + + Gets or sets whether the Balloon Close button is displayed. + + + + + Gets or sets default balloon width. Usually the width of the balloon is calculated based on the width of the caption text. If caption text is not set then this value will be used as default width of the balloon. + + + + + Gets or sets the Balloon Caption image. + + + + + Gets or sets the Balloon Caption icon. Icon is used to provide support for alpha-blended images in caption. + + + + + Represents bar control. + + + + + Interface used for docking support. + + + + + Returns Minimum docked size of the control. + + + + + Returns Preferrred size of the docked control. + + + + + Sets the dock line for the control. Used internaly by dock manager. + + New Dock line. + + + + Indicated whether control can be docked on top dock site. + + + + + Indicated whether control can be docked on bottom dock site. + + + + + Indicated whether control can be docked on left dock site. + + + + + Indicated whether control can be docked on right dock site. + + + + + Indicates whether control can be docked as document i.e. middle (fill) dock site. + + + + + Indicates whether control can be docked as tab to another bar. + + + + + Indicated whether control can be stretched to fill dock site. + + + + + Holds the left position (dock offset) of the control. + + + + + Specifies the dock line for the control. + + + + + Specifies current dock orientation. + + + + + Gets whether control is docked. + + + + + Returns the dock site of the control. + + + + + Gets or sets the control dock side. + + + + + Gets or sets whether bar is locked to prevent docking below it. + + + + + Interface implemented by target Bar interested in access to designer. + + + + + Gets or sets the BarBaseControlDesigner instance. + + + + + Desribes interface that provides custom serialization support for items. + + + + + Invokes SerializeItem event. + + Provides data for the event. + + + + Invokes DeserializeItem event. + + Provides data for the event. + + + + Occurs after an item has been serialized to XmlElement and provides you with opportunity to add any custom data + to serialized XML. This allows you to serialize any data with the item and load it back up in DeserializeItem event. + + + To serialize custom data to XML definition control creates handle this event and use CustomXmlElement + property on SerializeItemEventArgs to add new nodes or set attributes with custom data you want saved. + + + + + Occurs after an item has been de-serialized (load) from XmlElement and provides you with opportunity to load any custom data + you have serialized during SerializeItem event. + + + To de-serialize custom data from XML definition handle this event and use CustomXmlElement + property on SerializeItemEventArgs to retrive any data you saved in SerializeItem event. + + + + + Gets whether any handlers have been defined for SerializeItem event. If no handles have been defined to optimize performance SerializeItem event will not be attempted to fire. + + + + + Gets whether any handlers have been defined for DeserializeItem event. If no handles have been defined to optimize performance DeserializeItem event will not be attempted to fire. + + + + + Raises BarStateChanged event. + + Provides event arguments. + + + + Initializes a new instance of the Bar class. + + + + + Called by StyleManager to notify control that style on manager has changed and that control should refresh its appearance if + its style is controlled by StyleManager. + + New active style. + + + + Initializes a new instance of the Control class. + + Bar Caption + + + + Releases the focus from the bar and selects the control that had focus before bar was selected. If control that had focus could not be determined focus will stay on the bar. + This method is used by internal DotNetBar implementation and you should not use it. + + + + + Creates the Graphics object for the control. + + The Graphics object for the control. + + + + Returns the renderer control will be rendered with. + + The current renderer. + + + + Raises the PreRender event. + + Provides the event arguments + + + + Raises the PostRender event. + + Provides the event arguments + + + + Drawns bar grab handle if one specified. + + Context information. + + + + Paints bar side bar. + + Reference to graphics object. + + + + Recalculates the layout of the Bar, resizes the Bar if necessary and repaints it. + + + + + Recalculates the layout of the Bar and repaints it. This will not change the size of the Bar it will only force the recalculation of the size for each contained item and it will repaint the bar. To ensure that Bar is resized if necessary as well call RecalcLayout method. + + + + + Raises ItemLayoutUpdated event. + + Provides event arguments. + + + + Method is called by DotNetBarManager when bar is being moved and Escape key is pressed. + + + + + Called when IsMaximized property has changed. + + Old property value + New property value + + + + Closes the DockContainerItem with event source set to Code. + + DockContainerItem to close. + + + + Closes the DockContainerItem. + + DockContainerItem to close. + Source of the event. + + + + Raises the ItemClick event. + + Item that was clicked. + Event arguments. + + + + Suspends normal layout logic. + + + + + Resumes normal layout logic. + + + + + Resumes normal layout logic. Optionally forces an immediate layout of pending layout requests. + + + + + Invokes SerializeItem event. + + Provides data for the event. + + + + Invokes DeserializeItem event. + + Provides data for the event. + + + + Saves the Bar definition to file. + + Definition file name. + + + + Loads the Bar definition from file. + + Definition file name. + + + + Saves the Bar layout to file. + + Definition file name. + + + + Loads the Bar definition from file. + + Definition file name. + + + + Sets the client size of the bar excluding caption. This method is useful when setting the size of the bars with layout type DockContainer. + + Width of bar in pixels. + Height of bar in pixels. + + + + Sets the client size of the bar excluding caption. This method is useful when setting the size of the bars with layout type DockContainer. + + New bar size + + + + Returns true if Font property should be serialized by Windows Forms designer. + + + + + Designer method to reset the property to its default value. + + + + + Resets the ColorScheme property to its default value. + + + + + Called when CanMaximizeFloating property has changed. + + Old property value + New property value + + + + Makes the Bar display by setting the visible property to true. + + + + + Hides the Bar. + + + + + Returns whether Size property should be serialized. + + + + + Returns the first child item with specified name regardless of it's hierarchy. + + Item name. + + + + + Returns the collection of items with the specified name. + + Item name to look for. + + + + + Returns the collection of items with the specified name and type. + + Item name to look for. + Item type to look for. + + + + + Returns the collection of items with the specified name and type. This member is not implemented and should not be used. + + Item name to look for. + Item type to look for. + Indicates whether GlobalName property is used for searching. + + + + + Returns AutoHidePanel that bar is on if in auto-hide state otherwise returns null. + + AutoHidePanel object or null if bar is not in auto-hide state. + + + + Raises BeforeAutoHideDisplayed event. + + + + + + Raises BeforeAutoHideHidden event. + + + + + + Destroys tooltip window. + + + + + Shows tooltip for this item. + + + + + Re-docks the floating bar to its previous docking position. + + + + + Invokes CaptionButtonClick event. + + + + + Displays or hides the automatic caption button popup menu. + + + + + Called when DockTabStripHeight property has changed. + + Old property value + New property value + + + + Returns the Minimum Size for specified orientation. + + Orientation to return minimum size for. + + + + + Returns the preferred size of the Bar when docked. + + Orientation to return preferred size for. + + + + + Sets the dock line but it does not forces the Bar to change position. The position will be changed on next layout request or when dock site needs to recalculate the layout of the bat. Used internally only. + + + + + ISupportInitialize.BeginInit implementation. + + + + + ISupportInitialize.EndInit implementation. + + + + + Returns Minimum docked size of the control. + + + + + Returns Preferrred size of the docked control. + + + + + Sets the dock line for the control. Used internaly by dock manager. + + New Dock line. + + + + Occurs after bar state has changed, like selected dock tab has changed, bar has closed, bar has been docked or undocked etc. + + + + + Occurs when Item is clicked. + + + + + Occurs after Bar is docked. + + + + + Occurs after Bar is undocked. + + + + + Occurs after Bar definition is loaded. + + + + + Occurs when current Dock tab has changed. + + + + + Occurs when bar visibility has changed as a result of user action. + + + + + Occurs when bar auto hide state has changed. + + + + + Occurs when Bar is about to be closed as a result of user clicking the Close button on the bar. + + + + + Occurs when Bar in auto-hide state is about to be displayed. + + + + + Occurs when popup item is closing. Event is fired only when Bar is used independently of DotNetBarManager. + + + + + Occurs when popup of type container is loading. Event is fired only when Bar is used independently of DotNetBarManager. + + + + + Occurs when popup of type container is unloading. Event is fired only when Bar is used independently of DotNetBarManager. + + + + + Occurs when popup item is about to open. Event is fired only when Bar is used independently of DotNetBarManager. + + + + + Occurs just before popup window is shown. Event is fired only when Bar is used independently of DotNetBarManager. + + + + + Occurs before dock tab is displayed. + + + + + Occurs when caption button is clicked. Caption button is button displayed on bars with grab handle style task pane. + + + + + Occurs on dockable bars when end-user attempts to close the individual DockContainerItem objects using system buttons on dock tab. + Event can be canceled by setting the Cancel property of event arguments to true. This even will occur only after user presses the + X button on tab that is displaying the dockable windows/documents. + + + + + Occurs on dockable bars after DockContainerItem is closed by end-user. This action cannot be cancelled. + + + + + Occurs after an item has been serialized to XmlElement and provides you with opportunity to add any custom data + to serialized XML. This allows you to serialize any data with the item and load it back up in DeserializeItem event. + + + To serialize custom data to XML definition control creates handle this event and use CustomXmlElement + property on SerializeItemEventArgs to add new nodes or set attributes with custom data you want saved. + + + + + Occurs after an item has been de-serialized (load) from XmlElement and provides you with opportunity to load any custom data + you have serialized during SerializeItem event. + + + To de-serialize custom data from XML definition handle this event and use CustomXmlElement + property on SerializeItemEventArgs to retrive any data you saved in SerializeItem event. + + + + + Occurs after the TabStrip style which used on dockable windows has changed. This event gives you opportunity to + change the style of the tab strip by accessing Bar.DockTabControl.Style property. + + + + + Occurs before the bar control is rendered. This event is fired once for each part of the bar control being rendered. Check the Part property of the event arguments to identify the part being rendered. + You can cancel internal rendering by setting Cancel property. + + + + + Occurs after the bar control is rendered and allows you to render on top of the default rendering provided by the control. + + + + + Occurs when DotNetBar is looking for translated text for one of the internal text that are + displayed on menus, toolbars and customize forms. You need to set Handled=true if you want + your custom text to be used instead of the built-in system value. + + + + + Gets/Sets the owner of the Bar object. + + + + + Gets or sets the item default accessibility action will be performed on. + + + + + Returns the reference to the control that last had input focus. This property should be used to + determine which control had input focus before bar gained the focus. Use it to apply + the menu command to active control. + + + + + Indicates the array of colors that when set are used to draw the border of the item. + + + + + Gets or sets the redering mode used by control. Default value is eRenderMode.Global which means that static GlobalManager.Renderer is used. If set to Custom then Renderer property must + also be set to the custom renderer that will be used. + + + + + Gets or sets the custom renderer used by the items on this control. RenderMode property must also be set to eRenderMode.Custom in order renderer + specified here to be used. + + + + + Gets whether caption of floating bar will be drawn using themes. + + + + + Gets/Sets the parent item of the Bar. The parents item sub-items are displayed on the bar. + + + + + Occurs after internal item layout has been updated and items have valid bounds assigned. + + + + + Gets or sets docked bar caption height. Default value is 0 which means system predefined height is used. + + + + + Gets or sets whether bar when changed over to floating state is hidden instead of shown. This property is used + internally to optimize loading of hidden floating bars. You should not use this property in your code. It is for internal DotNetBar + infrastructure use only. + + + + + Returns true if bar is being moved/dragged by user. + + + + + Gets or sets whether floating dockable window is maximized. + + + + + Specifies the bar behavior when its title is double-clicked + + + + + Returns whether popup bar should display shadow. + + + + + Returns whether popup bar shadow should be alpha-blended. + + + + + Gets/Sets the popup animation that will be applied when popup is shown. + + + + + Gets whether any handlers have been defined for SerializeItem event. If no handles have been defined to optimize performance SerializeItem event will not be attempted to fire. + + + + + Gets whether any handlers have been defined for DeserializeItem event. If no handles have been defined to optimize performance DeserializeItem event will not be attempted to fire. + + + + + Gets/Sets Bar definition as XML string. + + + + + Gets or sets whether layout changes are saved for this bar when DotNetBarManager.SaveLayout method is used to save layout for all bars. Default value is true which means that layout changes are saved. + + + + + Gets/Sets Bar layout as XML string. + + + + + Specifies background image position when container is larger than image. + + + + + Specifies the transparency of background image. + + + + + Sets/Gets the side bar image structure. + + + + + Gets/Sets the caption of the Bar. This text is displayed in title of the Bar when Bar is floating. + + + + + Specifies whether Bar is drawn using Themes when running on OS that supports themes like Windows XP. + + + + + Returns current Bar state. + + + + + Returns the collection of sub-items hosted on the Bar. + + + + + Returns the reference to the container that containing the sub-items. + + + + + Gets/Sets whether the items that could not be displayed on the non-wrap Bar are displayed on popup menu or popup Bar. + + + + + Gets/Sets the spacing in pixels between the sub-items. + + + + + Gets/Sets the padding in pixels. This represents the spacing between the top edge of the bar and the top of the item. + + + + + Gets/Sets the padding in pixels. This represents the spacing between the bottom edge of the bar and the bottom of the item. + + + + + Gets/Sets the padding in pixels. This represents the spacing between the left edge of the bar and the left side of the first item. + + + + + Gets/Sets the padding in pixels. This represents the spacing between the right edge of the bar and the right side of the last item. + + + + + Sets/Gets whether bar is menu bar. Menu bar will show system icons + for Maximized forms in MDI Applications. Only one bar can be a Menu bar in an application. + + + + + Gets or sets the visual type of the bar. The type specified here is used to determine the appearance of the bar. + + + + + Gets or sets Bar Color Scheme. + + + + + Gets or sets Caption (Title bar) background color. + + + + + Gets or sets Caption (Title bar) text color. + + + + + Gets or sets whether toolbars with appropriate style appear with rounded corners. Default value is true. + + + + + Gets/Sets the visual style of the Bar. + + + + + Gets/Sets whether the items will be wrapped into next line when Bar is full. Applies to both docked and floating Bar states. + + + + + Gets/Sets whether the items will be wrapped into next line when Bar is full. Applies only to Bars that are docked. + + + + + Gets/Sets whether the items will be wrapped into next line when Bar is full. Applies only to Bars that are floating. + + + + + Gets/Sets the grab handle style of the docked Bars. + + + + + Gets the grab handle client rectangle. + + + + + Returns CanClose based on the selected dock-container item. + + + + + Gets/Sets whether the Bar can be hidden by end-user. Applies to Document docked bars only. + + + + + Indicates whether Maximize button is visible on floating dock windows. + + + + + Gets/Sets border style when Bar is docked. + + + + + Gets/Sets whether floating bar is hidden when application loses focus. + + + + + Gets/Sets whether tab navigation buttons are shown for tabbed dockable bars. + + + + + Gets or sets the border line color when docked border is a single line. + + + + + Gets/Sets whether Bar is visible or not. + + + + + Returns number of items that have Visible property set to true. + + + + + Gets or sets whether bar is valid drop target for end-user bar customization. Default value is true. + When bar is used as dock container then you can use this property to prevent docking of other bars as dock tabs. + + + + + Gets or sets whether items on the Bar can be customized. + + + + + Specifies whether Bar was created by user using Customize dialog. + + + + + Gets/Sets the Bar name used to identify Bar from code. + + + + + Gets/Sets the Image size for all sub-items on the Bar. + + + + + Gets or sets the layout type. + + + + + Gets or sets whether all buttons are automatically resized to the largest button in collection. + + + + + Gets or sets rounded corner size for styles that use rounded corners. + + + + + Gets or sets whether anti-alias smoothing is used while painting. Default value is false. + + + + + Gets or sets whether mouse over fade effect is enabled for buttons. Default value is false. Note that Fade effect + will work only when Office2007 style is used. For other styles this property has no effect and fade animation is not used regardless + this property setting. + + + + + Gets whether fade effect should be in use. + + + + + Gets or sets the Bar back color. + + + + + Gets or sets the Bar customize menu (Applies to the bars with LayoutType set to DockWindow only). + + + + + Indicates the auto-hide side of the parent form where bar is positioned. + + + + + Gets or sets whether tab text is always visible while bar is in auto-hide state. Default value is false which indicates that only text for the active dock tab is visible. + + + + + Indicates whether Bar is in auto-hide state. Applies to non-document dockable bars only. + + + + + Gets or sets the visibility of the bar when bar is in auto-hide state. + + + + + Indicates whether Bar can be auto hidden. + + + + + Gets or sets the global parent control used as part of Global Items feature when bar is used as context menu bar. This property is used internally by + DotNetBar and should not be set directly. + + + + + Gets or sets how long it takes to play the auto-hide animation, in milliseconds. Maximum value is 2000, 0 disables animation. + + + + + Occurs before the bar in auto-hide state is displayed on popup and allows you to cancel display by setting Cancel=true on event arguments. + + + + + Occurs before the bar in auto-hide state is hidden and allows you to cancel display by setting Cancel=true on event arguments. + + + + + Gets whether tooltip is visible or not. + + + + + Indicates whether dock tabs are visible when bar is acting as dock-container and it needs to display tabs to represents multiple DockContainerItem objects hosted by the bar. Default value is true. + + + + + Gets or sets height of the docked bar tab strip which displays docked tabs. + + + + + Returns the reference to internal TabStrip control used to display contained DockContainerItems. + + + + + Gets or sets the selected DockContainerItem if bar represents dockable window. + + + + + Gets or sets the tab (DockContainerItem) index for Bars with LayoutType set to eLayoutType.DockContainer. Index corresponds to the index of the DockContainerItem in Bar.Items collection. + + + + + Indicates Bar background image. + + + + + Gets or sets whether caption button menu for bars with grab handle task pane is automatically created. + Caption menu when automatically created will display the list of all items from Items collection + and it will maintain only one item from the list as visible item. + To create custom caption menu that is displayed when user clicks the caption button handle CaptionButtonClick event. + + + + + Gets or sets whether caption (text) of the bars with dock container layout is automatically set to the + selected dock container item text. + + + + + Specifies whether Bar can be undocked. Does not apply to stand alone bars. + + + + + Specifes whether end-user can tear-off (deattach) the tabs on dockable window. + + + + + Specifes whether end-user can reorder the tabs on dockable window. + + + + + Gets or sets whether bar or DockContainerItem that is torn-off this bar can be docked + as tab to another bar. Default value is true which indicates that bar can be docked as tab to another bar. + + + + + Gets or sets whether dock bar can be moved by dragging its caption using the mouse. + + + + + Specifies whether Bar can be docked on Top dock site or not. Does not apply to stand alone bars. + + + + + Specifies whether Bar can be docked on Bottom dock site or not. Does not apply to stand alone bars. + + + + + Specifes whether Bar can be docked on Left dock site or not. Does not apply to stand alone bars. + + + + + Specifes whether Bar can be docked on Right dock site or not. Does not apply to stand alone bars. + + + + + Specifies whether Bar can be docked as document. Default value is false. See DotNetBarManager.EnableDocumentDocking for more details. + + + + + Specifies whether Bar will stretch to always fill the space in dock site. Applies to the dockable bars only. + + + + + Gets or sets whether gray-scale algorithm is used to create automatic gray-scale images. Default is true. + + + + + Gets/Sets the distance from the far left/top side of the docking site or suggests the order of the docked bar. Upon serialization this property + will contain actual left/top position of the bar. You can use it to re-order the bars docked on the same line. Property value is relative to the other + bars docked on the same line when it is used to change the order. For example setting DockOffset value to 10 will place the bar just after the last bar on the + same line that has DockOffset value less than 10. If there is no bar with DockOffset value less than 10 the bar will be placed in first position. + + + + + Gets/Sets the dock line. + + + + + Gets or sets the dock tab alignment. + + + + + Gets or sets whether selected dock tab is closed when Bar caption close button is pressed. Default value is false which indicates that whole bar will be hidden when bars close button is pressed. + + + + + Gets or sets whether close button is displayed on each dock tab that allows closing of the tab. Default value is false. + + + + + Gets or sets whether tab that shows all dock containers on the bar is visible all the time. By default + tab is hidden when there is only one item displayed. + + + + + Gets or sets whether bar is locked to prevent docking below it. Applies to undockable bars only. + + + + + Gets/Sets the orientation of the Bar. + + + + + Returns whether Bar is docked or not. + + + + + Returns the Bars dock site. + + + + + Gets/Sets the dock side for the Bar. + + + + + Gets or sets the inital floating location. This location will be used when DockSide is set to None. + + + + + Indicates whether Tooltips are shown on Bars and menus. + + + + + Gets or sets whether control is selected in designer. + + + + + Gets or sets whether accelerator letters for menu or toolbar commands are underlined regardless of + current Windows settings. Accelerator keys allow easy access to menu commands by using + Alt + choosen key (letter). Default value is false which indicates that system setting is used + to determine whether accelerator letters are underlined. Setting this property to true + will always display accelerator letter underlined. + + + + + ImageList for images used on Items. Images specified here will always be used on menu-items and are by default used on all Bars. + + + + + ImageList for medium-sized images used on Items. + + + + + ImageList for large-sized images used on Items. + + + + + Gets or sets whether hooks are used for internal DotNetBar system functionality. Using hooks is recommended only if DotNetBar is used in hybrid environments like Visual Studio designers or IE. + + + + + Indicates whether mnemonic keys, accelerator keys, which are set through item Text property used ampersand character are processed by control. + + + + + Specifes whether Bar can be docked on Top dock site or not. Does not apply to stand alone bars. + + + + + Specifes whether Bar can be docked on Bottom dock site or not. Does not apply to stand alone bars. + + + + + Specifes whether Bar can be docked on Left dock site or not. Does not apply to stand alone bars. + + + + + Specifes whether Bar can be docked on Right dock site or not. Does not apply to stand alone bars. + + + + + Specifes whether Bar can be docked as document. Default value is false. See DotNetBarManager.EnableDocumentDocking for more details. + + + + + Indicated whether control can be stretched to fill dock site. + + + + + Holds the left position (dock offset) of the control. + + + + + Specifies the dock line for the control. + + + + + Specifies current dock orientation. + + + + + Gets whether control is docked. + + + + + Returns the dock site of the control. + + + + + Gets or sets the control dock side. + + + + + Gets or sets whether bar is locked to prevent docking below it. + + + + + Defines delegate for the PreRender and PostRender Bar control events. + + + + + Represents event arguments for PreRender and PostRender Bar control event. + + + + + Gets the reference to the Bar being rendered. + + + + + Gets or sets the rectangle of the part being rendered. Certain parts of bar like the title buttons allow you to set this property to the custom size of your button. + Default value is the system size of the part being rendered. + + + + + Gets the Bar part being rendered. + + + + + When used in PreRender event allows you to cancel the default rendering by setting this property to true. + + + + + Gets the reference to the Graphics object to render the tab on. + + + + + Creates new instance of the class and initializes it with default values. + + + + + Defines the part of the Bar control for custom rendering. + + + + + Indicates the Bar background and border. + + + + + Indicates the Bar caption. + + + + + Indicates the Bar close button displayed inside of caption. + + + + + Indicates the Bar customize button displayed inside of caption. + + + + + Indicates the Bar caption text. + + + + + Indicates the Bar grab handle. + + + + + Indicates the Bar resize handle. + + + + + Indicates the Bar auto-hide button displayed inside of caption. + + + + + Indicates the Bar caption task pane. + + + + + Indicates the Bar maximize button displayed inside of caption. + + + + + Indicates the complete bar area. This part is used for the PostRender event. + + + + + Defines delegate for BarStateChanged event. + + + + + + + Provides event arguments for ActiveDockContainerChanged event. + + + + + Gets the Bar that is changed. + + + + + Gets the type of the change that affected the bar. + + + + + Provides any optional context information about the state change. + + + + + Initializes a new instance of the BarStateChangedEventArgs class. + + + + + + + Initializes a new instance of the BarStateChangedEventArgs class. + + + + + + + + Defines bar state changes for BarStateChanged event. + + + + + Indicates that Bar selected dock tab is about to change. + + + + + Indicates that Bar selected dock tab has changed. + + + + + Indicates that bar docking has changed and bar was docked. + + + + + Indicates that bar has been undocked from dock site. + + + + + Indicates that bar dock tab has closed. + + + + + Indicates that bar in auto-hide state has been folded, i.e. returned to collapsed state. + + + + + Indicates that bar in auto-hide state has been open, shown. + + + + + Indicates that bar AutoHide property has changed meaning that bar has been either placed in auto-hide mode or taken out of auto-hide mode. + + + + + Indicates that tab has been moved within a bar tab-strip by end user. + + + + + Specifies the behavior of bar when its title is double clicked. + + + + + Double clicking bar title does not do anything. + + + + + Double clicking bar title when bar is docked will float the bar if CanUndock=true + + + + + Double clicking floating bar title will re-dock it if any of CanDock*** properties is true. + + + + + Double clicking will toggle bar state between float and dock state if all CanDock*** and CanUndock properties allow it. + + + + + Represents base control for bars. + + + + + Notifies the accessibility client applications of the specified AccessibleEvents for the specified child control. + + The AccessibleEvents object to notify the accessibility client applications of. + The child Control to notify of the accessible event. + + + + Returns the collection of items with the specified name. + + Item name to look for. + + + + + Returns the collection of items with the specified name and type. + + Item name to look for. + Item type to look for. + + + + + Returns the collection of items with the specified name and type. + + Item name to look for. + Item type to look for. + + + + + Returns the first item that matches specified name. + + Item name to look for. + + + + + Invokes the DotNetBar Customize dialog. + + + + + Invokes ItemDoubleClick event. + + Reference to item double-clicked + Event arguments + + + + Clean up any resources being used. + + + + + Applies design-time defaults to control. + + + + + Creates the Graphics object for the control. + + The Graphics object for the control. + + + + Returns the renderer control will be rendered with. + + The current renderer. + + + + Called after control has painted its content and allows painting on top of the controls content. + + Paint arguments. + + + + Raises ItemLayoutUpdated event. + + Provides event arguments. + + + + Applies any layout changes and repaint the control. + + + + + Occurs when Checked property of an button has changed. + + + + + Occurs when Item is clicked. + + + + + Occurs when Item is clicked. + + + + + Occurs when popup of type container is loading. + + + + + Occurs when popup of type container is unloading. + + + + + Occurs when popup item is about to open. + + + + + Occurs when popup item is closing. + + + + + Occurs just before popup window is shown. + + + + + Occurs when Item Expanded property has changed. + + + + + Occurs when mouse button is pressed. + + + + + Occurs when mouse button is released. + + + + + Occurs when mouse enters the item. + + + + + Occurs when mouse leaves the item. + + + + + Occurs when mouse moves over the item. + + + + + Occurs when mouse remains still inside an item for an amount of time. + + + + + Occurs when item loses input focus. + + + + + Occurs when item receives input focus. + + + + + Occurs when user changes the item position, removes the item, adds new item or creates new bar. + + + + + Occurs after an Item is removed from SubItemsCollection. + + + + + Occurs after an Item has been added to the SubItemsCollection. + + + + + Occurs when ControlContainerControl is created and contained control is needed. + + + + + Occurs when Text property of an Item has changed. + + + + + Use this event if you want to serialize the hosted control state directly into the DotNetBar definition file. + + + + + Use this event if you want to deserialize the hosted control state directly from the DotNetBar definition file. + + + + + Occurs after DotNetBar definition is loaded. + + + + + Occurs when DotNetBar is looking for translated text for one of the internal text that are + displayed on menus, toolbars and customize forms. You need to set Handled=true if you want + your custom text to be used instead of the built-in system value. + + + + + Occurs before an item in option group is checked and provides opportunity to cancel that. + + + + + Occurs before tooltip for an item is shown. Sender could be the BaseItem or derived class for which tooltip is being displayed or it could be a ToolTip object itself it tooltip is not displayed for any item in particular. + + + + + Occurs after main application form is activated. + + + + + Occurs after main application form is deacticated. + + + + + Occurs on application wide mouse down event. + + + + + Gets or sets the form SideBar is attached to. + + + + + Indicates whether Reset buttons is shown that allows end-user to reset the toolbar state. + + + + + ImageList for images used on Items. Images specified here will always be used on menu-items and are by default used on all Bars. + + + + + ImageList for medium-sized images used on Items. + + + + + ImageList for large-sized images used on Items. + + + + + Indicates whether Tooltips are shown on Bars and menus. + + + + + Indicates whether item shortcut is displayed in Tooltips. + + + + + Gets or sets the item default accessibility action will be performed on. + + + + + Specifies the background style of the Explorer Bar. + + + + + Indicates whether shortucts handled by items are dispatched to the next handler or control. + + + + + Gets or sets Bar Color Scheme. + + + + + Gets or sets whether gray-scale algorithm is used to create automatic gray-scale images. Default is true. + + + + + Specifies whether SideBar is drawn using Themes when running on OS that supports themes like Windows XP. + + + + + Gets or sets whether anti-alias smoothing is used while painting. Default value is false. + + + + + Gets or sets the redering mode used by control. Default value is eRenderMode.Global which means that static GlobalManager.Renderer is used. If set to Custom then Renderer property must + also be set to the custom renderer that will be used. + + + + + Gets or sets the custom renderer used by the items on this control. RenderMode property must also be set to eRenderMode.Custom in order renderer + specified here to be used. + + + + + Occurs after internal item layout has been updated and items have valid bounds assigned. + + + + + Represents the method that will handle the ItemRemoved event. + + + + + Represents class for Accessibility support. + + + + + Creates new instance of the object and initializes it with owner control. + + Reference to owner control. + + + + Returns number of child objects. + + Total number of child objects. + + + + Returns reference to child object given the index. + + 0 based index of child object. + Reference to child object. + + + + Gets accessible role. + + + + + Gets parent accessibility object. + + + + + Returns bounds of the control. + + + + + Returns current accessible state. + + + + + Summary description for BarFunctions. + + + + + Tries to invoke the RecalcLayout method on the control and return true if such method was invoked. + + Reference to the control + Indicates whether to invalidate control if no recalc layout method is found + return true if method is invoked. + + + + Creates copy of a bar to be used as new dock bar. This function is used to create new bar for tabs that are torn off the existing dock bars. + + Original base bar to base the new bar on. + New instance of a bar. Note that bar is not added to the DotNetBarManager.Bars collection and DockSide is not set. + + + + Returns if passed control is ready for painting. + + Control to test. + true if handle is valid otherwise false + + + + XML element is expected to be something like Image data Base64 encoded + + Image data + + + + + Collection of Bar objects. + + + + + Releases the resources used by the Component. + + + + + Adds an Bar to the end of Bars collection. + + The Bar to be added to the end of the Bars collection. + + + + Removes specified bar from collection. + + Bar to remove + + + + Determines whether an Bar is in the collection. + + The Bar to locate in the collection. + true if item is found in the collection; otherwise, false. + + + + Determines whether bar with given name is in collection. + + Name of the bar + True if bar is part of this collection, otherwise false. + + + + Returns the zero-based index of the Bar in the collection. + + Bar to locate. + + + + + Gets the Bar at the specified index. + + + + + Gets the Bar with the specified name. + + + + + Holds the XML element and attribute names for bar serialization. + + + + + Represents class with static functions that provide commonly used utility functions when working with + Bar objects and items hosted by Bar object. + + + + + Sets Bar visible property and remembers the auto-hide state. + + Bar to set visibility for. + true if visible otherwise false + + + + Sets the visible property of DockContainerItem and hides the bar if the given item is the last visible item on the bar. + It will also automatically display the bar if bar is not visible. + + DockContainerItem to set visibility for. + Indicates the visibility of the item + + + + Creates new instance of the bar and sets its properties so bar can be used as Document bar. + + Returns new instance of the bar. + + + + Sets the properties on a bar so it can be used as Document bar. + + Bar to set properties of. + + + + Changes the MDI Client border edge to remove 3D border or to add it. + + Reference to MDI Client object. + Indicates whether to remove border. + + + + Changes the MDI Client border edge to remove 3D border or to add it. + + Reference to MDI parent form. + Indicates whether to remove border. + + + + Disposes image reference and sets it to null. + + Reference to image to dispose. + + + + Disposes image reference and sets it to null. + + Reference to image to dispose. + + + + Invokes the method asynchronously using the WinForms Timer. + + Method to invoke. + + + + Invokes the method asynchronously using the WinForms Timer. + + Method to invoke. + Time in milliseconds after which method is invoked. + + + + Gets or sets whether Fade Animation is enabled on system level for DotNetBar items which use this. Default value is true. + + + + + Gets or sets whether StringFormat internally used by all DotNetBar controls to render text is GenericDefault. Default value is false + which indicates that GenericTypographic is used. + + + + + Gets or sets the anti-alias text rendering hint that will be used to render text on controls that have AntiAlias property set to true. + + + + + Gets or sets whether .NET Framework TextRenderer class is used for text rendering instead of Graphics.DrawString. + Default value is false. + Using TextRenderer will disable the Fade and Animation effects on controls because of issues in TextRenderer when drawing text on transparent + surfaces. + + + + + Gets or sets whether items always generate the Focus accessibility event when mouse enters the item. Default value is false which indicates + that focus event will be raised only when item is on menu bar. + + + + + Gets or sets whether Application Message Filter that is registered by popup controls + is automatically unregistered when last control is disposed. Default value is false and + in most cases should not be changed. + + + + + Get or sets the text-markup padding for text measurement when running on Japanese version of Windows. + + + + + Gets or sets whether Image and Icon resources assigned to items and controls are automatically disposed when + control or item is disposed. Default value is false. + + + + + Defines the base class for items that are used by DotNetBar. + + + + + Represents a content block interface. + + + + + Gets or sets the bounds of the content block. + + + + + Gets or sets whether content block is visible. + + + + + Gets or sets the block margins. + + + + + Creates new instance of BaseItem. + + + + + Creates new instance of BaseItem and assigns item name. + + Item name. + + + + Creates new instance of BaseItem and assigns item name and item text. + + Item Name + Item Text + + + + Serializes the item and all sub-items into the XmlElement. + + XmlElement to serialize the item to. + + + + Deserialize the Item from the XmlElement. + + Source XmlElement. + + + + Indicates whether SubItems collection is serialized. Default value is true. + + + + + Called on each item when ScaleControl method of parent control is called and gives opportunity to item to adjust its displayed based on current scaling. + + Scale factor. + + + + Called when item container has changed. If you override this method you must call the base implementation to allow default processing to occur. + + Previous container of the item. + + + + Called when item parent has changed. + + + + + Returns whether item is enabled including the parent control item is on. + + + + + + Returns whether item is enabled including the parent control item is on. + + + + + + Called when size of the item is changed externally. + + + + + Called when Visibility of the items has changed. + + New Visible state. + + + + Called when item Display state has changed. + + + + + Called when item owner has changed. + + + + + Raises SubItemsChanged event. + + + + + + Occurs after an item has been added to the container. This procedure is called on both item being added and the parent of the item. To distinguish between those two states check the item parameter. + + When occurring on the parent this will hold the reference to the item that has been added. When occurring on the item being added this will be null (Nothing). + + + + Occurs after an item has been removed. + + Item being removed. + + + + Occurs just before Click event is fired. + + + + + Occurs after SubItems Collection has been cleared. + + + + + Occurs before an item is removed. + + Item being removed. + + + + Occurs when IsOnCustomizeMenu property has changed. + + + + + Occurs when IsOnCustomizeDialogChanged property has changed. + + + + + Occurs when item enter or exists the design mode. + + + + + Occurs when tooltip is about to be shown or hidden. + + Specifies whether tooltip is shown or hidden. + + + + Occurs after item has received the input focus. + + Item that received the focus. + + + + Occurs after item has lost the input focus. + + Item that lost the input focus. + + + + Indicates whether the item enabled property has changed. + + + + + Called after TopInternal property has changed + + + + + Called after LeftInternal property has changed + + + + + Occurs when the mouse pointer enters the item. This is used by internal implementation only. + + + + + Occurs when the mouse pointer hovers the item. This is used by internal implementation only. + + + + + Occurs when the mouse pointer leaves the item. This is used by internal implementation only. + + + + + Occurs when the mouse pointer is over the item and a mouse button is pressed. This is used by internal implementation only. + + + + + Occurs when the mouse pointer is over the item and a mouse button is released. This is used by internal implementation only. + + + + + Occurs when a key is pressed down while the item has focus. This is used by internal implementation only. + + + + + Processes the MouseLeave for the current mouse over item. + + + + + Occurs when the mouse pointer is moved over the item. This is used by internal implementation only. + + + + + Occurs when the item is clicked. This is used by internal implementation only. + + + + + Raises the click event and provide the information about the source of the event. + + + + + + Raises the Click event with default source as Code. + + + + + Occurs when the item is double clicked. This is used by internal implementation only. + + + + + Invokes DoubleClick event. + + + + + Occurs when the item receives focus. If overridden base implementation must be called so default processing can occur. + + + + + Occurs when the item has lost the focus. If overridden base implementation must be called so default processing can occur. + + + + + Sets the input focus to the item. If overridden base implementation must be called so default processing can occur. + + + + + Releases the input focus. If overridden base implementation must be called so default processing can occur. + + + + + Occurs when item container has lost the input focus. If overridden base implementation must be called so default processing can occur. + + + + + Occurs when item container receives the input focus. If overridden base implementation must be called so default processing can occur. + + + + + Indicates that item size has changed. It must be called by child item to let the parent know that its size + has been changed. + + + + + Return Sub Item at specified location + + + + + Gets the current expanded subitem. + + + + + + Gets the item that has input focus. + + Item that has focus or Null (Nothing) if none of the subitems have focus. + + + + Gets the owner of the item. + + DotNetBarManager that owns the item. + + + + Recalculate the size of the item. If overridden base implementation must be called so default processing can occur. + + + + + Must be overridden by class that is inheriting to provide the painting for the item. + + + + + Must be overridden by class that is inheriting to provide the method to + return copy of an item. + + + + + Internal Copy implementation. + + Item to copy to. + + + + Returns copy of the item. + + Copy of the item. + + + + Forces the repaint the item. + + + + + Occurs when Expanded state changes. If overridden base implementation must be called so default processing can occur. + + + + + Raises ExpandChange event. + + Event arguments + + + + Occurs when sub item expanded state has changed. + + Sub item affected. + + + + Releases all resurces used in this control. After calling Dispose() + object is not in valid state and cannot be recovered to the valid state. + Recreation of the object is required. + + + + + Occurs after item visual style has changed. + + + + + Occurs after text has changed. + + + + + Returns if passed control is valid. + + Control to test. + + + + + Resets Hoover timer. + + + + + Returns true if any subitem is contained on the control with a given handle. + + Container handle to test. + + + + + Occurs after Tooltip text has changed. + + + + + Sets orientation of the item but it does not cause the recalculate layout flag setting on the parent item. + + New orientation value. + + + + Destroys tooltip window. + + + + + Called when HotSubItem has changed. + + New value. + Old value. + + + + Shows tooltip for this item. + + + + + Returns the shortcut string that is displayed on tooltip. + + + + + + Returns the point in screen coordinates. + + Client point + Point in screen coordinates if there is a parent Control otherwise clientPoint + + + + Collapses all sub items by setting their Expanded property to false. + + Item to collapse. + + + + Collapses all sub items by setting their Expanded property to false. Enumerates all child items as well. + + Item to collapse. + + + + Collapses whole tree for the item starting with its parent. + + Item to collapse. + + + + Returns whether item is hosted on popup menu or bar. + + Item to get information for. + + + + + Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table. + + Hash code. + + + + Called when DragStartPoint property has changed. + + Old property value + New property value + + + + Called when Command property value changes. + + + + + Occurs when text markup link is clicked. + + + + + Updates data bindings for item and its sub-items in response to binding context change on parent control. + + + + + Executes the specified delegate, on the thread that owns the control's underlying window handle, with the specified list of arguments. + This property calls directly the ContainerControl.Invoke and is provided as shortcut convenience property only. + + A delegate to a method that takes parameters of the same number and type that are contained in the args parameter. + An array of objects to pass as arguments to the specified method. This parameter can be null reference (Nothing in Visual Basic) if the method takes no arguments. + An Object that contains the return value from the delegate being invoked, or nullNothingnullptra null reference (Nothing in Visual Basic) if the delegate has no return value. + + + + Executes the specified delegate, on the thread that owns the control's underlying window handle, with the specified list of arguments. + This property calls directly the ContainerControl.Invoke and is provided as shortcut convenience property only. + + A delegate to a method that takes parameters of the same number and type that are contained in the args parameter. + An Object that contains the return value from the delegate being invoked, or nullNothingnullptra null reference (Nothing in Visual Basic) if the delegate has no return value. + + + + Executes the specified delegate, on the thread that owns the control's underlying window handle, with the specified list of arguments. + This property calls directly the ContainerControl.BeginInvoke and is provided as shortcut convenience property only. + + A delegate to a method that takes parameters of the same number and type that are contained in the args parameter. + An Object that contains the return value from the delegate being invoked, or nullNothingnullptra null reference (Nothing in Visual Basic) if the delegate has no return value. + + + + Occurs when Item is clicked. + + + + + Occurs when Item is double-clicked. + + + + + Occurs when Item Expanded property has changed. + + + + + Occurs when item loses input focus. + + + + + Occurs when item receives input focus. + + + + + Occurs when mouse button is pressed. + + + + + Occurs when mouse button is released. + + + + + Occurs when mouse enters the item. + + + + + Occurs when mouse leaves the item. + + + + + Occurs when mouse moves over the item. + + + + + Occurs when mouse remains still inside an item for an amount of time. + + + + + Occurs when copy of the item is made. + + + + + Occurs when Text property of an Item has changed. + + + + + Occurs when Visible property of an Item has changed. + + + + + Occurs when Enabled property of an Item has changed. + + + + + Occurs when item's tooltip visibility has changed. + + + + + Occurs when content of SubItems collection has changed. + + + + + Gets or sets whether item is rendered. + + + + + Gets or sets whether item is selectable at design-time. Default value is true. + + + + + Control Container (System.Windows.Forms.Control or its descendant) + + + + + Returns the Parent of the item. + + + + + Gets or sets a value indicating whether the item is enabled. + + + + + Gets or sets whether item separator is shown before this item. + + + + + Gets or sets Left position of this item + + + + + Gets or sets Top position of this item + + + + + Gets or sets Width of this item + + + + + Gets whether item is in right-to-left layout mode. + + + + + Gets or sets Height of this item + + + + + Gets or sets a value indicating whether the item is visible. + + + + + Gets or sets a value indicating whether the item is expanded or not. For Popup items this would indicate whether the item is popped up or not. + + + + + Indicates whether the item will auto-collapse (fold) when clicked. + When item is on popup menu and this property is set to false, menu will not + close when item is clicked. + + + + + Gets or sets whether item will auto expand when mouse is over the item or not. + + + + + Gets the rectangle that represents the display area of the item. + + + + + Gets or sets the size of the item. + + + + + IBlock member implementation + + + + + Specifies whether this item is visual container or not. For example + Tool Menu is not container since it drops-down its items and they are + not "visualy" contained. Also, the pop-up menus, drop-down Bars etc. are not containers. + + + + + Returns true if this item is currently displayed. This property should not be set directly since it is managed by system and container of the item. + + + + + Gets the mouse down coordinates. + + + + + Gets whether item is on context menu created using ContextMenuBar + + + + + Gets whether RaiseClick method will generate a click event give current item state. + + + + + Indicates whether RaiseClick method collapses parent popups before raising click event. Default value is true. + + + + + Gets whether item has input focus. + + + + + Indicates that item is recalculating its size. + + + + + Suspends all layout for the item including painting. Use this property carefully and only to improve performace. + + + + + Indicates whether item is performing layout pass. + + + + + Gets whether layout pass is in progress in the parent chain. + + + + + Gets whether item has been disposed through Dispose method call. + + + + + Returns the collection of sub items. + + + + + Returns count of sub items in SubItems collection that have Visible property set to true. + + + + + Unique ID that indentifies the item. + + + + + Allows the user to associate custom user data with the item. + + + + + Applies new visual style to this the item and all of its sub-items. + + + + + Gets the effective item style. + + + + + Gets or sets whether item will display sub items. + + + + + Gets or sets item alignment inside the container. + + + + + Gets or sets item description. This description is displayed in + Customize dialog to describe the item function in an application. + + + + + Gets or sets whether the item expands automatically to fill out the remaining space inside the container. Applies to Items on stretchable, no-wrap Bars only. + + + + + Gets/Sets informational text (tooltip) for the item. + + + + + Returns category for this item. If item cannot be customzied using the + customize dialog category is empty string. + + + + + Returns name of the item that can be used to identify item from the code. + + + + + Gets or sets the global name of the item that is used to synchronize the Global properties for the item across all instances with same + global name. Note that only instances that belong to the same control are synchronized. GlobalItem must be set to true to perform the synchronization. + You can find more information and list of + properties that are synchronized in help file. + + + + + Gets whether global properties should synchronized. + + + + + Gets orientation within container that is supported by this item. If item does not support certain orientation the container automatically hides it when container switches into that orientation. + + + + + Gets or sets whether item is global or not. + This flag is used to propagate property changes to all items with the same name. + Setting for example Visible property on the item that has GlobalItem set to true will + set visible property to the same value on all items with the same name. + + + + + Gets or sets orientation inside the container. Do not change the value of this property. It is managed by system only. + + + + + Gets whether tooltip for the item is displayed. + + + + + Gets whether tooltip is visible or not. + + + + + Gets or sets the name of the bar this item originated on. This is used to remember the + originating bar when user is moving the items from bar to bar. + + + + + Gets or sets item's original position (index) if item position has changed due to the user customization. + + + + + Gets or sets flag that indicates whether item was customize by the end-user. + + + + + Gets reference to the tooltip control if tooltip is displayed for this item. + + + + + Gets or sets the Key Tips access key or keys for the item when on Ribbon Control or Ribbon Bar. Use KeyTips property + when you want to assign the one or more letters to be used to access an item. For example assigning the FN to KeyTips property + will require the user to press F then N keys to select an item. Pressing the F letter will show only keytips for the items that start with letter F. + + + + + Gets or sets the text associated with this item. + + + + + Gets or sets whether item can be customized by end user. + + + + + Returns whether item is hosted on Customize menu. + + + + + Returns whether item is hosted on Customize Dialog. + + + + + Returns whether item is hosted on menu or not. + + + + + Returns whether item is hosted on menu bar or not. + + + + + Returns whether item is hosted on bar or not. + + + + + Returns whether item is in design mode or not. + + + + + Get or sets whether item has been changed in a way that it needs its size recalculated. This is internal + property and it should not be used by your code. + + + + + Returns whether item is System item. + + + + + Indicates whether access key processing set using ampersand key in Text is enabled. When enabled, and access key is pressed, item will raise Click event. + + + + + Return Access key for the item. + + + + + Gets or sets the collection of shortcut keys associated with the item. + + + + + Returns text representation of shortcut for this item. + + + + + Gets or sets whether Click event will be auto repeated when mouse button is kept pressed over the item. + + + + + Gets or sets the auto-repeat interval for the click event when mouse button is kept pressed over the item. + + + + + Gets or sets the design-marker orientation for the item. + + + + + + Specifes the mouse cursor displayed when mouse is over the item. + + + + + Indicates whether item will be Serialized. + + + + + Specifies whether item is drawn using Themes when running on OS that supports themes like Windows XP. + + + + + Gets the AccessibleObject assigned to the item. + + + + + Gets or sets the default action description of the control for use by accessibility client applications. + + + + + Gets or sets the description of the control used by accessibility client applications. + + + + + Gets or sets the name of the control used by accessibility client applications. + + + + + Gets or sets the accessible role of the item. + + + + + Gets or sets a value indicating whether the item is visible to accessibility applications. + + + + + Gets the item state inside of the parent container. + + + + + Gets or sets item margin only used by certain items in certain containers. Provided only for internal DotNetBar use. + + + + + Gets or sets the command assigned to the item. Default value is null. + Note that for ButtonItem instances if this property is set to null and command was assigned previously, Enabled property will be set to false automatically to disable the item. + + + + + Gets or sets user defined data value that can be passed to the command when it is executed. + + + + + Gets reference to parsed markup body element if text was markup otherwise returns null. + + + + + Gets plain text without text-markup if text-markup is used in Text. + + + + + Gets whether item supports text markup. Default is false. + + + + + Gets a value indicating whether the caller must call an invoke method when making method calls to the item because the caller is on a different thread than the one the item was created on. + This property calls directly the ContainerControl.InvokeRequired and is provided as shortcut convinience property only. + + + + + Defines item parent container states. + + + + + State is not set. + + + + + Item in on the NavigationPane in normal size. + + + + + Represents the controller which allows single BaseItem to be hosted on the control. + + + + + Initializes a new instance of the BaseItemController class. + + + + + + + Returns the renderer control will be rendered with. + + The current renderer. + + + + Defines class which described single binding. + + + + + Raises Format event. + + Provides event arguments. + + + + Initializes a new instance of the BindingDef class. + + + + + Initializes a new instance of the BindingDef class. + + + + + + + Updates specified item PropertyName with the data from data object property specified by DataMember. + + Item to set PropertyName on. + Data to retrieve DataMember value from. + + + + Updates specified item PropertyName with the data from data object property specified by DataMember. + + CurrencyManager to use + Item to set PropertyName on. + Data to retrieve DataMember value from. + + + + Called when PropertyName property has changed. + + Old property value + New property value + + + + Called when DataMember property has changed. + + Old property value + New property value + + + + Called when FormattingEnabled property has changed. + + Old property value + New property value + + + + Called when FormatString property has changed. + + Old property value + New property value + + + + Called when FormatInfo property has changed. + + Old property value + New property value + + + + Called when NullValue property has changed. + + Old property value + New property value + + + + Raises the PropertyChanged event. + + Provides event arguments. + + + + Gets or sets the property name binding is attached to. + + + + + Gets the reference to BindingMemberInfo created based on DataMember. + + + + + Gets or sets the data member name which holds data that PropertyName is populated with. + + + + + Gets or sets whether type conversion and formatting is applied to the property data. + + + + + Gets or sets format specifier characters that indicate how a value is to be displayed. + For more information, see Formatting Overview: http://msdn.microsoft.com/en-us/library/26etazsy%28v=vs.71%29.aspx + + + + + Gets or sets the IFormatProvider that provides custom formatting behavior. + + + + + Gets or sets the Object to be set as the target property when the data source contains a DBNull value. + The data source must contain DBNull for the NullValue property to be correctly applied. + If the data source type is a type such as a string or integer the value of the NullValue property will be ignored. + Also, the NullValue property is ignored if it is set to null. + + + + + Occurs when property on BindingDef object has changed. + + + + + Represents the method that will handle converting for bindings. + + + + + + + Gets the reference to the item being converted. + + + + + Get the reference to the name of the field or property on the item that needs conversion. + + + + + Represents BindingDefConverer converter. + + + + + Creates new instance of the class. + + + + + Checks whether conversion can be made to specified type. + + Context Information. + Destination type. + + + + + Converts object to specified type. + + Context information. + Culture information. + Object to convert. + Destination type. + Object converted to destination type. + + + + Represents the toolbar control with the magnifying (bubbling) buttons. + + + + + Creates new instance of the control. + + + + + Indicates whether property should be serialized. Used by the Windows Forms design-time support. + + + + + Resets the property to default value. Used by the Windows Forms design-time support. + + + + + Indicates whether property should be serialized. Used by the Windows Forms design-time support. + + + + + Resets the property to default value. Used by the Windows Forms design-time support. + + + + + Returns whether property should be serialized by Windows Forms designer. + + True if property is different than default value otherwise false. + + + + Returns whether property should be serialized by Windows Forms designer. + + True if property is different than default value otherwise false. + + + + Recalculates the layout of the control. This method should be called after all changes to the tabs, buttons are completed so + layout of the control recalculated. + + + + + Raises ItemLayoutUpdated event. + + Provides event arguments. + + + + Returns reference to the button at specified location + + x - coordinate + y - coordinate + Reference to the button or null if no button could be found at given coordinates. + + + + Returns reference to the button at specified location + + Location coordinates + Reference to the button or null if no button could be found at given coordinates. + + + + Returns tab at specific location. + + Coordinates to get the tab from. + Reference to the tab object or null if tab cannot be found at specified location + + + + Returns tab at specific location. + + x - coordinate + y - coordinate + Reference to the tab object or null if tab cannot be found at specified location + + + + Invokes BubbleStart event. + + + + + Invokes BubbleEnd event. + + + + + Invokes ButtonClick event on the control. + + Reference to the button that was clicked. + + + + Called after overlay window became inactive. + + + + + Stops the bubble animation effect is one is applied currently. + + + + + Internal processing of MouseMove event. + + Move move event arguments. + + + + Internal processing for MouseLeave event. + + Event arguments + + + + Called after all buttons have been removed. + + Tab from which all buttons were removed. + + + + Called after specified button has been removed. + + Tab from which button was removed. + Button that was removed. + + + + Called after new button is added to the Buttons collection. + + Tab to which button was added. + Reference to the button added. + + + + Called when Visible property of Button has changed. + + Button affected. + + + + Returns the button background rectangle for display purposes. Applies setting for the ButtonBackgroundStretch property. + + Background rectangle. + + + + Called after tab has been removed from the collection. + + Tab that was removed. + + + + Called after tab has been added to the collection. + + Newly added tab. + + + + Called after all tabs are removed from the collection. + + + + + Called after text of a tab has changed. + + Tab which text has changed. + + + + Called after Visible property of the tab has changed. + + Tab affected. + + + + Sets the tab mouse is placed over. + + Tab that mouse is currently over or null if mouse is not over any tab. + + + + Occurs when active tab is about to change. + + + + + Occurs when any of the buttons is clicked. Sender object should be casted to BubbleButton to get the button that was actually clicked. + + + + + Occurs when mouse first enters the control and bubble effect is employed to provide feedback. + + + + + Occurs when mouse leaves the control and bubble effect is ended. + + + + + Gets or sets the bubble button tooltip text color. Default value is White color. + + + + + Gets or sets the bubble button tooltip text outline color. Default value is Black color. + + + + + Gets or sets the spacing in pixels between buttons. Default value is 0. + + + + + Gets or sets whether background for the buttons is stretched to consume complete width of the control. Default value is true. + + + + + Gets the style for the background of the control. + + + + + Gets the style for the background of the buttons. + + + + + Gets the bounds of the buttons back area. + + + + + Gets the bounds of the tabs area. + + + + + Gets or sets the duration of animation that is performed when mouse enters a button for the first time or when mouse has left the control. + + + + + Gets or sets whether bubble animation is enabled. Default value is true. + + + + + Gets or sets whether anti-alias smoothing is used while painting. + + + + + Gets or sets ImageList for images used on buttons. These images will be used as images for the buttons that are not magnified. + Use ImagesLarge to specify the magnified images for the coresponding images based on the index in this list. + + + + + Gets or sets ImageList for large-sized images used on buttons when button is magnified. + + + + + Gets or sets whether tooltips are displayed for the buttons. + + + + + Gets or sets size of the images when button is enlarged, default value is 48 by 48 pixels. Note that you should provide the + images in the same size for the buttons through the image properties on the buttons or through ImagesLarge property. + If the large images are not provided the regular button image will be automatically enlarged. + + + + + Gets or sets the normal image size for the buttons, default value is 24 by 24 pixels. This should be set to the default image size that you will use on the + buttons. If the images specified for the buttons are not of the same size as the size specified here then they will + be automatically resized. Normal size must always be smaller than the size specified by ImageSizeLarge property. + + + + + Gets or sets the font that is used to display tooltips. + + + + + Gets or sets the selected tab. + + + + + Gets the reference to the colors that are used when tab is selected. + + + + + Gets the reference to the colors that are used when mouse is over the tab. + + + + + Gets the collection of all tabs. + + + + + Gets or sets the button alignment. + + + + + Gets or sets whether tabs are visible. Default value is true. + + + + + Occurs after internal item layout has been updated and items have valid bounds assigned. + + + + + Delegate for tab change events. + + + + + Represents the event arguments tab changing events. + + + + + Cancels the operation. + + + + + Specifies the event source. + + + + + Specifies newly selected tab. + + + + + Specifies currently selected tab. + + + + + Default Constructor. + + + + + Represents overlay class to support bubble effects on BubbleBar control. + + + + + Called just before window is shown. + + + + + Called after window is closed. + + + + + Summary description for BubbleBarGroup. + + + + + Represents interface for simple text only tab. + + + + + Returns the font used for tab text. + + Reference to font object. + + + + Gets or sets the text displayed on the tab. + + + + + Gets or sets whether tab is visible. + + + + + Gets the display bounds of the tab. + + + + + Gets or sets the background color of the tab when inactive. + + + + + Gets or sets the target gradient background color of the tab when inactive. + + + + + Gets or sets the gradient angle. + + + + + Gets or sets the light border color when tab is inactive. + + + + + Gets or sets the dark border color when tab is inactive. + + + + + Gets or sets the border color when tab is inactive. + + + + + Gets or sets the text color when tab is inactive. + + + + + Gets or sets name of the tab item that can be used to identify item from the code. + + + + + Gets or sets the predefined tab color. + + + + + Returns true if tab is selected tab. + + + + + Returns true if mouse is over the tab. + + + + + Gets the tab alignment. + + + + + Default constructor. + + + + + Default constructor. + + Container object. + + + + Returns the font for the tab text. + + Reference to the font object. + + + + Sets the parent of the tab. + + Reference to the tab parent object or null. + + + + Called after new button is added to the Buttons collection. + + Reference to the added button. + + + + Called after specified button has been removed. + + Button that was removed. + + + + Called after all buttons have been removed. + + + + + Gets the collection of the buttons associated with the tab. + + + + + Gets or sets the text displayed on the tab. + + + + + Gets or sets whether tab is visible. + + + + + Gets the display bounds of the tab. + + + + + Gets or sets the object that contains data about the tab. Any Object derived type can be assigned to this property. If this property is being set through the Windows Forms designer, only text can be assigned. + + + + + Gets or sets the object that contains data about the tab. Any Object derived type can be assigned to this property. If this property is being set through the Windows Forms designer, only text can be assigned. + + + + + Gets or sets the background color of the tab when inactive. + + + + + Gets or sets the target gradient background color of the tab when inactive. + + + + + Gets or sets the gradient angle. + + + + + Gets or sets the light border color when tab is inactive. + + + + + Gets or sets the dark border color when tab is inactive. + + + + + Gets or sets the border color when tab is inactive. + + + + + Gets or sets the text color when tab is inactive. + + + + + Gets or sets name of the tab item that can be used to identify item from the code. + + + + + Gets or sets the predefined tab color. + + + + + Returns true if tab is selected tab. + + + + + Returns true if mouse is over the tab. + + + + + Gets the tab alignment. + + + + + Returns reference to parent object or null if tab does not have parent. + + + + + Gets or sets whether tab has design-time focus. + + + + + Gets or sets the bounds of the content block. + + + + + Gets or sets item margin only used by certain items in certain containers. Provided only for internal DotNetBar use. + + + + + Represents collection for BubbleBarTab objects. + + + + + Adds new object to the collection. + + Object to add. + Index of newly added object. + + + + Inserts new object into the collection. + + Position of the object. + Object to insert. + + + + Returns index of the object inside of the collection. + + Reference to the object. + Index of the object. + + + + Returns whether collection contains specified object. + + Object to look for. + true if object is part of the collection, otherwise false. + + + + Removes specified object from the collection. + + + + + + Copies collection into the specified array. + + Array to copy collection to. + Starting index. + + + + Copies contained items to the IBlock array. + + Array to copy to. + + + + Copies contained items to the ISimpleTab array. + + Array to copy to. + + + + Returns next visible tab from the reference tab. + + Reference tab. + Next visible tab or null if next visible tab cannot be determined. + + + + Returns previous visible tab from the reference tab. + + Reference tab. + Previous visible tab or null if Previous visible tab cannot be determined. + + + + Returns reference to the object in collection based on it's index. + + + + + Represents a button used on BubbleBar control. + + + + + Creates new instance of button object. + + + + + Sets the display rectangle of the button. + + New display rectangle of the button. + + + + Sets the magnified display rectangle of the button. + + New magnified display rectangle. + + + + Sets whether mouse is over the button. + + True if mouse is over the button otherwise false. + + + + Raises the MouseEnter event. + + + + + Raises the MouseLeave event. + + + + + Sets whether left mouse button is pressed over this button. + + True if left mouse button is pressed otherwise false. + + + + Sets the parent collection button belongs to. + + Parent collection of the item. + + + + Returns the reference to the BubbleBar that contains this button. + + + + + + Invokes button's Click event. + + Indicates source of the event. + + + + Raises click event. + + Default event arguments. + + + + Occurs when user clicks the button. + + + + + Occurs when mouse enters the button. + + + + + Occurs when mouse leaves the button. + + + + + Gets or sets the shortcut key to expand/collapse splitter. + + + + + Gets or sets the tooltip for the button. + + + + + Gets or sets the default image used on the button. Note that for improved appearance of the buttons when enlarged + you should set the ImageIndexLarge to the large version of the image specified here. The image size should be the same size + that is specified by the image size properties on BubbleBar object. + + + + + Gets reference to the internal cached image loaded from the ImageIndex. + + + + + Gets reference to the internal cached image loaded from the ImageIndex. + + + + + Specifies the Button image. + + + + + Specifies enlarged the Button image. + + + + + Gets or sets the image index of the enlarged image for the button. Note that if large image is not specified the + default image will be enlarged which might not result in perfect image appearance. + + + + + Property for Property Editor support for ImageIndex selection. + + + + + Gets or sets a value indicating whether button is enabled. + + + + + Gets the display rectangle occupied by the button. + + + + + Gets or sets the magnified display rectangle of the button. + + + + + Gets whether mouse is over the button. + + + + + Gets whether left mouse button is pressed on the button. + + + + + Returns name of the button that can be used to identify it from the code. + + + + + Gets or sets a value indicating whether button is visible. + + + + + Gets or sets the object that contains data about the tab. Any Object derived type can be assigned to this property. If this property is being set through the Windows Forms designer, only text can be assigned. + + + + + Gets or sets the object that contains data about the tab. Any Object derived type can be assigned to this property. If this property is being set through the Windows Forms designer, only text can be assigned. + + + + + Returns the reference to parent tab. + + + + + Gets or sets whether button has design-time focus. + + + + + Gets or sets the mouse cursor that is displayed when mouse is over the button. + + + + + Gets or sets the bounds of the content block. + + + + + Gets or sets item margin only used by certain items in certain containers. Provided only for internal DotNetBar use. + + + + + Represents event arguments for Click event. + + + + + Gets the action that caused the event, event source. + + + + + Represents typed collection of BubbleButton objects. + + + + + Copies contained items to the IBlock array. + + Array to copy to. + + + + Creates new instance of the collection. + + Parent of the collection. + + + + Adds new item to the collection but it does not raise internal events. + + New item to add. + Index of newly added item. + + + + Adds new item to the collection at specified location but it does not raise internal events. + + New item to add. + Position to add item to. + + + + Clears the collection but it does not raise internal events. + + + + + Performs additional custom processes before setting a value in the CollectionBase instance. + + The zero-based index at which oldValue can be found. + The value to replace with newValue. + The new value of the element at index. + + + + Performs additional custom processes after setting a value in the CollectionBase instance. + + The zero-based index at which oldValue can be found. + The value to replace with newValue. + The new value of the element at index. + + + + Performs additional custom processes before inserting a new element into the CollectionBase instance. + + The zero-based index at which to insert value. + The new value of the element at index. + + + + Performs additional custom processes after inserting a new element into the CollectionBase instance. + + The zero-based index at which to insert value. + The new value of the element at index. + + + + Performs additional custom processes when removing an element from the CollectionBase instance. + + The zero-based index at which value can be found. + The value of the element to remove from index. + + + + Performs additional custom processes after removing an element from the CollectionBase instance. + + The zero-based index at which value can be found. + The value of the element to remove from index. + + + + Removes an item without raising internal events. + + Item to remove. + + + + Performs additional custom processes when clearing the contents of the CollectionBase instance. + + + + + Copies the collection to the ArrayList object. + + Target ArrayList. + + + + Adds new item to the collection. + + New item to add. + Index of newly added item. + + + + Adds new item to the collection at specified location. + + New item to add. + Position to insert item at. Position of -1 will append the item to the end of the collection. + Index of the newly added item. + + + + Inserts new item at the specified position. + + Position to insert item at. + Item to insert. + + + + Returns index of an item. + + Item to return index for. + Item at the specified position. + + + + Returns index of an item with given the item's name. + + Name of the item. + Index of the Item with the specified name or -1 if item is not found. + + + + Returns true if given item is contained by this collection. + + Item to test. + True if item is part of this collection otherwise false. + + + + Returns true if item with given name is part of this collection. + + Item name. + True if item is part of this collection otherwise false. + + + + Removes an item from the collection. + + Item to remove. + + + + Removes an item from collection at specified index. + + Index of the item to remove. + + + + Removes item from the collection with specified name. + + Name of the item to remove. + + + + Adds array of the items to the collection. + + Array of items to add. + + + + Copy the collection to the array. + + Array to copy collection to. + The zero-based relative index in array at which copying begins. + + + + Gets the parent of the collection. + + + + + Accesses items inside of the collection based on the index. + + + + + Accesses items inside of the collection based on the name. + + + + + Represents class for displaying BubbleButton objects on canvas. + + + + + Paints button on given canvas. + + Painting information. + + + + Represents class that holds information for BubbleButton painting. + + + + + Graphics object. + + + + + Button to paint. + + + + + Reference to BubbleBar control. + + + + + Gets or sets whether magnified version of the button is painted. + + + + + Gets or sets the button alignment inside of the bar. + + + + + Represents class for default layout of the BubbleButton objects. + + + + + Represents block layout manager responsible for sizing the content blocks. + + + + + Resizes the content block and sets it's Bounds property to reflect new size. + + Content block to resize. + Content size available for the block in the given line. + + + + Performs layout finalization + + + + + + + + + Gets or sets the graphics object used by layout manager. + + + + + Creates new instance of the class. + + + + + Resizes the content block and sets it's Bounds property to reflect new size. + + Content block to resize. + + + + Represents class that provides mangification for the BubbleMar control + + + + + Represents the serial content layout manager that arranges content blocks in series next to each other. + + + + + Represents interface for block layout. + + + + + Performs layout of the content block. + + Container bounds to layout content blocks in. + Content blocks to layout. + Block layout manager that resizes the content blocks. + The bounds of the content blocks within the container bounds. + + + + Creates new instance of the class. + + + + + Performs layout of the content block. + + Container bounds to layout content blocks in. + Content blocks to layout. + Block layout manager that resizes the content blocks. + The bounds of the content blocks within the container bounds. + + + + Occurs when X, Y position of next block is calcualted. + + + + + Occurs before new block is layed out. + + + + + Indicates whether space to the left of center and right aligned blocks is blocked out by stretching the block so it consumes that space. + + + + + Gets or sets the spacing in pixels between content blocks. Default value is 0. + + + + + Gets or sets whether content blocks are forced to fit the container bounds if they + occupy more space than it is available by container. Default value is false. + + + + + Gets or sets whether content blocks are resized to fit the container bound if they + occupy less space than it is available by container. Default value is false. + + + + + Gets or sets whether content blocks are resized (Width) to fit container bounds if they + occupy less space than the actual container width. Applies to the Vertical orientation only. Default value is false. + + + + + Gets or sets whether content blocks are resized (Height) to fit container bounds if they + occupy less space than the actual container height. Applies to the Horizontal orientation only. Default value is false. + + + + + Gets or sets the content orientation. Default value is Horizontal. + + + + + Gets or sets the content vertical alignment. Default value is Middle. + + + + + Gets or sets the block line vertical alignment. Default value is Middle. + + + + + Gets or sets the content horizontal alignment. Default value is Left. + + + + + Gets or sets whether all content blocks are resized so they have same height which is height of the tallest content block. Default value is false. + + + + + Gets or sets whether oversized blocks are resized based on the percentage reduction instead of based on equal pixel distribution. Default value is false. + + + + + Gets or sets whether content is wrapped into new line if it exceeds the width of the container. + + + + + Gets or sets whether layout is right-to-left. + + + + + Performs layout of the content block. + + Container bounds to layout content blocks in. + Content blocks to layout. + Block layout manager that resizes the content blocks. + The bounds of the content blocks within the container bounds. + + + + Gets or sets the bubble size for the mouse over item. + + + + + Gets or sets magnification factor for the item that is at the position MouseOverIndex-1 + + + + + Gets or sets magnification factor for the item that is at the position MouseOverIndex-2 + + + + + Gets or sets magnification factor for the item that is at the position MouseOverIndex+1 + + + + + Gets or sets magnification factor for the item that is at the position MouseOverIndex+2 + + + + + Gets or sets the index of the item mouse is over. + + + + + Gets or sets new X coordinate of the mouse over item when in horizontal layout or Y + coordinate when in vertical layout. + + + + + Summary description for ButtonItem. + + + + + PopupItem Class can pop-up it's subitems on either the popup Bar + or menu. + + + + + Adds neccessary functions to base item so it supports images properly. + If your item implements images you should derive from this class instead of BaseItem + + + + + Create new instance of ImageItem. + + + + + Create new instance of ImageItem and assigns the item name. + + Item name. + + + + Create new instance of ImageItem and assigns the item name and text. + + Item name. + Item text. + + + + Must be called by any sub item that implements the image when image has changed + + + + + Called after image on an item has changed. + + + + + Refreshes internal image size structure. + + + + + Occurs after an item has been removed. + + Item being removed. + + + + Refreshes internal image size structure. + + + + + When parent items does recalc size for its sub-items it should query + image size and store biggest image size into this property. + + + + + Provides design-time support for DotNetBar items. + + + + + Creates new instance of PopupItem. + + + + + Creates new instance of PopupItem and assigns the name to it. + + Item name + + + + Creates new instance of PopupItem and assigns the name and text to it. + + Item name. + Item text. + + + + Copies the PopupItem specific properties to new instance of the item. + + New ButtonItem instance. + + + + Occurs when the mouse pointer is moved over the item. This is used by internal implementation only. + + + + + Occurs when the mouse pointer is over the item and a mouse button is released. This is used by internal implementation only. + + + + + Displays the sub-items on popup menu. + + Popup location. + + + + Invokes PopupOpen event. + + + + + + Displays the sub-items on popup menu. + + Horizontal coordinate in pixels of the upper left corner of a popup. + Vertical coordinate in pixels of the upper left corner of a popup. + + + + Displays the sub-items on popup menu. + + Horizontal coordinate in pixels of the upper left corner of a popup. + Vertical coordinate in pixels of the upper left corner of a popup. + Indicates whether screen position of the menu is verified so the menu always appears on the screen. + + + + Raises PopupShowing event. + + Event arguments. + + + + Displays the sub-items on popup toolbar. + + Popup location. + + + + Displays the sub-items on popup toolbar. + + Horizontal coordinate in pixels of the upper left corner of a popup. + Vertical coordinate in pixels of the upper left corner of a popup. + + + + Displays popup container. + + Popup location. + + + + Creates the popup container control which is a parent/holder control for the controls you want to display on the popup. + This method can be used if you do not wish to handle the PopupContainerLoad to add controls to the popup container. + After calling this method you can access PopupContainerControl property to add your controls to be displayed on the popup. + + Indicates whether PopupContainerLoad events are fired. + + + + Displays popup container. + + Horizontal coordinate in pixels of the upper left corner of a popup. + Vertical coordinate in pixels of the upper left corner of a popup. + + + + Displays the sub-items on popup specified by PopupType. + + Popup location. + + + + Displays the sub-items on popup specified by PopupType. + + Horizontal coordinate in pixels of the upper left corner of a popup. + Vertical coordinate in pixels of the upper left corner of a popup. + + + + Raises PopupClose event. + + Event arguments. + + + + Queries whether popup can be closed. + + Source of closing request. + true if popup can be closed otherwise false. + + + + Closes the currently open popup. + + + + + Raises PopupFinalized event. + + Event arguments. + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Sets the SourceControl for popup menu or toolbar. + + Control that popup menu or toolbar was invoked for. + + + + Occurs when popup container is loading. Use this event to assign control to the popup container. If you want to use same control + that you added to the popup container after popup is closed you must handle the PopupContainerUnload event and remove the control + from the popup container so it is not disposed with the container. + + + + + Occurs when popup container is unloading. Use this event to save any state associated with the control that was contained by the container or + to remove the control from the container so it is not disposed with container. + + + + + Occurs when popup item is about to open. + + + + + Occurs while popup item is closing. + + + + + Occurs while popup item is closing. + + + + + Occurs after popup item has been closed. + + + + + Occurs just before popup window is shown. + + + + + Gets the size of the popup before it is displayed. + + + + + Gets or sets whether popup on-screen position is verified and popup location adjusted so it does not cross boundaries of the screen. + + + + + Indicates whether sub-items are shown on popup Bar or popup menu. + + + + + Indicates the font that will be used on the popup window. + + + + + Indicates side bar for pop-up window. + + + + + Gets or sets the location of popup in relation to it's parent. + + + + + Gets or sets the popup offset. + + + + + Gets or sets the popup location. + + + + + Indicates when menu items are displayed when MenuVisiblity is set to VisibleIfRecentlyUsed and RecentlyUsed is true. + + + + + Indicates Animation type for Popups. + + + + + Specifies the inital width for the Bar that hosts pop-up items. Applies to PopupType.Toolbar only. + + + + + Gets the control that is displaying the context menu. + + + + + Gets the reference to the internal host PopupContainerControl control. + + + + + Provides support for personalized menu items. + + + + + Creates new instance of ButtonItem. + + + + + Creates new instance of ButtonItem and assigns the name to it. + + Item name. + + + + Creates new instance of ButtonItem and assigns the name and text to it. + + Item name. + item text. + + + + Returns copy of the item. + + + + + Copies the ButtonItem specific properties to new instance of the item. + + New ButtonItem instance. + + + + Copies the ButtonItem specific properties to new instance of the item. + + New ButtonItem instance. + + + + Overloaded. Serializes the item and all sub-items into the XmlElement. + + XmlElement to serialize the item to. + + + + Overloaded. Deserializes the Item from the XmlElement. + + Source XmlElement. + + + + Called when NotificationMarkText property has changed. + + Old property value + New property value + + + + Called when NotificationMarkPosition property has changed. + + Old property value + New property value + + + + Called when NotificationMarkSize property has changed. + + Old property value + New property value + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Called when NotificationMarkOffset property has changed. + + Old property value + New property value + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Called when Symbol property has changed. + + Old property value + New property value + + + + Called when SymbolSet property value changes. + + Indciates old value + Indicates new value + + + + Called when SymbolSize property has changed. + + Old property value + New property value + + + + Called when button image has changed. + + + + + Called when container of the item has changed. + + Previous item container. + + + + Overriden. Draws the item. + + Item paint arguments. + + + + Resets ImageFixedSize property to its default value. + + + + + Gets whether ImageFixedSize property should be serialized. + + + + + Gets whether FixedSize property should be serialized. + + + + + Resets the property to default value. + + + + + Overridden. Recalculates the size of the item. + + + + + Overloaded. Called when size of the item is changed externally. + + + + + Starts the button pulse effect which alternates slowly between the mouse over and the default state. The pulse effect + continues indefinitely until it is stopped by call to StopPulse method. + + + + + Starts the button pulse effect which alternates slowly between the mouse over and the default state. Pulse effect + will alternate between the pulse state for the number of times specified by the pulseBeatCount parameter. + + Specifies the number of times button alternates between pulse states. 0 indicates indefinite pulse + + + + Stops the button Pulse effect. + + + + + Indicates whether the item enabled property has changed. + + + + + Provides internal implementation for ButtonItem mouse down events. + + Mouse event arguments. + + + + Occurs when the item is double clicked. This is used by internal implementation only. + + + + + Returns the Font object to be used for drawing the item text. + + Font object. + + + + Called after Checked property has changed. + + + + + Called when Visibility of the items has changed. + + New Visible state. + + + + Sets Checked property without firing any events or performing any built-in logic. + + + + + Fires CheckedChanged event. + + + + + Fires OptionGroupChanging event. + + + + + Occurs just before Click event is fired. + + + + + Returns the shortcut string that is displayed on tooltip. + + + + + + Gets or sets the current font for the button. + + + + + Creates new ButtonItem with text set to corresponding item from string array and adds it to SubItems collection. + + + + + + Creates new ButtonItem with text set to corresponding item from string array and adds it to SubItems collection. + + Click event handler assigned to each item + + + + Occurs when Checked property has changed. + + + + + Occurs before an item in option group is checked and provides opportunity to cancel that. + + + + + Indicates whether images assigned to the button are disposed when button is disposed. Default value is false. + + + + + Specifies maximum of 2 character text displayed inside of the notification mark on top of the button. + + + + + Indicates the position of the notification marker within the bounds of the button. + + + + + Specifies diameter of notification mark. When set to 0 system default value is used. + + + + + Gets or sets background color of the notification mark. + + + + + Specifies the offset for the notification mark relative to its position. + + + + + Gets/Sets the image position inside the button. + + + + + Gets or sets the custom color name. Name specified here must be represented by the corresponding object with the same name that is part + of the Office2007ColorTable.RibbonTabItemColors collection. See documentation for Office2007ColorTable.RibbonTabItemColors for more information. + If color table with specified name cannot be found default color will be used. Valid settings for this property override any + setting to the Color property. + Applies to items with Office 2007 style only. + + + + + Gets or sets the predefined color of the button. Color specified applies to buttons with Office 2007 style only. It does not have + any effect on other styles. Default value is eButtonColor.Default + + + + + Gets/Sets the button style which controls the appearance of the button elements. Changing the property can display image only, text only or image and text on the button at all times. + + + + + Indicates whether the item will auto-expand when clicked. + When item is on top level bar and not on menu and contains sub-items, sub-items will be shown only if user + click the expand part of the button. Setting this property to true will expand the button and show sub-items when user + clicks anywhere inside of the button. Default value is false which indicates that button is expanded only + if its expand part is clicked. + + + + + Gets or sets the color of the Symbol. + + + + + Gets the realized symbol string. + + + + + Indicates the symbol displayed on face of the button instead of the image. Setting the symbol overrides the image setting. + + + + + Gets or sets the symbol set used to represent the Symbol. + + + + + Indicates the size of the symbol in points. + + + + + Specifies the Button icon. Icons support multiple image sizes and alpha blending. + + + + + Specifies the Button image which is used when button background is black or very dark. Image is used when button text is white. This is provided for Metro style applications. + + + + + Specifies the Button image. + + + + + Specifies the small Button image used by Ribbon control when small image variant is needed because of the automatic button resizing or + because the button is on the Quick Access Toolbar. + + + + + Gets or sets the image size that is used by the button when multiple ImageList controls are used as source for button image. + By default ImageList assigned to Images property of parent control is used. Using this property you can selection ImagesMedium or + ImagesLarge ImageList to be used as source for image for this button. + + + + + Gets or sets whether button uses the ImageSmall as source of the image displayed on the button if ImageSmall is set to valid image. Default value is false. + + + + + Specifies the index of the image for the button if ImageList is used. + + + + + Specifies the image for the button when mouse is over the item. + + + + + Specifies the index of the image for the button when mouse is over the item when ImageList is used. + + + + + Specifies the image for the button when mouse left button is pressed. + + + + + Specifies the index of the image for the button when mouse left button is pressed and ImageList is used. + + + + + Specifies the image for the button when items Enabled property is set to false. + + + + + Specifies the index of the image for the button when items Enabled property is set to false and ImageList is used. + + + + + Sets fixed size of the image. Image will be scaled and painted it size specified. + + + + + Gets or sets the fixed size of the button. Both width and height must be set to value greater than 0 in order for button to use fixed size. + Setting both width and height to 0 (default value) indicates that button will be sized based on content. + + + + + Gets whether fade effect is enabled. + + + + + Gets whether Pulse function is enabled. + + + + + Gets whether the button is currently pulsing, alternating slowly between the mouse over and default state. + + + + + Gets or sets whether pulse effect started with StartPulse method stops automatically when mouse moves over the button. Default value is true. + + + + + Gets or sets the pulse speed. The value must be greater than 0 and less than 128. Higher values indicate faster pulse. Default value is 12. + + + + + Gets or sets whether button auto-expands on mouse hover when button is used as menu-item and displayed on menu. Default value is true. + + + + + Indicates whether button should popup when clicked automatically. + + + + + Gets or sets whether Checked property is automatically inverted, button checked/unchecked, when button is clicked. Default value is false. + + + + + Gets or set a value indicating whether the button is in the checked state. + + + + + Gets or set the alternative shortcut text. + + + + + Returns shortcut text if any that needs to be displayed. + + + + + Gets or sets the image bounds. + + + + + Gets or sets sub items bounds. + + + + + Gets or sets text bounds. + + + + + Gets or set the Group item belongs to. The groups allows a user to choose from mutually exclusive options within the group. The choice is reflected by Checked property. + + + + + Gets or sets the text color of the button. + + + + + Gets or sets the text color of the button when mouse is over the item. + + + + + Gets or sets whether the font used to draw the item text is underlined when mouse is over the item. + + + + + Gets or sets whether the font used to draw the item text is bold when mouse is over the item. + + + + + Gets or sets whether the font used to draw the item text is bold. + + + + + Gets or sets whether the font used to draw the item text is italic. + + + + + Gets or sets whether the font used to draw the item text is underlined. + + + + + Gets or sets the width of the expand part of the button item. + + + + + Returns the collection of sub items. + + + + + Gets or sets whether button appears as split button. Split button appearance divides button into two parts. Image which raises the click event + when clicked and text and expand sign which shows button sub items on popup menu when clicked. Button must have both text and image visible (ButtonStyle property) in order to appear as a full split button. + Use AutoExpandOnClick=true if you want to make complete surface of the button display popup when clicked. + + + + + Gets or sets the text associated with this item. + + + + + Gets or sets the amount of padding added horizontally to the button images when not on menus. Default value is 10 pixels. + + + + + Gets or sets the amount of padding added vertically to the button images when not on menus. Default value is 6 pixels. + + + + + Gets or sets an shape descriptor for the button which describes the shape of the button. Default value is null + which indicates that system default shape is used. + + + + + Indicates item's visibility when on pop-up menu. + + + + + Indicates whether item was recently used. + + + + + Indicates whether mouse is over the item. + + + + + Indicates whether mouse is over the expand part of the button. + + + + + Indicates whether mouse is pressed. + + + + + Indicates the way item is painting the picture when mouse is over it. Setting the value to Color will render the image in gray-scale when mouse is not over the item. + + + + + Gets or sets whether the button text is automatically wrapped over multiple lines when button is used on RibbonBar control. Default value is true. + + + + + Gets or sets whether image animation is enabled + + + + + Gets whether item supports text markup. Default is false. + + + + + Gets or sets whether text-markup support is enabled for items Text property. Default value is true. + Set this property to false to display HTML or other markup in the item instead of it being parsed as text-markup. + + + + + Occurs when text markup link is clicked. Markup links can be created using "a" tag, for example: + Markup link + + + + + Represents accessible interface for ButtonItem object. + + + + + Represents accessible interface for ButtonItem object. + + + + + Delegate for OptionGroupChanging event. + + + + + Represents event arguments for OptionGroupChanging event. + + + + + Set to true to cancel the checking on NewChecked button. + + + + + Button that will become checked if operation is not canceled. + + + + + Button that is currently checked and which will be unchecked if operation is not canceled. + + + + + Default constructor. + + + + + Stores all information for side bar images that are used by Bar or Popup menu. + + + + + Gets or sets the side bar image. + + + + + Gets or sets the side bar back color. + + + + + Gets or sets the gradient staring color. + + + + + Gets or sets the gradient ending color. + + + + + Gets or sets the gradient angle. + + + + + Gets or sets the gradient staring color. + + + + + Gets or sets whether image is stretched so it fills the side bar or not if image is smaller than current side bar size. + + + + + Summary description for ButtonItemLayout. + + + + + Arranges the button inner parts when button size has changed externally. + + Button to arrange inner parts for. + + + + Called by StyleManager to notify control that style on manager has changed and that control should refresh its appearance if + its style is controlled by StyleManager. + + New active style. + + + + Creates new accessibility instance. + + Reference to AccessibleObject. + + + + Starts the button pulse effect which alternates slowly between the mouse over and the default state. The pulse effect + continues indefinitely until it is stopped by call to StopPulse method. + + + + + Starts the button pulse effect which alternates slowly between the mouse over and the default state. Pulse effect + will alternate between the pulse state for the number of times specified by the pulseBeatCount parameter. + + Specifies the number of times button alternates between pulse states. 0 indicates indefinite pulse + + + + Stops the button Pulse effect. + + + + + Gets whether ImageFixedSize property should be serialized. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Notifies a control that it is the default button so that its appearance and behavior is adjusted accordingly. + + true if the control should behave as a default button; otherwise false. + + + + Generates a Click event for the control. + + + + + Displays the sub-items on popup specified by PopupType. + + Popup location. + + + + Displays the sub-items on popup specified by PopupType. + + Horizontal coordinate in pixels of the upper left corner of a popup. + Vertical coordinate in pixels of the upper left corner of a popup. + + + + Called when Command property value changes. + + + + + Occurs when Checked property has changed. + + + + + Gets or sets whether text-markup support is enabled for controls Text property. Default value is true. + Set this property to false to display HTML or other markup in the control instead of it being parsed as text-markup. + + + + + Gets whether the button is currently pulsing, alternating slowly between the mouse over and default state. + + + + + Gets or sets whether pulse effect started with StartPulse method stops automatically when mouse moves over the button. Default value is true. + + + + + Gets or sets the pulse speed. The value must be greater than 0 and less than 128. Higher values indicate faster pulse. Default value is 12. + + + + + Sets fixed size of the image. Image will be scaled and painted it size specified. + + + + + Gets or sets the text alignment. Applies only when button text is not composed using text markup. Default value is center. + + + + + Gets or sets whether during painting OnPaintBackground on base control is called when BackColor=Transparent. + + + + + Gets or sets whether button is focused when pressed using left mouse button. Default value is true. + + + + + Gets whether command is executed when button is clicked. + + + + + Gets or sets the color of the Symbol. + + + + + Indicates the symbol displayed on face of the button instead of the image. Setting the symbol overrides the image setting. + + + + + Gets or sets the symbol set used to represent the Symbol. + + + + + Indicates the size of the symbol in points. + + + + + Specifies the Button image which is used when button background is black or very dark. Image is used when button text is white. This is provided for Metro style applications. + + + + + Specifies the Button image. + + + + + Specifies the image for the button when mouse is over the item. + + + + + Specifies the image for the button when items Enabled property is set to false. + + + + + Specifies the image for the button when mouse left button is pressed. + + + + + Gets or sets the location of popup in relation to it's parent. + + + + + Returns the collection of sub items. + + + + + Gets or sets whether button appears as split button. Split button appearance divides button into two parts. Image which raises the click event + when clicked and text and expand sign which shows button sub items on popup menu when clicked. Button must have both text and image visible (ButtonStyle property) in order to appear as a full split button. + + + + + Gets or sets whether button displays the expand part that indicates that button has popup. + + + + + Gets/Sets the image position inside the button. + + + + + Gets or sets whether mouse over fade effect is enabled. Default value is true. + + + + + Indicates the way button is rendering the mouse over state. Setting the value to Color will render the image in gray-scale when mouse is not over the item. + + + + + Gets or sets the width of the expand part of the button item. + + + + + Gets or sets the text associated with this button. + + + + + Gets/Sets informational text (tooltip) for the button. + + + + + Gets or sets whether mnemonic character assigned to button is processed only if Alt key is pressed. Default value is false which indicate that Alt key is not required. + + + + + + Indicates whether the button will auto-expand when clicked. + When button contains sub-items, sub-items will be shown only if user + click the expand part of the button. Setting this property to true will expand the button and show sub-items when user + clicks anywhere inside of the button. Default value is false which indicates that button is expanded only + if its expand part is clicked. + + + + + Gets or sets whether Checked property is automatically inverted, button checked/unchecked, when button is clicked. Default value is false. + + + + + Gets or set a value indicating whether the button is in the checked state. + + + + + Gets or sets an shape descriptor for the button which describes the shape of the button. Default value is null + which indicates that system default shape is used. + + + + + Gets or sets whether control displays focus cues when focused. + + + + + Gets or sets the custom color name. Name specified here must be represented by the corresponding object with the same name that is part + of the Office2007ColorTable.ButtonItemColors collection. See documentation for Office2007ColorTable.ButtonItemColors for more information. + If color table with specified name cannot be found default color will be used. Valid settings for this property override any + setting to the Color property. + Applies to items with Office 2007 style only. + + + + + Gets or sets the predefined color of the button. Color specified applies to buttons with Office 2007 style only. It does not have + any effect on other styles. Default value is eButtonColor.Default + + + + + Gets or sets a value indicating whether the control is automatically resized to display its entire contents. You can set MaximumSize.Width property to set the maximum width used by the control. + + + + + Gets or sets the mode by which the Button automatically resizes itself. + + + + + Gets or sets the amount of spacing between button image if specified and text. + + + + + Gets or sets the text color. + + + + + Gets or sets the value returned to the parent form when the button is clicked. + + + + + Gets or sets a value indicating whether the button is expanded (displays drop-down) or not. + + + + + Gets or sets the collection of shortcut keys associated with the button. When shortcut key is pressed button Click event is raised. + + + + + Gets or sets the command assigned to the item. Default value is null. + Note that if this property is set to null Enabled property will be set to false automatically to disable the item. + + + + + Gets or sets user defined data value that can be passed to the command when it is executed. + + + + + Represents class for Accessibility support. + + + + + Creates new instance of the object and initializes it with owner control. + + Reference to owner control. + + + + Returns number of child objects. + + Total number of child objects. + + + + Returns reference to child object given the index. + + 0 based index of child object. + Reference to child object. + + + + Returns current accessible state. + + + + + Summary description for ThemedButtonItemPainter. + + + + + Represents the Check-box item. Use a CheckBox to give the user an option, such as true/false or yes/no. + + + + + Creates new instance of CheckBoxItem. + + + + + Creates new instance of CheckBoxItem and assigns the name to it. + + Item name. + + + + Creates new instance of CheckBoxItem and assigns the name and text to it. + + Item name. + item text. + + + + Returns copy of the item. + + + + + Copies the CheckBoxItem specific properties to new instance of the item. + + New CheckBoxItem instance. + + + + Copies the CheckBoxItem specific properties to new instance of the item. + + New CheckBoxItem instance. + + + + Raises the click event and provide the information about the source of the event. + + + + + + Sets the Checked property of the item, raises appropriate events and provides the information about the source of the change. + + New value for Checked property + Source of the change. + + + + Called when Command property value changes. + + + + + Sets the Checked property of the item, raises appropriate events and provides the information about the source of the change. + + New value for Checked property + Source of the change. + + + + Raises CheckState changed event. + + Event arguments. + + + + Raises CheckedBindableChanged changed event. + + Event arguments. + + + + Called after Checked property has changed. + + + + + Raises the CheckedChanging event. + + + + + Raises the CheckedChanged event. + + + + + Occurs before Checked property is changed and allows you to cancel the change. + + + + + Occurs after Checked property is changed. Action cannot be cancelled. + + + + + Occurs when CheckState property has changed. + + + + + Occurs when CheckedBindable property has changed. + + + + + Gets or set whether the Checked values and the item appearance are automatically changed when the Check-Box is clicked. Default value is true. + + + + + Gets or sets the size of the check or radio sign. Default value is 13x13. Minimum value is 6x6. + + + + + Gets or sets the text associated with this item. + + + + + Gets whether item supports text markup. Default is false. + + + + + Gets or sets whether text-markup support is enabled for items Text property. Default value is true. + Set this property to false to display HTML or other markup in the item instead of it being parsed as text-markup. + + + + + Gets or sets whether text assigned to the check box is visible. Default value is true. + + + + + Gets or sets the text color. Default value is Color.Empty which indicates that default color is used. + + + + + Gets or sets the appearance style of the item. Default value is CheckBox. Item can also assume the style of radio-button. + + + + + Gets or sets the check box position relative to the text. Default value is Left. + + + + + Gets whether mouse is over the item. + + + + + Gets whether left mouse button is pressed on the item. + + + + + Gets or set a value indicating whether the button is in the checked state. + + + + + Gets or set a value indicating whether the button is in the checked state. + + + + + Gets or sets a value indicating whether the CheckBox will allow three check states rather than two. If the ThreeState property is set to true + CheckState property should be used instead of Checked property to set the extended state of the control. + + + + + Specifies the state of a control, such as a check box, that can be checked, unchecked, or set to an indeterminate state. + + + + + Gets or sets the custom image that is displayed instead default check box representation when check box is checked. + + + + + Gets or sets the custom image that is displayed instead default check box representation when check box is unchecked. + + + + + Gets or sets the custom image that is displayed instead default check box representation when check box is in indeterminate state. + + + + + Delegate for OptionGroupChanging event. + + + + + Represents event arguments for OptionGroupChanging event. + + + + + Set to true to cancel the checking on NewChecked button. + + + + + Check-box that will become checked if operation is not cancelled. + + + + + Check-box that is currently checked and which will be unchecked if operation is not cancelled. This property will have only valid values for eCheckBoxStyle.RadioButton style CheckBoxItems. + + + + + Indicates the action that has caused the event. + + + + + Default constructor. + + + + + Represents painter for CheckBoxItem. + + + + + Paints CheckBoxItem. + + Provides arguments for the operation. + + + + Gets or sets color table used by renderer. + + + + + Represents circular progress indicator. + + + + + Creates new instance of circular progress indicator. + + + + + Creates new instance of circular progress indicator and assigns the name to it. + + Item name. + + + + Creates new instance of circular progress indicator and assigns the name and text to it. + + Item name. + item text. + + + + Returns copy of the item. + + + + + Copies the ProgressBarItem specific properties to new instance of the item. + + New ProgressBarItem instance. + + + + Copies the ProgressBarItem specific properties to new instance of the item. + + New ProgressBarItem instance. + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Raises ValueChanged event. + + Provides event arguments. + + + + Called when property on CircularProgressBar changes. + + Property Change Arguments + + + + Starts the progress bar loop for endless type progress bar. Progress bar will continue to run until Stop() method is called. + + + + + Stops the progress bar loop for endless type progress bar. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Called when ProgressTextFormat property has changed. + + Old property value + New property value + + + + Gets or sets the circular progress bar type. + + + + + Gets or sets the maximum value of the progress bar. + + + + + Gets or sets the minimum value of the progress bar. + + + + + Gets or sets the color of the progress percentage text. + + + + + Gets or sets whether text that displays the progress bar completion percentage text is visible. Default value is false. + + + + + Gets or sets the text displayed on top of the circular progress bar. + + + + + Gets or sets the current value of the progress bar. + + + + + Occurs when Value property has changed. + + + + + Gets or sets whether endless type progress bar is running. + + + + + Gets or sets the color of the color of progress indicator. + + + + + Gets or sets circular progress indicator diameter in pixels. + + + + + Gets or sets the text position in relation to the circular progress indicator. + + + + + Gets or sets whether text/label displayed next to the item is visible. + + + + + Gets or sets the suggested text-width. If you want to make sure that text you set wraps over multiple lines you can set suggested text-width so word break is performed. + + + + + Gets or sets text padding. + + + + + Gets or sets the color of the text label. + + + + + Gets or sets the color of the pie progress bar dark border. + + + + + Gets or sets the color of the pie progress bar light border. + + + + + Gets or sets the color of the spoke progress bar dark border. + + + + + Gets or sets the color of the spoke progress bar light border. + + + + + Gets or sets format string for progress value. + + + + + Gets or sets the animation speed for endless running progress. Lower number means faster running. + + + + + Defines available circular progress bar types. + + + + + Line spokes progress bar. + + + + + Dot type/FireFox progress bar. + + + + + Donut type progress bar. + + + + + Spoke type progress bar. + + + + + Pie type progress bar. + + + + + Summary description for ColorFunctions. + + + + + Provides popup color picker. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Gets or sets the reference to the IWindowsFormsEditorService interface used for Windows Forms design time support. + + + + + Gets or sets the ColorScheme object for Scheme colors. + + + + + Gets or sets currently selected color. + + + + + Gets the selected color color scheme name if color scheme color is selected otherwise it returns an empty string. + + + + + Returns true if color selection was cancelled. + + + + + Represents the color comb control that allows color choice from pre-defined color comb palette. + + + + + Raises SelectedColorChanged event. + + Provides event arguments. + + + + Required designer variable. + + + + + Creates new instance of the control. + + + + + Clean up any resources being used. + + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Raises MouseOverColorChanged event. + + Provides event arguments. + + + + Occurs when SelectedColor has changed. + + + + + Gets or sets whether anti-alias smoothing is used while painting. Default value is true. + + + + + Gets the color mouse is currently over. If mouse is not over any color in comb Color.Empty is returned. + + + + + Gets or sets the selected color. When setting the color note that color must be already present in the color comb otherwise the selected color will be reset to Color.Empty. + + + + + Occurs when MouseOverColor property has changed. + + + + + Represents the color selection control. + + + + + Raises SelectedColorChanged event. + + Provides event arguments. + + + + Required designer variable. + + + + + Clean up any resources being used. + + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Occurs when SelectedColor has changed. + + + + + Gets or sets the selected color. + + + + + Represents color item used for color picker control. Color item can only be used as part of the color picker DotNetBar feature. + + + + + Overloaded. Serializes the item and all sub-items into the XmlElement. + + XmlElement to serialize the item to. + + + + + Gets or sets the color represented by this item. Default value is Color.Black. + + + + + Gets or sets the size of the item when displayed. Default value is 13x13 pixels. + + + + + Gets or sets border drawn around the item. Default value is eColorItemBorder.All which indicates that border is drawn + on all four sides. + + + + + Gets whether mouse is over the item. + + + + + Represents the color picker drop down button. + + + + + Creates new instance of ButtonItem. + + + + + Creates new instance of ButtonItem and assigns the name to it. + + Item name. + + + + Creates new instance of ButtonItem and assigns the name and text to it. + + Item name. + item text. + + + + Returns copy of the item. + + + + + Copies the ButtonItem specific properties to new instance of the item. + + New ButtonItem instance. + + + + Raises the ColorPreview event. + + Provides the data for the event. + + + + Invokes the ColorPreview event. + + Provides data for the event. + + + + Indicates whether SubItems collection is serialized. ColorPickerDropDown does not serialize the sub items. + + + + + Gets whether property should be serialized. + + + + + Resets the property to its default value. + + + + + Raises RemovingToken event. + + Provides event arguments. + + + + Displays the Colors dialog that allows user to choose the color or create a custom color. If new color is chosen the + SelectedColorChanged event is raised. + + + + + Raises the BeforeColorDialog event. + + + + + + Update the selected color image if the SelectedColorImageRectangle has been set and button is using Image property to display the image. + + + + + Gets collection of ColorItem[] arrays that represent themed colors. Each ColorItem[] array is used to represent single line of theme colors. + + Collection of ColorItem[] arrays. + + + + Returns an array that represents the standard colors. Usually instances of ColorItem are included. + + ArrayList containing objects that describe standard colors. + + + + Invokes SelectedColorChanged event. + + + + + Occurs when color is chosen from drop-down color picker or from Custom Colors dialog box. Selected color can be accessed through SelectedColor property. + + + + + Occurs when mouse is moving over the colors presented by the color picker. You can use it to preview the color before it is selected. + + + + + Occurs before color picker dialog is shown. Data property of the event arguments will hold the reference to the Form about to be shown. + + + + + Gets or sets the last selected color from either the drop-down or Custom Color dialog box. Default value is + Color.Empty. You can use SelectedColorChanged event to be notified when this property changes. + + + + + Gets or sets whether theme colors are displayed on drop-down. Default value is true. + + + + + Gets or sets whether standard colors are displayed on drop-down. Default value is true. + + + + + Gets or sets more colors menu item is visible which allows user to open Custom Colors dialog box. Default value is true. + + + + + Gets or sets the rectangle in Image coordinates where selected color will be painted. Setting this property will + have an effect only if Image property is used to set the image. Default value is an empty rectangle which indicates + that selected color will not be painted on the image. + + + + + Gets whether internal representation of color items on popup has been initialized. + + + + + "Occurs after popup colors have been added to the SubItems collection. This event can be used to effectively add custom items to the popup. + + + + + Gets or sets the Owner Window that will be used as owner for the colors modal dialog when displayed. + + + + + Gets or sets the array of ColorItem objects that will be used as theme colors instead of built-in color palette. + See: http://www.devcomponents.com/kb2/?p=79 for instructions. + + + + + Gets or sets the array of ColorItem objects that will be used as standard colors instead of built-in color palette. + See: http://www.devcomponents.com/kb2/?p=79 for instructions. + + + + + Indicates whether button should popup when clicked automatically. + + + + + Represents custom color blend selection control. + + + + + Raises SelectedColorChanged event. + + Provides event arguments. + + + + Occurs when SelectedColor has changed. + + + + + Gets or sets the color selected by the control. Color that is assigned must be visible on the face of the control otherwise the SelectedColor will be set to Color.Empty + + + + + Represents the form in Office style with custom borders and caption. + + + + + Represents the form class that should be used instead of standard Form when form caption is provided by Ribbon control + and custom form look and feel in style of Office 2007 is required. This form does not have standard form caption. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Called by StyleManager to notify control that style on manager has changed and that control should refresh its appearance if + its style is controlled by StyleManager. + + New active style. + + + + Called when EnableCustomStyle property has changed. + + + + + Gets whether custom form styling is enabled. + + true if custom styling is enabled otherwise false. + + + + Gets the array of LinearGradientColorTable objects that describe the border colors. The colors with index 0 is used as the outer most + border. + + Array of LinearGradientColorTable + + + + Returns form custom region. + + New instance of the custom region. + + + + Gets the form path for the given input bounds. + + Represent the form bounds. + + + + + Paints the non-client area of the form. + + + + + Called when WM_NCACTIVATE message is received. + + Reference to message data. + Return true to call base form implementation otherwise return false. + + + + Invalidates non client area of the form. + + Indicates whether complete form is invalidated. + + + + Redraws the non-client area of the form. + + + + + Called when BackgroundImageUnderCaption property has changed. + + Old property value + New property value + + + + Called when RenderFormIcon property has changed. + + Old property value + New property value + + + + Called when RenderFormText property has changed. + + Old property value + New property value + + + + Gets or sets whether Windows Vista Glass support is enabled when form is running on Windows Vista with Glass support. + Default value is true. + + + + + Gets or sets the RibbonControl that is hosted by this form. This property is for internal use only. + + + + + Gets whether Vista glass effect extension over the ribbon control caption is enabled. + + + + + Gets or sets the form's window state. + + + + + Gets or sets whether custom style for the form is enabled. Default value is true. + + + + + Gets or sets top left rounded corner size. Default value is 6. + + + + + Gets or sets top right rounded corner size. Default value is 6. + + + + + + Gets or sets bottom left rounded corner size. Default value is 6. + + + + + Gets or sets bottom right rounded corner size. Default value is 6. + + + + + Gets whether client border is painted in OnPaint method. + + + + + Gets whether ribbon control caption is painted + + + + + Gets or sets whether 3D MDI border is removed. Default value is true. + + + + + Gets whether form uses custom region + + + + + Gets whether Windows Glass effect is rendered on the form when supported by Operating System and enabled using EnableGlass. + + + + + Returns whether form is sizable given form state (maximized, minimized, normal) and FormBorderStyle setting. + + + + + Gets or sets whether non-client area of the form rendering is enabled. + + + + + Indicates whether form BackgroundImage is pulled up and rendered under form caption as well. + + + + + Indicates whether form icon is drawn. This is different from ShowIcon property which when set to false also removes the form icon from task-bar. Setting this property to false will keep form icon in task-bar but will hide on the form. + + + + + Indicates whether form Text is rendered in form caption. + + + + + Called by StyleManager to notify control that style on manager has changed and that control should refresh its appearance if + its style is controlled by StyleManager. + + New active style. + + + + Raises TitleTextMarkupLinkClick event. + + Provides event arguments. + + + + Gets whether custom form styling is enabled. + + true if custom styling is enabled otherwise false. + + + + Invalidates non client area of the form. + + Indicates whether complete form is invalidated. + + + + Called when WM_NCACTIVATE message is received. + + Reference to message data. + Return true to call base form implementation otherwise return false. + + + + Gets the form path for the give input bounds. + + Represents the form bounds. + + + + + Updates the form title bar text. Usually calling this method is not necessary but under certain conditions when form is used as MDI parent form + calling it to update combined text is necessary. + + + + + Called when CloseEnabled property value has changed. + + + + + Paints the non-client area of the form. + + + + + Returns the renderer control will be rendered with. + + The current renderer. + + + + + Occurs when text-markup link in TitleText is clicked. + + + + + Gets or sets the font for the form caption text when CaptionVisible=true. Default value is NULL which means that system font is used. + + + + + Gets whether Vista glass effect extension over the ribbon control caption is enabled. + + + + + Gets or sets the icon for the form. + + + + + Gets or sets a value indicating whether the form enables auto scrolling. + + + + + Gets or sets the Office 2007 Renderer global Color Table. Setting this property will affect all controls in application that are using Office 2007 global renderer. + + + + + Gets whether client border is painted in OnPaint method. + + + + + Gets whether ribbon control caption is painted + + + + + Gets or sets whether anti-alias smoothing is used while painting form caption. Default value is true. + + + + + Gets or sets the redering mode used by control. Default value is eRenderMode.Global which means that static GlobalManager.Renderer is used. If set to Custom then Renderer property must + also be set to the custom renderer that will be used. + + + + + Gets or sets the custom renderer used by the items on this control. RenderMode property must also be set to eRenderMode.Custom in order renderer + specified here to be used. + + + + + Gets or sets the tooltip for the form system icon. + + + + + Clean up any resources being used. + + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Initializes a new instance of the MetroForm class. + + + + + Gets the array of LinearGradientColorTable objects that describe the border colors. The colors with index 0 is used as the outer most + border. + + Array of LinearGradientColorTable + + + + Called by StyleManager to notify control that style on manager has changed and that control should refresh its appearance if + its style is controlled by StyleManager. + + New active style. + + + + Gets the form path for the given input bounds. + + Represent the form bounds. + + + + + Called when HelpButtonText property has changed. + + Old property value + New property value + + + + Called when SettingsButtonText property has changed. + + Old property value + New property value + + + + Raises SettingsButtonClick event. + + Provides event arguments. + + + + Raises HelpButtonClick event. + + Provides event arguments. + + + + Gets or sets custom border colors for the form. When set it overrides settings from global Metro color table. + + + + + This property is not applicable for MetroForm. + + + + + + + Gets or sets the HELP button text. + + + + + Gets or sets the SETTINGS button text. + + + + + Occurs when SETTINGS button, if displayed, is clicked. + + + + + Occurs when HELP button, if displayed, is clicked. + + + + + Clean up any resources being used. + + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Represents the Color scheme used by items on the Bar. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + VS.NET 2005 Blue Color Scheme + + + + + Converts hex string to Color type. + + Hexadecimal color representation. + Reference to Color object. + + + + Converts hex string to Color type. + + Color representation as 32-bit RGB value. + Reference to Color object. + + + + Converts hex string to Color type. + + Color representation as 32-bit RGB value. + Reference to Color object. + + + + Specifies Dock Site BackColor. + + + + + Specifies Dock Site BackColor2. + + + + + Specifies the gradient angle. + + + + + Specifies the menu bar background color. + + + + + Specifies the target menu bar gradient background color. + + + + + Specifies the gradient angle. + + + + + Specifies the background color for the bar when floating or when docked. + + + + + Specifies the target gradient background color for the bar when floating or when docked. + + + + + Specifies the gradient angle. + + + + + Specifies the background color for the bar Caption. + + + + + Specifies the target gradient background color for the bar Caption. + + + + + Specifies the gradient angle. + + + + + Specifies the color for text of the Caption. + + + + + Specifies the Bar Caption inactive (lost focus) background color. + + + + + Specifies the target background gradient Bar Caption inactive (lost focus) color. + + + + + Specifies the gradient angle. + + + + + Specifies the Bar inactive (lost focus) text color. + + + + + Specifies the background color for popup bars. + + + + + Specifies the border color for popup bars. + + + + + Specifies the border color for docked bars. + + + + + Specifies the color of the grab handle stripes. + + + + + Specifies the border color for floating bars. + + + + + Specifies the item background color. + + + + + Specifies the target item background gradient color. + + + + + Specifies the gradient angle. + + + + + Specifies the item text color. + + + + + Specifies the background color for the item that is disabled. + + + + + Specifies the text color for the item that is disabled. + + + + + Specifies the background color when mouse is over the item. + + + + + Specifies the target gradient background color when mouse is over the item. + + + + + Specifies the gradient angle. + + + + + Specifies the text color when mouse is over the item. + + + + + Specifies the border color when mouse is over the item. + + + + + Specifies the background color when item is pressed. + + + + + Specifies the target gradient background color when item is pressed. + + + + + Specifies the gradient angle. + + + + + Specifies the text color when item is pressed. + + + + + Specifies the border color when item is pressed. + + + + + Specifies the color for the item group separator. + + + + + Specifies the color for the item group separator shade. + + + + + Specifies the background color for the shadow of expanded item. + + + + + Specifies the background color for the expanded item. + + + + + Specifies the target gradient background color for the expanded item. + + + + + Specifies the gradient angle. + + + + + Specifies the text color for the expanded item. + + + + + Specifies the border color for the expanded item. + + + + + Specifies the background color for the checked item. + + + + + Specifies the target gradient background color for the checked item. + + + + + Specifies the gradient angle. + + + + + Specifies the border color for the checked item. + + + + + Specifies the text color for the checked item. + + + + + Specifies the customize item background color. Applies to Office2003 style only. + + + + + Specifies the customize item target gradient background color. Applies to Office2003 style only. + + + + + Specifies the customize item background color gradient angle. Applies to Office2003 style only. + + + + + Specifies the customize item text color. Applies to Office2003 style only. + + + + + Specifies the color of the menu border. + + + + + Specifies the background color of the menu. + + + + + Specifies the target gradient background color of the menu. + + + + + Specifies the angle of the gradient fill for the menu background. + + + + + Specifies the background color of the menu part (left side) that is showing the images. + + + + + Specifies the target gradient background color of the menu part (left side) that is showing the images. + + + + + Specifies the angle of the gradient fill for the menu part (left side) that is showing the images. + + + + + Specifies the background color for the items that were not recently used. + + + + + Specifies the side bar color for the items that were not recently used. + + + + + Specifies the target gradient side bar color for the items that were not recently used. + + + + + Specifies the angle of the gradient fill for the menu part (left side) that is showing the images. + + + + + Specifies the border color for focused design-time item. + + + + + Gets or sets predefined color scheme. By default DotNetBar will automatically change and generate color scheme depending on system colors. + + + + + Specifies the background color of the panel. + + + + + Specifies the target background gradient color of the panel. + + + + + Specifies the angle of the gradient fill for the panel background. + + + + + Specifies border color of the panel. + + + + + Specifies color of the text on the panel. + + + + + Specifies the background color of the explorer bar. + + + + + Specifies the target gradient background color of the explorer bar. + + + + + Specifies the angle of the gradient fill for the explorer bar background. + + + + + Specifies the foreground color of MDI System Item buttons. + + + + + Specifies the background color of the Splitter. + + + + + Specifies the target background gradient color of the Splitter. + + + + + Specifies the angle of the gradient fill for the Splitter background. + + + + + Specifies border color of the Splitter. + + + + + Specifies color of the text on the Splitter. + + + + + Indicates auto-hide panel background image if any. + + + + + Gets or sets the color of the auto-hide panel background. + + + + + Gets or sets the color of the auto-hide panel background. + + + + + Gets or sets the color of the auto-hide tab. + + + + + Gets or sets the color of the auto-hide tab. + + + + + Gets or sets the auto-hide tab background gradient angle. + + + + + Gets or sets the color of the auto-hide tab text. + + + + + Gets or sets the color of the auto-hide tab border. + + + + + Gets or sets the color of the auto-hide tab. + + + + + Gets or sets the color of the auto-hide tab. + + + + + Gets or sets the color of the auto-hide tab text. + + + + + Gets or sets the color of the tab border. + + + + + Specifies the type of predefined color scheme in ColorScheme object. + + + + + Default value. DotNetBar will automatically change and generate color scheme depending on system colors. + + + + + Blue Office 2003 Color Scheme. This setting specifies that this color scheme will be used regardless of system color setting on user machine. + + + + + Olive Green Office 2003 Color Scheme. This setting specifies that this color scheme will be used regardless of system color setting on user machine. + + + + + Silver Office 2003 Color Scheme. This setting specifies that this color scheme will be used regardless of system color setting on user machine. + + + + + Always use system colors to auto-generate color scheme. + + + + + Specifies a color scheme member. + + + + + Summary description for ColorSchemeEditor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Summary description for ColorSchemeVSEditor. + + + + + Represents Color type editor with support for color schemes. + + + + + Edits the value of the specified object using the editor style indicated by GetEditStyle. + + An ITypeDescriptorContext that can be used to gain additional context information. + An IServiceProvider that this editor can use to obtain services. + The object to edit. + The new value of the object. + + + + Gets the editor style used by the EditValue method. + + An ITypeDescriptorContext that can be used to gain additional context information. + A UITypeEditorEditStyle value that indicates the style of editor used by EditValue. If the UITypeEditor does not support this method, then GetEditStyle will return None. + + + + + Provides command related utility methods that register and unregister commands. + + + + + Connects the Command Source to the Command. + + Command source to connect to the command. + Reference to the command. + + + + Disconnects command source from the command. + + Reference to command source. + Reference to the command. + + + + Unregister command from all subscribers. Called when command is disposed. + + Command to unregister. + + + + Gets an array of Command Sources that are connected with the command. + + Reference to command + An array of command sources. + + + + Gets or sets whether commands use Reflection to find the property names when applying value to the unknown types. Default value is true. + Setting this value to false will increase performance if Unknown types are used but it will at same time disable the + command setting value for these types. + + + + + Gets or sets whether layout on the items of type BaseItem is automatically updated when command text or other property changes which requires layout updated. Default value is true. + + + + + Represents the bound data navigator in current DotNetBar style. + + + + + Creates new instance of BindingNavigatorEx + + + + + Creates new instance of BindingNavigatorEx + + + + + Creates new instance of BindingNavigatorEx + + + + + Creates new instance of BindingNavigatorEx + + + + + Adds default items that make up the binding navigation control. + + + + + Gets or sets the reference to Add New record button. + + + + + Gets or sets the binding source for the navigator. + + + + + Gets or sets the label which represents the items count. + + + + + Indicates the format string for the label which displays the number of items bound. + + + + + Gets or sets the item which deletes current record. + + + + + Gets or sets the item which moves to first record. + + + + + Gets or sets the item which moves to last record. + + + + + Gets or sets the item which moves to next record. + + + + + Gets or sets the item which moves to previous record. + + + + + Gets or sets the text-box which shows current position. + + + + + Represents the class for the BaseItem non-popup based control host. + + + + + Creates new instance of the object. + + + + + Returns the color scheme used by control. Color scheme for Office2007 style will be retrieved from the current renderer instead of + local color scheme referenced by ColorScheme property. + + An instance of ColorScheme object. + + + + Paints the control focus cues. + + Paint event information. + + + + Creates the Graphics object for the control. + + The Graphics object for the control. + + + + Returns the renderer control will be rendered with. + + The current renderer. + + + + Resets style to default value. Used by windows forms designer. + + + + + Called when visual property of the control has changed so the control can be updated. + + + + + Forces the button to perform internal layout. + + + + + Recalculates the size of the internal item. + + + + + Indicates to control that all further update operations should not result in layout and refresh of control content. + Use this method to optimize the addition of new items to the control. This method supports nested calls meaning + that multiple calls are allowed but they must be ended with appropriate number of EndUpdate calls. + IsUpdateSuspended property returns whether update is suspended. + + + + + Indicates that update operation is complete and that control should perform layout and refresh to show changes. See BeginUpdate + for more details. + + + + + Indicates that update operation is complete and that control should perform layout and refresh to show changes. See BeginUpdate + for more details. + + + + + Gets or sets the instance of BaseItem object hosted by this control. + + + + + Gets or sets whether during painting OnPaintBackground on base control is called when BackColor=Transparent. + + + + + Gets or sets whether control displays focus cues when focused. + + + + + Gets or sets the redering mode used by control. Default value is eRenderMode.Global which means that static GlobalManager.Renderer is used. If set to Custom then Renderer property must + also be set to the custom renderer that will be used. + + + + + Gets or sets the custom renderer used by the items on this control. RenderMode property must also be set to eRenderMode.Custom in order renderer + specified here to be used. + + + + + Specifies the background style of the control. + + + + + Gets or sets Bar Color Scheme. + + + + + Gets or sets whether anti-alias smoothing is used while painting. Default value is false. + + + + + Gets/Sets the visual style for the control. + + + + + Gets whether control layout is suspended becouse of the call to BeginUpdate method. + + + + + Initializes a new instance of the CircularProgress class. + + + + + Raises ValueChanged event. + + Provides event arguments. + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Occurs when Value property has changed. + + + + + Gets or sets the circular progress bar type. + + + + + Gets or sets the maximum value of the progress bar. + + + + + Gets or sets the minimum value of the progress bar. + + + + + Gets or sets the color of the progress percentage text. + + + + + Gets or sets whether text that displays the progress bar completion percentage text is visible. Default value is false. + + + + + Gets or sets the text displayed on top of the circular progress bar. + + + + + Gets or sets the current value of the progress bar. + + + + + Gets or sets whether endless type progress bar is running. + + + + + Gets or sets the color of the color of progress indicator. + + + + + Gets or sets the color of the pie progress bar dark border. + + + + + Gets or sets the color of the pie progress bar light border. + + + + + Gets or sets the color of the spoke progress bar dark border. + + + + + Gets or sets the color of the spoke progress bar light border. + + + + + Gets or sets format string for progress value. + + + + + Gets or sets the animation speed for endless running progress. Lower number means faster running. + + + + + Initializes a new instance of the CollapsibleSplitContainer class. + + + + + Raises BeforeNearCollapseButtonClick event. + + Provides event arguments. + + + + Raises NearCollapseButtonClick event. + + Provides event arguments. + + + + Raises BeforeFarCollapseButtonClick event. + + Provides event arguments. + + + + Raises FarCollapseButtonClick event. + + Provides event arguments. + + + + Called when ButtonPosition property has changed. + + Old property value + New property value + + + + Called when CollapseMode property has changed. + + Old property value + New property value + + + + + Occurs after near collapse button is clicked. + + + + + Occurs before far collapse button is clicked and allows you to cancel its action. + + + + + Occurs after far collapse button is clicked. + + + + + Indicates position of buttons inside container. + + + + + Specifies how panels are collapsed when collapse buttons are pressed. + + + + + Defines available positions for buttons inside CollapsibleSplitterContainer. + + + + + Buttons are positioned on left or top side depending on orientation. + + + + + Buttons are positioned in center of container. + + + + + Buttons are positioned on right or bottom side depending on orientation. + + + + + Defines collapse mode for the CollapsibleSplitContainer control. + + + + + When buttons are pressed the splitter is positioned at the PanelMinSize. + + + + + When buttons are pressed associated panel is collapsed through Panel1Collapsed or Panel2Collapsed properties. + + + + + Represents the color picker button control. + + + + + Creates new instance of the object. + + + + + Displays the Colors dialog that allows user to choose the color or create a custom color. If new color is chosen the + SelectedColorChanged event is raised. + + + + + Raises the ColorPreview event. + + Provides event data. + + + + Raises the SelectedColorChanged event. + + Provides event data. + + + + Indicates whether SubItems collection is serialized. ColorPickerDropDown does not serialize the sub items. + + + + + Gets whether property should be serialized. + + + + + Resets the property to its default value. + + + + + Invokes the ColorPreview event. + + Provides data for the event. + + + + Update the selected color image if the SelectedColorImageRectangle has been set and button is using Image property to display the image. + + + + + Occurs when color is chosen from drop-down color picker or from Custom Colors dialog box. Selected color can be accessed through SelectedColor property. + + + + + Occurs when mouse is moving over the colors presented by the color picker. You can use it to preview the color before it is selected. + + + + + Gets or sets the array of ColorItem objects that will be used as standard colors instead of built-in color palette. + See: http://www.devcomponents.com/kb2/?p=79 for instructions. + + + + + Gets or sets the array of ColorItem objects that will be used as theme colors instead of built-in color palette. + See: http://www.devcomponents.com/kb2/?p=79 for instructions. + + + + + Gets whether command is executed when button is clicked. + + + + + Gets or sets the Owner Window that will be used as owner for the colors modal dialog when displayed. + + + + + Gets or sets more colors menu item is visible which allows user to open Custom Colors dialog box. Default value is true. + + + + + Gets or sets the last selected color from either the drop-down or Custom Color dialog box. Default value is + Color.Empty. You can use SelectedColorChanged event to be notified when this property changes. + + + + + Gets or sets whether theme colors are displayed on drop-down. Default value is true. + + + + + Gets or sets whether standard colors are displayed on drop-down. Default value is true. + + + + + Gets or sets the rectangle in Image coordinates where selected color will be painted. Setting this property will + have an effect only if Image property is used to set the image. Default value is an empty rectangle which indicates + that selected color will not be painted on the image. + + + + + Represents enhanced Windows combo box control. + + + + + Creates new instance of ComboBoxEx. + + + + + Called by StyleManager to notify control that style on manager has changed and that control should refresh its appearance if + its style is controlled by StyleManager. + + New active style. + + + + Indicates whether property should be serialized by Windows Forms designer. + + + + + Resets the property to default value. + + + + + Clean up any resources being used. + + + + + Loads all fonts available on system into the combo box. + + + + + Releases the focus from combo box. The control that last had focus will receive focus back when this method is called. + + + + + Called when DropDownColumns property has changed. + + Old property value + New property value + + + + Called when DropDownColumnsHeaders property has changed. + + Old property value + New property value + + + + Raises BeforeMultiColumnPopupOpen event. + + Provides event arguments. + + + + Raises the DataColumnCreated event. + + Provides event arguments. + + + + Raises SelectionChanging event. + + Provides event arguments. + + + + Called when MultiColumnControlFont property has changed. + + Old property value + New property value + + + + Called when Command property value changes. + + + + + Occurs when drop down portion of combo box is shown or hidden. + + + + + Gets or sets whether control displays focus cues when focused. + + + + + Gets or sets whether control is stand-alone control. Stand-alone flag affects the appearance of the control in Office 2007 style. + + + + + Gets or sets whether watermark text is displayed when control is empty. Default value is true. + + + + + Gets or sets the watermark (tip) text displayed inside of the control when Text is not set and control does not have input focus. This property supports text-markup. + Note that WatermarkText is not compatible with the auto-complete feature of .NET Framework 2.0. + + + + + Gets or sets the watermark hiding behaviour. Default value indicates that watermark is hidden when control receives input focus. + + + + + Gets or sets the watermark font. + + + + + Gets or sets the watermark text color. + + + + + Gets or sets the combo box background color. Note that in Office 2007 style back color of the control is automatically managed. + + + + + Gets or sets whether the BackColor value you set is used instead of the style back color automatically provided by the control. Default + value is false which indicates that BackColor property is automatically managed. Set this property to true and then set BackColor property + to make control use your custom back color. + + + + + Gets or sets value indicating whether system combo box appearance is used. Default value is false. + + + + + Gets or sets value indicating whether the combo box is draw using the Windows XP Theme manager when running on Windows XP or theme aware OS. + + + + + Disables internal drawing support for the List-box portion of Combo-box. Default value is false which means that internal drawing code is used. If + you plan to provide your own drawing for combo box items you must set this property to True. + + + + + Gets or sets whether combo box generates the audible alert when Enter key is pressed. + + + + + The ImageList control used by Combo box to draw images. + + + + + Determines the visual style applied to the combo box when shown. Default style is Office 2007. + + + + + Gets or sets whether ComboBoxEx thumb button that displays drop-down is rendered. Default value is true. + + + + + Gets or sets whether ComboBoxEx border is rendered. Default value is true. + + + + + Indicates whether ItemHeight property is set automatically based on the current font when DrawMode=OwnerDrawFixed + + + + + Gets or sets the custom color table used to render combo-box items + + + + + Gets or sets the text color for the text in combo-box when control Enabled property is set to false. + Setting this property is effective only for DropDownList ComboBox style. + + + + + Gets or sets the control background color when control is disabled. Default value is an empty color which indicates that system background color is used when control is disabled. + + + + + Gets the window handle that the drop down list is bound to. + + + + + Gets or sets whether FocusHighlightColor is used as background color to highlight text box when it has input focus. Default value is false. + + + + + Gets or sets the color used as background color to highlight text box when it has input focus and focus highlight is enabled. + + + + + Gets or sets comma separated list of field names that are displayed on drop down. When set it activates ComboBoxEx multi-column drop-down mode. + DataSource must be set in order for drop-down to display data. + + + + + Indicates custom column names with each column separated by new line, i.e. \r\n escape sequence. + + + + + Occurs before the multi-column popup is opened and it allows canceling of popup by setting CancelEventArgs.Cancel=true. + + + + + Occurs when ColumnHeader is automatically created by control as result of data binding for multi-column drop-down and provides you with opportunity to modify it. + + + + + Occurs before selection on multi-column drop-down has changed and allows canceling of the change. Applies to multi-column drop-down only. + + + + + Gets or sets whether selection change on multi-column drop-down closes the popup. Default value is true. Applies to multi-column drop-down only. + + + + + Indicates whether multi-column popup size is preserved between popup displays if popup is resized by end-user. Applies to multi-column drop-down only. + + + + + Indicates whether multi-column popup can be resized by end user. Applies to multi-column drop-down only. + + + + + Indicates whether multi-column popup close button is visible. + + + + + Gets or sets whether multi-column popup window is open. Applies to multi-column drop-down only. + + + + + Gets the reference to the control which is used to display multi-column data on popup. Control is created just before the popup is opened. + + + + + Indicates the font used by the multi-column control on the popup. + + + + + Gets or sets the command assigned to the item. Default value is null. + Note that if this property is set to null Enabled property will be set to false automatically to disable the item. + + + + + Gets or sets user defined data value that can be passed to the command when it is executed. + + + + + Represents the method that will handle the DropDownChange event. + + + + + Summary description for ComboBoxItem. + + + + + Creates new instance of ComboBoxItem. + + + + + Creates new instance of ComboBoxItem and assigns item name. + + Item Name. + + + + Creates new instance of ComboBoxItem and assigns item name and item text. + + Item Name + Item Text. + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Returns whether property should be serialized. + + + + + Overridden. Releases the input focus. + + + + + Raises the ComboBoxTextChanged event. + + Provides event arguments. + + + + Indicates whether property should be serialized by Windows Forms designer. + + + + + Resets the property to default value. + + + + + Occurs when underlining control ComboBox.Text property has changed. + + + + + Occurs when selected item on combo box has changed. + + + + + Gets or sets the accessible role of the item. + + + + + Gets or sets whether combo box generates the audible alert when Enter key is pressed. + + + + + Gets or sets the text color of the combo box label. + + + + + IBlock member implementation + + + + + Gets or sets the width of the of the drop-down portion of a combo box. + + + + + Gets or sets the height of the of the drop-down portion of a combo box. + + + + + Indicates the Width of the combo box part of the item. + + + + + Indicates whether control automatically releases its input focus when selection is made using keyboard. + + + + + Returns the reference to the inner combo box control. + + + + + Indicates whether item caption is always shown. + + + + + Gets an object representing the collection of the items contained in inner ComboBoxEx. + + + + + Gets or sets a value specifying the style of the combo box. + + + + + Gets or sets the starting index of text selected in the combo box. + + + + + Gets or sets the number of characters selected in the editable portion of the combo box. + + + + + Gets or sets the text that is selected in the editable portion of a combo box. + + + + + Gets or sets currently selected item in the combo box. + + + + + Gets or sets the index specifying the currently selected item. + + + + + Gets or sets the value indicating whether the item automatically loads all the fonts available into the combo box. + + + + + Gets or sets the height of an item in the combo box. + + + + + Indicates item's visibility when on pop-up menu. + + + + + Gets or sets the value that indicates whether the item was recently used. + + + + + Overridden. Gets or sets the text associated with this item. + + + + + Gets or sets the text associated with this item. + + + + + Gets or sets the item caption text displayed next to the combo box. + + + + + Gets or sets a string that specifies the property of the data source whose contents you want to display. When ComboBoxItem is used in DropDown mode + and objects like ComboItem are added to ComboBoxItems.Items collection DisplayMembers should be set to the name of the property you would + like to use as text representation in editable portion of ComboBox. For example in case of ComboItem objects property should be set to Text. + + + + + Specifies whether combo box is drawn using themes when running on OS that supports themes like Windows XP + + + + + Gets or sets the watermark font. + + + + + Gets or sets the watermark text color. + + + + + Gets or sets whether watermark text is displayed when control is empty. Default value is true. + + + + + Gets or sets the watermark (tip) text displayed inside of the control when Text is not set and control does not have input focus. This property supports text-markup. + Note that WatermarkText is not compatible with the auto-complete feature of .NET Framework 2.0. + + + + + Gets or sets the watermark hiding behaviour. Default value indicates that watermark is hidden when control receives input focus. + + + + + Gets or sets whether control is stand-alone control. Stand-alone flag affects the appearance of the control in Office 2007 style. + + + + + Summary description for ComboItem. + + + + + Creates new instance of ComboItem. + + + + + Initializes a new instance of the ComboItem class. + + + + + + Initializes a new instance of the ComboItem class. + + + + + + + Initializes a new instance of the ComboItem class. + + + + + + + + Initializes a new instance of the ComboItem class. + + + + + + + Overridden. Returns a human-readable string representation of this object. + + A string that represents this object. + + + + Gets or sets the text associated with this item. + + + + + Gets or sets the index value of the image assigned to the item. + + + + + Gets or sets the text alignment.. + + + + + Gets or sets the line alignment for the item. + + + + + Gets or sets the value that encapsulates text layout information (such as alignment, orientation, tab stops, and clipping) and display manipulations. + + + + + Gets or sets the image horizontal image position. + + + + + Gets or sets the font name used to draw the item text. + + + + + Gets or sets the text color. + + + + + Gets or sets the background color of the item. + + + + + Specifies style information applied to text. + + + + + Gets the em-size of this Font object in design units. + + + + + Gets or sets the image assigned to this item. + + + + + Gets or sets an object that contains data to associate with the item. + + + + + Serves as integration of regular Image class and Icon class + + + + + Specifies orientation of content. + + + + + Indicates Horizontal orientation of the content. + + + + + Indicates Vertical orientation of the content. + + + + + Specifies content horizontal alignment. + + + + + Content is left aligned.UI + + + + + Content is right aligned. + + + + + Content is centered. + + + + + Specifies content vertical alignment. + + + + + Content is top aligned. + + + + + Content is bottom aligned. + + + + + Content is in the middle. + + + + + Represents a extended content block interface for advanced layout information. + + + + + Returns whether element is an container so it receives full available size of parent control for layout. + + + + + Represents event arguments for SerialContentLayoutManager.NextPosition event. + + + + + Gets or sets the block that is layed out. + + + + + Gets or sets the current block position. + + + + + Gets or sets the calculated next block position. + + + + + Cancels default position calculation. + + + + + Represents event arguments for the SerialContentLayoutManager layout events. + + + + + Gets or sets the reference block object. + + + + + Gets or sets the position block will assume. + + + + + Cancel the layout of the block, applies only to BeforeXXX layout event. + + + + + Gets or sets the visibility index of the block. + + + + + Creates new instance of the class and initializes it with default values. + + + + + Delegate for SerialContentLayoutManager.NextPosition event. + + + + + Delegate for the SerialContentLayoutManager layout events. + + + + + Summary description for ContextExMenuTypeEditor. + + + + + Gets the editor style used by the EditValue method. + + An ITypeDescriptorContext that can be used to gain additional context information. + A UITypeEditorEditStyle value that indicates the style of editor used by EditValue. If the UITypeEditor does not support this method, then GetEditStyle will return None + + + + Represents the context menu bar that provides the context menus for the System.Windows.Forms.Control inherited controls on the form. + + + + + Returns the instance of the BaseItem that is assigned as context menu to the control. + + Control to return context menu for. + Instance of the BaseItem used as context menu for the control. + + + + Assigns the context menu to a control. + + Control to assign the context menu to. + Instance of PopupItem derived class usually ButtonItem to act as context menu for a control. The SubItems collection of the item specified here actually defines the visible context menu items. + + + + Gets/Sets whether Bar is visible or not. + + + + + Summary description for Popups. + + + + + Summary description for ControlContainerItem. + + + + + Creates new instance of ControlContainerItem and assigns item name. + + + + + Creates new instance of ControlContainerItem and assigns item name. + + Item name. + + + + Creates new instance of ControlContainerItem and assigns item name and item text. + + Item name. + Item text. + + + + Overridden. Returns the copy of the ControlContainerItem. + + Copy of the ControlContainerItem. + + + + Overridden. Draws the item. + + Target Graphics object. + + + + Overridden. Recalculates the size of the item. + + + + + Called when size of the item is changed externally. + + + + + Returns the Font object to be used for drawing the item text. + + Font object. + + + + Occurs when container control needs to be assigned to the item. + + + + + Indicates item's visiblity when on pop-up menu. + + + + + Indicates whether item was recently used. + + + + + Gets/Sets informational text (tooltip) for the item. + + + + + Gets or sets the reference to the control that is managed by the item. + + + + + IBlock member implementation + + + + + Specifies whether contained control can be automatically resized to fill the item container. + + + + + Represents the Check Box control with extended styles. + + + + + Invokes the CheckedChanged event. + + + + + Invokes CheckedChanging event. + + + + + Called when Command property value changes. + + + + + Occurs before Checked property is changed and allows you to cancel the change. + + + + + Occurs after Checked property is changed with extended information. + + + + + Occurs after Checked property is changed. This event is provided for the Windows Forms data binding support. You can use CheckedChangedEx to get extended information about the changed. + + + + + Occurs after Checked property is changed. This event is provided for the Windows Forms data binding support. You can use CheckedChangedEx to get extended information about the changed. + + + + + Gets or sets the size of the check or radio sign. Default value is 13x13. Minimum value is 6x6. + + + + + Gets or sets whether text-markup support is enabled for controls Text property. Default value is true. + Set this property to false to display HTML or other markup in the control instead of it being parsed as text-markup. + + + + + Gets or sets the appearance style of the item. Default value is CheckBox. Item can also assume the style of radio-button. + + + + + Gets or sets the check box position relative to the text. Default value is Left. + + + + + Gets or set a value indicating whether the button is in the checked state. + + + + + Gets or sets whether text assigned to the check box is visible. Default value is true. + + + + + Gets or sets the text color. Default value is Color.Empty which indicates that default color is used. + + + + + Gets or sets the text associated with the control. + + + + + Gets or sets a value indicating whether the control is automatically resized to display its entire contents. You can set MaximumSize.Width property to set the maximum width used by the control. + + + + + Gets or sets a value indicating whether the CheckBox will allow three check states rather than two. If the ThreeState property is set to true + CheckState property should be used instead of Checked property to set the extended state of the control. + + + + + Specifies the state of a control, such as a check box, that can be checked, unchecked, or set to an indeterminate state. + + + + + Gets the underlying CheckBoxItem + + + + + Gets or sets whether mnemonic character assigned to control is processed only if Alt key is pressed. Default value is false which indicate that Alt key is not required. + + + + + Gets or set whether the Checked values and the item appearance are automatically changed when the Check-Box is clicked. Default value is true. + + + + + Gets or sets the object that represents the Checked state of control. + + + + + Gets or sets whether empty string is consider as null value during CheckValue value comparison. Default value is true. + + + + + Gets or sets the value that represents the Indeterminate state of check box when CheckValue property is set to that value. Default value is null. + + + + + Gets or sets the value that represents the Checked state of check box when CheckValue property is set to that value. Default value is null. + + + + + Gets or sets the value that represents the Unchecked state of check box when CheckValue property is set to that value. Default value is null. + + + + + Gets or sets the custom image that is displayed instead default check box representation when check box is checked. + + + + + Gets or sets the custom image that is displayed instead default check box representation when check box is unchecked. + + + + + Gets or sets the custom image that is displayed instead default check box representation when check box is in indeterminate state. + + + + + Gets or sets the command assigned to the item. Default value is null. + Note that if this property is set to null Enabled property will be set to false automatically to disable the item. + + + + + Gets or sets user defined data value that can be passed to the command when it is executed. + + + + + Delegate for OptionGroupChanging event. + + + + + Represents event arguments for OptionGroupChanging event. + + + + + Set to true to cancel the checking on NewChecked button. + + + + + Check-box that will become checked if operation is not cancelled. + + + + + Check-box that is currently checked and which will be unchecked if operation is not cancelled. This property will have only valid values for eCheckBoxStyle.RadioButton style CheckBoxItems. + + + + + Indicates the action that has caused the event. + + + + + Default constructor. + + + + + Represents the combo box like control which shows the AdvTree control on popup. Tree control + can be configured to display multiple columns as well. + + + + + Initializes a new instance of the TextBoxDropDown class. + + + + + Raises FormattingEnabledChanged event. + + Event arguments. + + + + Raises FormatStringChanged event. + + Event arguments. + + + + Raises FormatInfoChanged event. + + Event arguments. + + + + Raises the DataSourceChanged event. + + An EventArgs that contains the event data. + + + + Raises the DisplayMemberChanged event. + + An EventArgs that contains the event data. + + + + When overridden in a derived class, resynchronizes the item data with the contents of the data source. + + + + + When overridden in a derived class, sets the specified array of objects in a collection in the derived class. + + An array of items. + + + + Raises the DataColumnCreated event. + + Provides event arguments. + + + + Raises the DataNodeCreated event. + + Provides event arguments. + + + + Creates a new node for the data item. + + Item to create node for. + New instance of the node. + + + + Raises the DataNodeCreated event. + + Provides event arguments. + + + + When overridden in a derived class, sets the object with the specified index in the derived class. + + The array index of the object. + The object. + + + + Called when ParentFieldName property has changed. + + + + + Called when GroupingMembers property has changed. + + + + + Raises the Format event. + + Event parameters + + + + Raises the SelectedIndexChanged event. + + Event arguments. + + + + Raises the ValueMemberChanged event. + + Event arguments. + + + + Raises the SelectedValueChanged event. + + Event arguments. + + + + Indicates whether property should be serialized by Windows Forms designer. + + + + + Resets the property to default value. + + + + + Resets style to default value. Used by windows forms designer. + + + + + Renders the selected node inside the combo box. + + Graphics reference. + Render bounds. + + + + Updates popup tree size based on its content. + + + + + Shows drop-down popup. Note that popup will be shown only if there is a DropDownControl assigned or DropDownItems collection has at least one item. + + + + + Closes the drop-down popup if it is open. + + + + + Called when PopupLocation property has changed. + + Old property value + New property value + + + + Raises the ButtonClearClick event. + + + + + + Raises the ButtonDropDownClick event. + + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Called when Command property value changes. + + + + + Occurs when Clear button is clicked and allows you to cancel the default action performed by the button. + + + + + Occurs when Drop-Down button that shows popup is clicked and allows you to cancel showing of the popup. + + + + + Occurs when ButtonCustom control is clicked. + + + + + Occurs when ButtonCustom2 control is clicked. + + + + + Occurs when the text alignment in text box has changed. + + + + + Occurs before Node has been selected by user or through the SelectedNode property. Event can be canceled. + + + + + Occurs after node has been selected by user or through the SelectedNode property. + + + + + Occurs when the DataSource changes. + + + + + Occurs when the DisplayMembers property changes. + + + + + Occurs when the control is bound to a data value that need to be converted. + + + + + Occurs when FormattingEnabled property changes. + + + + + Occurs when FormatString property changes. + + + + + Occurs when FormatInfo property has changed. + + + + + Occurs when a Node for an data-bound object item has been created and provides you with opportunity to modify the node. + + + + + Occurs when a group Node is created as result of GroupingMembers property setting and provides you with opportunity to modify the node. + + + + + Occurs when value of ValueMember property has changed. + + + + + Occurs when value of SelectedValue property has changed. + + + + + Occurs when value of SelectedIndex property has changed. + + + + + Occurs when ColumnHeader is automatically created by control as result of data binding and provides you with opportunity to modify it. + + + + + Gets or sets the tree node that is currently selected in the tree control. + + + If no Node is currently selected, the + SelectedNode property is a null reference (Nothing in Visual + Basic). + + + + + Gets or sets whether selection change on popup tree closes the popup. Default value is true. + + + + + Gets or sets the field name that holds the text that will be displayed in the control for selected item. When not set all items set in DisplayMembers will be displayed in control. + + + + + Gets or sets the field name that holds the text that will be displayed in the control for selected item. When not set all items set in DisplayMembers will be displayed in control. + + + + + Gets or sets the comma separated list of property or column names to display on popup tree control. + + + + + Gets or sets the data source for the ComboTree. Expected is an object that implements the IList or IListSource interfaces, + such as a DataSet or an Array. The default is null. + + + + + Gets or sets a value indicating whether formatting is applied to the DisplayMembers property of the control. + + + + + Gets or sets the format-specifier characters that indicate how a value is to be displayed. + + + + + Gets or sets the IFormatProvider that provides custom formatting behavior. + + + + + Gets or sets comma separated field or property names that holds the value that is used to identify node and parent node. Format expected is: FieldNodeId,ParentNodeFieldId. For example if your table represents departments, you have DepartmentId field which uniquely identifies a department and ParentDepartmentId field which identifies parent of the department if any you would set this property to DepartmentId,ParentDepartmentId. + Note that you can only use ParentFieldNames or GroupingMembers property but not both. If both are set ParentFieldName take precedence. + + + + + Gets or sets comma separated list of field or property names that are used for grouping when data-binding is used. + + + + + Gets or sets style for automatically created group nodes when data-binding is used and GroupingMembers property is set. + + + Name of the style assigned or null value indicating that no style is used. + Default value is null. + + + + + Gets or sets the index specifying the currently selected item. + + + + + Gets or sets the property to use as the actual value for the items in the control. Applies to data-binding scenarios. SelectedValue property will return the value of selected node as indicated by this property. + + + + + Gets or sets the value of the member property specified by the ValueMember property. + + + + + Gets or sets the watermark font. + + + + + Gets or sets the watermark text color. + + + + + Gets or sets whether watermark text is displayed if set for the input items. Default value is true. + + + + + Gets or sets the watermark text displayed on the input control when control is empty. + + + + + Gets or sets the watermark text alignment. Default value is left. + + + + + Gets or sets whether FocusHighlightColor is used as background color to highlight text box when it has input focus. Default value is false. + + + + + Gets or sets the color used as background color to highlight text box when it has input focus and focus highlight is enabled. + + + + + Specifies the background style of the control. + + + + + Gets the object that describes the settings for the button that shows drop-down when clicked. + + + + + Gets the object that describes the settings for the button that clears the content of the control when clicked. + + + + + Gets the object that describes the settings for the custom button that can execute an custom action of your choosing when clicked. + + + + + Gets the object that describes the settings for the custom button that can execute an custom action of your choosing when clicked. + + + + + Indicates whether Enter key when pressed while control has input focus toggles the popup. Default value is true. + + + + + Gets or sets whether keyboard incremental search is enabled. Default value is true. + + + + + Gets or sets whether during keyboard search selected node can be set to nothing/null if there is no match found. + Default value is true. + + + + + Gets or sets the keyboard search buffer expiration timeout. Default value is 1000 which indicates that + key pressed within 1 second will add to the search buffer and control will be searched for node text + that begins with resulting string. Setting this value to 0 will disable the search buffer. + + + + + Indicates the custom popup location for the ComboTree popup + + + + + Gets or sets the reference of the control that will be displayed on popup that is shown when drop-down button is clicked. + + + + + Gets the collection of BaseItem derived items displayed on popup menu. + + + + + Gets the reference to internal AdvTree control that is displayed on popup Use it to get access to the AdvTree events and properties. + + + + + Gets or sets the height in pixels of the drop-down portion of the ComboTreeBox control. + + + + + Gets or sets the width in pixels of the drop-down portion of the ComboTreeBox control. + + + + + Gets or sets a value indicating whether the combo box is displaying its drop-down portion. + + + + + Gets the collection of tree nodes that are assigned to the popup tree view control. + + + A NodeCollection that represents the tree nodes + assigned to the tree control. + + + The Nodes property holds a collection of Node objects, each of which has a + Nodes property that can contain its own NodeCollection. + + + + + Gets the collection of column headers that appear in the popup tree. + + + By default there are no column headers defined. In that case tree control + functions as regular tree control where text has unrestricted width. + If you want to restrict the horizontal width of the text but not display + column header you can create one column and set its width to the width desired and + set its Visible property to false. + + + + + Gets or sets whether column headers are visible if they are defined through Columns collection. Default value is true. + + + + + Gets or sets whether grid lines are displayed when columns are defined. Default value is true. + + + + + Gets or sets the grid lines color. + + + + + Gets or sets whether horizontal grid lines between each row are displayed. Default value is false. + + + + + Gets or sets whether node is highlighted when mouse enters the node. Default value is false. + + + There are two ways to enable the node hot-tracking. You can set the HotTracking property to true in which case the + mouse tracking is enabled using system colors specified in TreeColorTable. You can also define the NodeStyleMouseOver + style which gets applied to the node when mouse is over the node. + + + + + Gets or sets the node selection box style for popup tree control. + + SelectionBox Property + SelectionBoxSize Property + SelectionBoxFillColor Property + SelectionBoxBorderColor Property + + + + Gets or sets the ImageList that contains the Image objects used by the tree nodes. + + + + + Gets or sets the image-list index value of the default image that is displayed by the tree nodes. + + + + + Gets or sets the control background color when control is disabled. Default value is an empty color which indicates that system background color is used when control is disabled. + + + + + Gets or sets the command assigned to the item. Default value is null. + Note that if this property is set to null Enabled property will be set to false automatically to disable the item. + + + + + Gets or sets user defined data value that can be passed to the command when it is executed. + + + + + Represents the method that will handle converting for ComboTree control. + + + + + + + Gets the reference to the item being converted. + + + + + Get the reference to the name of the field or property on the item that needs conversion. + + + + + Defines delegate for data node based events. + + + + + Defines event arguments for data node based events. + + + + + Gets or sets the node that is created for data item. + + + + + Gets the data-item node is being created for. + + + + + Initializes a new instance of the DataNodeEventArgs class. + + + + + + + Defines delegate for data column based events. + + + + + Defines event arguments for data column based events. + + + + + Gets or sets the column header that is created for data. + + + + + Initializes a new instance of the DataColumnEventArgs class. + + + + + + Initializes a new instance of the ControlWithBackgroundStyle class. + + + + + Resets style to default value. Used by windows forms designer. + + + + + Gets or sets whether anti-alias smoothing is used while painting. Default value is true. + + + + + Specifies the background style of the control. + + + + + Represents the DataGridView control with enhanced Office 2007 style. + + + + + Called by StyleManager to notify control that style on manager has changed and that control should refresh its appearance if + its style is controlled by StyleManager. + + New active style. + + + + Indicates whether control will delay call to OnResize base DataGridView method when control is running on MDI Child which was introduced as workaround to an issue in control. + + + + + Gets or sets the scroll-bar visual style. + + + + + Gets or sets whether selected column header is highlighted. Default value is true. + + + + + Gets or sets whether select all sign displayed in top-left corner of the grid is visible. Default value is true. + + + + + Gets or sets whether enhanced selection for the cells is painted in Office 2007 style. Default value is true. + + + + + Indicates whether BackgroundColor property set on DataGridView is obeyed instead of using system color scheme color. + + + + + GetContentBounds + + + + + + + + + Cell painting + + + + + + + + + + + + + + + + Paints the Button background + + + + + + + + Paints the button background and content + + + + + + + + + + + OnMouseEnter + + + + + + Establishes the given rowIndex as the + ActiveRowIndex. + + + + + + Processes MouseLeave events + + + + + + Processes MouseMove events + + + + + + Processes MouseDown events + + + + + + Processes MouseUp events + + + + + + Determines if the given part is set + + + + + + + + Gets the background bounds for the given cell + + + + + + + + Gets the button bounds for the given cell + + + + + + + + GetValue + + + + + + + Initiates the refresh of the cell button + + + + + + + Gets the Type of the editing control associated with the cell + + + + + FormattedValueType + + + + + Gets whether the Column cells will fully paint + their cell background and content + + + + + Constructor + + + + + Gets whether ImageFixedSize property should be serialized. + + + + + Hooks or unhooks our system events + + + + + + Processes Button expand changes + + + + + + + ButtonItem_Click + + + + + + + Gets the cell paint bitmap + + + + + + + Invokes BeforeCellPaint user events + + Row index + Column index + + + + Clones the ButtonX Column + + + + + + Dispose + + + + + + Gets or sets the active row index + + + + + Gets the Control Button + + + + + Gets or sets the Current row index + + + + + Gets or sets a expanded button + was just closed + + + + + Gets or sets the cell callback state + + + + + Gets or sets whether Checked property is automatically inverted, button checked/unchecked, when button is clicked. Default value is false. + + + + + Indicates whether the button will auto-expand when clicked. + When button contains sub-items, sub-items will be shown only if user + click the expand part of the button. Setting this property to true will expand the button and show sub-items when user + clicks anywhere inside of the button. Default value is false which indicates that button is expanded only + if its expand part is clicked. + + + + + Gets or set a value indicating whether the button is in the checked state. + + + + + Gets or sets button Color Scheme. ColorScheme does not apply to Office2007 styled buttons. + + + + + Gets or sets the predefined color of the button. Color specified applies to buttons with Office 2007 style only. It does not have + any effect on other styles. Default value is eButtonColor.BlueWithBackground + + + + + Gets or sets the custom color name. Name specified here must be represented by the corresponding object with the same name that is part + of the Office2007ColorTable.ButtonItemColors collection. See documentation for Office2007ColorTable.ButtonItemColors for more information. + If color table with specified name cannot be found default color will be used. Valid settings for this property override any + setting to the Color property. Applies to items with Office 2007 style only. + + + + + Specifies the image for the button when items Enabled property is set to false. + + + + + Gets or sets whether text-markup support is enabled for items Text property. Default value is true. + Set this property to false to display HTML or other markup in the item instead of it being parsed as text-markup. + + + + + Gets or sets whether the control can respond to user interaction + + + + + Indicates the way button is rendering the mouse over state. Setting the value to + Color will render the image in gray-scale when mouse is not over the item. + + + + + Specifies the image for the button when mouse is over the item. + + + + + Specifies the Button image. + + + + + Sets fixed size of the image. Image will be scaled and painted it size specified. + + + + + Gets/Sets the image position inside the button. + + + + + Gets or sets the amount of spacing between button image if specified and text. + + + + + Gets or sets the location of popup in relation to it's parent. + + + + + Specifies the image for the button when mouse left button is pressed. + + + + + Gets or sets an shape descriptor for the button + which describes the shape of the button. Default value is null + which indicates that system default shape is used. + + + + + Gets or sets whether button displays the expand part that indicates that button has popup. + + + + + Gets or sets whether button appears as split button. Split button appearance + divides button into two parts. Image which raises the click event when clicked + and text and expand sign which shows button sub items on popup menu when clicked. + Button must have both text and image visible (ButtonStyle property) in order to + appear as a full split button. + + + + + Gets/Sets the visual style for the button. + + + + + Returns the collection of sub items. + + + + + Gets or sets the width of the expand part of the button item. + + + + + Gets or sets the default Text to display on the Button + + + + + Gets or sets the text alignment. Applies only when button text is not composed using text markup. Default value is center. + + + + + Gets the Cell paint setting for the ButtonX control + + + + + BeforeCellPaintEventArgs + + + + + RowIndex of cell being painted + + + + + ColumnIndex of cell being painted + + + + + GetAdjustedEditingControlBounds + + + + + + + + GetPreferredSize + + + + + + + + + + Cell painting + + + + + + + + + + + + + + + + Paints the Button background + + + + + + + + Paints the button background and content + + + + + + + + + + + OnMouseEnter + + + + + + Processes MouseLeave events + + + + + + Processes MouseMove events + + + + + + Processes MouseDown events + + + + + + Processes MouseUp events + + + + + + Determines if the given part is set + + + + + + + + Gets the background bounds for the given cell + + + + + + + + Gets the Content bounds for the given cell + + + + + + + Initiates the refresh of the cell + + + + + + + Gets the Type of the editing control associated with the cell + + + + + FormattedValueType + + + + + Constructor + + + + + HookEvents + + + + + + CheckBoxItem_Click + + + + + + + CheckBoxItem_DoubleClick + + + + + + + Gets the cell paint bitmap + + + + + + + Invokes BeforeCellPaint user events + + Row index + Column index + + + + Clones the ButtonX Column + + + + + + Dispose + + + + + + Gets or sets the active row index + + + + + Gets the Control Button + + + + + Gets or sets the Current row index + + + + + Gets or sets the MouseDown row index + + + + + Gets or sets the cell callback state + + + + + Gets or sets the custom image that is displayed instead default check box representation when check box is checked. + + + + + Gets or sets the custom image that is displayed instead default check box representation when check box is unchecked. + + + + + Gets or sets the custom image that is displayed instead default check box representation when check box is in indeterminate state. + + + + + Gets or sets the check box position relative to the text. + Default value is Left. + + + + + Gets or set a value indicating whether the button is in the checked state. + + + + + Specifies the state of the control, that can be + checked, unchecked, or set to an indeterminate state. + + + + + CheckValue + + + + + Gets or sets the value that represents the Checked state value of the check + box when CheckValue property is set to that value. Default value is null. + + + + + Gets or sets the value that represents the Indeterminate state of the check + box when CheckValue property is set to that value. Default value is null. + + + + + Gets or sets the value that represents the Unchecked state value of check + box when CheckValue property is set to that value. Default value is 'N'. + + + + + Gets or sets whether empty string is consider as null value + during CheckValue value comparison. Default value is true. + + + + + Gets or sets whether the control can respond to user interaction + + + + + Gets or sets whether text-markup support is enabled for controls + Text property. Default value is true. Set this property to false to + display HTML or other markup in the control instead of it being parsed as text-markup. + + + + + Gets or sets the default Text to display + + + + + Gets or sets the text color. Default value is + Color.Empty which indicates that default color is used. + + + + + Gets or sets whether text assigned to the check box is visible. + Default value is true. + + + + + Gets or sets a value indicating whether the CheckBox will allow + three check states rather than two. If the ThreeState property is + set to true CheckState property should be used instead of Checked + property to set the extended state of the control. + + + + + Gets the Cell paint setting for the ButtonX control + + + + + InitializeEditingControl + + + + + + + + DetachEditingControl + + + + + Click + + + + + + + DrawItem + + + + + + + DropDownChange + + + + + + + MeasureItem + + + + + + + PositionEditingControl + + + + + + + + + + + + + + GetAdjustedEditingControlBounds + + + + + + + + GetPreferredSize + + + + + + + + + + ParseFormattedValue + + + + + + + + + + Cell painting + + + + + + + + + + + + + + + + Paints the cell background + + + + + + + + Paints the cell content + + + + + + + + + + + + DrawControl + + + + + + + + + + + DrawText + + + + + + + + + MustRenderVisibleControl + + + + + + + OnMouseEnter + + + + + + Gets the background bounds for the given cell + + + + + + + + Gets the button bounds for the given cell + + + + + + + Determines if the given part is set + + + + + + + + Gets the Type of the editing control associated with the cell + + + + + Constructor + + + + + Indicates whether property should be serialized by Windows Forms designer. + + + + + Resets the property to default value. + + + + + HookEvents + + + + + + ComboBoxEx_DataSourceChanged + + + + + + + DoComboBoxEx_Click + + + + + + + DoComboBoxEx_DrawItem + + + + + + + DoComboBoxEx_DropDownChange + + + + + + + DoComboBoxEx_MeasureItem + + + + + + + Gets the cell paint bitmap + + + + + + + Invokes BeforeCellPaint user events + + Row index + Column index + + + + Clones the ButtonX Column + + + + + + Dispose + + + + + + Occurs right before a ComboBox Cell is painted + + + + + Occurs when the ComboBox is clicked + + + + + Occurs when a visual aspect of an owner-drawn ComboBox changes + + + + + Occurs when drop down portion of the ComboBox is shown or hidden. + + + + + Occurs each time an owner-drawn ComboBox item needs + to be drawn and when the sizes of the list items are determined + + + + + Gets the underlying ComboBoxEx control + + + + + Gets or sets the ComboBox CurrencyManager + + + + + Gets or sets a custom System.Collections.Specialized.StringCollection + to use when the AutoCompleteSource property is set to CustomSource. + + + + + Gets or sets an option that controls how automatic completion works for the ComboBox. + + + + + Gets or sets a value specifying the source of complete strings used for automatic completion. + + + + + Gets or sets the data source that populates the selections for the combo box + + + + + Gets or sets a string that specifies the property or column + from which to retrieve strings for display in the combo box. + + + + + Gets or sets whether the control + will be displayed for the current cell only. + + + + + Gets or sets a value indicating whether user code or + operating system code will handle drawing of elements in the list. + + + + + Gets or sets a value specifying the style of the combo box. + + + + + Gets or sets the height in pixels of the drop-down portion of the ComboBox. + + + + + Gets or sets the width of the drop-down lists of the combo box. + + + + + Gets or sets whether the control can respond to user interaction + + + + + Gets or sets the flat style appearance of the column's cells. + + + + + Gets or sets whether control displays focus cues when focused. + + + + + Gets or sets the format-specifier + characters that indicate how a value is to be displayed. + + + + + Gets or sets a value indicating whether formatting is applied to the DisplayMember property. + + + + + Gets or sets the ImageList control used by Combo box to draw images. + + + + + Gets or sets the Input Method Editor (IME) mode of the control. + + + + + Gets or sets a value indicating whether + the control should resize to avoid showing partial items. + + + + + Gets or sets whether control is stand-alone control. + Stand-alone flag affects the appearance of the control in Office 2007 style. + + + + + Gets or sets the height of an item in the combo box. + + + + + Gets the collection of objects used as selections in the combo box. + + + + + Gets or sets the maximum number of items + in the drop-down list of the cells in the column. + + + + + Gets or sets the number of characters a user can type into the ComboBox. + + + + + Gets or sets a value indicating whether control's + elements are aligned to support locales using right-to-left fonts. + + + + + Gets or sets whether the items in the combo box are sorted. + + + + + Determines the visual style applied to + the combo box when shown. Default style is Office 2007. + + + + + Gets or sets the text associated with this control. + + + + + Gets or sets a string that specifies the property or column + from which to get values that correspond to the selections in the drop-down list. + + + + + Gets or sets the watermark hiding behaviour. Default value + indicates that watermark is hidden when control receives input focus. + + + + + Gets or sets the watermark text color. + + + + + Gets or sets whether watermark text is + displayed when control is empty. Default value is true. + + + + + Gets or sets the watermark font. + + + + + Gets or sets the watermark (tip) text displayed inside of the control when Text + is not set and control does not have input focus. This property supports text-markup. + Note that WatermarkText is not compatible with the auto-complete feature of .NET Framework 2.0. + + + + + Gets the Cell paint setting for the control + + + + + DropDownChangeEventArgs + + + + + ColumnIndex + + + + + Expanded state + + + + + RowIndex + + + + + Handles OnTextChanged events + + + + + + OnSelectedIndexChanged + + + + + + NotifyDataGridViewOfValueChange + + + + + ApplyCellStyleToEditingControl + + + + + + Gets EditingControlFormattedValue + + + + + + + Gets whether the given key wants to be processed + by the Control + + + + + + + + PrepareEditingControlForEdit + + + + + + Gets or sets the DataGridView + + + + + Gets or sets the Control Formatted Value + + + + + Gets or sets the Control RoeIndex + + + + + Gets or sets the Control ValueChanged state + + + + + Gets the Panel Cursor + + + + + Gets whether to RepositionEditingControlOnValueChange + + + + + InitializeEditingControl + + + + + + + + DetachEditingControl + + + + + ButtonClearClick + + + + + + + ButtonCustomClick + + + + + + + ButtonCustom2Click + + + + + + + ButtonDropDownClick + + + + + + + ButtonFreeTextClick + + + + + + + ConvertFreeTextEntry + + + + + + + PositionEditingControl + + + + + + + + + + + + + + GetAdjustedEditingControlBounds + + + + + + + + GetPreferredSize + + + + + + + + + + Cell painting + + + + + + + + + + + + + + + + Paints the cell background + + + + + + + + Paints the cell content + + + + + + + + + + + DrawControl + + + + + + + + DrawText + + + + + + + + Gets the background bounds for the given cell + + + + + + + + Gets the button bounds for the given cell + + + + + + + GetValue + + + + + + + GetHorizontalAlignment + + + + + + + Determines if the given part is set + + + + + + + + Gets the Type of the editing control associated with the cell + + + + + FormattedValueType + + + + + Constructor + + + + + Resets style to default value. Used by windows forms designer. + + + + + Gets whether Value property should be serialized by Windows Forms designer. + + true if value serialized otherwise false. + + + + Gets whether Value property should be serialized by Windows Forms designer. + + true if value serialized otherwise false. + + + + DoButtonClearClick + + + + + + + DoButtonCustomClick + + + + + + + DoButtonCustom2Click + + + + + + + DoButtonDropDownClick + + + + + + + DoButtonFreeTextClick + + + + + + + DoConvertFreeTextEntry + + + + + + + Gets the cell paint bitmap + + + + + + + Invokes BeforeCellPaint user events + + Row index + Column index + + + + Clones the ButtonX Column + + + + + + Occurs right before a DateTimeInput Cell is painted + + + + + Occurs when Clear button is clicked and allows you + to cancel the default action performed by the button + + + + + Occurs when ButtonCustom control is clicked + + + + + Occurs when ButtonCustom2 control is clicked + + + + + Occurs when Drop-Down button that shows calendar + is clicked and allows you to cancel showing of the popup + + + + + Occurs when Free-Text button is clicked + and allows you to cancel its default action + + + + + Occurs if Free-Text entry value is not natively recognized by + the control and provides you with opportunity to convert that + value to the value the control expects + + + + + Gets the underlying DateTimeInput control + + + + + Gets or sets whether empty null/nothing state of the control is + allowed. Default value is true which means that IsEmpty property may + return true if input value is resets or ValueObject set to null/nothing. + + + + + Gets or sets whether input focus is automatically advanced + to next input field when input is complete in current one. + + + + + Gets or sets whether first day in month is automatically + selected on popup date picker when month or year is changed. + + + + + Gets or sets whether auto-overwrite functionality for input is enabled. + When in auto-overwrite mode input field will erase existing entry + and start new one if typing is continued after InputComplete method is called. + + + + + Specifies the background style of the control. + + + + + Gets the object that describes the settings for the button + that clears the content of the control when clicked. + + + + + Gets the object that describes the settings for the custom button + that can execute an custom action of your choosing when clicked. + + + + + Gets the object that describes the settings for the custom button that can execute an custom action of your choosing when clicked. + + + + + Gets the object that describes the settings for the button + that shows drop-down when clicked. + + + + + Gets the object that describes the settings for the button + that switches the control into the free-text entry mode when clicked. + + + + + Gets or sets the custom date/time format string. + + + + + Gets or sets whether the control + will be displayed for the current cell only. + + + + + Gets or sets whether empty input values (year, month or day) are + set to defaults while user is entering data. Default value is true. + + + + + Gets or sets whether the control can respond to user interaction + + + + + Gets or sets the format date/time is displayed in. To specify + custom format set this value to Custom and specify custom format + using CustomFormat property. + + + + + Gets or sets the input field alignment inside the control + + + + + Gets or sets whether input part of the control is read-only. When set + to true the input part of the control becomes read-only and does not allow + the typing. However, drop-down part if visible still allows user to change + the value of the control. Use this property to allow change of the value + through drop-down picker only. + + + + + Gets or sets whether check box shown using ShowCheckBox + property which locks/unlocks the control update is checked. + + + + + Gets or sets the maximum date and time that can be selected in the control. + + + + + Gets or sets the minimum date and time that can be selected in the control. + + + + + Gets the reference to the internal MonthCalendarItem control which is used to display calendar when drop-down is open. + + + + + List of characters that when pressed would select next input field. For example if you are + allowing time input you could set this property to : so when user presses the : character, + the input is forwarded to the next input field. + + + + + Gets or sets a value indicating whether a check box is + displayed to the left of the input value. Set to true if a check box + is displayed to the left of the input value; otherwise, false. The default is false. + + When the ShowCheckBox property is set to true, a check box is displayed + to the left of the input in the control. When the check box is selected, the value + can be updated. When the check box is cleared, the value is unable to be changed. + You can handle the LockUpdateChanged event to be notified when this check box is checked + and unchecked. Use LockUpdateChecked property to get or sets whether check box is checked. + + + + + + Gets or sets a value indicating whether a spin button control + (up-down control) is used to adjust the current value. The default is false. + + When the ShowUpDown property is set to true, a spin button control + is shown to adjust value of currently focused input item. The value can + be adjusted by using the up and down buttons to change the value. + + + + + + Gets the Cell paint setting for the control + + + + + Handles OnValueChanged events + + + + + + ApplyCellStyleToEditingControl + + + + + + Gets EditingControlFormattedValue + + + + + + + Gets whether the given key wants to be processed + by the Control + + + + + + + + PrepareEditingControlForEdit + + + + + + Gets or sets the Edit state + + + + + Gets or sets the DataGridView + + + + + Gets or sets the Control Formatted Value + + + + + Gets or sets the Control RoeIndex + + + + + Gets or sets the Control ValueChanged state + + + + + Gets the Panel Cursor + + + + + Gets whether to RepositionEditingControlOnValueChange + + + + + InitializeEditingControl + + + + + + + + DetachEditingControl + + + + + ButtonClearClick + + + + + + + ButtonCustomClick + + + + + + + ButtonCustom2Click + + + + + + + ButtonDropDownClick + + + + + + + ButtonFreeTextClick + + + + + + + ConvertFreeTextEntry + + + + + + + PositionEditingControl + + + + + + + + + + + + + + GetAdjustedEditingControlBounds + + + + + + + + GetPreferredSize + + + + + + + + + + Cell painting + + + + + + + + + + + + + + + + Paints the cell background + + + + + + + + Paints the cell content + + + + + + + + + + + DrawControl + + + + + + + + DrawText + + + + + + + + Gets the background bounds for the given cell + + + + + + + + Gets the button bounds for the given cell + + + + + + + GetValue + + + + + + + GetHorizontalAlignment + + + + + + + Determines if the given part is set + + + + + + + + Gets the Type of the editing control associated with the cell + + + + + FormattedValueType + + + + + Constructor + + + + + Resets style to default value. Used by windows forms designer. + + + + + DoButtonClearClick + + + + + + + DoButtonCustomClick + + + + + + + DoButtonCustom2Click + + + + + + + DoButtonDropDownClick + + + + + + + DoButtonFreeTextClick + + + + + + + DoConvertFreeTextEntry + + + + + + + Gets the cell paint bitmap + + + + + + + Invokes BeforeCellPaint user events + + Row index + Column index + + + + Clones the ButtonX Column + + + + + + Occurs right before a DoubleInput Cell is painted + + + + + Occurs when Clear button is clicked and allows you + to cancel the default action performed by the button + + + + + Occurs when ButtonCustom control is clicked + + + + + Occurs when ButtonCustom2 control is clicked + + + + + Occurs when Drop-Down button that shows calendar + is clicked and allows you to cancel showing of the popup + + + + + Occurs when Free-Text button is clicked + and allows you to cancel its default action + + + + + Occurs if Free-Text entry value is not natively recognized by + the control and provides you with opportunity to convert that + value to the value the control expects + + + + + DoubleInput + + + + + Specifies the background style of the control. + + + + + Gets the object that describes the settings for the button + that clears the content of the control when clicked. + + + + + Gets the object that describes the settings for the custom button + that can execute an custom action of your choosing when clicked. + + + + + Gets the object that describes the settings for the custom button that can execute an custom action of your choosing when clicked. + + + + + Gets the object that describes the settings for the button + that shows drop-down when clicked. + + + + + Gets the object that describes the settings for the button + that switches the control into the free-text entry mode when clicked. + + + + + Gets or sets the Numeric String Format that is used to format + the numeric value entered for display purpose. Read more about + available formats in MSDN under "Standard Numeric Format Strings" + and "Custom Numeric Format Strings" topics. + + The format specified here indicates the format for display purpose + only, not for the input purpose. For example to display the number + in system Currency format set the DisplayFormat to 'C'. + + + + + + Gets or sets whether the control + will be displayed for the current cell only. + + + + + Gets or sets whether the control can respond to user interaction + + + + + Gets or sets the value to increment or decrement the value of the + control when the up or down buttons are clicked. + + + + + Gets or sets the input field alignment inside the control + + + + + Gets or sets whether check box shown using ShowCheckBox + property which locks/unlocks the control update is checked. + + + + + Gets or sets the maximum value that can be entered. + + + + + Gets or sets the minimum value that can be entered. + + + + + Gets or sets a value indicating whether a check box is + displayed to the left of the input value. Set to true if a check box + is displayed to the left of the input value; otherwise, false. The default is false. + + When the ShowCheckBox property is set to true, a check box is displayed + to the left of the input in the control. When the check box is selected, the value + can be updated. When the check box is cleared, the value is unable to be changed. + You can handle the LockUpdateChanged event to be notified when this check box is checked + and unchecked. Use LockUpdateChecked property to get or sets whether check box is checked. + + + + + + Gets or sets a value indicating whether a spin button control + (up-down control) is used to adjust the current value. The default is false. + + When the ShowUpDown property is set to true, a spin button control + is shown to adjust value of currently focused input item. The value can + be adjusted by using the up and down buttons to change the value. + + + + + + Gets the Cell paint setting for the control + + + + + Handles OnValueChanged events + + + + + + ApplyCellStyleToEditingControl + + + + + + Gets EditingControlFormattedValue + + + + + + + Gets whether the given key wants to be processed + by the Control + + + + + + + + PrepareEditingControlForEdit + + + + + + Gets or sets the Edit state + + + + + Gets or sets the DataGridView + + + + + Gets or sets the Control Formatted Value + + + + + Gets or sets the Control RoeIndex + + + + + Gets or sets the Control ValueChanged state + + + + + Gets the Panel Cursor + + + + + Gets whether to RepositionEditingControlOnValueChange + + + + + InitializeEditingControl + + + + + + + + DetachEditingControl + + + + + ButtonClearClick + + + + + + + ButtonCustomClick + + + + + + + ButtonCustom2Click + + + + + + + ButtonDropDownClick + + + + + + + ButtonFreeTextClick + + + + + + + ConvertFreeTextEntry + + + + + + + PositionEditingControl + + + + + + + + + + + + + + GetAdjustedEditingControlBounds + + + + + + + + GetPreferredSize + + + + + + + + + + Cell painting + + + + + + + + + + + + + + + + Paints the cell background + + + + + + + + Paints the cell content + + + + + + + + + + + DrawControl + + + + + + + + DrawText + + + + + + + + Gets the background bounds for the given cell + + + + + + + + Gets the button bounds for the given cell + + + + + + + GetValue + + + + + + + GetHorizontalAlignment + + + + + + + Determines if the given part is set + + + + + + + + Gets the Type of the editing control associated with the cell + + + + + FormattedValueType + + + + + Constructor + + + + + Resets style to default value. Used by windows forms designer. + + + + + DoButtonClearClick + + + + + + + DoButtonCustomClick + + + + + + + DoButtonCustom2Click + + + + + + + DoButtonDropDownClick + + + + + + + DoButtonFreeTextClick + + + + + + + DoConvertFreeTextEntry + + + + + + + Gets the cell paint bitmap + + + + + + + Invokes BeforeCellPaint user events + + Row index + Column index + + + + Clones the ButtonX Column + + + + + + Occurs right before a DateTimeInput Cell is painted + + + + + Occurs when Clear button is clicked and allows you + to cancel the default action performed by the button + + + + + Occurs when ButtonCustom control is clicked + + + + + Occurs when ButtonCustom2 control is clicked + + + + + Occurs when Drop-Down button that shows calendar + is clicked and allows you to cancel showing of the popup + + + + + Occurs when Free-Text button is clicked + and allows you to cancel its default action + + + + + Occurs if Free-Text entry value is not natively recognized by + the control and provides you with opportunity to convert that + value to the value the control expects + + + + + IntegerInput + + + + + Specifies the background style of the control. + + + + + Gets the object that describes the settings for the button + that clears the content of the control when clicked. + + + + + Gets the object that describes the settings for the custom button + that can execute an custom action of your choosing when clicked. + + + + + Gets the object that describes the settings for the custom button that can execute an custom action of your choosing when clicked. + + + + + Gets the object that describes the settings for the button + that shows drop-down when clicked. + + + + + Gets the object that describes the settings for the button + that switches the control into the free-text entry mode when clicked. + + + + + Gets or sets the Numeric String Format that is used to format + the numeric value entered for display purpose. Read more about + available formats in MSDN under "Standard Numeric Format Strings" + and "Custom Numeric Format Strings" topics. + + The format specified here indicates the format for display purpose + only, not for the input purpose. For example to display the number + in system Currency format set the DisplayFormat to 'C'. + + + + + + Gets or sets whether the control + will be displayed for the current cell only. + + + + + Gets or sets whether the control can respond to user interaction + + + + + Gets or sets the value to increment or decrement the value of the + control when the up or down buttons are clicked. + + + + + Gets or sets the input field alignment inside the control + + + + + Gets or sets whether check box shown using ShowCheckBox + property which locks/unlocks the control update is checked. + + + + + Gets or sets the maximum value that can be entered. + + + + + Gets or sets the minimum value that can be entered. + + + + + Gets or sets a value indicating whether a check box is + displayed to the left of the input value. Set to true if a check box + is displayed to the left of the input value; otherwise, false. The default is false. + + When the ShowCheckBox property is set to true, a check box is displayed + to the left of the input in the control. When the check box is selected, the value + can be updated. When the check box is cleared, the value is unable to be changed. + You can handle the LockUpdateChanged event to be notified when this check box is checked + and unchecked. Use LockUpdateChecked property to get or sets whether check box is checked. + + + + + + Gets or sets a value indicating whether a spin button control + (up-down control) is used to adjust the current value. The default is false. + + When the ShowUpDown property is set to true, a spin button control + is shown to adjust value of currently focused input item. The value can + be adjusted by using the up and down buttons to change the value. + + + + + + Gets the Cell paint setting for the control + + + + + Handles OnValueChanged events + + + + + + ApplyCellStyleToEditingControl + + + + + + Gets EditingControlFormattedValue + + + + + + + Gets whether the given key wants to be processed + by the Control + + + + + + + + PrepareEditingControlForEdit + + + + + + Gets or sets the Edit state + + + + + Gets or sets the DataGridView + + + + + Gets or sets the Control Formatted Value + + + + + Gets or sets the Control RoeIndex + + + + + Gets or sets the Control ValueChanged state + + + + + Gets the Panel Cursor + + + + + Gets whether to RepositionEditingControlOnValueChange + + + + + InitializeEditingControl + + + + + + + + DetachEditingControl + + + + + ButtonClearClick + + + + + + + ButtonCustomClick + + + + + + + ButtonCustom2Click + + + + + + + ButtonDropDownClick + + + + + + + PositionEditingControl + + + + + + + + + + + + + + GetAdjustedEditingControlBounds + + + + + + + + GetPreferredSize + + + + + + + + + + Cell painting + + + + + + + + + + + + + + + + Paints the cell background + + + + + + + + Paints the cell content + + + + + + + + + + + DrawControl + + + + + + + + DrawText + + + + + + + + Gets the background bounds for the given cell + + + + + + + + Gets the button bounds for the given cell + + + + + + + GetValue + + + + + + + GetHorizontalAlignment + + + + + + + Determines if the given part is set + + + + + + + + Gets the Type of the editing control associated with the cell + + + + + Constructor + + + + + Resets style to default value. Used by windows forms designer. + + + + + Indicates whether property should be serialized by Windows Forms designer. + + + + + Resets the property to default value. + + + + + DoButtonClearClick + + + + + + + DoButtonCustomClick + + + + + + + DoButtonCustom2Click + + + + + + + DoButtonDropDownClick + + + + + + + Gets the cell paint bitmap + + + + + + + Invokes BeforeCellPaint user events + + Row index + Column index + + + + Clones the ButtonX Column + + + + + + Occurs right before a IpAddressInput Cell is painted + + + + + Occurs when Clear button is clicked and allows you + to cancel the default action performed by the button + + + + + Occurs when ButtonCustom control is clicked + + + + + Occurs when ButtonCustom2 control is clicked + + + + + Occurs when Drop-Down button that shows calendar + is clicked and allows you to cancel showing of the popup + + + + + Gets the underlying IpAddressInput control + + + + + Gets or sets whether empty null/nothing state of the control + is allowed. Default value is true which means that Text property + may return null if there is no input value. + + + + + Gets or sets whether free-text entry is automatically + turned off when control loses input focus. Default value is false. + + + + + Gets or sets whether auto-overwrite functionality for input + is enabled. When in auto-overwrite mode input field will erase existing entry + and start new one if typing is continued after InputComplete method is called. + + + + + Gets or sets whether free text entries are attempted to be + auto-resolved to IP address as host/domain names. Default value is true. + + + + + Gets or sets the Background color. + + + + + Specifies the background style of the control. + + + + + Gets the object that describes the settings for the button + that clears the content of the control when clicked. + + + + + Gets the object that describes the settings for the custom button + that can execute an custom action of your choosing when clicked. + + + + + Gets the object that describes the settings for the custom button that can execute an custom action of your choosing when clicked. + + + + + Gets the object that describes the settings for the button + that shows drop-down when clicked. + + + + + Gets or sets whether the control + will be displayed for the current cell only. + + + + + Gets or sets the reference of the control that will be + displayed on popup that is shown when the drop-down button is clicked. + + + + + Returns the collection of DropDownItems. + + + + + Gets or sets whether the control can respond to user interaction + + + + + Gets or sets the color used as background color to highlight + the text box when it has input focus and FocusHighlight is enabled. + + + + + Gets or sets whether FocusHighlightColor is used as + background color to highlight the text box when it has + input focus. Default value is false. + + + + + Gets or sets the foreground color. + + + + + Gets or sets whether control input is in + free-text input mode. Default value is false. + + + + + Gets or sets the Input Method Editor (IME) mode of the control. + + + + + Gets or sets whether input part of the control is read-only. When + set to true the input part of the control becomes read-only and does + not allow the typing. However, drop-down part if visible still allows + user to possibly change the value of the control through the method you + can provide on drop-down. Use this property to allow change of the value + through drop-down button only. + + + + + Gets or sets whether check box shown using ShowCheckBox + property which locks/unlocks the control update is checked. + + + + + Gets or sets a value indicating whether control's + elements are aligned to support locales using right-to-left fonts. + + + + + List of characters that when pressed would select next input field. For example if you are + allowing time input you could set this property to : so when user presses the : character, + the input is forwarded to the next input field. + + + + + Gets or sets a value indicating whether a check box is displayed to + the left of the input value. Set to true if a check box is displayed + to the left of the input value; otherwise, false. The default is false. + + + + + Gets or sets the text as it is currently displayed to the user. + + + + + Gets or sets the watermark text color. + + + + + Gets or sets whether watermark text is + displayed when control is empty. Default value is true. + + + + + Gets or sets the watermark font. + + + + + Gets or sets the watermark (tip) text displayed inside of + the control when Text is not set and control does not have + input focus. This property supports text-markup. + + + + + Gets the Cell paint setting for the control + + + + + Control for input of the integer value. + + + + + Initializes a new instance of the IpAddressInput class. + + + + + Copies the current value in the control to the Clipboard. + + + + + Pastes the current Clipboard content if possible as the value into the control. + + + + + Moves the current control value to the Clipboard. + + + + + Shows drop-down popup. Note that popup will be shown only if there is a DropDownControl assigned or DropDownItems collection has at least one item. + + + + + Closes the drop-down popup if it is open. + + + + + Raises the ButtonClearClick event. + + + + + + Raises the ButtonDropDownClick event. + + + + + + Raises the LockUpdateChanged event. + + Provides event data./ + + + + Raises ValueChanged event. + + Provides event arguments. + + + + + + + + + + Called when Command property value changes. + + + + + Occurs when Clear button is clicked and allows you to cancel the default action performed by the button. + + + + + Occurs when Drop-Down button that shows calendar is clicked and allows you to cancel showing of the popup. + + + + + Occurs when ShowCheckBox property is set to true and user changes the lock status of the control by clicking the check-box. + + + + + Occurs when Value property has changed. + + + + + Gets the object that describes the settings for the button that shows drop-down when clicked. + + + + + Gets the object that describes the settings for the button that clears the content of the control when clicked. + + + + + Gets the object that describes the settings for the button that switches the control into the free-text entry mode when clicked. + + + + + Gets or sets whether auto-overwrite functionality for input is enabled. When in auto-overwrite mode input field will erase existing entry + and start new one if typing is continued after InputComplete method is called. + + + + + Gets or sets whether empty null/nothing state of the control is allowed. Default value is true which means that Text property + may return null if there is no input value. + + + + + Gets or sets the reference of the control that will be displayed on popup that is shown when drop-down button is clicked. + + + + + Gets the collection of BaseItem derived items displayed on popup menu. + + + + + Gets or sets whether input part of the control is read-only. When set to true the input part of the control becomes + read-only and does not allow the typing. However, drop-down part if visible still allows user to possibly change the value of the control + through the method you can provide on drop-down. + Use this property to allow change of the value through drop-down button only. + + + + + Gets or sets a value indicating whether a check box is displayed to the left of the input value. + Set to true if a check box is displayed to the left of the input value; otherwise, false. The default is false. + + When the ShowCheckBox property is set to true, a check box is displayed to the left of the input in the control. When the check box is selected, the value can be updated. When the check box is cleared, the value is unable to be changed. + You can handle the LockUpdateChanged event to be notified when this check box is checked and unchecked. Use LockUpdateChecked property + to get or sets whether check box is checked. + + + + + + Gets or sets whether check box shown using ShowCheckBox property which locks/unlocks the control update is checked. + + + + + List of characters that when pressed would select next input field. For example if you are + allowing time input you could set this property to : so when user presses the : character, + the input is forwarded to the next input field. + + + + + Gets or sets the IP Address value represented by the control. + + + + + Occurs if Free-Text entry value is not natively recognized by the control and provides you with opportunity to convert that value to the + value control expects. + + + + + Occurs when Free-Text button is clicked and allows you to cancel its default action. + + + + + Gets or sets whether free text entries are attempted to be auto-resolved to IP address as host/domain names. Default value is true. + + + + + Gets or sets whether free-text entry is automatically turned off when control loses input focus. Default value is false. + + + + + Gets or sets whether control input is in free-text input mode. Default value is false. + + + + + Gets or sets the command assigned to the item. Default value is null. + Note that if this property is set to null Enabled property will be set to false automatically to disable the item. + + + + + Gets or sets user defined data value that can be passed to the command when it is executed. + + + + + Handles OnTextChanged events + + + + + + ApplyCellStyleToEditingControl + + + + + + Gets EditingControlFormattedValue + + + + + + + Gets whether the given key wants to be processed + by the Control + + + + + + + + PrepareEditingControlForEdit + + + + + + Gets or sets the Edit state + + + + + Gets or sets the DataGridView + + + + + Gets or sets the Control Formatted Value + + + + + Gets or sets the Control RoeIndex + + + + + Gets or sets the Control ValueChanged state + + + + + Gets the Panel Cursor + + + + + Gets whether to RepositionEditingControlOnValueChange + + + + + GetAdjustedEditingControlBounds + + + + + + + + + GetPreferredSize + + + + + + + + + + Cell painting + + + + + + + + + + + + + + + + Paints the Label background + + + + + + + + Paints the Label background and content + + + + + + + + + + + OnMouseEnter + + + + + + Processes MouseLeave events + + + + + + Processes MouseMove events + + + + + + Processes MouseDown events + + + + + + Processes MouseUp events + + + + + + CellAlignPoint + + + + + + + Determines if the given part is set + + + + + + + + Gets the background bounds for the given cell + + + + + + + + GetValue + + + + + + + GetHorizontalAlignment + + + + + + + Initiates the refresh of the cell label + + + + + + + Gets the Type of the editing control associated with the cell + + + + + FormattedValueType + + + + + Constructor + + + + + Gets whether property should be serialized. + + + + + Resets the SingleLineColor property to its default value. + + + + + Hooks or unhooks our system events + + + + + + LabelItem_Click + + + + + + + Gets the cell paint bitmap + + + + + + + Invokes BeforeCellPaint user events + + Row index + Column index + + + + Clones the LabelX Column + + + + + + Dispose + + + + + + Button FlatStyle + + + + + Button UseColumnTextForButtonValue + + + + + InCallBack + + + + + Gets the Control LabelX + + + + + Gets or sets whether text-markup support is enabled for items Text property. Default value is true. + Set this property to false to display HTML or other markup in the item instead of it being parsed as text-markup. + + + + + Gets or sets whether control displays focus cues when focused. + + + + + Gets or sets the border sides that are displayed. + Default value specifies border on all 4 sides. + + + + + Gets or sets the type of the border drawn around the label. + + + + + Specifies label image. + + + + + Gets/Sets the image position inside the label. + + + + + Gets or sets the bottom padding in pixels. + + + + + Gets or sets the left padding in pixels. + + + + + Gets or sets the top padding in pixels. + + + + + Gets or sets the right padding in pixels. + + + + + Gets or sets the border line color when border is single line. + + + + + Gets or sets the text associated with this item. + + + + + Gets or sets the horizontal text alignment. + + + + + Gets or sets the vertical text alignment. + + + + + + Gets or sets a value that determines whether text is displayed in multiple lines or one long line. + + + + + Gets the Cell paint setting for the ButtonX control + + + + + InitializeEditingControl + + + + + + + + DetachEditingControl + + + + + ButtonClearClick + + + + + + + ButtonCustomClick + + + + + + + ButtonCustom2Click + + + + + + + ButtonDropDownClick + + + + + + + KeyDown routine forwards all DataGridView sent keys to + the underlying focusable control + + + + + + + PositionEditingControl + + + + + + + + + + + + + + GetAdjustedEditingControlBounds + + + + + + + + GetPreferredSize + + + + + + + + + + Cell painting + + + + + + + + + + + + + + + + Paints the cell background + + + + + + + + Paints the cell content + + + + + + + + + + + + DrawControl + + + + + + + + + + + DrawText + + + + + + + + + MustRenderVisibleControl + + + + + + Gets the background bounds for the given cell + + + + + + + + Gets the button bounds for the given cell + + + + + + + GetValue + + + + + + + GetTextAlignment + + + + + + + Determines if the given part is set + + + + + + + + Gets the Type of the editing control associated with the cell + + + + + Constructor + + + + + Resets style to default value. Used by windows forms designer. + + + + + Indicates whether property should be serialized by Windows Forms designer. + + + + + Resets the property to default value. + + + + + DoButtonClearClick + + + + + + + DoButtonCustomClick + + + + + + + DoButtonCustom2Click + + + + + + + DoButtonDropDownClick + + + + + + + Gets the cell paint bitmap + + + + + + + Invokes BeforeCellPaint user events + + Row index + Column index + + + + Clones the ButtonX Column + + + + + + Dispose + + + + + + Occurs right before a MaskedTextBoxAdv Cell is painted + + + + + Occurs when Clear button is clicked and allows you + to cancel the default action performed by the button + + + + + Occurs when ButtonCustom control is clicked + + + + + Occurs when ButtonCustom2 control is clicked + + + + + Occurs when Drop-Down button is clicked and allows you to cancel showing of the popup + + + + + Gets the underlying MaskedTextBoxAdv control + + + + + Gets or sets a value indicating whether PromptChar can be entered as valid data. + + + + + Gets or sets a value indicating whether characters outside of the ASCII character set will be accepted. + + + + + Gets or sets the Background color. + + + + + Specifies the background style of the control. + + + + + Gets or sets a value indicating whether the masked text box + control raises the system beep for each user key stroke that it rejects. + + + + + Gets the object that describes the settings for the button + that clears the content of the control when clicked. + + + + + Gets the object that describes the settings for the custom button + that can execute an custom action of your choosing when clicked. + + + + + Gets the object that describes the settings for the custom button that can execute an custom action of your choosing when clicked. + + + + + Gets the object that describes the settings for the button + that shows drop-down when clicked. + + + + + Gets or sets the culture information associated with the masked text box. + + + + + Gets or sets a value that determines whether + literals and prompt characters are copied to the clipboard + + + + + Gets or sets whether the control + will be displayed for the current cell only. + + + + + Gets or sets the reference of the control that will be + displayed on popup that is shown when the drop-down button is clicked. + + + + + Gets or sets whether the control can respond to user interaction + + + + + Gets or sets the color used as background color to highlight + the text box when it has input focus and FocusHighlight is enabled. + + + + + Gets or sets whether FocusHighlightColor is used as + background color to highlight the text box when it has + input focus. Default value is false. + + + + + Gets or sets the foreground color. + + + + + Gets or sets a value indicating whether the prompt characters + in the input mask are hidden when the masked text box loses focus. + + + + + Gets or sets the Input Method Editor (IME) mode of the control. + + + + + Gets or sets the text insertion mode of the masked text box control. + + + + + Gets or sets the input mask to use at run time. + + + + + Gets or sets the character to be displayed in substitute for user input. + + + + + Gets or sets the character used to represent the absence of user input. + + + + + Gets or sets a value indicating whether the parsing of + user input should stop after the first invalid character is reached. + + + + + Gets or sets a value that determines how an input + character that matches the prompt character should be handled. + + + + + Gets or sets a value that determines how + a space input character should be handled. + + + + + Gets or sets a value indicating whether control's + elements are aligned to support locales using right-to-left fonts. + + + + + Gets or sets a value indicating + whether the user is allowed to reenter literal values. + + + + + Gets or sets the text as it is currently displayed to the user. + + + + + Gets or sets how text is aligned in a masked text box control. + + + + + Gets or sets a value that determines whether literals + and prompt characters are included in the formatted string. + + + + + Gets or sets a value indicating whether + the operating system-supplied password character should be used. + + + + + Gets or sets the data type used to verify the data input by the user. + + + + + Gets or sets the watermark hiding behaviour. Default value + indicates that watermark is hidden when control receives input focus. + + + + + Gets or sets the watermark text color. + + + + + Gets or sets whether watermark text is + displayed when control is empty. Default value is true. + + + + + Gets or sets the watermark font. + + + + + Gets or sets the watermark (tip) text displayed inside of + the control when Text is not set and control does not have + input focus. This property supports text-markup. + + + + + Gets the Cell paint setting for the control + + + + + Initializes a new instance of the MaskedTextBoxAdv class. + + + + + Initializes a new instance of the MaskedTextBoxAdv class using the specified input mask. + + A custom mask language provider, derived from the MaskedTextProvider class. + + + + Initializes a new instance of the MaskedTextBoxAdv class using the specified input mask. + + Initializes a new instance of the MaskedTextBox class using the specified input mask. + + + + Raises TypeValidationCompleted event. + + + + + Raises the TextAlignChanged event. + + + + + Raises MaskInputRejected event. + + + + + + Raises the MaskChanged event. + + + + + Raises IsOverwriteModeChanged event. + + + + + Resets style to default value. Used by windows forms designer. + + + + + Shows drop-down popup. Note that popup will be shown only if there is a DropDownControl assigned or DropDownItems collection has at least one item. + + + + + Closes the drop-down popup if it is open. + + + + + Raises the ButtonClearClick event. + + + + + + Raises the ButtonDropDownClick event. + + + + + + Indicates whether property should be serialized by Windows Forms designer. + + + + + Resets the property to default value. + + + + + Gets whether property should be serialized by Windows Forms designer. + + + + + Converts the user input string to an instance of the validating type. + + If successful, an Object of the type specified by the ValidatingType property; otherwise, null to indicate conversion failure. + + + + Returns a string that represents the current masked text box. This method overrides ToString. + + A String that contains information about the current MaskedTextBox. The string includes the type, a simplified view of the input string, and the formatted input string. + + + + Called when Command property value changes. + + + + + Occurs when Clear button is clicked and allows you to cancel the default action performed by the button. + + + + + Occurs when Drop-Down button that shows popup is clicked and allows you to cancel showing of the popup. + + + + + Occurs when ButtonCustom control is clicked. + + + + + Occurs when ButtonCustom2 control is clicked. + + + + + Occurs after the insert mode has changed + + + + + Occurs after the input mask is changed. + + + + + Occurs when the user's input or assigned character does not match the corresponding format element of the input mask. + + + + + Occurs when the text alignment is changed. + + + + + Occurs when MaskedTextBox has finished parsing the current value using the ValidatingType property. + + + + + Specifies back color when Enabled=false + + + + + Gets or sets whether FocusHighlightColor is used as background color to highlight text box when it has input focus. Default value is false. + + + + + Gets or sets the color used as background color to highlight text box when it has input focus and focus highlight is enabled. + + + + + Specifies the background style of the control. + + + + + Gets the object that describes the settings for the button that shows drop-down when clicked. + + + + + Gets the object that describes the settings for the button that clears the content of the control when clicked. + + + + + Gets the object that describes the settings for the custom button that can execute an custom action of your choosing when clicked. + + + + + Gets the object that describes the settings for the custom button that can execute an custom action of your choosing when clicked. + + + + + Gets or sets the reference of the control that will be displayed on popup that is shown when drop-down button is clicked. + + + + + Gets the collection of BaseItem derived items displayed on popup menu. + + + + + Gets the reference to internal MaskedTextBox control. + + + + + Gets or sets whether watermark text is displayed when control is empty. Default value is true. + + + + + Gets or sets the watermark (tip) text displayed inside of the control when Text is not set and control does not have input focus. This property supports text-markup. + + + + + Gets or sets the watermark font. + + + + + Gets or sets the watermark text color. + + + + + Gets or sets the watermark hiding behaviour. Default value indicates that watermark is hidden when control receives input focus. + + + + + Gets or sets a value indicating whether PromptChar can be entered as valid data by the user. Default value is true. + + + + + Gets or sets a value indicating whether the MaskedTextBox control accepts characters outside of the ASCII character set. + true if only ASCII is accepted; false if the MaskedTextBox control can accept any arbitrary Unicode character. The default is false. + + + + + Gets or sets a value indicating whether the masked text box control raises the system beep for each user key stroke that it rejects. + + + + + Gets or sets the culture information associated with the masked text box. + + + + + Gets or sets a value that determines whether literals and prompt characters are copied to the clipboard. + + + + + Gets or sets the IFormatProvider to use when performing type validation. + + + + + Gets or sets a value indicating whether the prompt characters in the input mask are hidden when the masked text box loses focus. + + + + + Gets or sets the text insertion mode of the masked text box control. + + + + + Gets or sets the input mask to use at run time. The default value is the empty string which allows any input + + + + + Gets a value indicating whether all required inputs have been entered into the input mask. Returns true if all required input has been entered into the mask; otherwise, false. + + + + + Gets a clone of the mask provider associated with this instance of the masked text box control. Returns masking language provider of type MaskedTextProvider. + + + + + Gets a value indicating whether all required and optional inputs have been entered into the input mask. Returns true if all required and optional inputs have been entered; otherwise, false. + + + + + Gets or sets the character to be displayed in substitute for user input. + + + + + Gets or sets the character used to represent the absence of user input in MaskedTextBox. Returns character used to prompt the user for input. The default is an underscore (_). + + + + + Gets or sets whether text in control is read only. Default value is false. + + + + + Gets or sets a value indicating whether the parsing of user input should stop after the first invalid character is reached. Returns true if processing of the input string should be terminated at the first parsing error; otherwise, false if processing should ignore all errors. The default is false. + + + + + Gets or sets a value that determines how an input character that matches the prompt character should be handled. Returns true if the prompt character entered as input causes the current editable position in the mask to be reset; otherwise, false to indicate that the prompt character is to be processed as a normal input character. The default is true. + + + + + Gets or sets a value that determines how a space input character should be handled. Returns true if the space input character causes the current editable position in the mask to be reset; otherwise, false to indicate that it is to be processed as a normal input character. The default is true. + + + + + Gets or sets a value indicating the currently selected text in the control. + + + + + Gets or sets the number of characters selected in the text box. + + + + + Gets or sets the starting point of text selected in the text box. + + + + + Gets or sets a value indicating whether the defined shortcuts are enabled. + + + + + Gets or sets the text as it is currently displayed to the user. + + + + + Gets or sets how text is aligned in a masked text box control. + + + + + Gets the length of the displayed text. + + + + + Gets or sets a value that determines whether literals and prompt characters are included in the formatted string. + + + + + Gets or sets a value indicating whether the operating system-supplied password character should be used. + + + + + Gets or sets the data type used to verify the data input by the user. Returns Type representing the data type used in validation. The default is null. + + + + + Gets the preferred height for a masked text box. + + + + + Gets or sets the command assigned to the item. Default value is null. + Note that if this property is set to null Enabled property will be set to false automatically to disable the item. + + + + + Gets or sets user defined data value that can be passed to the command when it is executed. + + + + + Handles OnTextChanged events + + + + + + ApplyCellStyleToEditingControl + + + + + + Gets EditingControlFormattedValue + + + + + + + Gets whether the given key wants to be processed + by the Control + + + + + + + + PrepareEditingControlForEdit + + + + + + Gets or sets the DataGridView + + + + + Gets or sets the Control Formatted Value + + + + + Gets or sets the Control RoeIndex + + + + + Gets or sets the Control ValueChanged state + + + + + Gets the Panel Cursor + + + + + Gets whether to RepositionEditingControlOnValueChange + + + + + Cell painting + + + + + + + + + + + + + + + + Paints the Button background + + + + + + + + Paints the button background and content + + + + + + + + + + + OnMouseEnter + + + + + + Processes MouseLeave events + + + + + + Processes MouseMove events + + + + + + Processes MouseDown events + + + + + + Processes MouseUp events + + + + + + Determines if the given part is set + + + + + + + + Gets the background bounds for the given cell + + + + + + + + Gets the content bounds for the given cell + + + + + + + + GetValue + + + + + + + + Gets the Type of the editing control associated with the cell + + + + + FormattedValueType + + + + + Constructor + + + + + Gets whether ChunkColor property should be serialized. + + + + + Resets the ChunkColor property to its default value. + + + + + Gets whether ChunkColor property should be serialized. + + + + + Resets the ChunkColor property to its default value. + + + + + Hooks or unhooks our system events + + + + + + ProgressBarItem_Click + + + + + + + Gets the cell paint bitmap + + + + + + + Invokes BeforeCellPaint user events + + Row index + Column index + + + + Clones the ButtonX Column + + + + + + Dispose + + + + + + Button FlatStyle + + + + + Button UseColumnTextForButtonValue + + + + + InCallBack + + + + + Gets the Control ProgressBarX + + + + + Gets or sets the color of the progress chunk. + + + + + Gets or sets the target gradient color of the progress chunk. + + + + + Gets or sets the gradient angle of the progress chunk. + + + + + Gets or sets the predefined color state table for progress bar. Color + specified applies to items with Office 2007 style only. It does not have + any effect on other styles. You can use ColorTable to indicate the state + of the operation that Progress Bar is tracking. Default value is eProgressBarItemColor.Normal. + + + + + Gets or sets the maximum value of the range of the control. + + + + + Gets or sets the minimum value of the range of the control. + + + + + Gets/Sets the visual style for the control. + + + + + Gets or sets the default Text to display on the Progress Bar + + + + + Gets or sets whether the text inside the progress bar is displayed. + + + + + Gets or sets the current position of the progress bar. + + + + + Gets the Cell paint setting for the ButtonX control + + + + + GetAdjustedEditingControlBounds + + + + + + + + GetPreferredSize + + + + + + + + + + Cell painting + + + + + + + + + + + + + + + + Paints the Slider background + + + + + + + + Paints the Slider content + + + + + + + + + + + OnMouseEnter + + + + + + Process MouseEnter state + + + + + + + Processes MouseLeave events + + + + + + Processes MouseMove events + + + + + + Processes MouseDown events + + + + + + Processes MouseUp events + + + + + + CellAlignPoint + + + + + + + + GetSliderValue + + + + + + + Determines if the given part is set + + + + + + + + Gets the background bounds for the given cell + + + + + + + + Gets the content bounds for the given cell + + + + + + + Initiates the refresh of the cell slider + + + + + + + Gets the Type of the editing control associated with the cell + + + + + Gets the type of the underlying data + (i.e., the type of the cell's Value property) + + + + + Constructor + + + + + Returns whether property should be serialized. Used by Windows Forms designer. + + + + + Resets the property to default value. Used by Windows Forms designer. + + + + + Hooks or unhooks our system events + + + + + + SliderItem_Click + + + + + + + SliderItem_ValueChanged + + + + + + + Gets the cell paint bitmap + + + + + + + Invokes BeforeCellPaint user events + + Row index + Column index + + + + Clones the ButtonX Column + + + + + + Dispose + + + + + + Occurs right before a Slider Cell is painted + + + + + Gets or sets the active row index + + + + + Gets or sets the DataBindingComplete state + + + + + Gets the Control Slider + + + + + Gets or sets whether the control can respond to user interaction + + + + + Gets or sets whether text-markup support is enabled for items Text property. Default value is true. + Set this property to false to display HTML or other markup in the item instead of it being parsed as text-markup. + + + + + Gets or sets the text label position in relationship to the slider. Default value is Left. + + + + + Gets or sets whether the text label next to the slider is displayed. + + + + + Gets or sets the width of the label part of the item in pixels. Value must be greater than 0. Default value is 38. + + + + + Gets or sets the maximum value of the range of the control. + + + + + Gets or sets the minimum value of the range of the control. + + + + + Gets or sets the amount by which a call to the PerformStep method increases the current position of the slider. Value must be greater than 0. + + + + + Gets or sets the text associated with this item. + + + + + Gets or sets the color of the label text. + + + + + Gets or sets whether vertical line track marker is displayed on the slide line. Default value is true. + + + + + Gets or sets the current position of the slider. + + + + + Gets the Cell paint setting for the ButtonX control + + + + + InitializeEditingControl + + + + + + + + DetachEditingControl + + + + + ButtonClearClick + + + + + + + ButtonCustomClick + + + + + + + ButtonCustom2Click + + + + + + + ButtonDropDownClick + + + + + + + KeyDown routine forwards all DataGridView sent keys to + the underlying focusable control + + + + + + + PositionEditingControl + + + + + + + + + + + + + + GetAdjustedEditingControlBounds + + + + + + + + Cell painting + + + + + + + + + + + + + + + + Paints the cell background + + + + + + + + Paints the cell content + + + + + + + + + + + + DrawControl + + + + + + + + + + DrawText + + + + + + + + + Gets the background bounds for the given cell + + + + + + + + Gets the button bounds for the given cell + + + + + + + GetValue + + + + + + + GetTextAlignment + + + + + + + Determines if the given part is set + + + + + + + + Gets the Type of the editing control associated with the cell + + + + + Constructor + + + + + Resets style to default value. Used by windows forms designer. + + + + + Indicates whether property should be serialized by Windows Forms designer. + + + + + Resets the property to default value. + + + + + Appends text to the current text of a text box. + + The text to append to the current contents of the text box. + + + + Clears all text from the text box control. + + + + + Clears information about the most recent operation from the undo buffer of the text box. + + + + + Copies the current selection in the text box to the Clipboard. + + + + + Moves the current selection in the text box to the Clipboard. + + + + + Specifies that the value of the SelectionLength + property is zero so that no characters are selected in the control. + + + + + Retrieves the character that is closest to the specified location within the control. + + The location from which to seek the nearest character. + The character at the specified location. + + + + Retrieves the index of the character nearest to the specified location. + + The location to search. + The zero-based character index at the specified location. + + + + Retrieves the index of the first character of a given line. + + The line for which to get the index of its first character. + The zero-based character index in the specified line. + + + + Retrieves the index of the first character of the current line. + + The zero-based character index in the current line. + + + + Retrieves the line number from the specified character position within the text of the control. + + The character index position to search. + The zero-based line number in which the character index is located. + + + + Retrieves the location within the control at the specified character index. + + The index of the character for which to retrieve the location. + The location of the specified character. + + + + Replaces the current selection in the text box with the contents of the Clipboard. + + + + + Selects a range of text in the text box. + + The position of the first character in the current text selection within the text box. + The number of characters to select. + + + + Selects all text in the text box. + + + + + Undoes the last edit operation in the text box. + + + + + Replaces the specified selection in the TextBox with the contents of the Clipboard. + + The text to replace. + + + + DoButtonClearClick + + + + + + + DoButtonCustomClick + + + + + + + DoButtonCustom2Click + + + + + + + DoButtonDropDownClick + + + + + + + Gets the cell paint bitmap + + + + + + + Invokes BeforeCellPaint user events + + Row index + Column index + + + + Clones the ButtonX Column + + + + + + Dispose + + + + + + Occurs right before a TextBoxDropDown Cell is painted + + + + + Occurs when Clear button is clicked and allows you + to cancel the default action performed by the button + + + + + Occurs when ButtonCustom control is clicked + + + + + Occurs when ButtonCustom2 control is clicked + + + + + Occurs when Drop-Down button is clicked and allows you to cancel showing of the popup + + + + + Gets the underlying TextBoxDropDown control + + + + + Gets or sets a custom StringCollection to use when + the AutoCompleteSource property is set to CustomSource. + A StringCollection to use with AutoCompleteSource. + + + + + Gets or sets an option that controls + how automatic completion works for the TextBox. + One of the values of AutoCompleteMode. The values are Append, + None, Suggest, and SuggestAppend. The default is None. + + + + + Gets or sets a value specifying the source of complete strings used for automatic completion. + One of the values of AutoCompleteSource. The options are AllSystemSources, AllUrl, FileSystem, HistoryList, RecentlyUsedList, CustomSource, and None. The default is None. + + + + + Gets or sets the Background color. + + + + + Specifies the background style of the control. + + + + + Gets the object that describes the settings for the button + that clears the content of the control when clicked. + + + + + Gets the object that describes the settings for the custom button + that can execute an custom action of your choosing when clicked. + + + + + Gets the object that describes the settings for the custom button that can execute an custom action of your choosing when clicked. + + + + + Gets the object that describes the settings for the button + that shows drop-down when clicked. + + + + + Gets or sets whether the TextBox control + modifies the case of characters as they are typed. + One of the CharacterCasing enumeration values that specifies + whether the TextBox control modifies the case of characters. + The default is CharacterCasing.Normal. + + + + + Gets or sets whether the control + will be displayed for the current cell only. + + + + + Gets or sets the reference of the control that will be + displayed on popup that is shown when the drop-down button is clicked. + + + + + Gets or sets whether the control can respond to user interaction + + + + + Gets or sets the color used as background color to highlight + the text box when it has input focus and FocusHighlight is enabled. + + + + + Gets or sets whether FocusHighlightColor is used as + background color to highlight the text box when it has + input focus. Default value is false. + + + + + Gets or sets the foreground color. + + + + + Gets or sets a value indicating whether the selected text in + the text box control remains highlighted when the control loses focus. + true if the selected text does not appear highlighted when the + text box control loses focus; false, if the selected text remains + highlighted when the text box control loses focus. The default is true. + + + + + Gets or sets the Input Method Editor (IME) mode of the control. + + + + + Gets or sets the maximum number of characters the user can type or paste into the text box control. + The number of characters that can be entered into the control. The default is 32767. + + + + + Gets or sets the character to be displayed in substitute for user input. + + + + + Gets or sets a value indicating whether control's + elements are aligned to support locales using right-to-left fonts. + + + + + Gets or sets a value indicating the currently selected text in the control. + A string that represents the currently selected text in the text box. + + + + + Gets or sets the number of characters selected in the text box. + The number of characters selected in the text box. + + + + + Gets or sets the starting point of text selected in the text box. + The starting position of text selected in the text box. + + + + + Gets or sets the text as it is currently displayed to the user. + + + + + Gets or sets how text is aligned in a masked text box control. + + + + + Gets the length of text in the control. + Returns number of characters contained in the text of the control. + + + + + Gets or sets a value indicating whether + the operating system-supplied password character should be used. + + + + + Gets or sets the watermark hiding behaviour. Default value + indicates that watermark is hidden when control receives input focus. + + + + + Gets or sets the watermark text color. + + + + + Gets or sets whether watermark text is + displayed when control is empty. Default value is true. + + + + + Gets or sets the watermark font. + + + + + Gets or sets the watermark (tip) text displayed inside of + the control when Text is not set and control does not have + input focus. This property supports text-markup. + + + + + Gets the Cell paint setting for the control + + + + + Represents single line text box control with the drop down button to display custom control on popup and additional custom buttons. + + + + + Raises BeforeMultiColumnPopupOpen event. + + Provides event arguments. + + + + Initializes a new instance of the TextBoxDropDown class. + + + + + Raises the TextAlignChanged event. + + + + + Resets style to default value. Used by windows forms designer. + + + + + Shows drop-down popup. Note that popup will be shown only if there is a DropDownControl assigned or DropDownItems collection has at least one item. + + + + + Closes the drop-down popup if it is open. + + + + + Raises the ButtonClearClick event. + + + + + + Raises the ButtonDropDownClick event. + + + + + + Called when DropDownControl property has changed. + + + + + Indicates whether property should be serialized by Windows Forms designer. + + + + + Resets the property to default value. + + + + + Called when Command property value changes. + + + + + Returns a string that represents the current text in text box. This method overrides ToString. + + A String that contains information about the current TextBox. The string includes the type, a simplified view of the input string, and the formatted input string. + + + + Appends text to the current text of a text box. + + The text to append to the current contents of the text box. + + + + Clears all text from the text box control. + + + + + Clears information about the most recent operation from the undo buffer of the text box. + + + + + Copies the current selection in the text box to the Clipboard. + + + + + Moves the current selection in the text box to the Clipboard. + + + + + Specifies that the value of the SelectionLength property is zero so that no characters are selected in the control. + + + + + Retrieves the character that is closest to the specified location within the control. + + The location from which to seek the nearest character. + The character at the specified location. + + + + Retrieves the index of the character nearest to the specified location. + + The location to search. + The zero-based character index at the specified location. + + + + Retrieves the index of the first character of a given line. + + The line for which to get the index of its first character. + The zero-based character index in the specified line. + + + + Retrieves the index of the first character of the current line. + + The zero-based character index in the current line. + + + + Retrieves the line number from the specified character position within the text of the control. + + The character index position to search. + The zero-based line number in which the character index is located. + + + + Retrieves the location within the control at the specified character index. + + The index of the character for which to retrieve the location. + The location of the specified character. + + + + Replaces the current selection in the text box with the contents of the Clipboard. + + + + + Selects a range of text in the text box. + + The position of the first character in the current text selection within the text box. + The number of characters to select. + + + + Selects all text in the text box. + + + + + Undoes the last edit operation in the text box. + + + + + Replaces the specified selection in the TextBox with the contents of the Clipboard. + + The text to replace. + + + + Occurs when Clear button is clicked and allows you to cancel the default action performed by the button. + + + + + Occurs when Drop-Down button that shows popup is clicked and allows you to cancel showing of the popup. + + + + + Occurs when ButtonCustom control is clicked. + + + + + Occurs when ButtonCustom2 control is clicked. + + + + + Occurs when the text alignment is changed. + + + + + Occurs when the value of the Modified property has changed. + + + + + Occurs before the popup is opened and it allows canceling of popup by setting CancelEventArgs.Cancel=true. + + + + + Indicates whether all text is auto-selected when control gets input focus. Default value is false. + + + + + Gets or sets whether FocusHighlightColor is used as background color to highlight text box when it has input focus. Default value is false. + + + + + Gets or sets the color used as background color to highlight text box when it has input focus and focus highlight is enabled. + + + + + Specifies the background style of the control. + + + + + Gets the object that describes the settings for the button that shows drop-down when clicked. + + + + + Gets the object that describes the settings for the button that clears the content of the control when clicked. + + + + + Gets the object that describes the settings for the custom button that can execute an custom action of your choosing when clicked. + + + + + Gets the object that describes the settings for the custom button that can execute an custom action of your choosing when clicked. + + + + + Gets or sets a value indicating whether the drop-down is open. + + + + + Indicates whether DropDownControl is automatically focused when popup is open. + + + + + Gets or sets the reference of the control that will be displayed on popup that is shown when drop-down button is clicked. + + + + + Gets the collection of BaseItem derived items displayed on popup menu. + + + + + Gets the reference to internal TextBox control. Use it to get access to the text box events and properties. + + + + + Gets or sets whether watermark text is displayed when control is empty. Default value is true. + + + + + Gets or sets the watermark (tip) text displayed inside of the control when Text is not set and control does not have input focus. This property supports text-markup. + + + + + Gets or sets the watermark font. + + + + + Gets or sets the watermark text color. + + + + + Gets or sets the watermark hiding behaviour. Default value indicates that watermark is hidden when control receives input focus. + + + + + Gets or sets the watermark image displayed inside of the control when Text is not set and control does not have input focus. + + + + + Gets or sets the watermark image alignment. + + + + + Gets or sets the command assigned to the item. Default value is null. + Note that if this property is set to null Enabled property will be set to false automatically to disable the item. + + + + + Gets or sets user defined data value that can be passed to the command when it is executed. + + + + + Gets or sets the text as it is currently displayed to the user. + + + + + Gets the preferred height for a text box. + + + + + Gets or sets a custom StringCollection to use when the AutoCompleteSource property is set to CustomSource. + A StringCollection to use with AutoCompleteSource. + + + + + Gets or sets an option that controls how automatic completion works for the TextBox. + One of the values of AutoCompleteMode. The values are Append, None, Suggest, and SuggestAppend. The default is None. + + + + + Gets or sets a value specifying the source of complete strings used for automatic completion. + One of the values of AutoCompleteSource. The options are AllSystemSources, AllUrl, FileSystem, HistoryList, RecentlyUsedList, CustomSource, and None. The default is None. + + + + + Gets or sets whether the TextBox control modifies the case of characters as they are typed. + One of the CharacterCasing enumeration values that specifies whether the TextBox control modifies the case of characters. The default is CharacterCasing.Normal. + + + + + Gets or sets the character used to mask characters of a password in a single-line TextBox control. + The character used to mask characters entered in a single-line TextBox control. Set the value of this property to 0 (character value) if you do not want the control to mask characters as they are typed. Equals 0 (character value) by default. + + + + + Gets or sets how text is aligned in a TextBox control. + One of the HorizontalAlignment enumeration values that specifies how text is aligned in the control. The default is HorizontalAlignment.Left. + + + + + Gets or sets a value indicating whether the text in the TextBox control should appear as the default password character. + true if the text in the TextBox control should appear as the default password character; otherwise, false. + + + + + Gets or sets a value indicating whether the selected text in the text box control remains highlighted when the control loses focus. + true if the selected text does not appear highlighted when the text box control loses focus; false, if the selected text remains highlighted when the text box control loses focus. The default is true. + + + + + Gets or sets the maximum number of characters the user can type or paste into the text box control. + The number of characters that can be entered into the control. The default is 32767. + + + + + Gets or sets a value that indicates that the text box control has been modified by the user since the control was created or its contents were last set. + true if the control's contents have been modified; otherwise, false. The default is false. + + + + + Gets or sets a value indicating whether text in the text box is read-only. + true if the text box is read-only; otherwise, false. The default is false. + + + + + Gets or sets a value indicating the currently selected text in the control. + A string that represents the currently selected text in the text box. + + + + + Gets or sets the number of characters selected in the text box. + The number of characters selected in the text box. + + + + + Gets or sets the starting point of text selected in the text box. + The starting position of text selected in the text box. + + + + + Gets the length of text in the control.Returns number of characters contained in the text of the control. + + + + + Handles OnTextChanged events + + + + + + ApplyCellStyleToEditingControl + + + + + + Gets EditingControlFormattedValue + + + + + + + Gets whether the given key wants to be processed + by the Control + + + + + + + + PrepareEditingControlForEdit + + + + + + Gets or sets the DataGridView + + + + + Gets or sets the Control Formatted Value + + + + + Gets or sets the Control RoeIndex + + + + + Gets or sets the Control ValueChanged state + + + + + Gets the Panel Cursor + + + + + Gets whether to RepositionEditingControlOnValueChange + + + + + Displays the desktop alerts with optional image or symbol. Text on alerts supports text-markup. + + + + + Shows desktop alert. + + Text to show on the alert. Text supports text-markup. + + + + Shows desktop alert. + + Text to show on the alert. Text supports text-markup. + Specifies reference control which is used to find target screen alert is displayed on. + + + + Shows desktop alert. + + Text to show on the alert. Text supports text-markup. + Text-markup link click event handler. + + + + Shows desktop alert. + + Text to show on the alert. Text supports text-markup. + Specifies alert color. + + + + Shows desktop alert. + + Text to show on the alert. Text supports text-markup. + Specifies alert color. + Specifies reference control which is used to find target screen alert is displayed on. + + + + Shows desktop alert at specific screen position. + + Text to show on the alert. Text supports text-markup. + Alert position on the screen. + + + + Shows desktop alert at specific screen position. + + Text to show on the alert. Text supports text-markup. + Alert position on the screen. + Specifies reference control which is used to find target screen alert is displayed on. + + + + Shows desktop alert at specific screen position. + + Text to show on the alert. Text supports text-markup. + Image to display on alert. + + + + Shows desktop alert. + + Text to show on the alert. Text supports text-markup. + Alert color. + Alert position on the screen. + + + + Shows desktop alert. + + Text to show on the alert. Text supports text-markup. + Alert color + Alert position on the screen + Text-markup link click event handler. + Specifies reference control which is used to find target screen alert is displayed on. + + + + Shows desktop alert. + + Text to show on the alert. Text supports text-markup. + Alert color + Alert position on the screen + Text-markup link click event handler. + + + + Shows desktop alert. + + Text to show on the alert. Text supports text-markup. + Alert ID used to recognize alert if clicked and specified Action is called + Action method to call if alert is clicked. + + + + Shows desktop alert. + + Text to show on the alert. Text supports text-markup. + Alert color + Alert ID used to recognize alert if clicked and specified Action is called + Action method to call if alert is clicked. + + + + Shows desktop alert. + + Text to show on the alert. Text supports text-markup. + Symbol to show on the alert, see http://www.devcomponents.com/kb2/?p=1347 + Symbol set to use + Symbol color or Color.Empty to use default text color + Alert color + Alert position on the screen + Duration of alert in the seconds. + Alert ID used to recognize alert if clicked and specified Action is called + Action method to call if alert is clicked. + + + + Shows desktop alert. + + Text to show on the alert. Text supports text-markup. + Symbol to show on the alert, see http://www.devcomponents.com/kb2/?p=1347 + Symbol set to use + Symbol color or Color.Empty to use default text color + Alert position on the screen + Alert color + Duration of alert in the seconds. + Alert ID used to recognize alert if clicked and specified Action is called + Action method to call if alert is clicked. + Text-markup link click event handler. + + + + Shows desktop alert. + + Text to show on the alert. Text supports text-markup. + Symbol to show on the alert, see http://www.devcomponents.com/kb2/?p=1347 + Symbol set to use + Symbol color or Color.Empty to use default text color + Alert position on the screen + Alert color + Duration of alert in the seconds. + Alert ID used to recognize alert if clicked and specified Action is called + Action method to call if alert is clicked. + Text-markup link click event handler. + Specifies reference control which is used to find target screen alert is displayed on. + + + + Shows desktop alert. + + Text to show on the alert. Text supports text-markup. + Image to display on the alert + Alert screen position + Alert color + Duration of alert in seconds + Alert ID used to recognize alert if clicked and specified Action is called + Action method to call if alert is clicked. + + + + Shows desktop alert. + + Text to show on the alert. Text supports text-markup. + Image to display on the alert + Alert screen position + Alert color + Duration of alert in seconds + Alert ID used to recognize alert if clicked and specified Action is called + Action method to call if alert is clicked. + Text-markup link click event handler. + + + + Shows desktop alert. + + Text to show on the alert. Text supports text-markup. + Image to display on the alert + Alert screen position + Alert color + Duration of alert in seconds + Alert ID used to recognize alert if clicked and specified Action is called + Action method to call if alert is clicked. + Text-markup link click event handler. + Specifies reference control which is used to find target screen alert is displayed on. + + + + Raises BeforeAlertDisplayed event. + + Provides event arguments. + + + + Raises RemovingToken event. + + Provides event arguments. + + + + Indicates maximum alert size. + + + + + Specifies default alert screen position. + + + + + Specifies default alert color. + + + + + Gets or sets the total time in milliseconds alert animation takes. + Default value is 200. + + + + + Gets or sets time period in seconds after alert closes automatically. + + + + + Gets or sets whether text-markup can be used in alert text, default value is true. + + + + + Indicates whether alert plays exclamation sound when shown. + + + + + Occurs before alert is displayed and allows access to the alert Window through sender. + + + + + Occurs after alert as been closed. + + + + + Defines delegate for AlertClosed event. + + Sender. + Event arguments + + + + Defines event arguments for AlertClosed event. + + + + + Specifies alert closure source. + + + + + Defines predefined desktop alert colors. + + + + + Sets alert size based on its content, it respects MinimumSize and MaximumSize property settings. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Called when Symbol property has changed. + + Old property value + New property value + + + + Called when SymbolSet property value changes. + + Indciates old value + Indicates new value + + + + Called when SymbolSize property has changed. + + Old property value + New property value + + + + Called when TextMarkupEnabled property has changed. + + Old property value + New property value + + + + Occurs when text markup link is clicked. + + + + + Raises MarkupLinkClick event. + + Provides event arguments. + + + + Display balloon. + + Indicates whether alert receives input focus upon showing. + + + + Displays balloon. + + + + + Called when alert needs to be hidden. + + + + + Hides balloon. + + + + + Gets or sets the color of the Symbol. + + + + + Gets the realized symbol string. + + + + + Indicates the symbol displayed on face of the button instead of the image. Setting the symbol overrides the image setting. + + + + + Gets or sets the symbol set used to represent the Symbol. + + + + + Indicates the size of the symbol in points. + + + + + Indicates image displayed on alert. + + + + + Indicates optional Alert Id. + + + + + Indicates the method that will be invoked if user clicks the alert. + + + + + Gets or sets whether text-markup can be used in Text property. + + + + + Occurs when text markup link is clicked. Markup links can be created using "a" tag, for example: + Markup link + + + + + Gets reference to parsed markup body element if text was markup otherwise returns null. + + + + + Gets or sets the default alert size. + + + + + Gets or sets the total time in milliseconds alert animation takes. + Default value is 200. + + + + + Gets or sets whether balloon will close automatically when user click the close button. + + + + + Gets or sets time period in seconds after alert closes automatically. + + + + + Specifies the reference control which is used to find which screen the alert is displayed on. If not specified alert is displayed on primary screen. + + + + + Indicates spacing between alerts on the screen + + + + + Indicates the request screen position for the alert + + + + + Indicates spacing in pixels between image and text + + + + + Indicates whether alert plays exclamation sound when shown. + + + + + Indicates whether close button on alert is visible + + + + + Defines the alert positions. + + + + + Top-left screen position. + + + + + Top-right screen position. + + + + + Bottom-right screen position. + + + + + Bottom left screen position. + + + + + Defines closure sources for the alert. + + + + + Alert is closed becouse of timeout + + + + + Alert is closed becouse user clicked close button. + + + + + Alert is closed becouse user clicked on the alert. + + + + + Component to display flyout popup. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Called when Content property has changed. + + Old property value + New property value + + + + Called when PointerSide property has changed. + + Old property value + New property value + + + + Called when TargetControl property has changed. + + Old property value + New property value + + + + Called when DeepControlIntegration property has changed. + + Old property value + New property value + + + + Called when DisplayMode property has changed. + + Old property value + New property value + + + + Called when CloseMode property has changed. + + Old property value + New property value + + + + Raises PrepareContent event. + + Provides event arguments. + + + + Shows flyout with the Content. + + + + + Returns the flyout size based on Content size. + + Proposed flyout size. + + + + Shows flyout at specified location and with specified size. Size can be empty (0,0) and flyout will be automatically sized based on the content. + + + + + + Raises FlyoutShowing event. + + Provides event arguments. + + + + Raises FlyoutShown event. + + Provides event arguments. + + + + Raises QueryShowFlyout event. + + Provides event arguments. + + + + Shows flyout at specified location and with specified size. Size can be empty (0,0) and flyout will be automatically sized based on the content. + + Screen bounds to display flyout at. + Side of the flyout which will have pointer triangle + Pointer position either x or y depending on which side pointer is displayed on. + Target item for the flyout. + + + + Raises FlyoutClosing event. + + Provides event arguments. + + + + Raises FlyoutClosed event. + + Provides event arguments. + + + + Closes the flyout form if it was open. + + + + + Called when ActivateOnShow property has changed. + + Old property value + New property value + + + + Called when TopMost property has changed. + + Old property value + New property value + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Called when DropShadow property has changed. + + Old property value + New property value + + + + Called when Parent property has changed. + + Old property value + New property value + + + + Indicates a control, usually panel with other controls inside of it, that is displayed on the flyout popup. + + + + + Indicates the side of the flyout triangle pointer is displayed on. + + + + + Indicates the target control for the flyout display and positioning. + + + + + Indicates whether Flyout integrates on item level with DotNetBar controls it recognizes like SuperTabControl, AdvTree etc. + + + + + Specifies when the flyout is displayed. + + + + + Indicates when Flyout is automatically closed. + + + + + Occurs before the flyout is shown for specific target and allows you to prepare Content for it. Sender of event will be the targeted control or item. + + + + + Occurs after flyout has been shown. + + + + + Provides opportunity to cancel showing of the flyout before any objects are created and allocated. This is preferred event to cancel flyout showing. + + + + + Occurs before flyout is closed and allows you to cancel the closing. + + + + + Occurs after flyout is closed. + + + + + Indicates whether flyout is active/focused when its shown, default value is false. + + + + + Indicates whether flyout is made top-most window when shown + + + + + Gets or sets the background flyout color. Default value is Color.Empty which indicates that current color scheme will be used. + + + + + Gets or sets the flyout border color. Default value of Color.Empty indicates that color scheme will be used. + + + + + Indicates whether flyout displays drop shadow. + + + + + Gets or sets the parent control for the Flyout. Parent is used to find the parent form so flyout can be closed when form is de-activated. + + + + + Defines delegate for the FlyoutShowing event. + + + + + + + Gets the reference to the flyout form. + + + + + Gets the reference to the flyout target usually TargetControl. + + + + + Allows you to cancel showing of the flyout by setting this value to true. + + + + + Initializes a new instance of the FlyoutShowingEventArgs class. + + + + + + + Defines the modes for Flyout display. + + + + + Flyout is displayed manually using flyout.Show() method. + + + + + Flyout is displayed when mouse is over TargetControl. + + + + + Flyout is displayed when mouse is hovering over TargetControl. + + + + + Flyout is displayed when left mouse button is clicked on TargetControl. + + + + + Defines Flyout closing condition. + + + + + Flyout is closed manually using flyout.Close() method. + + + + + Flyout is closed when user clicks outside of flyout bounds. + + + + + Flyout is closed when TargetControl is hidden. + + + + + Flyout is closed when TargetControl loses focus. + + + + + Flyout is closed when parent forms deactivates. + + + + + Defines colors for the Flyout control. + + + + + Specifies Flyout background color. + + + + + Specifies Flyout border color. + + + + + Called when PointerOffset property has changed. + + Old property value + New property value + + + + Called when PointerSide property has changed. + + Old property value + New property value + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Indicates whether flyout displays a drop shadow. + + + + + Gets or sets whether form is made active/focused when shown. + + + + + Gets or sets the pointer offset from the top-left corner + + + + + Gets or sets the side pointer triangle is displayed on. + + + + + Gets or sets the flyout border color. Default value of Color.Empty indicates that color scheme will be used. + + + + + Defines the side of triangle pointer displayed on flyout popup. + + + + + Represents graphical panel control with support for different visual styles and gradients. + + + + + Default constructor. + + + + + Called by StyleManager to notify control that style on manager has changed and that control should refresh its appearance if + its style is controlled by StyleManager. + + New active style. + + + + Applies any region related settings from style to control. + + + + + Applies color scheme colors to the style objects. + + + + + Creates the Graphics object for the control. + + The Graphics object for the control. + + + + Returns the current style of the control. + + Instance of ElementStyle object. + + + + Returns the current mouse down style of the control. + + Instance of ElementStyle object. + + + + Returns the current mouse over style of the control. + + Instance of ElementStyle object. + + + + Paints panel using Windows themes. + + Paint event arguments + + + + Prepares paint surface for paint operation. Called as first thing in Paint event. + + + + + + Paints panel given current style. + + Paint event arguments + + + + Paints insides of the control. + + Paint event arguments. + + + + Indicates whether CanvasColor should be serialized. Used by windows forms designer design-time support. + + + + + Resets CanvasColor to it's default value. Used by windows forms designer design-time support. + + + + + Resets the style to it's default value. + + + + + Resets the internal mouse tracking properties that track whether mouse is over the panel and whether is mouse pressed while over the panel. + + + + + Resets the style to it's default value. + + + + + Resets the style to it's default value. + + + + + Called after either ColorScheme or ColorSchemeStyle has changed. If you override make sure that you call base implementation so default + processing can occur. + + + + + Applies predefined Panel color scheme to the control. + + + + + Applies predefined Panel color scheme to the control. + + + + + Applies predefined Button color scheme to the control. + + + + + Applies predefined Label color scheme to the control. + + + + + Applies predefined lable style to the ElementStyle object. + + Reference to ElementStyle object. + + + + Notifies a control that it is the default button so that its appearance and behavior is adjusted accordingly. + + true if the control should behave as a default button; otherwise false. + + + + Generates a Click event for the control. + + + + + Occurs when text markup link is clicked. Markup links can be created using "a" tag, for example: + Markup link + + + + + Gets or sets Bar Color Scheme. + + + + + Gets or sets whether focus rectangle is displayed when control has focus. + + + + + Gets or sets the canvas color for the panel. Canvas color will be visible on areas of the control that do not get covered + by the style and it will also be used as a base color for style to be painted on. + + + + + Gets or sets the panel style. + + + + + Gets or sets the panel style when mouse hovers over the panel. + + + + + Gets or sets the panel style when mouse button is pressed on the panel. + + + + + Gets or sets whether anti-alias smoothing is used while painting. + + + + + Gets or sets color scheme style. + + + + + Gets or sets whether text rectangle painted on panel is considering docked controls inside the panel. + + + + + Gets or sets the text rectangle. This property is set by internal implementation and it should not be set by outside code. + + + + + Gets or sets whether painting of the control is suspended. + + + + + Gets or sets the value returned to the parent form when the button is clicked. + + + + + Specifies whether item is drawn using Themes when running on OS that supports themes like Windows XP. + + + + + Calls base WndProc implementation + + Describes Windows Message + + + + Gets the ItemPaintArgs which provide information for rendering. + + Reference to Canvas + Returns the new ItemPaintArgs instance + + + + Paints the background of the control + + PaintEventArgs arguments + + + + Converts the client point into the screen point. + + Client point + Client point converted into screen coordinates. + + + + Adjusts the client rectangle for the control. + + Reference to new client rectangle. + + + + Adjusts the border rectangle before the non-client border is rendered. + + Border rectangle + + + + Occurs after non-client area is rendered and provides opportunity to render on top of it. + + Reference to Graphics object. + + + + Gets the reference to the BorderStyle used by the control if any. + + + + + Returns the Windows handle associated with the control. + + + + + Returns width of the control. + + + + + Returns the height of the control. + + + + + Returns whether handled for the control has been created. + + + + + Returns background color of the control. + + + + + Returns background color of the control when Enabled=false. + + + + + Returns whether control is enabled. + + + + + Invalidates non-client area of the control. + + + + + Paints insides of the control. + + Paint event arguments. + + + + Returns the size of the panel calculated based on the text assigned. + + Calculated size of the panel or Size.Empty if panel size cannot be calculated. + + + + Applies color scheme to the panel. + + + + + Applies default group panel style to the control. + + + + + Returns the renderer control will be rendered with. + + The current renderer. + + + + Gets or sets the panel color scheme. + + + + + Gets or sets the image that appears in title with text. + + + + + Gets or sets the position of the title image. Default value is left. + + + + + Gets or sets the scrollbar skining type when control is using Office 2007 style. + + + + + Specifies whether item is drawn using Themes when running on OS that supports themes like Windows XP. + + + + + Gets or sets whether box around the title of the group is drawn. Default value is true. + + + + + Gets or sets whether text rectangle painted on panel is considering docked controls inside the panel. + + + + + Gets or sets whether panel automatically provides shadows for child controls. Default value is false. + + + + + Specifies back color when Enabled=false + + + + + Defines predefined color schemes for panel control. + + + + + Returns the color scheme used by control. Color scheme for Office2007 style will be retrived from the current renderer instead of + local color scheme referenced by ColorScheme property. + + An instance of ColorScheme object. + + + + Returns the renderer control will be rendered with. + + The current renderer. + + + + Gets or sets the redering mode used by control. Default value is eRenderMode.Global which means that static GlobalManager.Renderer is used. If set to Custom then Renderer property must + also be set to the custom renderer that will be used. + + + + + Gets or sets the custom renderer used by the items on this control. RenderMode property must also be set to eRenderMode.Custom in order renderer + specified here to be used. + + + + + Gets or sets whether custom styling (Office 2007 style) is enabled. Default value is true. + + + + + Recalculates the size of the internal item. + + + + + Gets whether property should be serialized. + + + + + Resets the SingleLineColor property to its default value. + + + + + Invokes the MarkupLinkClick event. + + Provides additional data about event. + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Called when Command property value changes. + + + + + Occurs when text markup link is clicked. Markup links can be created using "a" tag, for example: + Markup link + + + + + Specifies spacing between label image and text. + + + + + Gets or sets whether text-markup support is enabled for controls Text property. Default value is true. + Set this property to false to display HTML or other markup in the control instead of it being parsed as text-markup. + + + + + Gets or sets whether control displays focus cues when focused. + + + + + Gets or sets the border sides that are displayed. Default value specifies border on all 4 sides. + + + + + Gets or sets the type of the border drawn around the label. + + + + + Specifies label image. + + + + + Gets/Sets the image position inside the label. + + + + + Gets or sets the border line color when border is single line. + + + + + Gets or sets the text associated with this item. + + + + + Gets or sets the horizontal text alignment. + + + + + Gets or sets the text vertical alignment. + + + + + Gets or sets a value that determines whether text is displayed in multiple lines or one long line. + + + + + Gets or sets the left padding in pixels. + + + + + Gets or sets the right padding in pixels. + + + + + Gets or sets the top padding in pixels. + + + + + Gets or sets the bottom padding in pixels. + + + + + + Gets or sets a value indicating whether the control is automatically resized to display its entire contents. You can set MaximumSize.Width property to set the maximum width used by the control. + + + + + Gets or sets text-orientation. Default is horizontal. + + + + + Gets or sets how vertical text is rotated when TextOrientation = Vertical. + + + + + Gets the underlying LabelItem + + + + + Indicates the symbol displayed on label instead of the image. Setting the symbol overrides the image setting. + + + + + Gets or sets the symbol set used to represent the Symbol. + + + + + Indicates the size of the symbol in points. + + + + + Gets or sets the color of the symbol. + + + + + Indicates whether label text is rendered using bold font unless the Font property is specifically set to different font. + + + + + Gets or sets the command assigned to the item. Default value is null. + Note that if this property is set to null Enabled property will be set to false automatically to disable the item. + + + + + Gets or sets user defined data value that can be passed to the command when it is executed. + + + + + A single horizontal or vertical line control. + + + + + Initializes a new instance of the Line class. + + + + + Called when StartLineCap property has changed. + + Old property value + New property value + + + + Called when StartLineCapSize property has changed. + + Old property value + New property value + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Called when EndLineCap property has changed. + + Old property value + New property value + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Specifies the line alignment within control bounds. + + + + + Specifies distance from the start of a line to the beginning of a dash pattern. + + + + + Specifies the line dash style. + + + + + Gets or sets the line thickness in pixels. + + + + + Gets or sets whether vertical line is drawn. Default value is false which means horizontal line is drawn. + + + + + Gets or sets a value indicating whether the control is automatically resized to display its entire contents. You can set MaximumSize.Width property to set the maximum width used by the control. + + + + + Indicates the start of the line cap. + + + + + Indicates the size of the start cap. + + + + + Indicates the start of the line cap. + + + + + Indicates end line cap size. + + + + + Defined line end types. + + + + + Provides data for CheckStateConvert event. + + + + + Initializes a new instance of the CheckStateConvertEventArgs class. + + + + + + Represents generic base control for items container control. + + + + + Represents base control for bars. + + + + + Provides interface for controls that support ribbon customization. + + + + + Called when item contained by the container is right-clicked. + + Instance of the item that was right-clicked. + + + + Creates new accessibility instance. + + Reference to AccessibleObject. + + + + Notifies the accessibility client applications of the specified AccessibleEvents for the specified child control. + + The AccessibleEvents object to notify the accessibility client applications of. + The child Control to notify of the accessible event. + + + + Returns the collection of items with the specified name. + + Item name to look for. + + + + + Returns the collection of items with the specified name and type. + + Item name to look for. + Item type to look for. + + + + + Returns the collection of items with the specified name and type. + + Item name to look for. + Item type to look for. + Indicates whether GlobalName property is used for searching. + + + + + Returns the first item that matches specified name. + + Item name to look for. + + + + + Invokes the DotNetBar Customize dialog. + + + + + Raises BeforeItemDrag event. + + Provides event arguments. + + + + + Called when DragInProgress property value has changed. + + + + + Releases the focus from the bar and selects the control that had focus before bar was selected. If control that had focus could not be determined focus will stay on the bar. + This method is used by internal DotNetBar implementation and you should not use it. + + + + + Invokes ItemDoubleClick event. + + Reference to item double-clicked + Event arguments + + + + Invokes the ItemClick event. + + Reference to the item that was clicked. + + + + Returns the item at specified coordinates or null if no item can be found. + + X - coordinate to test. + Y - coordinate to test. + + + + + Sets the height of the control to the automatically calcualted height based on content. + + + + + Returns automatically calculated height of the control given current content. + + Height in pixels. + + + + Returns automatically calculated width of the control given current content. + + Width in pixels. + + + + Clean up any resources being used. + + + + + Resets style to default value. Used by windows forms designer. + + + + + Applies design-time defaults to control. + + + + + Creates the Graphics object for the control. + + The Graphics object for the control. + + + + Returns the color scheme used by control. Color scheme for Office2007 style will be retrived from the current renderer instead of + local color scheme referenced by ColorScheme property. + + An instance of ColorScheme object. + + + + Returns the renderer control will be rendered with. + + The current renderer. + + + + Indicates to control that all further update operations should not result in layout and refresh of control content. + Use this method to optimize the addition of new items to the control. This method supports nested calls meaning + that multiple calls are allowed but they must be ended with appropriate number of EndUpdate calls. + IsUpdateSuspended property returns whether update is suspended. + + + + + Indicates that update operation is complete and that control should perform layout and refresh to show changes. See BeginUpdate + for more details. + + + + + Indicates that update operation is complete and that control should perform layout and refresh to show changes. See BeginUpdate + for more details. + + + + + Raises ItemLayoutUpdated event. + + Provides event arguments. + + + + Invalidates the control layout and forces the control to recalculates the layout for the items it contains on next layout operation invoked using RecalcLayout method. + + + Call to this method is usually followed by the call to + RecalcLayout method to perform the control layout. + + + + + Applies any layout changes and repaint the control. + + + + + Sets up timer that watches when active window changes. + + + + + Called after change of active window has been detected. SetupActiveWindowTimer must be called to enable detection. + + + + + Releases and disposes the active window watcher timer. + + + + + Called when item on popup container is right-clicked. + + Instance of the item that is right-clicked. + + + + Called when item on popup container is right-clicked. + + Instance of the item that is right-clicked. + + + + Occurs when Checked property of an button has changed. + + + + + Occurs when Item is clicked. + + + + + Occurs when Item is clicked. + + + + + Occurs when popup of type container is loading. + + + + + Occurs when popup of type container is unloading. + + + + + Occurs when popup item is about to open. + + + + + Occurs when popup item is closing. + + + + + Occurs just before popup window is shown. + + + + + Occurs when Item Expanded property has changed. + + + + + Occurs when mouse button is pressed. + + + + + Occurs when mouse button is released. + + + + + Occurs when mouse enters the item. + + + + + Occurs when mouse leaves the item. + + + + + Occurs when mouse moves over the item. + + + + + Occurs when mouse remains still inside an item for an amount of time. + + + + + Occurs when item loses input focus. + + + + + Occurs when item receives input focus. + + + + + Occurs when user changes the item position, removes the item, adds new item or creates new bar. + + + + + Occurs after an Item is removed from SubItemsCollection. + + + + + Occurs after an Item has been added to the SubItemsCollection. + + + + + Occurs when ControlContainerControl is created and contained control is needed. + + + + + Occurs when Text property of an Item has changed. + + + + + Use this event if you want to serialize the hosted control state directly into the DotNetBar definition file. + + + + + Use this event if you want to deserialize the hosted control state directly from the DotNetBar definition file. + + + + + Occurs after DotNetBar definition is loaded. + + + + + Occurs when DotNetBar is looking for translated text for one of the internal text that are + displayed on menus, toolbars and customize forms. You need to set Handled=true if you want + your custom text to be used instead of the built-in system value. + + + + + Occurs before an item in option group is checked and provides opportunity to cancel that. + + + + + Occurs before tooltip for an item is shown. Sender could be the BaseItem or derived class for which tooltip is being displayed or it could be a ToolTip object itself it tooltip is not displayed for any item in particular. + + + + + Gets or sets the form SideBar is attached to. + + + + + Gets or sets whether accelerator letters on buttons are underlined. Default value is false which indicates that system setting is used + to determine whether accelerator letters are underlined. Setting this property to true + will always display accelerator letter underlined. + + + + + Indicates whether Reset buttons is shown that allows end-user to reset the toolbar state. + + + + + Occurs before an item drag & drop operation is started and allows cancellation. + + + + + + + Gets item that is being dragged. + + + + + ImageList for images used on Items. Images specified here will always be used on menu-items and are by default used on all Bars. + + + + + ImageList for medium-sized images used on Items. + + + + + ImageList for large-sized images used on Items. + + + + + Indicates whether Tooltips are shown on Bars and menus. + + + + + Indicates whether item shortcut is displayed in Tooltips. + + + + + Gets or sets whether hooks are used for internal DotNetBar system functionality. Using hooks is recommended only if DotNetBar is used in hybrid environments like Visual Studio designers or IE. + + + + + Gets whether control is in menu mode. + + + + + Returns the reference to the control that last had input focus. This property should be used to + determine which control had input focus before bar gained the focus. Use it to apply + the menu command to active control. + + + + + Returns whether control has any popups registered. + + + + + Gets or sets whether internal WM_GESTURENOTIFY handler is enabled. Default value is false. + + + + + Gets or sets whether ProcessDialogKey method calls base ContainerControl implementation. + By default base implementation is called but under certain conditions you might want to set + this property to true to receive KeyDown events for Arrow keys. + + + + + Gets or sets whether shortuct processing for the items hosted by this control is enabled. Default value is true. + + + + + Gets or sets the item default accessibility action will be performed on. + + + + + Gets or sets whether control height is set automatically based on the content. Default value is false. + + + + + Specifies the background style of the control. + + + + + Indicates whether shortucts handled by items are dispatched to the next handler or control. + + + + + Gets or sets Bar Color Scheme. + + + + + Gets or sets whether anti-alias smoothing is used while painting. Default value is true. + + + + + Gets or sets whether gray-scale algorithm is used to create automatic gray-scale images. Default is true. + + + + + Specifies whether SideBar is drawn using Themes when running on OS that supports themes like Windows XP. + + + + + Gets or sets whether Key Tips (accelerator keys) for items are displayed on top of them. + + + + + Gets or sets the font that is used to display Key Tips (accelerator keys) when they are displayed. Default value is null which means + that control Font is used for Key Tips display. + + + + + Gets or sets the redering mode used by control. Default value is eRenderMode.Global which means that static GlobalManager.Renderer is used. If set to Custom then Renderer property must + also be set to the custom renderer that will be used. + + + + + Gets or sets the custom renderer used by the items on this control. RenderMode property must also be set to eRenderMode.Custom in order renderer + specified here to be used. + + + + + Gets or sets whether mouse over fade effect is enabled. Default value is true. + + + + + Gets whether control layout is suspended becouse of the call to BeginUpdate method. + + + + + Occurs after internal item layout has been updated and items have valid bounds assigned. + + + + + Gets/Sets the Image size for all sub-items on the Bar. + + + + + Gets or sets whether external ButtonItem object is accepted in drag and drop operation. UseNativeDragDrop must be set to true in order for this property to be effective. + + + + + Gets or sets whether native .NET Drag and Drop is used by control to perform drag and drop operations. AllowDrop must be set to true to allow drop of the items on control. + + + + + Gets or sets whether control supports drag & drop. Default value is false. + + + + + Represents the method that will handle the ItemRemoved event. + + + + + Defines notification interface for scrollable item controls. + + + + + Indicates that item has been selected via keyboard. + + Reference to item being selected + + + + Gets or sets whether selection is allowed. + + + + + Gets or sets the selected item index. + + + + + Gets or sets the BindingContext. + + + + + Invalidates non-client area of the control. This method should be used + when you need to invalidate non-client area of the control. + + + + + Scrolls the control so that item is displayed within the visible bounds of the control. AutoScroll must be set to true for this method to work. + + Item to ensure visibility for. Item must belong to this control. + + + + Indicates that item has been selected via keyboard. + + Reference to item being selected + + + + Called when an item should be selected as result of the keyboard action. + + Item that is being selected. + + + + Raises the DataSourceChanged event. + + An EventArgs that contains the event data. + + + + When overridden in a derived class, resynchronizes the item data with the contents of the data source. + + + + + Raises the DataNodeCreated event. + + Provides event arguments. + + + + Raises the SelectedIndexChanged event. + + Event arguments. + + + + Called when TouchEnabled property has changed. + + Old property value + New property value + + + + Indicates whether container responds to keyboard presses and changes the active/mouse over item. + + + + + Gets or sets the scroll-bar visual style. + + + + + Gets/Sets the visual style for items and color scheme. + + + + + Gets or sets spacing in pixels between items. Default value is 1. + + + + + Indicates whether control can be scrolled when client area is dragged using mouse. Default value is true. + + + + + Gets the reference to internal vertical scroll-bar control if one is created or null if no scrollbar is visible. + + + + + Gets the reference to internal horizontal scroll-bar control if one is created or null if no scrollbar is visible. + + + + + Gets or sets a value indicating whether the control enables the user to scroll to items placed outside of its visible boundaries. + + + + + Gets or sets the minimum size of the auto-scroll. Returns a Size that represents the minimum height and width of the scrolling area in pixels. + This property is managed internally by control and should not be modified. + + + + + Gets or sets the location of the auto-scroll position. + + + + + Gets or sets whether all painting in control is suspended. + + + + + Gets or sets the index specifying the currently selected item. + + + + + Returns collection of items on a bar for binding support. + + + + + Gets or sets the item template that is repeated for each data-row when using data binding. + + + + + Gets the collection of the binding applied to ItemTemplate visual when using data-binding. + + + + + Gets or sets whether external ButtonItem object is accepted in drag and drop operation. UseNativeDragDrop must be set to true in order for this property to be effective. + + + + + Gets or sets whether native .NET Drag and Drop is used by control to perform drag and drop operations. AllowDrop must be set to true to allow drop of the items on control. + + + + + Gets or sets whether automatic drag & drop support is enabled. Default value is false. + + + + + Gets or sets the data source for the ComboTree. Expected is an object that implements the IList or IListSource interfaces, + such as a DataSet or an Array. The default is null. + + + + + Occurs when the DataSource changes. + + + + + Occurs when a item for an data-bound object item has been created and provides you with opportunity to modify the created item. + + + + + Occurs when value of SelectedIndex property has changed. + + + + + Indicates whether touch support for scrolling is enabled. + + + + + Initializes a new instance of the ListBoxAdv class. + + + + + Called when CheckBoxesVisible property has changed. + + Old property value + New property value + + + + Called when ItemHeight property has changed. + + Old property value + New property value + + + + Called when SelectionMode property has changed. + + Old property value + New property value + + + + Selects or clears the selection for the specified item in a ListBoxAdv. Use this property to set the selection of items in a multiple-selection ListBoxAdv. To select an item in a single-selection ListBox, use the SelectedIndex property. + + The zero-based index of the item in a ListBox to select or clear the selection for. You can pass -1 to clear the selection. + true to select the specified item; otherwise, false. + + + + Selects or clears the selection for the specified item in a ListBoxAdv. Use this property to set the selection of items in a multiple-selection ListBoxAdv. To select an item in a single-selection ListBox, use the SelectedIndex property. + + The zero-based index of the item in a ListBox to select or clear the selection for. You can pass -1 to clear the selection. + true to select the specified item; otherwise, false. + Indicates the source of the change. + + + + Selects next visible list box item. + + + + + Selects previous visible list box item. + + + + + Gets ListBoxItem which represents an object value from Items collection when Items collection contains non ListBoxItem objects. + + Value to get ListBoxItem for. + + + + + Called when DisplayMember property has changed. + + Old property value + New property value + + + + Called when CheckStateMember property has changed. + + Old property value + New property value + + + + Raises CheckStateConvert event. + + Provides event arguments. + + + + Called when ValueMember property has changed. + + Old property value + New property value + + + + Clears internal property descriptors cache when data-binding is used. In most cases it is not needed that you call this method. Do so only if instructed by DevComponents support. + + + + + Finds the first item in the ListBox that starts with the specified string. The search starts at a specific starting index. + + The text to search for. + The zero-based index of the first item found; returns ListBox.NoMatches if no match is found. + + + + Finds the first item in the ListBox that starts with the specified string. The search starts at a specific starting index. + + The text to search for. + The zero-based index of the item before the first item to be searched. Set to negative one (-1) to search from the beginning of the control. + The zero-based index of the first item found; returns ListBox.NoMatches if no match is found. + + + + Finds the first item in the ListBox that exactly matches the specified string. The search starts at a specific starting index. + + The text to search for. + The zero-based index of the first item found; returns ListBox.NoMatches if no match is found. + + + + Finds the first item in the ListBox that exactly matches the specified string. The search starts at a specific starting index. + + The text to search for. + The zero-based index of the item before the first item to be searched. Set to negative one (-1) to search from the beginning of the control. + The zero-based index of the first item found; returns ListBox.NoMatches if no match is found. + + + + Raises ItemCheck event. + + Provides event arguments. + + + + Sets the check state of the item at the specified index. + + The index of the item to set the state for. + One of the CheckState values. + + + + Gets the list of items displayed in list box. + + + + + Gets the collection of view items which are created to represent each data item in Items collection. + + + + + Indicates whether check-boxes are visible inside list box items. + + + + + Indicates fixed item height. Maybe set to 0 to indicate that each item should be sized based on its content. + + + + + Specifies the selection mode used by the control. + + + + + Gets or sets the zero-based index of the currently selected item in a ListBoxAdv. Negative one (-1) is returned if no item is selected. + + + + + Gets a collection that contains the zero-based indexes of all currently selected items in the ListBoxAdv. Do not modify items in this collection. To select or deselect list items while in multi-selection mode use SetSelected method. + + + + + Gets a collection containing the currently selected items in the ListBoxAdv. Do not modify items in this collection. To select or deselect list items while in multi-selection mode use SetSelected method. + + + + + Gets or sets the selected item. + + + + + Indicates property name which will provide the value to display for this list box when data-binding is used and DataSource is set. + + + + + Indicates property name which will provide the value for CheckState of the list box item when data-binding is used and DataSource is set. + + + + + Occurs when using data-binding with CheckStateMember specified and it allows you to convert a property value to CheckState. + + + + + Returns the enumerator with selected values if any + + + + + Gets or sets the value of the member property specified by the ValueMember property. If ValueMember specifies property that cannot be found on selected object this property returns null. + + + + + Indicates property name which will return the value for the selected item when SelectedValue property is accessed. + + + + + Occurs when CheckState of an ListBoxItem changes and it allows you to cancel the change. + + + + + Gets collection of checked items in the list. Modifying this collection does not have any effect on actual checked items. Use SetItemCheckState to set checked state of an item or access ListBoxItem directly and set its CheckState property. + + + + + + Defines selection modes for list control. + + + + + Items cannot be selected. + + + + + Only one item at the time can be selected. + + + + + Multiple items can be selected. A mouse click or pressing the SPACEBAR selects or deselects an item in the list. + + + + + Multiple items can be selected. Pressing SHIFT and clicking the mouse or pressing SHIFT and one of the arrow keys (UP ARROW, DOWN ARROW, LEFT ARROW, and RIGHT ARROW) extends the selection from the previously selected item to the current item. Pressing CTRL and clicking the mouse selects or deselects an item in the list. + + + + + Indicates that CheckState change of the item should be canceled. + + + + + Specifies the ListBoxItem that was changing. + + + + + When data-bound provides the object which was used to generate an ListBoxItem. + + + + + Initializes a new instance of the ListBoxAdvItemCheckEventArgs class. + + + + + + + Represents the ListBoxAdv item for internal use. Not for public usage. + + + + + Returns copy of the item. + + + + + Copies the ListBoxItem specific properties to new instance of the item. + + New ListBoxItem instance. + + + + Copies the ListBoxItem specific properties to new instance of the item. + + New item instance. + + + + Called when CheckState property has changed. + + Old property value + New property value + + + + Called when IsSelected property has changed. + + Old property value + New property value + + + + Sets selected state of the item including the source of the action that caused the change. + + + + + + + Called when HotTracking property has changed. + + Old property value + New property value + + + + Called when Image property has changed. + + Old property value + New property value + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Called when Symbol property has changed. + + Old property value + New property value + + + + Called when SymbolSet property value changes. + + Indciates old value + Indicates new value + + + + Called when SymbolSize property has changed. + + Old property value + New property value + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether mouse is over the item. + + + + + Gets the mouse state of the check box part of item if visible. + + + + + Indicates check-box state if visible. + + + + + Gets or sets whether item is selected. + + + + + Indicates whether item changes its background colors when mouse is over the item. + + + + + Specifies image displayed on the item. + + + + + Gets or sets the color of the Symbol. + + + + + Gets the realized symbol string. + + + + + Indicates the symbol displayed on face of the button instead of the image. Setting the symbol overrides the image setting. + + + + + Gets or sets the symbol set used to represent the Symbol. + + + + + Indicates the size of the symbol in points. + + + + + Indicates the array of colors that when set are used to draw the background of the item. + + + + + Gets or sets the color of the text. + + + + + Gets or sets the text associated with this item. + + + + + Gets or sets the text alignment. Default value is left. + + + + + Gets whether item supports text markup. Default is false. + + + + + Gets or sets whether text-markup support is enabled for items Text property. Default value is true. + Set this property to false to display HTML or other markup in the item instead of it being parsed as text-markup. + + + + + Paints ListBoxItem. + + Provides arguments for the operation. + + + + Provides data for the Slider item rendering events. + + + + + Gets or sets the reference to the item being rendered. + + + + + Gets or sets the reference to graphics object. + + + + + Creates new instance of the object and initializes it with default values. + + Reference to the ListBoxItem being rendered. + Reference to the graphics object. + + + + Defines color table for ListBoxItem. + + + + + Specifies default state color table. + + + + + Specifies mouse over state color table. + + + + + Specifies selected state color table. + + + + + Defines single state color table for ListBoxItem. + + + + + Initializes a new instance of the OfficeListBoxItemStateColorTable class. + + + + + Initializes a new instance of the OfficeListBoxItemStateColorTable class. + + + + + + + + + Initializes a new instance of the OfficeListBoxItemStateColorTable class. + + + + + + Indicates item text color. + + + + + Gets or sets the background colors for the item. + + + + + Gets or sets the back colors gradient angle if there is more than one color in BackColors array. + + + + + Gets or sets the gradient colors positions if there is more than one color in BackColors array. + + + + + Paints StepItem. + + Provides arguments for the operation. + + + + Represents the extended ListView control with the Office 2007 Style. + + + + + Called when ColumnHeaderFont property has changed. + + Old property value + New property value + + + + Called by StyleManager to notify control that style on manager has changed and that control should refresh its appearance if + its style is controlled by StyleManager. + + New active style. + + + + Resets internal Column Header handler. This method should be called after you change the View property + at run-time. If your control is always in single view there is no need to call this method. This method + will work only when controls handle has already been created. + + + + + Resets the internal color table reference. This method is usually called automatically by + + + + + Gets whether property should be serialized by VS.NET designer. + + + + + Resets property to its default value. + + + + + Returns the renderer control will be rendered with. + + The current renderer. + + + + Returns the color scheme used by control. Color scheme for Office2007 style will be retrived from the current renderer instead of + local color scheme referenced by ColorScheme property. + + An instance of ColorScheme object. + + + + Gets or sets the column header font. Default value is null which means controls Font property is used. + + + + + Gets or sets the item foreground color when control or item is disabled. By default SystemColors.Dark is used. + + + + + Gets or sets whether control displays focus cues when focused. + + + + + Gets or sets the redering mode used by control. Default value is eRenderMode.Global which means that static GlobalManager.Renderer is used. If set to Custom then Renderer property must + also be set to the custom renderer that will be used. + + + + + Gets or sets the custom renderer used by the items on this control. RenderMode property must also be set to eRenderMode.Custom in order renderer + specified here to be used. + + + + + Specifies the control border style. Default value has Class property set so the system style for the control is used. + + + + + Specifies back color when Enabled=false + + + + + Summary description for MessageHandler. + + + + + Calculates the size of non-client area of the control. + + + + + Paints the non-client area of the control. + + + + + Draws the non-client area buffered. + + + + + Represents the PageNavigator control + + + + + Constructor + + + + + Hooks or unhooks our control events + + true to hook, false to unhook + + + + Handles NavigatePreviousPage events + + + + + + + Raises the NavigatePreviousPage event + + + + + Handles NavigateToday events + + + + + + + Raises the NavigateToday event + + + + + Handles NavigateNextPage events + + + + + + + Raises the NavigateNextPage event + + + + + Forces the button to perform internal layout. + + + + + Dispose + + + + + + Occurs when NavigateNextPage button is clicked + + + + + Occurs when NavigateToday button is clicked + + + + + Occurs when NavigatePreviousPage button is clicked + + + + + DefaultSize + + + + + Gets or sets the layout orientation. Default value is horizontal. + + + + + Gets or sets the tooltip for the PreviousPage button of the control + + + + + Gets or sets the tooltip for the Today button + + + + + Gets or sets the tooltip for the NextPage button + + + + + Gets/Sets the visual style for the control. + + + + + PageNavigator buttons + + + + + Previous page + + + + + Today + + + + + Next page + + + + + Represents the PageNavigate item + + + + + Creates new instance of PageNavigateItem + + + + + Creates new instance of PageNavigateItem and assigns the name to it + + Item name + + + + Handles size recalc + + + + + Handles external size changes + + + + + Lays out our control based upon its + vertical / horizontal orientation + + + + + Handles control rendering + + + + + + Draws the PreviousPage button + + Graphics + Office2007ScrollBarColorTable + + + + Gets the PreviousPage bitmap + + + + + + + + Creates the PreviousPage bitmap + + + + + + + + Draws the Today button + + Graphics + Office2007ScrollBarColorTable + + + + Gets the Today Bitmap + + + + + + + + Creates the Today Bitmap + + + + + + + + Draws the NextPage button + + + + + + + Gets the NextPage Bitmap + + + + + + + + Creates the NextPage Bitmap + + + + + + + + Centers the given rect + + + + + + + Processes InternalMouseMove events + + + + + + Returns the HitText area for the given point + + + + + + + Processes Mouse Leave events + + + + + Processes Mouse Down events + + + + + + Processes Mouse Up events + + + + + + Raises the NavigatePreviousPage event + + + + + Raises the NavigateToday event + + + + + Raises the NavigateNextPage event + + + + + Handles timer click events + + + + + + + Enables our click timer + + + + + Disposes of the click timer + + + + + OnTooltipChanged + + + + + Updates the control tooltip + + + + + Returns copy of the item + + + + + Copies the PageNavigatorItem specific properties to + new instance of the item + + New PageNavigatorItem instance + + + + Dispose + + + + + Releases the given bitmap + + Bitmap to release + + + + Occurs when NavigateNextPage button is clicked + + + + + Occurs when NavigateToday button is clicked + + + + + Occurs when NavigatePreviousPage button is clicked + + + + + Gets or sets the MouseOverPart + + + + + Gets or sets the MouseDownPart + + + + + Gets or sets the control orientation. Default value is Horizontal + + + + + Gets or sets whether Click event will be auto repeated + when mouse button is kept pressed over the item + + + + + Gets or sets the auto-repeat interval for the click event + when mouse button is kept pressed over the item + + + + + Gets or sets the tooltip for the PreviousPage button of the control + + + + + Gets or sets the tooltip for the Today button + + + + + Gets or sets the tooltip for the NextPage button + + + + + Defines the PageNavigator item parts + + + + + Indicates no part + + + + + Indicates the PreviousPage button of the control + + + + + Indicates the TodayPage button of the control + + + + + Indicates the NextPage button of the control + + + + + Initializes a new instance of the PageSlider class. + + + + + Raises SelectedPageChanged event. + + Provides event arguments. + + + + Called when IndicatorVisible property has changed. + + Old property value + New property value + + + + Returns array of all pages in control. + + Array of pages. + + + + Removes and disposes all pages within the control. + + + + + Called when SelectedPage property has changed. + + Old property value + New property value + + + + Called when AnimationTime property has changed. + + Old property value + New property value + + + + Called when SelectedPagePadding property has changed. + + Old property value + New property value + + + + Called when PageSpacing property has changed. + + Old property value + New property value + + + + Called when NextPageVisibleMargin property has changed. + + Old property value + New property value + + + + Called when Orientation property has changed. + + Old property value + New property value + + + + Called when ScrollBarVisibility property has changed. + + Old property value + New property value + + + + Called when TouchEnabled property has changed. + + Old property value + New property value + + + + Occurs when selected page has changed. + + + + + Gets or sets whether current page indicator is visible. Default value is true. + + + + + Indicates selected page. + + + + + Indicates the animation time in milliseconds for operations that perform visual animation of transition. Set to zero to disable animation. + + + + + Gets or sets zero based selected page index. If there is no page selected returns -1. + + + + + Gets the total number of pages displayed by the control. + + + + + Gets or sets the single page padding. + + + + + Gets or sets the spacing in pixels between pages. + + + + + Gets or sets the page layout orientation. Default is horizontal. + + + + + Indicates whether page can be dragged using mouse to change currently selected page + + + + + Indicates whether selected page can be changed by using mouse drag on PageSlider client area which is not covered by pages. + + + + + Indicates scrollbar visibility. + + + + + Gets or sets the time in milliseconds that scrollbar is kept visible when there is no activity in control and mouse is over the control. + + + + + Indicates whether native touch support in control is enabled if available on target system. + + + + + Specifies scrollbar visibility. + + + + + Scrollbars are not visible. + + + + + Scrollbars are visible only if mouse is inside of the control. + + + + + Scrollbars are always visible. + + + + + Specifies level of touch enabled on the control. + + + + + Touch is enabled control wide. + + + + + Touch is disabled control wide. + + + + + Touch is enabled but only for the direct control client content. If touch input occurs on any child control it is not processed. + + + + + Called when PageNumber property has changed. + + Old property value + New property value + + + + Gets or sets page number. Page number determines the order in which pages are displayed inside of the PageSlider control. + + + + + Represents control which visually indicates current step in a sequence. + + + + + Initializes a new instance of the StepIndicator class. + + + + + Called when StepCount property has changed. + + Old property value + New property value + + + + Called when CurrentStep property has changed. + + Old property value + New property value + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Called when Orientation property has changed. + + Old property value + New property value + + + + Gets or sets the total number of steps that control will track. Default value is 10. + + + + + Gets or sets the current step in sequence. Current step should be less or equal than StepCount. + + + + + Gets or sets the background color of the control. + + + + + Gets or sets the color of the current step indicator. + + + + + Indicates the control orientation. + + + + + Processes the resizing messages. + + The message. + true, if the WndProc method from the base class shouldn't be invoked. + + + + Gets whether popup has been resized by end-user. + + + + + Type of resize mode, grips are automatically drawn at bottom-left and bottom-right corners. + + + + + Gets or sets whether Close button is visible in fotter. Resize handle must also be visible in order for close button to render. + + + + + Gets resize grip bounds. + + + + + Initializes a new instance of the ResizeGripColors structure. + + + + + + + + Specifies the popup resize modes + + + + + Raises Closed event. + + Provides event arguments. + + + + Raises Closing event. + + Provides event arguments. + + + + Show control on popup at specified location. + + + + + Shows control on popup at specified location with specified popup resize edges. + + + + + Shows control on popup at specified location and size with specified popup resize edges. + + + + + Hides popup if visible. + + + + + Occurs after popup is closed. + + + + + Occurs before popup is closed and allows canceling. + + + + + Gets whether popup is visible. + + + + + Gets the control displayed on popup. + + + + + Gets or sets the popup padding. + + + + + Gets or sets popup margin. + + + + + Represents the stand-alone progress bar control. + + + + + Advances the current position of the progress bar by the amount of the Step property. + + + + + Advances the current position of the progress bar by the specified amount. + + The amount by which to increment the progress bar's current position. + + + + Gets whether ChunkColor property should be serialized. + + + + + Resets the ChunkColor property to its default value. + + + + + Gets whether ChunkColor property should be serialized. + + + + + Resets the ChunkColor property to its default value. + + + + + Gets or sets the maximum value of the range of the control. + + + + + Gets or sets the minimum value of the range of the control. + + + + + Gets or sets the current position of the progress bar. + + + + + Gets or sets the amount by which a call to the PerformStep method increases the current position of the progress bar. + + + + + Gets or sets the color of the progress chunk. + + + + + Gets or sets the target gradient color of the progress chunk. + + + + + Gets or sets the gradient angle of the progress chunk. + + + + + Gets or sets whether the text inside the progress bar is displayed. + + + + + Gets or sets the type of progress bar used to indicate progress. The Standard style displays the progress based on Minimum, Maximum and current Value. + The Marquee type is automatically moving progress bar that is used to indicate an ongoing operation for which the actual duration cannot be estimated. + + + + + Gets or sets the marquee animation speed in milliseconds. + + + + + Gets or sets the predefined color state table for progress bar. Color specified applies to items with Office 2007 style only. It does not have + any effect on other styles. You can use ColorTable to indicate the state of the operation that Progress Bar is tracking. Default value is eProgressBarItemColor.Normal. + + + + + Gets the underlying ProgressBarItem + + + + + Defines color table for the StepItem. + + + + + Gets or sets the default state StepItem colors. + + + + + Gets or sets the mouse over state StepItem colors. + + + + + Gets or sets the StepItem colors when mouse is pressed over the item. + + + + + Gets or sets the StepItem colors when Value property is greater than Minimum property value, i.e. item is reporting progress. + Note that only Background color is used when progress indicator is drawn. + + + + + Paints StepItem. + + Provides arguments for the operation. + + + + Paints StepItem. + + Provides arguments for the operation. + + + + Represents the color table for StepItem single state. + + + + + Initializes a new instance of the OfficeStepItemStateColorTable class. + + + + + Initializes a new instance of the OfficeStepItemStateColorTable class. + + + + + + + + Initializes a new instance of the OfficeStepItemStateColorTable class. + + + + + + + + + + Gets or sets the background colors for the step item. + + + + + Gets or sets the back colors gradient angle if there is more than one color in BackColors array. + + + + + Gets or sets the gradient colors positions if there is more than one color in BackColors array. + + + + + Gets or sets the text color for the step item. + + + + + Gets or sets the border colors of the step item. + + + + + Represents the progress steps control. + + + + + Initializes a new instance of the ProgressSteps class. + + + + + Returns collection of items on a bar. + + + + + Gets/Sets the visual style for items and color scheme. + + + + + Gets or sets a value indicating whether the control is automatically resized to display its entire contents. You can set MaximumSize.Width property to set the maximum width used by the control. + + + + + Gets or sets the arrow pointer width for the StepItem objects hosted within this container. + + + + + Represents a step item which is used to show single step in multi-step progress control. + + + + + Creates new instance of StepItem. + + + + + Creates new instance of StepItem and assigns the name to it. + + Item name. + + + + Creates new instance of StepItem and assigns the name and text to it. + + Item name. + item text. + + + + Returns copy of the item. + + + + + Copies the StepItem specific properties to new instance of the item. + + New StepItem instance. + + + + Copies the StepItem specific properties to new instance of the item. + + New StepItem instance. + + + + Returns the Font object to be used for drawing the item text. + + Font object. + + + + Called when Minimum property has changed. + + Old property value + New property value + + + + Called when Maximum property has changed. + + Old property value + New property value + + + + Called when Value property has changed. + + Old property value + New property value + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Called when Symbol property has changed. + + Old property value + New property value + + + + Called when SymbolSet property value changes. + + Indciates old value + Indicates new value + + + + Called when SymbolSize property has changed. + + Old property value + New property value + + + + Called when Image property has changed. + + Old property value + New property value + + + + Called when MinimumSize property has changed. + + Old property value + New property value + + + + Called when HotTracking property has changed. + + Old property value + New property value + + + + Called when ImageTextSpacing property has changed. + + Old property value + New property value + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets the render path of the item. + + + + + Gets or sets the minimum value of the range of the control. + + + + + Gets or sets the color of the Symbol. + + + + + Gets the realized symbol string. + + + + + Indicates the symbol displayed on face of the button instead of the image. Setting the symbol overrides the image setting. + + + + + Gets or sets the symbol set used to represent the Symbol. + + + + + Indicates the size of the symbol in points. + + + + + Indicates the image that is displayed next to the item text label. + + + + + Gets or sets whether this is first item in StepControl. + + + + + Gets or sets whether this is laste item in StepControl. + + + + + Indicates minimum size of the item + + + + + Specifies whether item changes its appearance when mouse is moved over the item + + + + + Gets whether mouse is over the item. + + + + + Gets whether left mouse button is pressed on the item. + + + + + Indicates the spacing between image and text. + + + + + Gets or sets padding around content of the item. + + + + + Indicates the array of colors that when set are used to draw the current progress, i.e. Value>Minimum + + + + + Indicates the array of colors that when set are used to draw the background of the item. + + + + + Gets or sets the text alignment. Default value is left. + + + + + Gets or sets the text associated with this item. + + + + + Gets or sets the color of the text. + + + + + Gets whether item supports text markup. Default is false. + + + + + Gets or sets whether text-markup support is enabled for items Text property. Default value is true. + Set this property to false to display HTML or other markup in the item instead of it being parsed as text-markup. + + + + + Container for the StepItem objects. + + + + + Initializes a new instance of the StepContainer class. + + + + + Returns copy of the item. + + + + + Copies the StepContainer specific properties to new instance of the item. + + New StepContainer instance. + + + + Copies the StepContainer specific properties to new instance of the item. + + New StepContainer instance. + + + + Called when PointerSize property has changed. + + Old property value + New property value + + + + Gets or sets the arrow pointer width for the StepItem objects hosted within this container. + + + + + Provides data for the Slider item rendering events. + + + + + Gets or sets the reference to the item being rendered. + + + + + Gets or sets the reference to graphics object. + + + + + Creates new instance of the object and initializes it with default values. + + Reference to the Slider item being rendered. + Reference to the graphics object. + + + + Gets or sets current MultiFormAppContext context. If you are using MultiFormAppContext to start your app then you should also + set that instance of MultiFormAppContext to this property so internally TabFormControl can register any new deattached forms + and prevent application from closing if startup form is closed first. + + + + + Gets or sets whether tab renders its state. Used internally by DotNetBar. Do not set. + + + + + Gets the actual tab path. + + + + + Indicates the array of colors that when set are used to draw the background of the item. + + + + + Summary description for Office2003ButtonItemPainter. + + + + + Summary description for ButtonItemPainter. + + + + + Paints state of the button, either hot, pressed or checked + + + + + + + + Paints state of the button, either hot, pressed or checked + + + + + + + + Gets or sets color table used by renderer. + + + + + Gets or sets the color table for form in active state. + + + + + Gets or sets the color table for from in inactive state. + + + + + Gets or sets the border thickness. + + + + + Gets or sets the background color of the form. + + + + + Gets or sets the text color of the form. + + + + + Gets or sets the text formatting for caption text. + + + + + Represents Range Slider Control. + + + + + Raises ValueChanging event. + + Provides event arguments. + + + + Raises ValueChanged event. + + Provides event arguments. + + + + Raises GetRangeTooltipText event. + + Provides event arguments. + + + + Forces the button to perform internal layout. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Occurs before Value has changed and allow the cancellation of the change. + + + + + Occurs after Value property has changed + + + + + Occurs when control is about to display the range tooltip and it allows you to customize tooltip + + + + + Gets the RangeSliderItem. + + + + + Indicates whether clicking the area outside of the range change buttons moves the range change button to the clicked location if possible thus allowing range change. + + + + + Gets or sets the maximum value of the range of the control. + + + + + Gets or sets the minimum value of the range of the control. + + + + + Indicates image to be used as maximum range slider button instead of built-in button. Image is scaled to size set by RangeButtonSize. + + + + + Indicates image to be used as minimum range slider button instead of built-in button. Image is scaled to size set by RangeButtonSize. + + + + + Specifies minimum absolute range that user can select. Absolute range is defined as Abs(Value.Max-Value.Min) Applies to user performed selection through mouse only. + + + + + Gets current part that is pressed using mouse left button. + + + + + Gets mouse over part. + + + + + Gets bounds of maximum range sliding button. + + + + + Gets bounds of minimum range sliding button. + + + + + Indicates the size of the range change buttons. + + + + + Specifies the height of the range line + + + + + Gets or sets the string that is used to format the range value to be displayed while user moves the range buttons. Value set here is used in string.Format(RangeTooltipFormat, Value.Min, Value.Max). + + + + + Gets or sets the color of the range value. + + + + + Specifies whether range tooltip is shown while user is changing the range + + + + + Gets or sets the slider orientation. Default value is horizontal. + + + + + Gets tick marks bounds. + + + + + Gets tick marks bounds for second marker is visible. + + + + + Specifies the ticks position inside of Range Slider. + + + + + Indicates tick display period + + + + + Indicates whether tick lines are shown + + + + + Gets or sets the range displayed by the control. + + + + + Represents the Rating control. + + + + + Initializes a new instance of the Rating class. + + + + + Raises the ParseRating event. + + Provides event arguments. + + + + Raises the ParseAverageRatingValue event. + + Provides event arguments. + + + + Raises the AverageRatingChanged event. + + Event data. + + + + Raises the RatingChanged event. + + Event data. + + + + Raises RatingChanging event. + + Event data + + + + Called when Command property value changes. + + + + + Occurs when Rating property has changed. + + + + + Occurs when RatingValue property has changed. + + + + + Occurs when Rating property is about to be changed and provides opportunity to cancel the change. + + + + + Occurs when AverageRating property has changed. + + + + + Occurs when AverageRatingValue property has changed. + + + + + Occurs when text markup link is clicked. Markup links can be created using "a" tag, for example: + Markup link + + + + + Occurs when RatingValue property is set and it allows you to provide custom parsing for the values. + + + + + Occurs when AverageRatingValue property is set and it allows you to provide custom parsing for the values. + + + + + Indicates number of stars used for the rating. Minium value is 2 stars. + + + + + Gets or sets the rating value represented by the control. Default value is 0 which indicates + that there is no rating set. Maximum value is 5. + + + + + Gets or sets the average rating shown by control. Control will display average rating (if set) when no explicit + Rating value is set through Rating property. Minimum value is 0 and Maximum value is 5. + + + + + Gets or sets the AverageRating property. This property is provided for Data-Binding with NULL value support. + + + + + Gets the reference to custom rating images. + + + + + Gets or sets whether text assigned to the check box is visible. Default value is true. + + + + + Gets or sets whether text-markup support is enabled for items Text property. Default value is true. + Set this property to false to display HTML or other markup in the item instead of it being parsed as text-markup. + + + + + Gets or sets whether rating can be edited. Default value is true. + + + + + Gets or sets the orientation of rating control. + + + + + Gets or sets the Rating property value. This property is provided for Data-Binding with NULL value support. + + + + + Gets or sets the text color. Default value is Color.Empty which indicates that default color is used. + + + + + Gets or sets the spacing between optional text and the rating. + + + + + Gets or sets a value indicating whether the control is automatically resized to display its entire contents. You can set MaximumSize.Width property to set the maximum width used by the control. + + + + + Gets or sets the command assigned to the item. Default value is null. + Note that if this property is set to null Enabled property will be set to false automatically to disable the item. + + + + + Gets or sets user defined data value that can be passed to the command when it is executed. + + + + + Represents an image control with built-in reflection. + + + + + Initializes a new instance of the ReflectionImage class. + + + + + Gets or sets the image displayed on the control. + + + + + Gets or sets whether reflection effect is enabled. Default value is true. + + + + + Represents an single line of text label control with text-markup support and built-in reflection. + + + + + Occurs when text markup link is clicked. Markup links can be created using "a" tag, for example: + Markup link + + + + + Gets or sets whether reflection effect is enabled. Default value is true. + + + + + Represents control which handles scroll-bars. + + + + + Initializes a new instance of the ScrollbarControl class. + + + + + Called when ScrollOverrideControl property has changed. + + Old property value + New property value + + + + Gets or sets the scroll-bar visual style. + + + + + Initializes a new instance of the RichTextBoxEx class. + + + + + Raises AcceptsTabChanged event. + + Provides event arguments. + + + + Raises HideSelectionChanged event. + + Provides event arguments. + + + + Raises ModifiedChanged event. + + Provides event arguments. + + + + Raises MultilineChanged event. + + Provides event arguments. + + + + Raises ReadOnlyChanged event. + + Provides event arguments. + + + + Raises LinkClicked event. + + Provides event arguments. + + + + Raises Protected event. + + Provides event arguments. + + + + Raises SelectionChanged event. + + Provides event arguments. + + + + Raises HScroll event. + + Provides event arguments. + + + + Raises HScroll event. + + Provides event arguments. + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Appends text to the current text of a text box + + + + + Determines whether you can paste information from the Clipboard in the specified data format. + + + + + + + Clears all text from the text box control. + + + + + Clears information about the most recent operation from the undo buffer of the text box. + + + + + Copies the current selection in the text box to the Clipboard. + + + + + Moves the current selection in the text box to the Clipboard. + + + + + Specifies that the value of the SelectionLength property is zero so that no characters are selected in the control. + + + + + Searches the text in a RichTextBox control for a string. + + + + + + + Searches the text of a RichTextBox control for the first instance of a character from a list of characters. + + + + + + + Searches the text in a RichTextBox control for a string with specific options applied to the search. + + + + + + + + Searches the text of a RichTextBox control, at a specific starting point, for the first instance of a character from a list of characters. + + + + + + + + Searches the text in a RichTextBox control for a string at a specific location within the control and with specific options applied to the search. + + + + + + + + + Searches a range of text in a RichTextBox control for the first instance of a character from a list of characters. + + + + + + + + + Searches the text in a RichTextBox control for a string within a range of text within the control and with specific options applied to the search. + + + + + + + + + + Retrieves the character that is closest to the specified location within the control. + + + + + + + Retrieves the index of the character nearest to the specified location + + + + + + + Retrieves the index of the first character of a given line. (Inherited from TextBoxBase.) + + + + + + + Retrieves the index of the first character of the current line. (Inherited from TextBoxBase.) + + + + + + Retrieves the line number from the specified character position within the text of the RichTextBox control. + + + + + + + Retrieves the location within the control at the specified character index. + + + + + + + Loads a rich text format (RTF) or standard ASCII text file into the RichTextBox control. + + + + + + Loads the contents of an existing data stream into the RichTextBox control. + + + + + + + Loads a specific type of file into the RichTextBox control. + + + + + + + Replaces the current selection in the text box with the contents of the Clipboard. + + + + + Pastes the contents of the Clipboard in the specified Clipboard format. + + + + + + Reapplies the last operation that was undone in the control. + + + + + Saves the contents of the RichTextBox to a rich text format (RTF) file. + + + + + + Saves the contents of a RichTextBox control to an open data stream. + + + + + + + Saves the contents of the RichTextBox to a specific type of file. + + + + + + + Scrolls the contents of the control to the current caret position. + + + + + Activates the control. (Inherited from Control.) + + + + + Selects a range of text in the text box. + + + + + + + Selects all text in the text box. + + + + + Undoes the last edit operation in the text box. + + + + + Gets the reference to internal RichTextBox control. + + + + + Occurs when the value of the AcceptsTab property changes + + + + + Occurs when the value of the HideSelection property changes. + + + + + Occurs when the value of the Modified property changes. + + + + + Occurs when the value of the Multiline property changes. + + + + + Occurs when the value of the ReadOnly property changes. + + + + + Occurs when a hyperlink in the text is clicked. + + + + + Occurs when the user takes an action that would change a protected range of text. + + + + + Occurs when the current selection has changed. + + + + + Occurs when the horizontal scroll bar is clicked. + + + + + Occurs when the vertical scroll bar is clicked. + + + + + Gets or sets whether anti-alias smoothing is used while painting. Default value is true. + + + + + Gets or sets the back color of the RichTextBox. + + + + + Gets or sets whether tab characters are accepted as input + + + + + Gets or sets whether automatic word selection is enabled. + + + + + Gets or sets indent for bullets in the control. + + + + + Gets or sets whether URLs are automatically formatted as links. + + + + + Gets or sets whether drag/drop of text, pictures and other data is enabled. + + + + + Gets or sets whether selection should be hidden when the edit control loses focus. + + + + + Gets or sets lines of text in a multi-line edit, as an array of String values. + + + + + Gets or sets maximum number of characters that can be entered into the edit control. + + + + + Gets or sets whether the text in the control can span more than one line. + + + + + Gets or sets whether the text in the edit control can be changed or not. + + + + + Gets or sets right margin dimensions. + + + + + Gets or sets the text of the RichTextBox control, including all rich text format (RTF) codes. + + + + + Gets or sets for multi-line edit control, which scroll bars will be shown. + + + + + Gets or sets whether shortcuts defined for the control are enabled. + + + + + Gets or sets whether selection margin is visible. + + + + + Gets or sets whether lines are automatically word-wrapped. + + + + + Gets or sets current zoom factor for the control content. + + + + + Should be fired when non-client size of the control changes, i.e. when WM_NCCALCSIZE message is received. + + + + + Should be fired when scroll-bar value on child control changes. + + + + + Should be fired when control receives WM_MOVE message. + + + + + Gets whether control is in design mode. + + + + + Raises NonClientSizeChanged event. + + Provides event arguments. + + + + Raises ScrollBarValueChanged event. + + Provides event arguments. + + + + Raises NonClientSizeChanged event. + + Provides event arguments. + + + + Defines arguments for IScrollBarOverrideSupport.ScrollBarValueChanged event. + + + + + Initializes a new instance of the ScrollValueChangedEventArgs class. + + + + + + Defines information for IScrollBarOverrideSupport.ScrollBarValueChanged event. + + + + + Defines delegate for IScrollBarOverrideSupport.ScrollBarValueChanged event. + + Sender. + Event arguments + + + + Gets or sets the scroll-bar visual style. + + + + + Paints ListBoxItem. + + Provides arguments for the operation. + + + + Paints ListBoxItem. + + Provides arguments for the operation. + + + + Represents SideNav control to create "hamburger" menus. + + + + + Called by StyleManager to notify control that style on manager has changed and that control should refresh its appearance if + its style is controlled by StyleManager. + + New active style. + + + + Updates the control colors from the global color table. + + + + + Maximizes control width so it fills up space to the right of the control. + + Source of the event. + + + + Restores the control to previous size if it was maximized before. + + Source of event. + + + + Opens the control, i.e. expands it, selects specified item and shows its associated panel. + + Item to select. + Source of the event. + + + + Closes the control, i.e. unselects any selected item, hide its associated panel and folds the control. + + Source of the event. + + + + Raises IsMenuExpandedChanged event. + + Provides event arguments. + + + + Expands or collapses the control items menu. + + + + + + Called when AnimationTime property has changed. + + Old property value + New property value + + + + Raises BeforeMaximize event. + + Provides event arguments. + + + + Raises BeforeRestore event. + + Provides event arguments. + + + + Raises BeforeOpen event. + + Provides event arguments. + + + + Raises BeforeClose event. + + Provides event arguments. + + + + Raises SelectedItemChanged event. + + Provides event arguments. + + + + Indicates whether splitter that is located on right hand side of open control is visible and enabled. + + + + + Indicates whether button which folds/closes the control is visible. + + + + + + Returns collection of items on a bar. + + + + + Gets or sets whether control is closed, i.e. whether selected item panel is shown or not. When closed + any selected item is unselected and selected panel hidden. + + + + + Indicates whether side menu is expanded, i.e. shows both image and text. When menu is collapsed only image is shown. + + + + + Occurs when IsMenuExpanded property has changed its value. + + + + + Indicates the animation time in milliseconds for operations that perform visual animation of transition. Set to zero to disable animation. + + + + + Occurs before the control is maximized and allows you to cancel that. + + + + + Occurs before the control is restored and allows you to cancel that. + + + + + Occurs before the control is opened and allows you to cancel that. + + + + + Occurs before the control is closed and allows you to cancel that. + + + + + Gets currently selected item. Only items with Panel assigned can be selected. + + + + + Occurs when SelectedItem changes. + + + + + Gets reference to internal SideNavStrip control. + + + + + Defines delegate for the CancelSource events. + + + + + + + Event arguments for CancelSourceEventHandler + + + + + Gets the source of the event. + + + + + Gets any optional data that is associated with the event. + + + + + Creates new instance of the object. + + Source of event + + + + Creates new instance of the object. + + Source of event + Optional data associated with the event. + + + + Initializes a new instance of the MetroTabItem class. + + + + + Selects the tab. + + + + + Called after Checked property has changed. + + + + + Occurs just before Click event is fired. + + + + + Called when Visibility of the items has changed. + + New Visible state. + + + + Occurs after item visual style has changed. + + + + + Gets or sets cached image rendering bounds. + + + + + Gets or sets cached text rendering bounds. + + + + + Gets or sets the panel assigned to this tab item. + + + + + Gets or set the Group item belongs to. The groups allows a user to choose from mutually exclusive options within the group. The choice is reflected by Checked property. + + + + + Returns the collection of sub items. + + + + + Indicates the array of colors that when set are used to draw the background of the item. + + + + + Indicates the array of colors that when set are used to draw the border of the item. + + + + + Gets or sets the additional padding added around the tab item in pixels. Default value is 0. + + + + + Indicates an optional title for the associated panel. If not set item text is used. + + + + + Gets or sets whether this item acts as the SideNav control system menu which collapses and expands the SideNav items. + + + + + Indicates whether the item will auto-collapse (fold) when clicked. + When item is on popup menu and this property is set to false, menu will not + close when item is clicked. + + + + + Indicates whether the item will auto-expand when clicked. + When item is on top level bar and not on menu and contains sub-items, sub-items will be shown only if user + click the expand part of the button. Setting this propert to true will expand the button and show sub-items when user + clicks anywhere inside of the button. Default value is false which indicates that button is expanded only + if its expand part is clicked. + + + + + Gets or sets whether item can be customized by end user. + + + + + Gets or set a value indicating whether the button is in the checked state. + + + + + Gets or sets whether Click event will be auto repeated when mouse button is kept pressed over the item. + + + + + Gets or sets the auto-repeat interval for the click event when mouse button is kept pressed over the item. + + + + + Gets or sets a value indicating whether the item is enabled. + + + + + Indicates item's visiblity when on pop-up menu. + + + + + Indicates when menu items are displayed when MenuVisiblity is set to VisibleIfRecentlyUsed and RecentlyUsed is true. + + + + + Indicates Animation type for Popups. + + + + + Indicates the font that will be used on the popup window. + + + + + Indicates whether sub-items are shown on popup Bar or popup menu. + + + + + Specifies the inital width for the Bar that hosts pop-up items. Applies to PopupType.Toolbar only. + + + + + Gets or sets whether item will display sub items. + + + + + Gets or sets whether the item expands automatically to fill out the remaining space inside the container. Applies to Items on stretchable, no-wrap Bars only. + + + + + Gets or sets the width of the expand part of the button item. + + + + + Gets or set the alternative shortcut text. + + + + + Gets or sets whether item separator is shown before this item. + + + + + Returns category for this item. If item cannot be customzied using the + customize dialog category is empty string. + + + + + Gets or sets the text color of the button when mouse is over the item. + + + + + Indicates the way item is painting the picture when mouse is over it. Setting the value to Color will render the image in gray-scale when mouse is not over the item. + + + + + Gets/Sets the button style which controls the appearance of the button elements. Changing the property can display image only, text only or image and text on the button at all times. + + + + + Provides data for the SideNavItem rendering events. + + + + + Gets or sets the reference to the item being rendered. + + + + + Gets or sets the reference to graphics object. + + + + + Indicates whether to cancel system rendering of the item. + + + + + Creates new instance of the object and initializes it with default values. + + Reference to the ListBoxItem being rendered. + Reference to the graphics object. + + + + Defines color table for SideNav control. + + + + + Gets or sets the color table for SideNavItem + + + + + Gets or sets the background color of SideNav title bar. + + + + + Gets or sets the border color of the title of SideNav control. + + + + + Gets or sets the color of the strip which hosts the items. + + + + + Gets or sets the border color of the SideNav control. + + + + + Gets or sets the back color of panels that are attached to SideNavItem and displayed when SideNavItem is selected. + + + + + Defines color table for SideNavItem + + + + + Gets or sets the color table for Default state. + + + + + Gets or sets the color table for MouseOver state. + + + + + Gets or sets the color table for Pressed state. + + + + + Gets or sets the color table for Selected state. + + + + + Defines state color table for SideNavItem + + + + + Indicates item text color. + + + + + Gets or sets the background colors for the item. + + + + + Gets or sets the back colors gradient angle if there is more than one color in BackColors array. + + + + + Gets or sets the gradient colors positions if there is more than one color in BackColors array. + + + + + Gets or sets the border colors for the item. + + + + + Indicates the corner radius. + + + + + Represents a panel which hosts controls for the SideNavItem. + + + + + Raises NonClientSizeChanged event. + + Provides event arguments. + + + + Raises ScrollBarValueChanged event. + + Provides event arguments. + + + + Raises NonClientSizeChanged event. + + Provides event arguments. + + + + Called by StyleManager to notify control that style on manager has changed and that control should refresh its appearance if + its style is controlled by StyleManager. + + New active style. + + + + Returns collection of items on a bar. + + + + + Gets currently selected item. + + + + + Represents the panel which can slide out and into the view. + + + + + Raises IsOpenChanged event. + + Provides event arguments. + + + + Called when SlideSide property has changed. + + Old property value + New property value + + + + Called when IsOpen property has changed. + + Old property value + New property value + + + + Slides panel into the view. + + + + + Waits for current slide animation to finish and then returns control. + + + + + Slides panel out of the view. + + + + + Called when AnimationTime property has changed. + + Old property value + New property value + + + + Called when SlideOutButtonVisible property has changed. + + Old property value + New property value + + + + Called when SlideOutButtonSize property has changed. + + Old property value + New property value + + + + Returns whether property should be serialized. + + + + + Resets property to default value. + + + + + Called when SlideOutActiveButtonSize property has changed. + + Old property value + New property value + + + + Returns whether property should be serialized. + + + + + Resets property to default value. + + + + + Called when SlideOutButtonStyle property has changed. + + Old property value + New property value + + + + Called when CenterContent property has changed. + + Old property value + New property value + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Called when Symbol property has changed. + + Old property value + New property value + + + + Called when SymbolSet property value changes. + + Indciates old value + Indicates new value + + + + Called when SymbolSize property has changed. + + Old property value + New property value + + + + Occurs when IsOpen property value has changed, i.e. slide-panel is shown or hidden. + + + + + Gets or sets side panel slides into. + + + + + Gets or sets whether panel is open. When this property is changed panel will slide in or out of the view. + + + + + Gets or sets whether panel uses modal animation, meaning when IsOpen property is set the call is not returned until animation is complete. + + + + + Gets or sets the open panel bounds. When control IsOpen=false and panel is collapsed its original bounds are stored in OpenBounds property and restored once panel is open. + + + + + Gets or sets the animation duration time in milliseconds. Setting this property to 0 will disable slide animation. + + + + + Gets or sets whether slide out button is shown when panel is out of the view and which allows panel to be shown. + + + + + Gets or sets the slide-out buttton size in default state. + + + + + Gets or sets active (mouse over) slide out button size. + + + + + Gets or sets slide-out button style. + + + + + Gets or sets whether panel centers the Controls inside of it. Default value is false. + + + + + Gets or sets the color of the Symbol displayed on slideout button. + + + + + Gets the realized symbol string. + + + + + Indicates the symbol displayed on face of the slideout button. + + + + + Gets or sets the symbol set used to represent the Symbol. + + + + + Indicates the size of the symbol in points. + + + + + Defines the side SlidePanel slides into. + + + + + Represents the slider button that is used by SlidePanel when collapsed to slide it back into the view. + + + + + Initializes a new instance of the SliderButton class. + + + + + + Called when AutoTopMostEnabled property has changed. + + Old property value + New property value + + + + Called when SliderSize property has changed. + + Old property value + New property value + + + + Called when ActiveSliderSize property has changed. + + Old property value + New property value + + + + Called when IsActive property has changed. + + Old property value + New property value + + + + Called when IsMouseDown property has changed. + + Old property value + New property value + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Called when Symbol property has changed. + + Old property value + New property value + + + + Called when SymbolSet property value changes. + + Indciates old value + Indicates new value + + + + Called when SymbolSize property has changed. + + Old property value + New property value + + + + Gets or sets whether slider button automatically checks whether its top-most control on the form, i.e. visible at all times on top of other controls + + + + + Gets or sets the slider size in default state. Notice that size specified here applies to Left and Right SlidePanel positions. For Top and Bottom positions the Width and Height are interchaged. + + + + + Gets or sets the slider size in active state. Notice that size specified here applies to Left and Right SlidePanel positions. For Top and Bottom positions the Width and Height are interchaged. + + + + + Gets or sets whether slider button is in active state. + + + + + Gets or sets the style associated with the control. + + + + + Gets or sets the color of the Symbol. + + + + + Gets the realized symbol string. + + + + + Indicates the symbol displayed on face of the button instead of the image. Setting the symbol overrides the image setting. + + + + + Gets or sets the symbol set used to represent the Symbol. + + + + + Indicates the size of the symbol in points. + + + + + Represents the Slider control. + + + + + Raises the IncreaseButtonClick event. + + Provides event arguments + + + + Raises the DecreaseButtonClick event. + + Provides event arguments + + + + Raises the ValueChanged event. + + Provides event arguments + + + + Raises the ValueChanging event. + + + + + Advances the current position of the slider by the amount of the Step property. + + + + + Returns whether property should be serialized. Used by Windows Forms designer. + + + + + Resets the property to default value. Used by Windows Forms designer. + + + + + Forces the button to perform internal layout. + + + + + Called when Command property value changes. + + + + + Occurs after Value property has changed. + + + + + Occurs before Value property has changed. + + + + + Occurs when Increase button is clicked using mouse. + + + + + Occurs when Decrease button is clicked using mouse. + + + + + Gets or sets whether text-markup support is enabled for controls Text property. Default value is true. + Set this property to false to display HTML or other markup in the control instead of it being parsed as text-markup. + + + + + Gets or sets the text label position in relationship to the slider. Default value is Left. + + + + + Gets or sets whether the text label next to the slider is displayed. + + + + + Gets or sets the width of the label part of the item in pixels. Value must be greater than 0. Default value is 38. + + + + + Gets or sets the maximum value of the range of the control. + + + + + Gets or sets the minimum value of the range of the control. + + + + + Gets or sets the current position of the slider. + + + + + Gets or sets the amount by which a call to the PerformStep method increases the current position of the slider. Value must be greater than 0. + + + + + Gets or sets the color of the label text. + + + + + Gets or sets whether vertical line track marker is displayed on the slide line. Default value is true. + + + + + Gets or sets the tooltip for the Increase button of the slider. + + + + + Gets or sets the tooltip for the Decrease button of the slider. + + + + + Gets or sets the slider orientation. Default value is horizontal. + + + + + Gets the SliderItem. + + + + + Gets or sets the custom color table for the item. Color table here will override all system color table settings. + + + + + Gets or sets the command assigned to the item. Default value is null. + Note that if this property is set to null Enabled property will be set to false automatically to disable the item. + + + + + Gets or sets user defined data value that can be passed to the command when it is executed. + + + + + Represents the control which displays symbol from symbols library. + + + + + Initializes a new instance of the SymbolBox class. + + + + + Returns the color scheme used by control. Color scheme for Office2007 style will be retrieved from the current renderer instead of + local color scheme referenced by ColorScheme property. + + An instance of ColorScheme object. + + + + Resets style to default value. Used by windows forms designer. + + + + + Called when Symbol property has changed. + + Old property value + New property value + + + + Called when SymbolSet property value changes. + + Indciates old value + Indicates new value + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Called when SymbolSize property has changed. + + Old property value + New property value + + + + Specifies the background style of the control. + + + + + Gets the realized symbol string. + + + + + Indicates the symbol displayed on face of the button instead of the image. Setting the symbol overrides the image setting. + + + + + Gets or sets the symbol set used to represent the Symbol. + + + + + Gets or sets the color of the Symbol. + + + + + Indicates the size of the symbol in points. + + + + + Gets or sets the name of the color table. + + + + + Gets or sets the default tab colors. + + + + + Gets or sets the disabled tab colors. + + + + + Gets or sets the selected tab colors. + + + + + Gets or sets the colors when mouse is over the tab but tab is not selected. + + + + + Gets or sets colors for the tab close button. + + + + + Defines the color table for RibbonTabItem states. + + + + + Indicates item text color. + + + + + Gets or sets the background colors for the item. + + + + + Gets or sets the back colors gradient angle if there is more than one color in BackColors array. + + + + + Gets or sets the gradient colors positions if there is more than one color in BackColors array. + + + + + Gets or sets the item border colors. + + + + + Creates a copy of the state color table. + + + + + Defines color table for TabFormItem close button displayed on tabs. + + + + + Colors for the button in default state. + + + + + Colors for button in mouse over state. + + + + + Colors for button when pressed with mouse state. + + + + + Defines state color table for TabFormItem close button displayed on tabs. + + + + + Gets or sets the background colors for the item. + + + + + Gets or sets the back colors gradient angle if there is more than one color in BackColors array. + + + + + Gets or sets the gradient colors positions if there is more than one color in BackColors array. + + + + + Indicates item sign color. + + + + + Indicates item border color. + + + + + Gets or sets color table used by renderer. + + + + + Gets or sets Graphics object group is rendered on. + + + + + Gets or sets the reference to TabParentForm being rendered. + + + + + Indicates whether to cancel system rendering of the item. + + + + + Raises PrepareModalPanelBounds event. + + Provides event arguments. + + + + Initializes a new instance of the MetroForm class. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Called by StyleManager to notify control that style on manager has changed and that control should refresh its appearance if + its style is controlled by StyleManager. + + New active style. + + + + Shows the panel control in the center of the form and covers all non system controls making the panel effectively modal. + + Control to show. + + + + Shows the panel control in the center of the form by sliding it in from specified side and covers all non system controls making the panel effectively modal. + + Panel to show. + Side to slide panel into the view from. + + + + Shows the panel control in the center of the form by sliding it in from specified side and covers all non system controls making the panel effectively modal. + + Panel to show. + Side to slide panel into the view from. + Slide animation speed in milliseconds. + + + + Hides the panel control that was previously shown using ShowModalPanel method. + + Control to hide. + + + + Hides the panel control that was previously shown using ShowModalPanel method by sliding it out of the view to the specified side. + + Control to hide. + Side to slide control into. + + + + Gets effective Border Thickness for the form. + + Thickness + + + + Called when BorderThickness property has changed. + + Old property value + New property value + + + + Called when BorderColor property has changed. + + Old property value + New property value + + + + Called when WM_NCHITTEST message is received. + + Reference to message data. + Return true to call base form implementation otherwise return false. + + + + Called when WM_DWMCOMPOSITIONCHANGED message is received. + + Reference to message data. + Return true to call base form implementation otherwise return false. + + + + Called when WM_NCACTIVATE message is received. + + Reference to message data. + Return true to call base form implementation otherwise return false. + + + + Called when WM_NCCALCSIZE message is received. + + Message structure. + true to call base WndProc otherwise false. + + + + Occurs before modal panel is shown and allows change of modal panel bounds. + + + + + Gets or sets whether MetroShell is pre-rendered when form is shown to make first rendering smoother. Default value is true. + + + + + Gets whether at least one modal panel is displayed. + + + + + Indicates whether modal panel when displayed shows MetroStatusBar. + + + + + Returns whether Windows Glass effects are enabled. + + + + + Gets or sets the TabFormControl that is hosted by this form. This property is for internal use only. + + + + + Gets or sets whether form can be resized. + + + + + Gets or sets the form border thickness. Default value is empty thickness which indicates that thickness is taken from color table. + + + + + Gets or sets the form border colors. + + + + + Gets whether form is active. + + + + + Indicates the number of pixels subtracted from form's height or width (depending on taskbar position) when form is maximized and taskbar is in auto-hide state. Default value is 4. + + + + + This property is not to be used with MetroForm. + + + + + Gets or sets the size of the border on the edges of the form that when mouse is over allow for form resizing. + + + + + Indicates whether Close button in top-right corner of the form is visible. + + + + + This property cannot be used on MetroAppForm + + + + + This property cannot be used on MetroAppForm + + + + + This property cannot be used on MetroAppForm + + + + + This property cannot be used on MetroAppForm + + + + + Gets or sets text for form system menu Restore item. + + + + + Gets or sets text for form system menu Move item. + + + + + Gets or sets text for form system menu Size item. + + + + + Gets or sets text for form system menu Minimize item. + + + + + Gets or sets text for form system menu Maximize item. + + + + + Gets or sets text for form system menu Close item. + + + + + Represents Tabbed Forms control for creating tabbed user interface as replacement for MDI child forms. + + + + + Called by StyleManager to notify control that style on manager has changed and that control should refresh its appearance if + its style is controlled by StyleManager. + + New active style. + + + + Performs the setup of the TabFormPanel with the current style of the TabFormControl Control. + + Panel to apply style changes to. + + + + Creates new Tab at specified position, creates new associated panel and adds them to the control. + + Specifies the text displayed on the tab. + Specifies the name of the tab + Specifies the position of the new tab inside of Items collection. + New instance of the TabFormItem that was created. + + + + Creates new Tab and associated panel and adds them to the control. + + Specifies the text displayed on the tab. + Specifies the name of the tab + New instance of the TabFormItem that was created. + + + + Recalculates layout of the control and applies any changes made to the size or position of the items contained. + + + + + Occurs when text markup link is clicked. + + + + + Raises CreateNewTab event. + + Provides event arguments. + + + + Occurs when DotNetBar is looking for translated text for one of the internal text that are + displayed on menus, toolbars and customize forms. You need to set Handled=true if you want + your custom text to be used instead of the built-in system value. + + + + + Occurs when Item on control is clicked. + + + + + Occurs after selected tab has changed. You can use + TabFormControl.SelectedTab + property to get reference to newly selected tab. + + + + + Occurs when text markup link from TitleText markup is clicked. Markup links can be created using "a" tag, for example: + Markup link + + + + + Gets or sets whether anti-alias smoothing is used while painting. Default value is false. + + + + + Returns current number of tabs visible and hidden on the tab strip. + + + + + Indicates whether Form.Icon is shown in top-left corner. + + + + + + Gets or sets the Context menu bar associated with the this control which is used as part of Global Items feature. The context menu + bar assigned here will be used to search for the items with the same Name or GlobalName property so global properties can be propagated when changed. + You should assign this property to enable the Global Items feature to reach your ContextMenuBar. + + + + + Gets or sets whether custom caption and quick access toolbar provided by the control is visible. Default value is false. + This property should be set to true when control is used on MetroAppForm. + + + + + Gets or sets the font for the form caption text when CaptionVisible=true. Default value is NULL which means that system font is used. + + + + + Gets or sets the explicit height of the caption provided by control. Caption height when set is composed of the TabGroupHeight and + the value specified here. Default value is 0 which means that system default caption size is used. + + + + + Specifies the background style of the control. + + + + + Gets or sets the currently selected TabFormItem. TabFormItems are selected using the Checked property. Only a single + TabFormItem can be selected (Checked) at any given time. + + + + + Indicates whether new tab item which allows creation of new tab when clicked is visible. When visible you need to handle CreateNewTab event and create your new tab in event handler. + + + + + Occurs when new tab item is clicked by end user and allows you to create and add new tab to the control. + + + + + Returns reference to internal tab-strip control. + + + + + Returns collection of items on a bar. + + + + + Gets collection of items displayed in control captions, if it is visible (CaptionVisible=true). + + + + + Gets or sets the custom color table for the control. When set this color table overrides all system color settings for control. + + + + + Gets or sets whether mouse wheel scrolls through the tabs. Default value is true. + + + + + ImageList for images used on Items. Images specified here will always be used on menu-items and are by default used on all Bars. + + + + + ImageList for medium-sized images used on Items. + + + + + ImageList for large-sized images used on Items. + + + + + Gets or sets a value indicating whether the user can give the focus to this control using the TAB key. Default value is false. + + + + + Gets or sets the side tab-strip is docked to. + + + + + Gets or sets the font tab items are displayed with. + + + + + Gets or sets whether this TabFormControl was auto-created as result of end-user tearing off the tab. + + + + + Specifies dock side for tab form strip control. + + + + + Represents a tab in Tabbed Form user interface. + + + + + Initializes a new instance of the TabFormItem class. + + + + + Selects the tab. + + + + + Called after Checked property has changed. + + + + + Occurs just before Click event is fired. + + + + + Called when Visibility of the items has changed. + + New Visible state. + + + + Occurs after item visual style has changed. + + + + + Gets color table key for the default tab color table. + + + + + Gets color table key for the green tab color table. + + + + + Gets color table key for the magenta tab color table. + + + + + Gets color table key for the orange tab color table. + + + + + Gets color table key for the red tab color table. + + + + + Gets color table key for the blue tab color table. + + + + + Gets color table key for the yellow tab color table. + + + + + Gets color table key for the purple tab color table. + + + + + Gets color table key for the cyan tab color table. + + + + + Gets color table key for the blue mist tab color table. + + + + + Gets color table key for the purple mist tab color table. + + + + + Gets color table key for the tan tab color table. + + + + + Gets color table key for the lemon lime tab color table. + + + + + Gets color table key for the apple tab color table. + + + + + Gets color table key for the teal tab color table. + + + + + Gets color table key for the red chalk tab color table. + + + + + Gets color table key for the silver tab color table. + + + + + Gets or sets the close button bounds. + + + + + Gets or sets cached image rendering bounds. + + + + + Gets or sets cached text rendering bounds. + + + + + Gets or sets the additional padding added around the tab item in pixels. Default value is 0. + + + + + Indicates whether close button is visible on the tabs which when clicked closes the tab. Default value is true. + + + + + Gets or sets whether size of the tab has been reduced below the default calculated size. + + + + + Gets or sets the predefined color of the tab. Default value is eTabFormItemColor.Default + + + + + Gets or sets the panel assigned to this tab item. + + + + + Gets or set the Group item belongs to. The groups allows a user to choose from mutually exclusive options within the group. The choice is reflected by Checked property. + + + + + Returns the collection of sub items. + + + + + Indicates whether the item will auto-collapse (fold) when clicked. + When item is on popup menu and this property is set to false, menu will not + close when item is clicked. + + + + + Indicates whether the item will auto-expand when clicked. + When item is on top level bar and not on menu and contains sub-items, sub-items will be shown only if user + click the expand part of the button. Setting this propert to true will expand the button and show sub-items when user + clicks anywhere inside of the button. Default value is false which indicates that button is expanded only + if its expand part is clicked. + + + + + Gets or sets whether item can be customized by end user. + + + + + Gets or set a value indicating whether tab is selected. + + + + + Gets or sets whether Click event will be auto repeated when mouse button is kept pressed over the item. + + + + + Gets or sets the auto-repeat interval for the click event when mouse button is kept pressed over the item. + + + + + Gets or sets a value indicating whether the item is enabled. + + + + + Indicates item's visiblity when on pop-up menu. + + + + + Indicates when menu items are displayed when MenuVisiblity is set to VisibleIfRecentlyUsed and RecentlyUsed is true. + + + + + Indicates Animation type for Popups. + + + + + Indicates the font that will be used on the popup window. + + + + + Indicates whether sub-items are shown on popup Bar or popup menu. + + + + + Specifies the inital width for the Bar that hosts pop-up items. Applies to PopupType.Toolbar only. + + + + + Gets or sets whether item will display sub items. + + + + + Gets or sets whether the item expands automatically to fill out the remaining space inside the container. Applies to Items on stretchable, no-wrap Bars only. + + + + + Gets or sets the width of the expand part of the button item. + + + + + Gets or set the alternative shortcut text. + + + + + Gets or sets whether item separator is shown before this item. + + + + + Returns category for this item. If item cannot be customzied using the + customize dialog category is empty string. + + + + + Gets or sets the text color of the button when mouse is over the item. + + + + + Indicates the way item is painting the picture when mouse is over it. Setting the value to Color will render the image in gray-scale when mouse is not over the item. + + + + + Gets/Sets the button style which controls the appearance of the button elements. Changing the property can display image only, text only or image and text on the button at all times. + + + + + Indicates the array of colors that when set are used to draw the background of the item. + + + + + Gets or sets the custom color table for the tab. When set this color table overrides all color settings for a tab. + + + + + Specifies predefined color assigned to Tab Form Item. + + + + + Gets the TabFormItem this panel is associated with + + + + + Defines state color table for TabParentForm. + + + + + Gets or sets the colors for the top part of the background. + + + + + Gets or sets the back colors gradient angle if there is more than one color in BackColors array. + + + + + Gets or sets the gradient colors positions if there is more than one color in BackColors array. + + + + + Gets or sets the color of caption text. + + + + + Gets or sets the border colors. + + + + + Defines the internal container item for the ribbon strip control. + + + + + Creates new instance of the class and initializes it with the parent RibbonStrip control. + + Reference to parent RibbonStrip control + + + + Occurs after an item has been added to the container. This procedure is called on both item being added and the parent of the item. To distinguish between those two states check the item parameter. + + When occurring on the parent this will hold the reference to the item that has been added. When occurring on the item being added this will be null (Nothing). + + + + Paints this base container + + + + + Returns copy of GenericItemContainer item + + + + + Raises CreateNewTab event. + + Provides event arguments. + + + + Return Sub Item at specified location + + + + + Gets the list of the items displayed in form caption if its visible. + + + + + Gets or sets the scroll button width. + + + + + Indicates the scroll in pixels each time scroll button is pressed. + + + + + Gets reference to internal ribbon strip container that contains tabs and/or other items. + + + + + Gets reference to internal caption container item that contains the quick toolbar, start button and system caption item. + + + + + Indicates whether new tab item which allows creation of new tab when clicked is visible. When visible you need to handle CreateNewTab event and create your new tab in event handler. + + + + + Occurs when new tab item is clicked by end user and allows you to create and add new tab to the control. + + + + + Gets or sets a value indicating whether the item is expanded or not. For Popup items this would indicate whether the item is popped up or not. + + + + + When parent items does recalc size for its sub-items it should query + image size and store biggest image size into this property. + + + + + + Represents simple item container which orders items horizontally and support all ItemAlignment settings. + + + + + Initializes a new instance of the SimpleItemContainer class. + + + + + Returns copy of the item. + + + + + Copies the item specific properties to new instance of the item. + + New instance. + + + + Copies the item specific properties to new instance of the item. + + New instance. + + + + Sets whether container is used as system container internally by DotNetBar. + + true or false to indicate whether container is system container or not. + + + + Called when ItemSpacing property has changed. + + Old property value + New property value + + + + Gets or sets the minimum size of the container. Either Width or Height can be set or both. Default value is 0,0 which means + that size is automatically calculated. + + + + + Returns whether instance of the item container is used as system container internally by DotNetBar. + + + + + Indicates the spacing between items. + + + + + Indicates additional spacing between item when its BeginGroup property is set. + + + + + Specifies the layout orientation + + + + + Indicates whether all items are resized to be of the size equal to largest item in the container + + + + + Indicates left side padding within container. + + + + + Indicates right side padding within container. + + + + + Gets overlap spacing for specific item types specified by OverlapType in the container. + + + + + Gets the type of the item that will overlap. + + + + + Return Sub Item at specified location + + + + + Occurs after an item has been added to the container. This procedure is called on both item being added and the parent of the item. To distinguish between those two states check the item parameter. + + When occurring on the parent this will hold the reference to the item that has been added. When occurring on the item being added this will be null (Nothing). + + + + Occurs after an item has been removed. + + Item being removed. + + + + Gets or sets a value indicating whether the item is expanded or not. For Popup items this would indicate whether the item is popped up or not. + + + + + Represents tabbed UI strip control. + + + + + Called by StyleManager to notify control that style on manager has changed and that control should refresh its appearance if + its style is controlled by StyleManager. + + New active style. + + + + Occurs when text markup link is clicked. + + + + + Returns the color scheme used by control. Color scheme for Office2007 style will be retrived from the current renderer instead of + local color scheme referenced by ColorScheme property. + + An instance of ColorScheme object. + + + + Returns effective caption height. + + Caption height. + + + + Returns automatically calculated height of the control given current content. + + Height in pixels. + + + + Returns the collection of items with the specified name. + + Item name to look for. + + + + + Returns the collection of items with the specified name and type. + + Item name to look for. + Item type to look for. + + + + + Returns the collection of items with the specified name and type. + + Item name to look for. + Item type to look for. + Indicates whether GlobalName property is used for searching. + + + + + Returns the first item that matches specified name. + + Item name to look for. + + + + + Called when item on popup container is right-clicked. + + Instance of the item that is right-clicked. + + + + Starts moving of the parent form action which happens when user attempts to drag the form caption. + + + + + Returns true if point is inside the caption area. + + Client point coordinates. + True if point is inside of caption area otherwise false. + + + + Closes specified tab. + + Tab to close + Source of the event + + + + Raises RemovingToken event. + + Provides event arguments. + + + + Raises RemovingToken event. + + Provides event arguments. + + + + Raises BeforeTabFormItemDetach event. + + Provides event arguments. + + + + Raises TabFormItemDetach event. + + Provides event arguments. + + + + Occurs when text markup link from TitleText markup is clicked. Markup links can be created using "a" tag, for example: + Markup link + + + + + + Gets reference to parsed markup body element if text was markup otherwise returns null. + + + + + Gets or sets whether control can be customized and items added by end-user using context menu to the quick access toolbar. + Caption of the control must be visible for customization to be enabled. Default value is true. + + + + + Gets or sets the explicit height of the caption provided by control. Caption height when set is composed of the TabGroupHeight and + the value specified here. Default value is 0 which means that system default caption size is used. + + + + + Gets or sets whether custom caption line provided by the control is visible. Default value is false. + This property should be set to true when control is used on Office2007RibbonForm. + + + + + Gets or sets the font for the form caption text when CaptionVisible=true. Default value is NULL which means that system font is used. + + + + + Gets/Sets the visual style of the control. + + + + + Returns collection of items on a bar. + + + + + Returns currently selected TabFormItem. TabFormItems are selected using the Checked property. Only a single + TabFormItem can be Checked at any given time. + + + + + Indicates whether Form.Icon is shown in top-left corner. + + + + + Gets the reference to the internal container item for the items displayed in control caption. + + + + + Gets the reference to the internal container for the ribbon tabs and other items. + + + + + Indiciates the appearance of the tab form items rendered on the strip + + + + + Indicates whether end-user tab reordering is enabled, default value is true. + + + + + Indicates whether user can detach the tabs into the new forms using drag and drop. Default value is true. + + + + + Occurs before tab is closed and it allows canceling of the event. + + + + + Occurs after tab is closed. + + + + + Returns current number of tabs visile and hiden on the tab strip. + + + + + Indicates whether new tab item which allows creation of new tab when clicked is visible. When visible you need to handle CreateNewTab event and create your new tab in event handler. + + + + + Occurs before TabFormItem is detached and gives you opportunity to cancel the action or provide your own new TabParentForm and TabFormControl. + + + + + Occurs after TabFormItem has been detached and is added to the new form and tab control. + + + + + Defines delegate for the TabFormCloseTab event. + + + + + Defines delegate for the TabFormCloseTab event. + + + + + Allows to cancel the closing of the tab. + + + + + Reference to tab being closed. + + + + + Source of the event. + + + + + Defines delegate for the TabFormItemDetach event. + + + + + Defines delegate for the TabFormItemDetach event. + + + + + Gets or sets the reference to the form which will host newly detached TabFormItem and its panel, an instance of TabParentForm. You can provide your own instance of TabParentForm and TabControl to use instead of controls creating them. You must provide both TabParentForm and TabControl. Provide these in BeforeTabFormItemDetach event. + + + + + Gets or sets the reference to TabFormControl which will receive TabFormItem being dragged. If you provide your own TabParentForm and TabControl you must provide both. Provide these in BeforeTabFormItemDetach event. + + + + + Gets reference to the TabFormItem being detached. + + + + + Enables canceling of TabFormItem detachment from its parent. + + + + + Gets or sets Graphics object group is rendered on. + + + + + Gets or sets the reference to SwitchButtonItem being rendered. + + + + + Gets or sets the ItemPaintArgs reference. + + + + + Indicates whether to cancel system rendering of the item. + + + + + Called by StyleManager to notify control that style on manager has changed and that control should refresh its appearance if + its style is controlled by StyleManager. + + New active style. + + + + Raises CommandKeyDown event. + + Provides event arguments. + + + + Invalidates non-client area of the text box as response to the border changes. + + + + + Calculates and sets the text-box height based on font and style. This method is used internally and should not be used. + + + + + Returns the renderer control will be rendered with. + + The current renderer. + + + + Indicates whether property should be serialized by Windows Forms designer. + + + + + Resets the property to default value. + + + + + Invokes ButtonCustomClick event. + + + + + Invokes ButtonCustomClick2 event. + + + + + Returns the color scheme used by control. Color scheme for Office2007 style will be retrived from the current renderer instead of + local color scheme referenced by ColorScheme property. + + An instance of ColorScheme object. + + + + Occurs when ButtonCustom control is clicked. + + + + + Occurs when ButtonCustom2 control is clicked. + + + + + Indicates whether internal override for IsInputKey returns true for the Enter key. + + + + + Indicates whether all text is auto-selected when control gets input focus. Default value is false. + + + + + Gets or sets whether control prevents Beep sound when Enter key is pressed. + + + + + Gets or sets whether FocusHighlightColor is used as background color to highlight text box when it has input focus. Default value is false. + + + + + Gets or sets the color used as background color to highlight text box when it has input focus and focus highlight is enabled. + + + + + Occurs during preprocessing to handle command keys. Command keys are keys that always take precedence over regular input keys. Examples of command keys include accelerators and menu shortcuts. Set Handled=true to indicate that you handled the key and that it should not be passed for further processing. + + + + + Gets or sets the scrollbar skinning type when control is using Office 2007 style. + + + + + Specifies the control border style. Default value has Class property set so the system style for the control is used. + + + + + Gets or sets the rendering mode used by control. Default value is eRenderMode.Global which means that static GlobalManager.Renderer is used. If set to Custom then Renderer property must + also be set to the custom renderer that will be used. + + + + + Gets or sets the custom renderer used by the items on this control. RenderMode property must also be set to eRenderMode.Custom in order renderer + specified here to be used. + + + + + Gets or sets whether watermark text is displayed when control is empty. Default value is true. + + + + + Gets or sets the watermark image displayed inside of the control when Text is not set and control does not have input focus. + + + + + Gets or sets the watermark image alignment. + + + + + Gets or sets the watermark (tip) text displayed inside of the control when Text is not set and control does not have input focus. This property supports text-markup. + + + + + Gets or sets the watermark font. + + + + + Gets or sets the watermark text color. + + + + + Gets or sets the watermark hiding behaviour. Default value indicates that watermark is hidden when control receives input focus. + + + + + Gets the object that describes the settings for the custom button that can execute an custom action of your choosing when clicked. + + + + + Gets the object that describes the settings for the custom button that can execute an custom action of your choosing when clicked. + + + + + Specifies back color when Enabled=false + + + + + Represents the Vertical Office 2007 Style Scroll Bar control. + + + + + Gets or sets whether custom styling (Office 2007 style) is enabled. Default value is true. + + + + + Class represents single token in TokenEditor control. + + + + + Initializes a new instance of the EditToken class. + + Indicates token value. + + + + Initializes a new instance of the EditToken class. + + Indicates token value + Indicates token text + + + + Initializes a new instance of the EditToken class. + + Indicates token value + Indicates token text + Indicates token image + + + + Called when Value property has changed. + + Old property value + New property value + + + + Called when Text property has changed. + + Old property value + New property value + + + + Called when Image property has changed. + + Old property value + New property value + + + + Called when Symbol property has changed. + + Old property value + New property value + + + + Called when SymbolSet property value changes. + + Indciates old value + Indicates new value + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Called when Tooltip property has changed. + + Old property value + New property value + + + + Called when MouseOverPart property has changed. + + Old property value + New property value + + + + Indicates the token value, for example an email token has email address as token Value and full name as token Text. + + + + + Indicates the token text, for example an email token has email address as token Value and full name as token Text. + + + + + Gets or sets custom data associated with the object. + + + + + Gets the display bounds of the token, if displayed, inside of TokenEditor control. + + + + + Indicates the image that is displayed next to the token + + + + + Gets the realized symbol string. + + + + + Indicates the symbol displayed on face of the token instead of the image. Setting the symbol overrides the image setting. + + + + + Gets or sets the symbol set used to represent the Symbol. + + + + + Gets or sets the color of the Symbol. + + + + + Indicates tooltip that is displayed when mouse is over the token and token is selected. + + + + + Gets the part of the token mouse is over. Valid only when token is selected. + + + + + Gets the bounds of the remove button if displayed. Valid only when token is selected. + + + + + Gets the bounds of the image if displayed. Valid only when token is selected. + + + + + Indicates whether token is selected. + + + + + Indicates whether token is focused while selected. + + + + + Defines the token parts. + + + + + Identifies no token part. + + + + + Identifies the token body/text. + + + + + Identifies the remove token button. + + + + + Identifies the token image. + + + + + Initializes a new instance of the TokenEditor class. + + + + + Returns the color scheme used by control. Color scheme for Office2007 style will be retrieved from the current renderer instead of + local color scheme referenced by ColorScheme property. + + An instance of ColorScheme object. + + + + Resets style to default value. Used by windows forms designer. + + + + + Raises SelectedTokensChanged event. + + Provides event arguments. + + + + Called when RemoveTokenButtonVisible property has changed. + + Old property value + New property value + + + + Returns the token from SelectedTokens at specified position or null/nothing if no token is at given location. + + Location in client coordinates to test. + EditToken instance or null/nothing + + + + Raises TokenMouseEnter event. + + Provides event arguments. + + + + Raises TokenMouseLeave event. + + Provides event arguments. + + + + Raises TokenMouseClick event. + + Provides event arguments. + + + + Raises TokenMouseClick event. + + Provides event arguments. + + + + Raises TokenMouseHover event. + + Provides event arguments. + + + + Raises RemovingToken event. + + Provides event arguments. + + + + Called when ReadOnly property has changed. + + Old property value + New property value + + + + Called when DropDownHeight property has changed. + + Old property value + New property value + + + + Called when DropDownWidth property has changed. + + Old property value + New property value + + + + Raises AutoCompletePopupOpened event. + + Provides event arguments. + + + + Raises BeforeAutoCompletePopupOpen event. + + Provides event arguments. + + + + Raises BeforePopupOpen event. + + Provides event arguments. + + + + Raises ValidateToken event. + + Provides event arguments. + + + + Indicates whether property should be serialized by Windows Forms designer. + + + + + Resets the property to default value. + + + + + Called when TextSeparator property has changed. + + Old property value + New property value + + + + Called when DropDownButtonVisible property has changed. + + Old property value + New property value + + + + Called when CheckBoxesVisible property has changed. + + Old property value + New property value + + + + Shows tooltip for this item. + + + + + Destroys tooltip window. + + + + + Gets or sets the location of the auto-scroll position. + + + + + Specifies the background style of the control. + + + + + Gets the collection of the selected tokens. + + + + + Occurs when SelectedTokens collection changes. + + + + + Gets the collection of the tokens available for selection. + + + + + Indicates whether remove token button is displayed on individual tokens so they can be removed from the selection. + + + + + Occurs when mouse enters one of the SelectedTokens token. + + + + + Occurs when mouse leaves one of the SelectedTokens token. + + + + + Occurs when mouse clicks one of the SelectedTokens token. + + + + + Occurs when mouse double clicks one of the SelectedTokens token. + + + + + Occurs when mouse hovers one of the SelectedTokens token. + + + + + Occurs before token is removed from the SelectedTokens by end user. + + + + + Indicates whether tokens can be added or removed by end user. Default value is false. + + + + + Indicates the height of the auto-complete drop-down. + + + + + Indicates the width of the auto-complete drop-down. + + + + + Indicates whether when token text is entered into the text-box pressing the Enter key attempts to validate the token and converts the text to token. + + + + + Occurs before token auto-complete popup is displayed and allows cancelation of popup display. + + + + + Occurs after auto-complete popup is open. + + + + + Occurs before the auto-complete popup is displayed and allows you to adjust popup location. + + + + + Indicates how tokens are filtered based on the entered text + + + + + Indicates whether auto-complete popup size is preserved between popup displays if popup is resized by end-user. + + + + + Indicates whether auto-complete popup can be resized by end user. + + + + + Indicates whether multi-column popup close button is visible. + + + + + Gets or sets whether auto-complete popup window is open. + + + + + Gets the list of separators which are used to divide entered text into the tokens. + + + + + Occurs when an token is selected from the auto-complete list or when text entry by end user is parsed into token to validate it. + + + + + Indicates whether control automatically increases its height as more tokens are selected. MaxHeightLines property controls the maximum number of lines control will grow to before showing scroll-bar. + + + + + Indicates maximum number of lines control will grow to when AutoSizeHeight=true. Set to 0 to indicates unlimited growth. + Default value is 5. + + + + + Gets reference to internal text-box control that is used to input the token text. + + + + + Indicates whether any text entered into the token editor is validated and converted to token when control loses focus. + + + + + Gets or sets whether watermark text is displayed when control is empty. Default value is true. + + + + + Gets or sets the watermark image displayed inside of the control when Text is not set and control does not have input focus. + + + + + Gets or sets the watermark image alignment. + + + + + Gets or sets the watermark (tip) text displayed inside of the control when Text is not set and control does not have input focus. This property supports text-markup. + + + + + Gets or sets the watermark font. + + + + + Gets or sets the watermark text color. + + + + + Gets or sets the watermark hiding behaviour. Default value indicates that watermark is hidden when control receives input focus. + + + + + Indicates the character separator that is used to separate tokens when controls Text property is updated or parsed. + + + + + Indicates whether drop-down button which shows available token popup is displayed + + + + + Indicates whether check-boxes are displayed on popup token selection list and used for token selection. + + + + + Occurs when item's tooltip visibility has changed. + + + + + Gets or sets whether tooltips are shown when mouse is over the selected token when Tooltip property is set. + + + + + Delegate for the ValidateTokenEvent event. + + + + + Arguments for the ValidateTokenEvent event. + + + + + Indicates whether validated token is valid. Default value is true. When you set this property to false the token being validated will be discared. + + + + + Indicates the Token that will be accepted by the control if IsValid=true. + + + + + Indicates whether token is newly created. When false it means that token was taken from Tokens collection. + + + + + Initializes a new instance of the ValidateTokenEventArgs class. + + + + + + Delegate for RemovingToken event. + + + + + Defines event arguments for RemovingToken event. + + + + + Indicates the Token that will be removed. + + + + + Set to true to cancel removal of the token. + + + + + Indicates the source of the event. + + + + + Initializes a new instance of the RemovingTokenEventArgs class. + + + + + + Specifies the filter behavior on token editor popup list. + + + + + Token text is searched for the match. + + + + + Token value is searched for the match. + + + + + Both token text and value are searched for the match. + + + + + Delegate for TokenEditor.BeforePopupOpen event. + + + + + Defines event arguments for BeforePopupOpen event. + + + + + Gets or sets the screen location of the popup in relation to the TokenEditor control. + + + + + Gets the suggested popup size. + + + + + Initializes a new instance of the TokenEditorPopupEventArgs class. + + + + + + Represents the color table for TokenEditor control tokens. + + + + + Initializes a new instance of the TokenEditorColorTable class. + + + + + Initializes a new instance of the TokenEditorColorTable class. + + + + + Initializes a new instance of the TokenEditorColorTable class. + + + + + Gets or sets token default state colors. + + + + + Gets or sets token mouse over state colors. + + + + + Gets or sets token focused state colors. + + + + + Represents the state color table for token in TokenEditor control. + + + + + Initializes a new instance of the TokenColorTable class. + + + + + Initializes a new instance of the TokenColorTable class. + + + + + + + Initializes a new instance of the TokenColorTable class. + + + + + + + Gets or sets token text color. + + + + + Gets or sets the background color table. + + + + + Represents non-intrusive Warning Box control with Options and Close button. + + + + + Called by StyleManager to notify control that style on manager has changed and that control should refresh its appearance if + its style is controlled by StyleManager. + + New active style. + + + + Raises the CloseClick event. + + Event arguments. + + + + Raises the OptionsClick event. + + Event arguments. + + + + Updates control color scheme based on currently selected Office 2007 Color Table. Usually it is not necessary to + call this method manually. You need to call it to update the colors on control if you customize the Office2007ColorTable.WarningBox values. + + + + + Invokes the MarkupLinkClick event. + + Provides additional data about event. + + + + Called when AntiAlias property has changed. + + Old property value + New property value + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Occurs when Close button is clicked. + + + + + Occurs when Options button is clicked. + + + + + Occurs when warning text markup link is clicked. Markup links can be created using "a" tag, for example: + Markup link + + + + + Gets or sets the text displayed on close button tooltip. + + + + + Gets or sets the text displayed on warning control label. Supports text-markup. + + + + + Gets or sets whether text is wrapped on multiple lines if it cannot fit the space allocated to the control. + + + + + Gets or sets the image displayed next to the warning label text. Default value is null. + + + + + Gets or sets the text for the Options buttons. + + + + + Gets or sets whether Options button is visible. Default value is true. + + + + + Gets or sets whether Close button is visible. Default value is true. + + + + + Gets or sets the timeout in seconds after which the control automatically closes itself. Default value is 0 which indicates that auto-close + is disabled. + + + + + Gets or sets the control's color scheme. + + + + + Gets or sets whether anti-alias smoothing is used while painting. Default value is true. + + + + + Defines available WarningBox control color schemes. + + + + + Represents compact tree bread-crumb control. + + + + + Initializes a new instance of the CrumbBar class. + + + + + Finds CrumbBarItem with specified name. + + Name of item to look for + Item or null if no item was found. + + + + Sets the currently selected item in the control. + + Reference to selected item. + Source of the event. + + + + Shows the selected item popup menu if it has menu items. + + true if popup was shown otherwise false + + + + Gets whether an item is in selected path to the currently selected item as either one of the parents of selected item + or selected item itself. + + Item to test. + true if item is in selected path otherwise false. + + + + Returns the renderer control will be rendered with. + + The current renderer. + + + + Raises the SelectedItemChanging event. + + Provides event arguments. + + + + Raises the SelectedItemChanged event. + + Provides event arguments. + + + + Returns full path to the given node. + + Node to return path to. + Full path to the node. + + + + Occurs before SelectedItem has changed and provides opportunity to cancel the change. Set Cancel property on event arguments to true to cancel the change. + + + + + Occurs after SelectedItem has changed. The change of the selected item at this point cannot be canceled. For that use SelectedItemChanging event. + + + + + Gets or sets currently selected item. + + + + + Gets collection of items assigned to the control. + + + + + Gets or sets the visual style of the control. Default value is Windows Vista style. + + + + + Gets the color table used by the Vista style renderer. + + + + + Gets or sets a value indicating whether the control is automatically resized to display its entire contents. You can set MaximumSize.Width property to set the maximum width used by the control. + + + + + Gets or sets the delimiter string that the tree node path uses. + + + + + Defines delegate for CrumbBar selection events. + + + + + Provides data for CrumbBar selection events. + + + + + Gets or sets newly selected item. + + + + + Initializes a new instance of the CrumbBarSelectionEventArgs class. + + + + + + Represents an item for CrumbBar control. + + + + + Gets whether item is selected item in CrumbBar control. + + + + + Returns the collection of sub items. + + + + + Gets the path from the root tree node to the current tree node. The path consists of the labels of all the tree nodes that must be navigated to get to this tree node, starting at the root tree node. The node labels are separated by the delimiter character specified in the PathSeparator property of the Tree control that contains this node. + + + + + Represents collection of CrumbBarItem buttons. + + + + + Initializes a new instance of the CrumbBarItemsCollection class. + + + + + + Sets the node collection belongs to. + + CrumbBarItem that is parent of this collection. + + + + Adds new object to the collection. + + Object to add. + Index of newly added object. + + + + Inserts new object into the collection. + + Position of the object. + Object to insert. + + + + Returns index of the object inside of the collection. + + Reference to the object. + Index of the object. + + + + Returns whether collection contains specified object. + + Object to look for. + true if object is part of the collection, otherwise false. + + + + Removes specified object from the collection. + + + + + + Copies collection into the specified array. + + Array to copy collection to. + Starting index. + + + + Copies contained items to the CrumbBarItem array. + + Array to copy to. + + + + Gets or sets the node this collection is associated with. + + + + + Returns reference to the object in collection based on it's index. + + + + + Returns reference to the object in collection based on it's name. + + + + + Represents a view of CrumbBarItem displayed inside of CrumbBar control. + + + + + Initializes a new instance of the CrumbBarItemView class. + + + + + Returns copy of ExplorerBarContainerItem item + + + + + Gets the item attached to the view. + + + + + Gets or sets a value indicating whether the item is expanded or not. For Popup items this would indicate whether the item is popped up or not. + + + + + Gets or sets color table used by renderer. + + + + + Creates new instance of BaseItem. + + + + + Creates new instance of BaseItem and assigns item name. + + Item name. + + + + Creates new instance of BaseItem and assigns item name and item text. + + Item Name + Item Text + + + + Returns copy of ExplorerBarContainerItem item + + + + + Represents internal CrumbBar view container. + + + + + Initializes a new instance of the CrumbBarViewContainer class. + + + + + Recalculates the size of the item + + + + + Paints this base container + + + + + Returns copy of ExplorerBarContainerItem item + + + + + Occurs when sub item expanded state has changed. + + Sub item affected. + + + + Gets or sets a value indicating whether the item is expanded or not. For Popup items this would indicate whether the item is popped up or not. + + + + + Represents collection for Node objects. + + + + Creates new instance of the object. + + + + Adds new object to the collection. + + Object to add. + Index of newly added object. + + + + Inserts new object into the collection. + + Position of the object. + Object to insert. + + + + Returns index of the object inside of the collection. + + Reference to the object. + Index of the object. + + + + Returns whether collection contains specified object. + + Object to look for. + true if object is part of the collection, otherwise false. + + + + Removes specified object from the collection. + + + + + + Copies collection into the specified array. + + Array to copy collection to. + Starting index. + + + + Copies contained items to the Node array. + + Array to copy to. + + + + Returns reference to the object in collection based on it's index. + + + + + Returns reference to the object in collection based on it's name. + + + + + Provides High DPI support for DotNetBar controls. + + + + + Gets or sets whether scale factor when set is normalized so both Width and Height values are the same. Default value is false. + If using ScaleMode=font the scale factor might not be same for Width and Height so this allows opportunity to keep existing size ratios on the DotNetBar sized controls. + When set to true the scale factor Height will always be set to scale factor Width. + + + + + Indicates whether controls will automatically scale current images based on the current DPI. Depending on scaling this may result in pixalted images. + Best policy is to provide separate images for each DPI level Windows runs on and if you do that you need to set this property to false to disable + automatic size scaling for the images. Default value is true which causes the images to be upscaled. + + + + + Initializes a new instance of the DualButton class. + + + + + Called when ButtonSize property has changed. + + Old property value + New property value + + + + Called when Text2 property has changed. + + Old property value + New property value + + + + Called when MouseOverPart property has changed. + + Old property value + New property value + + + + Called when LeftMouseButtonDownPart property has changed. + + Old property value + New property value + + + + Called when Command property value changes. + + + + + Called when IsSelected property has changed. + + Old property value + New property value + + + + Called when Font property has changed. + + Old property value + New property value + + + + Gets or sets the second button part text. + + + + + Gets or sets the command assigned to the item. Default value is null. + Note that for ButtonItem instances if this property is set to null and command was assigned previously, Enabled property will be set to false automatically to disable the item. + + + + + Gets or sets user defined data value that can be passed to the command when it is executed. + + + + + Gets or sets the selected part of button. + + + + + Gets or sets the text font. + + + + + Standalone Calculator control. + + + + + Raises CalculatorDisplayChanged event. + + Provides event arguments. + + + + Invalidates control auto-size and resizes the control if AutoSize is set to true. + + + + + Called when FocusButtonsOnMouseDown property has changed. + + Old property value + New property value + + + + Called when DisplayVisible property has changed. + + Old property value + New property value + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Occurs when a calc button has been clicked + + + + + Occurs when the calculator value has changed + + + + + Indicates whether calculator displays only Integer values. + + + + + Gets or sets whether memory keys are visible. Default value is true. + + + + + Gets or sets visibility of the decimal calculator key. + + + + + Gets or sets a value indicating whether the control is automatically resized to display its entire contents. You can set MaximumSize.Width property to set the maximum width used by the control. + + + + + Gets or sets whether calculator display is visible. Default value is true. + + + + + ButtonClickEventArgs + + + + + ButtonClickEventArgs + + + + + Gets the calc button that was clicked + + + + + ValueChangedEventArgs + + + + + ValueChangedEventArgs + + + + + + + Gets the input string value + + + + + Gets or sets calculator value + + + + + Represents a control that enables the user to select time using visual time display. + + + + + Raises SelectedTimeChanged event. + + Provides event arguments. + + + + Raises OkClick event. + + Provides event arguments. + + + + Initializes a new instance of the MonthCalendarAdv class. + + + + + Returns whether property should be serialized. + + + + + Resets property to default value. + + + + + Invalidates control auto-size and resizes the control if AutoSize is set to true. + + + + + Occurs after SelectedTime changes. + + + + + Occurs when OK button is clicked. + + + + + Gets or sets the text displayed on OK button. + + + + + Gets or sets whether Ok button is visible. + + + + + Gets or sets the selected date time. + + + + + Gets or sets selected time. Returns TimeSpan.Zero if there is no time selected. + + + + + Gets or sets the time format used to present time by the selector. + + + + + Gets or sets the format for the 12 Hour Time Display. + + + + + Gets or sets the format for the 24 Hour Time Display. + + + + + Gets or sets a value indicating whether the control is automatically resized to display its entire contents. You can set MaximumSize.Width property to set the maximum width used by the control. + + + + + Indicates the type of the selector used to select time. + + + + + Gets or sets the text displayed on Clear button only when MonthCalendarStyle is used. + + + + + Gets or sets the text displayed on Hour label. + + + + + Gets or sets the text displayed on Minute label. + + + + + Represents the Time selector item. + + + + + Initializes a new instance of the TimeSelectionItem class. + + + + + Raises SelectedTimeChanged event. + + Provides event arguments. + + + + Raises OkClick event. + + Provides event arguments. + + + + Returns whether property should be serialized. + + + + + Resets property to default value. + + + + + Called when SelectedTime property has changed. + + Old property value + New property value + + + + Called when TimeFormat24H property has changed. + + Old property value + New property value + + + + Called when TimeFormat12H property has changed. + + Old property value + New property value + + + + Called when SelectedDateTime property has changed. + + Old property value + New property value + + + + Called when OkText property has changed. + + Old property value + New property value + + + + Called when ClearText property has changed. + + Old property value + New property value + + + + Called when TimeFormat property has changed. + + Old property value + New property value + + + + Called when OkButtonVisible property has changed. + + Old property value + New property value + + + + Called when ClearButtonVisible property has changed. + + Old property value + New property value + + + + Called when SelectorType property has changed. + + Old property value + New property value + + + + Called when HourText property has changed. + + Old property value + New property value + + + + Called when MinuteText property has changed. + + Old property value + New property value + + + + Occurs after SelectedTime changes. + + + + + Occurs when OK button is clicked. + + + + + Gets or sets selected time. Returns TimeSpan.Zero if there is no time selected. + + + + + Gets or sets the format for the 24 Hour Time Display. + + + + + Gets or sets the format for the 12 Hour Time Display. + + + + + Gets or sets the selected date time. + + + + + Gets or sets the text displayed on OK button. + + + + + Gets or sets the text displayed on Clear button only when MonthCalendarStyle is used. + + + + + Gets or sets the time format used to present time by the selector. + + + + + Gets or sets whether Ok button is visible. + + + + + Gets or sets whether Ok button is visible. + + + + + Indicates the type of the selector used to select time. + + + + + Gets or sets the text displayed on Hour label. + + + + + Gets or sets the text displayed on Minute label. + + + + + Defines time selector format. + + + + + Selector uses system format. + + + + + Selector uses 24-hour time format. + + + + + Selector uses 12-hour time format. + + + + + Defines the TimeSelector styles. + + + + + Time selector uses style similar to MonthCalendarStyle. + + + + + Time selector uses the touch style. + + + + + Represents the group of the input items with automatic and manual item focus change. + + + + + Raises the RenderInvalid event. + + + + + Raises the ArrangeInvalid event. + + + + + Raises the ResetMouseHover event. + + + + + Occurs when item arrange becomes invalid. + + + + + Occurs when item appearance becomes invalid and items needs to be repainted. + + + + + Occurs when item needs to signal to parent control that MouseHover needs to be reset usually in response to tooltip hiding. + + + + + Occurs when item is clicked. + + + + + Occurs when item is clicked using mouse. + + + + + Occurs when mouse button is pressed over the item. + + + + + Occurs when mouse button is pressed over the item. + + + + + Occurs when mouse hovers over the item. + + + + + Gets or sets whether item is Enabled. + + + + + Gets or sets whether visual is rendered. Default value is true. + + + + + Gets the parent of the item. + + + + + Gets the relative location of the element inside of its parent item. + + + + + Gets or sets the item horizontal alignment inside of the parent group. Default value is left. + + + + + Occurs when child item input is complete. Method should be used to forward the input focus onto the different field if desired. + + + + + Occurs when input stack on the child control has changed. + + Control on which input has changed + + + + Occurs when input stack on the child control has changed. + + Control on which input has changed + + + + Gets or sets the horizontal spacing in pixels between the items. + + + + + Gets or sets whether visual is root visual directly parented to the control. + + + + + Gets or sets group vertical alignment. Default value is middle. + + + + + Gets or sets input group horizontal alignment. Default value is left. + + + + + Resets the input position so the new input overwrites current value. + + + + + Updates the IsEmpty property value based on the contained input controls. + + + + + Gets or sets whether Tab key is used to navigate between the fields. Default value is true. + + + + + Gets or sets whether Enter key is used to navigate between input fields. Default value is true. + + + + + Gets or sets whether Arrow keys are used to navigate between input fields. Default value is true. + + + + + Gets or sets whether input focus is automatically advanced to next input field when input is complete in current one. + + + + + Gets or sets whether input items are read-only. + + + + + Gets or sets whether input group is empty i.e. it does not hold any value. + + + + + Gets or sets whether auto-overwrite functionality for input is enabled. When in auto-overwrite mode input field will erase existing entry + and start new one if typing is continued after InputComplete method is called. + + + + + Gets or sets whether current input is the user input. + + + + + List of characters that when pressed would select next input field. + + + + + Initializes a new instance of the IPAddressGroup class. + + + + + Describes the Elliptical Shape. + + + + + Returns the shape that fits given bounds. + + Bounds to fit shape in. + GraphicsPath representing shape or null if shape cannot be created. + + + + Returns the inner shape based on the specified border size. + + Bounds to fit shape in. + GraphicsPath representing shape or null if shape cannot be created. + + + + Returns whether shape can be drawn given the bounds. + + Bounds to test. + true if shape can be drawn inside of bounds otherwise false. + + + + Represents EllipticalShapeDescriptor object converter. + + + + + Initializes FormatHelper class. + + + + + Defines an interface that represents the Command associated with an BaseItem instance. + + + + + Executes the command without specifying the source of the command. + + + + + Executes the command and specifies the source of the command. + + + + + Called when CommandSource is registered for the command. + + CommandSource registered. + + + + Called when CommandSource is unregistered for the command. + + CommandSource unregistered. + + + + Sets an property value on the subscribers through the reflection. If subscriber does not have + specified property with value type its value is not set. + + Property name to set. + Property value. + + + + Executes the code associated with the command. + + + + + Provides the opportunity to cancel the execution of the command. This event occurs before the Executed event. + + + + + Gets or sets the text associated with the items that are using command. + + + + + Gets or sets the value of Checked property if item associated with the command support it. + + + + + Gets or sets the value of Visible property if item associated with the command support it. + + + + + Gets or sets the value of Image property if item associated with the command support it. + + + + + Gets or sets the value of small image (ImageSmall) property if item associated with the command support it. + + + + + Gets or sets the value of Enabled property for items associated with the command. + + + + + Defines an command that is associated with an instance of BaseItem + + + + + Initializes a new instance of the Command class with the specified container. + + An IContainer that represents the container for the command. + + + + Initializes a new instance of the Command class with the specified container. + + An IContainer that represents the container for the command. + + + + Initializes a new instance of the Command class with the specified execute event handler. + + + + + Initializes a new instance of the Command class. + + + + + Executes the command. + + + + + Executes the command. + + + + + Raises the Execute event. + + Provides event data. + + + + Raises the PreviewExecuted event. + + Provides event data. + + + + Called when Text property is set. + + + + + Sets the Text property on all subscribers to the command Text. + + + + + Sets an property value on the subscribers through the reflection. If subscriber does not have + specified property with value type its value is not set. + + Property name to set. + Property value. + + + + Gets whether property is set and whether it will be applied to items associated with the command. + + + + + + Resets the property to its default value and disables its propagation to items that are associated with command. + + + + + Gets whether property is set and whether it will be applied to items associated with the command. + + + + + + Resets the property to its default value and disables its propagation to items that are associated with command. + + + + + Gets whether property is set and whether it will be applied to items associated with the command. + + + + + + Resets the property to its default value and disables its propagation to items that are associated with command. + + + + + Gets whether property is set and whether it will be applied to items associated with the command. + + + + + + Resets the property to its default value and disables its propagation to items that are associated with command. + + + + + Gets whether property is set and whether it will be applied to items associated with the command. + + + + + + Resets the property to its default value and disables its propagation to items that are associated with command. + + + + + Gets whether property is set and whether it will be applied to items associated with the command. + + + + + + Resets the property to its default value and disables its propagation to items that are associated with command. + + + + + Called when CommandSource is registered for the command. + + CommandSource registered. + + + + Called when CommandSource is unregistered for the command. + + CommandSource unregistered. + + + + Executes the code associated with the command when an instance of BaseItem is clicked. + + + + + Occurs before the Executed event and allows you to cancel the firing of Executed event. + + + + + Gets or sets the Text that is assigned to all command sources that are using this command and have Text property. + + + + + Gets or sets the value for the Checked property that is assigned to the command subscribers using this command and have Checked property. + + + + + Gets whether the command is in process of syncing its state to all subscribers. + + + + + Gets or sets the value for the Visible property that is assigned to the command subscribers using this command and have Visible property. + + + + + Gets or sets the image that is assigned to the command subscribers using this command and have Image property. + + + + + Gets or sets the small image that is assigned to the command subscribers using this command and have ImageSmall property. + + + + + Gets or sets the value for Enabled property assigned to the command subscribers using this command and have Enabled property. + + + + + Returns name of the node that can be used to identify it from the code. + + + + + Defines an container where you can arrange child elements added to SubItems collection either horizontally or vertically, relative to each other using SetDock and GetDock methods. + + + + + Initializes a new instance of the ItemDockContainer class. + + + + + Returns copy of the item. + + + + + Copies the ButtonItem specific properties to new instance of the item. + + New ButtonItem instance. + + + + Copies the ButtonItem specific properties to new instance of the item. + + New ButtonItem instance. + + + + Recalculates the size of the container. Assumes that DisplayRectangle.Location is set to the upper left location of this container. + + + + + Called after TopInternal property has changed + + + + + Called after LeftInternal property has changed + + + + + Must be overridden by class that is inheriting to provide the painting for the item. + + + + + Retrieves the docking for specified item. + + + + + Sets the docking within container for specified item. + + Item to set docking for. + Docking value. + + + + Returns empty container default design-time size. + + Size of an empty container. + + + + Occurs when the mouse pointer is over the item and a mouse button is pressed. This is used by internal implementation only. + + + + + Return Sub Item at specified location + + + + + Gets or sets a value that indicates whether the last child element within a ItemDockContainer stretches to fill the remaining available space. + + + + + IBlock member implementation + + + + + Provides binding support for ItemPanel control. + + + + + Initializes a new instance of the ItemVisualGenerator class. + + + + + + Called when Bindings property has changed. + + Old property value + New property value + + + + Called when VisualTemplate property has changed. + + Old property value + New property value + + + + When overridden in a derived class, sets the specified array of objects in a collection in the derived class. + + An array of items. + + + + Creates a new item from template for the data. + + Data to create item for. + New instance of the BaseItem. + + + + When overridden in a derived class, sets the object with the specified index in the derived class. + + The array index of the object. + The object. + + + + When overridden in a derived class, resynchronizes the item data with the contents of the data source. + + + + + Gets or sets the data source for the ComboTree. Expected is an object that implements the IList or IListSource interfaces, + such as a DataSet or an Array. The default is null. + + + + + Gets or sets the visual template that is generated for each data item. + + + + + + Defines delegate for data visual creation based events. + + + + + Defines event arguments for data visual creation based events. + + + + + Gets or sets the visual that is created for data item. + + + + + Gets the data-item node is being created for. + + + + + Initializes a new instance of the DataNodeEventArgs class. + + + + + + + Defines BorderColors structure used to define border colors. + + + + + Creates new instance of the object. + + Uniform BorderColors + + + + Creates new instance of the object. + + Left BorderColors + Top BorderColors + Right BorderColors + Bottom BorderColors + + + + Gets whether object equals to this instance. + + object to test. + returns whether objects are Equals + + + + Gets whether object equals to this instance. + + object to test. + returns whether objects are Equals + + + + Returns hash code for object. + + Hash code + + + + Returns string representation of object. + + string representing BorderColors + + + + Gets string representation of object. + + Culture info. + string representing BorderColors + + + + Returns whether all values are empty. + + + + + Returns whether all values are the same. + + + + + Gets or sets the left BorderColors. + + + + + Gets or sets the top BorderColors. + + + + + Gets or sets the Right BorderColors. + + + + + Gets or sets the Bottom BorderColors. + + + + + Provides BorderColors TypeConverter. + + + + + Gets or sets the background color. + + + + + Gets or sets the canvas light shade color. This property is not directly used but it is provided for reference. + + + + + Gets or sets the canvas lighter shade color. This property is not directly used but it is provided for reference. + + + + + Gets or sets the foreground color. + + + + + Gets or sets the base metro color. + + + + + Gets or sets background color of edit controls. + + + + + Gets or sets the color table for MetroAppForm. + + + + + Gets or sets the color table for MetroForm. + + + + + Gets or sets the color table for MetroTab. + + + + + Gets or sets color table for MetroStatusBar. + + + + + Gets or sets color table for MetroToolbar. + + + + + Gets or sets the color table used by MetroTile items. + + + + + Gets or sets the metro-part colors that define the metro UI color scheme. These colors are provided for you reference and reuse in your app. + + + + + Represents class that defines parameters for Metro style color scheme. + + + + + Initializes a new instance of the MetroStyleParameters class. + + Canvas color. + Base color. + + + + Initializes a new instance of the MetroColorGeneratorParameters structure. + + Canvas color. + Base color. + User friendly theme name. + + + + Returns array of all predefined Metro color themes. + + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets or sets the color of the Metro canvas. + + + + + Gets or sets the base color for the Metro style. + + + + + Gets or sets the user friendly theme name. + + + + + Initializes the Metro UI color table based on colors specified. + + + + + Defines base set of Metro UI color scheme. + + + + + Gets or sets the base canvas color, like form background. + + + + + Gets or sets the chrome base color, used for window border, selection marking etc. + + + + + Gets or sets the text color for text displayed over the BaseColor. + + + + + Gets or sets the text color displayed over the canvas color. + + + + + Gets or sets the lighter text color used for example for inactive non selected tab text etc. + + + + + Gets or sets the text color used for disabled text. + + + + + Gets or sets the text light color. + + + + + Gets or sets the color that lighter than canvas color unless canvas is white in which case this will be white as well. + + + + + Gets or sets the color that is in dark shade off of the canvas color. + + + + + Gets or sets the color that is in darker shade off of the canvas color. + + + + + Gets or sets the color that is in light shade off of the canvas color. + + + + + Gets or sets the color that is in lighter shade off of the canvas color. + + + + + Gets or sets the light base color shade. + + + + + Gets or sets the just a tad lighter base color. + + + + + Gets or sets the text color for light base color. + + + + + Gets or sets the lighter base color shade. + + + + + Gets or sets the lightest base color shade. + + + + + Gets or sets the dark base color shade. + + + + + Gets or sets the darker base color shade. + + + + + Gets or sets the base color analogous color 1 + + + + + Gets or sets the Analogous color light variant. + + + + + Gets or sets the text color for Analogous color light variant. + + + + + Gets or sets the Analogous color dark variant. + + + + + Gets or sets the Analogous color darker variant. + + + + + Gets or sets the Analogous color text color. + + + + + Gets or sets the off base color button gradient start. + + + + + Gets or sets the off base color button gradient start. + + + + + Gets or sets background color of edit controls. + + + + + Represents the MetroAppForm color table. + + + + + Gets or sets the border thickness. + + + + + Gets or sets the border thickness for form when it is running on Windows without Glass effect enabled. + + + + + Gets or sets the border colors. + + + + + Gets or sets the inactive form border colors. + + + + + Represents the MetroForm color table. + + + + + Gets or sets the border thickness. + + + + + Gets or sets the border thickness for form when it is running on Windows without Glass effect enabled. + + + + + Gets or sets the border colors. + + + + + Gets or sets the inactive form border colors. + + + + + Gets or sets the color array for the top-border lines. + + + + + Gets or sets the color array for the bottom-border lines. + + + + + Gets or sets status bar background style. + + + + + Gets or sets the resize handle marker light color. + + + + + Gets or sets the resize handle marker color. + + + + + Gets or sets the color table for MetroTabStrip. + + + + + Gets or sets tab panel background style. + + + + + Gets or sets the color table for MetroTabItem. + + + + + Gets or sets the color of the active form caption text displayed on metro strip. + + + + + Gets or sets the color of the inactive form caption text displayed on metro strip. + + + + + Gets or sets the text formatting for caption text. + + + + + Represents MetroTabItem color table. + + + + + Gets or sets the default state tab colors. + + + + + Gets or sets the mouse over state tab colors. + + + + + Gets or sets the selected state tab colors. + + + + + Gets or sets the pressed state tab colors. + + + + + Gets or sets the disabled state tab colors. + + + + + Initializes a new instance of the MetroTabItemStateColorTable class. + + + + + + + Gets or sets the background style. + + + + + Gets or sets tabstrip background style. + + + + + Gets or sets the tile check-mark background overlay color. + + + + + Gets or sets the tile check-mark foreground overlay color. + + + + + Gets or sets toolbar background style. + + + + + Initializes the Visual Studio 2012 color scheme Metro color table based on colors specified. + + + + + Gets or sets color hue. Hue is value from 0-1 which determines the degree on color wheel color is on, i.e. 0.5 = 180 degrees + + + + + Gets or sets the color saturation from 0-1, i.e. 0-100%. + + + + + Gets or sets the amount of white and black in color. + + + + + Initializes a new instance of the HSVColor structure. + + + + + + + + Gets whether values are close. + + First value. + Second value + true if values are close enough + + + + Gets whether value is zero + + value to check + true if value is considered zero + + + + Gets whether value is not an number. + + value to test + true if value is not an number + + + + Represents the Metro application button used on MetroTab control. + + + + + Initializes a new instance of the MetroAppButton class. + + + + + Processes the Escape key when Application Button is hosting the backstage tab and uses it to close the tab if open. + This method is called from ProcessDialogKey method of MetroForm. + + Key data + true if key was used to close backstage tab + + + + Gets or sets a value indicating whether the item is expanded or not. For Popup items this would indicate whether the item is popped up or not. + + + + + Gets or sets whether control set on BackstageTab property is used on application menu popup. + + + + + Gets or sets the backstage tab that is displayed instead of popup menu. + + + + + Raises PrepareModalPanelBounds event. + + Provides event arguments. + + + + Initializes a new instance of the MetroForm class. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Called by StyleManager to notify control that style on manager has changed and that control should refresh its appearance if + its style is controlled by StyleManager. + + New active style. + + + + Shows the panel control in the center of the form and covers all non system controls making the panel effectively modal. + + Control to show. + + + + Shows the panel control in the center of the form by sliding it in from specified side and covers all non system controls making the panel effectively modal. + + Panel to show. + Side to slide panel into the view from. + + + + Shows the panel control in the center of the form by sliding it in from specified side and covers all non system controls making the panel effectively modal. + + Panel to show. + Side to slide panel into the view from. + Slide animation speed in milliseconds. + + + + Hides the panel control that was previously shown using ShowModalPanel method. + + Control to hide. + + + + Hides the panel control that was previously shown using ShowModalPanel method by sliding it out of the view to the specified side. + + Control to hide. + Side to slide control into. + + + + Gets effective Border Thickness for the form. + + Thickness + + + + Called when BorderThickness property has changed. + + Old property value + New property value + + + + Called when BorderColor property has changed. + + Old property value + New property value + + + + Called when WM_NCHITTEST message is received. + + Reference to message data. + Return true to call base form implementation otherwise return false. + + + + Called when WM_DWMCOMPOSITIONCHANGED message is received. + + Reference to message data. + Return true to call base form implementation otherwise return false. + + + + Called when WM_NCACTIVATE message is received. + + Reference to message data. + Return true to call base form implementation otherwise return false. + + + + Called when WM_NCCALCSIZE message is received. + + Message structure. + true to call base WndProc otherwise false. + + + + Occurs before modal panel is shown and allows change of modal panel bounds. + + + + + Gets or sets whether MetroShell is pre-rendered when form is shown to make first rendering smoother. Default value is true. + + + + + Gets whether at least one modal panel is displayed. + + + + + Indicates whether modal panel when displayed shows MetroStatusBar. + + + + + Returns whether Windows Glass effects are enabled. + + + + + Gets or sets the MetroTab that is hosted by this form. This property is for internal use only. + + + + + Gets or sets whether form can be resized. + + + + + Gets or sets the form border thickness. Default value is empty thickness which indicates that thickness is taken from MetroFormColorTable. + + + + + Gets or sets the form border colors. + + + + + Gets whether form is active. + + + + + Indicates the number of pixels subtracted from form's height or width (depending on taskbar position) when form is maximized and taskbar is in auto-hide state. Default value is 4. + + + + + This property is not to be used with MetroForm. + + + + + Gets or sets the size of the border on the edges of the form that when mouse is over allow for form resizing. + + + + + Indicates whether Close button in top-right corner of the form is visible. + + + + + This property cannot be used on MetroAppForm + + + + + This property cannot be used on MetroAppForm + + + + + This property cannot be used on MetroAppForm + + + + + This property cannot be used on MetroAppForm + + + + + Gets or sets text for form system menu Restore item. + + + + + Gets or sets text for form system menu Move item. + + + + + Gets or sets text for form system menu Size item. + + + + + Gets or sets text for form system menu Minimize item. + + + + + Gets or sets text for form system menu Maximize item. + + + + + Gets or sets text for form system menu Close item. + + + + + Initializes a new instance of the BorderOverlay class. + + + + + Delegate for PrepareModalPanelBounds event. + + + + + + + Provides data for PrepareModalPanelBounds event. + + + + + Gets or sets the bounds modal panel will occupy when shown. + + + + + Initializes a new instance of the ModalPanelBoundsEventArgs class. + + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Gets or sets whether divider panel that divides message box buttons and text content is visible. Default value is true. + + + + + Gets or sets whether Text supports and renders text markup. Default value is true. + + + + + Gets or sets the anti-alias setting for text-pane. + + + + + Enumeration of available common system strings. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Loads the items for the customization from MetroTab control. Registered MetroToolbar controls are enumerated and items + are added if they have CanCustomize=true. + + MetroTab control that holds references to known MetroToolbars. + + + + Gets reference to the internal Quick Access Toolbar Customization panel. + + + + + Represents Metro Tab control, usually used as application tab but can be used as standard tab control as well. + + + + + Raises SettingsButtonClick event. + + Provides event arguments. + + + + Raises HelpButtonClick event. + + Provides event arguments. + + + + Gets the name of the QAT Customize Item which is used to display the QAT Customize Dialog box. + + + + + Gets the name of the Add to Quick Access Toolbar context menu item. + + + + + Gets the name of the Remove from Quick Access Toolbar context menu item. + + + + + Gets the name of the QAT placement change context menu item. + + + + + Gets the name of the label displayed on Quick Access Toolbar customize popup menu. + + + + + Gets the string that is used as starting name for the frequently used QAT menu items created when QAT Customize menu is displayed. + + + + + Called by StyleManager to notify control that style on manager has changed and that control should refresh its appearance if + its style is controlled by StyleManager. + + New active style. + + + + Performs the setup of the MetroTabPanel with the current style of the MetroShell Control. + + Panel to apply style changes to. + + + + Creates new Rendering Tab at specified position, creates new associated panel and adds them to the control. + + Specifies the text displayed on the tab. + Specifies the name of the tab + Specifies the position of the new tab inside of Items collection. + New instance of the MetroTabItem that was created. + + + + Creates new Rendering Tab and associated panel and adds them to the control. + + Specifies the text displayed on the tab. + Specifies the name of the tab + New instance of the MetroTabItem that was created. + + + + Recalculates layout of the control and applies any changes made to the size or position of the items contained. + + + + + Occurs when text markup link is clicked. + + + + + Called when right-mouse button is pressed over MetroTabStrip + + Reference to MetroTabStrip object. + + + + Displays popup customize context menu for given customization object. + + Object that should be customized, usually an instance of BaseItem. + Indicates whether customize menu is displayed over metro tab strip + + + + Removes an item from the Quick Access Toolbar. + + Reference to the item that is already part of Quick Access Toolbar. + + + + Adds an instance of base type BaseItem to the Quick Access Toolbar. Note that this method creates + new instance of the item or an representation of the item being added and adds that to the Quick Access Toolbar. + + Reference to the item to add, must be an BaseItem type. + + + + Raises the BeforeCustomizeMenuPopup event. + + Event arguments + + + + Raises the BeforeAddItemToQuickAccessToolbar event. + + Event arguments. + + + + Shows the quick access toolbar customize dialog. + + + + + Applies the Quick Access Toolbar customization changes made on QatCustomizePanel to the MetroShell Control Quick Access Toolbar. Note that QatCustomizePanel.DataChanged property indicates whether user made any changes to the data on the panel. + + Reference to the QatCustomizePanel + + + + Raises the AfterQatDialogChangesApplied event. + + + + + Returns the Metro Application Button. + + reference to Application Button or null if button is not found. + + + + Registers the MetroToolbar or any other DotNetBar container that implements IOwner interface so it can participate in Quick Access Toolbar serialization and customization. + + + + + + Registers the MetroToolbar or any other DotNetBar container that implements IOwner interface so it can participate in Quick Access Toolbar serialization and customization. + + + + + + Occurs just before the customize popup menu is displayed and provides the ability to cancel the menu display as well + as to add/remove the menu items from the customize popup menu. + + + + + Occurs before an item is added to the quick access toolbar as result of user action. This event provides ability to + cancel the addition of the item by setting the Cancel=true of event arguments. + + + + + Occurs before an item is removed from the quick access toolbar as result of user action. This event provides ability to + cancel the addition of the item by setting the Cancel=true of event arguments. + + + + + Occurs when DotNetBar is looking for translated text for one of the internal text that are + displayed on menus, toolbars and customize forms. You need to set Handled=true if you want + your custom text to be used instead of the built-in system value. + + + + + Occurs when Item on metro tab strip or quick access toolbar is clicked. + + + + + Occurs before Quick Access Toolbar dialog is displayed. This event provides the opportunity to cancel the showing of + built-in dialog and display custom customization dialog. You can also set the Dialog property of the event arguments to + the custom dialog you want used instead of the DotNetBar system customization dialog. + + + + + Occurs after the Quick Access Toolbar dialog is closed. + + + + + Occurs after any changes done on the Quick Access Toolbar dialog are applied to the actual Quick Access Toolbar. + + + + + Occurs after selected Metro tab has changed. You can use + MetroShell.SelectedTab + property to get reference to newly selected tab. + + + + + Occurs when text markup link from TitleText markup is clicked. Markup links can be created using "a" tag, for example: + Markup link + + + + + Occurs when SETTINGS button, if displayed, is clicked. + + + + + Occurs when HELP button, if displayed, is clicked. + + + + + Gets the collection of the Quick Access Toolbar Frequently used commands. You should add existing buttons to this collection that + you already have on the MetroToolbar controls or on the application menu. The list will be used to construct the frequently used + menu that is displayed when Customize Quick Access Toolbar menu is displayed and it allows end-user to remove and add these + frequently used commands to the QAT directly from this menu. + Note that items you add here should not be items that are already on Quick Access Toolbar, i.e. in MetroShell.QuickToolbarItems collection. + + + + + Gets or sets whether KeyTips functionality is enabled. Default value is true. + + + + + Gets or sets whether anti-alias smoothing is used while painting. Default value is false. + + + + + Indicates whether Form.Icon is shown in top-left corner. + + + + + + Gets or sets the Context menu bar associated with the this control which is used as part of Global Items feature. The context menu + bar assigned here will be used to search for the items with the same Name or GlobalName property so global properties can be propagated when changed. + You should assign this property to enable the Global Items feature to reach your ContextMenuBar. + + + + + Gets or sets whether custom caption and quick access toolbar provided by the control is visible. Default value is false. + This property should be set to true when control is used on MetroAppForm. + + + + + Gets or sets the font for the form caption text when CaptionVisible=true. Default value is NULL which means that system font is used. + + + + + Gets or sets the explicit height of the caption provided by control. Caption height when set is composed of the TabGroupHeight and + the value specified here. Default value is 0 which means that system default caption size is used. + + + + + Gets or sets the font that is used to display Key Tips (accelerator keys) when they are displayed. Default value is null which means + that control Font is used for Key Tips display. + + + + + Specifies the background style of the control. + + + + + Gets or sets the currently selected MetroTabItem. MetroTabItems are selected using the Checked property. Only a single + MetroTabItem can be selected (Checked) at any given time. + + + + + Returns reference to internal metro tab-strip control. + + + + + Returns collection of items on a bar. + + + + + Returns collection of quick toolbar access and caption items. + + + + + Gets or sets whether mouse wheel scrolls through the Metro tabs. Default value is true. + + + + + ImageList for images used on Items. Images specified here will always be used on menu-items and are by default used on all Bars. + + + + + ImageList for medium-sized images used on Items. + + + + + ImageList for large-sized images used on Items. + + + + + Gets or sets a value indicating whether the user can give the focus to this control using the TAB key. Default value is false. + + + + + Gets or sets whether control can be customized and items added by end-user using context menu to the quick access toolbar. + Caption of the control must be visible for customization to be enabled. Default value is true. + + + + + Gets or sets whether external implementation for metro toolbar and menu item customization will be used for customizing the control. When set to true + it enables the displaying of MetroToolbar and menu item context menus which allow customization. You are responsible for + adding the menu items to context menu to handle all aspects of item customization. See "MetroShell Control Quick Access Toolbar Customization" topic in help file under How To. + Default value is false. + + + + + Gets or sets whether customize dialog is used to customize the quick access toolbar. You can handle the EnterCustomize event + to display your custom dialog instead of built-in dialog for customization. Default value is true. + + + + + Gets or sets the categorization mode for the items on Quick Access Toolbar customize dialog box. Default value categorizes + items by the toolbar they appear on. + + + + + Gets or sets the Quick Access Toolbar layout description. You can use the value obtained from this property to save + the customized Quick Access Toolbar into registry or into any other storage object. You can also set the saved layout description back + to restore user customize layout. + + + + + Gets or sets whether Quick Access Toolbar has been customized by end-user. You can use value of this property to determine + whether Quick Access Toolbar layout that can be accessed using QatLayout property should be saved. + + + + + Gets the reference to the Metro localization object which holds all system text used by the component. + + + + + Gets or sets the side tab-strip is docked to. + + + + + Gets or sets whether SETTINGS button is visible. + + + + + + Gets or sets the SETTINGS button text. + + + + + Gets or sets the HELP button text. + + + + + Gets or sets the font tab items are displayed with. + + + + + Describes the categorization mode used to categorize items on the Customize Metro dialog. + + + + + Items are automatically categorized by the toolbar they appear on. + + + + + Items are categorized by the Category property on each item. Category property should be set on each item. + + + + + Represents Metro-UI Status Bar control. + + + + + Initializes a new instance of the MetroStatusBar class. + + + + + Called when ResizeHandleVisible property has changed. + + Old property value + New property value + + + + Indicates whether items that cannot fit are displayed on popup. + + + + + Returns collection of items on a bar. + + + + + Gets or sets whether resize handle used to resize the parent form is visible. + + + + + Gets or sets spacing between items, default value is 2. + + + + + Defines the internal container item for the ribbon strip control. + + + + + Creates new instance of the class and initializes it with the parent RibbonStrip control. + + Reference to parent RibbonStrip control + + + + Paints this base container + + + + + Returns copy of GenericItemContainer item + + + + + Return Sub Item at specified location + + + + + Called when SettingsButtonText property has changed. + + Old property value + New property value + + + + Called when HelpButtonText property has changed. + + Old property value + New property value + + + + Gets reference to internal ribbon strip container that contains tabs and/or other items. + + + + + Gets reference to internal caption container item that contains the quick toolbar, start button and system caption item. + + + + + Gets or sets a value indicating whether the item is expanded or not. For Popup items this would indicate whether the item is popped up or not. + + + + + When parent items does recalc size for its sub-items it should query + image size and store biggest image size into this property. + + + + + Gets or sets whether Settings button is visible. + + + + + Gets or sets whether Help button is visible. + + + + + Gets or sets the Settings button text. + + + + + Represents Rendering Tab used on Metro Tab Control. + + + + + Initializes a new instance of the MetroTabItem class. + + + + + Selects the tab. + + + + + Called after Checked property has changed. + + + + + Occurs just before Click event is fired. + + + + + Called when Visibility of the items has changed. + + New Visible state. + + + + Occurs after item visual style has changed. + + + + + Gets or sets cached image rendering bounds. + + + + + Gets or sets cached text rendering bounds. + + + + + Gets or sets whether tab renders its state. Used internally by DotNetBar. Do not set. + + + + + Gets or sets the additional padding added around the tab item in pixels. Default value is 0. + + + + + Gets or sets whether size of the tab has been reduced below the default calculated size. + + + + + Gets or sets the predefined color of item. Color specified here applies to items with Office 2007 style only. It does not have + any effect on other styles. Default value is eMetroTabColor.Default + + + + + Gets or sets the panel assigned to this tab item. + + + + + Gets or set the Group item belongs to. The groups allows a user to choose from mutually exclusive options within the group. The choice is reflected by Checked property. + + + + + Returns the collection of sub items. + + + + + Indicates whether the item will auto-collapse (fold) when clicked. + When item is on popup menu and this property is set to false, menu will not + close when item is clicked. + + + + + Indicates whether the item will auto-expand when clicked. + When item is on top level bar and not on menu and contains sub-items, sub-items will be shown only if user + click the expand part of the button. Setting this propert to true will expand the button and show sub-items when user + clicks anywhere inside of the button. Default value is false which indicates that button is expanded only + if its expand part is clicked. + + + + + Gets or sets whether item can be customized by end user. + + + + + Gets or set a value indicating whether the button is in the checked state. + + + + + Gets or sets whether Click event will be auto repeated when mouse button is kept pressed over the item. + + + + + Gets or sets the auto-repeat interval for the click event when mouse button is kept pressed over the item. + + + + + Gets or sets a value indicating whether the item is enabled. + + + + + Indicates item's visiblity when on pop-up menu. + + + + + Indicates when menu items are displayed when MenuVisiblity is set to VisibleIfRecentlyUsed and RecentlyUsed is true. + + + + + Indicates Animation type for Popups. + + + + + Indicates the font that will be used on the popup window. + + + + + Indicates whether sub-items are shown on popup Bar or popup menu. + + + + + Specifies the inital width for the Bar that hosts pop-up items. Applies to PopupType.Toolbar only. + + + + + Gets or sets whether item will display sub items. + + + + + Gets or sets whether the item expands automatically to fill out the remaining space inside the container. Applies to Items on stretchable, no-wrap Bars only. + + + + + Gets or sets the width of the expand part of the button item. + + + + + Gets or set the alternative shortcut text. + + + + + Gets or sets whether item separator is shown before this item. + + + + + Returns category for this item. If item cannot be customzied using the + customize dialog category is empty string. + + + + + Gets or sets the text color of the button when mouse is over the item. + + + + + Indicates the way item is painting the picture when mouse is over it. Setting the value to Color will render the image in gray-scale when mouse is not over the item. + + + + + Gets or sets the text color of the button. + + + + + Gets/Sets the button style which controls the appearance of the button elements. Changing the property can display image only, text only or image and text on the button at all times. + + + + + Specifies predefined color assigned to Metro Tab. + + + + + Represents panel used by MetroTabItem as a container panel for the control. + + + + + Creates new instance of the panel. + + + + + Indicates whether style of the panel is managed by tab control automatically. + Set this to true if you would like to control style of the panel. + + + + + Gets or sets TabItem that this panel is attached to. + + + + + Gets or sets which edge of the parent container a control is docked to. + + + + + Gets or sets the size of the control. + + + + + Gets or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container. + + + + + Gets or sets a value indicating whether the control is displayed. + + + + + Gets or sets which edges of the control are anchored to the edges of its container. + + + + + Represents Metro-UI TabStrip control. + + + + + Called by StyleManager to notify control that style on manager has changed and that control should refresh its appearance if + its style is controlled by StyleManager. + + New active style. + + + + Occurs when text markup link is clicked. + + + + + Returns the color scheme used by control. Color scheme for Office2007 style will be retrived from the current renderer instead of + local color scheme referenced by ColorScheme property. + + An instance of ColorScheme object. + + + + Returns effective caption height. + + Caption height. + + + + Returns automatically calculated height of the control given current content. + + Height in pixels. + + + + Returns the collection of items with the specified name. + + Item name to look for. + + + + + Returns the collection of items with the specified name and type. + + Item name to look for. + Item type to look for. + + + + + Returns the collection of items with the specified name and type. + + Item name to look for. + Item type to look for. + Indicates whether GlobalName property is used for searching. + + + + + Returns the first item that matches specified name. + + Item name to look for. + + + + + Called when ShowKeyTips on RibbonBar contained by this Ribbon is set to true + + + + + Forces the control to exit Ribbon Key-Tips mode. + + + + + Called when item on popup container is right-clicked. + + Instance of the item that is right-clicked. + + + + Starts moving of the parent form action which happens when user attempts to drag the form caption. + + + + + Returns true if point is inside the caption area. + + Client point coordinates. + True if point is inside of caption area otherwise false. + + + + Occurs when text markup link from TitleText markup is clicked. Markup links can be created using "a" tag, for example: + Markup link + + + + + + Gets reference to parsed markup body element if text was markup otherwise returns null. + + + + + Gets or sets whether KeyTips functionality is enabled. Default value is true. + + + + + Gets or sets whether control can be customized and items added by end-user using context menu to the quick access toolbar. + Caption of the control must be visible for customization to be enabled. Default value is true. + + + + + Gets or sets the explicit height of the caption provided by control. Caption height when set is composed of the TabGroupHeight and + the value specified here. Default value is 0 which means that system default caption size is used. + + + + + Gets or sets whether custom caption line provided by the control is visible. Default value is false. + This property should be set to true when control is used on Office2007RibbonForm. + + + + + Gets or sets the font for the form caption text when CaptionVisible=true. Default value is NULL which means that system font is used. + + + + + Gets/Sets the visual style of the control. + + + + + Returns collection of items on a bar. + + + + + Returns currently selected MetroTabItem. MetroTabItems are selected using the Checked property. Only a single + MetroTabItem can be Checked at any given time. + + + + + Gets whether Ribbon is in key-tips mode including its child controls. + + + + + Indicates whether Form.Icon is shown in top-left corner. + + + + + Returns collection of items on a bar. + + + + + Gets the reference to the internal container item for the items displayed in control caption. + + + + + Gets the reference to the internal container for the ribbon tabs and other items. + + + + + Represents Metro Tile. + + + + + Raises CheckedChanged event. + + Provides event arguments. + + + + Raises OptionGroupChanging event. + + Provides event arguments. + + + + Creates new instance of metro tile. + + + + + Creates new instance of metro tile and assigns the name to it. + + Item name. + + + + Creates new instance of metro tile and assigns the name and text to it. + + Item name. + item text. + + + + Returns copy of the item. + + + + + Copies the MetroTileItem specific properties to new instance of the item. + + New ProgressBarItem instance. + + + + Copies the MetroTileItem specific properties to new instance of the item. + + New MetroTileItem instance. + + + + Called when NotificationMarkText property has changed. + + Old property value + New property value + + + + Called when NotificationMarkPosition property has changed. + + Old property value + New property value + + + + Called when NotificationMarkSize property has changed. + + Old property value + New property value + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Called when NotificationMarkOffset property has changed. + + Old property value + New property value + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Occurs just before Click event is fired. + + + + + Called when TileSize property has changed. + + Old property value + New property value + + + + Called when SymbolSet property value changes. + + Indciates old value + Indicates new value + + + + Called when IsLeftMouseButtonDown property has changed. + + Old property value + New property value + + + + Called when IsMouseOver property has changed. + + Old property value + New property value + + + + Raises TitleTextMarkupLinkClick event. + + Provides event arguments. + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Called when Checked property has changed. + + Old property value + New property value + + + + Called when CheckBehavior property has changed. + + Old property value + New property value + + + + Called when CurrentFrame property has changed. + + Old property value + New property value + + + + Called when AutoRotateFramesInterval property has changed. + + Old property value + New property value + + + + Called when DragStartPoint property has changed. + + Old property value + New property value + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Occurs after Checked property has changed. + + + + + Occurs before an item in option group is checked and provides opportunity to cancel that. + + + + + Occurs when text markup link is clicked. Markup links can be created using "a" tag, for example: + Markup link + + + + + Specifies maximum of 2 character text displayed inside of the notification mark on top of the button. + + + + + Indicates the position of the notification marker within the bounds of the button. + + + + + Specifies diameter of notification mark. When set to 0 system default value is used. + + + + + Gets or sets background color of the notification mark. + + + + + Specifies the offset for the notification mark relative to its position. + + + + + Gets or sets the tile size. + + + + + Gets or sets the predefined tile color for default tile frame. + + + + + Specifies the Tile style default tile frame. + + + + + Indicates the symbol displayed on face of the tile instead of the image. Setting the symbol overrides the image setting. + + + + + Gets or sets the symbol set used to represent the Symbol. + + + + + Indicates the size of the symbol in points. + + + + + Gets or sets the color of the symbol. + + + + + Gets or sets the image displayed on the tile. + + + + + Gets or sets image alignment in relation to text. + + + + + Gets or sets the text associated with this item. + + + + + Gets whether left mouse button is pressed over the tile. + + + + + Gets whether mouse is over the item. + + + + + Gets or sets the tile title text displayed by default in lower left corner. + + + + + Occurs when an hyperlink in title text markup is clicked. + + + + + Gets or sets the title text font. + + + + + Gets or sets the color of the title text. + + + + + Gets or sets title text alignment. + + + + + Gets or sets the top-left location of the image. + + + + + Gets or sets whether tile is checked. + + + + + Gets or sets the automatic check behavior of metro tile. + + + + + Gets or set the Group item belongs to. The groups allows a user to choose from mutually exclusive options within the group. The choice is reflected by Checked property. + + + + + Gets the list of tile frames that are displayed when frame animation is enabled using AnimationEnabled property. + + + + + Gets or sets index of currently displayed frame in Frames collection. + + + + + Gets the index of last selected frame, i.e. before CurrentFrame was set with new value. + + + + + Gets or sets whether Frame animation is enabled when CurrentFrame has changed. Default value is true. + + + + + Gets or sets the frames animation duration in milliseconds. Default value is 800. + + + + + Gets or sets the automatic tile frame rotation interval in milliseconds. When set it will change the CurrentFrame property so each frame from Frames collection is displayed after interval set here. + + + + + Gets or sets tile background color when Enabled=false. + + + + + Gets whether item supports text markup. Default is false. + + + + + Gets or sets whether text-markup support is enabled for items Text property. Default value is true. + Set this property to false to display HTML or other markup in the item instead of it being parsed as text-markup. + + + + + Specifies how MetroTileItem is checked. + + + + + Metro tile item inherits the check behavior from host control. + + + + + Metro tile item cannot be checked. + + + + + Metro tile item is checked using right mouse button. + + + + + Metro tile item is checked using middle mouse button. + + + + + Metro tile item is checked using left mouse button. + + + + + Defines single frame for metro-tile item. + + + + + Initializes a new instance of the MetroTileFrame class. + + + + + Called when TitleText property has changed. + + Old property value + New property value + + + + Raises TitleTextMarkupLinkClick event. + + Provides event arguments. + + + + Called when TitleTextFont property has changed. + + Old property value + New property value + + + + Called when TitleTextColor property has changed. + + Old property value + New property value + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Called when TitleTextAlignment property has changed. + + Old property value + New property value + + + + Called when Symbol property has changed. + + Old property value + New property value + + + + Called when SymbolSet property value changes. + + Indciates old value + Indicates new value + + + + Called when SymbolSize property has changed. + + Old property value + New property value + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Called when Image property has changed. + + Old property value + New property value + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Called when Text property has changed. + + Old property value + New property value + + + + Called when Color property has changed. + + Old property value + New property value + + + + Called when FrameDisplayDuration property has changed. + + Old property value + New property value + + + + Occurs when text markup link is clicked. + + + + + Raises MarkupLinkClick event. + + Provides event arguments. + + + + Called when TextMarkupEnabled property has changed. + + Old property value + New property value + + + + Called when ImageTextAlignment property has changed. + + Old property value + New property value + + + + Raises the PropertyChanged event. + + Provides event arguments. + + + + Gets or sets the tile title text displayed by default in lower left corner. + + + + + Gets reference to parsed markup body element if text was markup otherwise returns null. + + + + + Occurs when an hyperlink in title text markup is clicked. + + + + + Gets or sets the title text font. + + + + + Gets or sets the color of the title text. + + + + + Gets or sets title text alignment. + + + + + Gets the effective style for the tile when TileColor property is set to predefined tile color. + + + + + Specifies the Tile style of the item. + + + + + Gets the realized symbol string. + + + + + Indicates the symbol displayed on face of the tile instead of the image. Setting the symbol overrides the image setting. + + + + + Gets or sets the symbol set used to represent the Symbol. + + + + + Indicates the size of the symbol in points. + + + + + Gets or sets the color of the symbol. + + + + + Gets or sets the image displayed on the tile. + + + + + Gets or sets the top-left location of the image. + + + + + Gets or sets the text associated with this item. + + + + + Gets or sets the predefined tile color. + + + + + Gets or sets the frame display duration in milliseconds during metro-tile frame animation. When not set then each frame will stay visible for duration set on MetroTileItem.AutoRotateFramesInterval. + + + + + Occurs when text markup link is clicked. Markup links can be created using "a" tag, for example: + Markup link + + + + + Gets reference to parsed markup body element if text was markup otherwise returns null. + + + + + Gets or sets whether text-markup can be used in Text property. + + + + + Gets or sets image alignment in relation to text. + + + + + Occurs when property on BindingDef object has changed. + + + + + Represents panel for Metro Tiles. + + + + + Represents generic item panel container control. + + + + + Returns first checked top-level button item. + + An ButtonItem object or null if no button could be found. + + + + Adds new item to the ItemPanel based on specified ItemTemplate and sets its Text property. + + Text to assign to the item. + reference to newly created item + + + + Gets or sets default layout orientation inside the control. You can have multiple layouts inside of the control by adding + one or more instances of the ItemContainer object and chaning it's LayoutOrientation property. + + + + + Gets or sets whether items contained by container are resized to fit the container bounds. When container is in horizontal + layout mode then all items will have the same height. When container is in vertical layout mode then all items + will have the same width. Default value is true. + + + + + Gets or sets whether ButtonItem buttons when in vertical layout are fit into the available width so any text inside of them + is wrapped if needed. Default value is false. + + + + + Gets or sets the item alignment when container is in horizontal layout. Default value is Left. + + + + + Gets or sets whether items in horizontal layout are wrapped into the new line when they cannot fit allotted container size. Default value is false. + + + + + Returns collection of items on a bar. + + + + + Gets or sets the index specifying the currently selected item. + + + + + Gets the list of ButtonItem or CheckBoxItem controls that have their Checked property set to true. + + + + + Gets or sets ButtonItem or CheckBoxItem item that have their Checked property set to true. + + + + + Initializes a new instance of the MetroTilePanel class. + + + + + Gets or sets a value indicating whether the control enables the user to scroll to items placed outside of its visible boundaries. + + + + + Gets or sets spacing in pixels between items. Default value is 1. + + + + + Gets or sets whether items contained by container are resized to fit the container bounds. When container is in horizontal + layout mode then all items will have the same height. When container is in vertical layout mode then all items + will have the same width. Default value is true. + + + + + Raises ExpandedChanging event. + + Provides event arguments. + + + + Raises ExpandedChanged event. + + Provides event arguments. + + + + Initializes a new instance of the MetroStatusBar class. + + + + + Called by StyleManager to notify control that style on manager has changed and that control should refresh its appearance if + its style is controlled by StyleManager. + + New active style. + + + + Registers toolbar with MetroTab so it can participate in Quick Access Toolbar operations. + + MetroTab + + + + Unregisters previously registered toolbar from MetroTab and removes it from Quick Access Toolbar operations. + + + + + Returns automatically calculated height of the control given current content. + + Height in pixels. + + + + Called after change of active window has been detected. SetupActiveWindowTimer must be called to enable detection. + + + + + Invokes the ItemClick event. + + Reference to the item that was clicked. + + + + Called when AutoCollapse property has changed. + + Old property value + New property value + + + + Called when AnimationSpeed property has changed. + + Old property value + New property value + + + + Called when ExpandDirection property has changed. + + Old property value + New property value + + + + Occurs before Expanded property has changed, i.e. control expanded or collapsed and allows you to cancel action by setting Cancel=true on event arguments. + + + + + Occurs after Expanded property value has changed, i.e. control was expanded or collapsed. + + + + + Returns collection of items on a bar. + + + + + Gets or sets spacing between items, default value is 0. + + + + + Returns collection of items on a bar. + + + + + Gets or sets whether toolbar is attempted to be automatically registered with parent MetroShell control so it can participate in Quick Access Toolbar operations. Default value is true. + + + + + Gets or sets whether control is expanded or not. When control is expanded both main and extra toolbar items are visible. When collapsed + only main items are visible. Default value is false. + + + + + Gets or sets whether control is automatically collapsed, Expanded property set to False, if control was expanded and any button on the control was clicked or mouse is clicked elsewhere, parent form has lost input focus or some other control gains input focus. + + + + + Gets or sets the animation speed duration in milliseconds. Default value is 150 milliseconds. Set to zero, 0 to disable animation. + + + + + Gets or sets the expand direction for the toolbar. Default value is Auto. + + + + + Gets or sets whether Expand button is visible. Default value is true. + + + + + Gets or sets whether control height is set automatically based on the content. Default value is false. + + + + + Defines expand direction behavior for MetroToolbar. + + + + + Expand direction is automatically determined by the position of the control on the form. + + + + + Control is expanded up so bottom of the control is fixed. + + + + + Control sis expanded down so top of the control is fixed. + + + + + Defines the internal container item for the MetroToolbar control. + + + + + Creates new instance of the class and initializes it with the parent RibbonStrip control. + + Reference to parent MetroToolbar control + + + + Paints this base container + + + + + Returns copy of GenericItemContainer item + + + + + Called when ExpandButtonVisible property has changed. + + Old property value + New property value + + + + Gets or sets whether Expand button is visible. Default value is true. + + + + + Gets reference to container that host items. + + + + + Gets reference to container that hosts extra items. + + + + + Gets or sets a value indicating whether the item is expanded or not. For Popup items this would indicate whether the item is popped up or not. + + + + + When parent items does recalc size for its sub-items it should query + image size and store biggest image size into this property. + + + + + Initializes Office Mobile 2014 color scheme Metro color table based on colors specified. + + + + + Draws the border. + + Graphics canvas. + Bounds for border. + Border thickness. + Border color. + + + + Draws background. + + Graphics canvas. + Background bounds. + Background color + + + + Deflates the rectangle by the border thickness. + + Rectangle. + Border thickness + Rectangle deflated by the border thickness + + + + Represents the painter for the Office 2007 SystemCaptionItem + + + + + Represents the base class for the SystemCaptionItem painter. + + + + + Paints the SystemCaptionItem as icon in left hand corner. + + + + + + Paints the SystemCaptionItem as set of buttons minimize, restore/maximize and close. + + + + + + Paints the background of the button using specified color table colors. + + Graphics object. + Background bounds + Color Table + + + + Gets or sets color table used by renderer. + + + + + Abstract renderer for rendering Metro-UI controls. + + + + + Renders the + + + + + + Gets or sets color table used by renderer. + + + + + Renders the MetroTileItem. + + MetroTileItem to render. + Rendering event arguments. + + + + Renders the MetroForm. + + Form to render. + Rendering event arguments. + + + + Renders the MetroForm. + + Form to render. + Rendering event arguments. + + + + Renders the MetroTabItem. + + Form to render. + Rendering event arguments. + + + + Renders the MetroTabStrip + + TabStrip to render. + Paint args + + + + Renders the MetroStatusBar. + + Status bar to render + Paint args + + + + Renders the MetroStatusBar. + + Status bar to render + Paint args + + + + Defines class for passing rendering information to renderer. + + + + + Gets or sets the control to render. + + + + + Gets or sets the paint event arguments to use to render out control. + + + + + Gets or sets the current color table. + + + + + Gets or sets default font. + + + + + Gets or sets default plain font. + + + + + Gets or sets right-to-left setting. + + + + + Gets or sets the paint information for items. + + + + + Represents the Office 2007 Ribbon Tab Group painter. + + + + + Paints ribbon tab group. + + Context information + + + + Paints SwitchButton. + + Provides arguments for the operation. + + + + Gets or sets color table used by renderer. + + + + + Defines Thickness structure used by borders and margins. + + + + + Creates new instance of the object. + + Uniform Thickness + + + + Creates new instance of the object. + + Left Thickness + Top Thickness + Right Thickness + Bottom Thickness + + + + Gets whether object equals to this instance. + + object to test. + returns whether objects are Equals + + + + Gets whether object equals to this instance. + + object to test. + returns whether objects are Equals + + + + Returns hash code for object. + + Hash code + + + + Returns string representation of object. + + string representing Thickness + + + + Gets string representation of object. + + Culture info. + string representing Thickness + + + + Returns whether object holds valid value. + + Specifies whether negative values are allowed. + Specifies whether NaN values are allowed. + Specifies whether positive infinity values are allowed + Specifies whether negative infinity values are allowed + true if object holds valid value + + + + Returns true if two objects are close. + + Thickness to test. + true if values are close. + + + + Returns true if two objects are close. + + Thickness 1 + Thickness 2 + true if values are close. + + + + Returns whether all values are zero. + + + + + Returns whether all values are the same. + + + + + Gets or sets the left Thickness. + + + + + Gets or sets the top Thickness. + + + + + Gets or sets the Right Thickness. + + + + + Gets or sets the Bottom Thickness. + + + + + Gets the total horizontal thickness i.e. Left+Right. + + + + + Gets the total vertical thickness i.e. Top+Bottom. + + + + + Provides Thickness TypeConverter. + + + + + Represents the base class each micro-chart implements + + + + + Creates the chart image. + + Rendering information. + Image of the chart. + + + + Defines the style for Area micro chart. + + + + + Initializes a new instance of the AreaMicroChartStyle class. + + + + + Raises StyleChanged event. + + Provides event arguments. + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Occurs when style appearance changes. + + + + + Gets or sets the value of the zero line, i.e. where zero line is drawn. Default value is 0. + + + + + Gets or sets the chart area color. + + + + + Gets or sets the color of the high point dot on chart. + + + + + Gets or sets the color of the low point dot on chart. + + + + + Gets or sets the color of the first point dot on chart. + + + + + Gets or sets the color of the last point dot on chart. + + + + + Defines the style for the bar style micro charts. + + + + + Raises StyleChanged event. + + Provides event arguments. + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Occurs when style appearance changes. + + + + + Gets or sets the minimum single bar width. + + + + + Gets or sets the color of positive bar value. + + + + + Gets or sets the color of negative bar value. + + + + + Gets or sets whether average line is drawn. + + + + + Gets or sets the value of the zero line, i.e. pivot point that determines negative and positive values. Default value is 0. + + + + + Gets or sets the color of the lowest value bar on graph. + + + + + Gets or sets the color of the highest value bar on graph. + + + + + Defines the style for 100% bar chart. + + + + + Initializes a new instance of the PieMicroChartStyle class. + + + + + Raises StyleChanged event. + + Provides event arguments. + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Occurs when style appearance changes. + + + + + Gets or sets the minimum single bar width. + + + + + Gets the pre-defined slice colors for the pie chart. + + + + + Gets or sets the color of the slice outline. + + + + + Defines the style for the line micro chart. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Raises StyleChanged event. + + Provides event arguments. + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets or sets the color of the chart line. + + + + + Gets or sets whether average line is drawn. + + + + + Gets or sets the color of the + + + + + Gets or sets whether zero-line is drawn on chart. + + + + + Gets or sets the value of the zero line, i.e. where zero line is drawn. Default value is 0. + + + + + Gets or sets the color of the + + + + + Occurs when style appearance changes. + + + + + Gets or sets the color of the high point dot on chart. + + + + + Gets or sets the color of the low point dot on chart. + + + + + Gets or sets the color of the first point dot on chart. + + + + + Gets or sets the color of the last point dot on chart. + + + + + Gets or sets whether control line is drawn. Default value is false. Control lines can be used to display for example low and high control bounds for the chart. + + + + + Gets or sets the color of the first control line. + + + + + Gets or sets starting value that is used to draw first control line. + + + + + Gets or sets end value that is used to draw first control line. + + + + + Gets or sets whether control line is drawn. Default value is false. Control lines can be used to display for example low and high control bounds for the chart. + + + + + Gets or sets the color of the second control line. + + + + + Gets or sets starting value that is used to draw second control line. + + + + + Gets or sets end value that is used to draw second control line. + + + + + Represents Micro-Chart Control. + + + + + Initializes a new instance of the MicroChart class. + + + + + Forces the button to perform internal layout. + + + + + Raises MouseOverDataPointChanged event. + + Provides event arguments. + + + + Invalidates the chart display and requests the re-paint. + + Indicates whether to animate transition to new chart + + + + Called when Command property value changes. + + + + + Gets or sets whether mouse over tooltip for data point is enabled. Default value is true. + + + + + Gets the index of data point (DataPoints collection) that mouse is over or returns -1 if mouse is not over any data-point. + + + + + Occurs when MouseOverDataPointIndex property changes due to user moving the mouse and pointing it to different data point on chart. + + + + + Gets or sets the tooltips for each data-point assigned through DataPoints property. If not set control will automatically + show tooltip based on the data-point value. + + + + + Gets or sets the chart data points. Note that if you are adding or removing points directly from this collection you must call + Refresh() method on the control to refresh the display. + + + + + Gets or sets the format string for the value when it is displayed as tool-tip for data point. + + + + + Gets or sets whether chart is tracking mouse movement to show data-point and its value on tooltip. Default value is true. + + + + + Gets or sets whether transition animation between same chart with different data-points is enabled. Default value is true. + + + + + Gets or sets whether button like mouse over tracking is enabled for whole control. When enabled control looks like a button when mouse is over it. Default value is false. + + + + + Gets the style used to customize appearance of Line micro-chart. + + + + + Gets the style used to customize appearance of Plot micro-chart. + + + + + Gets the style used to customize appearance of Column micro-chart. + + + + + Gets the style used to customize appearance of Bar micro-chart. + + + + + Gets the style used to customize appearance of Win-Lose micro-chart. + + + + + Gets the style used to customize appearance of Pie micro-chart. + + + + + Gets the style used to customize appearance of Area micro-chart. + + + + + Gets the style used to customize appearance of 100% micro-chart. + + + + + Gets or sets the type of the chart rendered. + + + + + Gets or sets the maximum value for data points. By default maximum data point is calculated based on that data displayed by the chart, but when + two charts need to be scaled the same setting maximum and minimum values for them will ensure that scales are visually the same. + + + + + Gets or sets the minimum value for data points. By default minimum data point is calculated based on that data displayed by the chart, but when + two charts need to be scaled the same setting maximum and minimum values for them will ensure that scales are visually the same. + + + + + Gets whether command is executed when control is clicked. + + + + + Gets or sets the command assigned to the item. Default value is null. + Note that if this property is set to null Enabled property will be set to false automatically to disable the item. + + + + + Gets or sets user defined data value that can be passed to the command when it is executed. + + + + + Initializes a new instance of the TrendInfo structure. + + + + + + + + + Initializes a new instance of the TrendInfo structure. + + + + + Initializes a new instance of the MicroChartRenderInfo structure. + + + + + + + + + Represents the micro-chart item. + + + + + Creates new instance of MicroChartItem. + + + + + Creates new instance of MicroChartItem and assigns the name to it. + + Item name. + + + + Creates new instance of MicroChartItem and assigns the name and text to it. + + Item name. + item text. + + + + Returns copy of the item. + + + + + Copies the MicroChartItem specific properties to new instance of the item. + + New MicroChartItem instance. + + + + Copies the MicroChartItem specific properties to new instance of the item. + + New MicroChartItem instance. + + + + Recalculate the size of the item. If overridden base implementation must be called so default processing can occur. + + + + + Raises MouseOverDataPointChanged event. + + Provides event arguments. + + + + Invalidates the chart display and requests the re-paint. + + Indicates whether to animate transition to new chart + + + + Draws the chart. + + Paint arguments + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Called when DataMaxValue property has changed. + + Old property value + New property value + + + + Called when DataMinValue property has changed. + + Old property value + New property value + + + + Gets or sets the suggested text-width. If you want to make sure that text you set wraps over multiple lines you can set suggested text-width so word break is performed. + + + + + Gets or sets the format string for the value when it is displayed as tool-tip for data point. + + + + + Gets or sets the chart data points. Note that if you are adding or removing points directly from this collection you must call + Refresh() method on the control to refresh the display. + + + + + Gets or sets the tooltips for each data-point assigned through DataPoints property. If not set control will automatically + show tooltip based on the data-point value. + + + + + Gets or sets whether transition animation between same chart with different data-points is enabled. Default value is true. + + + + + Gets whether fade effect is enabled. + + + + + Gets or sets whether chart is tracking mouse movement to show data-point and its value on tooltip. Default value is true. + + + + + Gets or sets whether button like mouse over tracking is enabled for whole control. When enabled control looks like a button when mouse is over it. Default value is false. + + + + + Gets the index of data point (DataPoints collection) that mouse is over or returns -1 if mouse is not over any data-point. + + + + + Gets or sets whether mouse over tooltip for data point is enabled. Default value is true. + + + + + Occurs when MouseOverDataPointIndex property changes due to user moving the mouse and pointing it to different data point on chart. + + + + + Gets the style used to customize appearance of Line micro-chart. + + + + + Gets the style used to customize appearance of Plot micro-chart. + + + + + Gets the style used to customize appearance of Column micro-chart. + + + + + Gets the style used to customize appearance of Bar micro-chart. + + + + + Gets the style used to customize appearance of Win-Lose micro-chart. + + + + + Gets the style used to customize appearance of Pie micro-chart. + + + + + Gets the style used to customize appearance of Area micro-chart. + + + + + Gets the style used to customize appearance of 100% micro-chart. + + + + + Gets or sets the width of the chart part of the control. + + + + + Gets or sets the height of the chart part of the control. + + + + + Gets or sets the type of the chart rendered. + + + + + Gets whether item supports text markup. Default is false. + + + + + Gets or sets whether text-markup support is enabled for items Text property. Default value is true. + Set this property to false to display HTML or other markup in the item instead of it being parsed as text-markup. + + + + + Gets or sets text-position in relation to the chart. + + + + + Gets or sets the text associated with this item. + + + + + Gets or sets whether caption/label set using Text property is visible. + + + + + Gets or sets text padding. + + + + + Gets or sets switch margin. + + + + + Gets or sets the text color. + + + + + Gets or sets the background image position + + + + + Gets or sets the background image used by the control. + + + + + Gets or sets the maximum value for data points. By default maximum data point is calculated based on that data displayed by the chart, but when + two charts need to be scaled the same setting maximum and minimum values for them will ensure that scales are visually the same. + + + + + Gets or sets the minimum value for data points. By default minimum data point is calculated based on that data displayed by the chart, but when + two charts need to be scaled the same setting maximum and minimum values for them will ensure that scales are visually the same. + + + + + Indicates item's visibility when on pop-up menu. + + + + + Indicates whether item was recently used. + + + + + Represents MicroChart hot-points. + + + + + Start angle for pie slice. + + + + + Sweep angle for pie slice. + + + + + Initializes a new instance of the MicroChartHotPoint structure. + + + + + + + Initializes a new instance of the MicroChartHotPoint structure. + + + + + + + + + Initializes a new instance of the MicroChartHotPoint structure. + + + + + + + + + + Defines available MicroChar types. + + + + + Identifies Plot chart. + + + + + Identifies WinLose chart. + + + + + Identifies Area chart. + + + + + Identifies Line chart. + + + + + Identifies Column chart. + + + + + Identifies Bar chart. + + + + + Identifies Pie chart. + + + + + Identifies 100% bar. + + + + + Defines micro-chart text position in relation to the chart. + + + + + Text is positioned to the left of the chart. + + + + + Text is positioned to the right of the chart. + + + + + Text is positioned on top of the chart. + + + + + Text is positioned on bottom of the chart. + + + + + Defines the style for pie chart. + + + + + Initializes a new instance of the PieMicroChartStyle class. + + + + + Raises StyleChanged event. + + Provides event arguments. + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Occurs when style appearance changes. + + + + + Gets the pre-defined slice colors for the pie chart. + + + + + Gets or sets the color of the slice outline. + + + + + Defines the style for the plot micro chart. + + + + + Raises StyleChanged event. + + Provides event arguments. + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Occurs when style appearance changes. + + + + + Gets or sets the color of the chart line. + + + + + Gets or sets whether average line is drawn. + + + + + Gets or sets the color of the + + + + + Gets or sets whether zero-line is drawn on chart. + + + + + Gets or sets the value of the zero line, i.e. where zero line is drawn. Default value is 0. + + + + + Gets or sets the color of the + + + + + Gets or sets the color of the high point dot on chart. + + + + + Gets or sets the color of the low point dot on chart. + + + + + Gets or sets the color of the first point dot on chart. + + + + + Gets or sets the color of the last point dot on chart. + + + + + Gets or sets whether control line is drawn. Default value is false. Control lines can be used to display for example low and high control bounds for the chart. + + + + + Gets or sets the color of the first control line. + + + + + Gets or sets starting value that is used to draw first control line. + + + + + Gets or sets end value that is used to draw first control line. + + + + + Gets or sets whether control line is drawn. Default value is false. Control lines can be used to display for example low and high control bounds for the chart. + + + + + Gets or sets the color of the second control line. + + + + + Gets or sets starting value that is used to draw second control line. + + + + + Gets or sets end value that is used to draw second control line. + + + + + Class that tracks lists of all controls that host currently open popups. + + + + + Registers IOwnerMenuSupport popup host in response to host displaying its first popup. + + IOwnerMenuSupport host to register + + + + Unregisters IOwnerMenuSupport popup host in response to host closing its last popup. + + IOwnerMenuSupport host to unregister + + + + Closes all currently open popups. + + + + + Closes all currently open popups excluding specified popup host. + + IOwnerMenuSupport host to exclude from closing or null + + + + Represents custom collection with INotifyPropertyChanged and INotifyCollectionChanged interface support. + + + + + + Represents collection changed notification interface. + + + + + Occurs when collection changed. + + + + + Creates new instance of object. + + + + + Creates new instance of object. + + + + + Creates new instance of object. + + List to initialize collection with. + + + + Add item to collection. + + Item to add. + + + + Remove all items from collection. + + + + + Remove all items from collection. + + + + + Checks whether collection contains item. + + Item to look for. + true if item is in collection. + + + + Copy collection to array. + + Array to copy to. + Index to copy from. + + + + Copy collection to array. + + Array to copy to. + + + + Gets enumerator for collection. + + Enumerator. + + + + Returns index of an item. + + Reference to item. + Index of item. + + + + Insert item at specified location. + + Index to insert item in. + Item to insert. + + + + Inserts item. + + Index to insert item at. + Reference to item. + + + + Removes item from collection. + + Item to remove. + true if item was removed. + + + + Remove item at specified location. + + Index of item to remove. + + + + Remove item at specified location. + + Index of item to remove. + + + + Set item on location. + + Index + Item to assign. + + + + Returns items directly without checks. + + List of items. + + + + Occurs when collection is read. + + + + + Occurs when collection property has changed. + + Event arguments. + + + + Blocks the collection reentrancy. + + IDisposable to end re-entrancy + + + + Checks whether call creates reentrancy. + + + + + Called when collection has changed. + + Event arguments. + + + + Occurs when property value has changed. + + + + + Returns number of items in collection. + + + + + Returns item at index. + + Index of item. + Item at index. + + + + Returns the IList interface for items in collection. + + + + + Occurs when collection has changed. + + + + + Defines change actions. + + + + + Items were added. + + + + + Items were removed. + + + + + Items were replaced. + + + + + Items were moved. + + + + + Collection was reset. + + + + + Defines delegate for collection notification events. + + Event sender. + Event arguments. + + + + Defines collection change notification event arguments. + + + + + Create new instance of object. + + Action + + + + Creates new instance of object. + + Specifies action. + List of changed items. + + + + Creates new instance of object. + + Specifies action. + Item that was changed. + + + + Creates new instance of object. + + Action. + New items in collection. + Old items in collection. + + + + Creates new instance of object. + + Action. + List of changed items. + Starting index of change. + + + + Creates new instance of object. + + Action + Changed item + Index of change + + + + Creates new instance of object. + + Action + New item + Old item + + + + Creates new instance of object. + + Action + New items. + Removed items. + Starting index of change. + + + + Creates new instance of object. + + Action + Changed items + New index + Old index + + + + Creates new instance of object. + + Action + Changed item + New index + Old index + + + + Creates new instance of object. + + Action. + New item + Old item + New index + + + + Gets the type of the collection change action. + + + + + Gets list of newly added items. + + + + + Gets new starting index. + + + + + Gets list of removed items. + + + + + Old starting index. + + + + + Represents advanced property grid control. + + + + + Defines an interface that is used by advanced property grid parser to localize property names. + + + + + Gets localized property name. + + Property name to retrieve localized name for. + Localized Property name or null to use default. + + + + Gets localized category name. + + Category to retrieve localized value for. + Localized Category name or null to use default. + + + + Gets localized message for Tooltip body when error setting the property value has occurred. + + Default system message. + Localized message or null to use default. + + + + Gets the style that is applied to property node when it is in read-only state. + + + + + Gets the style that is applied to property node when its value has changed from the default value for the property. + + + + + Gets the property category style. + + + + + Gets the default style for unchanged value edit cell. + + + + + Initializes a new instance of the AdvPropertyGrid class. + + + + + Invokes PropertyValueChanging event. + + Event data. + + + + Invokes PropertyValueChanged event handler. + + Name of the property that has changed. + New property value. + Old property value. + + + + Invokes PropertyValueChanged event. + + Name of property that has changed + + + + Raises ValidatePropertyValue event. + + Provides event arguments. + + + + Raises PropertiesLoaded event. + + Provides event arguments. + + + + Commits any property edits that are currently in progress by applying the current entered value to the property. + Returns true if edit was applied. + + + + + Updates specified property value in property grid. + + Property Name to update value for. + + + + Refreshes the display of all property values in the grid. + + + + + Reloads all properties from selected object. + + + + + Collapses all the categories in the AdvPropertyGrid. + + + + + Expands all the categories in the AdvPropertyGrid. + + + + + Raises the PrepareErrorSuperTooltip event. + + Provides information about event. + + + + Sets the property grid column width. + + Column index + Width of column in pixels + + + + Raises the ConvertPropertyValueToString event. + + Provides event data + + + + Raises the ConvertFromStringToPropertyValue event. + + Provides event data + + + + Raises the ProvidePropertyValueList event. + + Provides event data + + + + Raises the ProvideUITypeEditor event. + + Provides event data + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Find PropertyNode using the property name. + + Property to name + PropertyNode or null if not found + + + + Called when SubPropertiesDefaultSort property has changed. + + Old property value + New property value + + + + Raises the PropertyChanged event. + + Provides event arguments. + + + + Signals the object that initialization is starting. + + + + + Signals the object that initialization is ending. + + + + + Occurs when property grid needs property names translated for UI. + + + + + Occurs when Super Tooltip that is displayed for the error that occurred when property is being set is being assigned to a property node. + This event allows you to customize the super tooltip displayed. + + + + + Occurs when property value is being converted to text representation for display. You can handle this event + to provide custom conversion for property values. You must set IsConverted=true on event arguments to indicate that you have performed value conversion. + + + + + Occurs when text entered by user is being converted to typed property value to be assigned to the property. You can handle this event + to provide custom conversion for property values. You must set IsConverted=true on event arguments to indicate that you have performed value conversion. + + + + + Occurs when property looks for the list of valid values for the property to show on either drop-down or use + in auto-complete list. For example when property type is enum the internal implementation will convert available enum + values into string list and use on drop-down and in auto-complete list. You can use this event to provide + custom value list in combination with ConvertPropertyValueToString, ConvertFromStringToPropertyValue events. + You must set IsListValid=true on event arguments to indicate that list your provided should be used. + + + + + Occurs when property node needs the UITypeEditor for the property. You can handle this event and provide your own UITypeEditor to be used instead of the one specified on the property. + + + + + Occurs when user changes the value of the property in property grid. + + + + + Occurs before property value entered by the user is set on the property. You can cancel internal assignment by property grid by setting Handled=true on event arguments. + + + + + Occurs when users changes the property value and attempts to commit the changes. This even allows you to validate the value and show error message if value is invalid and cancel its application. + + + + + Occurs after properties have been loaded into the property grid. + + + + + Gets or sets the currently selected objects. + + + + + Gets or sets the currently selected object. + + + + + Gets or sets the browsable attributes associated with the object that the property grid is attached to. + + + + + Gets or sets whether property is highlighted to confirm the value update by user. Default value is true. + + + + + Gets or sets the list of property names that are not loaded into property grid regardless of their Browsable attribute setting. + + + + + Gets or sets the list of category names properties below to that are not loaded into property grid regardless of the property Browsable attribute setting. + + + + + Returns reference to internal SuperTooltip component used by AdvPropertyGrid. + + + + + Defines the appearance of the control. + + + + + Gets or sets the property sorting inside of the grid. + + + + + Gets or sets the help type that is provided by the control. Default help type is SuperTooltip which shows tooltip over each property + that provides property description. + + + + + Gets reference to the help panel that is displayed below property grid and which provides selected property description. + + + + + Gets reference to the expandable splitter that is displayed above the help panel and allows resizing of the panel. + + + + + Gets reference to internal AdvTree control that displays properties. + + + + + Gets or sets the grid lines color. + + + + + Gets the reference to the internal toolbar control displayed above the property grid. + + + + + Gets or sets whether toolbar is visible. Default value is true. + + + + + Gets or sets whether search text box that allows property filtering is visible. Default value is true. + + + + + Gets reference to internal TextBoxItem that represents search text box. + + + + + Gets the reference to the property gird localization object which holds all system text used by the component. + + + + + Gets or sets whether Tab key navigates between property nodes. Default value is true. + + + + + Gets or sets the password character used by the property values that are marked with PropertyPasswordText attribute. + + + + + Gets or sets the sub property default sorting. Default value is Alphabetical. + + + + + Occurs when property defined by AdvPropertyGrid control has changed. + + + + + Gets the style that is applied to property node when it is in read-only state. + + + + + Gets the style that is applied to property node when its value has changed from the default value for the property. + + + + + Gets the style that is applied to property edit cell when its displaying unchanged property value. + + + + + Gets the property category style. + + + + + Defines the sorting for the AdvPropertyGrid properties. + + + + + Specifies help types property grid uses to display help for selected property. + + + + + No help is visible. + + + + + SuperTooltip with property description is displayed when mouse is over the property. + + + + + Panel below property grid is displayed which shows the description for the selected property. + + + + + Defines delegate for Localize AdvPropertyGrid event. + + + + + + + Defines data for Localize AdvPropertyGrid event. + + + + + Gets the property name or category name localization is performed for. Inspect LocalizationType property to get localization type which + determines value specified in this property. + + + + + Gets the localization type being performed. + + + + + Gets or sets the localized value to be used. Set to null or empty string to use default value. + + + + + Initializes a new instance of the AdvPropertyGridLocalizeEventArgs class. + + Key value event is raised for. + Localization Type being performed. + + + + Defines the localization types for AdvPropertyGrid control. + + + + + Property name is localized. + + + + + Category is localized. + + + + + Error super tooltip parts are being localized. + + + + + Defines delegate for Localize AdvPropertyGrid event. + + + + + + + Defines data for PrepareErrorTooltip AdvPropertyGrid event. + + + + + Gets or sets the SuperTooltipInfo that represent tooltip that will be displayed to provide error information. + + + + + Gets the name of the property tooltip is displayed for. + + + + + Gets reference to the exception that was thrown when property was set. + + + + + Gets the value that was set and caused the error. + + + + + Initializes a new instance of the PropertyErrorTooltipEventArgs class. + + SuperTooltipInfo for error tooltip + Property that caused error + Exception that was raised when property was set + Value that caused the error. + + + + Defines delegate for Convert Value events. + + Sender + Event data. + + + + Defines data for Convert Value events that allows custom value conversion for property grid. + + + + + Gets or sets the string property value. + + + + + Gets or sets the typed property value. + + + + + Gets the property name for which conversion is being done. + + + + + Gets the target component that property is on. + + + + + Gets or sets whether converted value is used. You need to set this property to true to indicate that you have performed value conversion. + + + + + Gets the property descriptor that describes property. + + + + + Initializes a new instance of the ConvertValueEventArgs class. + + + + + + + + + Defines delegate for Convert Value events. + + Sender + Event data. + + + + Defines data for Convert Value events that allows custom value conversion for property grid. + + + + + Gets the property name value list is needed for. + + + + + Gets the target component that property is on. + + + + + Gets or sets whether property ValueList provided is valid. You must set this property to true in order for the list to be used. + + + + + Gets or sets the list of valid property values. + + + + + Gets the property descriptor that describes property. + + + + + Initializes a new instance of the PropertyValueListEventArgs class. + + + + + + + Defines delegate for Localize AdvPropertyGrid event. + + Sender of event. + Event data. + + + + Defines data for PrepareErrorTooltip AdvPropertyGrid event. + + + + + Gets the property name UITypeEditor is looked for. + + + + + Gets the property descriptor for property UITypeEditor is looked for. + + + + + Gets or sets the instance of UITypeEditor to be used for the property. You set this property to the UITypeEditor that you want + used for the property while editing. Note that you must set EditorSpecified = true in order for this value to be used. + + + + + Gets or sets whether the value specified in UITypeEditor property is used. You must set this value to true in order for + UITypeEditor property value to be used. + + + + + Initializes a new instance of the ProvideUITypeEditorEventArgs class. + + Property Name + Property Descriptor + + + + Defines delegate for PropertyValueChanging event. + + Event sender. + Event data. + + + + Defines arguments for PropertyValueChanging event. + + + + + Gets the name of the property which value is changing. + + + + + Gets the new value that is being set on property. + + + + + Gets or sets whether value assignment was handled by your code. Set to true to cancel internal AdvPropertyGrid property value assignment. + + + + + Gets the PropertyDescriptor for the property being changed. + + + + + Gets the full property path up to the selected object. + + + + + Initializes a new instance of the PropertyValueChangingEventArgs class. + + + + + + + Initializes a new instance of the PropertyValueChangingEventArgs class. + + + + + + + Defines delegate for ValidatePropertyValue event. + + Sender + ValidatePropertyValue event arguments + + + + Defines event arguments for ValidatePropertyValue event. + + + + + Gets or sets whether validation failed. Set to true to cancel property value assignment. + + + + + Gets the name of the property which value is changing. + + + + + Gets the new value that is being set on property. + + + + + Gets the target object on which property value is set. + + + + + Gets or sets the message that is displayed to user if validation fails, i.e. Cancel=true. + + + + + Initializes a new instance of the ValidatePropertyValueEventArgs class. + + + + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets or sets the color of the node highlight when error has occurred while setting property value. + + + + + Gets or sets the color of the node highlight when property update was successful. + + + + + Gets or sets default style for property node. + + + Default value is null. + + + + + Gets or sets style for property node when in read-only state. + + + Default value is null. + + + + + Gets or sets style for property node when in read-only state. + + + Default value is null. + + + + + Gets or sets style for property node edit cell when displaying unchanged property value. + + + Default value is null. + + + + + Gets or sets style for property node when in read-only state. + + + Default value is null. + + + + + Gets or sets the image that is displayed in property name cell when property value has failed the validation. + + + + + Represents the class that stores text used by property grid control for localization purposes. + + + + + Raises the PropertyChanged event. + + Provides event arguments. + + + + Gets or sets tooltip used by Categorized toolbar button. + + + + + Gets or sets tooltip used by Alphabetical toolbar button. + + + + + Gets or sets the tooltip text used in tooltip when error occurred during property value setting. + + + + + Gets or sets the watermark text displayed in search text-box. + + + + + Occurs when property defined by AdvPropertyGridLocalization class has changed. + + + + + Represents the property category in AdvPropertyGrid. + + + + + Represents check-box style property node in AdvPropertyGrid. + + + + + Represents a property node in AdvPropertyGrid. + + + + + Initializes a new instance of the PropertyNode class. + + + + + + Releases the inline editor used by the node. + + + + + Places the node into the editing mode if possible, raises the exception if node is read-only. + + Action that caused the edit mode. + Indicates whether to focus the editor. + + + + Called after property editor is created. + + + + + Exits the editor mode. + + Action that caused the editor mode exit. + + + + Called when visual part of the node has changed due to the changes of its properties or properties of the cells contained by node. + + + + + Cancel the edit changes and applies the old property value. + + + + + Attempts to apply current edit value to the property. + + + + + Returns the full property path to the root of the selected object. + + Full property path. + + + + Starts fade background color style highlight for the property node. + + Specifies the fade background color. + + + + Applies PropertySettings to this node. + + + + + Gets or sets whether property text box is read only. Default value is false. + + + + + Gets whether node is in editing mode. + + + + + Gets or sets the property settings that are applied to this property node. + + + + + Gets or sets whether property node represents property for multiple objects. + + + + + Gets or sets whether property is password property which value is not displayed as plain text. + + + + + Defines delegate that is called after property editor is created. + + PropertyNode sender. + Reference to editor. + + + + Initializes a new instance of the PropertyNode class. + + + + + + Defines a attribute which applies an date-time editor to a property when used with AdvPropertyGrid control. Applies to DateTime property types only. + + + + + Defines base attribute for custom AdvPropertyGrid in-line property value editors. + + + + + Creates a control that is used as property value in-line editor. Control must implement IPropertyValueEditor interface. + + PropertyDescriptor for the property being edited. + Target object that owns the property. + Control that represents in-line editor. + + + + Gets or sets pre-defined format for date-time input. + + + + + Gets or sets custom format for date-time input. + + + + + Gets or sets whether empty null/nothing state of the control is allowed. Default value is false. + + + + + Gets or sets whether drop-down button that shows calendar is visible. Default value is true. + + + + + Gets or sets the minimum date that control accepts. + + + + + Gets or sets the maximum date that control accepts. + + + + + Initializes a new instance of the PropertyDateTimeEditor class. + + + + + + Initializes a new instance of the PropertyDateTimeEditor class. + + + + + + + Initializes a new instance of the PropertyDateTimeEditor class. + + + + + + + + Initializes a new instance of the PropertyDateTimeEditor class. + + + + + + + + + + + Initializes a new instance of the PropertyDateTimeEditor class. + + + + + + + Initializes a new instance of the PropertyDateTimeEditor class. + + + + + + Initializes a new instance of the PropertyDateTimeEditor class. + + + + + + + Initializes a new instance of the PropertyDateTimeEditor class. + + + + + Defines an interface that is implemented by the control that will be used by AdvPropertyGrid control to edit property value. + + + + + Focus the edit part of the control. + + + + + Gets or sets the font used by the edit part of the control. Font might be used to visually indicate that property value has changed. Implementing this property is optional. + + + + + Gets whether the edit part of the control is focused. + + + + + Gets or sets the value being edited. + + + + + Occurs when EditValue changes. Raising this even will cause the property value to be updated with the EditValue. + + + + + Defines a attribute which applies an double type numeric editor to a property when used with AdvPropertyGrid control. Applies to double property types only. + + + + + Gets or sets whether up/down button is shown. + + + + + Gets or sets the display format for the control when control does not have input focus. + + + + + Gets or sets the minimum value that can be entered. + + + + + Gets or sets the maximum value that can be entered. + + + + + Gets or sets whether empty state i.e. null/nothing value is allowed when editor is used with nullable types. + + + + + Initializes a new instance of the PropertyDoubleEditor class. + + + + + Initializes a new instance of the PropertyDoubleEditor class. + + + + + + Initializes a new instance of the PropertyDoubleEditor class. + + + + + + + Initializes a new instance of the PropertyDoubleEditor class. + + + + + + + + Initializes a new instance of the PropertyDoubleEditor class. + + + + + + + + + Initializes a new instance of the PropertyDoubleEditor class. + + + + + + + Defines a attribute which applies an integer type numeric editor to a property when used with AdvPropertyGrid control. Applies to int property types only. + + + + + Gets or sets whether up/down button is shown. + + + + + Gets or sets the display format for the control when control does not have input focus. + + + + + Gets or sets the minimum value that can be entered. + + + + + Gets or sets the maximum value that can be entered. + + + + + Gets or sets whether empty state i.e. null/nothing value is allowed when editor is used with nullable types. + + + + + Initializes a new instance of the PropertyIntegerEditor class. + + + + + Initializes a new instance of the PropertyIntegerEditor class. + + + + + + Initializes a new instance of the PropertyIntegerEditor class. + + + + + + + Initializes a new instance of the PropertyIntegerEditor class. + + + + + + + + Initializes a new instance of the PropertyIntegerEditor class. + + + + + + + + + Initializes a new instance of the PropertyIntegerEditor class. + + + + + + + Defines multiple choice, option or check-boxes, in-line AdvPropertyGrid property value editor. + + + + + Initializes a new instance of the PropertyMultiChoiceEditor class. + + + + + Initializes a new instance of the PropertyMultiChoiceEditor class. + + + + + + Initializes a new instance of the PropertyMultiChoiceEditor class. + + + + + + + Initializes a new instance of the PropertyMultiChoiceEditor class. + + + + + + + Initializes a new instance of the PropertyMultiChoiceEditor class. + + + + + + + Initializes a new instance of the PropertyMultiChoiceEditor class. + + + + + + Initializes a new instance of the PropertyMultiChoiceEditor class. + + + + + + Initializes a new instance of the PropertyMultiChoiceEditor class. + + + + + + + Initializes a new instance of the PropertyMultiChoiceEditor class. + + + + + + + Initializes a new instance of the PropertyMultiChoiceEditor class. + + + + + + + Initializes a new instance of the PropertyMultiChoiceEditor class. + + + + + + + + Represents item container that arranges items horizontally or vertically. + + + + + Creates new instance of the ItemContainer object. + + + + + Must be overridden by class that is inheriting to provide the painting for the item. + + + + + Returns empty container default design-time size. + + Size of an empty container. + + + + Gets whether FixedSize property should be serialized. + + + + + Resets the property to default value. + + + + + Called when FixedSize property has changed. + + Old property value + New property value + + + + Recalculates the size of the container. Assumes that DisplayRectangle.Location is set to the upper left location of this container. + + + + + Occurs when the mouse pointer is over the item and a mouse button is pressed. This is used by internal implementation only. + + + + + Return Sub Item at specified location + + + + + Called after TopInternal property has changed + + + + + Called after LeftInternal property has changed + + + + + Returns copy of the item. + + + + + Copies the ButtonItem specific properties to new instance of the item. + + New ButtonItem instance. + + + + Occurs when sub item expanded state has changed. + + Sub item affected. + + + + Called when item Display state has changed. + + + + + Sets whether container is used as system container internally by DotNetBar. + + true or false to indicate whether container is system container or not. + + + + Called when TitleVisible property has changed. + + Old property value + New property value + + + + Called when TitleText property has changed. + + Old property value + New property value + + + + Called when TitlePosition property has changed. + + Old property value + New property value + + + + Selects first visible item contained by the container by sending mouse over message. + + + + + Sets the new hot-sub item for the container. This method is designed for internal use by the DotNetBar and should not be used. + + Reference to an instance of BaseItem or null. + + + + Gets or sets the minimum size of the container. Either Width or Height can be set or both. Default value is 0,0 which means + that size is automatically calculated. + + + + + Specifies the container background style. Default value is an empty style which means that container does not display any background. + BeginGroup property set to true will override this style on some styles. + + + + + Gets or sets the item alignment when container is in horizontal layout. Default value is Left. + + + + + Gets or sets the item vertical alignment. Default value is Top. + + + + + Gets or sets whether items in horizontal layout are wrapped into the new line when they cannot fit allotted container size. Default value is false. + + + + + Gets or sets spacing in pixels between items. Default value is 0. + + + + + Gets or sets the suggested fixed size of the container. Width or Height or Both may be set to suggest fixed size for the container. + + + + + Gets or sets orientation inside the container. Do not change the value of this property. It is managed by system only. + + + + + Gets or sets orientation inside the container. + + + + + Gets or sets whether items contained by container are resized to fit the container bounds. When container is in horizontal + layout mode then all items will have the same height. When container is in vertical layout mode then all items + will have the same width. Default value is true. + + + + + IBlock member implementation + + + + + Gets or sets a value indicating whether the item is expanded or not. For Popup items this would indicate whether the item is popped up or not. + + + + + Returns whether instance of the item container is used as system container internally by DotNetBar. + + + + + Gets or sets the accessible role of the item. + + + + + Specifies the title background style. + + + + + Indicates whether TitleText is visible if set. Default value is true. + + + + + Gets or sets the title text for the container. + + + + + Gets or sets position of title text. + + + + + Gets or sets the Key Tips access key or keys for the item when on Ribbon Control or Ribbon Bar. Use KeyTips property + when you want to assign the one or more letters to be used to access an item. For example assigning the FN to KeyTips property + will require the user to press F then N keys to select an item. Pressing the F letter will show only keytips for the items that start with letter F. + + + + + Indicates whether the item will auto-collapse (fold) when clicked. + When item is on popup menu and this property is set to false, menu will not + close when item is clicked. + + + + + Gets or sets whether item can be customized by end user. + + + + + Returns category for this item. If item cannot be customzied using the + customize dialog category is empty string. + + + + + Gets or sets whether Click event will be auto repeated when mouse button is kept pressed over the item. + + + + + Gets or sets the auto-repeat interval for the click event when mouse button is kept pressed over the item. + + + + + Specifes the mouse cursor displayed when mouse is over the item. + + + + + Gets or sets item description. This description is displayed in + Customize dialog to describe the item function in an application. + + + + + Gets or sets a value indicating whether the item is enabled. + + + + + Gets or sets whether item is global or not. + This flag is used to propagate property changes to all items with the same name. + Setting for example Visible property on the item that has GlobalItem set to true will + set visible property to the same value on all items with the same name. + + + + + Gets or sets item alignment inside the container. + + + + + Gets or sets the collection of shortcut keys associated with the item. + + + + + Gets or sets whether item will display sub items. + + + + + Gets or sets whether the item expands automatically to fill out the remaining space inside the container. Applies to Items on stretchable, no-wrap Bars only. + + + + + Specifies whether item is drawn using Themes when running on OS that supports themes like Windows XP. + + + + + Gets/Sets informational text (tooltip) for the item. + + + + + Indicates whether container responds to keyboard presses and changes the active/mouse over item. + + + + + Initializes a new instance of the PropertyMultiChoiceItemEditor class. + + + + + + + Represents the option list property node for AdvPropertyGrid. + + + + + Initializes a new instance of the PropertyNode class. + + + + + + Describes the property settings applied to the property on AdvPropertyGrid control. + + + + + Initializes a new instance of the PropertySettings class. + + + + + Initializes a new instance of the PropertySettings class. + + + + + + Initializes a new instance of the PropertySettings class. + + + + + + Raises the ConvertPropertyValueToString event. + + Provides event data + + + + Raises the ConvertFromStringToPropertyValue event. + + Provides event data + + + + Raises the ProvidePropertyValueList event. + + Provides event data + + + + Called when TypeConverter property has changed. + + Old property value + New property value + + + + Raises PropertyChanged event. + + Event data. + + + + Occurs when property value is being converted to text representation for display. You can handle this event + to provide custom conversion for property values. You must set IsConverted=true on event arguments to indicate that you have performed value conversion. + + + + + Occurs when text entered by user is being converted to typed property value to be assigned to the property. You can handle this event + to provide custom conversion for property values. You must set IsConverted=true on event arguments to indicate that you have performed value conversion. + + + + + Occurs when property looks for the list of valid values for the property to show on either drop-down or use + in auto-complete list. For example when property type is enum the internal implementation will convert available enum + values into string list and use on drop-down and in auto-complete list. You can use this event to provide + custom value list in combination with ConvertPropertyValueToString, ConvertFromStringToPropertyValue events. + You must set IsListValid=true on event arguments to indicate that list your provided should be used. + + + + + Gets or sets read-only property style. + + + Default value is null. + + + + + Gets or sets whether property is in read-only state. Default value is false. + + + + + Gets or sets the SuperTooltip that is displayed when property is in read-only state (ReadOnly=true). + + + + + Gets or sets the SuperTooltip that is assigned to the property. + + + + + Gets or sets the image that is displayed next to the property name in the grid. + + + + + Gets or sets the image alignment in relation to the property name inside of the grid cell. + + + + + Gets or sets the custom category node will be placed in instead of category specified by Category attribute. + + + + + Gets or sets the custom property name that is displayed in the grid instead of the real property name. + + + + + Gets or sets the name of the property that is managed by this informational object. If you set PropertyDescriptor than that is the value + that will be used by the control regardless of PropertyName value. + If you set PropertyName but not PropertyDescriptor then all properties with given name + regardless of type will use these settings. + + + + + Gets or sets property descriptor that identifies the property settings apply to. If you set PropertyDescriptor than that is the value + that will be used by the control regardless of PropertyName value. + If you set PropertyName but not PropertyDescriptor then all properties with given name + regardless of type will use these settings. + + + + + Gets or sets default property style. + + + Default value is null. + + + + + Gets or sets the UITypeEditor used to edit the property. + + + + + Gets or sets the custom in-line property value editor. Property value editor is created by inheriting from PropertyValueEditor class. + + + + + Gets or sets whether node is visible in property grid. Default value is true. + + + + + Gets or sets the property node type that is used to edit this property value. Note that content of property grid would need to be + reloaded to apply any changes to this property. + + + + + Gets or sets the property description that overrides description specified on property through DescriptionAttribute. + Default value is null. + + + + + Gets or sets custom TypeConverter assigned to the property which will override any TypeConverter that is returned by the PropertyDescriptor. + + + + + Occurs when property value on the object changes. + + + + + Defines the type of the property node in grid that is assigned to property. + + + + + Specifies default node type for the property. + + + + + Specifies the node type that is constructed as group of option buttons that represent all values for the property. Works best + for smaller set of Enum values. + + + + + Defines exception which is thrown when property value fails the validation in AdvPropertyGrid.ValidatePropertyValue event. + + + + + Initializes a new instance of the InvalidPropertyValueException class. + + + + + Defines Advanced Property Grid Node for Color type. + + + + + Initializes a new instance of the PropertyNode class. + + + + + + Initializes a new instance of the PropertyNodeFactory class. + + + + + + Initializes a new instance of the PropertyParser class. + + + + + + Initializes a new instance of the PropertyParser class. + + + + + + Initializes a new instance of the PropertyParser class. + + + + + + Initializes a new instance of the PropertyParser class. + + + + + + Initializes a new instance of the PropertyGridInfoCollection class. + + + + + + Gets property info object based on property name. + + Property name. + PropertyGridInfo instance or null if it cannot be found. + + + + Gets property info object based on property descriptor. + + Property descriptor. + PropertyGridInfo instance or null if it cannot be found. + + + + Returns property setting based on property descriptor or name if property descriptor is not set on property settings + Property descriptor takes precedence. + + Property descriptor to look for. + Property Name to look for. + Property settings instance or null + + + + Gets the owner of the collection. + + + + + Defines a attribute which applies an slider in-line editor to a property when used with AdvPropertyGrid control. + + + + + Gets or sets the minimum slider value. + + + + + Gets or sets the maximum slider value. + + + + + Gets or sets whether slider text label is visible. + + + + + Gets or sets the slider label width. Default value is 18. + + + + + Gets or sets label text color. + + + + + Initializes a new instance of the PropertySliderEditor class. + + Minimum value for slider. + Maximum value for slider. + + + + Initializes a new instance of the PropertySliderEditor class. + + + + + + + + Initializes a new instance of the PropertySliderEditor class. + + + + + + + + + + Initializes a new instance of the PropertySliderEditor class. + + + + + + + + Initializes a new instance of the PropertySliderEditor class. + + + + + + + + + Creates a control that is used as property value in-line editor. Control must implement IPropertyValueEditor interface. + + PropertyDescriptor for the property being edited. + Target object that owns the property. + Control that represents in-line editor. + + + + Defines Radial Menu control. + + + + + Initializes a new instance of the RadialMenu class. + + + + + Raises BeforeMenuClose event. + + Provides event arguments. + + + + Raises BeforeMenuOpen event. + + Provides event arguments. + + + + Raises MenuOpened event. + + Provides event arguments. + + + + Raises MenuClosed event. + + Provides event arguments. + + + + Gets or sets whether radial menu is open. + + + + + Called when Image property has changed. + + Old property value + New property value + + + + Called when IsOpen property has changed. + + Old property value + New property value + + + + Sets whether radial menu is open and provides the source of the action. + + true to open menu, false to close it. + Source of the action. + + + + Returns the collection of items with the specified name. + + Item name to look for. + + + + + Returns the collection of items with the specified name and type. + + Item name to look for. + Item type to look for. + + + + + Returns the collection of items with the specified name and type. + + Item name to look for. + Item type to look for. + Indicates whether GlobalName property is used for searching. + + + + + Returns the first item that matches specified name. + + Item name to look for. + + + + + Raises ItemAdded event. + + Reference to item. + Provides event arguments. + + + + Raises ItemRemoved event. + + Reference to item. + Provides event arguments. + + + + Raises ItemMouseEnter event. + + Reference to item. + Provides event arguments. + + + + Raises ItemMouseHover event. + + Reference to item. + Provides event arguments. + + + + Raises ItemMouseLeave event. + + Reference to item. + Provides event arguments. + + + + Raises ItemMouseDown event. + + Reference to item. + Provides event arguments. + + + + Raises ItemMouseUp event. + + Reference to item. + Provides event arguments. + + + + Raises ItemMouseMove event. + + Reference to item. + Provides event arguments. + + + + Raises ItemClick event. + + Reference to item. + Provides event arguments. + + + + Raises ItemDoubleClick event. + + Reference to item. + Provides event arguments. + + + + Raises ItemExpandedChanged event. + + Reference to item. + Provides event arguments. + + + + Raises ItemTextChanged event. + + Provides event arguments. + + + + Raises ItemTooltipShowing event. + + Provides event arguments. + + + + Occurs before menu is closed and allows you to cancel closing. + + + + + Occurs before menu has been opened and allows you to cancel opening + + + + + Occurs after menu has been opened. + + + + + Occurs after menu is closed.Occurs after menu is closed. + + + + + Specifies the width of the sub-menu edge around the radial menu. + + + + + Indicates spacing between sub-menu marking edge and the item. + + + + + Gets or sets radial menu diameter. Minimum value is 64. + + + + + Gets reference to colors used by the radial menu. + + + + + Indicates the size of the back symbol that is displayed on center of radial menu + + + + + Specifies the back button symbol. + + + + + Gets or sets the symbol set used to represent the Symbol. + + + + + Indicates diameter of center button of radial menu. + + + + + Specifies the maximum pie part angle an item will occupy. Maximum is 180, minimum is 1 degree. + + + + + Indicates maximum radial angle single item in menu can consume. By default this property is set to zero which indicates that + radial menu is equally divided between visible menu items. + + + + + Indicates the position of top-left corner of radial menu when shown in screen coordinates + + + + + Indicates image displayed in center of the radial menu. + + + + + Indicates symbol displayed in center of the radial menu. When set, it overrides any Image settings. + + + + + Gets or sets the symbol set used to represent the Symbol. + + + + + Indicates the size of the symbol in points. + + + + + Gets or sets whether radial menu is open. + + + + + Returns collection of items on a bar. + + + + + Gets or sets whether shortcut processing for the items hosted by this control is enabled. Default value is true. + + + + + Indicates whether radial menu is closed automatically when app is deactivated. Default value is true, if set to false + you are responsible for closing the menu. + + + + + Gets or sets whether hooks are used for internal DotNetBar system functionality. Using hooks is recommended only if DotNetBar is used in hybrid environments like Visual Studio designers or IE. + + + + + Indicates the radial menu type. eRadialMenuType.Segment menu type allows for display of image, text and any sub-menu items. + eRadialMenuType.Circular allows only for display of Symbol or Image and it does not display either text or sub-menu items. + eRadialMenuType.Circular is designed to be used for single level menus only that don't need text. + + + + + Indicates whether control automatically scales the items if the parent Form performs scaling due to AutoScale settings. + + + + + Indicates accessibility help string + + + + + Returns whether control has any popups registered. + + + + + Indicates whether shortcuts handled by items are dispatched to the next handler or control. + + + + + Indicates whether items show tooltips. + + + + + Indicates whether item shortcut is displayed in Tooltips. + + + + + Gets or sets whether accelerator letters on buttons are underlined. Default value is false which indicates that system setting is used + to determine whether accelerator letters are underlined. Setting this property to true + will always display accelerator letter underlined. + + + + + Gets or sets whether gray-scale algorithm is used to create automatic gray-scale images. Default is true. + + + + + Occurs after an item has been added to items collection. + + + + + Occurs after an item has been removed from items collection. + + + + + Occurs when mouse pointer enters boundaries of an item. + + + + + Occurs when mouse pointer hovers over an item. + + + + + Occurs when mouse pointer leaves boundaries of an item. + + + + + Occurs when mouse button is pressed on item. + + + + + Occurs when mouse button is released on item. + + + + + Occurs when mouse moves over an item. + + + + + Occurs when an item is clicked. + + + + + Occurs when an item is double-clicked. + + + + + Occurs when an item Expanded property value has changed. + + + + + Occurs when an item Text property value has changed. + + + + + Occurs when tooltip for an item is about to be displayed. + + + + + Defines colors used by Radial Menu Component. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Raises the PropertyChanged event. + + Event arguments + + + + Gets or sets the color of the Radial Menu button background. + + + + + Gets or sets the color of the radial menu button border. + + + + + Gets or sets the color of the Radial Menu background. + + + + + Gets or sets the color of the Radial Menu border + + + + + Gets or sets the color of border for mouse over state for the radial menu item expand part. + + + + + Gets or sets the color of the radial menu border for parts where items do not have sub-items, i.e. non-active area of the border. + + + + + Gets or sets the color of the expand sign which shows menu item sub-items. + + + + + Gets or sets the color of the radial menu item text. + + + + + Gets or sets the color of the radial menu item mouse over background. + + + + + Gets or sets the color of the radial menu item mouse over foreground. + + + + + Gets or sets the color of the radial menu item foreground when disabled. + + + + + Gets or sets background color of the circular menu item type. Applies only to circular menu types. + + + + + Gets or sets text color of the circular menu item type. Applies only to circular menu types. + + + + + Gets or sets border color of the circular menu item type. Applies only to circular menu types. + + + + + Occurs when property value has changed. + + + + + Initializes a new instance of the RadialMenuContainer class. + + + + + Returns copy of the item. + + + + + Copies the RadialMenuItem specific properties to new instance of the item. + + New ProgressBarItem instance. + + + + Copies the RadialMenuItem specific properties to new instance of the item. + + New RadialMenuItem instance. + + + + Raises Opened event. + + Provides event arguments. + + + + Raises Closed event. + + Provides event arguments. + + + + Called when OpenState property has changed. + + Old property value + New property value + + + + Closes currently open popup. + + + + + Called when MaxItemRadialAngle property has changed. + + Old property value + New property value + + + + Called when Diameter property has changed. + + Old property value + New property value + + + + Called when CenterButtonDiameter property has changed. + + Old property value + New property value + + + + Called when SubMenuEdgeWidth property has changed. + + Old property value + New property value + + + + Called when SubMenuEdgeItemSpacing property has changed. + + Old property value + New property value + + + + Return Sub Item at specified location + + + + + Called when MenuLocation property has changed. + + Old property value + New property value + + + + Called when RadialMenu property has changed. + + Old property value + New property value + + + + Gets the current expanded subitem. + + + + + + Called when BackSymbolSize property has changed. + + Old property value + New property value + + + + Called when BackSymbol property has changed. + + Old property value + New property value + + + + Called when BackButtonSymbolSet property value changes. + + Indciates old value + Indicates new value + + + + Called when MaxItemPieAngle property has changed. + + Old property value + New property value + + + + Called when MenuType property has changed. + + Old property value + New property value + + + + Called when Symbol property has changed. + + Old property value + New property value + + + + Called when SymbolSet property value changes. + + Indciates old value + Indicates new value + + + + Called when SymbolSize property has changed. + + Old property value + New property value + + + + Called when Image property has changed. + + Old property value + New property value + + + + Called when Font property has changed. + + Old property value + New property value + + + + Occurs after radial menu is opened. + + + + + Occurs after radial menu is closed. + + + + + Returns internal popup control for radial menu. + + + + + Indicates maximum radial angle single item in menu can consume. By default this property is set to zero which indicates that + radial menu is equally divided between visible menu items. + + + + + Returns diameter which takes in account current scaling factor. + + + + + Gets or sets radial menu diameter. Minimum value is 64. + + + + + Returns actual center button diameter which takes in account current scale factor. + + + + + Indicates diameter of center button of radial menu. + + + + + Specifies the width of the sub-menu edge around the radial menu. + + + + + Indicates spacing between sub-menu marking edge and the item. + + + + + Indicates the position of top-left corner of radial menu when shown in screen coordinates + + + + + Indicates the size of the back symbol that is displayed on center of radial menu + + + + + Specifies the back button symbol. + + + + + Gets or sets the symbol set used to represent the Symbol. + + + + + Specifies the maximum pie part angle an item will occupy. Maximum is 180, minimum is 1 degree. + + + + + Gets reference to colors used by the radial menu. + + + + + Indicates the radial menu type. eRadialMenuType.Radial menu type allows for display of image, text and any sub-menu items. + eRadialMenuType.Circular allows only for display of Symbol or Image and it does not display either text or sub-menu items. + eRadialMenuType.Circular is designed to be used for single level menus only that don't need text. + + + + + Gets the realized symbol string. + + + + + Indicates the symbol displayed on face of the button instead of the image. Setting the symbol overrides the image setting. + + + + + Gets or sets the symbol set used to represent the Symbol. + + + + + Indicates the size of the symbol in points. + + + + + Gets or sets the image displayed on the item. + + + + + Specifies font for menu items. + + + + + Initializes a new instance of the RadialSubItemInfo class. + + + + + + + + + Initializes a new instance of the RadialMenuPopupProxy class. + + + + + + Defines available radial menu type. + + + + + Defines Radial Menu Item. + + + + + Raises CheckedChanged event. + + Provides event arguments. + + + + Called when DisplayPath property has changed. + + Old property value + New property value + + + + Returns copy of the item. + + + + + Copies the RadialMenuItem specific properties to new instance of the item. + + New ProgressBarItem instance. + + + + Copies the RadialMenuItem specific properties to new instance of the item. + + New RadialMenuItem instance. + + + + Called when Symbol property has changed. + + Old property value + New property value + + + + Called when SymbolSet property value changes. + + Indciates old value + Indicates new value + + + + Called when SymbolSize property has changed. + + Old property value + New property value + + + + Called when Image property has changed. + + Old property value + New property value + + + + Called when TextVisible property has changed. + + Old property value + New property value + + + + Called when TracksMouse property has changed. + + Old property value + New property value + + + + Called when Checked property has changed. + + Old property value + New property value + + + + Called when TextOffset property has changed. + + Old property value + New property value + + + + Raises BeforeMenuOpened event. + + Provides event arguments. + + + + Raises BeforeMenuClosed event. + + Provides event arguments. + + + + Called when CircularMenuDiameter property has changed. + + Old property value + New property value + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Occurs after Checked property has changed. + + + + + Gets display path of the item. + + + + + Gets the realized symbol string. + + + + + Indicates the symbol displayed on face of the button instead of the image. Setting the symbol overrides the image setting. + + + + + Gets or sets the symbol set used to represent the Symbol. + + + + + Indicates the size of the symbol in points. + + + + + Gets or sets the image displayed on the item. + + + + + Indicates whether text on item is visible. + + + + + Gets whether mouse is over the item. + + + + + Indicates whether item changes its appearance when mouse is over it or pressed + + + + + Indicates whether item is in checked state. + + + + + Gets or sets the optional text offset for the item. + + + + + Gets or sets a value indicating whether the item is expanded or not. For Popup items this would indicate whether the item is popped up or not. + + + + + Occurs before radial menu item is expanded and its sub-items displayed. + + + + + Occurs before radial menu item is closed + + + + + Control Container (System.Windows.Forms.Control or its descendant) + + + + + Specifies explicit circular menu type diameter. Applies to circular menu type only. + + + + + Gets or sets background color of the circular menu item type. Applies only to circular menu types. + + + + + Gets or sets text color of the circular menu item type. Applies only to circular menu types. + + + + + Gets or sets border color of the circular menu item type. Applies only to circular menu types. + + + + + Initializes a new instance of the RadialMenuPopup class. + + + + + Called when DisplayItem property has changed. + + Old property value + New property value + + + + Returns the renderer control will be rendered with. + + The current renderer. + + + + Returns the color scheme used by control. Color scheme for Office2007 style will be retrieved from the current renderer instead of + local color scheme referenced by ColorScheme property. + + An instance of ColorScheme object. + + + + Identifies the item displayed by this popup. + + + + + Gets or sets the content image displayed on the window. + + + + + Gets or sets the rendering mode used by control. Default value is eRenderMode.Global which means that static GlobalManager.Renderer is used. If set to Custom then Renderer property must + also be set to the custom renderer that will be used. + + + + + Gets or sets the custom renderer used by the items on this control. RenderMode property must also be set to eRenderMode.Custom in order renderer + specified here to be used. + + + + + Represents rating item control which provides rating functionality. + + + + + Initializes a new instance of the RatingItem class. + + + + + Copies the ButtonItem specific properties to new instance of the item. + + New ButtonItem instance. + + + + Raises the AverageRatingChanged event. + + Event data. + + + + Raises the ParseAverageRatingValue event. + + Provides event arguments. + + + + Sets the Rating value of the control and provides information about source of the rating change. + + New Rating value. + Source of this change. + + + + Raises RatingChanging event. + + Event data + + + + Raises the RatingChanged event. + + Event data. + + + + Raises the ParseRating event. + + Provides event arguments. + + + + Occurs when Rating property has changed. + + + + + Occurs when RatingValue property has changed. + + + + + Occurs when Rating property is about to be changed and provides opportunity to cancel the change. + + + + + Occurs when AverageRating property has changed. + + + + + Occurs when AverageRatingValue property has changed. + + + + + Occurs when text markup link is clicked. Markup links can be created using "a" tag, for example: + Markup link + + + + + Occurs when RatingValue property is set and it allows you to provide custom parsing for the values. + + + + + Occurs when AverageRatingValue property is set and it allows you to provide custom parsing for the values. + + + + + Gets or sets the average rating shown by control. Control will display average rating (if set) when no explicit + Rating value is set through Rating property. Minimum value is 0 and Maximum value is controlled by NumberOfStars property value. + + + + + Gets or sets the AverageRating property. This property is provided for Data-Binding with NULL value support. + + + + + Gets or sets the rating value represented by the control. Default value is 0 which indicates + that there is no rating set. Maximum value is controlled by NumberOfStars property. + + + + + Gets or sets the Rating property value. This property is provided for Data-Binding with NULL value support. + + + + + Gets or sets whether rating can be edited. Default value is true. + + + + + Specifies the control background style. Default value is an empty style which means that container does not display any background. + + + + + Gets the reference to custom rating images. + + + + + Gets or sets whether text assigned to the check box is visible. Default value is true. + + + + + Gets or sets the text color. Default value is Color.Empty which indicates that default color is used. + + + + + Gets or sets the spacing between optional text and the rating. + + + + + Gets or sets the orientation of rating control. + + + + + Indicates number of stars used for the rating. Minium value is 2 stars. + + + + + Gets whether item supports text markup. Default is false. + + + + + Gets or sets whether text-markup support is enabled for items Text property. Default value is true. + Set this property to false to display HTML or other markup in the item instead of it being parsed as text-markup. + + + + + Initializes a new instance of the RatingImage structure. + + + + + + + Defines the custom rating images for Rating control. + + + + + Initializes a new instance of the RatingImages class. + + + + + Gets or sets the image used for unrated rating part. + + + + + Gets or sets the image used for unrated rating part when mouse is over the control. + + + + + Gets or sets the image used for rated part of the control. + + + + + Gets or sets the image used for Average Rated part of the control. + + + + + Gets or sets the image used for rated part of the control when mouse is over the control. + + + + + Delegate for Rating change events. + + + + + Represents event arguments for Rating change events. + + + + + New Rating value being assigned. + + + + + Previous or current value (if RatingChanging event). + + + + + Indicates the action that has caused the event. + + + + + Initializes a new instance of the RatingChangeEventArgs class. + + + + + + + + Represents color table for CrumbBarItemView. + + + + + Gets or sets the default state color table. + + + + + Gets or sets active mouse over color table. + + + + + Gets or sets inactive part mouse over color table. + + + + + Gets or sets the pressed color table. + + + + + Defines state color table for CrumbBarItemView + + + + + Gets or sets foreground/text color. + + + + + Gets or sets the background color blend collection. + + + + + Gets or sets the border color. + + + + + Gets or sets the border color. + + + + + Represents the color table for Office 2007 Style CalendarView Control. + + + + + Initializes ColorScheme object with the black color scheme. + + ColorScheme object to initialize. + + + + Defines colors for the WarningBox control. + + + + + Gets or sets the background color of WarningBox control. + + + + + Gets or sets the border color of the warning panel. + + + + + Gets or sets the back color of the warning panel. + + + + + Gets or sets the end gradient back color of the warning panel. + + + + + Gets or sets the background color of WarningBox control. + + + + + Gets or sets the border color of the warning panel. + + + + + Gets or sets the back color of the warning panel. + + + + + Gets or sets the end gradient back color of the warning panel. + + + + + Gets or sets the background color of WarningBox control. + + + + + Gets or sets the border color of the warning panel. + + + + + Gets or sets the back color of the warning panel. + + + + + Gets or sets the end gradient back color of the warning panel. + + + + + Gets or sets the background color of WarningBox control. + + + + + Gets or sets the border color of the warning panel. + + + + + Gets or sets the back color of the warning panel. + + + + + Gets or sets the end gradient back color of the warning panel. + + + + + Renders the Range Slider items. + + + + + Gets or sets color table used by renderer. + + + + + Defines the color table for the Range Slider Item in single state. + + + + + Gets or sets the colors for the slider which changes the minimum value of the range. + + + + + Gets or sets the colors for the slider which changes the maximum value of the range. + + + + + Gets or sets the tick line color. + + + + + Gets or sets the color for the line which indicates current range value. + + + + + Gets or sets the background colors of the current range value. + + + + + Gets or sets the color for the line showing control range. + + + + + Gets or sets the background colors for the line showing control range. + + + + + Gets or sets the corner radius for the range rectangle. + + + + + Defines the color table for the Range Slider Item in single state. + + + + + Gets or sets the default state colors. + + + + + Gets or sets the mouse over state colors. + + + + + Gets or sets the mouse pressed colors. + + + + + Gets or sets the disabled colors. + + + + + Initializes a new instance of the Office2010RangeChangePartColorTable class. + + + + + Initializes a new instance of the Office2010RangeChangePartColorTable class. + + + + + + + + Gets or sets the part background colors. + + + + + Gets or sets the part border color + + + + + Gets or sets the part border light color + + + + + Represents color table for Office 2010 style. + + + + + Represents color table for Office 2007 style. + + + + + Defines the provider for the element style classes support. + + + + + Returns the instance of the ElementStyle with given class name or null if there is no class with that name defined. + + Class name. See static members of ElementStyleClassKeys class for the list of available keys. + Instance of ElementStyle for given class name or null if class cannot be found. + + + + Creates new instance of the object. + + + + + Initializes a new instance of the Office2007ColorTable class. + + Specifies the color factory for the color table. + + + + Creates new instance of the object. + + + + + Creates new instance of the object. + + + + + Creates new instance of the color table and initializes it with custom color scheme. + + Predefined color scheme to be used as starting color scheme. + Color to use as basis for new color scheme + + + + Gets or sets the RibbonBar color table. + + + + + Gets or sets the background colors for the ItemContainer with BeginGroup property set to true. + + + + + Gets or sets the background colors for the Bar object. + + + + + Gets or sets the colors for the RibbonControl. + + + + + Gets or sets the colors for the ColorItem which is used by drop-down Color Picker. + + + + + Gets or sets the color table for menus. + + + + + Gets or sets the color table for ComboBoxItem. + + + + + Gets or sets the colors for the Ribbon Bar dialog launcher button. + + + + + Gets or sets the legacy color scheme object that applies to the user interface elements not covered by color table. + + + + + Gets or sets the color table of the system buttons displayed in form caption. + + + + + Gets or sets the color table of the close system button displayed in form caption. Applies to Office 2010 styles and later only. + + + + + Gets or sets the color table for the form caption. + + + + + Gets or sets the bacgkround colors for the quick access toolbar. + + + + + Gets or sets the colors for the tab and tab strip control. + + + + + Gets or sets the colors for the tab strip control used on docking windows. When not set TabControl color scheme is used. + + + + + Gets or sets the KeyTips color table. + + + + + Gets or sets the color table for the CheckBoxItem. + + + + + Gets or sets the scroll bar colors. + + + + + Gets or sets the application style scroll bar colors. + + + + + Gets or sets the color table for the ProgressBarItem. + + + + + Gets or sets the color table for the paused ProgressBarItem. + + + + + Gets or sets the color table for the error state of ProgressBarItem. + + + + + Gets or sets the color table for the galleries. + + + + + Gets or sets the color table for the NavigationPane control. + + + + + Gets or sets the color table for the Slider item. + + + + + Gets or sets the color table for the Range Slider item. + + + + + Gets the SuperTooltip color table. + + + + + Gets the color table for the ListViewEx control. + + + + + Gets the color table for the ListViewEx control. + + + + + Gets the color table used by SideBar control. + + + + + Gets or sets the color table for AdvTree control. + + + + + Gets or sets the CrumBarItem color table. + + + + + Gets the color table used by Schedule control. + + + + + Gets or sets SwitchButton color table. + + + + + Gets or sets the colors for the StepItem used in ProgressSteps control. + + + + + Gets or sets the colors for the ListBoxItem used in ListBoxAdv control. + + + + + Gets or sets the color table for the radial menu. + + + + + Gets or sets color table for TokenEditor control tokens. + + + + + Gets or sets color table for Flyout control. + + + + + Gets or sets the colors for the SideNav control. + + + + + Gets or sets the color tables for the TabFormItem. The key is the string representation of a eTabFormItemColor value. + + + + + Returns the instance of the ElementStyle with given class name or null if there is no class with that name defined. + + Class name. See static members of ElementStyleClassKeys class for the list of available keys. + Instance of ElementStyle for given class name or null if class cannot be found. + + + + Gets the reference to collection of Office2007ButtonItemColorTable objects the describe colors used by a button with Office 2007 style. + The collection by default has elements that are created to + represents the members of eButtonColor enumeration. The name of each color table object is the same as the string + enum representation. You can add custom members to this collection or modify the existing ones. Note that you must specify the + unique name for the new color table elements. Name specified there can be used in ButtonItem.CustomColorName property to specify + custom color table for an ButtonItem. + + + + + Gets the reference to collection of Office2007ButtonItemColorTable objects the describe colors used by a button with Office 2007 style when + button is on RibbonBar control. When collection is empty the values from the ButtonItemColors collections are used instead. + + + + + Gets the reference to collection of Office2007ButtonItemColorTable objects the describe colors used by a button with Office 2007 style when + button is on menu bar. When collection is empty the values from the ButtonItemColors collections are used instead. + + + + + Gets the reference to collection of Office2007ButtonItemColorTable objects the describe colors used by Ribbon Application Menu Button in Office 2010 style. + + + + + Gets the reference to collection of Office2007ButtonItemColorTable objects the describe colors used by buttons that are on Backstage tab-strip. + + + + + Gets the reference to collection of Office2007ButtonItemColorTable objects the describe colors used by buttons that are on NavigationPane control. Currently used for Office 2010 style only. When empty ButtonItemColors is used. + + + + + Gets the reference to collection of Office2007RibbonTabItemColorTable objects the describe colors used by a ribbon tab with Office 2007 style. + The collection by default has elements that are created to + represents the members of eRibbonTabColor enumeration. The name of each color table object is the same as the string + enum representation. You can add custom members to this collection or modify the existing ones. Note that you must specify the + unique name for the new color table elements. Name specified there can be used in RibbonTabItem.CustomColorName property to specify + custom color table for an ButtonItem. + + + + + Gets the reference to collection of Office2007RibbonTabGroupColorTableCollection objects the describe colors used by a ribbon tab groups with Office 2007 style. + The collection by default has elements that are created to + represents the members of eRibbonTabGroupColor enumeration. The name of each color table object is the same as the string + enum representation. You can add custom members to this collection or modify the existing ones. Note that you must specify the + unique name for the new color table elements. + + + + + Returns the color scheme table was initialized with. + + + + + Get the reference to the collection that holds system cached styles. In most cases there is no need for you to modify members of this collection. + + + + + Gets or sets whether images like Start button image, are cloned when painted. This is reduces the performance but is necessary if they can be accessed from multiple threads. + + + + + Gets the reference to collection of contextual color tables that are based on items Control container type and other context properties. + When contextual color table is defined it overrides the default color table. + + + + + Initializes a new instance of the Office2010ColorTable class. + + + + + Gets the color scheme color table is initialized with. + + + + + Defines the color scheme type for the Office2010ColorTable. + + + + + Silver color scheme. + + + + + Blue color scheme. + + + + + Black color scheme. + + + + + Visual Studio 2010 Blue color scheme. + + + + + Specifies colors for StepIndicator control. + + + + + Initializes a new instance of the StepIndicatorColorTable class. + + + + + Initializes a new instance of the StepIndicatorColorTable class. + + + + + + + Gets or sets Background color of the control. + + + + + Gets or sets indicator color. + + + + + Defines the color table for SuperTab states + + + + + Event raised when the SuperTabColorTable is changed + + + + + Gets or sets the Background color + + + + + Gets or sets the colors for the outer border. + + + + + Gets or sets the colors for the inner border. + + + + + Gets or sets the ControlBoxDefault colors + + + + + Gets or sets the ControlBoxMouseOver colors + + + + + Gets or sets the ControlBoxPressed colors + + + + + Gets or sets the colors for the InsertMarker. + + + + + Gets or sets the color for the SelectionMarker. + + + + + Gets whether the ColorTable is empty. + + + + + Defines the colors for the SuperTabControlBox states + + + + + Event raised when the SuperTabControlBoxStateColorTable is changed + + + + + Gets or sets the colors for the background. + + + + + Gets or sets the colors for the border. + + + + + Gets or sets the colors for the drawn image. + + + + + Defines the color table for SuperTabItem states + + + + + Event raised when the SuperTabItemColorTable is changed + + + + + Gets or sets the Default tab color settings + + + + + Gets or sets the Left Aligned tab color settings + + + + + Gets or sets the Bottom Aligned tab color settings + + + + + Gets or sets the Right Aligned tab color settings + + + + + Event raised when the SuperTabColorStates is changed + + + + + Gets or sets the tab colors when the tab is not selected, and the mouse is not over it + + + + + Gets or sets the tab colors when the tab is selected, but the mouse is not over the it + + + + + Gets or sets the tab colors when the tab is not selected, but the mouse is over it + + + + + Gets or sets the tab colors when the tab is selected, and the mouse is over it + + + + + Gets or sets the tab colors when the tab + is disabled, is not selected, and the mouse is not over it + + + + + Defines the colors for the SuperTabItem states + + + + + Event raised when the SuperTabItemStateColorTable is changed + + + + + Gets or sets the background colors. + + + + + Gets or sets the outer border color. + + + + + Gets or sets the inner border color. + + + + + Gets or sets the text color. + + + + + Gets or sets the Close Marker color. + + + + + Gets or sets the Selection Marker color. + + + + + Event raised when the SuperTabLinearGradientColorTable is changed + + + + + Gets or sets the Gradient Colors + + + + + Gets or sets the Gradient Color Positions + + + + + Gets or sets the Gradient angle + + + + + Gets or sets whether the Gradient will adapt to changes in the TabAlignment + + + + + Gets whether color definition is empty + + + + + Defines the colors for the SuperTabPanel + + + + + Event raised when the SuperTabPanelColorTable is changed + + + + + Gets or sets the Default tab panel color settings + + + + + Gets or sets the Left Aligned tab panel color settings + + + + + Gets or sets the Bottom Aligned tab panel color settings + + + + + Gets or sets the Right Aligned tab panel color settings + + + + + Event raised when the SuperTabPanelItemColorTable is changed + + + + + Gets or sets the background colors. + + + + + Gets or sets the colors for the outer border. + + + + + Gets or sets the colors for the inner border. + + + + + GetOffice2010BackstageColorTable + + Office2010BackstageColorTable + + + + GetOffice2010BackstageBlueColorTable + + + + Office2010BackstageBlueColorTable + + + + GetVS2010BackstageBlueColorTable + + + + Office2010BackstageBlueColorTable + + + + GetOffice2010BackstageBlackColorTable + + + + Office2010BackstageBlackColorTable + + + + GetOffice2010BackstageSilverColorTable + + + + Office2010BackstageSilverColorTable + + + + GetOffice2007BackstageVistaGlassColorTable + + + + Office2010BackstageVistaGlassColorTable + + + + GetOffice2010BackstageSilverColorTable + + + + Office2010BackstageSilverColorTable + + + + GetOffice2010BackstageItemColorTable + + Office2010BackstageItemColorTable + + + + GetOffice2010BackstageBlueItemColorTable + + + + Office2010BackstageBlueItemColorTable + + + + GetOffice2010BackstageBlackItemColorTable + + + + Office2010BackstageBlackItemColorTable + + + + GetOffice2010BackstageSilverItemColorTable + + + + Office2010BackstageSilverItemColorTable + + + + GetOffice2007BackstageVistaGlassItemColorTable + + + + Office2010BackstageVistaGlassItemColorTable + + + + GetOffice2010BackstageSilverItemColorTable + + + + + Office2010BackstageSilverItemColorTable + + + + GetOffice2010BackstagePanelColorTable + + Office2010BackstagePanelColorTable + + + + GetOffice2010BackstageBluePanelColorTable + + + + Office2010BackstageBluePanelColorTable + + + + GetOffice2010BackstageBlackPanelColorTable + + + + Office2010BackstageBlackPanelColorTable + + + + GetOffice2010BackstageSilverPanelColorTable + + + + Office2010BackstageSilverPanelColorTable + + + + GetOffice2007BackstageVistaGlassPanelColorTable + + + + Office2010BackstageVistaGlassPanelColorTable + + + + GetOffice2010BackstageSilverPanelColorTable + + + + Office2010BackstageSilverPanelColorTable + + + + Defines color table for the SwitchButton control. + + + + + Gets or set the text/caption color. + + + + + Gets or sets the OFF text color. + + + + + Gets or sets the ON text color. + + + + + Gets or sets the button border color. + + + + + Gets or sets background color of OFF switch part. + + + + + Gets or sets background color of ON switch part. + + + + + Gets or sets the switch border color. + + + + + Gets or sets the switch background color. + + + + + Gets or sets the switch background color when in ON state, i.e. Value=true. When set to Color.Empty SwitchBackColor is always used. + + + + + Gets default disabled color scheme for the switch button. + + + + + Gets or sets default Switch Button color table. + + + + + Gets or sets the disabled Switch Button color table. + + + + + Represents the Windows 7 blue style color initialization class. + + + + + Represents color table for Windows 7 style. + + + + + Initializes a new instance of the Office2010ColorTable class. + + + + + Defines the color scheme type for the Office2010ColorTable. + + + + + Blue color scheme. + + + + + Provides information about the binding for the item. + + + + + Initializes a new instance of the ItemBindingInfo class. + + + + + + + Gets or sets the data row item is bound to. + + + + + Gets or sets the data item index. + + + + + Gets or sets the additional data connected to this binding information. + + + + + Represents the slider item which allows you to select a value from predefined range. + + + + + Creates new instance of SliderItem. + + + + + Creates new instance of SliderItem and assigns the name to it. + + Item name. + + + + Creates new instance of SliderItem and assigns the name and text to it. + + Item name. + item text. + + + + Returns copy of the item. + + + + + Copies the SliderItem specific properties to new instance of the item. + + New SliderItem instance. + + + + Copies the SliderItem specific properties to new instance of the item. + + New SliderItem instance. + + + + Raises ValueChanging event. + + Provides event arguments. + + + + Raises ValueChanged event. + + Provides event arguments. + + + + Raises GetRangeTooltipText event. + + Provides event arguments. + + + + Gets the range part that is under specified client location. + + Location in parent control client coordinates. + Range part at specified location. + + + + Called when Minimum property has changed. + + Old property value + New property value + + + + Called when Maximum property has changed. + + Old property value + New property value + + + + Sets the range value. + + New Range value. + Source of the value change. + + + + Called when Value property has changed. + + Old property value + New property value + + + + Called when TicksVisible property has changed. + + Old property value + New property value + + + + Called when TicksStep property has changed. + + Old property value + New property value + + + + Called when RangeButtonSize property has changed. + + Old property value + New property value + + + + Called when TicksPosition property has changed. + + Old property value + New property value + + + + Called when MinimumAbsoluteRange property has changed. + + Old property value + New property value + + + + Called when RangeTooltipFormat property has changed. + + Old property value + New property value + + + + Called when MinRangeSliderImage property has changed. + + Old property value + New property value + + + + Called when MaxRangeSliderImage property has changed. + + Old property value + New property value + + + + Called when RangeLineHeight property has changed. + + Old property value + New property value + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Occurs before Value has changed and allow the cancellation of the change. + + + + + Occurs after Value property has changed + + + + + Gets mouse over part. + + + + + Gets current part that is pressed using mouse left button. + + + + + Occurs when control is about to display the range tooltip and it allows you to customize tooltip + + + + + Gets or sets the minimum value of the range of the control. + + + + + Gets or sets the maximum value of the range of the control. + + + + + Gets or sets the range displayed by the control. + + + + + Indicates whether tick lines are shown + + + + + Gets tick marks bounds. + + + + + Gets tick marks bounds for second marker is visible. + + + + + Gets bounds of minimum range sliding button. + + + + + Gets bounds of maximum range sliding button. + + + + + Indicates tick display period + + + + + Gets or sets the slider orientation. Default value is horizontal. + + + + + Gets or sets the width of the range slider in pixels. Value must be greater than 0. Default value is 140. + + + + + Gets or sets the Height of the range slider in pixels. Value must be greater than 0. Default value is 24. + + + + + Indicates the size of the range change buttons. + + + + + Specifies the ticks position inside of Range Slider. + + + + + Specifies minimum absolute range that user can select. Absolute range is defined as Abs(Value.Max-Value.Min) Applies to user performed selection through mouse only. + + + + + Gets or sets the string that is used to format the range value to be displayed while user moves the range buttons. Value set here is used in string.Format(RangeTooltipFormat, Value.Min, Value.Max). + + + + + Specifies whether range tooltip is shown while user is changing the range + + + + + Indicates image to be used as minimum range slider button instead of built-in button. Image is scaled to size set by RangeButtonSize. + + + + + Indicates image to be used as maximum range slider button instead of built-in button. Image is scaled to size set by RangeButtonSize. + + + + + Specifies the height of the range line + + + + + Indicates whether clicking the area outside of the range change buttons moves the range change button to the clicked location if possible thus allowing range change. + + + + + Gets or sets the color of the range value. + + + + + Specifies the ticks position inside of Range Slider. + + + + + Ticks are displayed on top of range sliders. + + + + + Ticks are displayed on bottom of range sliders. + + + + + Ticks are displayed on top and bottom of range sliders. + + + + + Defines value for the range slider controls. + + + + + Gets or sets the range minimum value. + + + + + Gets or sets the range maximum value. + + + + + Provides data for the Slider item rendering events. + + + + + Gets or sets the reference to the item being rendered. + + + + + Gets or sets the reference to graphics object. + + + + + Creates new instance of the object and initializes it with default values. + + Reference to the Range Slider item being rendered. + Reference to the graphics object. + + + + Defines delegate for RangeSliderValueChanging event. + + + + + + + Provides information for RangeSliderValueChanging event. + + + + + Represents event arguments that provide information on source of action. + + + + + Gets the source of the event. + + + + + Initializes a new instance of the EventSourceArgs class. + + + + + + New range value. + + + + + Set to true to cancel the value changing. + + + + + Initializes a new instance of the RangeSliderValueChangingEventArgs class. + + + + + + Defines the slider item parts. + + + + + Indicates no part. + + + + + Indicates the minimum range slider button. + + + + + Indicates the maximum range slider button. + + + + + Indicates the track area part of the control. + + + + + Defines delegate for RangeSliderValueChanging event. + + + + + + + Provides information for GetRangeTooltip event. + + + + + Gets or sets the tooltip to display. + + + + + Initializes a new instance of the RangeTooltipEventArgs class. + + + + + + Color definition class + + + + + Constructor - solid def + + RGB value + + + + Constructor - solid def + + Color + + + + Constructor - 2 color def + + Start Color + End Color + + + + Constructor - 2 color def + + Start Color + End Color + Gradient angle + + + + Constructor - Gradient def + + Array of RGB values + Gradient positions + + + + Constructor - Gradient def + + Array of Color values + Gradient positions + + + + Constructor - Gradient def + + Array of RGB values + Gradient positions + Gradient angle + + + + Constructor - Gradient def + + Array of Color values + Gradient positions + Gradient angle + + + + OnColorDefChanged + + + + + Event raised when the SuperTabColorStates is changed + + + + + Gets or sets the Color array + + + + + Gets or sets the Color Positions + + + + + Gets or sets the Gradient Angle + + + + + IsEmpty + + + + + ColorDefConvertor + + + + + Represents the visual separator line that is displayed between items. + + + + + Creates new instance of Separator. + + + + + Creates new instance of Separator and assigns the name to it. + + Item name. + + + + Returns copy of the item. + + + + + Copies the ButtonItem specific properties to new instance of the item. + + New ButtonItem instance. + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets or sets separator padding. + + + + + Gets or sets the size of separator. Size specified is for separator in Vertical orientation. If orientation changes then the size will be internally switched to respect proper orientation. + + + + + Indicates splitter orientation. + + + + + Gets or sets the separator color. + + + + + Gets or sets the separator shade color. + + + + + Defines an item that allows the toolbar customization. + + + + + Creates new instance of CustomizeItem object. + + + + + Returns copy of CustomizeItem item + + + + + Called when item container has changed. If you override this method you must call the base implementation to allow default processing to occur. + + Previous container of the item. + + + + Occurs when tooltip is about to be shown or hidden. + + Specifies whether tooltip is shown or hidden. + + + + Loads the resources (text) used by this item. + + + + + Overriden. Draws the item. + + Target Graphics object. + + + + Sets the custom system tooltip text for the item. + + Tooltip text. + + + + Overriden. Recalculates the size of the item. + + + + + Gets localized tooltip text for this instance of the item. + + Tooltip text. + + + + Called when mouse hovers over the customize item. + + + + + Forces the repaint the item. + + + + + Returns the Font object to be used for drawing the item text. + + Font object. + + + + Overloaded. Serializes the item and all sub-items into the XmlElement. + + XmlElement to serialize the item to. + + + + Overloaded. Deserializes the Item from the XmlElement. + + Source XmlElement. + + + + Gets whether the mouse is over the item. + + + + + Gets or sets a value indicating whether the item is visible. + + + + + Gets or sets whether Customize menu item is visible. + + + + + Indicates whether the item will auto-collapse (fold) when clicked. + When item is on popup menu and this property is set to false, menu will not + close when item is clicked. + + + + + Gets or sets whether item can be customized by end user. + + + + + Gets or sets whether item is global or not. + This flag is used to propagate property changes to all items with the same name. + Setting for example Visible property on the item that has GlobalItem set to true will + set visible property to the same value on all items with the same name. + + + + + Represents base class for the CalendarMonth and MultiMonthCalendar controls. This class is used internally by DotNetBar and is not intended for public use. + + + + + Initializes a new instance of the MultiMonthCalendar class. + + + + + Must be overridden by class that is inheriting to provide the painting for the item. + + + + + Paints background of the item. + + Provides painting arguments + + + + Returns copy of the item. + + + + + Copies the CalendarMonth specific properties to new instance of the item. + + New ButtonItem instance. + + + + Specifies the container background style. Default value is an empty style which means that container does not display any background. + BeginGroup property set to true will override this style on some styles. + + + + + Returns name of the item that can be used to identify item from the code. + + + + + Gets or sets the accessible role of the item. + + + + + + Indicates whether the item will auto-collapse (fold) when clicked. + When item is on popup menu and this property is set to false, menu will not + close when item is clicked. + + + + + Gets or sets whether item can be customized by end user. + + + + + Returns category for this item. If item cannot be customzied using the + customize dialog category is empty string. + + + + + Gets or sets whether Click event will be auto repeated when mouse button is kept pressed over the item. + + + + + Gets or sets the auto-repeat interval for the click event when mouse button is kept pressed over the item. + + + + + Specifies the mouse cursor displayed when mouse is over the item. + + + + + Gets or sets item description. This description is displayed in + Customize dialog to describe the item function in an application. + + + + + Gets or sets whether item is global or not. + This flag is used to propagate property changes to all items with the same name. + Setting for example Visible property on the item that has GlobalItem set to true will + set visible property to the same value on all items with the same name. + + + + + Gets or sets item alignment inside the container. + + + + + Gets or sets the collection of shortcut keys associated with the item. + + + + + Gets or sets whether item will display sub items. + + + + + Gets or sets whether the item expands automatically to fill out the remaining space inside the container. Applies to Items on stretchable, no-wrap Bars only. + + + + + Specifies whether item is drawn using Themes when running on OS that supports themes like Windows XP. + + + + + Gets/Sets informational text (tooltip) for the item. + + + + + Gets or sets the text associated with this item. + + + + + Defines the visual marking applied to dates through month calendar control. + + + + + Initializes a new instance of the DateAppearanceDescription class. + + + + + Initializes a new instance of the DateAppearanceDescription class. + + + + + + Applies all settings from this object to specified object. + + Reference to object. + + + Gets whether property should be serialized. Provided for WinForms designer support. + + + Resets property to its default value. Provided for WinForms designer support. + + + Gets whether property should be serialized. Provided for WinForms designer support. + + + Resets property to its default value. Provided for WinForms designer support. + + + Gets whether property should be serialized. Provided for WinForms designer support. + + + Resets property to its default value. Provided for WinForms designer support. + + + Gets whether property should be serialized. Provided for WinForms designer support. + + + Resets property to its default value. Provided for WinForms designer support. + + + + Gets or sets whether text is drawn using bold font. + + + + + Gets or sets the background color for the marked day. + + + + + Gets or sets the background target gradient color for the marked date. + + + + + Gets or sets the background gradient fill angle. Default value is 90. + + + + + Gets or sets the text color for the marked date. + + + + + Gets whether any of the appearance values have been changed. + + + + + Gets or sets the border color. + + + + + Gets or sets whether day marked is selectable by end user. Default value is true. + + + + + Reverts the input to the last stored value. + + + + + Called when input field is full, i.e. it has an complete entry. If auto-overwrite is enabled the continued typing after input is complete + will erase the existing entry and start new one. + + + + + Resets the input position so the new input overwrites current value. + + + + + Occurs when input on the control has changed. + + + + + Occurs when validation of the input is performed and it allows you to deny the input. + + + + + Occurs when IsEmpty property has changed. + + + + + Gets whether watermark will be drawn in current control state. + + + + + Gets or sets whether control is empty. + + + + + Gets or sets whether auto-overwrite functionality for input is enabled. When in auto-overwrite mode input field will erase existing entry + and start new one if typing is continued after InputComplete method is called. + + + + + Gets or sets the watermark text displayed on the input control when control is empty. + + + + + Gets or sets whether watermark text is displayed if set. Default value is true. + + + + + Gets or sets whether input item is read-only. + + + + + Gets or sets whether control allows empty input state i.e. does not have an text entered. Default value is true. + + + + + Raises SelectedIndexChanged event + + + + + Occurs when SelectedIndex property has changed. + + + + + Gets or sets the text that is selected by the control. + + + + + Gets or sets the currently selected index. -1 is returned if nothing is selected. + + + + + Gets or sets custom AM text used. + + + + + Gets or sets custom PM text used. + + + + + Represents a control that enables the user to select a date using a visual monthly calendar display. + + + + + Initializes a new instance of the MonthCalendarAdv class. + + + + + Returns the DayLabel at given client coordinates or null/nothing if there is no label at give location. + + X - position in client coordinates. + Y - position in client coordinates. + DayLabel at given coordinates or null/nothing. + + + + Returns the DayLabel that represents the date. + + Date to find label for. + DayLabel object or nothing if date cannot be founds. + + + + Returns whether property should be serialized. Provided for Windows Forms designer support. + + + + + Resets property to its default value. Provided for Windows Forms designer support. + + + + + Removes all monthly marked dates. Note that you must call UpdateMarkedDates method to reflect these changes on calendar. + + + + + Removes the date from the MonthlyMarkedDates. Note that you must call UpdateMarkedDates method to reflect these changes on calendar. + + + + + + Returns whether property should be serialized. Provided for Windows Forms designer support. + + + + + Resets property to its default value. Provided for Windows Forms designer support. + + + + + Removes all weekly marked dates. Note that you must call UpdateMarkedDates method to reflect these changes on calendar. + + + + + Removes the day from the WeeklyMarkedDays. Note that you must call UpdateMarkedDates method to reflect these changes on calendar. + + + + + + Returns whether property should be serialized. Provided for Windows Forms designer support. + + + + + Resets property to its default value. Provided for Windows Forms designer support. + + + + + Removes all annually marked dates. Note that you must call UpdateMarkedDates method to reflect these changes on calendar. + + + + + Removes the date from the AnnuallyMarkedDates. Note that you must call UpdateMarkedDates method to reflect these changes on calendar. + + + + + + Returns whether property should be serialized. Provided for Windows Forms designer support. + + + + + Resets property to its default value. Provided for Windows Forms designer support. + + + + + Removes all marked dates set through MarkedDates property. Note that you must call UpdateMarkedDates method to reflect these changes on calendar. + + + + + Removes the date from the MarkedDates collection. Note that you must call UpdateMarkedDates method to reflect these changes on calendar. + + + + + + Repaints the marked dates to reflect the dates set in the lists of marked dates. + Use this method to reflect the changes made to the AnnuallyMarkedDates, MonthlyMarkedDates or MarkedDates properties as well + as change to the marked Colors properties. + + + + + Raises the DateChanged event. + + Provides event data. + + + + Raises the DateSelected event. + + Provides event data. + + + + Raises the MonthChanged event. + + Provides additional event data. + + + + Raises the MonthChanging event. + + Provides additional event data. + + + + Raises the PaintLabel event. + + Provides event data. + + + + Raises the LabelMouseDown event. + + Provides event data. + + + + Raises the LabelMouseUp event. + + Provides event data. + + + + Raises the LabelMouseEnter event. + + Provides event data. + + + + Raises the LabelMouseLeave event. + + Provides event data. + + + + Raises the LabelMouseMove event. + + Provides event data. + + + + Raises the LabelMouseHover event. + + Provides event data. + + + + Gets whether property should be serialized. Provided for designer support. + + + + + + Reset property to default value. Provided for designer support. + + + + + Gets whether property should be serialized. Provided for designer support. + + + + + + Reset property to default value. Provided for designer support. + + + + + Gets whether Value property should be serialized by Windows Forms designer. + + true if value serialized otherwise false. + + + + Reset the MinDate property to its default value. + + + + + Gets whether Value property should be serialized by Windows Forms designer. + + true if value serialized otherwise false. + + + + Reset the MaxDate property to its default value. + + + + + Resets property to its default value. Provided for design-time support. + + + + + Gets whether property should be serialized. Provided for design-time support. + + + + + Sets the number of columns and rows of months to display. + + The number of columns. + The number of rows. + ArgumentOutOfRangeException will be raised if any value is less than zero or one value is grater than zero and other is zero. + + + + Returns whether property should be serialized by Windows Forms designer. + + + + + Sets the selected dates in a month calendar control to the specified date range. + + The beginning date of the selection range. + The end date of the selection range. + startDate is less than the minimum date allowable for a month calendar control.
+ -or-
+ startDate is greater than the maximum allowable date for a month calendar control.
+ -or-
+ endDate is less than the minimum date allowable for a month calendar control.
+ -or- endDate is greater than the maximum allowable date for a month calendar control.
+ + + If the startDate value is greater than endDate property value, the dates are swapped; the endDate value becomes the starting date, and startDate value becomes the end date. + + + + + Invalidates control auto-size and resizes the control if AutoSize is set to true. + + + + + Occurs when month displayed by the item has changed. + + + + + Occurs before the month that is displayed is changed. + + + + + Occurs when child label representing days is rendered and it allows you to override default rendering. + + + + + Occurs when mouse button is pressed over the day/week label inside of the calendar. + + + + + Occurs when mouse button is released over day/week label inside of the calendar. + + + + + Occurs when mouse enters the day/week label inside of the calendar. + + + + + Occurs when mouse leaves the day/week label inside of the calendar. + + + + + Occurs when mouse moves over the day/week label inside of the calendar. + + + + + Occurs when mouse remains still inside an day/week label of the calendar for an amount of time. + + + + + Occurs when SelectedDate property has changed. + + + + + Occurs when the user makes an explicit date selection using the mouse. + + + This event is similar to the DateChanged event, but it occurs at the end of a date selection made using the mouse. + The DateChanged event occurs during any date selection, whether by mouse, keyboard, or code. You should handle this event + when you enable multiple date selection through MultiSelect property and want to be notified after the date selection has been + made. DateChanged event would fire each time selection changes during the selection of multiple dates. + + + + + Gets or sets the array of DateTime objects that determine which monthly days to mark using Colors.MonthlyMarker settings. + Make sure to call UpdateMarkedDates() method to update calendar display with marked dates. + + + + + Gets or sets the array of DayOfWeek members that determine which days of week to mark using Colors.WeeklyMarker settings. + + + + + Gets or sets the array of DateTime objects that determines which annual days are marked using Colors.AnnualMarker settings. + Make sure to call UpdateMarkedDates() method to update calendar display with marked dates. + + + + + Gets or sets the array of DateTime objects that determines which non-recurring dates are marked using Colors.DayMarker settings. + Make sure to call UpdateMarkedDates() method to update calendar display with marked dates. + + + + + Gets or sets the first month displayed by the control. + + + + + Gets number of months displayed on the control. + + + + + Gets the calendar colors used by the control. + + + + + Gets or sets the size of each day item on the calendar. Default value is 24, 15. + + + + + Gets or sets the size of date navigation buttons on the calendar. Default value is 13, 18. If you increase size of the navigation + buttons change DaySize as well so everything fits. + + + + + Gets or sets the minimum date and time that can be selected in the control. + + + + + Gets or sets the maximum date and time that can be selected in the control. + + + + + Specifies the commands container background style. Commands container displays Today and Clear buttons if they are visible. + + + + + Specifies the navigation container background style. Navigation container displays month, year and optional buttons. Default value is an empty style which means that container does not display any background. + BeginGroup property set to true will override this style on some styles. + + + + + Gets or sets the number of columns and rows of months displayed on control. Default value is 0,0 which indicates that + calendar will display as many columns and rows as it is possible to fit into container space available. + + + + + Gets or sets whether weekend days can be selected. Default value is true. + + + + + Gets or sets the rule used to determine first week of the year for week of year display on calendar. Default value is first-day. + + + + + Gets or sets the value that is used by calendar as today's date. + + + + + Gets a value indicating whether the TodayDate property has been explicitly set. + + + + + Gets or sets whether today marker that indicates TodayDate is visible on the calendar. Default value is true. + + + + + Gets or sets whether week of year is visible. Default value is false. + + + + + Gets or sets the array of custom names for days displayed on calendar header. The array must have exactly 7 elements representing day names from 0 to 6. + + + + + Gets or sets the first day of week displayed on the calendar. Default value is Sunday. + + + + + Gets or sets whether control uses the two letter day names. Default value is true. + + + + + Gets or sets the calendar selected date. Note that SelectedDate property should be used only when MultiSelect property is set to false. + When multiple dates can be selected use range selection properties: SelectionStart, SelectionEnd and SelectionRange. + + + + + Gets or sets whether selection of multiple dates up to the MaxSelectionCount is enabled. Default value is false which indicates that only + single day can be selected. + + + + + Gets the reference to the bottom container that parents the Today, and Clear system buttons. + + + + + Gets or sets whether Today button displayed at the bottom of the calendar is visible. Default value is false. + + + + + Gets or sets whether Clear button displayed at the bottom of the calendar is visible. Clear button clears the currently selected date. Default value is false. + + + + + Gets or sets the maximum number of days that can be selected in a month calendar control. + + + + + Gets or sets the start date of the selected range of dates. + + + + + Gets or sets the end date of the selected range of dates. + + + + + Gets or sets the selected range of dates for a month calendar control. + + Setting this property is functionally equivalent to using the SetSelectionRange method. You can set the start and end dates separately by setting either the SelectionStart or SelectionEnd properties. You cannot change the start and end dates by setting the SelectionRange.Start or SelectionRange.End property values of the SelectionRange property. You should use SelectionStart, SelectionEnd, or SetSelectionRange. + If the Start property value of the SelectionRange is greater than its End property value, the dates are swapped; the End property value becomes the starting date, and Start property value becomes the end date. + + + + + Gets or sets whether Year/Century selection is enabled when calendar is displaying single month. + + + + + Indicates whether month selector which is displayed when month label is clicked is using abbreviated month names instead of month number. + + + + + Indicates whether calendar is used in month selection mode which shows only month and year. + + + + + Gets or sets a value indicating whether the control is automatically resized to display its entire contents. You can set MaximumSize.Width property to set the maximum width used by the control. + + + + + Represents the container that presents single calendar month. + + + + + Initializes a new instance of the CalendarMonth class. + + + + + Called when MonthSelectionMode property has changed. + + Old property value + New property value + + + + Must be overridden by class that is inheriting to provide the painting for the item. + + + + + Returns copy of the item. + + + + + Copies the CalendarMonth specific properties to new instance of the item. + + New ButtonItem instance. + + + + Raises the MonthChanged event. + + Provides additional event data. + + + + Raises the MonthChanging event. + + Provides additional event data. + + + + Gets whether property should be serialized. Provided for designer support. + + + + + + Reset property to default value. Provided for designer support. + + + + + Gets whether property should be serialized. Provided for designer support. + + + + + + Reset property to default value. Provided for designer support. + + + + + Raises the PaintLabel event. + + Provides event data. + + + + Raises the DateChanged event. + + Provides event data. + + + + Gets the DayLabel item assigned to the given date. Returns null if there is no label displayed for the date. + + Date to return label for. + DayLabel instance or null if date is not displayed on this calendar. + + + + Occurs when sub item expanded state has changed. + + Sub item affected. + + + + Gets whether Value property should be serialized by Windows Forms designer. + + true if value serialized otherwise false. + + + + Reset the MinDate property to its default value. + + + + + Gets whether Value property should be serialized by Windows Forms designer. + + true if value serialized otherwise false. + + + + Reset the MaxDate property to its default value. + + + + + Called when DayClickAutoClosePopup property has changed. + + Old property value + New property value + + + + Occurs when month displayed by the item has changed. + + + + + Occurs before the month that is displayed is changed. + + + + + Occurs when child label representing days is rendered and it allows you to override default rendering. + + + + + Occurs when mouse button is pressed over the day/week label inside of the calendar. + + + + + Occurs when mouse button is released over day/week label inside of the calendar. + + + + + Occurs when mouse enters the day/week label inside of the calendar. + + + + + Occurs when mouse leaves the day/week label inside of the calendar. + + + + + Occurs when mouse moves over the day/week label inside of the calendar. + + + + + Occurs when mouse remains still inside an day/week label of the calendar for an amount of time. + + + + + Occurs when SelectedDate property has changed. + + + + + Indicates whether calendar is used in month selection mode which shows only month and year. + + + + + Gets or sets whether Year/Century selection is enabled. + + + + + Indicates whether month selector which is displayed when month label is clicked is using abbreviated month names instead of month number. + + + + + Gets or sets the first day of week displayed on the calendar. Default value is Sunday. + + + + + Gets or sets whether trailing days outside of the current displayed month are visible on calendar. + + + + + Gets or sets whether week of year is visible. Default value is false. + + + + + Gets or sets the rule used to determine first week of the year for week of year display on calendar. Default value is first-day. + + + + + Returns the collection of sub items. + + + + + Gets or sets the size of each day item on the calendar. Default value is 24, 15. + + + + + Gets or sets the size of date navigation buttons on the calendar. Default value is 13, 18. If you increase size of the navigation + buttons change DaySize as well so everything fits. + + + + + Gets the calendar colors used by the control. + + + + + Gets or sets whether multiple days can be selected by clicking each day. Default value is false. + + + + + Gets or sets whether selection of dates using mouse is enabled. Default value is true. + + + + + Gets or sets the calendar selected date. + + + + + Gets or sets whether weekend days can be selected. Default value is true. + + + + + Gets or sets a value indicating whether the item is expanded or not. For Popup items this would indicate whether the item is popped up or not. + + + + + Gets or sets default text alignment for the DayLabel items representing calendar days. + + + + + Gets or sets whether control uses the two letter day names. Default value is true. + + + + + Gets or sets the array of custom names for days displayed on calendar header. The array must have exactly 7 elements representing day names from 0 to 6. + + + + + Gets or sets whether header navigation buttons for month and year are visible. Default value is true. + + + + + Specifies the navigation container background style. Navigation container displays month, year and optional buttons. Default value is an empty style which means that container does not display any background. + BeginGroup property set to true will override this style on some styles. + + + + + Gets or sets whether today marker that indicates TodayDate is visible on the calendar. Default value is true. + + + + + Gets or sets the value that is used by calendar as today's date. + + + + + Gets a value indicating whether the TodayDate property has been explicitly set. + + + + + Gets or sets the minimum date and time that can be selected in the control. + + + + + Gets or sets the maximum date and time that can be selected in the control. + + + + + Gets or sets whether clicking the day closes the parent popup if item is on popup. + + + + + Initializes a new instance of the YearSelectoControl class. + + + + + Initializes a new instance of the CenturySelectorControl class. + + + + + Initializes a new instance of the YearSelectorContainer class. + + + + + Raises SelectedYearChanged event. + + Provides event arguments. + + + + Initializes a new instance of the YearSelectorContainer class. + + + + + Raises SelectedYearChanged event. + + Provides event arguments. + + + + Initializes a new instance of the CenturySelectorControl class. + + + + + Initializes a new instance of the YearSelectorContainer class. + + + + + Raises SelectedYearChanged event. + + Provides event arguments. + + + + Defines the MonthCalendar and SingleMonthCalendar colors for customization. + + + + + Resets property to its default value. Provided for Windows Forms designer support. + + + + + Resets property to its default value. Provided for Windows Forms designer support. + + + + + Resets property to its default value. Provided for Windows Forms designer support. + + + + + Resets property to its default value. Provided for Windows Forms designer support. + + + + Gets whether property should be serialized. Provided for WinForms designer support. + + + Resets property to its default value. Provided for WinForms designer support. + + + + Resets property to its default value. Provided for Windows Forms designer support. + + + + + Resets property to its default value. Provided for Windows Forms designer support. + + + + + Resets property to its default value. Provided for Windows Forms designer support. + + + + + Resets property to its default value. Provided for Windows Forms designer support. + + + + + Gets the appearance settings for the todays date. + + + + + Gets the appearance settings for selected days. + + + + + Gets the appearance settings for the trailing days on calendar. + + + + + Gets or sets the appearance settings for the labels that show week of year number. + + + + + Gets or sets the days divider line color. + + + + + Gets the appearance settings for the numeric day of month label. + + + + + Gets the appearance settings for the weekend days on calendar (Saturday and Sunday). + + + + + Gets the appearance settings for the trailing weekend days on calendar (Saturday and Sunday). + + + + + Gets the appearance settings for the labels that display day name in calendar header. + + + + + Gets or sets the marker settings for days specified by MonthCalendarItem.MonthlyMarkedDates property. + + + + + Gets or sets the marker settings for days specified by MonthCalendarItem.AnnuallyMarkedDates property. + + + + + Gets or sets the marker settings for days specified by MonthCalendarItem.MarkedDates property. + + + + + Gets or sets the marker settings for days specified by MonthCalendarItem.WeeklyMarkedDays property. + + + + + Gets the minimum date value of the DateTimePicker control. + + + + + Specifies the maximum date value of the DateTimePicker control. This field is read-only. + + + + + Raises the ValueChanged event. + + + + + Occurs when Value or IsEmpty property has changed. + + + + + Gets or sets the date time. + + + + + Gets or sets the values of the nested DateTimeGroup items. + + + + + Gets or sets the minimum value represented by the group. + + + + + Gets or sets maximum value represented by the group. + + + + + Gets or sets whether input values are set to defaults while user is entering data. Default value is true. + + + + + Defines the date-time selector visibility for DateTimeInput control popup. + + + + + Depending on DateTimeInput.Format property setting either date or time selector is used. + + + + + Only date selector is visible. + + + + + Only time selector is visible on popup. + + + + + Both date and time selectors are visible. + + + + + Gets or sets the amount of padding added to text. + + + + + Gets or sets the text displayed by the label. + + + + + Defines an interface for the DateTime Part interaction. + + + + + Reverts to the last input value control held. + + + + + Gets or sets the date/time part value. + + + + + Gets or sets the minimum value for the date/time part entry. + + + + + Gets or sets the maximum value for the date/time part entry. + + + + + Gets the date time part control represents. + + + + + Gets or sets whether input part is empty. + + + + + Gets or sets the day in numeric format to display. Allowed values are from -1 to 6. -1 represents an empty state. + 0 represents Sunday and 6 Represents Saturday. + + + + + Gets or sets the array of custom names for days. The array must have exactly 7 elements representing day names from 0 to 6. + + + + + Gets or sets whether abbreviated day names are used for display instead of full day names. Default value is false. + + + + + Represents a label for the NumericHourInput control that shows whether time is AM or PM. + + + + + Gets or sets custom AM text used. + + + + + Gets or sets custom PM text used. + + + + + Gets or sets whether abbreviated month names are used for display instead of full month names. Default value is false. + + + + + Occurs when Value property has changed. + + + + + Gets or sets whether mouse wheel increases or decreases the input value when used. + + + + + Gets or sets whether control allows empty input state i.e. does not have an number entered. Default value is true. When control is empty + IsEmpty property returns true and control does not display number. Set to false to always force control to have number displayed. + + + + + Gets or sets the value to increment or decrement the value of the control when the up or down buttons are clicked. + + + + + Gets or sets the Numeric String Format that is used to format the numeric value entered for display purpose. + + + + + Initializes a new instance of the NumericDayInput class. + + + + + Initializes a new instance of the NumericDayOfYearInput class. + + + + + Initializes a new instance of the NumericHourInput class. + + + + + Initializes a new instance of the NumericMinuteInput class. + + + + + Initializes a new instance of the NumericMonthInput class. + + + + + Initializes a new instance of the NumericSecondInput class. + + + + + Initializes a new instance of the NumericYearInput class. + + + + + Gets or sets the year display format. Default value is four digit format. + + + + + Defines data for the ParseValue event that allows you to provide custom parsing for values set to ValueObject property. + + + + + Get the value that was set to the ValueObject property and which should be converted to ParsedValue DateTime. + + + + + Gets or sets whether you have provided ParsedValue. + + + + + Initializes a new instance of the ParseDateTimeValueEventArgs class. + + Indicates the value object. + + + + /// + Gets or sets the parsed value from ValueObject property. + + + + + + Defines delegate for ParseDateTimeValue event. + + + + + + + Initializes a new instance of the DayLabel class. + + + + + Raises the PaintLabel event. + + Provides event data. + + + + Returns copy of the item. + + + + + Copies the DayLabel specific properties to new instance of the item. + + New ButtonItem instance. + + + + Occurs when the mouse pointer enters the item. This is used by internal implementation only. + + + + + Occurs when the mouse pointer leaves the item. This is used by internal implementation only. + + + + + Occurs when the mouse pointer is over the item and a mouse button is pressed. This is used by internal implementation only. + + + + + Occurs when the mouse pointer is over the item and a mouse button is released. This is used by internal implementation only. + + + + Gets whether property should be serialized. Provided for WinForms designer support. + + + Resets property to its default value. Provided for WinForms designer support. + + + + Occurs when label is rendered and it allows you to override default rendering. + + + + + Gets or sets the date represented by this label. DateTime.MinValue indicates that label is either used as textual day representation + or the week number as specified by the IsWeekOfYear property. + + + + + Gets or sets whether this label is used as the label that displays the day name. + + + + + Gets or sets whether this label is used as the week of year label. + + + + + Gets whether the label for date represents the trailing date, i.e. date that is from next or previous month for the month displayed. + + + + + Gets or sets whether mouse is over the item. + + + + + Gets or sets whether left-mouse button is pressed over the item. + + + + + Specifies the item background style. Default value is an empty style which means that container does not display any background. + BeginGroup property set to true will override this style on some styles. + + + + + Gets or sets whether label appears as selected. + + + + + Gets or sets whether label provides visual indicator when mouse is over the label or pressed while over the label. Default value is true. + + + + + Gets or sets whether label is selectable. IsSelected property returns whether label is selected. Default value is true. + + + + + Gets or sets the label text color. Default value is an empty color. + + + + + Gets or sets whether text is drawn using Bold font. Default value is false. + + + + + Gets or sets the text alignment. + + + + + Gets or sets the image alignment. + + + + + Gets or sets the image displayed on the label. + + + + + Gets or sets whether flat Office 2007 style is used to render the item. Default value is false. + + + + + Gets or sets whether date represented by label is marked as todays date. + + + + + Gets or sets whether popup is displayed when mouse is pressed anywhere over the item. Default value is false which indicates + that popup is displayed only if image assigned to the item and mouse is pressed over image. + + + + + Indicates the alignment of the DayLabel part like text or image. + + + + + Provides data for DayLabel painting events. + + + + + Gets the graphics canvas for rendering. + + + + + Gets or sets which parts of the item will be drawn by the system. You can set this to None to completely disable system rendering. + + + + + Initializes a new instance of the DayPaintEventArgs class. + + Reference to Graphics canvas. + Reference to item being rendered. + + + + Renders the background of the item. + + + + + Renders the item text. + + + + + Renders the item text. + + + + + Renders the item text. + + + + + Renders the item text. + + + + + Renders the item text. + + + + + Renders items image. + + + + + Renders items image. + + + + + Defines delegate for DayLabel painting events. + + Source of the event. + Provides event data. + + + + Specifies the parts of DayLabel control. Members of this enum are intended to be used as flags (combined). + + + + + Specifies no part. + + + + + Specifies the label background. + + + + + Specifies the label text. + + + + + Specifies the label image. + + + + + Specifies all parts. + + + + + Indicates the hour format. + + + + + Indicates Ante Meridiem period, before the middle day. + + + + + Indicates Post Meridiem after the middle day". + + + + + Identifies the date time part. + + + + + Specifies the input fields alignment inside of the control. + + + + + Specifies the text alignment. + + + + + Specifies the format of the date time picker. + + + + + Indicates that custom format specified by CustomFormat property is used. + + + + + The DateTimePicker control displays the date/time value in the long date format set by the user's operating system. + + + + + The DateTimePicker control displays the date/time value in the short date format set by the user's operating system. + + + + + The DateTimePicker control displays the date/time value in the time format set by the user's operating system. + + + + + The DateTimePicker control displays the date/time value in the short time format set by the user's operating system. + + + + + Specifies the display format of the year in input control. + + + + + Specifies the visual item alignment inside the parent group. + + + + + Specifies the vertical alignment. + + + + + Describes the system button item type. System buttons are buttons created internally by controls. + + + + + Specifies the auto-change item when VisualUpDownButton control is clicked. + + + + + No item is automatically changed. + + + + + Auto-change focused item in parent group + + + + + Auto change first input item before the Up/Down button in parent group. + + + + + Specifies the keys used for navigation between input fields. + + + + + No key is used for the navigation. + + + + + Tab key is used to advance to the next input field. + + + + + Arrow keys are used to advance to the next input field. + + + + + Enter key is used to advance to the next input field. + + + + + Tab, Arrows and Enter keys are used to advance to the next input field. + + + + + Describes input button settings. + + + + + Initializes a new instance of the InputButtonSettings class. + + + + + Initializes a new instance of the InputButtonSettings class. + + + + + + Called when Symbol property has changed. + + Old property value + New property value + + + + Called when SymbolSet property value changes. + + Indciates old value + Indicates new value + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Copies properties to new instance of the item. + + New InputButtonSettings instance + + + + Gets or sets whether button is visible. + + + + + Gets or sets whether button is enabled. + + + + + Gets or sets the display position index of the button. Buttons are ordered from left to right with button with lowest index appearing as left-most button. + + + + + Gets or sets the image displayed on the face of the button. + + + + + Gets or sets the text displayed on the input button face. + + + + + Gets or sets the visual item button references for its action. + + + + + Gets or sets the shortcut key which when pressed triggers button click event or its default function. + + + + + Gets or sets tooltip displayed for the button when mouse hovers over it. + + + + + Indicates the symbol displayed on face of the button instead of the image. Setting the symbol overrides the image setting. + + + + + Gets or sets the symbol set used to represent the Symbol. + + + + + Gets or sets the color of the Symbol. + + + + + Defines the system colors used by the input controls. + + + + + Resets property to its default value. Provided for design-time support. + + + + + Returns whether property should be serialized. Provided for design-time support. + + + + + Resets property to its default value. Provided for design-time support. + + + + + Returns whether property should be serialized. Provided for design-time support. + + + + + Occurs when color has changed. + + + + + Gets or sets the background color of input item part when part has input focus. Default value is Color.Empty which indicates that system Highlight color is used. + + + + + Gets or sets the text color of input item part when part has input focus. Default value is Color.Empty which indicates that system HighlightText color is used. + + + + + Initializes a new instance of the InputValidationEventArgs class. + + Indicates current input. + + + + Defines delegate for input validation event. + + + + + + + Initializes a new instance of the VisualToggleButton class. + + + + + Raises the CheckedChanged event. + + + + + Occurs when Checked property has changed. + + + + + Gets or sets whether item is checked. + + + + + Gets whether left mouse button is pressed over the item. + + + + + Gets whether mouse is over the item. + + + + + Initializes a new instance of the LockUpdateCheckBox class. + + + + + Initializes a new instance of the MonthCalendarItem class. + + + + + Returns copy of the item. + + + + + Copies the CalendarMonth specific properties to new instance of the item. + + New ButtonItem instance. + + + + Copies the CalendarMonth specific properties to new instance of the item. + + New ButtonItem instance. + + + + Returns whether property should be serialized by Windows Forms desginer. + + + + + Sets the selected dates in a month calendar control to the specified date range. + + The beginning date of the selection range. + The end date of the selection range. + startDate is less than the minimum date allowable for a month calendar control.
+ -or-
+ startDate is greater than the maximum allowable date for a month calendar control.
+ -or-
+ endDate is less than the minimum date allowable for a month calendar control.
+ -or- endDate is greater than the maximum allowable date for a month calendar control.
+ + + If the startDate value is greater than endDate property value, the dates are swapped; the endDate value becomes the starting date, and startDate value becomes the end date. + + + + + Applies current date selection to the control. You are usually not required to make calls to this method directly since it is automatically + done by the control when selection changes. This method returns immediately if MultiSelect + property is set to false or SelectionStart or SelectionEnd properties have DateTime.MinValue. + + + + + Returns the DayLabel at given client coordinates or null/nothing if there is no label at give location. + + X - position in client coordinates. + Y - position in client coordinates. + DayLabel at given coordinates or null/nothing. + + + + Returns the DayLabel that represents the date. + + Date to find label for. + DayLabel object or nothing if date cannot be founds. + + + + Returns whether property should be serialized. Provided for Windows Forms designer support. + + + + + Resets property to its default value. Provided for Windows Forms designer support. + + + + + Removes all monthly marked dates. Note that you must call UpdateMarkedDates method to reflect these changes on calendar. + + + + + Removes the date from the MonthlyMarkedDates. Note that you must call UpdateMarkedDates method to reflect these changes on calendar. + + + + + + Returns whether property should be serialized. Provided for Windows Forms designer support. + + + + + Resets property to its default value. Provided for Windows Forms designer support. + + + + + Removes all weekly marked days. Note that you must call UpdateMarkedDates method to reflect these changes on calendar. + + + + + Removes the date from the MonthlyMarkedDates. Note that you must call UpdateMarkedDates method to reflect these changes on calendar. + + + + + + Returns whether property should be serialized. Provided for Windows Forms designer support. + + + + + Resets property to its default value. Provided for Windows Forms designer support. + + + + + Removes all annually marked dates. Note that you must call UpdateMarkedDates method to reflect these changes on calendar. + + + + + Removes the date from the AnnuallyMarkedDates. Note that you must call UpdateMarkedDates method to reflect these changes on calendar. + + + + + + Returns whether property should be serialized. Provided for Windows Forms designer support. + + + + + Resets property to its default value. Provided for Windows Forms designer support. + + + + + Removes all marked dates set through MarkedDates property. Note that you must call UpdateMarkedDates method to reflect these changes on calendar. + + + + + Removes the date from the MarkedDates collection. Note that you must call UpdateMarkedDates method to reflect these changes on calendar. + + + + + + Repaints the marked dates to reflect the dates set in the lists of marked dates. + Use this method to reflect the changes made to the AnnuallyMarkedDates, MonthlyMarkedDates or MarkedDates properties as well + as change to the marked Colors properties. + + + + + Raises the MonthChanged event. + + Provides additional event data. + + + + Raises the MonthChanging event. + + Provides additional event data. + + + + Raises the PaintLabel event. + + Provides event data. + + + + Raises the LabelMouseDown event. + + Provides event data. + + + + Raises the LabelMouseUp event. + + Provides event data. + + + + Raises the LabelMouseEnter event. + + Provides event data. + + + + Raises the LabelMouseLeave event. + + Provides event data. + + + + Raises the LabelMouseMove event. + + Provides event data. + + + + Raises the LabelMouseHover event. + + Provides event data. + + + + Gets whether property should be serialized. Provided for designer support. + + + + + + Reset property to default value. Provided for designer support. + + + + + Gets whether property should be serialized. Provided for designer support. + + + + + + Reset property to default value. Provided for designer support. + + + + + Gets whether Value property should be serialized by Windows Forms designer. + + true if value serialized otherwise false. + + + + Reset the MinDate property to its default value. + + + + + Gets whether Value property should be serialized by Windows Forms designer. + + true if value serialized otherwise false. + + + + Reset the MaxDate property to its default value. + + + + + Resets property to its default value. Provided for design-time support. + + + + + Gets whether property should be serialized. Provided for design-time support. + + + + + Sets the number of columns and rows of months to display. + + The number of columns. + The number of rows. + ArgumentOutOfRangeException will be raised if any value is less than zero or one value is grater than zero and other is zero. + + + + Raises the DateChanged event. + + Provides event data. + + + + Raises the DateSelected event. + + Provides event data. + + + + Reloads the localized strings for Today and Clear buttons. + + + + + Called when DayClickAutoClosePopup property has changed. + + Old property value + New property value + + + + Occurs when month displayed by the item has changed. + + + + + Occurs before the month that is displayed is changed. + + + + + Occurs when child label representing days is rendered and it allows you to override default rendering. + + + + + Occurs when mouse button is pressed over the day/week label inside of the calendar. + + + + + Occurs when mouse button is released over day/week label inside of the calendar. + + + + + Occurs when mouse enters the day/week label inside of the calendar. + + + + + Occurs when mouse leaves the day/week label inside of the calendar. + + + + + Occurs when mouse moves over the day/week label inside of the calendar. + + + + + Occurs when mouse remains still inside an day/week label of the calendar for an amount of time. + + + + + Occurs when SelectedDate property has changed. + + + + + Occurs when the user makes an explicit date selection using the mouse. + + + This event is similar to the DateChanged event, but it occurs at the end of a date selection made using the mouse. + The DateChanged event occurs during any date selection, whether by mouse, keyboard, or code. You should handle this event + when you enable multiple date selection through MultiSelect property and want to be notified after the date selection has been + made. DateChanged event would fire each time selection changes during the selection of multiple dates. + + + + + Gets or sets the maximum number of days that can be selected in a month calendar control. + + + + + Gets or sets the start date of the selected range of dates. + + + + + Gets or sets the end date of the selected range of dates. + + + + + Gets or sets the selected range of dates for a month calendar control. + + Setting this property is functionally equivalent to using the SetSelectionRange method. You can set the start and end dates separately by setting either the SelectionStart or SelectionEnd properties. You cannot change the start and end dates by setting the SelectionRange.Start or SelectionRange.End property values of the SelectionRange property. You should use SelectionStart, SelectionEnd, or SetSelectionRange. + If the Start property value of the SelectionRange is greater than its End property value, the dates are swapped; the End property value becomes the starting date, and Start property value becomes the end date. + + + + + Gets or sets whether selection of multiple dates up to the MaxSelectionCount is enabled. Default value is false which indicates that only + single day can be selected. + + + + + Gets or sets the array of DateTime objects that determine which monthly days to mark using Colors.MonthlyMarker settings. + + + + + Gets or sets the array of DayOfWeek members that determine which days of week to mark using Colors.WeeklyMarker settings. + + + + + Gets or sets the array of DateTime objects that determines which annual days are marked using Colors.AnnualMarker settings. + + + + + Gets or sets the array of DateTime objects that determines which nonrecurring dates are marked using Colors.DayMarker settings. + + + + + Gets or sets the first month displayed by the control. + + + + + Gets number of months displayed on the control. + + + + + Gets the calendar colors used by the control. + + + + + Gets or sets the size of each day item on the calendar. Default value is 24, 15. + + + + + Gets or sets the size of date navigation buttons on the calendar. Default value is 13, 18. If you increase size of the navigation + buttons change DaySize as well so everything fits. + + + + + Gets or sets the minimum date and time that can be selected in the control. + + + + + Gets or sets the maximum date and time that can be selected in the control. + + + + + Specifies the commands container background style. Commands container displays Today and Clear buttons if they are visible. + + + + + Specifies the navigation container background style. Navigation container displays month, year and optional buttons. Default value is an empty style which means that container does not display any background. + BeginGroup property set to true will override this style on some styles. + + + + + Gets or sets the number of columns and rows of months displayed on control. Default value is 0,0 which indicates that + calendar will display as many columns and rows as it is possible to fit into container space available. + + + + + Gets or sets whether weekend days can be selected. Default value is true. + + + + + Gets or sets the rule used to determine first week of the year for week of year display on calendar. Default value is first-day. + + + + + Gets or sets the value that is used by calendar as today's date. + + + + + Gets a value indicating whether the TodayDate property has been explicitly set. + + + + + Gets or sets whether today marker that indicates TodayDate is visible on the calendar. Default value is true. + + + + + Gets or sets whether week of year is visible. Default value is false. + + + + + Gets or sets whether control uses the two letter day names. Default value is true. + + + + + Gets or sets the array of custom names for days displayed on calendar header. The array must have exactly 7 elements representing day names from 0 to 6. + + + + + Gets or sets the first day of week displayed on the calendar. Default value is Sunday. + + + + + Gets or sets the calendar selected date. Note that SelectedDate property should be used only when MultiSelect property is set to false. + When multiple dates can be selected use range selection properties: SelectionStart, SelectionEnd and SelectionRange. + + + + + Gets the reference to the bottom container that parents the Today, and Clear system buttons. + + + + + Gets reference to internal Today button on calendar. + + + + + Gets or sets whether Today button displayed at the bottom of the calendar is visible. Default value is false. + + + + + Gets or sets whether Clear button displayed at the bottom of the calendar is visible. Clear button clears the currently selected date. Default value is false. + + + + + Gets or sets a value indicating whether the item is expanded or not. For Popup items this would indicate whether the item is popped up or not. + + + + + Gets or sets whether clicking the day closes the parent popup if item is on popup. + + + + + Gets or sets whether Year/Century selection is enabled when calendar is displaying single month. + + + + + Indicates whether month selector which is displayed when month label is clicked is using abbreviated month names instead of month number. + + + + + Indicates whether calendar is used in month selection mode which shows only month and year. + + + + + Gets or sets the size available for the item currently being arranged. + + + + + Gets or sets whether mouse is over the host control. + + + + + Gets or sets system colors used by the control. + + + + + Defines data for the ParseValue event that allows you to provide custom parsing for values set to ValueObject property. + + + + + Get the value that was set to the ValueObject property and which should be converted to ParsedValue DateTime. + + + + + Gets or sets whether you have provided ParsedValue. + + + + + Initializes a new instance of the ParseDateTimeValueEventArgs class. + + Indicates the value object. + + + + /// + Gets or sets the parsed value from ValueObject property. + + + + + + Defines delegate for ParseValue event. + + + + + + + Defines data for the ParseValue event that allows you to provide custom parsing for values set to ValueObject property. + + + + + Get the value that was set to the ValueObject property and which should be converted to ParsedValue DateTime. + + + + + Gets or sets whether you have provided ParsedValue. + + + + + Initializes a new instance of the ParseDateTimeValueEventArgs class. + + Indicates the value object. + + + + /// + Gets or sets the parsed value from ValueObject property. + + + + + + Defines delegate for ParseValue event. + + + + + + + Gets or sets whether button automatically gets Click events repeated when mouse is kept pressed on the button. Default value is false. + + + + + Gets or sets the auto-repeat interval for the click event when mouse button is kept pressed over the item. + + + + + Gets or sets whether default button background is rendered when mouse is not over the host control. Default value is true. + + + + + Gets or sets the shortcut key which when pressed triggers button click event or its default function. + + + + + Gets or sets the button tooltip. + + + + + Called when Symbol property has changed. + + Old property value + New property value + + + + Called when SymbolSet property value changes. + + Indciates old value + Indicates new value + + + + Gets or sets the fixed button height. + + + + + Gets whether mouse is over the control. + + + + + Gets whether mouse is pressed on the control. + + + + + Gets or sets the text displayed on the face of the button. + + + + + Gets or sets the image displayed on the face of the button. + + + + + Gets the realized symbol string. + + + + + Indicates the symbol displayed on face of the button instead of the image. Setting the symbol overrides the image setting. + + + + + Gets or sets the symbol set used to represent the Symbol. + + + + + Gets or sets the color of the Symbol. + + + + + Raises DecreaseValue event. + + Provides event arguments. + + + + Raises IncreaseValue event. + + Provides event arguments. + + + + Defines data for ConvertFreeTextEntry event. + + + + + Gets the string value that was entered by the user. + + + + + Gets or sets the converted ValueEntered into the control's value type. For example for IpAddressInput the value set here + must be of string type and in IP address format. For IntegerInput control the value set here must be an int type. For DateTimeInput + control value set here must be DateTime type. + If you provide ControlValue set ValueConverted=true to indicate so. + + + + + Gets or sets whether ValueEntered has been converted to ControlValue. Set to true to indicate that you have performed conversion. + + + + + Defines delegate for ConvertFreeTextEntry event. + + Source of event. + Provides event data. + + + + Gets or sets the value to increment or decrement the value of the control when the up or down buttons are clicked. + + + + + Gets or sets the Numeric String Format that is used to format the numeric value entered for display purpose. + + + + + Specifies trigger types for the value changed events on editor controls. + + + + + ValueChanged event is fired as soon as user types in the value. + + + + + ValueChanged event is fired after control loses input focus. + + + + + ValueChanged event is fired after control loses input focus or user presses the Enter key. + + + + Creates new instance of the class. + + + Creates new instance of the class. + + + + Adds new object to the collection. + + Object to add. + Index of newly added object. + + + + Adds array of new objects to the collection. + + Array of object to add. + + + + Adds array of new objects to the collection. + + Array of object to add. + + + + Inserts new object into the collection. + + Position of the object. + Object to insert. + + + + Returns index of the object inside of the collection. + + Reference to the object. + Index of the object. + + + + Returns whether collection contains specified object. + + Object to look for. + true if object is part of the collection, otherwise false. + + + + Removes specified object from the collection. + + + + + + Copies collection into the specified array. + + Array to copy collection to. + Starting index. + + + + Copies contained items to the VisualItem array. + + Array to copy to. + + + + Returns reference to the object in collection based on it's index. + + + + + Represents the up down button which allows change of the value in currently focused input control. + + + + + Initializes a new instance of the VisualUpDownButton class. + + + + + Raises the UpClick event. + + Provides event data. + + + + Raises the DownClick event. + + Provides event data. + + + + Occurs when Up part of the button has been clicked. + + + + + Occurs when Down part of the button has been clicked. + + + + + Gets or sets the image displayed on the face of the button. + + + + + Gets or sets the image displayed on the face of the button. + + + + + Gets or sets the default width of the buttons. + + + + + Gets or sets whether control automatically tries to increase/decrease the value of the item that has input focus in the same + parent group as the button. Default value is false. + + + + + Gets or sets the item that is automatically changed when buttons are pressed. + + + + + Statis functions for design-time support. + + + + + Summary description for DesignTimeDte. + + + + + Summary description for Display. + + + + + System item that displays the items that could not fit inside the container on popup menu or toolbar. + + + + + Create new instance of DisplayMoreItem object. + + + + + Returns copy of DisplayMoreItem item + + + + + Called when item container has changed. If you override this method you must call the base implementation to allow default processing to occur. + + Previous container of the item. + + + + Overridden. Draws the item. + + Target Graphics object. + + + + Overriden. Recalculates the size of the item. + + + + + Overridden. Displays the sub-items on popup. + + Popup location. + + + + Overridden. Displays the sub-items on popup. + + Horizontal coordinate in pixels of the upper left corner of a popup. + Vertical coordinate in pixels of the upper left corner of a popup. + + + + Overridden. Displays the sub-items on popup toolbar. + + Horizontal coordinate in pixels of the upper left corner of a popup. + Vertical coordinate in pixels of the upper left corner of a popup. + + + + Overridden. Displays the sub-items on popup menu. + + Horizontal coordinate in pixels of the upper left corner of a popup. + Vertical coordinate in pixels of the upper left corner of a popup. + + + + Overridden. Close the popup window if open. + + + + + Adds the items that are not visible to the overflow popup. + + + + + Returns the insertion index for the items removed from overflow popup. Assumes that right-most items are removed first by the layout manager. + + + + + + Removes the items from the overflow and adds them back to the parent item. + + + + + Forces the repaint the item. + + + + + Returns the fixed size of the item. + + + + + Get or sets whether item has been changed in a way that it needs its size recalculated. This is internal + property and it should not be used by your code. + + + + + Gets whether the mouse is over the item. + + + + + Represents panel that is hosted by DockContainerItem as docked control. + + + + + Represents graphical panel control with support for different visual styles and gradients. + + + + + Default constructor. + + + + + Called by StyleManager to notify control that style on manager has changed and that control should refresh its appearance if + its style is controlled by StyleManager. + + New active style. + + + + Applies color scheme colors to the style objects. + + + + + Sets the internal mouse down flag which controls appearance of the control. You can use this method to simulate the pressed state for the panel with appropriate StyleMouseDown assigned. + + New value for the mouse down flag. + + + + Sets the mouse over internal flag that tracks whether the mouse is over the control. You can use this method to simulate the mouse over appearance when appropriate StyleMouseOver style is set. + + New value for the mouse over flag. + + + + Indicates whether CanvasColor should be serialized. Used by windows forms designer design-time support. + + + + + Resets CanvasColor to it's default value. Used by windows forms designer design-time support. + + + + + Resets the style to it's default value. + + + + + Resets the internal mouse tracking properties that track whether mouse is over the panel and whether is mouse pressed while over the panel. + + + + + Resets the style to it's default value. + + + + + Resets the style to it's default value. + + + + + Called when AntiAlias property has changed. + + + + + Called after either ColorScheme or ColorSchemeStyle has changed. If you override make sure that you call base implementation so default + processing can occur. + + + + + Returns the size of the panel calculated based on the text assigned. + + Calculated size of the panel or Size.Empty if panel size cannot be calculated. + + + + Returns the size of the panel calculated based on the text assigned. + + Calculated size of the panel or Size.Empty if panel size cannot be calculated. + + + + Updates the markup size to reflect current position of the scrollbars. You must call this method if you are scrolling control with markup using the AutoScrollPosition property. + + + + + Applies predefined Panel color scheme to the control. + + + + + Applies predefined Button color scheme to the control. + + + + + Applies predefined Label color scheme to the control. + + + + + Notifies a control that it is the default button so that its appearance and behavior is adjusted accordingly. + + true if the control should behave as a default button; otherwise false. + + + + Generates a Click event for the control. + + + + + Returns the renderer control will be rendered with. + + The current renderer. + + + + Raises NonClientSizeChanged event. + + Provides event arguments. + + + + Raises ScrollBarValueChanged event. + + Provides event arguments. + + + + Raises NonClientSizeChanged event. + + Provides event arguments. + + + + Occurs when text markup link is clicked. Markup links can be created using "a" tag, for example: + Markup link + + + + + Gets or sets a value indicating whether right-to-left mirror placement is turned on. Default value is false. + + + + + Gets or sets Bar Color Scheme. Note that when ColorSchemeStyle property is set to Office 2007 style the color scheme is always retrived from the GlobalManager.Renderer and any\ + changes made on this property will not have any effect. + + + + + Gets or sets whether paint operations for the control are suspended. + + + + + Gets or sets whether Text supports and renders text markup. Default value is true. + + + + + Gets or sets the text displayed on panel. + + + + + Gets or sets whether focus rectangle is displayed when control has focus. + + + + + Gets or sets the canvas color for the panel. Canvas color will be visible on areas of the control that do not get covered + by the style and it will also be used as a base color for style to be painted on. + + + + + Gets or sets the panel style. + + + + + Gets or sets the panel style when mouse hovers over the panel. + + + + + Gets or sets the panel style when mouse button is pressed on the panel. + + + + + Gets or sets whether anti-alias smoothing is used while painting. + + + + + Gets or sets color scheme style. + + + + + Gets or sets a value indicating whether the container will allow the user to scroll to any controls placed outside of its visible boundaries. + + + + + Gets or sets whether text rectangle painted on panel is considering docked controls inside the panel. + + + + + Gets or sets the text rectangle. This property is set by internal implementation and it should not be set by outside code. + + + + + Gets or sets whether text markup if it occupies less space than control provides uses the Style Alignment and LineAlignment properties to align the markup inside of the control. Default value is false. + + + + + Returns reference to internal vertical scroll-bar control. + + + + + Returns reference to internal horizontal scroll-bar control. + + + + + Indicates whether panel uses themed DotNetBar scrollbars. Default value is true. + + + + + Gets or sets the scroll-bar visual style. + + + + + Gets or sets the value returned to the parent form when the button is clicked. + + + + + Specifies whether item is drawn using Themes when running on OS that supports themes like Windows XP. + + + + + Specifies back color when Enabled=false + + + + + Creates new instance of the panel. + + + + + Called after either ColorScheme or ColorSchemeStyle has changed. If you override make sure that you call base implementation so default + processing can occur. + + + + + Indicates whether style of the panel is managed by tab control automatically. + Set this to true if you would like to control style of the panel. + + + + + Gets or sets TabItem that this panel is attached to. + + + + + Gets or sets which edge of the parent container a control is docked to. + + + + + Gets or sets the size of the control. + + + + + Gets or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container. + + + + + Gets or sets a value indicating whether the control is displayed. + + + + + Gets or sets which edges of the control are anchored to the edges of its container. + + + + + Defines single color blend point for the multicolor gradient fills. + + + + + Creates new instance of the class. When defining multicolor gradinet blends and using the percentage positions the positions created + must start with 0f and end with 1f. + + + + + Creates new instance of the class and initialize it with default values. + + + + + Creates new instance of the class and initialize it with default values. + + + + + Gets or sets Color to use in multicolor gradient blend at specified position. + + + + + Gets or sets the color position in multicolor gradient blend. Values less or equal to 1 are used as percentage specifing percentages of distance along the gradient line. + Values greater than 1 are used as absolute pixel values of distance along the gradient line. + + + + + Represents Collection for the BackgroundColorBlend objects. + + + + Creates new instance of the class. + + + + Adds new object to the collection. + + Object to add. + Index of newly added object. + + + + Adds array of new objects to the collection. + + Array of object to add. + + + + Inserts new object into the collection. + + Position of the object. + Object to insert. + + + + Returns index of the object inside of the collection. + + Reference to the object. + Index of the object. + + + + Returns whether collection contains specified object. + + Object to look for. + true if object is part of the collection, otherwise false. + + + + Removes specified object from the collection. + + + + + + Copies collection into the specified array. + + Array to copy collection to. + Starting index. + + + + Copies contained items to the BackgroundColorBlend array. + + Array to copy to. + + + + Creates ColorBlend object based on the members of the collection. ColorBlend object will be valid only if all members of the collection + represents relative/percentage based color blends. + + + + + + Adds the BackgroundColorBlend objects from the collection. + + Collection to copy objects from + + + + Initializes the collection with the two color blend. + + Collection to initialize. + Start color. + End color. + + + + Initializes the collection with the two color blend. + + Collection to initialize. + Start color. + End color. + + + + Initializes the collection with the two color blend. + + Collection to initialize. + Solid Color + + + + Returns reference to the object in collection based on it's index. + + + + + Represents BackgroundColorBlend object converter. + + + + + Represents the cancelable event arguments with integer value. + + + + + Gets or sets the new value that will be used if event is not canceled. + + + + + Indicates the source of the event. + + + + + Defines delegate for cancelable events. + + + + + Represents the cancelable event arguments with object value. + + + + + Initializes a new instance of the CancelObjectValueEventArgs class. + + + + + + Gets or sets the data connected to this event. + + + + + Defines delegate for cancelable events. + + + + + Provides data for CheckBoxItem rendering events. + + + + + Gets or sets Graphics object group is rendered on. + + + + + Gets or sets the reference to CheckBoxItem being rendered. + + + + + ColorScheme object that is used to provide colors for rendering check box item in legacy styles like Office 2003. Office 2007 style + uses color tables provided by renderers. + + + + + Indicates whether item is in Right-To-Left environment. + + + + + Gets or sets the text font. + + + + + Gets or sets the ItemPaintArgs reference. + + + + + Creates new instance of the object and provides default values. + + Reference to Graphics object + Reference to CheckBoxItem + Reference to legacy ColorScheme + Indicates the font for the text. + Indicates whether item is in Right-To-Left environment. + + + + Defines the event arguments class for ColorPickerDropDown ColorPreview event. + + + + + Gets the color that is being previewed. + + + + + Gets the ColorItem if available for the color being previewed. This property can be null if there is no ColorItem connected with the color. + + + + + Creates new instance of the object. + + Color being previewed. + ColorItem connected with the color. + + + + Defines delegate for ColorPreview event. + + + + + Delegate for the CancelableEventSource event. + + + + + Represents event arguments that provide information on source of action and allow canceling of action. + + + + + Gets or sets whether event action will be canceled. + + + + + Initializes a new instance of the EventSourceArgs class. + + + + + + Initializes a new instance of the CancelableEventSourceArgs class. + + + + + + Provides data for the Navigation Pane rendering events. + + + + + Gets or sets Graphics object group is rendered on. + + + + + Gets or sets the rendering bounds. + + + + + Creates new instance of the objects and initializes it with default values. + + + + + Provides data for the ProgressBarItem rendering events. + + + + + Gets or sets Graphics object group is rendered on. + + + + + Gets or sets the reference to ProgressBarItem being rendered. + + + + + Indicates whether item is in Right-To-Left environment. + + + + + Gets or sets the text font. + + + + + Creates new instance of the object and provides default values. + + Reference to Graphics object + Reference to ProgressBarItem + Indicates the font for the text. + Indicates whether item is in Right-To-Left environment. + + + + Provides data for the Quick Access Toolbar Customize dialog events. + + + + + Gets or sets whether to cancel the current operation. When showing the dialog this allows to cancel the showing. When dialog is closed + it allows to cancel the changes made on customize dialog. + + + + + Gets or sets the reference to the form that is acting as dialog. You can set this value to your custom form to display it instead of + built-in dialog. + + + + + Creates new instance of the object and initializes it with default values. + + Reference to the dialog being used for customization. + + + + Provides data for the Quick Access Toolbar Customize Item rendering events. + + + + + Gets or sets the reference to the item being rendered. + + + + + Gets or sets the reference to graphics object. + + + + + Creates new instance of the object and initializes it with default values. + + Reference to the customize item being rendered. + Reference to the graphics object. + + + + Provides data for the Quick Access Toolbar Overflow item rendering events. + + + + + Gets or sets the reference to the item being rendered. + + + + + Gets or sets the reference to graphics object. + + + + + Creates new instance of the object and initializes it with default values. + + Reference to the overflow item being rendered. + Reference to the graphics object. + + + + Provides information for ribbon customization events. + + + + + Gets or sets whether the menu popup will be cancelled. Default value is false. + + + + + Gets or sets the reference to the object customize menu will be acting on. This could be an ButtonItem or any + BaseItem derived class as well as RibbonBar object. + + + + + Gets or sets the reference to the popup menu that will be displayed. You can change the members of SubItems collection to add/remove/change + the context menu items that will be displayed. + + + + + Creates new instance of the object and initializes it with default values. + + Reference to context object. + Reference to popup menu item if any. + + + + Provides data for the RenderMdiSystemitem event. + + + + + Gets or sets Graphics object group is rendered on. + + + + + Gets or sets the reference to MdiSystemItem being rendered. + + + + + Creates new instance of the class and initializes it with default values. + + Reference to graphics object. + Reference to MdiSystemItem being rendered. + + + + Represents events arguments for the Ribbon Control rendering events. + + + + + Gets or sets Graphics control is rendered on. + + + + + Gets the reference to RibbonControl instance being rendered. + + + + + Gets whether Windows Vista Glass is enabled. + + + + + Creates new instance and initializes it with the default values. + + Reference to Graphics object + Reference to RibbonControl + + + + Gets or sets whether the closing of the ribbon menu is canceled. + + + + + Gets or sets the source object that was cause of the menu closing. For example this could be reference to an item that was clicked. + Default value is null which indicates that there is no information about the object that caused closing available. + + + Following is the possible list of types that this property could be set to + and causes for closing: + + BaseItem - when an item is clicked the Source will be set to the instance + of the item that was clicked. + RibbonControl - when parent form RibbonControl is on loses the input + focus the Source will be set to the RibbonControl + RibbonTabItem - when tab menu is displayed and user clicks the same tab + to close the menu. The RibbonTabItem with EventSource=Code will be also set as + source when user double-clicks the tab to maximize the ribbon. + Any other type if RibbonControl.PopupRibbon method is called by your + code. + + + + + + Gets or sets the source of the event. + + + + + Creates new instance of the object. + + + + + Gets or sets the reference to graphics object. + + + + + Initializes a new instance of the SideBarPanelItemRendererEventArgs class. + + + + + + + Gets or sets the reference to graphics object. + + + + + Initializes a new instance of the SideBarRendererEventArgs class. + + + + + + + Provides data for the Slider item rendering events. + + + + + Gets or sets the reference to the item being rendered. + + + + + Gets or sets the reference to graphics object. + + + + + Creates new instance of the object and initializes it with default values. + + Reference to the Slider item being rendered. + Reference to the graphics object. + + + + Defines the abstract class for form caption painter. + + + + + Provides data for form caption rendering events. + + + + + Gets or sets the reference to graphics object. + + + + + Gets or sets the caption bounds. + + + + + Gets or sets the form caption is rendered for. + + + + + Creates new instance of the class. + + + + + Defines the Office 2007 style form caption painter. + + + + + Gets or sets color table used by renderer. + + + + + Represents an item that provides system buttons displayed on form caption. + + + + + Summary description for MDISystemItem. + + + + + Returns copy of CustomizeItem item + + + + + Returns the single button size. + + Size of the button. + + + + MDI System Item can render itself as either Simple icon with system drop down menu or set of + system buttons Minimize, Restore and Close. This item is rendered on the Bar that is designated as + Menu bar and when bar is used on MDI form and MDI Child form is maximized. + + + + + Gets the default size of the system buttons. + + + + + + Gets or sets the custom button size to use instead of system determined size. + + + + + Gets or sets whether Minimize button is visible. + + + + + Gets or sets whether Restore/Maximize button is visible. + + + + + Gets or sets whether Close button is visible. + + + + + Gets or sets whether help button is visible. + + + + + Gets or sets whether Icon is queried when item is painted. Default value is false. + + + + + Provides data for the RenderSystemCaptionItem event. + + + + + Gets or sets Graphics control is rendered on. + + + + + Gets reference to SystemCaptionItem being rendered. + + + + + Gets whether Windows Vista Glass is enabled. + + + + + Creates new instance of the class and initializes it with default values. + + Reference to Graphics object. + Reference to item being rendered. + Indicates whether Vista Glass effect is enabled. + + + + Represents the line drawn between start and end point. + + + + + Paints the shape on canvas. If overriden base implementation must be called to paint any child shapes. + + Shape paint information. + + + + Returns absolute location of the shape based on parent bounds. + + Parent absolute bounds. + Absolute location of the shape + + + + Returns absolute size of the shape based on the parent bounds. + + Absolute parent bounds. + Absolute size of the shape. + + + + Gets the absolute bounds of the shape. + + Parent bounds. + Absolute bounds of the shape. + + + + Gets the location of the shape. + + + + + Gets the size of the shape. + + + + + Gets the shape padding. Padding is the inside spacing between shape and it's child shapes. + + + + + Gets the collection of child shapes. + + + + + Gets or sets whether this shape will set the ShapePaintInfo.ChildContentClip property to the region that represents the inside content of the shape. + This is used when there is inside content of the shape which is not part of the shape itself and calling routine needs + access to the region that defines the shape inside bounds. + + + + + Gets the start point of the line. + + + + + Gets the end point of the line. + + + + + Gets the line border. + + + + + Describes the shape location. + + + + + Gets or sets the X location of the shape relative to it's parent. + + + + + Gets or sets the Y location of the shape relative to it's parent. + + + + + Gets or sets the relative X position. + + + + + Gets or sets the relative Y position. + + + + + Describes the relative location. + + + + + Describes the padding for the shape. Padding is the space inside the shape and between it's child shapes. + + + + + Creates new instance of the class. + + + + + Creates new instance of the class and initializes it with default values. + + + + + Gets or sets the left padding in pixels. + + + + + Gets or sets the right padding in pixels. + + + + + Gets or sets the top padding in pixels. + + + + + Gets or sets the bottom padding in pixels. + + + + + Gets the total horizontal padding. + + + + + Gets the total vertical padding. + + + + + Paints the border. + + + + + Paints the border. + + + + + Gets or sets the rounded corner size. + + + + + Gets the shape border. + + + + + Gets the shape fill. + + + + + Defines the shape border. + + + + + Gets or sets the border width in pixels. + + + + + Gets or sets the border color. + + + + + Gets or sets the ending gradient border color. + + + + + Gets or sets the gradient angle. Default value is 90. + + + + Creates new instance of the class. + + + + Adds new object to the collection. + + Object to add. + Index of newly added object. + + + + Inserts new object into the collection. + + Position of the object. + Object to insert. + + + + Returns index of the object inside of the collection. + + Reference to the object. + Index of the object. + + + + Returns whether collection contains specified object. + + Object to look for. + true if object is part of the collection, otherwise false. + + + + Removes specified object from the collection. + + + + + + Copies collection into the specified array. + + Array to copy collection to. + Starting index. + + + + Copies contained items to the Shape array. + + Array to copy to. + + + + Returns reference to the object in collection based on it's index. + + + + + Gets or sets the starting fill color. + + + + + Gets or sets the end fill color. + + + + + Gets or sets the gradient angle. + + + + + Gets or sets the background color collection blend. + + + + + Gets or sets the fill gradient type. + + + + + Paints the border. + + + + + Paints the border. + + + + + Gets the shape border. + + + + + Gets the shape fill. + + + + + Describes shape size. + + + + + Gets or sets the width of the shape. When RelativeWidth is specified then number specifed here is added to the actual shape width. + + + + + Gets or sets the height of the shape. When RelativeHeight is specified the number specified here is added to the actual shape height. + + + + + Gets or sets the relative shape width. + + + + + Gets or sets the relative shape height. + + + + + A strongly-typed resource class, for looking up localized strings, etc. + + + + + Returns the cached ResourceManager instance used by this class. + + + + + Overrides the current thread's CurrentUICulture property for all + resource lookups using this strongly typed resource class. + + + + + Represents the class used to create Color objects. + + + + + Creates new instance of the object. + + + + + Represents the class used to create Color objects blended based on base color. + + + + + Creates new instance of the object. + + + + + Converts integer color representation to Color type. + + Color representation as 32-bit RGB value. + Reference to Color object. + + + + Converts integer color representation to Color type. + + Color representation as 32-bit RGB value. + Reference to Color object. + + + + Converts integer color representation to Color type. + + Color value. + Reference to Color object. + + + + Converts color representation to alpha Color type. + + Color value. + Reference to Color object. + + + + Converts integer color representation to Color type. + + Color value. + Reference to Color object. + + + + Defines the names for the ElementStyle.Class style classes. + + + + + Gets the key for the GalleryContainer background style class. + + + + + Gets the key for the Ribbon File menu outer container background style class. + + + + + Gets the key for the Ribbon File menu two column container background style class. + + + + + Gets the key for the Ribbon File menu first column container background style class. + + + + + Gets the key for the Ribbon File menu second column container background style class. + + + + + Gets the key for the Ribbon File menu bottom container background style class. + + + + + Gets the key for the text box border style class. + + + + + Gets the key for the RichTextBox control border style class. + + + + + Gets the key for the ItemPanel style class. + + + + + Gets the key for the ListBoxAdv style class. + + + + + Gets the key for the date time input background style class. + + + + + Gets the style key for the Ribbon client panel. + + + + + Gets the style key for the ListView control border style. + + + + + Gets the style key for the Office2007 Status Bar alternative background. + + + + + Gets the style key for the AdvTree control border and background. + + + + + Gets the style key for the AdvTree control columns header. + + + + + Gets the style key for the AdvTree control columns header for the child nodes. + + + + + Gets the style key for the AdvTree control column. + + + + + Gets the style key for the CrumbBar background style. + + + + + Gets the key for the DataGridView border style class. + + + + + Gets the key for the DataGridViewNumeric border style class. + + + + + Gets the key for the DataGridViewDateTime border style class. + + + + + Gets the key for the DataGridViewIpAddress border style class. + + + + + Gets the key for SlidePanel slide-out button style. + + + + + Gets the key for the MetroTilePanel style class. + + + + + Gets the key for Metro tile group container title class. + + + + + Gets the style key for the MonthCalendarAdv control. + + + + + Gets the style key for the ProgressSteps control. + + + + + Gets the style key for the SideNavStrip control. + + + + + Gets the style key for the TabFormPanel control. + + + + + Represents a static class that maintains the global rendering properties for all controls when eRenderMode is set to global. + + + + + Gets or sets the global renderer used by all controls that have RenderMode set to eRenderMode.Global. + + + + + Represents complex gradient color table. + + + + + Creates new instance of the object. + + + + + Creates new instance of the object and initializes it with default values. + + Start color + End color + + + + Creates new instance of the object and initializes it with default values. + + Start color + End color + + + + Creates new instance of the object and initializes it with default values. + + Start color + End color + + + + Creates new instance of the object and initializes it with default values. + + Start color + End color + Linear gradient angle + + + + Creates new instance of the object and initializes it with default values. + + Start color + End color + Linear gradient angle + + + + Gets or sets the color collection blend that describes the gradient. + + + + + Gets or sets the gradient type. + + + + + Gets or sets the linear gradient angle. + + + + + Creates a copy of table. + + A copy. + + + + Represents the color table of linear gradient. + + + + + Creates new instance of the object. + + + + + Creates new instance of the object. + + Start color. + + + + Creates new instance of the object. + + Start color. + End color. + + + + Creates new instance of the object. + + Start color in hexadecimal representation like FFFFFF. + End color in hexadecimal representation like FFFFFF. + + + + Creates new instance of the object. + + Start color in 32-bit RGB representation. + + + + Creates new instance of the object. + + Start color in 32-bit RGB representation. + End color in 32-bit RGB representation. + + + + Creates new instance of the object. + + Start color in 32-bit RGB representation. + End color in 32-bit RGB representation. + Gradient angle. + + + + Creates new instance of the object. + + Start color. + End color. + Gradient angle. + + + + Gets or sets the start color. + + + + + Gets or sets the end color. + + + + + Gets or sets the gradient angle. Default value is 90. + + + + + Gets whether both colors assigned are empty. + + + + + Item container for dockable windows. + + + + + Creates new instance of ControlContainerItem and assigns item name. + + + + + Creates new instance of ControlContainerItem and assigns item name. + + Item name. + + + + Creates new instance of ControlContainerItem and assigns item name and item text. + + Item name. + Item text. + + + + Overriden. Returns the copy of the ControlContainerItem. + + Copy of the ControlContainerItem. + + + + Overriden. Draws the item. + + Target Graphics object. + + + + Overriden. Recalculates the size of the item. + + + + + Returns the Font object to be used for drawing the item text. + + Font object. + + + + Occurs after an item has been removed. + + Item being removed. + + + + Occurs after text has changed. + + + + + Occurs after item visual style has changed. + + + + + Occurs when container control needs to be assigned to the item. + + + + + Gets or sets the reference to the contained control. + + + + + Returns category for this item. If item cannot be customzied using the + customize dialog category is empty string. + + + + + Gets or sets whether Click event will be auto repeated when mouse button is kept pressed over the item. + + + + + Gets or sets the auto-repeat interval for the click event when mouse button is kept pressed over the item. + + + + + Gets or sets item description. This description is displayed in + Customize dialog to describe the item function in an application. + + + + + Gets or sets item alignment inside the container. + + + + + Gets or sets the collection of shortcut keys associated with the item. + + + + + Gets or sets whether item will display sub items. + + + + + Gets or sets a value indicating whether the item is visible. + + + + + Specifies the Tab image. Image specified here is used only on Tab when there are multiple dock containers on Bar. + + + + + Specifies the index of the Tab image if ImageList is used. Image specified here is used only on Tab when there are multiple dock containers on Bar. + + + + + Specifies the Button icon. Icons support multiple image sizes and alpha blending. + + + + + Gets or sets the predefined tab color. Default value is eTabItemColor.Default which means that default color is used. + + + + + Gets or sets whether tab that dock container item is on is selected. + + + + + Gets or sets the width of the item in pixels. + + + + + Gets or sets the height of the item in pixels. + + + + + Gets or sets the minimum size of the item. When used please note that layout logic for dockable windows expects that + all DockContainerItems that are in particular docking side have exact same minimum size. When setting this property it is + best to set the same value for all DockContainerItem instances you create. + + + + + Gets or sets the default floating size of the Bar that is containing this item. + + + + + Gets or sets the minimum size of the form client area that is tried to maintain when dockable window is resized. + + + + + Gets or sets whether the item expands automatically to fill out the remaining space inside the container. Applies to Items on stretchable, no-wrap Bars only. + + + + + Gets or sets whether item can be customized by end user. + + + + + Returns whether item is in design mode or not. + + + + + Gets or sets whether item is global or not. + This flag is used to propagate property changes to all items with the same name. + Setting for example Visible property on the item that has GlobalItem set to true will + set visible property to the same value on all items with the same name. + + + + + Gets or sets the close button behavior on the host Bar. Default value is eDockContainerClose.Inherit which means that Bar.CanHide will control whether DockContainerItem can be closed. + + + + + Specifies the behavior of the close button on host bar for the DockContainerItem. + + + + + Closing of the bar is inherited from the host bar. Bar.CanHide property will control close button visibility. + + + + + Closing of the DockContainerItem is allowed. + + + + + Closing of DockContainerItem is not allowed. + + + + + Summary description for DockingHint. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + + + + Update control region based on hint side + + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Represent the docking information for an control. + + + + + Control dock side. + + + + + Control dock site. + + + + + Docking offset. + + + + + Docking line. + + + + + Docked control width. + + + + + Docked control height. + + + + + Control position. + + + + + Indicates whether to use outline or not + + + + + Indicates that dock site should change it's Z-Order so it maximizes the space it consumes as related to other dock sites. + + + + + Indicates that dock site should change it's Z-Order so it reduces the amount of space it consumes as related to other dock sites. + + + + + When either FullSizeDock or PartialSizeDock is set it indicates the new dock site Z-Order index. + + + + + Returns the bar that mouse is placed over. + + + + + Returns dock side the mouse is indicating user wants to dock bar at. + + + + + Gets the last relative docked to bar. + + + + + Gets the last relative docked to document id. + + + + + Returns side of last docked-to dock site. + + + + + Dock Sites are created by DotNetBar control on each edge of the + DotNetBar container control and are used for docking purposes. + If Dock Site does not contain any controls it will be invisible. + + + + + Creates new instance of DockSite object with specified dock style. + + Specifies the position and manner in which a site is docked. + + + + Creates new instance of DockSite object. + + + + + Returns reference to the DocumentDockUIManager object used for interaction with document docking engine. + + Reference to the DocumentDockUIManager object. + + + + Saves layout for bars contained by dock site. + + Parent XmlElement. + + + + Loads layout for the bars. + + Parent XmlElement that was passed to SaveLayout method to save layout + + + + Suspends normal layout logic. + + + + + Resumes normal layout logic. + + + + + Resumes normal layout logic. Optionally forces an immediate layout of pending layout requests. + + + + + Docks the bar to the dock site. + + Bar to dock. + + + + Dockes the Bar to dock site at specified position. + + Bar to dock. + Bar insert position. + + + + Relayouts all docked controls in the site. + + + + + Returns the docking information for current position. + + Controls docking provider. + Horizontal assumed docking position. + Vertical assumed docking position. + Docking information. + + + + + Undocks the control from the site. + + Control to undock. + + + + Gets or sets whether painting is disabled on dock site while layout of bars is performed. Default value is true. + You might need to set this property to false if you are expirience vide flashing while using DirectX video animation in Bar controls that are part of the + dock site. + + + + + Specifies background image position when container is larger than image. + + + + + Specifies the transparency of background image. + + + + + Gets or sets the target gradient background color. + + + + + Gets or sets gradient fill angle. + + + + + Specifies the position and manner in which a site is docked. + + + + + Gets the reference to the DotNetBarManager that uses this dock site. + + + + + Represents class that is a bar container for document docking. + + + + + Represents Document container base class. + + + + + Creates new instance of the class. + + + + + Resizes the document within specified bounds. + + Area available for the document. + + + + Sets the display bounds. + + New display bounds. + + + + Sets layout bounds. + + New layout bounds. + + + + Resets the layout bounds for the document base container to the empty bounds. + + + + + Resets the layout bounds for the document base container to the empty bounds. + + + + + Sets the parent document. + + Parent container. + + + + Sets the width of the document. + + Width in pixels + + + + Sets the height of the document. + + Height in pixels. + + + + Occurs when width is being set on child document. + + Reference document being changed + Width in pixels + True if width was applied by parent otherwise false + + + + Occurs when height is being set on child document. + + Reference document being changed + Height in pixels + True if width was applied by parent otherwise false + + + + Updates bounds of the item in response to the scrolling of LayoutControl. + + + + + + + Gets the unique ID for the container. + + + + + Returns actual display bounds of the document. + + + + + Returns layout bounds of the document. Layout bounds are proposed bounds of the layout and might not be the same + as DisplayBounds. + + + + + Gets the parent container. + + + + + Gets whether document is visible or not. + + + + + Gets minimum size of the document. + + + + + Creates new instance of the class. + + + + + Creates new instance of the class and initializes it with the Bar object. + + Bar to contain on document. + + + + Creates new instance of the class and initializes it with the bar and propesed width and height. + + Bar to contain on document. + Proposed width of the document in pixels + Proposed height of the document in pixels + + + + Resizes document object. + + Available bounds for the document. + + + + Gets or sets the bar that is contained by this document. + + + + + Gets whether document is visible. + + + + + Gets the minimum size of the document. + + + + + Represents DocumentBarContainer converter. + + + + + Creates new instance of the class. + + + + + Checks whether conversion can be made to specified type. + + Context Information. + Destination type. + + + + + Converts object to specified type. + + Context information. + Culture information. + Object to convert. + Destination type. + Object converted to destination type. + + + + Collection of DocumentBaseContainer objects. + + + + + Adds new object to the collection. + + Object to add. + Index of newly added object. + + + + Adds new objects to the collection. + + Array of documents to add. + + + + Inserts new object into the collection. + + Position of the object. + Object to insert. + + + + Returns index of the object inside of the collection. + + Reference to the object. + Index of the object. + + + + Returns whether collection contains specified object. + + Object to look for. + true if object is part of the collection, otherwise false. + + + + Removes specified object from the collection. + + + + + + Copies collection into the specified array. + + Array to copy collection to. + Starting index. + + + + Copies contained items to the DocumentBaseContainer array. + + Array to copy to. + + + + Returns reference to the object in collection based on it's index. + + + + + Represents Dock container with either horizontal or vertical layout. + + + + + Creates new instance of the object and initializes it with specified values. + + Array of documents to host in this container. + Container orientation + + + + Creates new instance of the object. + + + + + Resizes the object inside of the given bounds. + + Available area. + + + + Occurs when width is being set on child document. + + Reference document being changed + Width in pixels + True if width was applied by parent otherwise false + + + + Occurs when height is being set on child document. + + Reference document being changed + Height in pixels + True if width was applied by parent otherwise false + + + + Returns the DocumentBarContainer object for a given bar. + + Bar to search for. + Reference to container or null if bar could not be found + + + + Gets whether document is visible or not. + + + + + Gets the orientation of the container. Default value is Horizontal. + + + + + Returns collection of the documents hosted by this container. + + + + + Returns minimum size of the object. + + + + + Gets or sets splitter size in pixels between the documents docking inside the container. Default value is 3. + + + + + Gets or sets whether the size of the documents is recorded once the layout is calculated. + + + + + Indicates whether the container is allowed to exceed the parent control client size due to inner child windows minimum size constraints. + + + + + Represents DocumentDockContainer object converter. + + + + + Represents class that manages document docking UI interaction. + + + + + + Returns DocumentBaseContainer that holds the reference bar. + + Bar to return document container for. + Returns null if document container cannot be found or reference to the document container. + + + + Docks specified bar by appending it to the container. Bar will be added according to the container's orientation. + + Bar to dock. + + + + Docks specified bar by appending it to the container. Bar will be added according to the container's orientation. + + Bar to dock. + Side to dock bar at. + + + + Adjusts the size of the dock container if needed after a bar has been docked to it. + + Bar object that has been docked. + Indicates that bar was already docked but its Visible property has changed + + + + Processes OnMouseMove events from DockSite. This routine assumes that mouse messages are received only when mouse is actually over + the dock site and not containing bars. This is significant because it will receive messages only if mouse is over the splitter + space between bars. + + Mouse event arguments. + + + + Returns reference to the DocumentDockContainer that contains specified coordinates. Searches through the Documents collection first. + + X coordinate + Y coordinate + + + + + Sets the width of the bar that is managed by this document layout. Width can be set only if parent container has + Horizontal orientation. Note that bar minimum size is respected by this method and + it will be enforced. If width is less than minimum width bar's width will be set to minimum width. + + Reference to bar object. + Desired width. + + + + Sets the height of the bar that is managed by this document layout. Height can be set only if parent container has + vertical orientation. Note that bar minimum size is respected by this method and + it will be enforced. If height is less than minimum height bar's height will be set to minimum height. + + Reference to bar object. + Desired height. + + + + Gets or sets the root document dock container object. + + + + + Gets or sets the splitter width used for mouse hit-testing. + + + + + Gets or sets the container of the document. + + + + + Gets whether document/bar is being resized. + + + + + Represent the menu, toolbar and popup menu structure for the form. + + + + + Raises BarStateChanged event. + + Provides event arguments. + + + + Creates new instance of DotNetBarManager. + + + + + Creates new instance of DotNetBarManager. + + Container. + + + + Dock bar to the specified side of the form. + + Bar to dock. + Side to dock bar to. + + + + Docks the bar to the specified side of the reference bar. + + Bar to dock. + Reference bar. + Side of the reference bar to dock the bar to. + + + + Docks specified DockContainerItem. + + DockContainerItem to dock. + Side to dock item to. + + + + Docks specified DockContainerItem. + + DockContainerItem to dock. + Reference bar. + Side to dock item to. + + + + Docks specified DockContainerItem. + + DockContainerItem to dock. + Reference bar. + Side to dock item to. + + + + Tear-off specified DockContainerItem and float it. + + Item to float. + + + + Tear-off specified DockContainerItem and float it. + + Item to float. + + + + Make specified bar floating bar, i.e. undock it and place in floating window. + + Bar to float. + + + + Make specified bar floating bar, i.e. undock it and place in floating window and specified location on the screen. + + Bar to float. + Screen coordinates for the floating bar. + + + + Raises the ActiveDockContainerChanged event. + + Provides event arguments. + + + + Invokes ItemDoubleClick event. + + Reference to item double-clicked + Event arguments + + + + Returns the Bar object that contains the item. + + + + + Clean up any resources being used. + + + + + Returns whether property should be serialized by Windows Forms designer. + + + + + Use to remove bar from DotNetBar control. Bar will be undocked if it is docked and + removed from all internal collections. + + Bar to remove. + + + + Forces the loading of the definition specified in DefinitionName property. + By default definition is loaded after parent form handle has been created and form is loaded. + However, under certain circumstances you might need DotNetBar to load definition right away so + you can access bars and items. We recommend moving the code to Form Load event and leaving the loading process for DotNetBar definition as is. + + + + + Loads DotNetBar definition from file. + + File that contains DotNetBar defintion. + + + + Invokes SerializeItem event. + + Provides data for the event. + + + + Invokes DeserializeItem event. + + Provides data for the event. + + + + Saves current DotNetBar definition and state to the file. + + File name. + + + + Loads DotNetBar layout from file. + + File that contains DotNetBar defintion. + + + + Saves current DotNetBar layout to the file. + + File name. + + + + Invokes the DotNetBar Customize dialog. + + + + + Returns the collection of items with the specified name. + + Item name to look for. + + + + + Returns the collection of items with the specified name. This method search for items on all Bars, Items collection and ContextMenus collection. + The order of search is as follows. All Bars from Bars collections are searched, then Items collection and then ContextMenus collection. + + Item name to look for. + Specifies that search will be performed through all DotNetBar collections. + + + + + Returns the collection of items with the specified name and type. + + Item name to look for. + Item type to look for. + + + + + Returns the collection of items with the specified name and type. This method will searchs for items on all Bars, Items collection and ContextMenus collection. + The order of search is as follows. All Bars from Bars collections are searced, then Items collection and then ContextMenus collection. + + Item name to look for. + Item type to look for. + Specifies that full search (through all collections) will be performed. + + + + + Returns the collection of items with the specified name and type. This method will searchs for items on all Bars, Items collection and ContextMenus collection. + The order of search is as follows. All Bars from Bars collections are searced, then Items collection and then ContextMenus collection. + + Item name to look for. + Item type to look for. + Specifies that full search (through all collections) will be performed. + + + + + Returns the first item that matches specified name. + + Item name to look for. + + + + + Returns the first item that matches specified name with the option to indicate full search of all collections. + The order of search is as follows. All Bars from Bars collections are searced, then Items collection and then ContextMenus collection. + + Item name to look for. + Specifies that all collection will be searched. + + + + + Called before modal dialog is displayed using ShowModal() method. + + + + + Called after modal dialog is closed. + + + + + You must call this procedure if you are implementing custom customize dialog box after your dialog box is closed. + + + + + Registers popup item with DotNetBar. Use this function carefully. The registration is required only if Popup item is created completely from code and it is not added to any DotNetBarManager collection. + + + + + + Un-registers specified popup. See RegisterPopup for more information. + + + + + + Resets the ColorScheme property to its default value. + + + + + Informs the DotNetBarManager that Mdi Child for has been activated. Calling this method is needed only under special + conditions where MDI child system items do not show. + + + + + Resets all usage data collected by DotNetBar in relation to the Personalized menus. + + + + + Occurs after bar registered with DotNetBarManager state has changed, like selected dock tab has changed, bar has closed, bar has been docked or undocked etc. + + + + + Occurs when focused (active) DockContainerItem has changed. You can use ActiveDockContainerItem property to get reference to currently focused DockContainerItem. + + + + + Occurs just before customize popup menu is shown. + + + + + Occurs when Item is clicked. + + + + + Occurs when Item is clicked. + + + + + Occurs when popup of type container is loading. + + + + + Occurs when popup of type container is unloading. + + + + + Occurs when popup item is about to open. + + + + + Occurs when popup item is closing. + + + + + Occurs just before popup window is shown. + + + + + Occurs when Item Expanded property has changed. + + + + + Occurs when Bar is docked. + + + + + Occurs when Bar is Undocked. + + + + + Occurs before dock tab is displayed. + + + + + Occurs when Bar auto-hide state has changed. + + + + + Occurs when mouse button is pressed. + + + + + Occurs when mouse button is released. + + + + + Occurs when mouse enters the item. + + + + + Occurs when mouse leaves the item. + + + + + Occurs when mouse moves over the item. + + + + + Occurs when mouse remains still inside an item for an amount of time. + + + + + Occurs when item loses input focus. + + + + + Occurs when item receives input focus. + + + + + Occurs when user changes the item position, removes the item, adds new item or creates new bar. + + + + + Occurs after DotNetBar definition is loaded. + + + + + Occurs when users wants to reset the DotNetBar to default state. + + + + + Occurs after an Item is removed from SubItemsCollection. + + + + + Occurs after an Item has been added to the SubItemsCollection. + + + + + Occurs when ControlContainerControl is created and contained control is needed. + + + + + Occurs when Text property of an Item has changed. + + + + + Occurs when Customize Dialog is about to be shown. + + + + + Occurs when Customize Dialog is closed. + + + + + Use this event if you want to serialize the hosted control state directly into the DotNetBar definition file. + + + + + Use this event if you want to deserialize the hosted control state directly from the DotNetBar definition file. + + + + + Occurs when current Dock tab has changed. + + + + + Occurs when Bar is about to be closed as a result of user clicking the Close button on the bar. + + + + + Occurs when Bar in auto-hide state is about to be displayed. + + + + + Occurs when user starts to drag the item when customize dialog is open. + + + + + Occurs when users Tears-off the Tab from the Bar and new Bar is created as result of that action. + + + + + Occurs when DotNetBar is looking for translated text for one of the internal text that are + displayed on menus, toolbars and customize forms. You need to set Handled=true if you want + your custom text to be used instead of the built-in system value. + + + + + Occurs before an item in option group is checked and provides opportunity to cancel the change. + + + + + Occurs before tooltip for an item is shown. Sender could be the BaseItem or derived class for which tooltip is being displayed or it could be a ToolTip object itself it tooltip is not displayed for any item in particular. + + + + + Occurs on dockable bars when end-user attempts to close the individual DockContainerItem objects using system buttons on dock tab. + Event can be canceled by setting the Cancel property of event arguments to true. This even will occur only after user presses the + X button on tab that is displaying the dockable windows/documents. + + + + + Occurs on dockable bars after DockContainerItem is closed. This action cannot be cancelled. + + + + + Occurs after an item has been serialized to XmlElement and provides you with opportunity to add any custom data + to serialized XML. This allows you to serialize any data with the item and load it back up in DeserializeItem event. + + + To serialize custom data to XML definition control creates handle this event and use CustomXmlElement + property on SerializeItemEventArgs to add new nodes or set attributes with custom data you want saved. + + + + + Occurs after an item has been de-serialized (load) from XmlElement and provides you with opportunity to load any custom data + you have serialized during SerializeItem event. + + + To de-serialize custom data from XML definition handle this event and use CustomXmlElement + property on SerializeItemEventArgs to retrive any data you saved in SerializeItem event. + + + + + Occurs when TextBoxItem input text has changed. + + + + + Occurs when color on ColorPickerDropDown is choosen from drop-down color picker or from Custom Colors dialog box. Selected color can be accessed through SelectedColor property. + + + + + Occurs when Checked property of an button has changed. + + + + + Gets or sets docking splitter size. + + + + + Indicates whether Ctrl+Tab keys cycles the currently selected dock tab. + + + + + Gets or sets the Context menu bar associated with the this control which is used as part of Global Items feature. The context menu + bar assigned here will be used to search for the items with the same Name or GlobalName property so global properties can be propagated when changed. + You should assign this property to enable the Global Items feature to reach your ContextMenuBar. + + + + + Gets or sets the form DotNetBarManager is attached to. + + + + + Gets or sets the user control DotNetBarManager is parented to when on user control and providing popups only. + + + + + Gets currently focused (active) DockContainerItem. Note that only if DockContainer Item has input focus it will be consider active + so there can only be one active DockContainerItem at a time. + + + + + Gets whether component has been disposed. + + + + + Disposed will return true after Dispose method has been executed. + + + + + Gets or sets whether GC.Collect() is called when this component is disposed. + + + + + Gets or sets the minimum client size that docking windows will try to maintain for the client area (not occupied by dock windows). + Note that this value is suggested value and cannot be observed when form is resized below the minimum size required for the given layout. + Default value is 48x48 pixels. + + + + + Indicates whether DotNetBar provides docking hints for easy docking of bars. + + + + + Gets or sets whether user can control how first bar is docked when using docking hints (default value is True). When enabled (default value) placing the mouse over the middle + docking hint will dock the bar at partial size and using the far docking hint will dock bar at full size. Full size indicates that dock site which hosts the bar + consumes all the space of the parent form while partial size indicates that dock site consumes the full size minus the space of the other dock sites. Default value is true. + + + + + Gets or sets whether uniform styling is applied to bars docked as documents. Default value is true which means + that bar that will be docked as document will have it's style changed so it fits in default document styling. + Such bars will have GrabHandleStyle=None, DockTabAlignment=Top and AlwaysDisplayDockTab=true. + Set this property to false to have bars keep these properties once they are docked as documents. + Value of these properties will be returned back to the default values once bar is not docked as document. + + + + + Gets the collection of the Bar objects associated with DotNetBarManager. + + + + + Gets whether definition is loaded. + + + + + Gets the collection of all items that are used for end-user design-time customization. + + + + + Gets the collection of all popup menus managed by DotNetBarManager. + + + + + Indicates whether shortucts handled by items are dispatched to the next handler or control. + + + + + Gets or sets the collection of shortcut keys that are automatically dispatched to the control that has focus even if they are handled and used by one of the items. This gives you fine control over which shortcuts are passed through the system and which ones are marked as handled by DotNetBar. + + + + + Indicates whether Reset buttons is shown that allows end-user to reset the toolbar state. + + + + + ImageList for images used on Items. Images specified here will always be used on menu-items and are by default used on all Bars. + + + + + ImageList for medium-sized images used on Items. + + + + + ImageList for large-sized images used on Items. + + + + + Suspends the bar layout for all bars. + + + + + Specifes whether drop shadow is displayed for Menus and pop-up Bars. OfficeXP Style only. + + + + + Specifes whether to use Alpha-Blending shadows for pop-up items if supported by target OS. Disabling Alpha-Blended shadows can improve performance. + + + + + Gets or sets whether gray-scale algorithm is used to create automatic gray-scale images. Default is true. + + + + + Gets or sets whether hooks are used for internal DotNetBar system functionality. Using hooks is recommended only if DotNetBar is used in hybrid environments like Visual Studio designers or IE. + + + + + Gets whether any handlers have been defined for SerializeItem event. If no handles have been defined to optimize performance SerializeItem event will not be attempted to fire. + + + + + Gets whether any handlers have been defined for DeserializeItem event. If no handles have been defined to optimize performance DeserializeItem event will not be attempted to fire. + + + + + Returns whether definition is being currently loaded. + + + + + Gets or sets whether document bars are saved in definition file. Default value is false which means that document + bars are not saved as part of definition file. You can set this value to true to save document bar to definition file and + be able to load them. + + + Note that by default Document bars that you created during design-time get member + variables assigned to them by Windows Forms designer. If you decide to save definition + of such bars and load definition back member variables will not point to correct bar + instances since loading definition recreates all bars from scratch. You should always + use Bars collection to access bars when saving and loading definitions. + + + + + Gets or sets the DotNetBar definition string. + + + + + Gets or sets the DotNetBar layout string. + + + + + Gets whether DotNetBarManager is loading layout. + + + + + Specifies that custom customize dialog will be used. Use EnterCustomize event to show your custom dialog box. + + + + + Gets or sets the toolbar Top dock site used by DotNetBarManager. + + + + + Gets or sets the toolbar Bottom dock site used by DotNetBarManager. + + + + + Gets or sets the toolbar Left dock site used by DotNetBarManager. + + + + + Gets or sets the toolbar Right dock site used by DotNetBarManager. + + + + + Gets or sets the Top dock site used by DotNetBarManager. + + + + + Gets or sets the Bottom dock site used by DotNetBarManager. + + + + + Gets or sets the Left dock site used by DotNetBarManager. + + + + + Gets or sets the Right dock site used by DotNetBarManager. + + + + + Gets or sets the Fill dock site used by DotNetBarManager. Fill dock site is most commonly used as dock site + for document type docking. + + + + + Specifies whether bars are drawn using Themes when running on OS that supports themes like Windows XP. + + + + + Sets the style of all items in DotNetBar Manager. + + + + + Gets or sets Color scheme for all bars. Note that you need to set UseGlobalColorScheme to true to indicate + that this ColorScheme object will be used on all bars managed by this instance of DotNetBarManager. + + + + + Gets or sets whether ColorScheme object on DotNetBarManager is used as a default ColorScheme for all bars managed by DotNetBarManager. + Default value is false which indicates that ColorScheme on each Bar is used. + When set to true each bar will use the ColorScheme settings from DotNetBarManager and it will ignore any + setting on the Bar.ColorScheme object. + + + + + Indicates whether the Personalized menu setting is ignored and full menus are always shown. + + + + + Gets or sets whether accelerator letters for menu or toolbar commands are underlined regardless of + current Windows settings. Accelerator keys allow easy access to menu commands by using + Alt + choosen key (letter). Default value is false which indicates that system setting is used + to determine whether accelerator letters are underlined. Setting this property to true + will always display accelerator letter underlined. + + + + + Returns whether theme support is enabled on the OS that supports themes like Windows XP. + + + + + Indicates whether the CustomizeItem (allows toolbar customization) is added for new Bars end users are creating. + + + + + Gets or sets whether DotNetBar ignores the F10 key which when pressed sets the focus to menu bar + + + + + Indicates whether the items that are not recenly used are shown after mouse hovers over the expand button. + + + + + Indicates whether Tooltips are shown on Bars and menus. + + + + + Indicates whether item shortcut is displayed in Tooltips. + + + + + Specifies the pop-up animation style. + + + + + Specifies whether the MDI system buttons are displayed in menu bar when MDI Child window is maximized. + + + + + Gets or sets whether MDI Child form System Menu is hidden. System menu is displayed in MDI form menu area when form is maximized. Default value is false. + + + + + Gets or sets whether customize context menu is shown on all bars or dock sites. + + + + + Gets or sets whether parent form is activated when dock window layout is loaded. + + + + + Represents delegate for ContextMenu events. + + + + + Represents the method that will handle the ItemRemoved event. + + + + + Defines the delegate for DockTabChange event + + + + + Defines the delegate for BarClosing event + + + + + Defines the delegate for BarAutoHideDisplay event + + + + + Represents the method that will handle the LocalizeString event. + + + + + Gets or sets the display rectangle for popup auto-hide bar. + + + + + Event arguments for LocalizeString event. + + + + + Indicates that event has been handled and that LocalizedValue should be used. + + + + + Indicates the string key for the text that needs to be localized. + + + + + Indicates the localized text value. If you are performing custom string localization + you need to set this value to the translated text for current locale and you need to set + Handled property to true. + + + + + Default constructor. + + + + + Event arguments for EndUserCustomize event. + + + + + Indicates the customize action that user executed. + + + + + Default constructor. + + Indicates action user executed. + + + + Initializes a new instance of the EndUserCustomizeEventArgs class. + + + + + + + Gets any action data, might be null/nothing. + + + + + Delegate for EndUserCustomize event. + + + + + Defines delegate for ActiveDockContainerChanged event. + + + + + + + Provides event arguments for ActiveDockContainerChanged event. + + + + + Gets the DockContainerItem that has been activate or deactivated. + + + + + Initializes a new instance of the ActiveDockContainerChangedEventArgs class. + + + + + + Summary description for DotNetBarResourcesAttribute. + + + + + Summary description for DotNetBarStreamer. + + + + + Represents class that can serialize compatible marked properties. + + + + + XML element is expected to be something like Image data Base64 encoded + + Image data + + + + + Represents visual style of an User Interface Element. + + + + Creates new instance of the class. + + + + Initializes a new instance of the ElementStyle class. + + + + + Creates new instance of the class. + + + Creates new instance of the class. + + + Creates new instance of the class. + + + + Indicates whether BackgroundColor should be serialized. Used by windows forms designer design-time support. + + + + + Resets BackgroundColor to it's default value. Used by windows forms designer design-time support. + + + + + Indicates whether BackgroundColor2 should be serialized. Used by windows forms designer design-time support. + + + + + Resets BackgroundColor2 to it's default value. Used by windows forms designer design-time support. + + + + + Resets BackgroundImage to it's default value null (VB Nothing). Used by windows forms designer design-time support. + + + + + Indicates whether TextColor should be serialized. Used by windows forms designer design-time support. + + + + + Resets TextColor to it's default value. Used by windows forms designer design-time support. + + + + + Indicates whether TextShadowColor should be serialized. Used by windows forms designer design-time support. + + + + + Resets TextColor to it's default value. Used by windows forms designer design-time support. + + + + + Indicates whether TextShadowOffset should be serialized. Used by windows forms designer design-time support. + + + + + Resets TextShadowOffset to it's default value. Used by windows forms designer design-time support. + + + + + Sets size of the element style. + + Indicates new size. + + + + Indicates whether BorderColor should be serialized. Used by windows forms designer design-time support. + + + + + Resets BorderColor to it's default value. Used by windows forms designer design-time support. + + + + + Indicates whether BorderColor3 should be serialized. Used by windows forms designer design-time support. + + + + + Resets BorderColor to it's default value. Used by windows forms designer design-time support. + + + + + Indicates whether BorderColorLight should be serialized. Used by windows forms designer design-time support. + + + + + Resets BorderColor to it's default value. Used by windows forms designer design-time support. + + + + + Indicates whether BorderColor2 should be serialized. Used by windows forms designer design-time support. + + + + + Resets BorderColorLight2 to it's default value. Used by windows forms designer design-time support. + + + + + Indicates whether property should be serialized. Used by windows forms designer design-time support. + + + + + Resets property to it's default value. Used by windows forms designer design-time support. + + + + + Indicates whether property should be serialized. Used by windows forms designer design-time support. + + + + + Resets property to it's default value. Used by windows forms designer design-time support. + + + + + Indicates whether property should be serialized. Used by windows forms designer design-time support. + + + + + Resets property to it's default value. Used by windows forms designer design-time support. + + + + + Indicates whether property should be serialized. Used by windows forms designer design-time support. + + + + + Resets property to it's default value. Used by windows forms designer design-time support. + + + + + Releases all resources used in this control. After calling Dispose() + object is not in valid state and cannot be recovered to the valid state. + Recreation of the object is required. + + + + + Applies a "child/inherited" style text and box properties but not any background or border properties to this style. + Use this method to create style hierarchies. + + Style to apply to this style + + + + + Applies a "child/inherited" style to this style. Use this method to create style + hierarchies. + + + This method is used to support style hierarchies where a base style is defined + and inherited/child styles are derived and based on it. By using this method on the + base style you can apply only style changes defined by the child style. For example if + you defined a base style for normal user interface element then in most cases you do + not want to redefine the styling for the case when same user interface element is + selected. You will just defined the behavior of the selected state and then apply it to + the base normal style using ApplyStyle method. + + Style to apply to current style. + + + + Makes an exact copy of the style. + + New copy of ElementStyle object. + + + + Reset all style properties to default values. + + + + Returns default style for the Cell object. + + Reference to the default style for the Node. Cell style is based on the given + node style. + + + + Returns default style for disabled cells. + Returns new instance of ElementStyle object. + + + Returns default style for the selected cell object. + New instance of the ElementStyle object. + + + + Sets Alpha value for all colors defined by style to specified value. + + Style to change. + Alpha value for the colors. + + + + Returns reference to ColorScheme object used by this style. + + Instance of ColorScheme object or null if object could not be obtained. + + + + Occurs when appearance property of the style has changed. + + + + + Occurs when component is Disposed. + + + + + Gets the collection that defines the multicolor gradient background. + + + + + Gets or sets the background color for UI element. If used in combination with + BackgroundColor2 is specifies starting gradient color. + + + + + Gets or sets the color scheme color that is used as background color. Setting + this property overrides the setting of the corresponding BackColor property. + Color scheme colors are automatically managed and are based on current system colors. + That means if colors on the system change the color scheme will ensure that it's colors + are changed as well to fit in the color scheme of target system. Set this property to + eColorSchemePart.None to + specify explicit color to use through BackColor property. + + + + + Gets or sets the target gradient background color for UI element. + + + + + Gets or sets the color scheme color that is used as target gradient background color. Setting + this property overrides the setting of the corresponding BackColor2 property. + Color scheme colors are automatically managed and are based on current system colors. + That means if colors on the system change the color scheme will ensure that it's colors + are changed as well to fit in the color scheme of target system. Set this property to + eColorSchemePart.None to + specify explicit color to use through BackColor2 property. + + + + + Gets or sets the background gradient angle. + + + + + Gets or sets the background gradient fill type. Default value is Linear. + + + + + Specifies background image. + + + + + Specifies background image position when container is larger than image. + + + + + Specifies the transparency of background image. + + + + + Gets or sets the text color displayed in this UI element. + + + + + Gets or sets the color scheme color that is used as text color. Setting + this property overrides the setting of the corresponding TextColor property. + Color scheme colors are automatically managed and are based on current system colors. + That means if colors on the system change the color scheme will ensure that it's colors + are changed as well to fit in the color scheme of target system. Set this property to + eColorSchemePart.None to + specify explicit color to use through TextColor property. + + + + + Gets or sets the text shadow color. + + + + + Gets or sets the color scheme color that is used as text shadow color. Setting + this property overrides the setting of the corresponding TextShadowColor property. + Color scheme colors are automatically managed and are based on current system colors. + That means if colors on the system change the color scheme will ensure that it's colors + are changed as well to fit in the color scheme of target system. Set this property to + eColorSchemePart.None to + specify explicit color to use through TextColor property. + + + + + Indicates text shadow offset in pixels + + + + + Gets or sets the Font used to draw this the text. + + + + + Gets or sets a value that determines whether text is displayed in multiple lines or one long line. + + + + + Specifies alignment of the text. + + + + + Specifies alignment of the text. + + + + + Specifies how to trim characters when text does not fit. + + + + + Gets the total horizontal margin (Left + Right) + + + + + Gets the total vertical margin (Top + Bottom) + + + + + Gets or sets the left margin. + + + + + Gets or sets the right margin. + + + + + Gets or sets the top margin. + + + + + Gets or sets the bottom margin. + + + + + Gets or sets whether any style property has changed which could influence the size of the style. + + + + + Gets the calcuated size of the element style. + + + + + Gets or sets the border type for all sides of the element. + + + + + Gets or sets border width in pixels. + + + + + Gets or sets the border type for top side of the element. + + + + + Gets or sets the border type for bottom side of the element. + + + + + Gets or sets the border type for left side of the element. + + + + + Gets or sets the border type for right side of the element. + + + + + Gets or sets border width in pixels. + + + + + Gets or sets border width in pixels. + + + + + Gets or sets border width in pixels. + + + + + Gets or sets border width in pixels. + + + + + Gets or sets the border color for all sides. Specifing the color for the side will override this value. + + + + + Gets or sets the color scheme color that is used as border color. Setting + this property overrides the setting of the corresponding BorderColor property. + Color scheme colors are automatically managed and are based on current system colors. + That means if colors on the system change the color scheme will ensure that it's colors + are changed as well to fit in the color scheme of target system. Set this property to + eColorSchemePart.None to + specify explicit color to use through BorderColor property. + + + + + Gets or sets the target background gradient color for border on all sides. Specifing the color for the side will override this value. Gradient border colors + be employed only when per side border color is not specified. + + + + + Gets or sets the color scheme color that is used as taget gradient border color. Setting + this property overrides the setting of the corresponding BorderColor property. + Color scheme colors are automatically managed and are based on current system colors. + That means if colors on the system change the color scheme will ensure that it's colors + are changed as well to fit in the color scheme of target system. Set this property to + eColorSchemePart.None to + specify explicit color to use through BorderColor property. + + + + + Gets or sets the border gradient angle. Default value is 90. + + + + + Gets or sets the color for light border part when etched border is used. + + + + + Gets or sets the color scheme color that is used as border light color for etched border style. Setting + this property overrides the setting of the corresponding BorderColor property. + Color scheme colors are automatically managed and are based on current system colors. + That means if colors on the system change the color scheme will ensure that it's colors + are changed as well to fit in the color scheme of target system. Set this property to + eColorSchemePart.None to + specify explicit color to use through BorderColor property. + + + + + Gets or sets the target background gradient color for border on all sides. Specifing the color for the side will override this value. Gradient border colors + be employed only when per side border color is not specified. + + + + + Gets or sets the color scheme color that is used as taget gradient border light color for etched border style. Setting + this property overrides the setting of the corresponding BorderColor property. + Color scheme colors are automatically managed and are based on current system colors. + That means if colors on the system change the color scheme will ensure that it's colors + are changed as well to fit in the color scheme of target system. Set this property to + eColorSchemePart.None to + specify explicit color to use through BorderColor property. + + + + + Gets or sets the light border gradient angle. Default value is 90. + + + + + Gets or sets the background color for the left side border. + + + + + Gets or sets the color scheme color that is used as left border color. Setting + this property overrides the setting of the corresponding BorderLeftColor property. + Color scheme colors are automatically managed and are based on current system colors. + That means if colors on the system change the color scheme will ensure that it's colors + are changed as well to fit in the color scheme of target system. Set this property to + eColorSchemePart.None to + specify explicit color to use through BorderLeftColor property. + + + + + Gets or sets the background color for the right side border. + + + + + Gets or sets the color scheme color that is used as right border color. Setting + this property overrides the setting of the corresponding BorderRightColor property. + Color scheme colors are automatically managed and are based on current system colors. + That means if colors on the system change the color scheme will ensure that it's colors + are changed as well to fit in the color scheme of target system. Set this property to + eColorSchemePart.None to + specify explicit color to use through BorderRightColor property. + + + + + Gets or sets the background color for the top side border. + + + + + Gets or sets the color scheme color that is used as top border color. Setting + this property overrides the setting of the corresponding BorderTopColor property. + Color scheme colors are automatically managed and are based on current system colors. + That means if colors on the system change the color scheme will ensure that it's colors + are changed as well to fit in the color scheme of target system. Set this property to + eColorSchemePart.None to + specify explicit color to use through BorderTopColor property. + + + + + Gets or sets the background color for the bottom side border. + + + + + Gets or sets the color scheme color that is used as bottom border color. Setting + this property overrides the setting of the corresponding BorderBottomColor property. + Color scheme colors are automatically managed and are based on current system colors. + That means if colors on the system change the color scheme will ensure that it's colors + are changed as well to fit in the color scheme of target system. Set this property to + eColorSchemePart.None to + specify explicit color to use through BorderBottomColor property. + + + + + Gets the total horizontal padding (Left + Right) + + + + + Gets the total vertical padding (Top + Bottom) + + + + + Gets or sets the padding space in pixels for all 4 sides of the box. + + + + + Gets or sets the amount of space to insert between the top border of the element and the content. + + + + + Gets or sets the amount of space to insert between the bottom border of the element and the content. + + + + + Gets or sets the amount of space to insert between the left border of the element and the content. + + + + + Gets or sets the amount of space to insert between the right border of the element and the content. + + + + + Gets or sets the name of the style. + + + + + Gets or sets the class style belongs to. The Class styles are used to apply predefined values to the styles that belong to the same class. + This feature is used to manage color schemes/tables per class style. + + + + + Gets or sets the description of the style. + + + + + Gets or sets the Site associated with this component. Used by Windows forms designer. + + + + + Gets or sets the maximum height of the element. This property should be used in + conjunction with the WordWrap property to limit the size of + text bounding box. + + Default value is 0 which indicates that height of the style is unlimited. + + + + Returns System.Drawing.StringFormat constructed from current style settings. + + + + + Gets or sets a value indicating whether the control interprets an ampersand character (&) in the control's Text property to be an access key prefix character. Default value is false. + + + + + Indicates whether control hides the underlines of the letter prefixed by ampersand character when UseMnemonic=true + + + + + Returns eTextFormat constructed from current style settings. + + + + + Gets or sets the border corner type for all 4 sides. Default corner type is Square. + + + + + Gets or sets the border corner type for top left corner. Default value is Inherit which means that setting from CornerType property is used. + + + + + Gets or sets the border corner type for top right corner. Default value is Inherit which means that setting from CornerType property is used. + + + + + Gets or sets the border corner type for bottom left corner. Default value is Inherit which means that setting from CornerType property is used. + + + + + Gets or sets the border corner type for bottom right corner. Default value is Inherit which means that setting from CornerType property is used. + + + + + Gets or sets the diameter in pixels of the corner type rounded or diagonal. + + + + + Gets whether to paint left border for the style. + + + + + Gets whether to paint right border for the style. + + + + + Gets whether to paint top border for the style. + + + + + Gets whether to paint bottom border for the style. + + + + + Gets whether to paint any border for the style. + + + + + Gets whether to paint any border for the style. + + + + + Gets whether custom has any of properties changed. + + + + + Gets or sets whether ElementStyle is in design mode. + + + + + Gets or sets the maximum width of the element. This property should be used in + conjunction with the WordWrap property to limit the size of + text bounding box. + + Default value is 0 which indicates that width of the style is not limited. + + + + Gets or sets the reference to the parent collection. + + + + + Gets or sets the tree control style is assigned to. + + + + + Specifies the type of the gradient fill. + + + + + Represents linear gradient fill. + + + + + Represents radial gradient fill. + + + + + Paints the ElementStyle + + + + Creates new instance of the object. + + + + Paints text for given style. + + Display information. + Text to paint. + Default font if no font by style is specified. + + + + + Returns new Region object for given ElementStyle. + New instance of Region object. + Information to describe ElementStyle. + + + + Returns the clipping for the content of the element style. + + + + + + + Paints the element style on the canvas. + + Holds information necessary to paint style on canvas. + + + + Paint style border. + + Style display information. + + + + Paints style background. + + Style display information. + + + + Paints style background. + + Style display information. + + + + Paints style background image. + + Style display information. + + + + Returns background rectangle for given style by taking in account margins. + + Reference to style object. + Style bounds + Background rectangle. + + + + Returns GraphicsPath for given style. + + Reference to style. + Style bounds. + New instance of GraphicsPath + + + + Returns GraphicsPath for given style. + + Reference to style. + Style bounds. + New instance of GraphicsPath + + + + Initializes a new instance of the BorderDrawInfo structure. + + + + + + + + + + Represents information necessary to paint the style on canvas. + + + + Reference to ElementStyle object. + + + Reference to Graphics object. + + + ElementStyle bounds. + + + Get or sets whether layout is right-to-left. + + + + Gets or sets whether bottom and right border is "twisted" giving beveled look when double border is used. + + + + Creates new instance of the object. + + + Creates new instance of the object and initializes it with default values. + Style to initialize object with. + Graphics object to initialize object with. + Bounds to initialize object with. + + + Creates new instance of the object and initializes it with default values. + Style to initialize object with. + Graphics object to initialize object with. + Bounds to initialize object with. + + + + Specifies part of the background path. + + + + + Indicates complete background path + + + + + Indicates Top half of background path + + + + + Indicates Bottom half of background path + + + + + Represents the layout for the element style. + + + + + Calculates size of an style element. + + Style to calculate size for. + Default font that will be used by style if style does not uses it's own font. + Size of the style element. At this time only Height member will be calculated. + + + + Returns the total white space for a style. Whitespace is the space between the edge of the element and inner content of the element. + + Style to return white space for + + + + + Returns the total white space for a style. Whitespace is the space between the edge of the element and inner content of the element. + + Style to return white space for. + + + + + Returns total white space for left side of the style. Whitespace is the space between the edge of the element and inner content of the element. + + Style to return white space for. + + + + + Returns total white space for left side of the style. Whitespace is the space between the edge of the element and inner content of the element. + + Style to return white space for. + + + + + Returns total white space for right side of the style. Whitespace is the space between the edge of the element and inner content of the element. + + Style to return white space for. + + + + + Returns total white space for right side of the style. Whitespace is the space between the edge of the element and inner content of the element. + + Style to return white space for. + + + + + Returns total white space for top side of the style. Whitespace is the space between the edge of the element and inner content of the element. + + Style to return white space for. + + + + + Returns total white space for top side of the style. Whitespace is the space between the edge of the element and inner content of the element. + + Style to return white space for. + + + + + Returns total white space for top side of the style. Whitespace is the space between the edge of the element and inner content of the element. + + Style to return white space for. + + + + + Returns total white space for top side of the style. Whitespace is the space between the edge of the element and inner content of the element. + + Style to return white space for. + + + + + Returns amount of spacing for specified style parts. + + Style to calculate spacing for. + Part of the style spacing is calculated for. Values can be combined. + Side of the style to use for calculation. + + + + + Gets inner rectangle taking in account style padding, margins and border. + + + + + Specifies the appearance of a item. + + + + + Specifies the CrumbBar control style. + + + + + Specifies the Bar state. + + + + + Specifies the Bar grab handle style. + + + + + Specifies the Orientation of the item within container. + + + + + Specifies the design-marker orientation for the item. + + + + + Specifies the supported orientations by the item. + + + + + Specifies the docked Bar border type. + + + + + Specifes vertical alignment. + + + + + Specifies item alignment. + + + + + Specifies the popup type. + + + + + Specifies the dock side. + + + + + Specifies the item shortcut. + + + + + Specifies the item menu visibility. + + + + + Specifies the item behavior personalized menus. + + + + + Specifies the popup animation. + + + + + Specifies ButtonItem style. + + + + + Specifies the image position. + + + + + Specifies the hot tracking style for buttons. + + + + + Specifies the menu drop shadow. + + + + + Specifies the image size for the items on the Bar. + + + + + Specifies button image list selection. + + + + + Indicates that image is stretched to fill the container space. + + + + + Image is centered inside of container space. + + + + + Image is tiled to fill container space. + + + + + Image is drawn in top left corner of container space. + + + + + Image is drawn in top right corner of container space. + + + + + Image is drawn in bottom left corner of container space. + + + + + Image is drawn in bottom right corner of container space. + + + + + Image is drawn on the left side in the middle of the container space. + + + + + Image is drawn on the right side in the middle of the container space. + + + + + Specifies the sides of a rectangle to apply a border to. + + + + + No Border. + + + + + Border on the Left edge. + + + + + Border on the Right edge. + + + + + Border on the Top edge. + + + + + Border on the Bottom edge. + + + + + Border on all 4 sides. + + + + + Specifies appearance type of the Side Bar control. + + + + + Traditional Side Bar appearance with 3D panels. + + + + + Improved Flat Side Bar appearance with extended appearance options. + + + + + Specifies predefined side bar color scheme. + + + + + Specifies the side popup is displayed in relation to it's parent. + + + + + Indicates layout type used for items within side bar panel. + + + + + Default layout all items arranged in one column. + + + + + Items arranged in multiple columns determined by the width of the panel. + + + + + Indicates color scheme assigned to the tab item. + + + + + Indicates the action end user took during toolbar/menubar customization. + + + + + User has changed the visibility of the bar. + + + + + Indicates that item visibility has changed i.e. it's visible property. + + + + + Indicates that an item has been moved to different location. + + + + + Indicates that an item has been removed from the bar. + + + + + Indicates that item's text has been changed. + + + + + Indicates that style of the button i.e. ButtonStyle property has changed. + + + + + Indicates that item's BeginGroup property has changed. + + + + + Indicates that user has created a new bar. + + + + + Indicates that user has renamed the bar i.e. changed it's Text property. + + + + + Indicates that user has deleted the bar. + + + + + Specifies the type of the layout for tabs. + + + + + Tabs are auto-sized to fit the width of the container. + + + + + Tab's width is calculated based on the image and text and navigation box is displayed + when tabs cannot fit the container. + + + + + Tab are wrapping on multiple lines based on the width and navigation box is displayed. + + + + + Tab are wrapping on multiple lines based on the width and NO navigation box is displayed. + + + + + Indicates the corner type. + + + + + Inherits setting if applies. + + + + + Specifies square corner. + + + + + Specifies rounded corner. + + + + + Specifies diagonal corner. + + + + + Specifies the action that raised a event + + + + + The event was caused by a keystroke. + + + + + The event was caused by a mouse operation. + + + + + The event is caused programmatically from user code. + + + + + Specifies the button alignment inside of the BubbleBar. + + + + + Buttons are aligned to the top and arranged horizontally. + + + + + Buttons are aligned to the bottom and arranged horizontally. + + + + Specifies the way background image is displayed on background. + + + Image is stretched to fill the background + + + Image is centered inside the background + + + Image is tiled inside the background + + + + Image is drawn in top left corner of container space. + + + + + Image is drawn in top right corner of container space. + + + + + Image is drawn in bottom left corner of container space. + + + + + Image is drawn in bottom right corner of container space. + + + + + Imaged is centered and fills the control but aspect ratio is unchanged. + + + + + Specifies the border type for style element. + + + + Indicates no border + + + Border is a solid line + + + Border is a solid dash line + + + Border is solid dash-dot line + + + Border is solid dash-dot-dot line + + + Border consists of dots + + + Border consists light and dark part creating an etched effect + + + Border consists dark and light part. Light part is the inside border. + + + + Specifies the alignment of a text string relative to its element's rectangle. + + + + + Specifies the text be aligned near from the origin position of the element's rectangle. In a left-to-right layout, the near position is left. In a right-to-left layout, the near position is right. + + + + + Specifies that text is aligned in the center of the element's rectangle. + + + + + Specifies that text is aligned far from the origin position of the element's rectangle. In a left-to-right layout, the far position is right. In a right-to-left layout, the far position is left. + + + + + Specifies how to trim characters from a text that does not completely fit into a element's shape. + + + + + Specifies that the text is trimmed to the nearest character. + + + + + Specifies that the text is trimmed to the nearest character, and an ellipsis is inserted at the end of a trimmed line. + + + + + The center is removed from trimmed lines and replaced by an ellipsis. The algorithm keeps as much of the last slash-delimited segment of the line as possible. + + + + + Specifies that text is trimmed to the nearest word, and an ellipsis is inserted at the end of a trimmed line. + + + + + Specifies no trimming. + + + + + Specifies that text is trimmed to the nearest word. + + + + + Specifies the alignment of buttons in title bar. + + + + + Buttons are left aligned. + + + + + Buttons are right aligned. + + + + + Indicates white-space part of the style. + + + + + Represents style padding. + + + + + Represents style border. + + + + + Represents style margin. + + + + + Indicates the style side. + + + + + Specifies left side of the style. + + + + + Specifies right side of the style. + + + + + Specifies top side of the style. + + + + + Specifies bottom side of the style. + + + + + Specifies the button state. + + + + + Button is in it's default state. + + + + + Button is disabled + + + + + Mouse is over the button + + + + + Left mouse button is pressed + + + + + Right mouse button is pressed + + + + + Button is hidden. + + + + + Indicates predefined color scheme assigned to super tooltip. + + + + + Specifies predefined color assigned to ribbon items. + + + + + Specifies predefined color assigned to ribbon tab groups. + + + + + Specifies the state of the Wizard button. + + + + + Specifies the button that caused the wizard page change. + + + + + Page change was started using Wizard Back button. + + + + + Page change was started using Wizard Next button. + + + + + Page change was started from code. + + + + + Specifies wizard button that is clicked when the user presses the ENTER key. + + + + + If finish button is enabled and visible it will be clicked otherwise click next button + + + + + Click finish button + + + + + Click next button + + + + + No button will be clicked + + + + + Specifies wizard button that is clicked when the user presses the Escape key. + + + + + Cancel button will be clicked + + + + + No button will be clicked + + + + + Specifies border around ColorItem. + + + + + No Border. + + + + + Border on the Left edge. + + + + + Border on the Right edge. + + + + + Border on the Top edge. + + + + + Border on the Bottom edge. + + + + + Border on all 4 sides. + + + + + Specifies the line alignment of the items inside of the container. + + + + + Items are aligned to the top. + + + + + Items are aligned to the middle point of the line. + + + + + Items are aligned to the bottom. + + + + + Specifies the alignment of the items inside of the container in horizontal layout. + + + + + Items are left aligned. + + + + + Items are centered. + + + + + Items are right aligned. + + + + + Specifies the alignment of the items inside of the container in vertical layout. + + + + + Items are top aligned. + + + + + Items are in the middle. + + + + + Items are Bottom aligned. + + + + + Specifies the rendering mode used by a user interface element. + + + + + Indicates that rendering on user interface element instance set through Renderer property is used. + + + + + Indicates that global application wide renderer is used as specified by GlobalManager.Renderer property. + + + + + Indicates that custom rendered will be used for an user interface element. Renderer property must be set when using this value to the renderer + that will be used. + + + + + Specifies the predefined color table for button. + + + + + Specifies the color table used to render ProgressBarItem in Office 2007 style. + + + + + Indicates default Normal color table, usually green. + + + + + Indicates Pause state color table, usually yellow. + + + + + Indicates Error state color table, usually red. + + + + + Specifies the position of ribbon title. + + + + + Title is positioned on the top of the ribbon. + + + + + Title is positioned on the bottom of the ribbon. + + + + + Specifies text alignment on the button. + + + + + Specifies the left aligned text. + + + + + Specifies the center aligned text. + + + + + Specifies the right aligned text. + + + + + Specifies the position of the tab close button. + + + + + Close button is on the left side of the tab. + + + + + Close button is on the right side of the tab. + + + + + Describes the bar type. + + + + + Indicates that bar is toolbar. + + + + + Indicates that bar is menu bar. + + + + + Indicates that bar is status bar. + + + + + Indicates that bar is dock window. + + + + + Describes the categorization mode used to categorize items on the Customize Ribbon dialog. + + + + + Items are automatically categorized by the ribbon bar they appear on. + + + + + Items are categorized by the Category property on each item. Category property should be set on each item. + + + + + Describes the check-box item appearance style + + + + + Standard check-box style. + + + + + Radio button style. Only one button can be selected/checked in given container. + + + + + Indicates the position of the check box sign related to the text for CheckBoxItem. + + + + + Check box sign is positioned on the left side of the text. + + + + + Check box sign is positioned on the right side of the text. + + + + + Check box sign is positioned above the text. + + + + + Check box sing is positioned below the text + + + + + Indicates the type of the progress bar. + + + + + Standard step based progress bar. + + + + + The automatically moving progress bar. + + + + + Defines the direction of collapsing/expanding + + + + + Control is collapsed from bottom to top. + + + + + Control is collapsed from top to bottom. + + + + + Control is collapsed from right to left. + + + + + Control is collapsed from left to right. + + + + + Describes the scroll bar skinning applied to the controls. + + + + + No scrollbar skinning is applied to the control. + + + + + Optimized scrollbar skinning algorithm is used. Might provide better appearance in certain scenarios. + + + + + Unoptimized scrollbar skinning algorithm is used. Might provide better appearance in certain scenarios. + + + + + Indicates the position of the slider label text related to the slider part. + + + + + Label is positioned on the left side of the slider. + + + + + Label is positioned on the right side of the slider. + + + + + Label is positioned above the slider. + + + + + Label is positioned below the slider. + + + + + Defines the slider item parts. + + + + + Indicates no part. + + + + + Indicates the increase button of slider control. + + + + + Indicates the decrease button of slider control. + + + + + Indicates the label part of slider control. + + + + + Indicates the track area part of the control. + + + + + Specifies the position of the title image. + + + + + Image is positioned on the left side. + + + + + Image is centered. + + + + + Image is positioned on the right side. + + + + + Specifies the Wizard control Appearance. + + + + + Indicates default Wizard 97 style. + + + + + Indicates the Office 2007 Style Wizard Appearance. + + + + + Specifies wizard title image alignment + + + + + Image is aligned to left + + + + + Image is aligned to right + + + + + Specifies the behaviour used to hide watermark. + + + + + Watermark for control is hidden when control receives the input focus. + + + + + Watermark for control is hidden when control has non-empty input value. + + + + + Specifies the advanced ScrollBar appearance. + + + + + Default scroll bar appearance. + + + + + Office 2007 style Application scroll bar appearance. + + + + + Defines text position in relation to the content of the item.. + + + + + Text is positioned to the left of the content. + + + + + Text is positioned to the right of the content. + + + + + Text is positioned on top of the content. + + + + + Text is positioned on bottom of the content. + + + + + Defines position for the notification mark + + + + + Defines available symbol sets. + + + + + FontAwesome Symbol Set. + + + + + Android Material Symbol Set. + + + + + Gets or sets Graphics object group is rendered on. + + + + + Gets the reference to ButtonItem instance being rendered. + + + + + Creates new instance of the object and initializes it with default values + + Reference to Graphics object. + Reference to ColorItem object. + + + + Represents event arguments for DockTabClosing event. + + + + + Indicates the DockContainerItem that is about to close. + + + + + Provides ability to cancel closing of the DockContainerItem. Default value is false. + + + + + Set to true to automatically remove DockContainerItem from the Bar.Items collection after it is closed. Default value is false + which means that DockContainerItem will be kept in collection but it will be hidden after this event is complete. + + + + + Returns source of the event: keyboard, mouse or code. + + + + + Creates new instance of the class. + + Reference to DockContainerItem that is about to close + + + + Delegate for DockTabClosing event. + + + + + Represents arguments for SerializeItem event which allows you to add custom serialization data to definitions saved by control. + + + + + Gets reference to item being serialized or de-serialized. + + + + + Gets reference to instance of XmlElement that item is serialized to or is being de-serialized from. You should not change any data directly on this element. + + + + + Gets the reference to XmlElement that you can serialize to or de-serialize any custom data from. You can add child elements or set the attributes on + this XmlElement when handling SerializeItem event. When handling DeserializeItem event you can load same data from this element. + + + + + Defines delegate for SerializeItem event. + + + + + Provides more information about MarkupLinkClick event. + + + + + Gets the value of href attribute from the markup link that was clicked. + + + + + Gets the value of name attribute from the markup link that was clicked. + + + + + Creates new instance of the object. + + Value of name attribute. + Value of href attribute. + + + + Defines delegate for MarkupLinkClick event. + + + + + Panel control with title bar that can be expanded or collapsed. + + + + + Called after either ColorScheme or ColorSchemeStyle has changed. If you override make sure that you call base implementation so default + processing can occur. + + + + + Used for design time support. + + true if property should be serialized. + + + + Resets the style to it's default value. + + + + + Resets the style to it's default value. + + + + + Resets the style to it's default value. + + + + + Called when AntiAlias property has changed. + + + + + Occurs before Expanded property is changed. You can cancel change of this property by setting Cancel=true on the event arguments. + + + + + Occurs after Expanded property has changed. You can handle ExpandedChanging event and have opportunity to cancel the change. + + + + + Indicates whether panel will hide the controls it contains when its collapsed and show them when its expanded. Default value is false. + + + + + Gets or sets whether the panel is collapsed/expanded when title bar is clicked. Default value is false. + + + + + Gets or sets the collapse/expand direction for the control. Default value causes the control to collapse from bottom to top. + + + + + Gets or sets whether panel is expanded or not. Default value is true. + + + + + Gets or sets animation time in milliseconds. Default value is 100 miliseconds. You can set this to 0 (zero) to disable animation. + + + + + Gets or sets the bounds of panel when expanded. This value is managed automatically by control based on the starting designer size and value + of Expanded property. + + + + + Gets or sets whether expand button is visible or not. Default value is true. + + + + + Returns bounds of expand button. Bounds are relative to the TitlePanel coordinates. + + + + + Gets or sets image that is used on title bar button to collapse panel. Default value is null which indicates + that system default image is used. + + + + + Gets or sets image that is used on title bar button to expand panel. Default value is null which indicates + that system default image is used. + + + + + Gets or sets the text for the title of the panel. + + + + + Gets or sets the title style. + + + + + Gets or sets the title style when mouse hovers over the title. + + + + + Gets or sets the title style when mouse button is pressed on the title. + + + + + Gets or sets the height of the title portion of the panel. Height must be greater than 0. Default is 26. + + + + + Gets reference to Panel control used as title bar. + + + + + Gets reference to the title bar expand button. + + + + + Gets or sets alignment of the expand button. + + + + + Gets the reference to the panel used as button when control is collapsed to the left or right. + + + + + Represents multi-functional splitter control. + + + + + Creates new instance of the object. + + + + + This member overrides Control.OnPaint. + + Event arguments. + + + + Resets BackgroundColor to it's default value. Used by windows forms designer design-time support. + + + + + Resets BackgroundColor2 to it's default value. Used by windows forms designer design-time support. + + + + + Resets BackgroundColor2 to it's default value. Used by windows forms designer design-time support. + + + + + Resets BackgroundColor2 to it's default value. Used by windows forms designer design-time support. + + + + + Resets BackgroundColor2 to it's default value. Used by windows forms designer design-time support. + + + + + Resets BackgroundColor2 to it's default value. Used by windows forms designer design-time support. + + + + + Resets BackgroundColor to it's default value. Used by windows forms designer design-time support. + + + + + Resets BackgroundColor2 to it's default value. Used by windows forms designer design-time support. + + + + + Resets BackgroundColor2 to it's default value. Used by windows forms designer design-time support. + + + + + Resets BackgroundColor2 to it's default value. Used by windows forms designer design-time support. + + + + + Resets BackgroundColor2 to it's default value. Used by windows forms designer design-time support. + + + + + Resets BackgroundColor2 to it's default value. Used by windows forms designer design-time support. + + + + + Apply default splitter style colors. + + Style colors to apply. + + + + Gets or sets whether expandable control ExpandableControl assigned to this splitter is expaned or not. Default value is true. + + + + + Gets or sets whether Click event is triggering expand/collapse of the splitter. Default value is true. + + + + + Gets or sets whether DoubleClick event is triggering expand/collapse of the splitter. Default value is false. + + + + + Gets or sets whether splitter will act as expandable splitter. Default value is true. When set to true ExpandableControl property should be set to the control that should be expanded/collapsed. + + + + + Gets or sets the control that will be expanded/collapsed by the splitter. Default value is null. Expandable property should be also set to true (default) to enable expand/collapse functionality. + + + + + Gets or sets visual style of the control. Default value is eSplitterStyle.Office2003. + + + + + Gets or sets animation time in milliseconds. Default value is 100 miliseconds. You can set this to 0 (zero) to disable animation. + + + + + Gets or sets the shortcut key to expand/collapse splitter. + + + + + Gets or sets the background color for UI element. If used in combination with + BackgroundColor2 is specifies starting gradient color. + + + + + Gets or sets the color scheme color that is used as background color. Setting + this property overrides the setting of the corresponding BackColor property. + Color scheme colors are automatically managed and are based on current system colors. + That means if colors on the system change the color scheme will ensure that it's colors + are changed as well to fit in the color scheme of target system. Set this property to + eColorSchemePart.None to + specify explicit color to use through BackColor property. + + + + + Gets or sets the target gradient background color for UI element. + + + + + Gets or sets the color scheme color that is used as target gradient background color. Setting + this property overrides the setting of the corresponding BackColor2 property. + Color scheme colors are automatically managed and are based on current system colors. + That means if colors on the system change the color scheme will ensure that it's colors + are changed as well to fit in the color scheme of target system. Set this property to + eColorSchemePart.None to + specify explicit color to use through BackColor2 property. + + + + + Gets or sets the background gradient angle. + + + + + Gets or sets the expand part fill color. + + + + + Gets or sets the color scheme color that is used expand part fill color. Setting + this property overrides the setting of the corresponding ExpandFillColor property. + Color scheme colors are automatically managed and are based on current system colors. + That means if colors on the system change the color scheme will ensure that it's colors + are changed as well to fit in the color scheme of target system. Set this property to + eColorSchemePart.None to + specify explicit color to use through ExpandFillColor property. + + + + + Gets or sets the expand part line color. + + + + + Gets or sets the color scheme color that is used expand part line color. Setting + this property overrides the setting of the corresponding ExpandLineColor property. + Color scheme colors are automatically managed and are based on current system colors. + That means if colors on the system change the color scheme will ensure that it's colors + are changed as well to fit in the color scheme of target system. Set this property to + eColorSchemePart.None to + specify explicit color to use through ExpandLineColor property. + + + + + Gets or sets the grip part dark color. + + + + + Gets or sets the color scheme color that is used grip part dark color. Setting + this property overrides the setting of the corresponding GripDarkColor property. + Color scheme colors are automatically managed and are based on current system colors. + That means if colors on the system change the color scheme will ensure that it's colors + are changed as well to fit in the color scheme of target system. Set this property to + eColorSchemePart.None to + specify explicit color to use through GripDarkColor property. + + + + + Gets or sets the expand part line color. + + + + + Gets or sets the color scheme color that is used expand part line color. Setting + this property overrides the setting of the corresponding GripLightColor property. + Color scheme colors are automatically managed and are based on current system colors. + That means if colors on the system change the color scheme will ensure that it's colors + are changed as well to fit in the color scheme of target system. Set this property to + eColorSchemePart.None to + specify explicit color to use through GripLightColor property. + + + + + Gets or sets the background color for UI element when mouse is over the element. If used in combination with + BackgroundColor2 is specifies starting gradient color. + + + + + Gets or sets the color scheme color that is used as background color when mouse is over the element. Setting + this property overrides the setting of the corresponding HotBackColor property. + Color scheme colors are automatically managed and are based on current system colors. + That means if colors on the system change the color scheme will ensure that it's colors + are changed as well to fit in the color scheme of target system. Set this property to + eColorSchemePart.None to + specify explicit color to use through HotBackColor property. + + + + + Gets or sets the target gradient background color for UI element when mouse is over the element. + + + + + Gets or sets the color scheme color that is used as target gradient background color when mouse is over the element. Setting + this property overrides the setting of the corresponding HotBackColor2 property. + Color scheme colors are automatically managed and are based on current system colors. + That means if colors on the system change the color scheme will ensure that it's colors + are changed as well to fit in the color scheme of target system. Set this property to + eColorSchemePart.None to + specify explicit color to use through HotBackColor2 property. + + + + + Gets or sets the background gradient angle when mouse is over the element. + + + + + Gets or sets the expand part fill color when mouse is over the element. + + + + + Gets or sets the color scheme color that is used expand part fill color when mouse is over the element. Setting + this property overrides the setting of the corresponding HotExpandFillColor property. + Color scheme colors are automatically managed and are based on current system colors. + That means if colors on the system change the color scheme will ensure that it's colors + are changed as well to fit in the color scheme of target system. Set this property to + eColorSchemePart.None to + specify explicit color to use through HotExpandFillColor property. + + + + + Gets or sets the expand part line color when mouse is over the element. + + + + + Gets or sets the color scheme color that is used expand part line color when mouse is over the element. Setting + this property overrides the setting of the corresponding HotExpandLineColor property. + Color scheme colors are automatically managed and are based on current system colors. + That means if colors on the system change the color scheme will ensure that it's colors + are changed as well to fit in the color scheme of target system. Set this property to + eColorSchemePart.None to + specify explicit color to use through HotExpandLineColor property. + + + + + Gets or sets the grip part dark color when mouse is over the element. + + + + + Gets or sets the color scheme color that is used grip part dark color when mouse is over the element. Setting + this property overrides the setting of the corresponding HotGripDarkColor property. + Color scheme colors are automatically managed and are based on current system colors. + That means if colors on the system change the color scheme will ensure that it's colors + are changed as well to fit in the color scheme of target system. Set this property to + eColorSchemePart.None to + specify explicit color to use through HotGripDarkColor property. + + + + + Gets or sets the grip part light color when mouse is over the element. + + + + + Gets or sets the color scheme color that is used grip part light color when mouse is over the element. Setting + this property overrides the setting of the corresponding HotGripLightColor property. + Color scheme colors are automatically managed and are based on current system colors. + That means if colors on the system change the color scheme will ensure that it's colors + are changed as well to fit in the color scheme of target system. Set this property to + eColorSchemePart.None to + specify explicit color to use through HotGripLightColor property. + + + + + Indicates the style of mutli-functional splitter control. + + + + + Specifies Office 2003 like splitter style and color scheme. + + + + + Specifies Mozilla like splitter style and color scheme. + + + + + Specifies Office 2007 like splitter style and color scheme. + + + + + Represents event arguments for ExpandedChanging and ExpandedChanged events. + + + + + Gets the action that caused the event, event source. + + + + + Gets or sets whether execution Expand event should be canceled. Applies only to ExpandedChanging event. Default is false. + + + + + Indicates new value for the Expanded property. + + + + + Represents the Outlook like Explorer-bar Control. + + + + + Creates new instance of side bar control. + + + + + Clean up any resources being used. + + + + + Returns true if color scheme has changed. + + + + + Resets color scheme to it's default value. + + + + + Creates the Graphics object for the control. + + The Graphics object for the control. + + + + Returns the renderer control will be rendered with. + + The current renderer. + + + + Raises ItemLayoutUpdated event. + + Provides event arguments. + + + + Applies any layout changes and repaint the control. + + + + + Invokes ItemDoubleClick event. + + Reference to item double-clicked + Event arguments + + + + Returns the collection of items with the specified name. + + Item name to look for. + + + + + Returns the collection of items with the specified name and type. + + Item name to look for. + Item type to look for. + + + + + Returns the collection of items with the specified name and type. + + Item name to look for. + Item type to look for. + + + + + Returns the first item that matches specified name. + + Item name to look for. + + + + + Ensures that item is displayed on the screen. Item needs to have it's Visible property set to true. This method will expand the group if needed or it will scroll control to display an item. + + Item to display. + + + + Returns the item located at specific client coordinates. + + X Coordinate + Y Coordinate + + + + + Invokes the DotNetBar Customize dialog. + + + + + Invokes SerializeItem event. + + Provides data for the event. + + + + Invokes DeserializeItem event. + + Provides data for the event. + + + + Loads the Side bar definition from file. + + Definition file name. + + + + Saves the Side bar definition to file. + + Definition file name. + + + + Occurs when Checked property of an button has changed. + + + + + Occurs when Item is clicked. + + + + + Occurs when Item is clicked. + + + + + Occurs when popup of type container is loading. + + + + + Occurs when popup of type container is unloading. + + + + + Occurs when popup item is about to open. + + + + + Occurs when popup item is closing. + + + + + Occurs just before popup window is shown. + + + + + Occurs when Item Expanded property has changed. + + + + + Occurs when mouse button is pressed. + + + + + Occurs when mouse button is released. + + + + + Occurs when mouse enters the item. + + + + + Occurs when mouse leaves the item. + + + + + Occurs when mouse moves over the item. + + + + + Occurs when mouse remains still inside an item for an amount of time. + + + + + Occurs when item loses input focus. + + + + + Occurs when item receives input focus. + + + + + Occurs when user changes the item position, removes the item, adds new item or creates new bar. + + + + + Occurs after an Item is removed from SubItemsCollection. + + + + + Occurs after an Item has been added to the SubItemsCollection. + + + + + Occurs when ControlContainerControl is created and contained control is needed. + + + + + Occurs when Text property of an Item has changed. + + + + + Use this event if you want to serialize the hosted control state directly into the DotNetBar definition file. + + + + + Use this event if you want to deserialize the hosted control state directly from the DotNetBar definition file. + + + + + Occurs after DotNetBar definition is loaded. + + + + + Occurs before an item in option group is checked and provides opportunity to cancel that. + + + + + Occurs before tooltip for an item is shown. Sender could be the BaseItem or derived class for which tooltip is being displayed or it could be a ToolTip object itself it tooltip is not displayed for any item in particular. + + + + + Occurs after an item has been serialized to XmlElement and provides you with opportunity to add any custom data + to serialized XML. This allows you to serialize any data with the item and load it back up in DeserializeItem event. + + + To serialize custom data to XML definition control creates handle this event and use CustomXmlElement + property on SerializeItemEventArgs to add new nodes or set attributes with custom data you want saved. + + + + + Occurs after an item has been de-serialized (load) from XmlElement and provides you with opportunity to load any custom data + you have serialized during SerializeItem event. + + + To de-serialize custom data from XML definition handle this event and use CustomXmlElement + property on SerializeItemEventArgs to retrive any data you saved in SerializeItem event. + + + + + Suspends the layout and painting of the control. When you want to perform multiple operations on the explorer bar and you want to ensure + that layout of the items on it and painting is not performed for performance and appearance reasons set this property to true. Once you + want to enable layout and painting set the property back to false and call RecalcLayout method. Default value is false. + + + + + Gets or sets Bar Color Scheme. + + + + + Specifies whether ExplorerBar is drawn using Themes when running on OS that supports themes like Windows XP. + + + + + Specifies the background style of the Explorer Bar. + + + + + Gets or sets the vertical spacing between the group items. + + + + + Occurs after internal item layout has been updated and items have valid bounds assigned. + + + + + Gets or sets whether anti-alias smoothing is used while painting. + + + + + Returns the collection of Explorer Bar Groups. + + + + + Gets or sets the form ExplorerBar is attached to. + + + + + Gets or sets the margin in pixels between the explorer bar groups and the edge of the control. + + + + + Gets or sets whether end-user can rearrange the items inside the panels. + + + + + Gets or sets whether animation is enabled. + + + + + Gets or sets maximum animation time in milliseconds. + + + + + Gets or sets whether native .NET Drag and Drop is used by side-bar to perform drag and drop operations. AllowDrop must be set to true to allow drop of the items on control. + + + + + Gets or sets whether external ButtonItem object is accepted in drag and drop operation. UseNativeDragDrop must be set to true in order for this property to be effective. + + + + + Applies the stock style to the object. + + + + + Gets or sets whether gray-scale algorithm is used to create automatic gray-scale images. Default is true. + + + + + Specifies custom image to be used as button on ExplorerBarGroup item to expand the group. Default value is null + which indicates that default button is used. + + + + + Specifies custom image to be used as button on ExplorerBarGroup item to expand the group. This image is used when mouse is over the button. Default value is null + which indicates that default button is used. + + + + + Specifies custom image to be used as button on ExplorerBarGroup item to expand the group. This image is used when user presses left mouse button while cursor is positioned over the button. Default value is null + which indicates that default button is used. + + + + + Specifies custom image to be used as button on ExplorerBarGroup item to collapse the group. Default value is null + which indicates that default button is used. + + + + + Specifies custom image to be used as button on ExplorerBarGroup item to collapse the group. + This Image is used when mouse is over the button. Default value is null + which indicates that default button is used. + + + + + Specifies custom image to be used as button on ExplorerBarGroup item to collapse the group. + This Image is used when left mouse button is pressed while cursor is over the button. Default value is null + which indicates that default button is used. + + + + + ImageList for images used on Items. Images specified here will always be used on menu-items and are by default used on all Bars. + + + + + ImageList for images displayed on the Group Item. + + + + + ImageList for large-sized images used on Items. + + + + + Indicates whether Tooltips are shown on Bars and menus. + + + + + Indicates whether item shortcut is displayed in Tooltips. + + + + + Gets or sets the item default accesibility action will be performed on. + + + + + Indicates whether Reset buttons is shown that allows end-user to reset the toolbar state. + + + + + Returns the reference to the container that containing the sub-items. + + + + + Gets whether any handlers have been defined for SerializeItem event. If no handles have been defined to optimize performance SerializeItem event will not be attempted to fire. + + + + + Gets whether any handlers have been defined for DeserializeItem event. If no handles have been defined to optimize performance DeserializeItem event will not be attempted to fire. + + + + + Gets/Sets Bar definition as XML string. + + + + + Indicates whether shortucts handled by items are dispatched to the next handler or control. + + + + + Represents the method that will handle the ItemRemoved event. + + + + + Provides layout for Explorer-Bar control. + + + + + Creates new instance of ExplorerBarContainerItem class. + + + + + Returns copy of ExplorerBarContainerItem item + + + + + Recalculates the size of the item + + + + + Paints this base container + + + + + Occurs when the mouse pointer is over the item and a mouse button is pressed. This is used by internal implementation only. + + + + + Occurs when the mouse pointer is over the item and a mouse button is released. This is used by internal implementation only. + + + + + Sets input focus to next visible item in Explorer Bar. + + True if focus was set to next visible item otherwise false. + + + + Sets input focus to previous visible item in Explorer Bar. + + True if focus was set to previous visible item otherwise false. + + + + Gets or sets a value indicating whether the item is expanded or not. For Popup items this would indicate whether the item is popped up or not. + + + + + Represents the Explorer-Bar Group item. + + + + + Creates new instance of ExplorerBarGroupItem. + + + + + Creates new instance of ExplorerBarGroupItem and assigns the name to it. + + Item name. + + + + Creates new instance of ExplorerBarGroupItem and assigns the name and text to it. + + Item name. + item text. + + + + Returns copy of ExplorerBarGroupItem item. + + + + + Returns the Font object to be used for drawing the item text. + + Font object. + + + + Occurs when the mouse pointer is moved over the item. This is used by internal implementation only. + + + + + Occurs when the mouse pointer is over the item and a mouse button is pressed. This is used by internal implementation only. + + + + + Occurs when the item is clicked. This is used by internal implementation only. + + + + + Called when Visibility of the items has changed. + + New Visible state. + + + + Overloaded. Serializes the item and all sub-items into the XmlElement. + + XmlElement to serialize the item to. + + + + Overloaded. Deserializes the Item from the XmlElement. + + Source XmlElement. + + + + Shows tooltip for this item. + + + + + Forces the repaint the item. + + + + + Applies default appearance to ExplorerBarGroupItem. + + + + + Specifies whether item is drawn using Themes when running on OS that supports themes like Windows XP. + + + + + Gets or sets whether expand button is visible. + + + + + Gets or sets a value indicating whether the item is expanded or not. For Popup items this would indicate whether the item is popped up or not. + + + + + Gets or sets whether drop shadow is displayed when non-themed display is used. + + + + + Gets the reference to ElementStyle object which describes visual appearance of the explorer group item title. + + + + + Gets the reference to ElementStyle object which describes visual appearance of the explorer group item title while mouse is over the title bar. + + + + + Gets or sets the item background style. + + + + + Gets or sets whether clicking the header of the control expands the item. + + + + + Applies the stock style to the object. + + + + + Applies new visual style to this the item and all of its sub-items. + + + + + Gets or sets expand button border color. + + + + + Gets or sets expand button back color. + + + + + Gets or sets expand button fore color. + + + + + Gets or sets hot expand button border color. + + + + + Gets or sets hot expand button back color. + + + + + Gets or sets hot expand button fore color. + + + + + Gets or sets a value indicating whether the item is enabled. + + + + + Gets the rectangle of the panel item Button. + + + + + Specifies the image. + + + + + Indicates whether XP themed special group colors are used for drawing. + + + + + Gets or sets the margin in pixels between the edge of the container and the items contained inside of it. Default value is 4. + + + + + Gets or sets whether text on sub items is wrapped on new line if it cannot fit the space available. + + + + + Specifies the index of the image if ImageList is used. + + + + + Summary description for frmCustomize. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Defines the generic container item that is used by toolbar, menu bar and other control for item layout. + + + + + Occurs when new item is added to the container. + + + + + Returns copy of GenericItemContainer item + + + + + Paints this base container + + + + + Recalculate Size of this item + + + + + This must be called by child item to let the parent know that its size + has been changed. + + + + + Occurs when the mouse pointer is over the item and a mouse button is released. This is used by internal implementation only. + + + + + Called when item owner has changed. + + + + + Return Sub Item at specified location + + + + + Set/Get does container wraps item into the new line when they exceed the container size + + + + + Specifies whether to display more items on popup menu or Bar. + + + + + Gets or sets a value indicating whether the item is expanded or not. For Popup items this would indicate whether the item is popped up or not. + + + + + Gets or sets whether container is system container used internally by DotNetBar. + + + + + When parent items does recalc size for its sub-items it should query + image size and store biggest image size into this property. + + + + + Gets or sets whether item container fills the container control completely. + + + + + Summary description for Hook. + + + + + Summary description for HTMLHelp. + + + + + Interface for designer-item integration. + + + + + Describes container support for setting the word-wrap behavior of it's sub-items. + + + + + Gets or sets whether sub items text will be word wrapped if it cannot fit the space allocated. + + + + + Summary description for ItemPaintArgs. + + + + + Holds reference to all unique items in the DotNetBar. + + + + + Provides context information for serialization. + + + + + Gets or sets reference to context XmlElement an item is being serialized to. + + + + + Gets or sets whether SerializeItem event handler has been defined and whether event should be fired. + + + + + Gets or sets whether DeserializeItem event handler has been defined and whether event should be fired. + + + + + Provides access to serializer. + + + + + + + + + + Returns the renderer control will be rendered with. + + The current renderer. + + + + Represent an style for the item. + + + + + Default Constructor + + + + + Makes a copy of the ItemStyle object. + + New Instance of a ItemStyle object + + + + Paints the style. + + Graphics object + Target area + Text + Text area + Text Font + + + + Paints the style + + Graphics object + Target Area + Text + Text area + Text Font + Border Type + + + + Paints the style + + Graphics object + Target Area + + + + Paints the style text only. + + Graphics object + Text + Text area + Font + + + + Gets or sets whether text is drawn vertically by this style. + + + + + Gets or sets a background color or starting color for gradient background. + + + + + Gets or sets a background color or ending color for gradient background. + + + + + Gets or sets a text color. + + + + + Gets or sets the gradient angle. + + + + + Gets or sets the style Font + + + + + Gets or sets a value that determines whether text is displayed in multiple lines or one long line. + + + + + Specifies alignment of the text. + + + + + Specifies alignment of the text. + + + + + Specifies how to trim characters when text does not fit. + + + + + Specifies background image. + + + + + Specifies background image position when container is larger than image. + + + + + Specifies the transparency of background image. + + + + + Gets or sets the corner type. + + + + + Gets or sets the diameter in pixels of the corner type rounded or diagonal. + + + + + Gets or sets the border type. + + + + + Gets or sets dash style for single line border type. + + + + + Gets or sets the border sides that are displayed. + + + + + Gets or sets the border color. + + + + + Gets or sets the line tickness of single line border. + + + + + Gets or sets the left text margin. + + + + + Gets or sets the right text margin. + + + + + Gets or sets the top text margin. + + + + + Gets or sets the bottom text margin. + + + + + + ColorEx object that provides the transparency setting ability. + + + + + Constructor with Color Initialization. + + Color object + + + + Constructor with Color and Transparency Initialization. + + Color object + Transparency + + + + Returns the color object with the transparency set. + + Color object + + + + Gets or sets the Color object which does not include transparency. + + + + + Indicates the transparency for the color. + + + + + Specifies that color derived from system colors which is part of DotNetBar Color Scheme object is used. + Colors derived from system colors are automatically refreshed when + system colors are changed. + + + We recommend using this property to specify color rather than setting color directly. + Using colors that are derived from system colors improves uniform look of your application + and visual integration into user environment. + + + + + Returns empty ColorEx object. + + + + + Indicates whether object contain any color. + + + + + Gets or sets a background color or starting color for gradient background. + + + + + Gets or sets a background color or ending color for gradient background. + + + + + Gets or sets a text color. + + + + + Gets or sets the gradient angle. + + + + + Gets or sets the style Font + + + + + Gets or sets a value that determines whether text is displayed in multiple lines or one long line. + + + + + Specifies alignment of the text. + + + + + Specifies alignment of the text. + + + + + Specifies how to trim characters when text does not fit. + + + + + Specifies background image. + + + + + Specifies background image position when container is larger than image. + + + + + Specifies the transparency of background image. + + + + + Gets or sets the corner type. + + + + + Gets or sets the diameter in pixels of the corner type rounded or diagonal. + + + + + Gets or sets the border type. + + + + + Gets or sets dash style for single line border type. + + + + + Gets or sets the border sides that are displayed. + + + + + Gets or sets the border color. + + + + + Gets or sets the line tickness of single line border. + + + + + Gets or sets the left text margin. + + + + + Gets or sets the right text margin. + + + + + Gets or sets the top text margin. + + + + + Gets or sets the bottom text margin. + + + + + ColorEx object that provides the transparency setting ability. + + + + + Gets or sets the Color object which does not include transparency. + + + + + Indicates the transparency for the color. + + + + + Specifies that color derived from system colors which is part of DotNetBar Color Scheme object is used. + Colors derived from system colors are automatically refreshed when + system colors are changed. + + + We recommend using this property to specify color rather than setting color directly. + Using colors that are derived from system colors improves uniform look of your application + and visual integration into user environment. + + + + + Summary description for LabelItem. + + + + + Called when ImageTextSpacing property has changed. + + Old property value + New property value + + + + Gets whether property should be serialized. + + + + + Reset property to its default value. + + + + + Gets whether property should be serialized. + + + + + Gets whether property should be serialized. + + + + + Resets the SingleLineColor property to its default value. + + + + + Called when Symbol property has changed. + + Old property value + New property value + + + + Called when SymbolSet property value changes. + + Indciates old value + Indicates new value + + + + Called when SymbolSize property has changed. + + Old property value + New property value + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Occurs when text markup link is clicked. Markup links can be created using "a" tag, for example: + Markup link + + + + + Specifies spacing between label image and text. + + + + + Gets whether item supports text markup. Default is false. + + + + + Gets or sets whether text-markup support is enabled for items Text property. Default value is true. + Set this property to false to display HTML or other markup in the item instead of it being parsed as text-markup. + + + + + Gets or sets the type of the border drawn around the label. + + + + + Gets or sets the border sides that are displayed. Default value specifies border on all 4 sides. + + + + + Gets or sets the background color of the label. + + + + + Gets or sets the text color. + + + + + Gets or sets the border line color when border is single line. + + + + + Gets or sets the horizontal text alignment. + + + + + Gets or sets the text vertical alignment. + + + + + Gets or sets the label font. + + + + + Gets or sets the left padding in pixels. + + + + + Gets or sets the right padding in pixels. + + + + + Gets or sets the top padding in pixels. + + + + + Gets or sets the bottom padding in pixels. + + + + + Gets or sets the width of the label in pixels. + + + + + Gets or sets the height of the label. + + + + + Gets or sets whether the label is drawn as a divider label. + + + + + Gets or sets a value that determines whether text is displayed in multiple lines or one long line. + + + + + Indicates whether label text is rendered using bold font unless the Font property is specifically set to different font. + + + + + Gets or sets the text associated with this item. + + + + + Specifies the label icon. Icons support alpha blending. + + + + + Specifies label image. + + + + + Specifies the index of the image for the label if ImageList is used. + + + + + Gets/Sets the image position inside the label. + + + + + Gets or sets text-orientation. Default is horizontal. + + + + + Gets or sets how vertical text is rotated when TextOrientation = Vertical. + + + + + Gets the realized symbol string. + + + + + Indicates the symbol displayed on label instead of the image. Setting the symbol overrides the image setting. + + + + + Gets or sets the symbol set used to represent the Symbol. + + + + + Indicates the size of the symbol in points. + + + + + Gets or sets the color of the symbol. + + + + + Gets or sets whether label hosted in multi-line ItemContainer triggers new line switch after label is processed. + + + + + Contains static keys that are used to discover localized text for internal controls. + + + + + Navigation Pane collapse button tooltip text. + + + + + Navigation Pane expand button tooltip text. + + + + + Bar auto-hide button tooltip text. + + + + + Bar customize button tooltip text. + + + + + Bar close button tooltip text. + + + + + Bar maximize button tooltip text. + + + + + CustomizeItem tooltip text. + + + + + CustomizeItem Add/Remove text. + + + + + CustomizeItem text for button that opens Customize dialog. + + + + + CustomizeItem text for Reset command. + + + + + Tooltip text for system button that displays overflow items. + + + + + Text for Customize Dialog caption. + + + + + Text for Customize Dialog toolbars tab. + + + + + Text for Customize Dialog commands tab. + + + + + Text for Customize Dialog options tab. + + + + + Text for Customize Dialog keyboard button. + + + + + Text for Customize Dialog close button. + + + + + Text for Customize Dialog new toolbar button. + + + + + Text for Customize Dialog rename toolbar button. + + + + + Text for Customize Dialog delete toolbar button. + + + + + Text for Customize Dialog reset toolbar button. + + + + + Text for Customize Dialog label that gives following instructions to user: + To add a command to Bar select the category and drag the command out of this box to a Bar. + + + + + Text for Customize Dialog categories label. + + + + + Text for Customize Dialog toolbars label. + + + + + Text for Customize Dialog options tab Personalized Menus and Toolbars label. + + + + + Text for Customize Dialog options tab Aways show full menus check box. + + + + + Text for Customize Dialog options tab Show full menus after a short delay check box. + + + + + Text for Customize Dialog options tab 'Reset my usage data' command. + + + + + Text for Customize Dialog options tab 'Other' labe. + + + + + + + Text for Customize Dialog options tab 'Menu Animation:' label. + + + + + Text for Customize Dialog options tab Menu Animation combo box None option. + + + + + Text for Customize Dialog options tab Menu Animation combo box System Default option. + + + + + Text for Customize Dialog options tab Menu Animation combo box Random option. + + + + + Text for Customize Dialog options tab Menu Animation combo box Unfold option. + + + + + Text for Customize Dialog options tab Menu Animation combo box Slide option. + + + + + Text for Customize Dialog Confirm delete of bar message box. + + + + + Text for Reset command on customize item context menu. + + + + + Text for Delete item command on customize item context menu. + + + + + Text for Change Name item command on customize item context menu. + + + + + Text for Default Style item command on customize item context menu. + + + + + Text for Text Only item command on customize item context menu. + + + + + Text for Image And Text item command on customize item context menu. + + + + + Text for Begin Group item command on customize item context menu. + + + + + Text MdiSystemItem Minimize button. + + + + + Text MdiSystemItem Restore button. + + + + + Text MdiSystemItem Close button. + + + + + Text MdiSystemItem menu Restore command. + + + + + Text MdiSystemItem menu Move command. + + + + + Text MdiSystemItem menu Size command. + + + + + Text MdiSystemItem menu Minimize command. + + + + + Text MdiSystemItem menu Maximize command. + + + + + Text MdiSystemItem menu Close command. + + + + + Text MdiSystemItem menu Next command. + + + + + Text Navigation Bar Show More Buttons menu item. + + + + + Text Navigation Bar Show Fewer Buttons menu item. + + + + + Text Navigation Bar Options menu item. + + + + + Text for Move Up button on Navigation Bar Options dialog box. + + + + + Text for Move Down button on Navigation Bar Options dialog box. + + + + + Text for Reset button on Navigation Bar Options dialog box. + + + + + Text for OK button on Navigation Bar Options dialog box. + + + + + Text for Cancel button on Navigation Bar Options dialog box. + + + + + Text for Navigation Bar Options dialog box title. + + + + + Text for Navigation Bar Options label which is displayed above the list box which lists all the controls. + + + + + Text for Rename Toolbar dialog caption. + + + + + Text for New Toolbar dialog caption. + + + + + Text for Bar Name label on Bar edit dialog (either rename or new). + + + + + Text for OK Button on Bar edit dialog (either rename or new). + + + + + Text for Cancel Button on Bar edit dialog (either rename or new). + + + + + Text for Invalid Name Message on Bar edit dialog (either rename or new). + + + + + Text displayed on Color Picker drop down Theme Colors label. + + + + + Text displayed on Color Picker drop down Standard Colors label. + + + + + Text displayed on Color Picker drop down more colors menu item. + + + + + Text for the OK Button on Color Picker dialog. + + + + + Text for the Cancel Button on Color Picker dialog. + + + + + Text for the new color label on Color Picker dialog. + + + + + Text for the current color label on Color Picker dialog. + + + + + Text for the colors label on the standard colors tab. + + + + + Text for the colors label on the custom colors tab. + + + + + Text for the green component label on the custom colors tab. + + + + + Text for the blue component label on the custom colors tab. + + + + + Text for the red component label on the custom colors tab. + + + + + Text for the Color Model label on the custom colors tab. + + + + + Text for the RGB combo box item choice on the custom colors tab. + + + + + Text for the Standard tab on color picker dialog. + + + + + Text for the Custom tab on color picker dialog. + + + + + Text for the Custom tab on color picker dialog. + + + + + Text for the Custom tab on color picker dialog. + + + + + Indicates the text for Today button displayed on the MonthCalendarItem control. + + + + + Indicates the text for Clear button displayed on the MonthCalendarItem control. + + + + + Indicates the text for MessageBoxEx Abort button. + + + + + Indicates the text for MessageBoxEx Cancel button. + + + + + Indicates the text for MessageBoxEx Close button. + + + + + Indicates the text for MessageBoxEx Continue button. + + + + + Indicates the text for MessageBoxEx Help button. + + + + + Indicates the text for MessageBoxEx Ignore button. + + + + + Indicates the text for MessageBoxEx No button. + + + + + Indicates the text for MessageBoxEx OK button. + + + + + Indicates the text for MessageBoxEx Retry button. + + + + + Indicates the text for MessageBoxEx Try Again button. + + + + + Indicates the text for MessageBoxEx Yes button. + + + + + Identifies Form system menu Restore item. + + + + + Identifies Form system menu Move item. + + + + + Identifies Form system menu Size item. + + + + + Identifies Form system menu Minimize item. + + + + + Identifies Form system menu Maximize item. + + + + + Identifies Form system menu Close item. + + + + + Identifies Time Selector OK button. + + + + + Identifies Time Selector Clear button. + + + + + Identifies Time Selector Hour Label. + + + + + Identifies Time Selector Minute Label. + + + + + Identifies 'Show all' Filter Expression label. + + + + + Identifies 'Show null' Filter Expression label. + + + + + Identifies 'Show not null' Filter Expression label. + + + + + Identifies 'Custom' Filter Expression label. + + + + + Identifies 'Enter expression' Filter text. + + + + + Identifies 'Apply' Filter Expression button label. + + + + + Identifies 'Apply' Filter Expression button label. + + + + + Identifies 'Apply' Filter Expression button label. + + + + + Identifies 'Ok' Filter Expression button label. + + + + + Identifies 'Cancel' Filter Expression button label. + + + + + Identifies 'Close' Filter Expression button label. + + + + + Identifies 'Clear' Filter Expression button label. + + + + + Identifies 'Clear' Filter Expression button label. + + + + + Identifies Filter DateTimePicked dialog 'Filter by relative date' text. + + + + + Identifies Filter DateTimePicker dialog 'Filter by specific date' text. + + + + + Identifies Filter DateTimePicker dialog 'Filter by date range' text. + + + + + Identifies Filter DateTimePicker dialog, ByRelativeDate combo entry 'Current Month' text. + + + + + Identifies Filter DateTimePicker dialog, ByRelativeDate combo entry 'Current Year' text. + + + + + Identifies Filter DateTimePicker dialog, ByRelativeDate combo entry 'Last Month Period' text. + + + + + Identifies Filter DateTimePicker dialog, ByRelativeDate combo entry 'Last 3 Month Period' text. + + + + + Identifies Filter DateTimePicker dialog, ByRelativeDate combo entry 'Last 6 Month Period' text. + + + + + Identifies Filter DateTimePicker dialog, ByRelativeDate combo entry 'Last 9 Month Period' text. + + + + + Identifies Filter DateTimePicker dialog, ByRelativeDate combo entry 'Last Year' text. + + + + + Identifies Filter DateTimePicker dialog, ByRelativeDate combo entry 'Last 5 Year Period' text. + + + + + Identifies Filter DateTimePicker dialog, ByRelativeDate combo entry 'Last 10 Year Period' text. + + + + + Identifies Filter expression evaluation error 'Expression error' text. + + + + + Identifies Filter expression evaluation error 'Missing parenthesis' text. + + + + + Identifies Filter expression evaluation error 'Missing quote' text. + + + + + Identifies Filter expression evaluation error 'Invalid number of arguments' text. + + + + + Identifies Filter expression evaluation error 'Invalid argument' text. + + + + + Identifies Filter expression evaluation error 'Invalid 'Empty' operation' text. + + + + + Identifies Filter expression evaluation error 'Invalid DateTime operation' text. + + + + + Identifies Filter expression evaluation error 'Invalid bool operation' text. + + + + + Identifies Filter expression evaluation error 'Invalid string operation' text. + + + + + Identifies Filter expression evaluation error 'Invalid numeric operation' text. + + + + + Identifies Filter expression evaluation error 'Invalid logical evaluation' text. + + + + + Identifies Filter expression evaluation error 'Undefined User function' text. + + + + + Identifies custom filter dialog title 'Custom Filter' text. + + + + + Identifies custom filter dialog 'New Filter' text. + + + + + Identifies custom filter dialog 'New' button text. + + + + + Identifies custom filter dialog 'Delete' button text. + + + + + Identifies custom filter dialog 'Filter Name' text. + + + + + Identifies custom filter dialog 'Description' text. + + + + + Identifies custom filter dialog 'Show in FilterPopup' text. + + + + + Identifies custom filter dialog title 'Custom Filter' text. + + + + + Identifies the default GroupBy WaterMarkText. + + + + + Occurs when DotNetBar is looking for translated text for one of the internal text that are + displayed on menus, toolbars and customize forms. You need to set Handled=true if you want + your custom text to be used instead of the built-in system value. + + + + + Represents an item that displays log information in list container. + + + + + Initializes a new instance of the LogItem class. + + + + + + Creates new instance of LogItem and assigns the name to it. + + Item name. + + + + Creates new instance of LogItem and assigns the name and text to it. + + Item name. + item text. + + + + Returns copy of the item. + + + + + Copies the ButtonItem specific properties to new instance of the item. + + New ButtonItem instance. + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Occurs when text markup link is clicked. Markup links can be created using "a" tag, for example: + Markup link + + + + + Gets or sets the color of the control text body. + + + + + Gets or sets the color of the header text. + + + + + Gets or sets the image displayed on the log item. + + + + + Gets or sets the image position in relation to text. + + + + + Gets or sets the background color of the item. + + + + + Gets whether item supports text markup. Default is false. + + + + + Summary description for MdiWindowListItem. + + + + + Initializes the item and connects it to the MDI form so it can process the events. You should not call this method directly since this process is + automatically managed by the item. + + + + + Initializes the item and connects it to the MDI form so it can process the events. You should not call this method directly since this process is + automatically managed by the item. + + + + + Refresh the MDI Child form Icons that are displayed on window list items. + + + + + Gets or sets whether the MDI Child Window Icons are displayed on items. + + + + + Gets or sets maximum form caption length that will be displayed on each item. If caption length exceeds given value ... characters are added. + + + + + Gets whether item has been connected to the MDI form so it can process its events. + + + + + Gets or sets whether flicker associated with switching maximized Mdi child forms is attempted to eliminate. You should set this property to false if you encounter any painting problems with your Mdi child forms. + + + + + Gets or sets whether numbered access keys are created for MDI Child window menu items for first 9 items. Access keys will start with number 1 and go through 9. Default value is false + which indicates that access keys are not created. + + + + + Summary description for PopupWindow. + + + + + Return Sub Item at specified location + + + + + Gets or sets whether Key Tips (accelerator keys) for items are displayed on top of them. + + + + + Gets or sets the font that is used to display Key Tips (accelerator keys) when they are displayed. Default value is null which means + that control Font is used for Key Tips display. + + + + + Gets or sets the item default accessibility action will be performed on. + + + + + Gets or sets whether anti-alias smoothing is used while painting. Default value is false. + + + + + Indicates whether Tooltips are shown on Bars and menus. + + + + + Sets,Gets the side bar image structure. + + + + + Gets or sets the HotSubItem on the menu. This method is used internally by DotNetBar and should not be used in your application. + + + + + Summary description for MessageHandler. + + + + + Summary description for NativeFunctions. + + + + + For use with ChildWindowFromPointEx + + + + + Does not skip any child windows + + + + + Skips invisible child windows + + + + + Skips disabled child windows + + + + + Skips transparent child windows + + + + + Represents Outlook 2003 like Navigation Bar. + + + + + Default constructor. + + + + + Applies design-time defaults to control. + + + + + Increases the size of the navigation bar if possible by showing more buttons on the top. + + + + + Reduces the size of the navigation bar if possible by showing fewer buttons on the top. + + + + + Saves current visual layout of navigation bar control to XML based file. + + File name to save layout to. + + + + Saves current visual layout of navigation bar control to XmlElement. + + XmlElement object that will act as a parent for the layout definition. Exact same element should be passed into the LoadLayout method to load the layout. + + + + Loads navigation bar layout that was saved using SaveLayout method. Note that this method must be called after all items are created and added to the control. + + File to load layout from. + + + + Loads navigation bar layout that was saved using SaveLayout method. Note that this method must be called after all items are created and added to the control. + + Parent XML element that is used to load layout from. Note that this must be the same element that was passed into the SaveLayout method. + + + + Occurs after Options dialog which is used to customize control's content has closed by user using OK button. + + + + + Returns collection of items on a bar. + + + + + Gets or sets whether Configure Buttons button is visible. + + + + + Gets or sets whether Show More Buttons and Show Fewer Buttons menu items are visible on Configure buttons menu. + + + + + Gets or sets whether Navigation Pane Options menu item is visible on Configure buttons menu. + + + + + Gets or sets whether Navigation Pane Add/Remove Buttons menu item is visible on Configure buttons menu. + + + + + Gets or sets whether summary line is visible. + + + + + Gets or sets the padding in pixels at the top portion of the item. Height of each item will be increased by padding amount. + + + + + Gets or sets the padding in pixels for bottom portion of the item. Height of each item will be increased by padding amount. + + + + + Returns items container. + + + + + Returns reference to currently checked button. + + + + + Gets or sets whether images are automatically resized to size specified in ImageSizeSummaryLine when button is on the bottom summary line of navigation bar. + + + + + Gets or sets size of the image that will be use to resize images to when button button is on the bottom summary line of navigation bar and AutoSizeButtonImage=true. + + + + + Gets or sets the navigation bar definition string. + + + + + Gets/Sets the visual style for items and color scheme. + + + + + Indicates whether splitter on top of the navigation bar is visible. When activated splitter will let user change the height of the + control to show fewer or more buttons. It is recommended to have navigation bar docked to bottom (Dock=Bottom) to maintain + proper layout. + + + + + Container control for Navigation Bar. + + + + + Creates new instance of NavigationBarContainer. + + + + + Creates new instance of SideBarPanelItem and assigns the name to it. + + Item name. + + + + Creates new instance of SideBarPanelItem and assigns the name and text to it. + + Item name. + item text. + + + + Returns copy of SideBarPanelItem item. + + + + + Recalculates size of this container. + + + + + Increases the size of the navigation bar if possible by showing more buttons on the top. + + + + + Reduces the size of the navigation bar if possible by showing fewer buttons on the top. + + + + + Must be called by any sub item that implements the image when image has changed + + + + + Occurs after an item has been added to the container. This procedure is called on both item being added and the parent of the item. To distinguish between those two states check the item parameter. + + When occurring on the parent this will hold the reference to the item that has been added. When occurring on the item being added this will be null (Nothing). + + + + Occurs after an item has been removed. + + Item being removed. + + + + Returns index of the first item that is displayed in summary line or -1 if there is no item displayed in summary line. + + + + + Gets or sets a value indicating whether the item is expanded or not. For Popup items this would indicate whether the item is popped up or not. + + + + + Gets or sets whether Configure Buttons button is visible. + + + + + Gets or sets whether Show More Buttons and Show Fewer Buttons menu items are visible on Configure buttons menu. + + + + + Gets or sets whether Navigation Pane Options menu item is visible on Configure buttons menu. + + + + + Gets or sets whether Navigation Pane Add/Remove Buttons menu item is visible on Configure buttons menu. + + + + + Gets or sets the padding in pixels at the top portion of the item. Height of each item will be increased by padding amount. + + + + + Gets or sets the padding in pixels for bottom portion of the item. Height of each item will be increased by padding amount. + + + + + Gets or sets whether images are automatically resized to size specified in ImageSizeSummaryLine when button is on the bottom summary line of navigation bar. + + + + + Gets or sets size of the image that will be use to resize images to when button button is on the bottom summary line of navigation bar and AutoSizeButtonImage=true. + + + + + Gets or sets whether summary line is visible. + + + + + Delegate for OptionGroupChanging event. + + + + + Delegate for PanelPopup events. + + + + + Represents Outlook 2003 style navigation pane control. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + + + + Applies any layout changes and repaint the control. + + + + + Returns Panel associated with button on navigation bar or null if panel cannot be found. + + Button on navigation bar. + + + + + Suspends normal layout logic. + + + + + Resumes normal layout logic. Optionally forces an immediate layout of pending layout requests. + + + + + Increases the size of the navigation bar if possible by showing more buttons on the top. + + + + + Reduces the size of the navigation bar if possible by showing fewer buttons on the top. + + + + + Saves current visual layout of navigation bar control to XML based file. + + File name to save layout to. + + + + Saves current visual layout of navigation bar control to XmlElement. + + XmlElement object that will act as a parent for the layout definition. Exact same element should be passed into the LoadLayout method to load the layout. + + + + Popup selected pane when control is collapsed. When control is collapsed (Expanded=false) currently selected pane is not visible + calling this method will popup selected pane and allow user access to it. Use PopupPaneVisible property + to check whether currently selected pane is displayed as popup. + + + + + Hides popup selected pane when control is collapsed and selected pane is displayed as popup. When control is collapsed (Expanded=false) + currently selected pane can be displayed as popup. Calling this method will hide the popup pane. Use PopupPaneVisible property + to check whether currently selected pane is displayed as popup. + + + + + Raises the PanelPopupClosed event. + + Provides event arguments. + + + + Loads navigation bar layout that was saved using SaveLayout method. Note that this method must be called after all items are created and added to the control. + + File to load layout from. + + + + Loads navigation bar layout that was saved using SaveLayout method. Note that this method must be called after all items are created and added to the control. + + Parent XML element that is used to load layout from. Note that this must be the same element that was passed into the SaveLayout method. + + + + Called by StyleManager to notify control that style on manager has changed and that control should refresh its appearance if + its style is controlled by StyleManager. + + New active style. + + + + Updates the color scheme on child panels to reflect the style of the NavigationBar control. Calling this method is necessary only if you manually + change the NavigationBar.ColorScheme property. + + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Occurs when Item is clicked. + + + + + Occurs when currently selected panel is about to change. + + + + + Occurs when control is looking for translated text for one of the internal text that are + displayed on menus, toolbars and customize forms. You need to set Handled=true if you want + your custom text to be used instead of the built-in system value. + + + + + Occurs before panel is displayed on popup when control is collapsed. You can use this event to modify default + size of the popup panel or cancel the popup of the panel. + + + + + Occurs after panel is displayed on popup. + + + + + Occurs after panel displayed on popup is closed. + + + + + Occurs before Expanded property is changed. You can cancel change of this property by setting Cancel=true on the event arguments. + + + + + Occurs after Expanded property has changed. You can handle ExpandedChanging event and have opportunity to cancel the change. + + + + + Occurs after Options dialog which is used to customize control's content has closed by user using OK button. + + + + + Returns the width of the expanded control if control is currently collapsed. + + + + + Returns collection containing buttons on navigation bar. + + + + + Gets or sets the height of the navigation bar part of the navigation pane control. + Navigation Bar height is automatically calculated based on the content. + Setting this property suggests desired height of the navigation bar but the actual height will be + calculated to ensure that complete buttons are visible so suggested and actual height might differ. + + + + + Returns reference to internal NavigationBar control. + + + + + Gets or sets size of the image that will be use to resize images to when button button is on the bottom summary line of navigation bar and AutoSizeButtonImage=true. + + + + + Gets or sets whether Configure Buttons button is visible. + + + + + Gets or sets whether Show More Buttons and Show Fewer Buttons menu items are visible on Configure buttons menu. + + + + + Gets or sets whether Navigation Pane Options menu item is visible on Configure buttons menu. + + + + + Gets or sets whether Navigation Pane Add/Remove Buttons menu item is visible on Configure buttons menu. + + + + + Returns reference to currently checked button. + + + + + Returns reference to currently selected panel. Panels are automatically switched when buttons are checked. + + + + + ImageList for images used on Items. + + + + + Returns reference to the PanelEx that is used to display title. + + + + + Gets or sets the padding in pixels at the top portion of the item. Height of each item will be increased by padding amount. + + + + + Gets or sets the padding in pixels for bottom portion of the item. Height of each item will be increased by padding amount. + + + + + Gets or sets whether images are automatically resized to size specified in ImageSizeSummaryLine when button is on the bottom summary line of navigation bar. + + + + + Gets or sets the navigation bar definition string. + + + + + Gets or sets whether anti-alias smoothing is used while painting. Default value is false. + + + + + Gets or sets animation time in milliseconds when control is expanded or collapsed. Default value is 100 miliseconds. You can set this to 0 (zero) to disable animation. + + + + + Gets or sets whether navigation pane can be collapsed. Default value is false. When set to true + expand/collapse button will be displayed in title so control can be reduced in size. + + + + + Gets or sets alignment of the expand button inside of title bar. + + + + + Gets or sets whether navigation pane is expanded. Default value is true. + When control is collapsed it is reduced in size so it consumes less space. + + + + + Gets the reference to the inner panel displaying Navigation Pane vertical text created when control is collapsed. + + + + + Gets or sets whether selected pane is displayed as popup when control is collapsed (Expanded=false). Using + navigation pane button that is displayed when control is collapsed user can popup or close currently selected pane without + expanding the control. You can use this property to do same from code as well as check whether selected pane is displayed as + popup. Note that control must be collapsed (Expanded=false) in order for this property to have any effect. + + + + + Gets/Sets the visual style for the control. Default style is Office 2003. + + + + + Represents event arguments for PanelChanging event. + + + + + Set to true to cancel changing of the panel. + + + + + Panel that will be selected if operation is not cancelled. + + + + + Panel that is currently selected and which will be de-selected if operation is not cancelled. + + + + + Default constructor. + + + + + Represents event arguments for BeforePanelPopup event. + + + + + Set to true to cancel popup of the panel. + + + + + Size and position of popup. You can modify this memeber to affect size and position of popup. + + + + + Default constructor. + + + + + Represents Panel on Navigation Pane control. + + + + + Gets or sets button associated with the pane on the panel when hosted on NavigationPane control. + + + + + Summary description for NavPaneOptions. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Updates position of the title bar button to reflect any changes to the button that influence size of the button. + + + + + Occurs when Expanded/Collapse button is clicked. + + + + + Gets or sets whether expand button is visible or not. Default value is true. + + + + + Gets or sets alignment of the button. + + + + + Gets or sets whether text markup if it occupies less space than control provides uses the Style Alignment and LineAlignment properties to align the markup inside of the control. Default value is true. + + + + + Use as a popup container for DotNetBar objects. + + + + + Summary description for PopupContainer. + + + + + Summary description for PopupShadow. + + + + + Represents a progress bar item. + + + + + Creates new instance of ProgressBarItem. + + + + + Creates new instance of ProgressBarItem and assigns the name to it. + + Item name. + + + + Creates new instance of ProgressBarItem and assigns the name and text to it. + + Item name. + item text. + + + + Returns copy of the item. + + + + + Copies the ProgressBarItem specific properties to new instance of the item. + + New ProgressBarItem instance. + + + + Copies the ProgressBarItem specific properties to new instance of the item. + + New ProgressBarItem instance. + + + + Overriden. Draws the item. + + Target Graphics object. + + + + Overriden. Recalculates the size of the item. + + + + + Resets style to default value. Used by windows forms designer. + + + + + Advances the current position of the progress bar by the amount of the Step property. + + + + + Advances the current position of the progress bar by the specified amount. + + The amount by which to increment the progress bar's current position. + + + + Gets whether ChunkColor property should be serialized. + + + + + Resets the ChunkColor property to its default value. + + + + + Gets whether ChunkColor property should be serialized. + + + + + Resets the ChunkColor property to its default value. + + + + + Overloaded. Deserializes the Item from the XmlElement. + + Source XmlElement. + + + + Overloaded. Serializes the item and all sub-items into the XmlElement. + + XmlElement to serialize the item to. + + + + Gets or sets the item background style. + + + + + Specifies the background style of the item. + + + + + Gets or sets the maximum value of the range of the control. + + + + + Gets or sets the minimum value of the range of the control. + + + + + Gets or sets the current position of the progress bar. + + + + + Gets or sets the amount by which a call to the PerformStep method increases the current position of the progress bar. + + + + + Gets or sets whether the text inside the progress bar is displayed. + + + + + Gets or sets the width of the item in pixels. 0 value indicates the auto-sizing item based on the text contained in it. + + + + + Gets or sets the height of the label. 0 value indicates the auto-sizing item based on the text height. + + + + + Gets or sets the color of the progress chunk. + + + + + Gets or sets the target gradient color of the progress chunk. + + + + + Gets or sets the gradient angle of the progress chunk. + + + + + Indicates item's visiblity when on pop-up menu. + + + + + Indicates whether item was recently used. + + + + + Gets or sets the type of progress bar used to indicate progress. The Standard style displays the progress based on Minimum, Maximum and current Value. + The Marquee type is automatically moving progress bar that is used to indicate an ongoing operation for which the actual duration cannot be estimated. + + + + + Gets or sets the marquee animation speed in milliseconds. + + + + + Gets or sets the predefined color state table for progress bar. Color specified applies to items with Office 2007 style only. It does not have + any effect on other styles. You can use ColorTable to indicate the state of the operation that Progress Bar is tracking. Default value is eProgressBarItemColor.Normal. + + + + + Summary description for RemindForm. + + + + + Clean up any resources being used. + + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Represents color table for Bar objects in various states. + + + + + Gets or sets the colors for top part of toolbar background. + + + + + Gets or sets the colors for bottom part of toolbar background. + + + + + Gets or sets the color of the bottom border. + + + + + Gets or sets the popup toolbar background color. + + + + + Gets or sets the color of popup toolbar border. + + + + + Gets or sets the status bar top border color. + + + + + Gets or sets the status bar top border light color. + + + + + Gets or sets the alternative background colors for the status bar. + + + + + Represents color table for ButtonItem object. + + + + + Gets or sets the name of the color table. + + + + + Gets or sets the color table applied for button in default state. + + + + + Gets or sets the color table applied when mouse is over the button. + + + + + Gets or sets the color table applied when mouse is over the buttons inactive split part. Applies to split button appearance only. + + + + + Gets or sets the color table applied when mouse is pressed over the button. + + + + + Gets or sets the color table applied when mouse is pressed over the button. + + + + + Gets or sets the color table applied when button is expanded. + + + + + Gets or sets the color table applied when cursor is over button on a menu. + + + + + Represents typed collection of Office2007ButtonItemColorTable type. + + + + Creates new instance of the class. + + + + Adds new object to the collection. + + Object to add. + Index of newly added object. + + + + Inserts new object into the collection. + + Position of the object. + Object to insert. + + + + Returns index of the object inside of the collection. + + Reference to the object. + Index of the object. + + + + Returns whether collection contains specified object. + + Object to look for. + true if object is part of the collection, otherwise false. + + + + Returns whether collection contains object with specified name. + + Name of the object to look for + true if object with given name is part of the collection otherwise false + + + + Removes specified object from the collection. + + + + + + Copies collection into the specified array. + + Array to copy collection to. + Starting index. + + + + Copies contained items to the Office2007ButtonItemColorTable array. + + Array to copy to. + + + + Returns reference to the object in collection based on it's index. + + + + + Returns reference to the object in collection based on it's index. + + + + + Represents a color table for ButtonItem in certain state like but not limited to mouse over, checked or pressed. + + + + + Gets or sets the outer border colors. + + + + + Gets or sets the outer border width. Default is 1. + + + + + Gets or sets the inner border colors. + + + + + Gets or sets top part background colors. + + + + + Gets or sets highlight colors for the top background part. + + + + + Gets or sets bottom part background colors. + + + + + Gets or sets highlight colors for the bottom background part. + + + + + Gets or sets the split border colors that divides button text and image from expand part of the button. + + + + + Gets or sets the split border light colors that divides button text and image from expand part of the button. + + + + + Gets or sets the text color. + + + + + Gets or sets the background color of the expand sign. + + + + + Gets or sets the outline light color of the expand sign. + + + + + Gets or sets the single gradient background for the button. When specified it is used instead of TopBackground and BottomBackground for rendering. + + + + + Represent the color table for the CheckBoxItem. + + + + + Gets or sets the colors for the item in default state. + + + + + Gets or sets the colors for the item when mouse is over the item. + + + + + Gets or sets the colors for the item when mouse is pressed over the item. + + + + + Gets or sets the colors for the item when item is disabled. + + + + + Defines the colors for the single CheckBoxItem state. + + + + + Gets or sets the background colors of the check box. + + + + + Gets or sets the color of the check border. + + + + + Gets or sets the inner color of check box border. + + + + + Gets or sets the inner background color of check box. + + + + + Gets or sets the color of the check sign that is drawn when item is checked. + + + + + Gets or sets the text color. + + + + + Defines color table for ColorItem. + + + + + Gets or sets the border that is drawn around each individual color item or color item group. + + + + + Gets or sets the inner mouse over color. + + + + + Gets or sets the outer mouse over color. + + + + + Represents the painter for ColorItem in Office 2007 style + + + + + Gets or sets color table used by renderer. + + + + + Defines the color scheme type for the Office2007ColorTable. + + + + + Blue color scheme. + + + + + Black color scheme. + + + + + Silver color scheme. + + + + + Windows Vista Glass inspired color scheme. + + + + + Defines the delegate which retrieves the color for specific integer value. + + color represented as integer. + Reference to Color object. + + + + Defines contextual label colors. + + + + + Initializes a new instance of the LabelColors structure. + + + + + + + Initializes ColorScheme object with the black color scheme. + + ColorScheme object to initialize. + + + + Defines the color table for the combo box. + + + + + Gets or sets the color for combo box in default state. + + + + + Gets or sets the color for standalone combo box in default state. Standalone combo box is a control not used by ComboBoxItem. + + + + + Gets or sets the colors when mouse is over the control. + + + + + Gets or sets the colors when control is dropped down. + + + + + Defines the combo box colors for a particular state. + + + + + Gets or sets the border color. + + + + + Gets or sets the background color. + + + + + Gets or sets the outer expand button border. + + + + + Gets or sets the inner expand button border. + + + + + Gets or sets the background color of the expand button. + + + + + Gets or sets the foreground color of the expand button. + + + + + Defines color table for the Office 2007 style DataGridView control. + + + + + Gets or sets grid background color. + + + + + Gets or sets default cell color. + + + + + Gets or sets default cell text color. + + + + + Gets or sets the background color for the column headers in normal state. + + + + + Gets or sets the normal column text color. + + + + + Gets or sets the column header border color. + + + + + Gets or sets the background color for the column headers in mouse over state. + + + + + Gets or sets the column header border color when mouse is over the column. + + + + + Gets or sets the selected column header text color. + + + + + Gets or sets the background color for the column headers in selected state. + + + + + Gets or sets the border color for the column headers in selected state. + + + + + Gets or sets the background color for the column headers in selected mouse over state. + + + + + Gets or sets the border color for the column headers in selected mouse over state. + + + + + Gets or sets the background color for the column headers in pressed state. + + + + + Gets or sets the border color for the column headers in pressed state. + + + + + Gets or sets the column header foreground color. + + + + + Gets or sets the background color for row marker background. + + + + + Gets or sets the border color for row marker. + + + + + Gets or sets the background color for row marker background. + + + + + Gets or sets the border color for row marker. + + + + + Gets or sets the background color for row marker background. + + + + + Gets or sets the border color for row marker. + + + + + Gets or sets the background color for row marker background. + + + + + Gets or sets the border color for row marker. + + + + + Gets or sets the background color for row marker background. + + + + + Gets or sets the border color for row marker. + + + + + Gets or sets the color of the grid lines. + + + + + Gets or sets the background color of selector cell usually located in top-left corner. + + + + + Gets or sets the border color of selector cell usually located in top-left corner. + + + + + Gets or sets the light border color of selector cell usually located in top-left corner. + + + + + Gets or sets the dark border color of selector cell usually located in top-left corner. + + + + + Gets or sets the sign color of selector cell usually located in top-left corner. + + + + + Gets or sets the background color of selector cell usually located in top-left corner. + + + + + Gets or sets the border color of selector cell usually located in top-left corner. + + + + + Gets or sets the light border color of selector cell usually located in top-left corner. + + + + + Gets or sets the dark border color of selector cell usually located in top-left corner. + + + + + Gets or sets the sign color of selector cell usually located in top-left corner. + + + + + Defines color table for the Dialog Launcher button. + + + + + Gets or sets the colors for the default state. + + + + + Gets or sets the colors for the mouse over state. + + + + + Gets or sets the colors for the pressed state. + + + + + Defines the color table for dialog launcher state. + + + + + Gets or sets the color of dialog launcher symbol. + + + + + Gets or sets the shade color of dialog launcher symbol. + + + + + Gets or sets the background color for the top part of the element. + + + + + Gets or sets the background color for the bottom part of the element. + + + + + Gets or sets the outer border colors. + + + + + Gets or sets the inner border colors. + + + + + Defines the color table for all states of Office 2007 style form caption. + + + + + Gets or sets the color table for caption in active state. + + + + + Gets or sets the color table for caption in inactive state. + + + + + Gets or sets the background color of the form. + + + + + Gets or sets the text color of the form. + + + + + Gets or sets the MDI Client Background image. + + + + + Defines color table for the Office 2007 style Form caption color state. + + + + + Gets or sets the colors for the top part of the background. + + + + + Gets or sets the colors for the bottom part of the background. + + + + + Gets or sets the array of colors used to draw the border that separates the form caption and the form content. Applies only to the Office2007Form rendering. + + + + + Gets or sets the color of caption text. + + + + + Gets or sets the color of caption extra text that is appended to the caption. + + + + + Gets or sets the array of colors that represents the border colors. Outer border is at index 0. + + + + + Represents the color table used by the Gallery container. + + + + + Gets or sets the background color of the Gallery Group label when gallery is displayed on popup. + + + + + Gets or sets the text color of the Gallery Group label when gallery is displayed on popup. + + + + + Gets or sets the border color of the Gallery Group label when gallery is displayed on popup. + + + + + Represents color table for ItemContainer object with BeginGroup set to true. + + + + + Gets or sets the outer border colors. + + + + + Gets or sets the inner border colors. + + + + + Gets or sets the top background colors. + + + + + Gets or sets the bottom background colors. + + + + + Gets or sets the dark color of item devider for items inside of the ItemContainer. + + + + + Gets or sets the light color of item devider for items inside of the ItemContainer. + + + + + Represents the color table for key tips. + + + + + Gets or sets KeyTip Text color. + + + + + Gets or sets KeyTip border color. + + + + + Gets or sets KeyTip Background color. + + + + + Represents color table for ListViewEx control. + + + + + Gets or sets the background color of the columns. + + + + + Gets or sets the color of the column separator. + + + + + Gets or sets the color of the column text. + + + + + Gets or sets the color of the control border. + + + + + Gets or sets the background colors for the selected item. + + + + + Gets or sets the color of the selected item border that is draw on top and bottom of the selection. + + + + + Gets or sets the text color for selected item. + + + + + Defines the color table for the menus. + + + + + Gets or sets the menu background colors. + + + + + Gets or sets the menu side background colors. + + + + + Gets or sets the menu side background colors for the items that were not recently used. + + + + + Gets or sets the menu border background colors. + + + + + Gets or sets the menu side border. + + + + + Gets or sets the light menu side border. + + + + + Gets or sets the background color blend for the special file menu background. + + + + + Gets or sets the two column container border color. + + + + + Gets or sets the two column container light border color. + + + + + Gets or sets the background color of first file column. + + + + + Gets or sets the border color of first file column. + + + + + Gets or sets the background color of first file column. + + + + + Gets or sets the background color blend for the bottom container on file menu. + + + + + Defines the color table for the NavigationPane control. + + + + + Gets or sets the background color collection blend for the button background. + + + + + Gets or sets color table used by renderer. + + + + + Defines color table for the Office 2007 style ProgressBarItem. + + + + + Gets or sets the background color collection blend for the item background. + + + + + Gets or sets the outer border color. + + + + + Gets or sets the inner border color. + + + + + Gets or sets the color collection blend for the current progress part of the item. + + + + + Gets or sets the color collection blend for overlay for the current progress of the item. + + + + + Gets or sets the color collection blend of shadow for the current progress of the item. + + + + + Defines abstract class for the ProgressBarItem painter. + + + + + Gets or sets color table used by renderer. + + + + + Defines painter for the Office 2007 style QAT Customize Item. + + + + + Defines base class for QAT customize item painter. + + + + + Gets or sets color table used by renderer. + + + + + Defines Office 2007 style QAT painter. + + + + + Defines base class for QAT overflow item painter. + + + + + Gets or sets color table used by renderer. + + + + + Defines the color table for the quick access toolbar in all states. + + + + + Gets or sets the colors for the quick access toolbar background when hosted in ribbon control caption and form is active + or the background colors when toolbar is hosted below the ribbon control. + + + + + Gets or sets the colors for the quick access toolbar background when hosted in ribbon control caption and form is inactive + + + + + Gets or sets the colors for the quick access toolbar background when positioned below the ribbon bar. + + + + + Gets or sets the background color of Customize Quick Access Toolbar menu label displayed on customize quick access toolbar menu. + + + + + Gets or sets the text color of Customize Quick Access Toolbar menu label displayed on customize quick access toolbar menu. + + + + + Defines the color table for the Quick Access toolbar. + + + + + Gets or sets the colors of the top background. + + + + + Gets or sets the colors of the bottom background. + + + + + Gets or sets the outer border color. + + + + + Gets or sets the middle border color. + + + + + Gets or sets the inner border color. + + + + + Gets or sets the border when Windows Vista Glass is enabled. + + + + + Represents Office 2007 Control renderer. + + + + + Represents bases class that defines a renderer. + + + + + Raises RenderKeyTips event. + + Provides context information. + + + + Draws KeyTip for an object. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderKeyTips method so events can occur. + + Provides context information. + + + + Raises RenderRibbonTabGroup event. + + Provides context information. + + + + Draws ribbon tab group. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderRibbonTabGroup method so events can occur. + + Provides context information. + + + + Raises RenderItemContainer event. + + Provides context information. + + + + Draws the separator for an item inside of item container. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderItemContainerSeparator method so events can occur. + + Provides context information. + + + + Raises RenderItemContainer event. + + Provides context information. + + + + Draws item container. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderItemContainer method so events can occur. + + Provides context information. + + + + Raises RenderButtonItem event. + + Provides context information. + + + + Draws ButtonItem. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderButtonItem method so events can occur. + + Provides context information. + + + + Raises RenderRibbonTabItem event. + + Provides context information. + + + + Draws RibbonTabItem. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderRibbonTabItem method so events can occur. + + Provides context information. + + + + Raises RenderToolbarBackground event. + + Provides context information. + + + + Draws docked or floating toolbar background. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderToolbarBackground method so events can occur. + + Provides context information. + + + + Raises RenderPopupToolbarBackground event. + + Provides context information. + + + + Draws popup toolbar background. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderPopupToolbarBackground method so events can occur. + + Provides context information. + + + + Raises RenderRibbonDialogLauncher event. + + Provides context information. + + + + Draws ribbon bar dialog launcher button. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderRibbonDialogLauncher method so events can occur. + + Provides context information. + + + + Raises RenderColorItem event event. + + Provides context information. + + + + Draws ColorItem. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderColorItem method so events can occur. + + Provides context information. + + + + Raises RenderRibbonControlBackground event event. + + Provides context information. + + + + Draws the background of the Ribbon Control. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderRibbonControlBackground method so events can occur. + + Provides context information. + + + + Raises RenderSystemCaptionItem event event. + + Provides context information. + + + + Draws the SystemCaptionItem. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderSystemCaptionItem method so events can occur. + + Provides context information. + + + + Raises RenderRibbonFormCaptionText event event. + + Provides context information. + + + + Draws the form caption text for the Ribbon Control. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderRibbonFormCaptionText method so events can occur. + + Provides context information. + + + + Raises RenderQuickAccessToolbarBackground event event. + + Provides context information. + + + + Draws the background of Quick Access Toolbar on Ribbon Control. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderQuickAccessToolbarBackground method so events can occur. + + Provides context information. + + + + Raises RenderMdiSystemItem event. + + Provides context information. + + + + Draws the MdiSystemItem. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderMdiSystemItem method so events can occur. + + Provides context information. + + + + Raises RenderFormCaptionBackground event. + + Provides context information. + + + + Draws the form caption background. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderFormCaptionBackground method so events can occur. + + Provides context information. + + + + Raises RenderQatOverflowItem event. + + Provides context information. + + + + Draws the Quick Access Toolbar Overflow item. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderQatOverflowItem method so events can occur. + + Provides context information. + + + + Raises RenderQatCustomizeItem event. + + Provides context information. + + + + Draws the Quick Access Toolbar Customize Item. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderQatCustomizeItem method so events can occur. + + Provides context information. + + + + Raises RenderCheckBoxItem event. + + Provides context information. + + + + Draws the CheckBoxItem. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderCheckBoxItem method so events can occur. + + Provides context information. + + + + Raises RenderCheckBoxItem event. + + Provides context information. + + + + Draws the ProgressBarItem. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderProgressBarItem method so events can occur. + + Provides context information. + + + + Raises RenderNavPaneButtonBackground event. + + Provides context information. + + + + Draws the Navigation Pane button background. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderNavPaneButtonBackground method so events can occur. + + Provides context information. + + + + Raises RenderSliderItem event. + + Provides context information. + + + + Draws the Slider item. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderSliderItem method so events can occur. + + Provides context information. + + + + Raises RenderSideBar event. + + Provides context information. + + + + Draws the SideBar control. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderSideBar method so events can occur. + + Provides context information. + + + + Raises RenderSideBarPanelItem event. + + Provides context information. + + + + Draws the SideBar control. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderSideBarPanelItem method so events can occur. + + Provides context information. + + + + Raises RenderCrumbBarItemView event. + + Provides context information. + + + + Draws CrumbBarItemView. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderCrumbBarItemView method so events can occur. + + Provides context information. + + + + Raises RenderCrumbBarOverflowItem event. + + Provides context information. + + + + Draws CrumbBarOverflowButton. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderCrumbBarOverflowItem method so events can occur. + + Provides context information. + + + + Raises RenderSwitchButton event. + + Provides context information. + + + + Draws the Switch Button. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderSwitchButton method so events can occur. + + Provides context information. + + + + Raises RenderRangeSliderItem event. + + Provides context information. + + + + Draws the Range Slider item. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderRangeSliderItem method so events can occur. + + Provides context information. + + + + Raises RenderStepItem event. + + Provides context information. + + + + Draws the Step item. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderStepItem method so events can occur. + + Provides context information. + + + + Raises RenderListBoxItem event. + + Provides context information. + + + + Draws the ListBoxItem. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderListBoxItem method so events can occur. + + Provides context information. + + + + Raises RenderListBoxItem event. + + Provides context information. + + + + Draws the ListBoxItem. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderListBoxItem method so events can occur. + + Provides context information. + + + + Raises RenderTabFormStrip event. + + Provides context information. + + + + Draws the TabStrip. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderTabFormStrip method so events can occur. + + Provides context information. + + + + Raises RenderTabFormItem event. + + Provides context information. + + + + Draws the TabStrip. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderTabFormStrip method so events can occur. + + Provides context information. + + + + Raises RenderNewTabFormItem event. + + Provides context information. + + + + Draws the NewTabFormItem. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderTabFormStrip method so events can occur. + + Provides context information. + + + + Raises RenderTabParentForm event. + + Provides context information. + + + + Draws the TabParentForm. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderTabParentForm method so events can occur. + + Provides context information. + + + + Occurs when KeyTip is rendered. + + + + + Occurs when ribbon tab group is rendered. + + + + + Occurs when ItemContainer is rendered. + + + + + Occurs when separator is drawn for an item inside of ItemContainer. + + + + + Occurs when ButtonItem is rendered. + + + + + Occurs when RibbonTabItem is rendered. + + + + + Occurs when docked or floating toolbar is rendered. + + + + + Occurs when popup toolbar is rendered. + + + + + Occurs when dialog launcher button on ribbon bar is rendered. + + + + + Occurs when Ribbon Control background is rendered. + + + + + Occurs when form caption text on ribbon control is rendered. + + + + + Occurs when Quick Access Toolbar background is rendered. + + + + + Occurs when ColorItem is rendered. + + + + + Occurs when SystemCaptionItem is rendered. + + + + + Occurs when MdiSystemItem is rendered. + + + + + Occurs when form caption is background is being rendered. + + + + + Occurs when quick access toolbar overflow item is being rendered. + + + + + Occurs when quick access toolbar customize item is being rendered. + + + + + Occurs when CheckBoxItem is being rendered. + + + + + Occurs when ProgressBarItem is being rendered. + + + + + Occurs when Navigation pane button background is being rendered. + + + + + Occurs when Slider item is being rendered. + + + + + Occurs when Range Slider item is being rendered. + + + + + Occurs when SideBar control is being rendered. + + + + + Occurs when SideBarPanelItem control is being rendered. + + + + + Occurs when CrumbBarItemView is rendered. + + + + + Occurs when CrumbBarOverflowButton is rendered. + + + + + Occurs when Slider item is being rendered. + + + + + Occurs when StepItem is being rendered. + + + + + Occurs when ListBoxItem is being rendered. + + + + + Occurs when SideNavItem is being rendered. + + + + + Occurs when TabStrip is being rendered. + + + + + Occurs when TabFormItem is rendered. + + + + + Occurs when NewTabFormItem is rendered. + + + + + Occurs when TabParentForm is being rendered. + + + + + Draws KeyTip for an object. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderKeyTips method so events can occur. + + Provides context information. + + + + Draws ribbon tab group. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderRibbonTabGroup method so events can occur. + + Provides context information. + + + + Draws item container. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderItemContainer method so events can occur. + + Provides context information. + + + + Draws the separator for an item inside of item container. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderItemContainerSeparator method so events can occur. + + Provides context information. + + + + Draws ButtonItem. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderButtonItem method so events can occur. + + Provides context information. + + + + Draws RibbonTabItem. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderRibbonTabItem method so events can occur. + + Provides context information. + + + + Draws popup toolbar background. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderPopupToolbarBackground method so events can occur. + + Provides context information. + + + + Draws docked or floating toolbar background. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderToolbarBackground method so events can occur. + + Provides context information. + + + + Draws floating toolbar background. + + Provides context information. + + + + Draws ribbon bar dialog launcher button. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderPopupToolbarBackground method so events can occur. + + Provides context information. + + + + Draws ColorItem. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderColorItem method so events can occur. + + Provides context information. + + + + Draws the background of the Ribbon Control. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderRibbonControlBackground method so events can occur. + + Provides context information. + + + + Draws the form caption text for the Ribbon Control. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderRibbonFormCaptionText method so events can occur. + + Provides context information. + + + + Draws the background of Quick Access Toolbar on Ribbon Control. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderQuickAccessToolbarBackground method so events can occur. + + Provides context information. + + + + Draws the SystemCaptionItem. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderSystemCaptionItem method so events can occur. + + Provides context information. + + + + Draws the MdiSystemItem. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderMdiSystemItem method so events can occur. + + Provides context information. + + + + Draws the form caption background. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderFormCaptionBackground method so events can occur. + + Provides context information. + + + + Draws the Quick Access Toolbar Overflow item. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderQatOverflowItem method so events can occur. + + Provides context information. + + + + Draws the Quick Access Toolbar Overflow item. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderQatOverflowItem method so events can occur. + + Provides context information. + + + + Draws the ProgressBarItem. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderProgressBarItem method so events can occur. + + Provides context information. + + + + Draws the Navigation Pane button background. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderNavPaneButtonBackground method so events can occur. + + Provides context information. + + + + Draws the Slider item. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderSliderItem method so events can occur. + + Provides context information. + + + + Draws the SideBar control. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderSideBar method so events can occur. + + Provides context information. + + + + Draws the SideBar control. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderSideBarPanelItem method so events can occur. + + Provides context information. + + + + Draws CrumbBarItemView. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderButtonItem method so events can occur. + + Provides context information. + + + + Draws CrumbBarOverflowButton. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderCrumbBarOverflowItem method so events can occur. + + Provides context information. + + + + Draws SwitchButton. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderButtonItem method so events can occur. + + Provides context information. + + + + Draws the Slider item. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderSliderItem method so events can occur. + + Provides context information. + + + + Draws the Step item. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderStepItem method so events can occur. + + Provides context information. + + + + Draws the ListBoxItem. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderListBoxItem method so events can occur. + + Provides context information. + + + + Draws the ListBoxItem. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderListBoxItem method so events can occur. + + Provides context information. + + + + Draws the TabStrip. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderTabFormStrip method so events can occur. + + Provides context information. + + + + Draws the TabStrip. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderTabFormStrip method so events can occur. + + Provides context information. + + + + Draws the TabStrip. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderTabFormStrip method so events can occur. + + Provides context information. + + + + Draws the TabParentForm. If you need to provide custom rendering this is the method that you should override in your custom rendered. If you + do not want default rendering to occur do not call the base implementation. You can call OnRenderTabParentForm method so events can occur. + + Provides context information. + + + + Occurs when color table is changed by setting the ColorTable property on the renderer. + + + + + Gets or sets color table used by renderer. + + + + + Defines color table for RibbonBar in various states. + + + + + Gets or sets the colors for the default RibbonBar state. + + + + + Gets or sets the colors for RibbonBar when mouse is over the control. + + + + + Gets or sets the colors for RibbonBar when ribbon bar is in overflow state and expanded to show all the items. + + + + + Represents the color table of RibbonBar for Office 2007 style. Default values represent blue Luna theme. + + + + + Gets or sets the height in pixels of top background part. + + + + + Gets or sets the outer border colors. + + + + + Gets or sets the inner border colors. + + + + + Gets or sets the top background colors. + + + + + Gets or sets the bottom background colors. + + + + + Gets or sets the title background colors. + + + + + Gets or sets the color of title text. + + + + + Defines color table for Ribbon Control. + + + + + Gets or sets the colors for the outer border. + + + + + Gets or sets the colors for the inner border. + + + + + Gets or sets the colors for the tabs background area. + + + + + Gets or sets the colors for the tabs background area when Windows Glass is enabled. + + + + + Gets or sets the color of border which is drawn above the tab. + + + + + Gets or sets the light color of border which is drawn above the tab. + + + + + Gets or sets the round corner size for the ribbon control parts. + + + + + Gets or sets the height in pixels of top background part. + + + + + Gets or sets the top background colors. + + + + + Gets or sets the bottom background colors. + + + + + Gets or sets the background image used on Office 2007 style start button displayed in top-left corner of ribbon control. + Note that image assigned to all StartButton properties must be the same size. The size for the button will be determined by image + size set on this property. + + + + + Gets or sets the background image used on Office 2007 style start button displayed in top-left corner of ribbon control when mouse is over the button. + + + + + Gets or sets the background image used on Office 2007 style start button displayed in top-left corner of ribbon control when button is pressed. + + + + + Represents painter for Office 2007 style ribbon overflow button. + + + + + Defines the color table for the Ribbon Tab Group. + + + + + Gets or sets the name of the color table. + + + + + Gets or sets the background color. + + + + + Gets or sets the background highlight colors. + + + + + Gets or sets the text color. + + + + + Gets or sets the border color + + + + + Collection for Office2007RibbonTabGroupColorTable type. + + + + Creates new instance of the class. + + + + Adds new object to the collection. + + Object to add. + Index of newly added object. + + + + Inserts new object into the collection. + + Position of the object. + Object to insert. + + + + Returns index of the object inside of the collection. + + Reference to the object. + Index of the object. + + + + Returns whether collection contains specified object. + + Object to look for. + true if object is part of the collection, otherwise false. + + + + Returns whether collection contains object with specified name. + + Name of the object to look for + true if object with given name is part of the collection otherwise false + + + + Removes specified object from the collection. + + + + + + Copies collection into the specified array. + + Array to copy collection to. + Starting index. + + + + Copies contained items to the Office2007RibbonTabItemColorTable array. + + Array to copy to. + + + + Returns reference to the object in collection based on it's index. + + + + + Returns reference to the object in collection based on it's index. + + + + + Defines the color table for RibbonTabItem states. + + + + + Gets or sets the name of the color table. + + + + + Gets or sets the default tab colors. + + + + + Gets or sets the selected tab colors. + + + + + Gets or sets the selected tab colors when mouse is over the tab. + + + + + Gets or sets the colors when mouse is over the tab but tab is not selected. + + + + + Gets or sets the round corner size for the top part of the ribbon tab item. + + + + + Defines collection for Office2007RibbonTabItemColorTable items. + + + + Creates new instance of the class. + + + + Adds new object to the collection. + + Object to add. + Index of newly added object. + + + + Inserts new object into the collection. + + Position of the object. + Object to insert. + + + + Returns index of the object inside of the collection. + + Reference to the object. + Index of the object. + + + + Returns whether collection contains specified object. + + Object to look for. + true if object is part of the collection, otherwise false. + + + + Returns whether collection contains object with specified name. + + Name of the object to look for + true if object with given name is part of the collection otherwise false + + + + Removes specified object from the collection. + + + + + + Copies collection into the specified array. + + Array to copy collection to. + Starting index. + + + + Copies contained items to the Office2007ButtonItemColorTable array. + + Array to copy to. + + + + Returns reference to the object in collection based on it's index. + + + + + Returns reference to the object in collection based on it's index. + + + + + Defines the colors for the RibbonTabItem state like but not limited to selected, mouse over etc. + + + + + Gets or sets the colors for the outer border. + + + + + Gets or sets the colors for the inner border. + + + + + Gets or sets the background colors. + + + + + Gets or sets the background highlight colors. + + + + + Gets or sets the text color. + + + + + Gets or sets the text color when rendered on Windows Glass. + + + + + Defines the colors for the scroll bar control. + + + + + Gets or sets the colors for the control default state. + + + + + Gets or sets the colors for the control when mouse is pressed over the control. + + + + + Gets or sets the colors for the control when mouse is over the control but not over an active part of the control like scroll buttons. + + + + + Gets or sets the colors for the control when mouse is over the active part of the control like scroll buttons. + + + + + Gets or sets the colors for the control when control is disabled. + + + + + Represents the color table for the Scroll bar in single state. + + + + + Gets or sets the outer border color for the scroll bar thumb. + + + + + Gets or sets the inner border color for the scroll bar thumb. + + + + + Gets or sets the thumb background color blend collection. + + + + + Gets or sets the directional sign background color for the scroll bar thumb. + + + + + Gets or sets the outer border color for the scroll bar track button. + + + + + Gets or sets the inner border color for the scroll bar track button. + + + + + Gets or sets the track background color blend collection. + + + + + Gets or sets the background color for the track signs. + + + + + Gets or sets the background colors for the entire control. + + + + + Gets or sets the border colors for the entire control. + + + + + Represents the color table for Office 2007 Style Side Bar Control. + + + + + Gets or sets the background color of the control. + + + + + Gets or sets the control border color. + + + + + Gets or sets the color of SideBarPanelItem text. + + + + + Gets or sets the color table for SideBarPanelItem in default state. + + + + + Gets or sets the color table for SideBarPanelItem in mouse over state. + + + + + Gets or sets the color table for SideBarPanelItem in expanded state. + + + + + Gets or sets the color table for SideBarPanelItem when mouse button is pressed on the item. + + + + + Gets or sets color table used by renderer. + + + + + Populates Office 2007 Color Table with Silver color scheme + + + + + Initializes ColorScheme object with the black color scheme. + + ColorScheme object to initialize. + + + + Defines the color table for the slider item. + + + + + Gets or sets the default state colors. + + + + + Gets or sets the mouse over state colors. + + + + + Gets or sets the mouse pressed colors. + + + + + Gets or sets the disabled colors. + + + + + Gets or sets the optional color table for Thumb part of the slider. When set to null default values from Office2007SliderColorTable are used. + + + + + Gets or sets the optional color table for Increase button part of the slider. When set to null default values from Office2007SliderColorTable are used. + + + + + Gets or sets the optional color table for Decrease button part of the slider. When set to null default values from Office2007SliderColorTable are used. + + + + + Defines set of color tables for single slider part. + + + + + Gets or sets the default state colors. + + + + + Gets or sets the mouse over state colors. + + + + + Gets or sets the mouse pressed colors. + + + + + Renders the Slider items. + + + + + Gets or sets color table used by renderer. + + + + + Defines the color table for the Slider Item in single state. + + + + + Gets or sets the part background colors. + + + + + Gets or sets the part border color + + + + + Gets or sets the part border light color + + + + + Gets or sets the part foreground color. + + + + + Gets or sets the part foreground light color. + + + + + Gets or sets the track line color. + + + + + Gets or sets the track line light color. + + + + + Gets or sets the track label color. + + + + + Gets or sets the track label color when on Slider control. + + + + + Defines the color table for the SuperTooltip. + + + + + Gets or sets the background colors. + + + + + Gets or sets the text color. + + + + + Represents color table for Office 2007 style system button displayed in form caption. + + + + + Gets or sets the color table of default button state. + + + + + Gets or sets the color table of button state when mouse is over the button. + + + + + Gets or sets the color table of button state when mouse is pressed over the button. + + + + + Represents color table for single state of Office 2007 style system button displayed in form caption. + + + + + Gets or sets the outer border colors. + + + + + Gets or sets the inner border colors. + + + + + Gets or sets top part background colors. + + + + + Gets or sets bottom part background colors. + + + + + Gets or sets highlight colors for the top background part. + + + + + Gets or sets highlight colors for the bottom background part. + + + + + Gets or sets the foreground color for the button. + + + + + Gets or sets the dark shading color for the foreground. + + + + + Gets or sets the light shading color for the foreground. + + + + + Represents the color table for the tab control. + + + + + Gets or sets the default tab item colors. + + + + + Gets or sets the mouse over tab item colors. + + + + + Gets or sets the selected tab item colors. + + + + + Gets or sets the color of the tab background colors. + + + + + Gets or sets the tab-strip background image. + + + + + Gets or sets the color of the tab panel background colors. + + + + + Gets or sets the color of tab panel border. + + + + + Represents the color table for the tab item. + + + + + Gets or sets top part background colors. + + + + + Gets or sets the bottom part background colors. + + + + + Gets or sets the outer border colors. + + + + + Gets or sets the inner border colors. + + + + + Gets or sets the text colors. + + + + + Paints background of docked bar. + + Context information + + + + Paints background of floating bar. + + Context information + + + + Paints background of popup bar. + + Context information + + + + Summary description for ButtonItemPainterHelper. + + + + + Provides data for ButtonItem rendering. + + + + + Gets or sets Graphics object group is rendered on. + + + + + Gets the reference to ButtonItem instance being rendered. + + + + + Reference to internal data. + + + + + Indicates whether to cancel system rendering of the item. + + + + + Creates new instance of the object. + + + + + Creates new instance of the object and initializes it with default values + + Reference to Graphics object. + Reference to ButtonItem object. + + + + Creates new instance of the object and initializes it with default values + + Reference to Graphics object. + Reference to ButtonItem object. + + + + Defines container for ribbon caption layout and quick access toolbar customization and overflow. + + + + + Summary description for DesignTimeProviderContainer. + + + + + + + + Returns insertion index for an item taking in account any system items that are at the end of the collection. + + Parent item + Returns the index at which an item should be inserted + + + + Defines delegate for RenderKeyTips event. + + + + + Defines delegate for RenderRibbonTabGroup event. + + + + + Defines delegate for RenderItemContainer event. + + + + + Defines delegate for RenderItemContainerSeparator event. + + + + + Defines delegate for ButtonItem rendering events. + + + + + Defines delegate for RibbonTabItem rendering events. + + + + + Defines delegate for toolbar rendering events. + + + + + Defines delegate for Rendering dialog launcher button rendering events. + + + + + Defines delegate for ColorItem rendering events. + + + + + Defines delegate for RibbonControl rendering events. + + + + + Defines delegate for SystemCaptionItem rendering events. + + + + + Defines delegate for MdiSystemItem rendering events. + + + + + Defines delegate for RenderFormCaptionBackground rendering events. + + + + + Defines delegate for CustomizeMenuPopup events. + + + + + Defines delegate for the Quick Access Overflow item rendering events. + + + + + Defines delegate for the Quick Access Customize item rendering events. + + + + + Defines delegate for the Quick Access Customization dialog events. + + + + + Defines delegate for the CheckBoxItem rendering events. + + + + + Defines delegate for the ProgressBarItem rendering events. + + + + + Defines delegate for the Navigation Pane rendering events. + + + + + Defines delegate for the BeforeRibbonPanelPopupClose event. + + + + + Defines delegate for the Slider item rendering events. + + + + + Defines delegate for the SideBar control rendering event. + + + + + Defines delegate for the SideBarPanelItem control rendering event. + + + + + Defines delegate for the SwitchButtonItem control rendering event. + + + + + Defines delegate for the Slider item rendering events. + + + + + Defines delegate for the StepItem rendering events. + + + + + Defines delegate for the ListBoxItem rendering events. + + + + + Defines delegate for the SideNavItem rendering events. + + + + + Defines delegate for the TabStrip rendering events. + + + + + Defines delegate for the TabParentForm rendering events. + + + + + Represents the class that provides Office 2007 style Gallery container with drop-down ability. + + + + + Creates new instance of the class + + + + + Returns copy of the item. + + + + + Copies the ButtonItem specific properties to new instance of the item. + + New ButtonItem instance. + + + + Returns the client rectangle which is DisplayRectangle excluding scroll-bar bounds + + + + + + Invokes GalleryPopupOpen event. + + + + + + Invokes GalleryPopupShowing event. + + + + + + Invokes GalleryPopupClose event. + + + + + + Invokes GalleryPopupFinalized event. + + + + + + Gets whether DefaultSize property is serialized by Windows Forms designer based on its current value. + + + + + Resets DefaultSize property to its default value. + + + + + Gets whether PopupGallerySize property is serialized by Windows Forms designer based on its current value. + + + + + Resets PopupGallerySize property to its default value. + + + + + Scrolls the gallery if necessary to ensures that item is visible. + + Reference to the items that is part of the gallery. + + + + Scrolls gallery down to show next line of items. + + + + + Scrolls gallery up to show previous line of items. + + + + + + Opens the Gallery popup menu. + + + + + Called on each item when ScaleControl method of parent control is called and gives opportunity to item to adjust its displayed based on current scaling. + + Scale factor. + + + + Returns whether Gallery can extend the object. + + Object to test extensibility for. + Returns true if object can be extended otherwise false. + + + + Gets the GalleryGroup item is assigned to. + + Reference to item. + An instance of GalleryGroup object or null if item is not assigned to the group + + + + Assigns the item to the gallery group. + + Item to assign. + Group to assign item to. Can be null to remove item assignment. + + + + Occurs when Gallery popup item is about to open. + + + + + Occurs just before Gallery popup window is shown. + + + + + Occurs before the Gallery popup item is closed. + + + + + Occurs after Gallery popup item has been closed. + + + + + Gets or sets orientation inside the container. GalleryContainer automatically manages the layout orientation and this property should not be changed from its default value. + + + + + Gets or sets the item alignment when container is in horizontal layout. Default value is Left. + + + + + Gets or sets the item vertical alignment. Default value is Top. + + + + + Gets or sets whether items in horizontal layout are wrapped into the new line when they cannot fit allotted container size. Default value is false. + + + + + Gets or sets whether items contained by container are resized to fit the container bounds. When container is in horizontal + layout mode then all items will have the same height. When container is in vertical layout mode then all items + will have the same width. Default value is true. + + + + + Gets or sets whether Gallery when on popup is using standard scrollbars to scroll the content. + Standard scrollbars are displayed on right hand side of the Gallery. Default value for this property is true. + When set to false the scroll buttons are displayed only when needed and two buttons on top and bottom + of the Gallery are used to indicate the scrolling possibility and enable scrolling. Buttons are only + visible when needed. This scrolling button style can be used for example on Application Menu + to enable scrolling of list of most recently used files. + + + + + Gets or sets whether gallery is using incremental sizing when stretched. Default + value is true. Incremental sizing will resize the width of the gallery so it fits + completely the items it can contain in available space. That means that gallery will + occupy enough space to display the whole items within available space. When set to + false, it indicates that gallery will resize to fill all available space. + + + + + Gets or sets whether Gallery width is determined based on the RibbonBar width. This property is in effect when + Gallery is hosted directly the RibbonBar control. Default value is false. + When set to true the Gallery size is changed as the RibbonBar control is resized. The initial size of the Gallery is + determined by DefaultSize property. The MinimumSize property specifies the minimum size of the Gallery. + Note that only single Gallery can be stretched per RibbonBar control. + + + + + Gets the collection of the items that are added to the popup gallery. The items displayed on the gallery are combined with the + items from this collection and they are displayed on the gallery popup. This collection can for example have items that are + customizing the choices of the commands in gallery etc. + + + + + Gets or sets the default size of the gallery. The gallery height will be always enforced so all scroll buttons can be displayed. + Gallery width should allow display of both scroll buttons and the gallery content. + + + + + Gets or sets the default size of the gallery when gallery is displayed on the popup menu. + + + + + Gets or sets whether gallery can be displayed on the popup. Default value is true. + + + + + Gets or sets a value indicating whether the item is expanded or not. For Popup items this would indicate whether the item is popped up or not. + + + + + Gets whether the Gallery popup is open. + + + + + Gets or sets the Key Tips access key or keys for the item when on Ribbon Control or Ribbon Bar. Use KeyTips property + when you want to assign the one or more letters to be used to access an item. For example assigning the FN to KeyTips property + will require the user to press F then N keys to select an item. Pressing the F letter will show only keytips for the items that start with letter F. + + + + + Gets or sets whether scroll animation is enabled. Default value is true. + Scroll animation will be disabled if gallery is running under Remote Windows Terminal session or fade animation effect is disabled on the + container control. + + + + + Gets the collection of GalleryGroup objects associated with this gallery. Groups are assigned optionally to one or more items + that are part of the GalleryContainer. Groups are used to visually group the items when gallery is displayed on the popup. + + + + + Represents the popup gallery group that groups set of items inside of gallery into the group. + + + + + Creates new instance of the object. + + + + + Gets or sets title of the group that will be displayed on the group label when on popup gallery. + + + + + Gets or sets name of the group that can be used to identify item from the code. + + + + + Gets the parent gallery for the group. + + + + + Gets or sets the display order for the group when displayed on the popup. Lower values are displayed closer to the top. Default value is 0. + + + + + Gets the collection of the items assigned to this group. + + + + + Represents the GalleryGroup typed collection. + + + + + Adds new object to the collection. + + Object to add. + Index of newly added object. + + + + Adds new objects to the collection. + + Array of groups to add. + + + + Inserts new object into the collection. + + Position of the object. + Object to insert. + + + + Returns index of the object inside of the collection. + + Reference to the object. + Index of the object. + + + + Returns whether collection contains specified object. + + Object to look for. + true if object is part of the collection, otherwise false. + + + + Removes specified object from the collection. + + + + + + Copies collection into the specified array. + + Array to copy collection to. + Starting index. + + + + Copies contained items to the GalleryGroup array. + + Array to copy to. + + + + Returns reference to the object in collection based on it's index. + + + + + Returns reference to the object in collection based on it's name. + + + + + Summary description for ISimpleElement. + + + + + Represents IBlock layout manager implementation + + + + + Resizes the content block and sets it's Bounds property to reflect new size. + + Content block to resize. + + + + Indicates container title location. + + + + + Provides data for rendering ItemContainer. + + + + + Gets or sets Graphics object group is rendered on. + + + + + Gets the reference to ItemContainer instance being rendered. + + + + + Creates new instance of the object. + + Reference to graphics object. + Reference to ItemContainer object. + + + + Provides data for the item separator rendering inside of the ItemContainer. + + + + + Gets or sets the reference to the item separator is being rendered for. + + + + + Creates new instance of the object. + + + + + Represents class for Accessibility support. + + + + + Creates new instance of the object and initializes it with owner control. + + Reference to owner control. + + + + Returns number of child objects. + + Total number of child objects. + + + + Returns reference to child object given the index. + + 0 based index of child object. + Reference to child object. + + + + Gets accessible role. + + + + + Gets parent accessibility object. + + + + + Returns bounds of the control. + + + + + Returns current accessible state. + + + + + Represents class for item display. + + + + + Represents canvas for KeyTips + + + + + Represents data for key tips rendering. + + + + + Gets or sets the graphics object used for rendering. + + + + + Gets or sets key tip bounds. + + + + + Gets or sets the text of key tip to be rendered. + + + + + Gets or sets the font key tip should be rendered with. + + + + + Reference object for which Key Tip is rendered. For example this could be reference to an instance of ButtonItem or BaseItem as well + as reference to System.Windows.Forms.Control object. Always test for type before accessing this reference. + + + + + Creates new instance of the object and initializes it with default values. + + + + + Represents painter for the MdiSystemItem. + + + + + Paints MdiSystemItem. + + Provides arguments for the operation. + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Gets or sets whether Text supports and renders text markup. Default value is true. + + + + + Gets or sets whether divider panel that divides message box buttons and text content is visible. Default value is true. + + + + + Gets or sets the anti-alias setting for text-pane. + + + + + Enumeration of available common system strings. + + + + + Represents the class that provides MessageBox like functionality with the styled Office 2007 dialog and text markup support. + + + + + Displays a message box with specified text. + + The text to display in the message box. + One of the DialogResult values. + + + + Displays a message box in front of the specified object and with the specified text. + + The IWin32Window the message box will display in front of. + The text to display in the message box. + One of the DialogResult values. + + + + Displays a message box with specified text and caption. + + The text to display in the message box. + The text to display in the title bar of the message box. + One of the DialogResult values. + + + + Displays a message box with specified text and caption. + + The IWin32Window the message box will display in front of. + The text to display in the message box. + The text to display in the title bar of the message box. + One of the DialogResult values. + + + + Displays a message box with specified text, caption, and buttons. + + The text to display in the message box. + The text to display in the title bar of the message box. + One of the MessageBoxButtons values that specifies which buttons to display in the message box. + One of the DialogResult values. + + + + Displays a message box with specified text, caption, and buttons. + + The IWin32Window the message box will display in front of. + The text to display in the message box. + The text to display in the title bar of the message box. + One of the MessageBoxButtons values that specifies which buttons to display in the message box. + One of the DialogResult values. + + + + Displays a message box with specified text, caption, buttons, and icon. + + The text to display in the message box. + The text to display in the title bar of the message box. + One of the MessageBoxButtons values that specifies which buttons to display in the message box. + One of the MessageBoxIcon values that specifies which icon to display in the message box. + One of the DialogResult values. + + + + Displays a message box with specified text, caption, buttons, and icon. + + The IWin32Window the message box will display in front of. + The text to display in the message box. + The text to display in the title bar of the message box. + One of the MessageBoxButtons values that specifies which buttons to display in the message box. + One of the MessageBoxIcon values that specifies which icon to display in the message box. + One of the DialogResult values. + + + + Displays a message box with the specified text, caption, buttons, icon, and default button. + + The text to display in the message box. + The text to display in the title bar of the message box. + One of the MessageBoxButtons values that specifies which buttons to display in the message box. + One of the MessageBoxIcon values that specifies which icon to display in the message box. + One of the MessageBoxDefaultButton values that specifies the default button for the message box. + One of the DialogResult values. + + + + Displays a message box with the specified text, caption, buttons, icon, and default button. + + The IWin32Window the message box will display in front of. + The text to display in the message box. + The text to display in the title bar of the message box. + One of the MessageBoxButtons values that specifies which buttons to display in the message box. + One of the MessageBoxIcon values that specifies which icon to display in the message box. + One of the MessageBoxDefaultButton values that specifies the default button for the message box. + One of the DialogResult values. + + + + Displays a message box with the specified text, caption, buttons, icon, and default button. + + The IWin32Window the message box will display in front of. + The text to display in the message box. + The text to display in the title bar of the message box. + One of the MessageBoxButtons values that specifies which buttons to display in the message box. + One of the MessageBoxIcon values that specifies which icon to display in the message box. + One of the MessageBoxDefaultButton values that specifies the default button for the message box. + Indicates value for Message Box dialog TopMost property. + One of the DialogResult values. + + + + Occurs when text markup link on Message Box is clicked. Markup links can be created using "a" tag, for example: + Markup link + + + + + Gets or sets whether MessageBoxEx is using Windows System API function to retrieve the localized strings used by MessageBoxEx. Set this to false + if you experience issues when using MessageBoxEx under certain conditions. + + + + + Gets or sets whether MessageBoxEx form has Windows Vista Glass enabled if running on + Windows Vista with Glass enabled. Default value is true. + + + + + Gets or sets the anti-alias setting for message box text. + + + + + Gets or sets the text color for the message box text. Default value is Color.Empty which indicates that system colors are used. + + + + + Gets or sets whether divider panel that divides message box buttons and text content is visible. Default value is true. + + + + + Gets or sets the message box start position when Owner is not specified. Default value is CenterScreen. + + + + + Gets or sets the message box start position when Owner is specified. Default value is CenterParent. + + + + + Gets or sets whether message box text renders text markup. Default value is true. + + + + + Summary description for Office2003RibbonTabItemPainter. + + + + + Paints state of the button, either hot, pressed or checked + + + + + + + + Paints background of docked bar. + + Context information + + + + Paints background of floating bar. + + Context information + + + + Paints background of popup bar. + + Context information + + + + Gets or sets color table used by renderer. + + + + + Gets or sets color table used by renderer. + + + + + Gets or sets color table used by renderer. + + + + + Represents Office 2007 style MdiSystemItem painter + + + + + Gets or sets color table used by renderer. + + + + + Represents base class for Ribbon Control painting. + + + + + Paints controls background + + + + + Paints form caption background + + + + + Paints form caption text when ribbon control is displaying form caption + + + + + Paints the background of quick access toolbar. + + + + + Paints controls background + + + + + Paints form caption background + + + + + Paints the background of quick access toolbar. + + + + + RibbonTabItem painter for Office 2007 style + + + + + Represents the Office Application Button displayed in the top-left corner of the Ribbon Control. + + + + + Processes the Escape key when Application Button is hosting the backstage tab and uses it to close the tab if open. + This method is called from ProcessDialogKey method of Office2007RibbonForm. + + Key data + true if key was used to close backstage tab + + + + Gets or sets a value indicating whether the item is expanded or not. For Popup items this would indicate whether the item is popped up or not. + + + + + Gets or sets whether control set on BackstageTab property is used on application menu popup. + + + + + Gets or sets the backstage tab that is displayed instead of popup menu. + + + + + Summary description for PainterFactory. + + + + + Forces the creation of the objects inside of factory. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Loads the items for the customization into the ribbon control. All Ribbon Bars on the ribbon are enumerated and items + are added if they have CanCustomize=true. + + Ribbon control to enumerate. + + + + Loads the items for the customization from MetroTab control. Registered MetroToolbar controls are enumerated and items + are added if they have CanCustomize=true. + + MetroTab control that holds references to known MetroToolbars. + + + + Gets reference to the internal Quick Access Toolbar Customization panel. + + + + + Represents the item that provides Quick Access Toolbar customization. + + + + + Creates new instance of CustomizeItem object. + + + + + Returns copy of CustomizeItem item + + + + + Overridden. Recalculates the size of the item. + + + + + Gets localized tooltip text for this instance of the item. + + Tooltip text. + + + + Called when mouse hovers over the customize item. + + + + + Gets or sets whether Customize menu item is visible. + + + + + Gets/Sets informational text (tooltip) for the item. + + + + + Represents the Quick Access Toolbar customization panel which can be used on the custom QAT customization dialogs + so customization of Quick Access Toolbar can be reused. + + + + + Gets reference to the internal ItemPanel control that displays the commands for selected category. + + + + + Gets reference to the ItemPanel control that displays the Quick Access Toolbar Items. + + + + + Gets reference to the button that perform addition of commands to the Quick Access Toolbar. + + + + + Gets reference to the button that perform removal of commands from the Quick Access Toolbar. + + + + + Gets reference to the combo box control that holds all categories. + + + + + Gets reference to the combo box categories label control. + + + + + Gets reference to the check box that changes the placement of the Quick Access Toolbar. + + + + + Required designer variable. + + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Loads the items for the customization into the ribbon control. All Ribbon Bars on the ribbon are enumerated and items + are added if they have CanCustomize=true. + + Ribbon control to enumerate. + + + + Loads the items for the customization from MetroTab registered toolbars. All registered Toolbars are enumerated and items + are added if they have CanCustomize=true. + + MetroTab control to enumerate. + + + + Gets or sets the value of data changed flag. + + + + + Represents the stand-alone Quick Access Toolbar control + + + + + Returns the collection of items with the specified name. + + Item name to look for. + + + + + Returns the collection of items with the specified name and type. + + Item name to look for. + Item type to look for. + + + + + Returns the collection of items with the specified name and type. + + Item name to look for. + Item type to look for. + Indicates whether GlobalName property is used for searching. + + + + + Returns the first item that matches specified name. + + Item name to look for. + + + + + Gets/Sets the visual style for items and color scheme. + + + + + Returns collection of items on a bar. + + + + + Represents a single ribbon container control. + + + + + Creates new accessibility instance. + + Reference to AccessibleObject. + + + + Closes the RibbonBar overflow popup if control is in overflow mode and displays the overflow popup that shows complete content of the control. + + + + + Resets style to default value. Used by windows forms designer. + + + + + Invokes the LaunchDialog event to execute default launch dialog action. + + + + + Called when item on popup container is right-clicked. + + Instance of the item that is right-clicked. + + + + Invokes DialogLauncherMouseEnter event. + + + + + Invokes DialogLauncherMouseLeave event. + + + + + Invokes DialogLauncherMouseHover event. + + + + + Returns the collection of items with the specified name. + + Item name to look for. + + + + + Returns the collection of items with the specified name and type. + + Item name to look for. + Item type to look for. + + + + + Returns the first item that matches specified name. + + Item name to look for. + + + + + Returns the collection of items with the specified name and type. + + Item name to look for. + Item type to look for. + Indicates whether GlobalName property is used for searching. + + + + + Resets cached content size. Content size is cached to improve performance of the control when control is + switched into overflow mode displaying a single button. If you change content of Rendering, hide/show items or + add new items you will need to call this method to erase cached value and allow the full Rendering size to be calculated. + + + + + Returns size of the control based on current content size. + + Size based on content. + + + + Sets the height of the control to the automatically calculated height based on content. + + + + + Returns automatically calculated height of the control given current content. + + Height in pixels. + + + + Returns automatically calculated width of the control given current content. + + Width in pixels. + + + + Gets the bounds of the title. + + + + + Resets TitleStyle property to its default value. Used by Windows Forms designer for design-time support. + + + + + Resets TitleStyle property to its default value. Used by Windows Forms designer for design-time support. + + + + + Occurs when dialog launcher button in title bar is clicked. Use DialogLauncherVisible property to show the button in title bar. + + + + + Occurs when overflow button for control is created because control size is below the minimum size required to display complete content of the control. + This event allows you to get access to the internal overflow button that is created and change it's properties if required. + + + + + Occurs after overflow button setup is complete and all items contained by this control are moved to it. + + + + + Occurs before overflow button is destroyed. + + + + + Occurs when mouse enters dialog launcher button. + + + + + Occurs when mouse leaves dialog launcher button. + + + + + Occurs when mouse hovers over the dialog launcher button. + + + + + Occurs when mouse is pressed over the dialog launcher button. + + + + + Gets or sets parent button when on QAT. + + + + + Gets or sets whether this RibbonBar is on QAT. + + + + + Gets or sets whether Office 2007 Design Guidelines specification for positioning KeyTips is used. + + + + + Gets or sets the Accessible name for the Dialog Launcher button + + + + + Specifies the background style of the control when mouse is over the control. Style specified here will be applied to the + BackgroundStyle. + + + + + Gets or sets image that is used as dialog luncher button in ribbon title bar. Default value is null which indicates that + default appearance for the button is used. + + + + + Gets or sets image that is used as dialog luncher button when mouse is over the button. + Note that if this property is set you also must set the DialogLauncherButton property. Images set to both + properties must have same size. Default value is null which indicates that + default appearance for the button is used. + + + + + Gets or sets maximum text length for automatic overflow button text. When overflow button is created due to the + reduced size of the control text for the button can be specified using OverflowButtonText property. If + text is not specified RibbonBar.Text property is used as overflow button text. In that case + this property specifies maximum length of the text to display on the button. Default value is 25. You can set + this property to 0 to use complete text regardless of length. + + + + + Gets or sets resize order index of the control. When control is parented to RibbonPanel control (which is the case when control is + used as part of RibbonControl) index specified here indicates the order in which controls that are part of the same panel + are resized. Lower index value indicates that control should be resized later when size needs to be reduced or earlier when size needs + to be increased. Default value is 0. + + + + + Gets or sets whether automatic overflow handling is enabled. When overflow is enabled if control is resized below the + size that is needed to display its complete content overflow button is created and all content is moved to the overflow button + popup. Control will only display overflow button when in this state and user can click overflow button to display the actual + content of the control. + Default value is true. + + + + + Gets or sets the text for overflow button that is created when ribbon bar size is reduced so it cannot display all its content. + When control is resized so it cannot display its content overflow button is created which is displayed on face of the control. + Complete content of the control is then displayed on popup toolbar when user clicks overflow button. + + + + + Gets or sets the Image for overflow button that is created when ribbon bar size is reduced so it cannot display all its content. + When control is resized so it cannot display its content overflow button is created which is displayed on face of the control. + Complete content of the control is then displayed on popup toolbar when user clicks overflow button. This Image is also used when + RibbonBar is added to the Quick Access Toolbar to identify the RibbonBar button. + + + + + Gets or sets whether dialog launcher button is visible in title of the ribbon. Default value is false. + + + + + Gets or sets default layout orientation inside the control. You can have multiple layouts inside of the control by adding + one or more instances of the ItemContainer object and changing it's LayoutOrientation property. + + + + + Gets or sets spacing in pixels between items. Default value is 1. + + + + + Gets or sets whether items contained by container are resized to fit the container bounds. When container is in horizontal + layout mode then all items will have the same height. When container is in vertical layout mode then all items + will have the same width. Default value is true. + + + + + Gets or sets the item alignment when container is in horizontal layout. Default value is Left. + + + + + Gets or sets the item vertical alignment. Default value is Top. + + + + + Returns collection of items on a bar. + + + + + Gets or sets whether ribbon bar can be customized by end user i.e. added to Quick Access Toolbar. + + + + + Returns reference to the overflow button that is used by control. + + + + + Gets whether control is in overflow state or not. + + + + + Gets or sets whether ButtonItem objects hosted on control are resized to reduce the space consumed by ribbon bar when required. + Default value is true. + + + + + Indicates whether auto-sizing for RibbonBar includes ribbon bar title width so in case when ribbon bar title width is wider than ribbon bar width the + width of the ribbon bar will always be at least the title bar width so complete title text can be displayed. + + + + + Gets/Sets the visual style for items and color scheme. + + + + + Gets or sets the KeyTip for the dialog launcher button. + + + + + Gets or sets whether ribbon bar title is visible. Default value is true. + + + + + Specifies the style of the title of the control. + + + + + Specifies the style of the title of the control when mouse is over the control. + + + + + Gets the title bounds. + + + + + Gets or sets whether control changes its background when mouse is over the control. + + + + + Gets or sets whether external ButtonItem object is accepted in drag and drop operation. UseNativeDragDrop must be set to true in order for this property to be effective. + + + + + Gets or sets whether native .NET Drag and Drop is used by control to perform drag and drop operations. AllowDrop must be set to true to allow drop of the items on control. + + + + + + Defines event handler for overflow button events. + + Control that is hosting the overflow button. + Event arguments + + + + Represents event arguments for overflow button events. + + + + + Creates new instance of the class and initializes it. + + Reference to overflow button. + + + + Returns reference to the overflow button that is used by control. + + + + + Represents class for RibbonBar Accessibility support. + + + + + Creates new instance of the object and initializes it with owner control. + + Reference to owner control. + + + + Returns number of child objects. + + Total number of child objects. + + + + Returns reference to child object given the index. + + 0 based index of child object. + Reference to child object. + + + + Represents the container for RibbonBar objects that will be merged into the MDI parent ribbon control. + + + + + Represents panel used by RibbonTabItem as a container panel for the control. + + + + + Creates new instance of the panel. + + + + + Scrolls the RibbonBar controls to the right one step if there is more of the controls on the panel that can fit into the available space. + + + + + Scrolls the RibbonBar controls one step to the left. + + + + + Resets the panel scroll position. + + + + + Gets or sets whether default control layout is used instead of Rendering layout for RibbonBar controls positioning. By default + internal layout logic is used so proper resizing of Ribbons can be performed. You can disable internal layout by setting this property + to true. + Default value is false. + + + + + Indicates whether style of the panel is managed by tab control automatically. + Set this to true if you would like to control style of the panel. + + + + + Gets or sets TabItem that this panel is attached to. + + + + + Gets or sets whether last RibbonBar is stretched to fill available space inside of the panel. Default value is false. + + + + + Gets or sets which edge of the parent container a control is docked to. + + + + + Gets or sets the size of the control. + + + + + Gets or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container. + + + + + Gets or sets a value indicating whether the control is displayed. + + + + + Gets or sets which edges of the control are anchored to the edges of its container. + + + + + Removes any RibbonBar objects that were merged into the Ribbon control. + + Reference to ribbon control to remove RibbonBar objects from. + + + + Merges RibbonBar objects from this container into the Ribbon control. + + Reference to ribbon control to remove RibbonBar objects from. + + + + Raises the BeforeRibbonMerge event. + + + + + Raises the AfterRibbonMerge event. + + + + + Raises the BeforeRibbonUnmerge event. + + + + + Raises the AfterRibbonUnmerge event. + + + + + Occurs before the RibbonBar objects from container are merged into the Ribbon control. + + + + + Occurs after the RibbonBar objects are merged into the Ribbon control. + + + + + Occurs after the RibbonBar objects are removed from the Ribbon control. + + + + + + Gets whether RibbonBar controls are merged into the RibbonControl. + + + + + Gets or sets whether RibbonTab item the RibbonBar controls are added to when merged is automatically activated (selected) after + controls are merged. Default value is true. + + + + + Gets or sets whether merge functionality is enabled for the container. Default value is true. + + + + + Gets or sets the Ribbon Tab text for the tab that will be created when ribbon bar objects from this container are merged into the ribbon. + + + + + Gets or sets the Key Tips access key or keys for the Ribbon Tab. Use KeyTips property + when you want to assign the one or more letters to be used to access an item. For example assigning the FN to KeyTips property + will require the user to press F then N keys to select an item. Pressing the F letter will show only keytips for the items that start with letter F. + + + + + Gets or sets the predefined color for the ribbon tab that is created when ribbon bar controls are merged into the ribbon. + Default value is eRibbonTabColor.Default + + + + + Gets or sets the name of RibbonTabItem object that already exists on Ribbon control into which the RibbonBar controls are merged. + If name is not specified new RibbonTabItem is created and RibbonBar controls are added to it. + + + + + Gets or sets the name of the RibbonTabItemGroup the new Ribbon Tab Item that is created will be added to. The RibbonTabItemGroup + must be created and added to RibbonControl.TabGroups collection. + + + + + Gets or sets the insertion index for the ribbon tab item that is created when ribbon bars are merged into the ribbon control. + Default value is -1 which means that ribbon tab item is appended to the existing ribbon tab items. + + + + + Gets or sets whether panel automatically provides shadows for child controls. + + + + + Represents Rendering control composed of two parts, RibbonStrip and multiple RibbonBar controls per strip. + + + + + Gets the name of the QAT Customize Item which is used to display the QAT Customize Dialog box. + + + + + Gets the name of the Add to Quick Access Toolbar context menu item. + + + + + Gets the name of the Remove from Quick Access Toolbar context menu item. + + + + + Gets the name of the QAT placement change context menu item. + + + + + Gets the name of the Minimize Ribbon Item which is used to minimize the ribbon. + + + + + Gets the name of the Maximize Ribbon Item which is used to maximize the ribbon. + + + + + Gets the name of the label displayed on Quick Access Toolbar customize popup menu. + + + + + Gets the string that is used as starting name for the frequently used QAT menu items created when QAT Customize menu is displayed. + + + + + Called by StyleManager to notify control that style on manager has changed and that control should refresh its appearance if + its style is controlled by StyleManager. + + New active style. + + + + Sets the height of the control to the automatically calcualted height based on content. + + + + + Sets the height of the control to the automatically calcualted height based on content. + + + + + Performs the setup of the RibbonPanel with the current style of the Ribbon Control. + + Panel to apply style changes to. + + + + Creates new Rendering Tab at specified position, creates new associated panel and adds them to the control. + + Specifies the text displayed on the tab. + Specifies the name of the tab + Specifies the position of the new tab inside of Items collection. + New instance of the RibbonTabItem that was created. + + + + Creates new Rendering Tab and associated panel and adds them to the control. + + Specifies the text displayed on the tab. + Specifies the name of the tab + New instance of the RibbonTabItem that was created. + + + + Recalculates layout of the control and applies any changes made to the size or position of the items contained. + + + + + Returns Control region if any when control is hosted by Office2007RibbonForm + + + + + + Occurs when text markup link is clicked. + + + + + Resets DefaultGroupFont property to default value null. + + + + + Raises the BeforeRibbonPanelPopupClose event. + + + + + Raises the AfterRibbonPanelPopupClose event. + + + + + Raises the BeforeRibbonPanelPopup event. + + + + + + Raises the BeforeRibbonPanelPopup event. + + + + + + Sets up timer that watches when active window changes. + + + + + Called after change of active window has been detected. SetupActiveWindowTimer must be called to enable detection. + + + + + Releases and disposes the active window watcher timer. + + + + + Displays the active ribbon panel on the popup if ribbon control is collapsed. + + Reference to the object that was cause of the event. This is provided to the BeforeRibbonPanelPopupClose event if an menu needs to be closed. + Indicates the event source. This is provided to the BeforeRibbonPanelPopupClose event if an menu needs to be closed. + + + + Closes the Ribbon tab menu with source set to null and event source set to Code. + + + + + Closes the Ribbon Menu if one is currently displayed. + + + + + Suspends the form layout. + + + + + Suspends the form layout. + + + + + Suspends the form layout. + + + + + Selects first visible RibbonTab. + + Returns true if selection is performed otherwise false. + + + + Called when right-mouse button is pressed over RibbonBar + + Reference to RibbonBar object. + + + + Called when right-mouse button is pressed over RibbonStrip + + Reference to RibbonStrip object. + + + + Displays popup customize context menu for given customization object. + + Object that should be customized, usually an instance of BaseItem. + Indicates whether customize menu is displayed over ribbon strip + + + + Raises the QatPlacementChanged event. + + Event arguments. + + + + Removes an item from the Quick Access Toolbar. + + Reference to the item that is already part of Quick Access Toolbar. + + + + Adds an instance of base type BaseItem or RibbonBar to the Quick Access Toolbar. Note that this method creates + new instance of the item or an representation of the item being added and adds that to the Quick Access Toolbar. + + Reference to the item to add, must be an BaseItem type or RibbonBar type. + + + + Raises the BeforeCustomizeMenuPopup event. + + Event arguments + + + + Raises the BeforeAddItemToQuickAccessToolbar event. + + Event arguments. + + + + Shows the quick access toolbar customize dialog. + + + + + Applies the Quick Access Toolbar customization changes made on QatCustomizePanel to the Ribbon Control Quick Access Toolbar. Note that QatCustomizePanel.DataChanged property indicates whether user made any changes to the data on the panel. + + Reference to the QatCustomizePanel + + + + Raises the AfterQatDialogChangesApplied event. + + + + + Returns the ribbon Application Button. + + reference to Application Button or null if button is not found. + + + + Occurs when Quick Access Toolbar placement is changed, i.e. below or above the Ribbon. + + + + + Occurs just before the customize popup menu is displayed and provides the ability to cancel the menu display as well + as to add/remove the menu items from the customize popup menu. + + + + + Occurs before an item is added to the quick access toolbar as result of user action. This event provides ability to + cancel the addition of the item by setting the Cancel=true of event arguments. + + + + + Occurs before an item is removed from the quick access toolbar as result of user action. This event provides ability to + cancel the addition of the item by setting the Cancel=true of event arguments. + + + + + Occurs when DotNetBar is looking for translated text for one of the internal text that are + displayed on menus, toolbars and customize forms. You need to set Handled=true if you want + your custom text to be used instead of the built-in system value. + + + + + Occurs when Item on ribbon tab strip or quick access toolbar is clicked. + + + + + Occurs before Quick Access Toolbar dialog is displayed. This event provides the opportunity to cancel the showing of + built-in dialog and display custom customization dialog. You can also set the Dialog property of the event arguments to + the custom dialog you want used instead of the DotNetBar system customization dialog. + + + + + Occurs after the Quick Access Toolbar dialog is closed. + + + + + Occurs after any changes done on the Quick Access Toolbar dialog are applied to the actual Quick Access Toolbar. + + + + + Occurs after selected Ribbon tab has changed. You can use + RibbonControl.SelectedRibbonTabItem + property to get reference to newly selected tab. + + + + + Occurs before selected RibbonPanel is displayed on popup while ribbon is collapsed. This event gives you the opportunity to cancel the popup of the ribbon panel. + + + + + Occurs after selected RibbonPanel is displayed on popup while ribbon is collapsed. + + + + + Occurs before RibbonPanel popup is closed and provides opportunity to cancel the closing. Note that if you cancel closing of ribbon popup you are + responsible for closing the popup. + + + + + Occurs after RibbonPanel popup is closed. + + + + + Occurs when text markup link from TitleText markup is clicked. Markup links can be created using "a" tag, for example: + Markup link + + + + + Occurs after Expanded property has changed. + + + + + Gets the collection of the Quick Access Toolbar Frequently used commands. You should add existing buttons to this collection that + you already have on the RibbonBar controls or on the application menu. The list will be used to construct the frequently used + menu that is displayed when Customize Quick Access Toolbar menu is displayed and it allows end-user to remove and add these + frequently used commands to the QAT directly from this menu. + Note that items you add here should not be items that are already on Quick Access Toolbar, i.e. in RibbonControl.QuickToolbarItems collection. + + + + + Gets or sets whether KeyTips functionality is enabled. Default value is true. + + + + + Gets or sets whether merge functionality is enabled for the control. Default value is true. + + + + + Gets or sets whether control height is set automatically based on the content. Default value is false. + + + + + Gets or sets whether anti-alias smoothing is used while painting. Default value is false. + + + + + + Gets or sets the Context menu bar associated with the this control which is used as part of Global Items feature. The context menu + bar assigned here will be used to search for the items with the same Name or GlobalName property so global properties can be propagated when changed. + You should assign this property to enable the Global Items feature to reach your ContextMenuBar. + + + + + Gets or sets whether custom caption and quick access toolbar provided by the control is visible. Default value is false. + This property should be set to true when control is used on Office2007RibbonForm. + + + + + Gets or sets the font for the form caption text when CaptionVisible=true. Default value is NULL which means that system font is used. + + + + + Gets or sets the explicit height of the caption provided by control. Caption height when set is composed of the TabGroupHeight and + the value specified here. Default value is 0 which means that system default caption size is used. + + + + + Gets or sets the indent of the ribbon strip. The indent setting is useful when control is used with caption visible and the Office 2007 + style start button. The indent specified here will move the ribbon strip so the start button does not overlap the tabs. + Value of this property is used only when CaptionVisible = true. + Default value is 46. + + + + + Gets or sets the font used by the ribbon strip. + + + + + Gets or sets whether mouse over fade effect is enabled. Default value is true. + + + + + Gets or sets the font that is used to display Key Tips (accelerator keys) when they are displayed. Default value is null which means + that control Font is used for Key Tips display. + + + + + Collection of RibbonTabItemGroup items. Groups are assigned optionally to one or more RibbonTabItem object through the RibbonTabItem.Group + property to visually group tabs that belong to same functions. These tabs should be positioned next to each other. + + + + + Gets or sets the height in pixels of tab group line that is displayed above the RibbonTabItem objects that have group assigned. + Default value is 10 pixels. To show tab groups you need to assign the RibbonTabItem.Group property and set TabGroupsVisible=true. + + + + + Gets or sets whether tab group line that is displayed above the RibbonTabItem objects that have group assigned is visible. + Default value is false. To show tab groups you need to assign the RibbonTabItem.Group property and set TabGroupsVisible=true. Use TabGroupHeight + property to control height of the group line. + + + + + Gets or sets default font for tab groups. This font will be used if font is not specified by group style element. + + + + + Specifies the background style of the control. + + + + + Gets or sets the currently selected RibbonTabItem. RibbonTabItems are selected using the Checked property. Only a single + RibbonTabItem can be selected (Checked) at any given time. + + + + + Returns reference to internal ribbon strip control. + + + + + Returns collection of items on a bar. + + + + + Returns collection of quick toolbar access and caption items. + + + + + Gets/Sets the visual style of the control. If you are changing style to Office 2007 or Office 2010 use RibbonPredefinedColorSchemes.ChangeStyle method instead to ensure + all controls are switched properly. + + + + + Indicates whether control automatically updates Padding property for the ribbon and RibbonPanel based on style. Default value is true. + + + + + Gets or sets the Office 2007 Renderer global Color Table. Setting this property will affect all controls on the form that are using Office 2007 global renderer. + + + + + Gets whether collapsed ribbon is displaying the selected ribbon panel as popup. + + + + + Gets or sets whether mouse wheel scrolls through the ribbon tabs. Default value is true. + + + + + Gets or sets whether control is expanded or not. When control is expanded both the tabs and the tab ribbons are visible. When collapsed + only tabs are visible. + + + + + Gets or sets whether control is collapsed when RibbonTabItem is double clicked and expanded when RibbonTabItem is clicked. + Default value is true. + + + + + Gets or sets whether control is collapsed/expanded when Ctrl+F1 key is clicked. + Default value is true. + + + + + ImageList for images used on Items. Images specified here will always be used on menu-items and are by default used on all Bars. + + + + + ImageList for medium-sized images used on Items. + + + + + ImageList for large-sized images used on Items. + + + + + Gets or sets a value indicating whether the user can give the focus to this control using the TAB key. Default value is false. + + + + + Indicates the position of the BackgroundImage + + + + + Specifies whether the MDI system buttons are displayed in ribbon strip when MDI Child window is maximized. + + + + + Gets or sets whether Ribbon control employs the Windows Vista Glass support when available. This is managed automatically by Ribbon Control and + no setting is necessary on your part. + + + + + Indicates Quick Access Toolbar height when positioned below the Ribbon. Default value of 0 indicates auto-height. + + + + + Gets or sets whether control can be customized and items added by end-user using context menu to the quick access toolbar. + Caption of the control must be visible for customization to be enabled. Default value is true. + + + + + Gets or sets whether external implementation for ribbon bar and menu item customization will be used for customizing the ribbon control. When set to true + it enables the displaying of RibbonBar and menu item context menus which allow customization. You are responsible for + adding the menu items to context menu to handle all aspects of item customization. See "Ribbon Control Quick Access Toolbar Customization" topic in help file under How To. + Default value is false. + + + + + Gets or sets whether end-user customization of the placement of the Quick Access Toolbar is enabled. User + can change the position of the Quick Access Toolbar using the customize menu. Default value is true. + + + + + Gets or sets whether customize dialog is used to customize the quick access toolbar. You can handle the EnterCustomize event + to display your custom dialog instead of built-in dialog for customization. Default value is true. + + + + + Gets or sets the categorization mode for the items on Quick Access Toolbar customize dialog box. Default value categorizes + items by the ribbon bar they appear on. + + + + + Gets or sets whether Quick Access toolbar is positioned below the ribbon. + + + + + Gets or sets the Quick Access Toolbar layout description. You can use the value obtained from this property to save + the customized Quick Access Toolbar into registry or into any other storage object. You can also set the saved layout description back + to restore user customize layout. + + + + + Gets or sets whether Quick Access Toolbar has been customized by end-user. You can use value of this property to determine + whether Quick Access Toolbar layout that can be accessed using QatLayout property should be saved. + + + + + Gets the reference to the ribbon localization object which holds all system text used by the component. + + + + + Provides data for RibbonBar rendering events. + + + + + Gets or sets the reference to Graphics object. + + + + + Gets or sets the part bounds. + + + + + Gets or sets the reference to RibbonBar. + + + + + Gets or sets whether mouse over state should be painted for the ribbon bar part. + + + + + Gets or sets whether mouse is pressed over the ribbon part. + + + + + Gets or sets the region that defines the content bounds. When background is rendered the renderer should set this property + to define the content clip. + + + + + Creates new instance of the object and initializes it with default values. + + Reference to Graphics object. + Bounds of the part to be rendered. + Reference to ribbon bar. + + + + Represents the class that stores text used by ribbon control only for localization purposes. + + + + + Gets or sets the title text of the Quick Access Toolbar Customize dialog form. + + + + + Gets or sets the text of the "Place Quick Access Toolbar below the Ribbon" check-box on the Quick Access Toolbar Customize dialog form. + + + + + Gets or sets the text of the Choose commands from label on the Quick Access Toolbar Customize dialog form. + + + + + Gets or sets the text of the Remove button on the Quick Access Toolbar Customize dialog form. + + + + + Gets or sets the text of the Add button on the Quick Access Toolbar Customize dialog form. + + + + + Gets or sets the text of the OK button on the Quick Access Toolbar Customize dialog form. + + + + + Gets or sets the text of the Cancel button on the Quick Access Toolbar Customize dialog form. + + + + + Gets or sets the text that is used on context menu used to customize Quick Access Toolbar. + + + + + Gets or sets the text that is used on context menu used to customize Quick Access Toolbar. + + + + + Gets or sets the text that is used on context menu used to customize Quick Access Toolbar. + + + + + Gets or sets the text that is used on Quick Access Toolbar customize menu label. + + + + + Gets or sets the text that is used on context menu used to change placement of the Quick Access Toolbar. + + + + + Gets or sets the text that is used on context menu used to change placement of the Quick Access Toolbar. + + + + + Gets or sets the text that is used on context menu item used to minimize the Ribbon. + + + + + Gets or sets the text that is used on context menu item used to maximize the Ribbon. + + + + + Represents ribbon overflow button. + + + + + Gets or sets the ribbon bar control overflow button is displayed on. + + + + + Represents predefined color schemes for ribbon controls. + + + + + Applies default gray color scheme to background and title. + + Reference to object. + + + + Applies orange color scheme to background and title. + + Reference to object + + + + Apply Office 2003 color scheme to background and title. + + Reference to object + + + + Applies Office 2003 color scheme to ribbon control background. + + Reference to object. + + + + Applies Gray color scheme to ribbon control background. + + Reference to object. + + + + Applies Office 2007 color table to ribbon control background. + + Reference to object. + + + + Applies Office 2007 Luna blue color scheme to the Ribbon Bar. + + Reference to object. + + + + Applies specified style to Ribbon control and all other controls that are managed by the ribbon control. + This method is useful for example when switching the color tables for Office 2007 renderer. Once + the GlobalManager.Renderer color table is changed you can call this method to apply color table + changes to the Ribbon Control and other controls managed by it. + + RibbonControl to set the style on. + Visual style to apply. + + + + Applies specified visual style to the RibbonBar control. + + RibbonBar control to set the style on. + Visual style to apply. + + + + Applies current color scheme and layout settings to the container which acts as top-level file menu container. + Applies to Office 2007 style only. + + Container to apply style to. + + + + Applies current color scheme and layout properties to the two column menu container used by the top-level file menu. + Applies to Office 2007 style only. + + Container to apply style to. + + + + Applies current color scheme and layout properties to the first column menu container used by the top-level file menu. + This column usually contains menu items. + Applies to Office 2007 style only. + + Container to apply style to. + + + + Applies current color scheme and layout properties to the first column menu container used by the top-level file menu. + This column usually contains most recently used list of files or documents. + Applies to Office 2007 style only. + + Container to apply style to. + + + + Applies current color scheme and layout properties to the bottom menu container used by the top-level file menu. + This container usually contains Options and Exit buttons. + Applies to Office 2007 style only. + + Container to apply style to. + + + + Changes the Office 2007 color table for all DotNetBar controls on the open forms that are tracked by Application.OpenForms collection. You can use this function for example to + apply Black color scheme to all DotNetBar control on all open forms. The color table will be changed only for controls that + have Office 2007 style. Any other style will be unchanged. + + Color table to select and apply. + + + + Applies current Office 2007 style color table set on GlobalManager.Renderer to all DotNetBar controls with Office 2007 style on all open forms. + + + + + Changes the Office 2007 color table for all DotNetBar controls on the form. You can use this function for example to + apply Black color scheme to all DotNetBar control on given form. The color table will be changed only for controls that + have Office 2007 style. Any other style will be unchanged. + + Form to apply color table to. + Color table to select and apply. + + + + Generates and Changes the Office 2007 color table for all DotNetBar controls on the form. You can use this function for example to + create custom color scheme based on the base color and apply it to all DotNetBar control on given form. The new color table will be applied only to controls that + have Office 2007 style. Any other style will be unchanged. + + Form to apply color table to. + Base color table to use for creation of custom color table that will be applied. + Base color used to create custom color table. + + + + Generates and Changes the Office 2007 color table for all DotNetBar controls on all open forms. You can use this function for example to + create custom color scheme based on the base color and apply it to all DotNetBar control on given form. The new color table will be applied only to controls that + have Office 2007 style. Any other style will be unchanged. + + Base color table to use for creation of custom color table that will be applied. + Base color used to create custom color table. + + + + Applies current Office 2007 style color table to all DotNetBar controls on the form. + + Reference to the form or parent control that contains DotNetBar controls you would like to apply color table to. + + + + Changes style for all controls on Application.OpenForms to specified style. Use this method to change the style for all controls to Office 2007 or Office 2010 styles only. + + New style to assign to controls on forms. + + + + Changes style for all controls on Application.OpenForms to specified style. Use this method to change the style for all controls to Office 2007 or Office 2010 styles only. + + New style to assign to controls on forms. + Color used to blend with the base color scheme. + + + + Changes style for all controls on a form to specified style. Use this method to change the style for all controls to Office 2007 or Office 2010 styles only. + + New style to assign to controls. + Form or Control to process. + + + + Changes style for all controls on a form to specified style. Use this method to change the style for all controls to Office 2007 or Office 2010 styles only. + + New style to assign to controls. + Form or Control to process. + Color used to blend with the base color scheme. + + + + Changes the Office 2010 color table for all DotNetBar controls on the form. You can use this function for example to + apply Black color scheme to all DotNetBar control on given form. The color table will be changed only for controls that + have Office 2007 and 2010 style. Any other style will be unchanged. + + Form to apply color table to. + Color table to select and apply. + + + + Generates and Changes the Office 2010 color table for all DotNetBar controls on the form. You can use this function for example to + create custom color scheme based on the base color and apply it to all DotNetBar control on given form. The new color table will be applied only to controls that + have Office 2007 and 2010 style. Any other style will be unchanged. + + Form to apply color table to. + Base color table to use for creation of custom color table that will be applied. + Base color used to create custom color table. + + + + Generates and Changes the Office 2010 color table for all DotNetBar controls on all open forms. You can use this function for example to + create custom color scheme based on the base color and apply it to all DotNetBar control on given form. The new color table will be applied only to controls that + have Office 2007 and 2010 style. Any other style will be unchanged. + + Base color table to use for creation of custom color table that will be applied. + Base color used to create custom color table. + + + + Changes the Windows 7 color table for all DotNetBar controls on the form. You can use this function for example to + apply Black color scheme to all DotNetBar control on given form. The color table will be changed only for controls that + have Windows 7, Office 2007, 2010 style. Any other style will be unchanged. + + Form to apply color table to. + Color table to select and apply. + + + + Generates and Changes the Windows 7 color table for all DotNetBar controls on the form. You can use this function for example to + create custom color scheme based on the base color and apply it to all DotNetBar control on given form. The new color table will be applied only to controls that + have Windows 7, Office 2007 and 2010 style. Any other style will be unchanged. + + Form to apply color table to. + Base color table to use for creation of custom color table that will be applied. + Base color used to create custom color table. + + + + Generates and Changes the Windows 7 color table for all DotNetBar controls on all open forms. You can use this function for example to + create custom color scheme based on the base color and apply it to all DotNetBar control on given form. The new color table will be applied only to controls that + have Windows 7, Office 2007 and 2010 style. Any other style will be unchanged. + + Base color table to use for creation of custom color table that will be applied. + Base color used to create custom color table. + + + + Defines the Ribbon Quick Access Overflow system item. Used internally by Ribbon control. + + + + + Returns copy of DisplayMoreItem item + + + + + Overriden. Draws the item. + + Target Graphics object. + + + + Returns the insertion index for the items removed from overflow popup. Assumes that right-most items are removed first by the layout manager. + + + + + + Represents RibbonStrip control internally used by RibbonControl. + + + + + Occurs when text markup link is clicked. + + + + + Resets DefaultGroupFont property to default value null. + + + + + Returns automatically calculated height of the control given current content. + + Height in pixels. + + + + Returns the collection of items with the specified name. + + Item name to look for. + + + + + Returns the collection of items with the specified name and type. + + Item name to look for. + Item type to look for. + + + + + Returns the collection of items with the specified name and type. + + Item name to look for. + Item type to look for. + Indicates whether GlobalName property is used for searching. + + + + + Returns the first item that matches specified name. + + Item name to look for. + + + + + Called when ShowKeyTips on RibbonBar contained by this Ribbon is set to true + + + + + Forces the control to exit Ribbon Key-Tips mode. + + + + + Called when item on popup container is right-clicked. + + Instance of the item that is right-clicked. + + + + Returns true if point is inside the caption area. + + Client point coordinates. + True if point is inside of caption area otherwise false. + + + + Occurs when text markup link from TitleText markup is clicked. Markup links can be created using "a" tag, for example: + Markup link + + + + + Gets or sets whether RibbonStrip control employs the Windows Vista Glass support when available. This is managed automatically by Ribbon Control and + no setting is necessary on your part. + + + + + + Gets reference to parsed markup body element if text was markup otherwise returns null. + + + + + Gets or sets whether KeyTips functionality is enabled. Default value is true. + + + + + Gets or sets whether control can be customized and items added by end-user using context menu to the quick access toolbar. + Caption of the control must be visible for customization to be enabled. Default value is true. + + + + + Gets or sets the explicit height of the caption provided by control. Caption height when set is composed of the TabGroupHeight and + the value specified here. Default value is 0 which means that system default caption size is used. + + + + + Gets or sets whether custom caption line provided by the control is visible. Default value is false. + This property should be set to true when control is used on Office2007RibbonForm. + + + + + Gets or sets the font for the form caption text when CaptionVisible=true. Default value is NULL which means that system font is used. + + + + + Gets or sets the indent of the ribbon strip. The indent setting is useful when control is used with caption visible and the Office 2007 + style start button. The indent specified here will move the ribbon strip so the start button does not overlap the tabs. + Value of this property is used only when CaptionVisible = true. + Default value is 46. + + + + + Gets or sets the height in pixels of tab group line that is displayed above the RibbonTabItem objects that have group assigned. + Default value is 14 pixels. To show tab groups you need to assign the RibbonTabItem.Group property and set TabGroupsVisible=true. + + + + + Gets or sets whether tab group line that is displayed above the RibbonTabItem objects that have group assigned is visible. + Default value is false. To show tab groups you need to assign the RibbonTabItem.Group property and set TabGroupsVisible=true. Use TabGroupHeight + property to control height of the group line. + + + + + Collection of RibbonTabItemGroup items. Groups are assigned optionally to one or more RibbonTabItem object through the RibbonTabItem.Group + property to visually group tabs that belong to same functions. These tabs should be positioned next to each other. + + + + + Gets/Sets the visual style of the control. + + + + + Returns collection of items on a bar. + + + + + Returns currently selected RibbonTabItem. RibbonTabItems are selected using the Checked property. Only a single + RibbonTabItem can be Checked at any given time. + + + + + Gets or set whether TabGroup painting is suspended. + + + + + Gets or sets default font for tab groups. This font will be used if font is not specified by group style element. + + + + + Gets or sets whether control is collapsed when RibbonTabItem is double clicked and expanded when RibbonTabItem is clicked. + + + + + Gets or sets whether control is collapsed when RibbonTabItem is double clicked and expanded when RibbonTabItem is clicked. + + + + + Gets or sets whether F10 key is ignored as way to set KeyTips focus to Ribbon. + + + + + Gets whether Ribbon is in key-tips mode including its child controls. + + + + + Returns collection of items on a bar. + + + + + Gets the reference to the internal container item for the items displayed in control caption. + + + + + Gets the reference to the internal container for the ribbon tabs and other items. + + + + + Defines the internal container item for the ribbon strip control. + + + + + Creates new instance of the class and initializes it with the parent RibbonStrip control. + + Reference to parent RibbonStrip control + + + + Paints this base container + + + + + Returns copy of GenericItemContainer item + + + + + Return Sub Item at specified location + + + + + Gets whether Metro Backstage application menu is open. + + + + + Gets reference to internal ribbon strip container that contains tabs and/or other items. + + + + + Gets reference to internal caption container item that contains the quick toolbar, start button and system caption item. + + + + + Gets or sets a value indicating whether the item is expanded or not. For Popup items this would indicate whether the item is popped up or not. + + + + + When parent items does recalc size for its sub-items it should query + image size and store biggest image size into this property. + + + + + Provides data for RenderRibbonTabGroup event. + + + + + Gets or sets Graphics object group is rendered on. + + + + + Gets or sets RibbonTabItemGroup being rendered. + + + + + Gets or sets the bounds of the tab group. Bounds specified here are bounds of the tab group title. GroupBounds contains the bounds + that include all tabs that belong to the tab group. + + + + + Gets or sets the font that should be used to render group text. + + + + + Gets or sets group bounds including the tabs that belong to the group. + + + + + Gets or sets the effective style for the group. + + + + + Gets whether Windows Vista glass is enabled. + + + + + Represents Rendering Tab used on RibbonControl. + + + + + Selects the tab. + + + + + Resets Group property to default value null. + + + + + Called after Checked property has changed. + + + + + Occurs just before Click event is fired. + + + + + Occurs when the item is clicked. This is used by internal implementation only. + + + + + Called when Visibility of the items has changed. + + New Visible state. + + + + Occurs after item visual style has changed. + + + + + Gets or sets whether tab renders its state. Used internally by DotNetBar. Do not set. + + + + + Gets or sets the additional padding added around the tab item in pixels. Default value is 0. + + + + + Gets or sets whether size of the tab has been reduced below the default calculated size. + + + + + Gets or sets the predefined color of item. Color specified here applies to items with Office 2007 style only. It does not have + any effect on other styles. Default value is eRibbonTabColor.Default + + + + + Gets or sets the group this tab belongs to. Groups are optional classification that is used to + visually group tabs that belong to same functions. These tabs should be positioned next to each other. + + + + + Gets or sets the panel assigned to this ribbon tab item. + + + + + Gets or set the Group item belongs to. The groups allows a user to choose from mutually exclusive options within the group. The choice is reflected by Checked property. + + + + + Returns the collection of sub items. + + + + + Indicates whether the item will auto-collapse (fold) when clicked. + When item is on popup menu and this property is set to false, menu will not + close when item is clicked. + + + + + Indicates whether the item will auto-expand when clicked. + When item is on top level bar and not on menu and contains sub-items, sub-items will be shown only if user + click the expand part of the button. Setting this propert to true will expand the button and show sub-items when user + clicks anywhere inside of the button. Default value is false which indicates that button is expanded only + if its expand part is clicked. + + + + + Gets or sets whether item can be customized by end user. + + + + + Gets or set a value indicating whether the button is in the checked state. + + + + + Gets or sets whether Click event will be auto repeated when mouse button is kept pressed over the item. + + + + + Gets or sets the auto-repeat interval for the click event when mouse button is kept pressed over the item. + + + + + Gets or sets a value indicating whether the item is enabled. + + + + + Indicates item's visiblity when on pop-up menu. + + + + + Indicates when menu items are displayed when MenuVisiblity is set to VisibleIfRecentlyUsed and RecentlyUsed is true. + + + + + Indicates Animation type for Popups. + + + + + Indicates the font that will be used on the popup window. + + + + + Indicates whether sub-items are shown on popup Bar or popup menu. + + + + + Specifies the inital width for the Bar that hosts pop-up items. Applies to PopupType.Toolbar only. + + + + + Gets or sets whether item will display sub items. + + + + + Gets or sets whether the item expands automatically to fill out the remaining space inside the container. Applies to Items on stretchable, no-wrap Bars only. + + + + + Gets or sets the width of the expand part of the button item. + + + + + Gets or set the alternative shortcut text. + + + + + Gets or sets whether item separator is shown before this item. + + + + + Returns category for this item. If item cannot be customzied using the + customize dialog category is empty string. + + + + + Gets or sets the text color of the button when mouse is over the item. + + + + + Indicates the way item is painting the picture when mouse is over it. Setting the value to Color will render the image in gray-scale when mouse is not over the item. + + + + + Gets or sets the text color of the button. + + + + + Represents a group RibbonTabItem objects are assigned to. + + + + + Selected first tab that is part of this group. + + + + + Gets or sets the predefined color of the group. Color specified here applies to groups with Office 12 style only. It does not have + any effect on other styles. Default value is eRibbonTabGroupColor.Default + + + + + Gets or sets the custom color name. Name specified here must be represented by the coresponding object with the same name that is part + of the Office2007ColorTable.RibbonTabGroupColors collection. See documentation for Office2007ColorTable.RibbonTabGroupColors for more information. + If color table with specified name cannot be found default color will be used. Valid settings for this property override any + setting to the Color property. + + + + + Gets the style for tab group. + + + + + Gets or sets title of the group that will be displayed when group is visually represented. + + + + + Gets or sets parent ribbon strip for this group. + + + + + Gets or sets whether RibbonTabItem objects that belong to this group are visible. Setting this property will + show/hide all RibbonTabItem objects that are assigned to this group through RibbonTabItem.Group property. + + + + + Gets whether any tab from this tab group is selected. + + + + + Gets or sets name of the group that can be used to identify item from the code. + + + + + Gets an array of Rectangle objects that describe the visual position on the ribbon control of the group titles displayed. + If tabs that belong to a tab group are not next to each other then there will be multiple rectangle returned as part of the array + for each tab group that is apart. + + + + + Collection of RibbonTabItemGroup objects. + + + + + Adds new object to the collection. + + Object to add. + Index of newly added object. + + + + Adds new objects to the collection. + + Array of groups to add. + + + + Inserts new object into the collection. + + Position of the object. + Object to insert. + + + + Returns index of the object inside of the collection. + + Reference to the object. + Index of the object. + + + + Returns whether collection contains specified object. + + Object to look for. + true if object is part of the collection, otherwise false. + + + + Removes specified object from the collection. + + + + + + Copies collection into the specified array. + + Array to copy collection to. + Starting index. + + + + Copies contained items to the RibbonTabItemGroup array. + + Array to copy to. + + + + Returns reference to the object in collection based on it's index. + + + + + Returns reference to the object in collection based on it's name. + + + + + Provides data for ButtonItem rendering. + + + + + Gets or sets Graphics object group is rendered on. + + + + + Gets the reference to ButtonItem instance being rendered. + + + + + Reference to internal data. + + + + + Creates new instance of the object. + + + + + Creates new instance of the object and initializes it with default values + + Reference to Graphics object. + Reference to ButtonItem object. + + + + Creates new instance of the object and initializes it with default values + + Reference to Graphics object. + Reference to ButtonItem object. + + + + Summary description for SimpleElement. + + + + + Summary description for SimpleElementLayout. + + + + + Indicates absolute vertical alignment of the content. + + + + + Content is aligned to the top + + + + + Content is aligned in the middle + + + + + Content is aligned at the bottom + + + + + Indicates absolute horizontal alignment + + + + + Content is left aligned + + + + + Content is centered + + + + + Content is right aligned + + + + Indicates alignment of a part of the cell like image or check box in relation to the text. + + + + Part is aligned to the left center of the text assuming left-to-right + orientation. + + + + + Part is aligned to the right center of the text assuming left-to-right + orientation. + + + + + Part is aligned to the top left of the text assuming left-to-right + orientation. + + + + Part is aligned above the text and centered. + + + + Part is aligned to the top right of the text assuming left-to-right + orientation. + + + + + Part is aligned to the bottom left of the text assuming left-to-right + orientation. + + + + Part is aligned below the text and centered. + + + + Part is aligned to the bottom right of the text assuming left-to-right + orientation. + + + + + Summary description for SimpleNodeDisplay. + + + + + Represents information neccessary to paint the cell on canvas. + + + + + Represents the slider item which allows you to select a value from predefined range. + + + + + Creates new instance of SliderItem. + + + + + Creates new instance of SliderItem and assigns the name to it. + + Item name. + + + + Creates new instance of SliderItem and assigns the name and text to it. + + Item name. + item text. + + + + Returns copy of the item. + + + + + Copies the SliderItem specific properties to new instance of the item. + + New SliderItem instance. + + + + Copies the SliderItem specific properties to new instance of the item. + + New SliderItem instance. + + + + Raises the IncreaseButtonClick event. + + Provides event arguments + + + + Raises the DecreaseButtonClick event. + + Provides event arguments + + + + Returns the Font object to be used for drawing the item text. + + Font object. + + + + Advances the current position of the slider by the amount of the Step property. + + + + + Advances the current position of the slider by the amount of the Step property. + + + + + Advances the current position of the slider by the specified amount. + + The amount by which to increment the sliders current position. + + + + Advances the current position of the slider by the specified amount. + + The amount by which to increment the sliders current position. + + + + Raises the ValueChanged event. + + + + + Raises the ValueChanged event. + + + + + Raises the ValueChanging event. + + + + + Returns whether property should be serialized. Used by Windows Forms designer. + + + + + Resets the property to default value. Used by Windows Forms designer. + + + + + Occurs after Value property has changed. + + + + + Occurs before Value property has changed. + + + + + Occurs when Increase button is clicked using mouse. + + + + + Occurs when Decrease button is clicked using mouse. + + + + + Gets or sets the slider mouse over part. + + + + + Gets or sets the slider part that mouse is pressed over. This property should not be modified and it is for internal usage only. + + + + + Returns the label bounds inside of the control. + + + + + Gets or sets the text associated with this item. + + + + + Gets whether item supports text markup. Default is false. + + + + + Gets or sets whether text-markup support is enabled for items Text property. Default value is true. + Set this property to false to display HTML or other markup in the item instead of it being parsed as text-markup. + + + + + Gets or sets the maximum value of the range of the control. + + + + + Gets or sets the minimum value of the range of the control. + + + + + Gets or sets the current position of the slider. + + + + + Gets or sets the amount by which a call to the PerformStep method increases the current position of the slider. Value must be greater than 0. + + + + + Gets or sets whether the text label next to the slider is displayed. + + + + + Gets or sets the width of the slider part of the item in pixels. Value must be greater than 0. Default value is 136. + + + + + Gets or sets the width of the label part of the item in pixels. Value must be greater than 0. Default value is 38. + + + + + Gets or sets the text label position in relationship to the slider. Default value is Left. + + + + + Gets or sets whether Click event will be auto repeated when mouse button is kept pressed over the item. + + + + + Gets or sets the auto-repeat interval for the click event when mouse button is kept pressed over the item. + + + + + Gets or sets whether vertical line track marker is displayed on the slide line. Default value is true. + + + + + Gets or sets the color of the label text. + + + + + Gets or sets the Key Tips access key or keys for the item when on Ribbon Control or Ribbon Bar. Use KeyTips property + when you want to assign the one or more letters to be used to access an item. For example assigning the FN to KeyTips property + will require the user to press F then N keys to select an item. Pressing the F letter will show only keytips for the items that start with letter F. + + + + + Gets or sets the collection of shortcut keys associated with the item. + + + + + Gets or sets whether item will display sub items. + + + + + Specifies whether item is drawn using Themes when running on OS that supports themes like Windows XP. + + + + + Gets or sets whether the item expands automatically to fill out the remaining space inside the container. Applies to Items on stretchable, no-wrap Bars only. + + + + + Gets or sets the tooltip for the Increase button of the slider. + + + + + Gets or sets the tooltip for the Decrease button of the slider. + + + + + Gets or sets the slider orientation. Default value is horizontal. + + + + + Gets or sets the custom color table for the item. Color table here will override all system color table settings. + + + + + Indicates spacing for an user interface element either padding or margins. + + + + + Gets or sets the amount of the space on the left side. + + + + + Gets or sets the amount of the space on the right side. + + + + + Gets or sets the amount of the space on the top. + + + + + Gets or sets the amount of the space on the bottom. + + + + + Gets total horizontal spacing. + + + + + Gets total vertical spacing. + + + + + Gets whether all memebers of class are set to 0. + + + + + Summary description for SubItemsCollection. + + + + + Sorts the items in the collection using the built in IComparable on each item which sorts items by the Text property. + + + + + Sorts the items in the collection using specified comparer. + + Comparer to use for item sorting. + + + + Gets whether MinimumTooltipSize property should be serialized. + + + + + Retrieves SuperTooltipInfo for given component or return null if component does not have tooltip associated with it. + + + + + Associates SuperTooltipInfo with given component. + + Reference to supported component. + Instance of SuperTooltipInfo class. If null is passed the SuperTooltip is detached from the given component. + + + + Raises the MarkupLinkClick event. + + + + + Shows SuperTooltip for given object that has been registered using SetSuperTooltip method at specific location on the screen. + + Object to show tooltip for. Object must be registered using SetSuperTooltip method before tooltip is shown for it. + Specifies the explicit position of the SuperTooltip in screen coordinates. + + + + Shows SuperTooltip for given object that has been registered using SetSuperTooltip method. + + Object to show tooltip for. Object must be registered using SetSuperTooltip method before tooltip is shown for it. + + + + Shows SuperTooltip for given object that has been registered using SetSuperTooltip method. + + Object to show tooltip for. Object must be registered using SetSuperTooltip method before tooltip is shown for it. + + + + Raises the TooltipClosed event. + + Provides event arguments. + + + + Hides tooltip if it is visible. + + + + + Resets Hoover timer. + + + + + Occurs just before tooltip is displayed and gives you opportunity to cancel showing of tooltip. + + + + + Occurs after tooltip has been closed. + + + + + Occurs when text markup link is clicked. Markup links can be created using "a" tag, for example: + Markup link + + + + + Gets or sets the maximum width of the super tooltip. Default value is 0 which indicates that maximum width is not used. The maximum width property + will not be used if custom size is specified. + + + + + Gets or sets whether form active state is ignored when control is deciding whether to show tooltip. By default this property is set to false + which indicates that tooltip will be shown only if parent form is active. When set to true the form active state is ignored when + deciding whether to show tooltip. + + + + + Gets or sets whether anti-alias smoothing is used while painting. Default value is true. + + + + + Gets or sets whether SuperTooltip will be shown for the controls assigned to it. Default value is true. You can set + this property to false to disable SuperTooltip for all controls assigned to it. + + + + + Gets or sets whether tooltip is shown immediately after the mouse enters the control. The default value is false which indicates + that tooltip is shown after system hover timeout has expired which provides slight delay before tooltip is shown. + + + + + Gets or sets the minimum tooltip size. Default value is 150 width and 24 height. + + + + + Gets or sets the duration in seconds that tooltip is kept on screen after it is displayed. Default value is 20 seconds. + You can set this value to 0 to keep tooltip displayed until user moves mouse out of control or application loses focus. + + + + + Gets or sets the delay time for hiding the tooltip in milliseconds after + mouse has left the control. Default value is 0 which means that tooltip will be + hidden as soon as mouse leaves the control tooltip was displayed for. You can use + this property to provide the user with enough time to move the mouse cursor to the + tooltip so user can act on the content of the tooltip, like hyper links. + + + + + Gets or sets whether tooltip position is checked before tooltip is displayed and adjusted to tooltip always + falls into screen bounds. Default value is true. + + + + + Gets or sets whether tooltip position is checked before tooltip is displayed and adjusted so tooltip does not overlaps the + control it is displayed for. Default value is true. + + + + + Gets or sets the tooltip position in relationship to the control tooltip is providing information for. + Set this property to false if you want tooltip to be displayed below the mouse cursor. Default value is + true which indicates that tooltip is displayed below mouse cursor but it is positioned below the control + that it provides the information for so it is not covering its content. + + + + + Gets or sets default setting for new Tooltips you create in design time. If all your tooltips have common elements + you can change this property to reflect these default setting before you start writing tooltips for all controls on the form. + As you start creating new tooltips for controls on the form default values specified here will be used as starting values + for new tooltip you are creating. + + + + + Returns instance of default tooltip information used in design-time. + + + + + Gets the reference to internal Hashtable that contains reference to all controls and assigned SuperTooltips. This + collection must not be modified directly and it is automatically managed by the SuperTooltip component. You can use it + for example to change the color for all SuperTooltips managed by the component but you should not add or remove items to it. + Instead use SetSuperTooltip methods to add or remove the tooltip for a component. + + + + + Gets or sets the hover delay multiplier which controls how fast tooltip appears. The value set here indicates + how many hover events are needed to occur before the tooltip is displayed. + + + + + Returns whether tooltip is visible. + + + + + Gets reference to instance of tooltip control if any has been created at the time call is made. + + + + + Gets or sets default tooltip font. Default value is null which means that default system font is used. + + + + + Gets or sets whether complete tooltip is shown including header, body and footer. Default value is true. When set to false only tooltip header will be shown. + Providing this option to your end users as part of your application setting allows them to customize the level of information displayed and reduce it after they are familiar with your product. + + + + + Gets or sets whether tooltip is shown when control that tooltip is assigned to is focused. You can set this value to false to disable Tooltip display when control receives input focus. Default value is true. + + This property is effective only when Super Tooltip is assigned to the controls that inherit from System.Windows.Forms.Control class and it relies on Focused property of respective control for proper function. + + + + Provides information about SuperTooltip attached to a component. + + + + + Creates new instance of the class. + + + + + Creates new instance of the class with specified parameters. + + + + + Creates new instance of the class with specified parameters. + + + + + Returns whether property should be serialized. + + + + + Gets or sets whether tooltip header text is visible or not. Default value is true. + + + + + Gets or sets whether tooltip footer text is visible or not. Default value is true. + + + + + Gets or sets the header text. + + + + + Gets or sets the footer text. + + + + + Gets or sets body text. + + + + + Gets or sets body image displayed to the left of body text. + + + + + Gets or sets footer image displayed to the left of footer text. + + + + + Gets or sets the custom size for tooltip. Default value is 0,0 which indicates that tooltip is automatically + resized based on the content. + + + + + Gets or sets predefined tooltip color. + + + + + Extensibility interface that custom components may implement + so SuperTooltip can be provided for them. + + + + + This event should be triggered by the component when it wants to display SuperTooltip. Normally + this event would be equivalent of MouseHover event but you can trigger it in response to anything else. + Sender for this event must be object that implements ISuperTooltipInfoProvider interface. + + + + + This event should be triggered by component when it wants to hide SuperTooltip. For example this event + might be triggered when mouse leaves your component. Sender of this event must be object that implements ISuperTooltipInfoProvider interface. + + + + + Returns rectangle of the visible area of the component in screen coordinates. This rectangle is used + to position SuperTooltip on the screen. + + + + + Delegate for SuperTooltip events. + + + + + Represents event arguments for PanelChanging event. + + + + + Set to true to cancel display of tooltip. + + + + + Object that has triggered displaying of tooltip + + + + + Information that will be used to populate tooltip. + + + + + Location where tooltip will be displayed. You can change the location here to display tooltip at different position. + + + + + Indicates the tooltip size, read-only and valid only if tooltip position is checked on screen. + + + + + Default constructor. + + + + + Represents SuperTooltipControl. + + + + + Default constructor. + + + + + Paints insides of the control. + + Paint event arguments. + + + + Recalculates and set size of the control based on the content that is made available to it. + + + + + Calculates the tooltip height based on the specified width. + + Tooltip width + Size of the tooltip based on specified width. + + + + Shows tooltip at specified screen coordinates. + + X coordinate + Y coordinate + Indicates whether to enforce the screen position of tooltip if tooltip falls out of screen bounds. + + + + Updates the popup shadow size and position if shadow is visible. + + + + + Gets or sets whether complete tooltip is shown including header, body and footer. Default value is true. When set to false only tooltip header will be shown. + Providing this option to your end users as part of your application setting allows them to customize the level of information displayed and reduce it after they are familiar with your product. + + + + + Gets or sets the maximum width of the super tooltip. Default value is 0 which indicates that maximum width is not used. The maximum width property + will not be used if custom size is specified. + + + + + Gets or sets the minimum tooltip size. Default value is 150, 50 + + + + + Gets or sets image used next to body text. + + + + + Gets or sets image used next to footer text. + + + + + Gets or sets text displayed in header of tooltip + + + + + Gets or sets whether header in tooltip is visible. Default value is true. + + + + + Gets or sets text displayed in footer of the tooltip + + + + + Gets or sets whether footer in tooltip is visible. Default value is true. + + + + + Gets or sets whether line above footer text is drawn to separate footer from body text. Default value is true. + + + + + Gets or sets whether mouse click on super tooltip will activate it, make it active window. Default value is true. + + + + + Gets or sets whether tooltip control is popup tooltip or standard control. Default is false which means tooltip is popup style. + + + + + Represents class that holds padding information for user interface elements. + + + + + Gets or sets padding on left side. Default value is 0 + + + + + Gets or sets padding on right side. Default value is 0 + + + + + Gets or sets padding on top side. Default value is 0 + + + + + Gets or sets padding on bottom side. Default value is 0 + + + + + Creates new instance of the class and initializes it. + + Padding for all sides + + + + Creates new instance of the class and initializes it. + + Left padding + Right padding + Top padding + Bottom padding + + + + Raises the PropertyChanged event. + + Event arguments + + + + Gets amount of Top padding + + + + + Gets amount of Left padding + + + + + Gets amount of Bottom padding + + + + + Gets amount of Right padding + + + + + Gets amount of horizontal padding (Left+Right) + + + + + Gets amount of vertical padding (Top+Bottom) + + + + + Gets whether Padding is empty. + + + + + Gets or sets the padding for all sides. + + + + + Occurs when property value has changed. + + + + + Summary description for ThemedButtonItemPainter. + + + + + Provides data for toolbar rendering. + + + + + Gets or sets the reference to Bar object being rendered + + + + + Gets or sets Graphics object bar is rendered on. + + + + + Gets the bounds of the region that should be rendered. + + + + + Reference to internal data. + + + + + Creates new instance of the object and initializes it with default data. + + Reference to bar object. + Reference to Graphics object. + + + + Describes the round rectangle shape. + + + + + Initializes a new instance of the RoundCornerDescriptor class. + + + + + Initializes a new instance of the RoundCornerDescriptor class. + + + + + Initializes a new instance of the RoundCornerDescriptor class. + + + + + + + + + Gets or sets the top-left round corner size. + + + + + Gets or sets the top-right round corner size. + + + + + Gets or sets the bottom-left round corner size. + + + + + Gets or sets the bottom-right round corner size. + + + + + Gets whether all corner size values are set to zero which results in no rounded corners. + + + + + Gets whether all corner size values are set to same value. + + + + + Represents DocumentDockContainer object converter. + + + + + Initializes a new instance of the ScrollBarAdv class. + + + + + Called by StyleManager to notify control that style on manager has changed and that control should refresh its appearance if + its style is controlled by StyleManager. + + New active style. + + + + Gets whether scrollbar is vertical. + + true if scrollbar is vertical otherwise false for horizontal scrollbar + + + + Raises the Scroll event. + + Provides Event arguments. + + + + Raises the ValueChanged event. + + Provides Event arguments. + + + + Called when Command property value changes. + + + + + Occurs when the Value property is changed, either by a Scroll event or programmatically. + + + + + Occurs when the scroll box has been moved by either a mouse or keyboard action. + + + + + Gets or sets a value to be added to or subtracted from the Value property when the scroll box is moved a large distance. + A numeric value. The default value is 10. + ArgumentOutOfRangeException is raised if assigned value is less than 0. + + + + + Gets or sets the upper limit of values of the scrollable range. + A numeric value. The default value is 100. + + + + + Gets or sets the lower limit of values of the scrollable range. + A numeric value. The default value is 0. + + + + + Gets or sets the value to be added to or subtracted from the Value property when the scroll box is moved a small distance. + A numeric value. The default value is 1. + ArgumentOutOfRangeException is raised if assigned value is less than 0. + + + + + Gets or sets a numeric value that represents the current position of the scroll box on the scroll bar control. + A numeric value that is within the Minimum and Maximum range. The default value is 0. + ArgumentOutOfRangeException is raised if assigned value is less than the Minimum property value or assigned value is greater than the Maximum property value. + + + + + Gets or sets the scroll bar appearance style. + + + + + Gets or sets the command assigned to the item. Default value is null. + Note that if this property is set to null Enabled property will be set to false automatically to disable the item. + + + + + Gets or sets user defined data value that can be passed to the command when it is executed. + + + + + Summary description for ScrollButton. + + + + + Clean up any resources being used. + + + + + Represents class that provides shadows to elements. + + + + + Creates new instance of shadow painter. + + + + + Represents class that provides display context for shadow painter. + + + + + Summary description for ShortcutList. + + + + + Represents the Outlook like Side-bar Control. + + + + + Creates new instance of side bar control. + + + + + Clean up any resources being used. + + + + + Called by StyleManager to notify control that style on manager has changed and that control should refresh its appearance if + its style is controlled by StyleManager. + + New active style. + + + + Returns the renderer control will be rendered with. + + The current renderer. + + + + Raises ItemLayoutUpdated event. + + Provides event arguments. + + + + Invokes ItemDoubleClick event. + + Reference to item double-clicked + Event arguments + + + + Returns the collection of items with the specified name. + + Item name to look for. + + + + + Returns the collection of items with the specified name and type. + + Item name to look for. + Item type to look for. + + + + + Returns the collection of items with the specified name and type. + + Item name to look for. + Item type to look for. + + + + + Returns the first item that matches specified name. + + Item name to look for. + + + + + Invokes the DotNetBar Customize dialog. + + + + + Invokes SerializeItem event. + + Provides data for the event. + + + + Invokes DeserializeItem event. + + Provides data for the event. + + + + Loads the Side bar definition from file. + + Definition file name. + + + + Saves the Side bar definition to file. + + Definition file name. + + + + Occurs when Checked property of an button has changed. + + + + + Occurs when Item is clicked. + + + + + Occurs when Item is clicked. + + + + + Occurs when popup of type container is loading. + + + + + Occurs when popup of type container is unloading. + + + + + Occurs when popup item is about to open. + + + + + Occurs when popup item is closing. + + + + + Occurs just before popup window is shown. + + + + + Occurs when Item Expanded property has changed. + + + + + Occurs when mouse button is pressed. + + + + + Occurs when mouse button is released. + + + + + Occurs when mouse enters the item. + + + + + Occurs when mouse leaves the item. + + + + + Occurs when mouse moves over the item. + + + + + Occurs when mouse remains still inside an item for an amount of time. + + + + + Occurs when item loses input focus. + + + + + Occurs when item receives input focus. + + + + + Occurs when user changes the item position, removes the item, adds new item or creates new bar. + + + + + Occurs after an Item is removed from SubItemsCollection. + + + + + Occurs after an Item has been added to the SubItemsCollection. + + + + + Occurs when ControlContainerControl is created and contained control is needed. + + + + + Occurs when Text property of an Item has changed. + + + + + Use this event if you want to serialize the hosted control state directly into the DotNetBar definition file. + + + + + Use this event if you want to deserialize the hosted control state directly from the DotNetBar definition file. + + + + + Occurs after DotNetBar definition is loaded. + + + + + Occurs before an item in option group is checked and provides opportunity to cancel that. + + + + + Occurs before tooltip for an item is shown. Sender could be the BaseItem or derived class for which tooltip is being displayed or it could be a ToolTip object itself it tooltip is not displayed for any item in particular. + + + + + Occurs after an item has been serialized to XmlElement and provides you with opportunity to add any custom data + to serialized XML. This allows you to serialize any data with the item and load it back up in DeserializeItem event. + + + To serialize custom data to XML definition control creates handle this event and use CustomXmlElement + property on SerializeItemEventArgs to add new nodes or set attributes with custom data you want saved. + + + + + Occurs after an item has been de-serialized (load) from XmlElement and provides you with opportunity to load any custom data + you have serialized during SerializeItem event. + + + To de-serialize custom data from XML definition handle this event and use CustomXmlElement + property on SerializeItemEventArgs to retrive any data you saved in SerializeItem event. + + + + + Gets or sets the redering mode used by control. Default value is eRenderMode.Global which means that static GlobalManager.Renderer is used. If set to Custom then Renderer property must + also be set to the custom renderer that will be used. + + + + + Gets or sets the custom renderer used by the items on this control. RenderMode property must also be set to eRenderMode.Custom in order renderer + specified here to be used. + + + + + Gets or sets visual appearance for the control. + + + + + Gets or sets whether flat side bar is using system colors. + + + This property is used internally by side bar to determine whether to reset color scheme based on system colors. + If you want side bar to use system colors you need to set PredefinedColorScheme property. + + + + + Gets or sets Bar Color Scheme. + + + + + Gets/Sets the visual style of the SideBar. + + + + + Specifies whether SideBar is drawn using Themes when running on OS that supports themes like Windows XP. + + + + + Occurs after internal item layout has been updated and items have valid bounds assigned. + + + + + Returns the collection of side-bar Panels. + + + + + Gets or sets the expanded panel. Only one panel can be expanded at a time. + + + + + Gets or sets the form SideBar is attached to. + + + + + Gets or sets whether end-user can rearrange the items inside the panels. + + + + + Gets or sets whether native .NET Drag and Drop is used by side-bar to perform drag and drop operations. AllowDrop must be set to true to allow drop of the items on control. + + + + + Gets or sets whether external ButtonItem object is accepted in drag and drop operation. UseNativeDragDrop must be set to true in order for this property to be effective. + + + + + Gets or sets whether gray-scale algorithm is used to create automatic gray-scale images. Default is true. + + + + + ImageList for images used on Items. Images specified here will always be used on menu-items and are by default used on all Bars. + + + + + ImageList for medium-sized images used on Items. + + + + + ImageList for large-sized images used on Items. + + + + + Indicates whether Tooltips are shown on Bars and menus. + + + + + Indicates whether item shortcut is displayed in Tooltips. + + + + + Indicates whether Reset buttons is shown that allows end-user to reset the toolbar state. + + + + + Returns the reference to the container that containing the sub-items. + + + + + Gets/Sets control border style. + + + + + Gets whether any handlers have been defined for SerializeItem event. If no handles have been defined to optimize performance SerializeItem event will not be attempted to fire. + + + + + Gets whether any handlers have been defined for DeserializeItem event. If no handles have been defined to optimize performance DeserializeItem event will not be attempted to fire. + + + + + Gets/Sets Bar definition as XML string. + + + + + Indicates whether shortucts handled by items are dispatched to the next handler or control. + + + + + Represents the method that will handle the ItemRemoved event. + + + + + Provides layout for Side-Bar control. + + + + + Creates new instance of SideBarContainerItem class. + + + + + Returns copy of SideBarContainerItem item + + + + + Recalculates the size of the item + + + + + Paints this base container + + + + + Occurs when sub item expanded state has changed. + + Sub item affected. + + + + Occurs when the mouse pointer is over the item and a mouse button is pressed. This is used by internal implementation only. + + + + + Sets input focus to next visible item in Explorer Bar. + + True if focus was set to next visible item otherwise false. + + + + Sets input focus to previous visible item in Explorer Bar. + + True if focus was set to previous visible item otherwise false. + + + + Gets or sets a value indicating whether the item is expanded or not. For Popup items this would indicate whether the item is popped up or not. + + + + + Summary description for SideBarPanelControl. + + + + + Represents the Side-Bar Panel item. + + + + + Creates new instance of SideBarPanelItem. + + + + + Creates new instance of SideBarPanelItem and assigns the name to it. + + Item name. + + + + Creates new instance of SideBarPanelItem and assigns the name and text to it. + + Item name. + item text. + + + + Returns copy of SideBarPanelItem item. + + + + + Returns the Font object to be used for drawing the item text. + + Font object. + + + + Occurs when the mouse pointer is moved over the item. This is used by internal implementation only. + + + + + Occurs when the mouse pointer is over the item and a mouse button is pressed. This is used by internal implementation only. + + + + + Occurs when the item is clicked. This is used by internal implementation only. + + + + + Overloaded. Serializes the item and all sub-items into the XmlElement. + + XmlElement to serialize the item to. + + + + Overloaded. Deserializes the Item from the XmlElement. + + Source XmlElement. + + + + Shows tooltip for this item. + + + + + Forces the repaint the item. + + + + + Must be called by any sub item that implements the image when image has changed + + + + + Gets whether mouse is over the panel header. + + + + + Gets whether mouse is pressed over the panel header. + + + + + Specifies panel title text alignment. Default value is Center. + + + + + Gets or sets the layout type for the items. Default layout orders items in a single column. Multi-column layout will order + items in multiple colums based on the width of the control. + + + + + Gets or sets the text associated with this item. + + + + + Gets or sets the item background style. + + + + + Gets or sets the item header style. Applies only when SideBar.Appearance is set to Flat. + + + + + Gets or sets the item header style when mouse is over the header. Applies only when SideBar.Appearance is set to Flat. + + + + + Gets or sets the item header style when left mouse button is pressed on header. Applies only when SideBar.Appearance is set to Flat. + + + + + Gets or sets the item header side style. Applies only when SideBar.Appearance is set to Flat. + + + + + Gets or sets the item header side style when mouse is over the header. Applies only when SideBar.Appearance is set to Flat. + + + + + Gets or sets the item header side style when left mouse button is pressed on header. Applies only when SideBar.Appearance is set to Flat. + + + + + Gets or sets whether the font used to draw the item text is bold. + + + + + Gets or sets whether the font used to draw the item text is bold when mouse is over the item. + + + + + Gets or sets whether the font used to draw the item text is underlined when mouse is over the item. + + + + + Gets or sets the text color of the button when mouse is over the item. + + + + + Gets or sets the text color of the button. + + + + + Gets/Sets the Image size for all sub-items on the Bar. + + + + + Gets the rectangle of the panel item Button. + + + + + Gets or sets the index of the first visible item on the panel. + + + + + Gets or sets a value that determines whether text is displayed in multiple lines or one long line. + This setting applies to the buttons inside Panel as well. + + + + + Gets or sets whether scroll buttons are displayed when content of the panel exceeds it's height. + + + + + Specifies the Button icon. Icons support multiple image sizes and alpha blending. + + + + + Specifies the Button image. + + + + + Specifies the index of the image for the button if ImageList is used. + + + + + Specifies the image for the button when mouse is over the item. + + + + + Specifies the index of the image for the button when mouse is over the item when ImageList is used. + + + + + Specifies the image for the button when mouse left button is pressed. + + + + + Specifies the index of the image for the button when mouse left button is pressed and ImageList is used. + + + + + Represents class that provide display support for simple tabs. + + + + + Default constructor. + + + + + Provides layout management for ISimpleTab tab implementations. + + + + + Resizes the content block and sets it's Bounds property to reflect new size. + + Content block to resize. + + + + Represents painter for Mozilla style splitter. + + + + + Base class for painting expandable splitter control. + + + + + Default constructor. + + + + + Paints splitter. + + Paint information. + + + + Creates new instance of splitter painter. + + + + + Paints splitter. + + Paint information. + + + + Represents painter for Office 2003 style splitter. + + + + + Creates new instance of splitter painter. + + + + + Paints splitter. + + Paint information. + + + + Represents class that holds information neccessary to paint the expandable splitter. + + + + + Specifies reference to graphics canvas. + + + + + Specifies splitter display rectangle. + + + + + Holds color settings for painting. + + + + + Specifies whether splitter is expandable or not. + + + + + Specifies whether splitter is expanded or not. + + + + + Specifies the splitter dock. + + + + + Represents class that holds colors for the splitter display. + + + + + Specifies back color. + + + + + Specifies target gradient background color. + + + + + Specifies background gradient angle. + + + + + Specifies grip part dark color. + + + + + Specifies grip part light color. + + + + + Specifies expand part line color. + + + + + Specifies expand part fill color. + + + + + Initializes a new instance of the StyleManager class. + + + + + Initializes a new instance of the StyleManager class with the specified container. + + An IContainer that represents the container for the command. + + + + Updates Ambient colors for control and its child controls. + + + + + + Updates ambient colors for the control and its children. + + + + + + Gets whether property should be serialized by WinForms designer. + + + + + Resets property to its default value. + + + + + Changes the StyleManager style and color tint in one step. Use this method if you need to change style and color tint simultaneously in single step for better performance. + + New style. + Color tint for the style. + + + + Registers control with the StyleManager so control can be notified of global style changes. + + Control to register with the StyleManager. + + + + Unregister the control from StyleManager notifications. + + Control that was registered through Register method. + + + + Returns whether style is a Metro type style. + + style to test. + true if Metro type style otherwise false. + + + + Returns whether style is a Metro type style. + + style to test. + true if Metro type style otherwise false. + + + + Returns whether style is a Metro type style. + + style to test. + true if Metro type style otherwise false. + + + + Gets or sets the global style for the controls that have Style=ManagerControlled. + + + + + Gets or sets the color current style is tinted with. + + + + + Gets previous effective style. + + + + + Gets or sets color generation parameters for Metro color generator. + + + + + Gets or sets color generation parameters for Metro color generator. + + + + + Gets or sets the current visual style. + + + + + Gets or sets the color tint that is applied to current Office 2007, Office 2010 or Windows 7 color table. + Default value is Color.Empty which indicates that no color blending is performed. + + + + + Defines the StyleManager styles. + + + + + Manages whether ambient property settings (BackColor, ForeColor etc.) are applied to child controls of the form when StyleManager component changes style. + + + + + Initializes a new instance of the StyleManagerAmbient class. + + + + + Initializes a new instance of the StyleManagerAmbient class with the specified container. + + An IContainer that represents the container for the command. + + + + Gets ambient settings StyleManager is allowed to change on the control. + + + + + Sets the ambient settings StyleManager is allowed to change on component. + + Reference to supported component. + Ambient settings that StyleManager may change. + + + + Specifies ambient settings enabled on the control for StyleManager. + + + + + All ambient settings are allowed to change. + + + + + StyleManager cannot change ambient settings. + + + + + StyleManager should process child controls. + + + + + StyleManager should change BackColor. + + + + + StyleManager should change ForeColor. + + + + + Constructor + + Associated SuperTabItem + + + + Paint processing + + + + + + Gets the default tab ContentRectangle + + Rectangle + + + + Gets the tab ContentRectangle + + Rectangle + + + + Gets the tab path + + GraphicsPath + + + + Sets the default color tables + + + + + Gets the tab ColorTable + + ColorTable + + + + Gets the tab state + + eTabState + + + + Gets the tab panel Color Table + + Color Table + + + + Draws the tab background + + Graphics + Tab path + StateColorTable + + + + Draws the tab border + + Graphics + Tab path + Color table + + + + Draws the tab contents + + Graphics + State color table + + + + Draws the tab image + + Graphics + + + + Draws the tab text + + + + + + + Draws the tab close button + + Graphics + State color table + + + + Sets the GraphicsTransform for the given alignment + and Horizontal text setting + + Graphics + Rectangle to transform + Transformed rectangle + + + + Resets out transform + + Graphics + + + + Gets the focus rectangle + + + + + + + Gets the tab close button bitmap + + Graphics + State color table + Button bitmap + + + + Creates the close button bitmap + + Graphics + State color table + Close bitmap + + + + Gets the hot close button bitmap + + Graphics + Close bitmap + + + + Creates the hot button bitmap + + Graphics + Close bitmap + + + + Gets the pressed close button bitmap + + Graphics + Close bitmap + + + + Creates the pressed button bitmap + + Graphics + Close bitmap + + + + Gets the close button path + + Close rectangle + Corner radius + + + + + Gets or sets the default item ColorTable + + + + + Constructor for Office2007 style SuperTabItem base display + + Associated SuperTabItem + + + + Creates the tab item GraphicsPath + + Tab path + + + + Create the Top tab path + + GraphicsPath + + + + Creates the Bottom tab path + + GraphicsPath + + + + Creates the Left tab path + + GraphicsPath + + + + Create the Right tab path + + GraphicsPath + + + + Constructor + + Associated SuperTabStripItem + + + + Handles ContentManager NextPosition events + + + + + + + Handles RecalcSize requests + + + + + + Handles RecLayoutContent requests + + + + + Initializes the layout engine + + + + + + Performs the Recalc Layout + + + + + + Recalculates the bounds for the TabControlBox + + + + + + + Gets the tab client area + + + + + + Gets the tab client area + + + + + + Gets the tab height + + + + + + Layout manager NextBlockPosition + + + + + + PromoteTab NextBlockPosition + + + + + + + + Determines if all tabs are visible + + + + + + Paint processing + + + + + + Draws the background + + + + + + + Draws the tabs + + + + + + Draws the Drag and Drop insert marker + + ItemPaintArgs + Color table + + + + Draws the top insert marker + + + + + + Draws the left insert marker + + + + + + Determines if the given items are on the same line + + + + + + + + Draws the TabStrip border + + + + + + + Gets the inner and outer border lines + + + + + + + Sets the default color table + + + + + Gets the tab color table + + Tab color table + + + + Gets the tab close button bitmap + + + + + + + + Creates the tab close button bitmap + + + + + + + Gets the Menu button bitmap + + + + + + + + Create the Menu button bitmap + + + + + + + Gets the Menu button path + + + + + + Gets the Menu button bitmap + + + + + + + + Create the Menu button bitmap + + + + + + + Gets the Menu button path + + + + + + Gets the TabAlignment + + + + + gets or sets the default color table + + + + + Gets if display is RightToLeft + + + + + Gets tab vertical orientation + + + + + Gets the minimum TabStrip height + + + + + Gets whether we are to show the Focus rectangle + + + + + Gets CloseButtonOnTabsVisible + + + + + Gets FixedTabSize + + + + + Gets the minimum tab size + + + + + Gets the selected tab + + + + + Gets the selected font + + + + + Gets the tab ControlBox + + + + + Gets the tab height + + + + + Gets the tab bounds + + + + + Gets the Tabs collection + + + + + Gets the TabStrip + + + + + Gets the TabStripItem + + + + + Gets the PreDrawStripBorder state + + + + + Gets the SelectedPaddingWidth + + + + + Gets the TabOverlap + + + + + Gets the TabSpacing + + + + + Gets the TabOverlapLeft + + + + + Gets the TabLayoutOffset + + + + + Office2007 TabStrip base display constructor + + Associated TabStrip + + + + Tab layout offsets + + + + + Office 2010 Backstage SuperTabItem display constructor + + Associated SuperTabItem + + + + Draws the tab border + + + + + + + + Draws the Backstage SelectedItem marker + + + + + + + DrawTabItemBackground + + + + + + + + DrawTabItemHighLight + + + + + + + + + Creates the tab item GraphicsPath + + Tab path + + + + Create the Top tab path + + GraphicsPath + + + + Creates the Bottom tab path + + GraphicsPath + + + + Creates the Left tab path + + GraphicsPath + + + + Create the Right tab path + + GraphicsPath + + + + Gets the Layout manager NextBlockPosition + + + + + + Gets the "PromoteSelTab" NextBlockPosition + + + + + + + + Draws the background + + + + + + + PreDrawStripBorder + + + + + SelectedPaddingWidth + + + + + Constructor for OfficeMobile2014 style SuperTabItem base display + + Associated SuperTabItem + + + + Calculates the Content Rectangle for the tab + + Content Rectangle + + + + Creates the tab item GraphicsPath + + Tab path + + + + Create the Top tab path + + GraphicsPath + + + + Creates the Bottom tab path + + GraphicsPath + + + + Creates the Left tab path + + GraphicsPath + + + + Create the Right tab path + + GraphicsPath + + + + OfficeMobile2014 SuperTabStripBaseDisplay + + Associated TabStripItem + + + + Gets the next layout block position + + LayoutManagerPositionEventArgs + + + + Gets the next block position when attempting + to make a specific tab visible + + Potential item to replace + View item being placed + Block Rectangle + + + + Returns the Minimum tab size for this style + + + + + Tab layout offsets + + + + + Tab Overlap + + + + + Tab Spacing + + + + + Constructor for OneNote2007 style SuperTabItem base display + + Associated SuperTabItem + + + + Calculates the Content Rectangle for the tab + + Content Rectangle + + + + Creates the tab item GraphicsPath + + Tab path + + + + Create the Top tab path + + GraphicsPath + + + + Creates the Bottom tab path + + GraphicsPath + + + + Creates the Left tab path + + GraphicsPath + + + + Create the Right tab path + + GraphicsPath + + + + OneNote2007 SuperTabStripBaseDisplay + + Associated TabStripItem + + + + Gets the next layout block position + + LayoutManagerPositionEventArgs + + + + Gets the next block position when attempting + to make a specific tab visible + + Potential item to replace + View item being placed + Block Rectangle + + + + Returns the Minimum tab size for this style + + + + + Tab Overlap + + + + + Tab Spacing + + + + + Constructor + + Associated SuperTabControlBox + + + + Performs RecalcSize processing + + + + + Refreshes the CloseBox + + + + + Performs control Paint processing + + + + + + InternalMouseEnter + + + + + InternalMouseLeave + + + + + InternalMouseDown + + + + + + InternalMouseUp + + + + + + Returns copy of the item + + + + + Gets or sets the CloseBox Visible state + + + + + Gets whether the mouse is down + + + + + Gets whether the mouse is over the CloseBox + + + + + Constructor + + Associated SuperTabStripItem + + + + Performs RecalcSize processing + + + + + Performs RecalcLayout processing + + + + + Performs individual running layout processing for the given BaseItem + + Item to Layout + Running Layout Size + Whether a recalcSize is needed + New running Size + + + + Refresh code + + + + + Paint processing + + + + + + InternalMouseEnter + + + + + InternalMouseLeave + + + + + InternalMouseMove + + + + + + InternalMouseDown + + + + + + InternalMouseUp + + + + + + Gets the ControlBoxItem from the given Point + + + + + + + OnItemAdded + + + + + + OnAfterItemRemoved + + + + + + Removes all user added items from the ControlBox + + + + + Returns copy of the item. + + + + + Gets or sets the ControlBox Bounds + + + + + Gets the CloseBox + + + + + Gets the MenuBox + + + + + Gets or sets the ControlBox Visible state + + + + + Gets the MouseDown state + + + + + Gets the MouseOver state + + + + + Gets the TabStrip TabDisplay + + + + + Constructor + + Associated SuperTabControlBox + + + + RecalcSize + + + + + Refreshes the display + + + + + Paint processing + + + + + + Determines if all the items are visible + + true if all visible + + + + Gets MenuButton1 + + + + + + + + Gets MenuButton2 + + + + + + + + InternalMouseEnter + + + + + InternalMouseLeave + + + + + InternalMouseDown + + + + + + Gets the popup menu position + + + + + + Loads the TabMenu + + + + + Loads Tabs only into the TabMenu + + + + + + Loads all items into the TabMenu + + + + + + Sets the TabMenu entry image + + + + + + + Handles SuperTabMenuBox_Click event + + + + + + + InternalMouseUp + + + + + + Returns copy of the item. + + + + + Gets or sets whether the MenuBox is automatically hidden when the tab items size does not exceed the size of the control + + + + + Gets or sets whether the MenuBox raises a ClickEvent when selected + + + + + Gets or sets whether MenuBox shows only Tabs entries + + + + + Gets or sets whether the MenuBox displays each menu entry with its associated Image/Icon + + + + + Gets or sets MenuBox Visible state + + + + + Gets the MouseDown state + + + + + Gets the MouseOver state + + + + + Constructor + + + + + Sets the tab docking based upon the given alignment + + + + + + Hooks (or unhooks) underlying TabStrip events + + true to hook, false to unhook + + + + Handles TabItemOpen events + + + + + + + Handles TabItemClose events + + + + + + + Handles TabMoving events + + + + + + + Handles TabMoved events + + + + + + + Handles TabRemoved events + + + + + + + Handles SelectedTabChanging events + + + + + + + Handles SelectedTabChanged events + + + + + + + Handles GetTabItemPath events + + + + + + + Handles GetTabItemContentRectangle events + + + + + + + Handles BeforeTabDisplay events + + + + + + + Handles MeasureTabItem events + + + + + + + Handles PreRenderTabItem events + + + + + + + Handles PostRenderTabItem events + + + + + + + Handles GetTabCloseBounds events + + + + + + + Handles GetTabImageBounds events + + + + + + + Handles GetTabTextBounds events + + + + + + + Handles TabStripPaintBackground events + + + + + + + Handles StyleManagerStyleChanged events + + + + + + Handles TabStripTabColorChanged events + + + + + + + Handles TabStrip_MouseUp events + + + + + + + Handles TabStrip_MouseDown events + + + + + + + Handles TabStrip_MouseMove events + + + + + + + Handles TabStrip_MouseClick events + + + + + + + Handles TabStrip_MouseDoubleClick events + + + + + + + Handles TabStrip_MouseEnter events + + + + + + + Handles TabStrip_MouseHover events + + + + + + + Handles TabStrip_MouseLeave events + + + + + + + Creates a TabControl tab + + + + + + + Creates a TabControl tab + + + + + + + + Creates a TabControl tab + + + + + + + + + Selects the previous tab + + true if tab selected + + + + Selects the next tab + + true if tab selected + + + + Gets the SuperTabItem tab containing the given Point + + Point to test + Associated tab, or null + + + + Gets the item (SuperTabItem or BaseView) associated + with the given Point + + Point to test + BaseItem or null + + + + Closes the given tab + + + + + + Causes a Layout Recalculation of the SuperTabControl + + + + + Refreshes all panel styles + + + + + Applies color and border settings to the given panel + + + + + + Applies color settings to the given panel + + + + + + + Applies border settings for the given panel + + + + + + Performs OnSystemColorsChanged processing + + + + + + Performs OnResize processing + + + NOT NEEDED. Let WinForms layout do the work! + + + + OnControlAdded + + + + + + OnControlRemoved + + + + + + BeginInit + + + + + EndInit + + + + + Occurs when a tab is added to the Tabs collection + + + + + Occurs when a tab is about to Close + + + + + Occurs when a tab is removed from the Tabs collection + + + + + Occurs when a tab is about to be displayed + + + + + Occurs when a tab is being moved or dragged by the user + + + + + Occurs when a tab has been moved or dragged by the user + + + + + Occurs when the Selected tab is changing + + + + + Occurs when the Selected tab has changed + + + + + Occurs when the control needs a tab's bordering path + + + + + Occurs when the control needs a tab's Content Rectangle + + + + + Occurs when the control needs to measure a tab + + + + + Occurs before any tab rendering is done + + + + + Occurs After all tab rendering is complete + + + + + Occurs when the control needs to get the tab's Text Bounds + + + + + Occurs when the control needs to get the tab's Image Bounds + + + + + Occurs when the control needs to get the tab's Close Button Bounds + + + + + Occurs when the TabStrip background needs painted + + + + + Occurs when a TabStrip MouseUp event is raised + + + + + Occurs when a TabStrip MouseDown event is raised + + + + + Occurs when a TabStrip MouseMove event is raised + + + + + Occurs when a TabStrip MouseClick event is raised + + + + + Occurs when a TabStrip MouseDoubleClick event is raised + + + + + Occurs when a TabStrip MouseEnter event is raised + + + + + Occurs when a TabStrip MouseHover event is raised + + + + + Occurs when a TabStrip MouseLeave event is raised + + + + + Gets or sets whether TabStrip will get focus when Tab key is used. Default value is false. + + + + + Gets or sets whether tabs are automatically closed when a close button is clicked + + + + + Gets or sets whether the tab's visible close button is displayed for every tab state + + + + + Gets or sets whether close button is visible on each tab + + + + + Gets or sets the position of the tab close button + + + + + Gets or sets the custom tab Close button image + + + + + Gets or sets the custom Close button image that is used on tabs when the mouse is over the close button + + + + + Gets or sets the custom Close button image that is used on tabs when the button has been pressed + + + + + Gets the TabStrip ControlBox + + + + + Gets or sets whether the only Text displayed is for the SelectedTab + + + + + Gets or sets whether text is drawn horizontally regardless of tab orientation + + + + + Gets or sets the default alignment of the Image within the tab + + + + + Gets or sets the ImageList used by the TabStrip and its tab items + + + + + Gets or sets BaseItem tab padding in pixels. + + + + + Gets or sets whether vertical tab text is rotated 180 degrees + + + + + Gets or sets the SelectedTab based upon the given panel + + + + + Gets or sets whether a focus rectangle is displayed when tab has input focus + + + + + Gets or sets the fixed tab size in pixels. Either Height, Width, or both can be set + + + + + Gets or sets whether a tab is currently in a drag operation + + + + + Gets or sets whether tabs can be reordered through the user interface + + + + + Gets or sets the selected tab + + + + + Gets or sets the selected tab Font + + + + + Gets or sets the index of the selected tab + + + + + Gets or sets the tab alignment within the Tab-Strip control + + + + + Gets or sets the tab Font + + + + + Gets or sets the Horizontal spacing around tab elements + + + + + Gets or sets the type of the tab layout + + + + + Gets the collection of Tabs + + + + + Gets the control TabStrip + + + + + Gets or sets the Color of the TabStrip + + + + + Gets or sets the tab style + + + + + Gets or sets the Vertical spacing around tab elements + + + + + Gets or sets whether tabs are visible + + + + + Gets or sets tab text alignment + + + + + Gets the DefaultSize + + + + + Indicates whether Form.Validate is called and checked before selected tab is changed. Default value is true. + + + + + Represents Panel for the SuperTabControl + + + + + + _PanelColor_ColorTableChanged + + + + + + + Processes ColorTable changes + + + + + GetStyle + + + + + + Provides OnPaint support + + + + + + Occurs when the tab colors have changed + + + + + Gets or sets which edge of the parent container a control is docked to. + + + + + Gets or sets user specified tab panel display colors + + + + + Gets or sets the Panel ElementStyle + + + + + Gets or sets TabItem that this panel is attached to. + + + + + Specifies background image position when container is larger than image. + + + + + Constructor + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Called when Symbol property has changed. + + Old property value + New property value + + + + Called when SymbolSet property value changes. + + Indciates old value + Indicates new value + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Called when SymbolSize property has changed. + + Old property value + New property value + + + + Hooks or unhooks control events + + true to hook + + + + SuperTabItem_TextChanged processing + + + + + + + TextMarkupLinkClick + + + + + + + OnMarkupLinkClick + + + + + + ColorTable_ColorTableChanged + + + + + + + Processes ColorTable changes + + + + + Closes the tab + + + + + Gets the operational tab font + + + + + + Gets the tab ColorTable + + SuperTabItemStateColorTable + + + + Gets the tab ColorStateTable for the given state + + eTabState + SuperTabItemStateColorTable + + + + Gets the tab Panel ColorTable + + + + + + Gets the area of the tab that contains the given Point + + + + + + + Determines if the given Point is in the tab + + Point to test + true if Point is in tab + + + + Gets the tab bordering GraphicsPath + + GraphicsPath + + + + Gets the Close Button bounding Rectangle + + Bounding Rectangle + + + + Gets the Image bounding Rectangle + + Bounding Rectangle + + + + Gets the Text bounding Rectangle + + Bounding Rectangle + + + + Calculates Close button bounds + + Running rectangle + Running rectangle + + + + Calculates Image bounds + + Running rectangle + Running rectangle + + + + Refreshes the tab owner + + + + + Refreshes the tab display + + + + + Paint processing + + + + + + InternalMouseMove + + + + + + InternalMouseEnter + + + + + InternalMouseLeave + + + + + InternalMouseDown + + + + + + InternalMouseUp + + + + + + ToString + + + + + + Dispose + + + + + Returns copy of the item. + + + + + Copies specific properties to new instance of the item. + + New SuperTabItem instance + + + + Occurs when text markup link is clicked + + + + + Occurs when the tab colors have changed + + + + + IsMarkupSupported + + + + + Gets or sets the default SelectedTabFont + + + + + Gets the tab CloseButton Bounds + + + + + Gets or sets the CloseButtonMouseOver state + + + + + Gets or sets the CloseButtonPressed state + + + + + Gets the effective image alignment + + + + + Gets the tab Image Bounds + + + + + Gets the tabs vertical orientation + + + + + Gets the TabItemDisplay + + + + + Gets the tabs TabStrip + + + + + Gets the tabs Text Bounds + + + + + Gets or sets whether image animation is enabled + + + + + Gets or sets user specified tab display colors + + + + + Gets or sets whether Close button on the tab is visible when SuperTabStrip.CloseButtonOnTabsVisible property is set to true + + + + + Enabled + + + + + Gets or sets whether text-markup support is enabled for the control's Text property + + + + + Gets or sets the FixedTabSize + + + + + Gets or sets the tab icon. Icon has same functionality as Image except that it supports Alpha blending + + + + + Gets or sets the tab image + + + + + Gets or sets the tab image index + + + + + Gets or sets the alignment of the Image within the tab + + + + + Gets or sets the spacing between content and edges of the Image + + + + + Gets or sets the predefined color for the tab + + + + + Gets or sets the selected tab Font + + + + + StartsNewTabLine + + + + + Gets the realized symbol string. + + + + + Indicates the symbol displayed on face of the button instead of + the image. Setting the symbol overrides the image setting. + + + + + Gets or sets the symbol set used to represent the Symbol. + + + + + Gets or sets the color of the Symbol. + + + + + Indicates the size of the symbol in points. + + + + + Gets or sets the text alignment + + + + + Gets or sets the tab Font + + + + + Gets or sets the tab text + + + + + Gets or sets the control that is attached to this tab + + + + + Gets or sets the tab Bounds + + + + + Gets the MouseOver state + + + + + Gets the tab selected state + + + + + Gets the tab alignment + + + + + Gets the tab Content Rectangle + + + + + Gets or sets the tab TabStripItem + + + + + Gets or sets the tabs TabStyle + + + + + Visible + + + + + Alignment + + + + + + + + + TopLeft + + + + + TopCenter + + + + + TopRight + + + + + MiddleLeft + + + + + MiddleCenter + + + + + MiddleRight + + + + + BottomLeft + + + + + BottomCenter + + + + + BottomRight + + + + + Tab area parts + + + + + Tab states + + + + + Constructor + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + ShowWithoutActivation + + + + + Constructor + + + + + Hooks or unhooks TabStripItem events + + true to hook + + + + TabStripItem_TabItemOpen + + + + + + + TabStripItem_TabItemClose + + + + + + + TabStripItem_TabRemoved + + + + + + + TabStripItem_TabMoving + + + + + + + TabStripItem_TabMoved + + + + + + + TabStripItem_GetTabItemPath + + + + + + + TabStripItem_GetTabItemContentRectangle + + + + + + + TabStripItem_BeforeTabDisplay + + + + + + + TabStripItem_MeasureTabItem + + + + + + + TabStripItem_PreRenderTabItem + + + + + + + TabStripItem_PostRenderTabItem + + + + + + + TabStripItem_GetTabCloseBounds + + + + + + + TabStripItem_GetTabImageBounds + + + + + + + TabStripItem_GetTabTextBounds + + + + + + + TabStripItem_TabStripPaintBackground + + + + + + + TabStripItem_SelectedTabChanging + + + + + + + TabStripItem_SelectedTabChanged + + + + + + + TabStripItem_TabStripTabColorChanged + + + + + + + Called by StyleManager to notify control that style on manager has changed and that control should refresh its appearance if + its style is controlled by StyleManager. + + New active style. + + + + Performs layout recalculation + + + + + Ensures that the given tab is visible on the TabStrip + + + + + + Gets the SuperTabItem from the given Point + + + SuperTabItem or null + + + + Gets the BaseItem from the given Point + + + BaseItem or null + + + + Closes the given tab + + + + + + Selects the previous tab + + true if successful + + + + Selects the next tab + + true if successful + + + + OnResize processing + + + + + + BeginInit + + + + + EndInit + + + + + Occurs when a tab is added to the Tabs collection + + + + + Occurs when a tab is about to Close + + + + + Occurs when a tab is removed from the Tabs collection + + + + + Occurs when a tab is about to be displayed + + + + + Occurs when a tab is being moved or dragged by the user + + + + + Occurs when a tab has been moved or dragged by the user + + + + + Occurs when the Selected tab is changing + + + + + Occurs when the Selected tab has changed + + + + + Occurs when the control needs a tab's bordering path + + + + + Occurs when the control needs a tab's Content Rectangle + + + + + Occurs when the control needs to measure a tab + + + + + Occurs before any tab rendering is done + + + + + Occurs After all tab rendering is complete + + + + + Occurs when the control needs to get the tab's Text Bounds + + + + + Occurs when the control needs to get the tab's Image Bounds + + + + + Occurs when the control needs to get the tab's Close Button Bounds + + + + + Occurs when the TabStrip background needs painted + + + + + Occurs when the TabStrip TabColor has changed + + + + + Gets or sets whether the control attached to the TabItem.AttachedControl property + is automatically selected when TabItem becomes the selected tab. Default value is true. + + + + + Gets or sets whether tabs are automatically closed when a close button is clicked + + + + + Gets or sets whether the tab's visible close button is displayed for every tab state + + + + + Gets or sets whether close button is visible on each tab + + + + + Gets or sets the position of the tab close button + + + + + Gets or sets the custom tab Close button image + + + + + Gets or sets the custom Close button image that is used on tabs when the mouse is over the close button + + + + + Gets or sets the custom Close button image that is used on tabs when the button has been pressed + + + + + Gets the TabStrip ControlBox + + + + + Gets or sets whether the only Text displayed is for the SelectedTab + + + + + Gets or sets the default alignment of the Image within the tab + + + + + Gets or sets BaseItem tab padding in pixels. + + + + + Gets or sets whether vertical tab text is rotated 180 degrees + + + + + Gets or sets the fixed tab size in pixels. Either Height, Width, or both can be set + + + + + Gets or sets whether a tab is currently in a drag operation + + + + + Gets or sets whether tabs can be reordered through the user interface + + + + + Gets or sets the selected tab + + + + + Gets or sets the selected tab Font + + + + + Gets or sets the index of the selected tab + + + + + Gets or sets the tab alignment within the Tab-Strip control + + + + + Gets or sets the tab Font + + + + + Gets or sets the Horizontal spacing around tab elements + + + + + Gets or sets the type of the tab layout + + + + + Gets the collection of Tabs + + + + + Gets or sets the Color of the TabStrip + + + + + Gets or sets the tab style + + + + + Gets or sets the Vertical spacing around tab elements + + + + + Gets the TabStrip associated TabStripItem + + + + + Gets or sets tab text alignment + + + + + Gets whether the tabStrip is visually available + + + + + Gets the Design state for the control + + + + + Gets the ISupportInitialize state + + + + + Gets the TabDisplay + + + + + Gets or sets the reference to ribbon application button when tab control is used as backstage ribbon control. + + + + + Gets the DefaultSize + + + + + Constructor + + Associated SuperTabStrip + + + + Syncs the Orientation of each SubItem to + the current TabAlignment Orientation + + + + + Gets the Orientation based upon the current + TabAlignment + + + + + + Makes sure all newly added items + are set to the design orientation and style + + + + + + Applies the current TabStyle to each tab and + sets the item style to the DotNetBarStyle from the TabStyle + + + + + Gets the DotNetBarStyle from the SuperTabStyle + + eDotNetBarStyle + + + + Hooks or unhooks our events + + + + + + Handles SubItemsChanged events + + + + + + + Handles newly added items + + + + + + Handles newly removed items + + + + + + Handles tab color changes + + + + + + + Handles color table changes + + + + + + + Performs NeedRecalcSize and refresh + + + + + Recalculates the size of the tabs. + + + + + Ensures that the given item is visible on the TabStrip + + + + + + Selects the given tab + + + + + + + Selects the previous tab + + + + + + Selects the previous tab + + + + + + Selects the next tab + + + + + + Selects the next tab + + + + + + UpdateSelectedTab + + + + + OnTabStyleChanged + + + + + OnMeasureTabItem + + + + + + + + + OnPreRenderTabItem + + + + + + + + OnPostRenderTabItem + + + + + + + OnGetTabItemContentRectangle + + + + + + + OnGetTabItemPath + + + + + + + OnSelectedTabRemoved + + + + + + + OnSelectedTabChanging + + + + + + + + OnSelectedTabChanged + + + + + + + + OnBeforeTabDisplay + + + + + + OnTabItemClose + + + + + + + OnTabStripColorChanged + + + + + OnPaintBackground + + + + + + + OnGetTextBounds + + + + + + + + OnGetImageBounds + + + + + + + + OnGetCloseBounds + + + + + + + + OnTabMoving + + + + + + + + + OnTabMoved + + Tab that was moved + Old tab order + New tab order + + + + + ItemAtLocation + + + + + + + + InternalClick + + + + + + + InternalMouseDown + + + + + + InternalMouseUp + + + + + + InternalMouseMove + + + + + + InternalOnMouseMove + + + + + + ProcessMouseMove + + + + + + HotTabMouseMove + + + + + + + ControlBoxMouseMove + + + + + + ProcessTabMove + + + + + + StartTabMove + + + + + + + SetDragWindowRegion + + + + + TabDragWindow_Paint + + + + + + + InternalMouseLeave + + + + + InternalOnMouseLeave + + + + + Get the tab at the given Point + + + SuperTabItem or null + + + + Gets the item at the given point + + + BaseItem or null + + + + Gets the next visible Tab + + + SuperTabItem + + + + Closes the given tab + + + + + + Paint processing + + + + + + SubItemSizeChanged + + + + + + Returns copy of the item. + + + + + Copies specific properties to new instance of the item. + + New SuperTabStripItem instance + + + + Occurs when a tab is added to the Tabs collection + + + + + Occurs when a tab is about to Close + + + + + Occurs when a tab is removed from the Tabs collection + + + + + Occurs when a tab is about to be displayed + + + + + Occurs when a tab is being moved or dragged by the user + + + + + Occurs when a tab has been moved or dragged by the user + + + + + Occurs when the Selected tab is changing + + + + + Occurs when the Selected tab has changed + + + + + Occurs when the control needs a tab's bordering path + + + + + Occurs when the control needs a tab's Content Rectangle + + + + + Occurs when the control needs to measure a tab + + + + + Occurs before any tab rendering is done + + + + + Occurs After all tab rendering is complete + + + + + Occurs when the control needs to get the tab's Text Bounds + + + + + Occurs when the control needs to get the tab's Image Bounds + + + + + Occurs when the control needs to get the tab's Close Button Bounds + + + + + Occurs when the TabStrip background needs painted + + + + + Occurs when the TabStrip TabColor has changed + + + + + Occurs when the TabStrip Color has changed + + + + + Gets or sets AutoCloseTabs + + + + + Gets or sets whether the control attached to the TabItem.AttachedControl property + is automatically selected when TabItem becomes the selected tab. Default value is true. + + + + + Gets or sets TabCloseButtonNormal + + + + + Gets or sets TabCloseButtonHot + + + + + Gets or sets TabCloseButtonPressed + + + + + Gets or sets TabHorizontalSpacing + + + + + Gets or sets TabVerticalSpacing + + + + + Gets or sets CloseButtonOnTabsVisible + + + + + Gets or sets CloseButtonOnTabsAlwaysDisplayed + + + + + Gets or sets CloseButtonPosition + + + + + Gets the ControlBox + + + + + Gets or sets DisplaySelectedTextOnly + + + + + Gets or set the Expanded state + + + + + Gets or sets the tab font + + + + + Gets or sets the selected tab font + + + + + Gets or sets the HorizontalText + + + + + Gets or sets the default alignment of the Image within the tab + + + + + Gets or sets the BaseItem tab padding. + + + + + Gets or sets RotateVerticalText + + + + + Gets or sets ShowFocusRectangle + + + + + Gets or sets the FixedTabSize + + + + + Gets or sets + + + + + Gets the MinTabStripHeight + + + + + Gets or sets ReorderTabsEnabled + + + + + Gets or sets the selected tab + + + + + Gets or sets the selected tab index + + + + + Gets or sets the tab alignment + + + + + Gets or sets the TabLayoutType + + + + + Gets or sets the TabStripColor + + + + + Gets or sets the TabStyle + + + + + Gets or sets the TextAlignment + + + + + Gets the First Visible Tab + + + + + Gets the HotTab + + + + + Gets the InsertTab + + + + + Gets whether to insert before or after + + + + + Gets the MouseOver tab + + + + + Gets TabStrip vertical orientation + + + + + Gets the Last Visible Tab + + + + + Gets the tab close button size + + + + + Gets the TabDisplay + + + + + Gets or sets the TabItemsBounds + + + + + Gets or sets the number of TabLines + + + + + Gets the TabStrip + + + + + Gets the visible tab count + + + + + Gets or sets the promoted visible tab + + + + + Generic ValueChangingEventArgs + + oldValue type + newValue type + + + + Gets the old value + + + + + Gets the new value + + + + + Generic ValueChangingSourceEventArgs + + oldValue type + newValue type + EventSource + + + + Gets the old value + + + + + Gets the new value + + + + + Gets the eventSource + + + + + Generic ValueChangedEventArgs + + oldValue type + newValue type + + + + Gets the old value + + + + + Gets the new value + + + + + Generic ValueChangedSourceEventArgs + + oldValue type + newValue type + EventSource + + + + Gets the old value + + + + + Gets the new value + + + + + Gets the eventSource + + + + + Gets the tab + + + + + Gets the tab + + + + + Gets the old order of the tabs + + + + + Gets or sets the new order of the tabs + + + + + TabStripTabColorChangedEventArgs + + + + + Constructor + + + + + Constructor + + Associated SuperTabStripItem + + + + Resizes the content block and sets it's Bounds property to reflect new size. + + Content block to resize. + + + + + Measures the given tab + + + + + + + Measures the markup text + + + + + + + + + Measures the given text + + + + + + + + + Finalizes the layout + + + + + + + + + Reorders the lines to keep the selected tab as line 0. + + + + + + + Adjusts the line layout + + + + + + + Gets the array od line sizes + + + + + + + Adjusts the individual blocks within a given line + + + + + + + Sets the Displayed status for the line blocks + + + + + + + Gets the count of BeginBreak groups + + + + + + + + Process item BeginBreaks + + + + + + + + + Makes sure the "VisibleTab" is in fact visible. + + + + + + + Determines what line th selected tab lies within + + + + + + + Finds the SelectedTab block + + + + + + + Resizes single line layouts + + + + + + Resizes multiline layouts + + + + + + gets or sets the FixedTabSize + + + + + Gets or sets the TabLayoutOffset + + + + + Gets the TabDisplay + + + + + Creates the tab item GraphicsPath + + Tab path + + + + Create the Top tab path + + GraphicsPath + + + + Creates the Bottom tab path + + GraphicsPath + + + + Creates the Left tab path + + GraphicsPath + + + + Create the Right tab path + + GraphicsPath + + + + Applies the predefined tab color to the color table + + + + + + + Applies the predefined color to the panel color table + + + + + + Constructor + + Associated SuperTabStripItem + + + + Gets the TabLayoutOffset + + + + + Constructor + + Associated SuperTabItem + + + + Returns the tab ContentRectangle + + + + + + Creates the tab item GraphicsPath + + Tab path + + + + Create the Top tab path + + GraphicsPath + + + + Creates the Bottom tab path + + GraphicsPath + + + + Creates the Left tab path + + GraphicsPath + + + + Create the Right tab path + + GraphicsPath + + + + Constructor + + Associated SuperTabStripItem + + + + Gets the LayoutManager NextBlockPosition + + + + + + Gets the PromoteSelectedTab NextBlockPosition + + + + + + + + Gets the TabOverlap + + + + + Gets the TabSpacing + + + + + Gets the TabOverlapLeft + + + + + Gets the TabLayoutOffset + + + + + Gets the MinTabSize + + + + + Constructor + + Associated SuperTabItem + + + + Creates the tab item GraphicsPath + + Tab path + + + + Create the Top tab path + + GraphicsPath + + + + Creates the Bottom tab path + + GraphicsPath + + + + Creates the Left tab path + + GraphicsPath + + + + Create the Right tab path + + GraphicsPath + + + + Constructor + + Associated SuperTabStripItem + + + + Gets the Layout manager NextBlockPosition + + + + + + Gets the "PromoteSelTab" NextBlockPosition + + + + + + + + Raises ValueChanging event. + + Provides event arguments. + + + + Raises ValueChanged event. + + Provides event arguments. + + + + Forces the button to perform internal layout. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Cancels animation if in progress. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Sets the value of the control with state transition animation (if enabled) and specifies the source of the action. + + New value for Value property. + Source of the action. + + + + Sets the value of the control and specifies the source of the action. + + New value for Value property. + Source of the action. + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Raises ValueObjectChanged event. + + Provides event arguments. + + + + Called when Command property value changes. + + + + + Occurs before Value property has changed and it allows you to cancel the change. + + + + + Occurs after Value property has changed. + + + + + Gets or sets the switch value. + + + + + Gets or sets the item border color. + + + + + Gets or sets whether state transition animation is enabled. + + + + + Gets or sets the color of the OFF state background. + + + + + Gets or sets the color of the ON state background. + + + + + Gets or sets the color of the ON state text. + + + + + Gets or sets the color of the OFF state text. + + + + + Gets or sets the border color of the button switch. + + + + + Gets or sets the background color of the switch button. + + + + + Gets or sets the text color. + + + + + Gets or sets the font that is used to draw ON/OFF text on the switch button. + + + + + Gets or sets the text that is displayed on switch when Value property is set to true. + + + + + Gets or sets the text that is displayed on switch when Value property is set to false. + + + + + Gets or sets the width in pixels of the switch part of the button. Minimum value is 6. + + + + + Gets the switch bounds. + + + + + Gets the On part of the switch button bounds excluding the SwitchBounds. + + + + + Gets the Off part of the switch button bounds excluding the SwitchBounds. + + + + + Gets or sets whether button is in read-only state meaning that it appears as enabled but user cannot change its state. + + + + + Gets or sets whether lock marker is visible on face of the control when IsReadOnly is set to true. + Default value is true. + + + + + Gets or sets the color of the read-only marker. + + + + + Indicates whether clicking left mouse button on the switch part of the item will toggle the switch Value. + + + + + Occurs after ValueObject property changes. + + + + + Gets or sets the object that represents the Value state of control. + + + + + Gets or sets the value that represents the True state of control when ValueObject property is set to that value. + + + + + Gets or sets the value that represents the False state of control when ValueObject property is set to that value. + + + + + Gets or sets the command assigned to the item. Default value is null. + Note that if this property is set to null Enabled property will be set to false automatically to disable the item. + + + + + Gets or sets user defined data value that can be passed to the command when it is executed. + + + + + Represents the switch button UI element. + + + + + Raises ValueChanging event. + + Provides event arguments. + + + + Raises ValueChanged event. + + Provides event arguments. + + + + Creates new instance of SwitchButtonItem. + + + + + Creates new instance of SwitchButtonItem and assigns the name to it. + + Item name. + + + + Creates new instance of SwitchButtonItem and assigns the name and text to it. + + Item name. + item text. + + + + Returns copy of the item. + + + + + Copies the SwitchButtonItem specific properties to new instance of the item. + + New SwitchButtonItem instance. + + + + Copies the SwitchButtonItem specific properties to new instance of the item. + + New SwitchButtonItem instance. + + + + Sets the value of the control and specifies the source of the action. + + New value for Value property. + Source of the action. + + + + Sets the value of the control with state transition animation (if enabled) and specifies the source of the action. + + New value for Value property. + Source of the action. + + + + Cancels any current inprogress animation. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Gets whether property should be serialized. + + + + + Resets property to its default value. + + + + + Occurs before Value property has changed and it allows you to cancel the change. + + + + + Occurs after Value property has changed. + + + + + Gets whether item supports text markup. Default is false. + + + + + Gets or sets whether text-markup support is enabled for items Text property. Default value is true. + Set this property to false to display HTML or other markup in the item instead of it being parsed as text-markup. + + + + + Gets or sets the text associated with this item. + + + + + Gets or sets the switch value. + + + + + Indicates whether clicking left mouse button on the switch part of the item will toggle the switch Value. + + + + + Gets the switch bounds. + + + + + Gets the button bounds. + + + + + Gets the On part of the switch button bounds excluding the SwitchBounds. + + + + + Gets the Off part of the switch button bounds excluding the SwitchBounds. + + + + + Gets or sets the switch offset from its initial position. Used for animation and dragging of the switch. + + + + + Gets whether switch part of the button is pressed using mouse left button. + + + + + Gets or sets the width in pixels of the switch part of the button. Minimum value is 6. + + + + + Gets or sets the text that is displayed on switch when Value property is set to true. + + + + + Gets or sets the text that is displayed on switch when Value property is set to false. + + + + + Gets whether fade effect is enabled. + + + + + Gets or sets whether state transition animation is enabled. + + + + + Gets or sets the width of the switch button. Must be greater than SwitchWidth. + + + + + Gets or sets the height of the switch button. Must be greater than 5. + + + + + Gets or sets text padding. + + + + + Gets or sets switch margin. + + + + + Gets or sets the color of the OFF state background. + + + + + Gets or sets the color of the ON state background. + + + + + Gets or sets the color of the ON state text. + + + + + Gets or sets the color of the OFF state text. + + + + + Gets or sets the item border color. + + + + + Gets or sets the border color of the button switch. + + + + + Gets or sets the background color of the switch button. + + + + + Gets or sets whether caption/label set using Text property is visible. + + + + + Gets or sets the text color. + + + + + Gets or sets the font that is used to draw ON/OFF text on the switch button. + + + + + Gets or sets whether button is in read-only state meaning that it appears as enabled but user cannot change its state. + + + + + Gets or sets whether lock marker is visible on face of the control when IsReadOnly is set to true. + Default value is true. + + + + + Gets or sets the color of the read-only marker. + + + + + Provides data for SwitchButton rendering. + + + + + Gets or sets Graphics object group is rendered on. + + + + + Gets or sets the reference to SwitchButtonItem being rendered. + + + + + ColorScheme object that is used to provide colors for rendering check box item in legacy styles like Office 2003. Office 2007 style + uses color tables provided by renderer. + + + + + Indicates whether item is in Right-To-Left environment. + + + + + Gets or sets the text font. + + + + + Gets or sets the ItemPaintArgs reference. + + + + + Creates new instance of the object and provides default values. + + Reference to Graphics object + Reference to SwitchButtonItem + Reference to legacy ColorScheme + Indicates the font for the text. + Indicates whether item is in Right-To-Left environment. + + + + Returns specific font set at specified size/ + + Font size + Symbol set to return + Font + + + + Returns FontAwesome at specific size. + + Font size in points + Font in desired size. + + + + Returns FontAwesome at specific size. + + Font size in points + Font in desired size. + + + + Gets FontAwesome at default size. + + + + + Returns FontAwesome Family. + + + + + Gets Material Font at default size. + + + + + Returns Material Font Family. + + + + + Gets the default size for the Material font size in points. + + + + + Gets the default size for the FontAwesome font size in points. + + + + + Represents colors for the active tab. + + + + + Creates new instance of the object. + + + + + Returns whether property should be serialized. + + true if property should be serialized otherwise false. + + + + Resets property to the default value. + + + + + Returns whether property should be serialized. + + true if property should be serialized otherwise false. + + + + Resets property to the default value. + + + + + Returns whether property should be serialized. + + true if property should be serialized otherwise false. + + + + Resets property to the default value. + + + + + Returns whether property should be serialized. + + true if property should be serialized otherwise false. + + + + Resets property to the default value. + + + + + Returns whether property should be serialized. + + true if property should be serialized otherwise false. + + + + Resets property to the default value. + + + + + Returns whether property should be serialized. + + true if property should be serialized otherwise false. + + + + Resets property to the default value. + + + + + Occurs after color property has changed. + + + + + Gets or sets the background color of the tab when inactive. + + + + + Gets or sets the target gradient background color of the tab when inactive. + + + + + Gets or sets the gradient angle. + + + + + Gets the collection that defines the multi-color gradient background for tab item.. + + + + + Gets or sets the light border color when tab is inactive. + + + + + Gets or sets the dark border color when tab is inactive. + + + + + Gets or sets the border color when tab is inactive. + + + + + Gets or sets the text color when tab is inactive. + + + + + Represents the class that defines colors for a tab control. + + + + + Default constructor. + + + + + Default contructor that accepts style. + + + + + Refreshes colors stored in the color scheme. This method is used for example to refresh the color after system display colors have changed. + + + + + Generates color scheme for flat style. + + + + + Generates color scheme for Office 2003 style. + + + + + Generates the VS2005 document tab like color scheme. + + + + + Generates Windows XP Themed color scheme. + + + + + Generates OneNote style color scheme. + + + + + Generates VS2005 style color scheme. + + + + + Generates OneNote style color scheme. + + + + + Generates OneNote style color scheme. + + + + + Resets changed flag for all color properties. When changed flag is set for a color property color is not automatically generated for that property. + Reseting the flag will ensure that all colors are automatically generated. + + + + + Applies predefinied tab item color scheme to the tab. + + Tab item to apply color to. + Predefined color to apply + + + + Applies predefinied tab item color scheme to the tab. + + Tab item to apply color to. + Predefined color to apply + + + + Gets or sets the style that color scheme represents. + + + + + Gets or sets whether themed color scheme is generated. + + + + + Indicates whether any of the colors has changed. + + + + + Gets or sets the tab-strip background image. + + + + + Specifies the background color of the tab control. + + + + + Specifies the target gradient background color of the tab control. + + + + + Specifies the gradient angle. + + + + + Specifies the border color of the tab control. + + + + + Specifies the background color of the tab panel. + + + + + Specifies the target gradient background color of the tab panel. + + + + + Specifies the gradient angle. + + + + + Specifies the border color of the tab panel. + + + + + Specifies the border color of the tab item. + + + + + Specifies the light border color of the tab item. + + + + + Specifies the dark border color of the tab item. + + + + + Specifies the background color of the tab item. + + + + + Specifies the target gradient background color of the tab item. + + + + + Specifies the gradient angle. + + + + + Gets the collection that defines the multi-color gradient background for tab item.. + + + + + Specifies the text of the tab item. + + + + + Specifies the border color of the tab item when mouse is over it. + + + + + Specifies the light border color of the tab item when mouse is over it. + + + + + Specifies the dark border color of the tab item when mouse is over it. + + + + + Specifies the background color of the tab item when mouse is over it. + + + + + Specifies the target gradient background color of the tab item when mouse is over it. + + + + + Specifies the gradient angle. + + + + + Gets the collection that defines the multi-color gradient background for tab item.. + + + + + Specifies the text color of the tab item when mouse is over it. + + + + + Specifies the border color of the tab item when selected. + + + + + Specifies the light border color of the tab item when selected. + + + + + Specifies the dark border color of the tab item when selected. + + + + + Specifies the background color of the tab item when selected. + + + + + Specifies the target gradient background color of the tab item when selected. + + + + + Specifies the gradient angle. + + + + + Gets the collection that defines the multi-color gradient background for tab item.. + + + + + Specifies the text color of the tab item when selected. + + + + + Specifies the tab item separator color. + + + + + Specifies the tab item separator shadow color. + + + + + Specifies the text of the tab item. + + + + + Summary description for TabControl. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Gets whether property should be serialized. Used by Windows Forms designer. + + + + + Called by StyleManager to notify control that style on manager has changed and that control should refresh its appearance if + its style is controlled by StyleManager. + + New active style. + + + + Applies default tab colors to the panel + + Panel to apply colors to. + + + + Resumes normal layout logic. Optionally forces an immediate layout of pending layout requests. + + + + + Resizes the portion of the control that holds the tabs. + + + + + Creates new tab and tab panel and adds it to the Tabs collection. + + Tab text. + Reference to newly created TabItem. + + + + Creates new tab and tab panel and inserts it at specified position inside of Tabs collection. + + Tab text. + Index to insert newly created tab at. -1 will append tab to the end of Tabs collection. + Reference to newly created TabItem. + + + + Selects previous visible tab. Returns true if previous tab was found for selection. + + + + + Selects next visible tab. Returns true if next tab was found for selection. + + + + + Resets color scheme to default value. + + + + + Memeber used by Windows Forms designer. + + true if property should be serialized. + + + + Memeber used by Windows Forms designer to reset property to default value. + + + + + Occurs when selected tab changes. + + + + + Occurs before selected tab changes and gives you opportunity to cancel the change. + + + + + Occurs when tab is dragged by user. + + + + + Occurs when the user navigates back using the back arrow. + + + + + Occurs when the user navigates forward using the forward arrow. + + + + + Occurs when tab item is closing. + + + + + Occurs when tab item is added to the tabs collection. + + + + + Occurs before control or item attached to the tab is displayed. + + + + + Occurs after tab item has been removed from tabs collection. + + + + + Gets or sets the background color. + + + + + Gets the collection of all tabs. + + + + + Gets or sets whether tabs are visible. Default value is true. + + + + + Returns reference to internal tab strip control. + + + + + Gets or sets whether TabStrip will get focus when Tab key is used. Default value is false. + + + + + Use TabControlPanel.Style property to set the background image for each tab panel. + + + + + Gets or sets whether pressing Ctrl+Tab keys will cycle through the selected tabs. Default value is true. + + + + + Gets or sets whether tabs use anti-alias smoothing when painted. Default value is false. + + + + + Gets or sets whether the tab scrolling is animated. + + + + + Gets or sets whether system box that enables scrolling and closing of the tabs is automatically hidden when tab items size does not exceed the size of the control. + + + + + Specifes whether end-user can reorder the tabs. + + + + + Gets or sets whether tab is automatically closed when close button is clicked. Closing the tab will remove tab being closed from Tabs collection + and it will remove the panel as well. Default value is false which means that tab will not be closed and you should handle TabClose event to + perform desired action as result of user closing the tab. + + + + + Gets or sets whether the Close button that closes the active tab is visible on system box. + + + + + Gets or sets whether close button is visible on each tab instead of in system box. + + + + + Gets or sets whether close button on tabs when visible is displayed for every tab state. Default value is true. When set to false + the close button will be displayed only for selected and tab that mouse is currently over. + + + + + Gets or sets the position of the close button displayed on each tab. Default value is Left. + + + + + Gets or sets custom image that is used on tabs as Close button that allows user to close the tab. + Use TabCloseButtonHot property to specify image that is used when mouse is over the close button. Note that image size must + be same for both images. + Default value is null + which means that internal representation of close button is used. + + + + + Gets or sets custom image that is used on tabs as Close button whem mouse is over the close button. + To use this property you must set TabCloseButtonNormal as well. Note that image size for both images must be same. + Default value is null which means that internal representation of close button is used. + + + + + Gets or sets whether only selected tab is displaying it's text. + + + + + Gets or sets the image list used by tab items. + + + + + Gets or sets scrolling offset of the first tab. You can use this property to programmatically scroll the tab strip. + + + + + Gets or sets Tab Control style. Theme style is supported only on themed OS and only for bottom or top aligned tabs. + + + + + Specifies whether tab is drawn using Themes when running on OS that supports themes like Windows XP. + + + + + Gets or sets whether tabs are scrolled continuously while mouse is pressed over the scroll tab button. + + + + + Gets or sets the auto-repeat interval for the tab scrolling while mouse button is kept pressed over the scroll tab button. + + + + + Gets or sets Tab Color Scheme. + + + + + Gets or sets the tab alignment within the Tab-Strip control. + + + + + Gets or sets the selected tab. + + + + + Gets or sets the selected tab Font + + + + + Gets or sets whether focus rectangle is displayed on the tab when tab has input focus. + + + + + Gets or sets whether keyboard navigation using Left and Right arrow keys to select tabs is enabled. Default value is true. + + + + + Gets or sets the index of the selected tab. + + + + + Gets or sets selected tab panel. + + + + + Gets or sets the type of the tab layout. + + + + + Indicates whether selected tab is aligned with the panel in multiple lines use case. + + + + + Gets or sets the fixed tab size in pixels. Either Height or Width can be set or both. + Value of 0 indicates that size is automatically calculated which is + default behavior. + + + + + Represents Panel for the Tab Control. + + + + + Default constructor. + + + + + Gets or sets TabItem that this panel is attached to. + + + + + Indicates whether style of the panel is managed by tab control automatically. + Set this to true if you would like to control style of the panel. + + + + + Gets or sets which edge of the parent container a control is docked to. + + + + + Represents the Tab on the Tab-Strip control. + + + + + Default constructor. + + Container object. + + + + Default constructor. + + + + + Returns the font for the tab text. + + Reference to the font object. + + + + Raises the Click event. + + + + + Occurs when mouse is pressed over the tab item. + + + + + Occurs when mouse button is released over the tab item. + + + + + Occurs when mouse hovers over the tab item. + + + + + Occurs when mouse enters the tab item. + + + + + Occurs when mouse leaves the tab item. + + + + + Occurs when mouse moves over the tab item. + + + + + Occurs when mouse click is performed on the tab item. + + + + + Gets the AccessibleObject assigned to the item. + + + + + Gets or sets the tab Image index. + + + + + Gets or sets the tab image. + + + + + Gets or sets the tab icon. Icon has same functionality as Image except that it support Alpha blending. + + + + + Gets or sets the text displayed on the tab. + + + + + Gets or sets whether tab is visible. + + + + + Gets the display bounds of the tab. + + + + + Gets or sets the bounds of the close button rectangle if displayed on the tab. You should not set value of this property. + + + + + Gets or sets the control that is attached to this tab. When tab is selected the control Visible property is set to true and when tab is unselected the control Visible property is set to false. + + + + + Gets or sets the background color of the tab when inactive. + + + + + Gets or sets the target gradient background color of the tab when inactive. + + + + + Gets or sets the gradient angle. + + + + + Gets or sets the light border color when tab is inactive. + + + + + Gets or sets the dark border color when tab is inactive. + + + + + Gets or sets the border color when tab is inactive. + + + + + Gets or sets the text color when tab is inactive. + + + + + Gets or sets name of the tab item that can be used to identify item from the code. + + + + + Gets or sets the predefined tab color. + + + + + Gets or sets an object that contains data to associate with the item. + + + + + Gets/Sets informational text (tooltip) for the tab. + + + + + Returns true if tab is selected tab. + + + + + Gets the tab alignment. + + + + + Returns true if mouse is over the tab. + + + + + Gets or sets whether Close button on the tab is visible when TabStrip.CloseButtonOnTabsVisible property is set to true. Default value is true. You can use this property + to selectively hide Close button on tabs. + + + + + Gets or sets the bounds of the content block. + + + + + Gets or sets item margin only used by certain items in certain containers. Provided only for internal DotNetBar use. + + + + + Summary description for TabItemLayoutManager. + + + + + Resizes the content block and sets it's Bounds property to reflect new size. + + Content block to resize. + + + + Gets or sets the padding in pixels for the measured text. Default is 4. + + + + + Gets or sets the padding in pixels for the measured image size. Default is 4. + + + + + Gets or sets the padding in pixels that is added to the measured height of the tab. Default is 4. + + + + + Gets or sets the padding in pixels that is added to the measured width of the tab. Default is 0. + + + + + Gets or sets whether text is always layed out horizontaly even if tabs are vertically aligned. + + + + + Gets or sets the additional padding for the selected item. + + + + + Gets or sets the fixed tab size in pixels. Either member can be set. Value of 0 indicates that size is automatically calculated which is + default behavior. + + + + + Summary description for TabsCollection. + + + + + Get the TabItem with given name. Name comparison is case insensitive. + + + + + + + Represents Tab-Strip control. + + + + + Raises TabMouseEnter event. + + Provides event arguments. + + + + Raises TabMouseLeave event. + + Provides event arguments. + + + + Raises TabMouseMove event. + + Provides event arguments. + + + + Raises TabMouseClick event. + + Provides event arguments. + + + + Raises TabMouseHover event. + + Provides event arguments. + + + + Default constructor. + + + + + Returns the bounds of the tab system box if one is available in current tab style. + + Rectangle describing the system box bounds. + + + + Recalculates the size of the tabs. + + + + + Selectes previous visible tab. Returns true if previous tab was found for selection. + + + + + Selectes next visible tab. Returns true if next tab was found for selection. + + + + + Invokes the TabCleared event. + + Provides events arguments + + + + Ensures that the tab is visible, scrolling the tab-strip view as necessary. + + Tab to make visible. + + + + Clean up any resources being used. + + + + + Called by StyleManager to notify control that style on manager has changed and that control should refresh its appearance if + its style is controlled by StyleManager. + + New active style. + + + + Refreshes the color scheme with the colors from system color table. + + + + + Resets color scheme to default value. + + + + + Memeber used by Windows Forms designer. + + true if property should be serialized. + + + + Memeber used by Windows Forms designer to reset property to default value. + + + + + Returns tab item that contains specified coordinates. + + X - coordinate to hit test + Y - coordinate to hit test + + + + + Hides tooltip for a tab is one is displayed. + + + + + Shows tooltip for given tab. + + + + + Resets Hoover timer. + + + + + Occurs after selected tab has changed. + + + + + Occurs before selected tab changes and gives you opportunity to cancel the change. + + + + + Occurs when tab is dragged by user. + + + + + Occurs when the user navigates back using the back arrow. + + + + + Occurs when the user navigates forward using the forward arrow. + + + + + Occurs when tab item is closing. + + + + + Occurs when tab item is added to the tabs collection. + + + + + Occurs before control or item attached to the tab is displayed. + + + + + Occurs after tab item has been removed from tabs collection. + + + + + Occurs after Tabs collection has been cleared. + + + + + Occurs after the tab item size has been determined and allows you to apply your custom size to the TabItem. + + + + + Occurs before tab is rendered and allows you to cancel default tab rendering performed by the control. + + + + + Occurs after tab is rendered and allows you to render on top of the default rendering performed by the control. + + + + + Occurs when mouse enters a tab. + + + + + Occurs when mouse leaves a tab. + + + + + Occurs when mouse moves over the tab. + + + + + Occurs when mouse clicks the tab. + + + + + Occurs when mouse hovers over the tab. + + + + + Gets or sets whether anti-alias smoothing is used while painting. Default value is false. + + + + + Returns minimum tab strip height given the style and the tabs it contains. + + + + + Returns the rectangle that contains all the tabs. + + + + + Gets or sets the index of currently selected tab. + + + + + Gets or sets the selected tab. + + + + + Gets or sets whether tabs are scrolled continuously while mouse is pressed over the scroll tab button. + + + + + Gets or sets the auto-repeat interval for the tab scrolling while mouse button is kept pressed over the scroll tab button. + + + + + Gets or sets whether the Close button that closes the active tab is visible. + + + + + Gets or sets whether close button is visible on each tab instead of in system box. + + + + + Gets or sets whether close button on tabs when visible is displayed for every tab state. Default value is true. When set to false + the close button will be displayed only for selected and tab that mouse is currently over. + + + + + Gets or sets the position of the close button displayed on each tab. Default value is Left. + + + + + Gets or sets custom image that is used on tabs as Close button that allows user to close the tab. + Use TabCloseButtonHot property to specify image that is used when mouse is over the close button. Note that image size must + be same for both images. + Default value is null + which means that internal representation of close button is used. + + + + + Gets or sets custom image that is used on tabs as Close button whem mouse is over the close button. + To use this property you must set TabCloseButtonNormal as well. Note that image size for both images must be same. + Default value is null which means that internal representation of close button is used. + + + + + Gets the collection of all tabs. + + + + + Gets or sets whether control attached to the TabItem.AttachedControl property is automatically selected when TabItem becomes selected tab. Default value is true. + + + + + Gets or sets the image list used by tab items. + + + + + Indicates whether selected tab is aligned with the panel in multiple lines use case. + + + + + Gets or sets the type of the tab layout. + + + + + Gets or sets whether tab size is adjusted to fit the available control size. + + + + + Gets or sets scrolling offset of the first tab. You can use this property to programmatically scroll the tab strip. + + + + + Gets or sets whether keyboard navigation using Left and Right arrow keys to select tabs is enabled. Default value is true. + + + + + Gets or sets the mouse cursor that is displayed when tab is dragged. + + + + + Returns tab mouse is over or null if mouse is not over the tab. + + + + + Gets or sets the selected tab Font + + + + + Gets or sets the tab alignment within the Tab-Strip control. + + + + + Specifes whether end-user can reorder the tabs. + + + + + Gets or sets whether system box that enables scrolling and closing of the tabs is automatically hidden when tab items size does not exceed the size of the control. + + + + + Gets or sets the background color. + + + + + Gets or sets whether only selected tab is displaying it's text. + + + + + Gets or sets TabStrip style. Theme style is supported only on themed OS and only for bottom or top aligned tabs. + + + + + Specifies whether tab is drawn using Themes when running on OS that supports themes like Windows XP. + + + + + Gets whether control should be represented in themed style. + + + + + Gets or sets Tab Color Scheme. + + + + + Gets or sets whether the tab scrolling is animanted. + + + + + Gets or sets the fixed tab size in pixels. Either Height or Width can be set or both. + Value of 0 indicates that size is automatically calculated which is + default behavior. + + + + + Gets or sets whether focus rectangle is displayed when tab has input focus. + + + + + Gets or sets whether Tab-Strip control provides Tabbed MDI Child form support. Default value is false. + + + + + Gets or sets the maximum number of characters that will be used as Tab text from Mdi Child caption. + + + + + Gets or sets whether the Mdi Child Icon is displayed on Tab. + + + + + Gets or sets whether the Tab-strip is automatically hidden when there are not Mdi Child forms open. + + + + + Gets or sets whether flicker associated with switching maximized Mdi child forms is attempted to eliminate. You should set this property to false if you encounter any painting problems with your Mdi child forms. + + + + + Gets or sets Mdi Container form for which Tab-Strip is providing Tabbed MDI Child support. + + + + + Event delegate for SelectedTabChanged event. + + + + + Event delegate for SelectedTabChanging event. + + + + + Event delegate for TabMoved event + + + + + Event delegate for NavigateBack, NavigateForward and TabItemClose events. + + + + + Represents the event arguments for tab selection events. + + + + + Currently selected tab. + + + + + Tab being selected. + + + + + Specifies the action that caused the event. + + + + + Default constructor. + + Currently selected tab. + New selection. + + + + Represents the event arguments for tab selection events. + + + + + Currently selected tab. + + + + + Tab being selected. + + + + + Cancels the selection operation. + + + + + Specifies the action that caused the event. + + + + + Default constructor. + + Currently selected tab. + New selection. + + + + Represents the event arguments for tab moving events. + + + + + Tab being moved. + + + + + Moved from index. + + + + + Moving to index. + + + + + Cancels the operation. + + + + + Default Constructor + + Tab + Old Index + New Index + + + + Represents the event arguments for action events. + + + + + Cancels the operation. + + + + + Reference to relevant TabItem, if any, otherwise null/nothing. + + + + + Default Constructor. + + + + + Destroys tooltip window. + + + + + Specifies the tab alignment inside the Tab-Strip control. + + + + + Tabs are left aligned. + + + + + Tabs are right aligned. + + + + + Tabs are top aligned. + + + + + Tabs are bottom aligned. + + + + + Indicates tab strip style. + + + + + Default VS.NET like flat style. + + + + + Office 2003 like style. + + + + + OneNote like style. + + + + + VS.NET 2005 style tabs. + + + + + Tab style where tabs are centered and first and last tab have the corners rounded. This style does not support multi-line tabs or tab scrolling. + + + + + VS.NET 2005 dock style tabs. + + + + + VS.NET 2005 document style tabs. + + + + + Simulated theme style with the horizontal text alignment at all times. + + + + + Office 2007 document style. + + + + + Office 2007 dock style. + + + + + Metro UI style. + + + + + Defines delegate for the MeasureTabItem event. + + + + + Represents event arguments for MeasureTabItem event. + + + + + Gets the TabItem that is being measured. + + + + + Gets or sets the size of the TabItem. The default size calculated by the control will be set by default. You can inspect it and change it to the + custom size by setting this property. + + + + + Creates new instance of the class and initializes it with default values. + + TabItem being measured. + Default size. + + + + Defines delegate for the PreRenderTabItem and PostRenderTabItem events. + + + + + Represents event arguments for PreRenderTabItem and PostRenderTabItem event. + + + + + Gets the reference to the TabItem being rendered. You can use properties like DisplayRectangle to determine the rendering bounds for the tab. + + + + + When used in PreRenderTabItem event allows you to cancel the default rendering by setting this property to true. + + + + + Gets the reference to the Graphics object to render the tab on. + + + + + Creates new instance of the class and initializes it with default values. + + Default value for TabItem property. + Default value for Graphics property. + + + + Represents base class for tab display. + + + + + Main method for painting. + + Reference to graphics object + TabStrip to paint + + + + Gets or sets whether anti-alias is used for painting the tabs. Default value is true. + + + + + Gets or sets whether text is drawn horizontaly regardless of tab orientation. + + + + + Gets or sets whether close button is painted on each tab. + + + + + Provides display capabilities for TabStrip with Office 2007 Dock style. + + + + + Provides display capabilities for TabStrip with Office 2007 Document style. + + + + + Creates new instance of the class. + + + + + Represents class performing the display of tabs with RoundHeader style. + + + + + Provides display support for SimualtedTheme tab style. + + + + + Provides display capabilites for TabStrip with VS2005Dock style. + + + + + Creates new instance of the class. + + + + + Represent a task-dialog message box window. + + + + + Displays TaskDialog message. + + Title of the window. + Task dialog header. + Task dialog text. + Displayed buttons. + Result from task-dialog. + + + + Displays TaskDialog message. + + Title of the window. + Task dialog header. + Task dialog text. + Displayed buttons. + Specifies the predefined color for the dialog. + Result from task-dialog. + + + + Displays TaskDialog message. + + Title of the window. + Icon displayed on dialog. + Task dialog header. + Task dialog text. + Displayed buttons. + Result from task-dialog. + + + + Displays TaskDialog message. + + Title of the window. + Icon displayed on dialog. + Task dialog header. + Task dialog text. + Displayed buttons. + Specifies the predefined color for the dialog. + Result from task-dialog. + + + + Displays TaskDialog message. + + Specifies the content of the task dialog. + Result from task-dialog. + + + + Displays TaskDialog message. + + Window owner of the task dialog. + Specifies the content of the task dialog. + Result from task-dialog. + + + + Closes the task dialog if it is open with eTaskDialogResult.None result. + + + + + Closes the task dialog if it is open with specified result value. + + Value that will be used as return value from Show method. + + + + Gets or sets whether TaskDialog form has Windows Vista Glass enabled if running on + Windows Vista with Glass enabled. Default value is true. + + + + + Gets or sets the anti-alias text-rendering setting for the controls on task-dialog. Default value is true. + + + + + Occurs when any text markup link on Task-Dialog Box is clicked. Markup links can be created using "a" tag, for example: + Markup link + + + + + Specifies the information displayed on task-dialog. + + + + + Initializes a new instance of the TaskDialogInfo structure. + + Title of dialog. + Task-dialog icon + Header text. + Dialog main/content text. + Dialog buttons displayed. + Dialog background color. + Radio Button Commands + Button commands. + Check-box command. + Footer text + Footer image. + + + + Initializes a new instance of the TaskDialogInfo structure. + + Title of dialog. + Task-dialog icon + Header text. + Dialog main/content text. + Dialog buttons displayed. + Dialog background color. + Radio Button Commands + Button commands. + Check-box command. + Footer text + Footer image. + Indicates whether TaskDialog is top most. + + + + Initializes a new instance of the TaskDialogInfo structure. + + Title of dialog. + Task-dialog icon + Header text. + Dialog main/content text. + Dialog buttons displayed. + Dialog background color. + + + + Initializes a new instance of the TaskDialogInfo structure. + + Title of dialog. + Task-dialog icon + Header text. + Dialog main/content text. + Dialog buttons displayed. + + + + Initializes a new instance of the TaskDialogInfo structure. + + Title of dialog. + Task-dialog icon + Header text. + Dialog main/content text. + Dialog buttons displayed. + + + + Gets or sets the task-dialog window title. + + + + + Gets or sets the task-dialog header. + + + + + Gets or sets the task-dialog text. + + + + + Gets or sets the task-dialog buttons displayed. + + + + + Gets or sets the task-dialog background color. + + + + + Gets or sets the array of commands that will be used to create the radio-buttons displayed on task-dialog. Each command will be executed as radio-buttons are checked by user. + + + + + Gets or sets the array of commands that will be used to create the buttons displayed on task-dialog. Each command will be executed as buttons are clicked by user. + + + + + Gets or sets the footer text displayed on task-dialog. + + + + + Gets or sets the command that is used to initialize the footer check-box. Command will be executed when check-box state changes by end user. + + + + + Gets or sets the icon that is displayed on task dialog. + + + + + Gets or sets the image that is displayed in the task-dialog footer. Expected image size is 16x16 pixels. + + + + + Gets or sets whether TaskDialog form is top-most. Default value is false. + + + + + Gets or sets the TaskDialog default button. + + + + + Indicates whether task dialog form close button is enabled, default value is true. + + + + + Specifies the task dialog buttons. + + + + + OK button will be displayed. + + + + + Yes button will be displayed. + + + + + No button will be displayed. + + + + + Cancel button will be displayed. + + + + + Retry button will be displayed. + + + + + Close button will be displayed. + + + + + Specifies the task dialog return values. + + + + + No button was clicked because dialog was closed using TaskDialog.Close method. + + + + + OK button was clicked. + + + + + Yes button was clicked. + + + + + No button was clicked. + + + + + Cancel button was clicked. + + + + + Retry button was clicked. + + + + + Close button was clicked. + + + + + Specifies the custom result. Custom result can be specified if TaskDialog.Close method is called to close dialog. + + + + + Specifies the custom result. Custom result can be specified if TaskDialog.Close method is called to close dialog. + + + + + Specifies the custom result. Custom result can be specified if TaskDialog.Close method is called to close dialog. + + + + + Define icons available on TaskDialog. + + + + + No icon. + + + + + Blue flag icon. + + + + + Blue stop icon. + + + + + Light bulb, idea icon. + + + + + Check-mark icon. + + + + + Check-mark icon. + + + + + Trash-can delete icon. + + + + + Exclamation icon. + + + + + Flag icon. + + + + + Hand-stop icon. + + + + + Help icon. + + + + + Informational icon. + + + + + Informational icon. + + + + + No entry icon. + + + + + Shield icon. + + + + + Shield help icon. + + + + + Shield OK icon. + + + + + Shield stop icon. + + + + + Stop icon. + + + + + Stop icon. + + + + + Users icons. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Gets or sets the task-background color. + + + + + Gets the task-dialog result + + + + + Gets or sets the anti-alias text-rendering setting for the controls. + + + + + Defines TaskDialog colors. + + + + + Task dialog will use default background as specified by current theme. + + + + + Task dialog will use silver background color. + + + + + Task dialog will use tan background color. + + + + + Task dialog will use dark-blue background color. + + + + + Task dialog will use blue background color. + + + + + Task dialog will use red background color. + + + + + Task dialog will use olive-green background color. + + + + + Task dialog will use purple background color. + + + + + Task dialog will use aqua background color. + + + + + Task dialog will use orange background color. + + + + + Summary description for TextBoxItem. + + + + + Selects all text in text box. + + + + + Indicates whether property should be serialized by Windows Forms designer. + + + + + Resets the property to default value. + + + + + Occurs when ButtonCustom control is clicked. + + + + + Occurs when ButtonCustom2 control is clicked. + + + + + IBlock member implementation + + + + + Gets or sets a value indicating whether the text in the TextBox control should appear as the default password character. + + + + + Gets or sets the character used to mask characters of a password in a single-line TextBox control. + + + + + Gets or sets the text associated with the editable part of the item. + + + + + Gets or sets the item caption text displayed next to the text input. + + + + + Gets or sets the maximum number of characters the user can type or paste into the text box control. + + + + + Gets or sets whether watermark text is displayed when control is empty. Default value is true. + + + + + Gets or sets the watermark image displayed inside of the control when Text is not set and control does not have input focus. + + + + + Gets or sets the watermark image alignment. + + + + + + Gets or sets the watermark font. + + + + + Gets or sets the watermark text color. + + + + + Gets or sets the watermark hiding behaviour. Default value indicates that watermark is hidden when control receives input focus. + + + + + Gets or sets whether FocusHighlightColor is used as background color to highlight text box when it has input focus. Default value is false. + + + + + Gets or sets the color used as background color to highlight text box when it has input focus and focus highlight is enabled. + + + + + Gets or sets the text-alignment inside of the text box. + + + + + Gets the object that describes the settings for the custom button that can execute an custom action of your choosing when clicked. + + + + + Gets the object that describes the settings for the custom button that can execute an custom action of your choosing when clicked. + + + + + Measures the element given available size. + + Size available to element + Reference to graphics object + + + + Measures the end tag of an element. Most implementations do not need to do anything but implementations like the ones + that change color should return state back at this time. + + + + + + + Renders element. + + Provides markup drawing context information. + + + + Renders element tag end. Most implementations do not need to do anything but mplementations like the ones + that change color should return state back at this time. + + Provides markup drawing context information. + + + + Provides final rectangle to element and lets it arrange it's content given new constraint. + + Final rectangle. + + + + + Arranges the element given the final size. Layout is two step process with Measure followed by Arrange. + + + + + + + Returns whether markup element is an container so it receives full available size of parent control for layout. + + + + + Returns whether markup element is an block element that always consumes a whole line in layout. + + + + + Returns whether layout manager switches to new line after processing this element. + + + + + Returns whether layout manager can start new line with this element. + + + + + Gets the collection of child elements if any for this markup element. + + + + + Gets or sets whether element size is valid. When size is not valid element Measure method will be called to validate size. + + + + + Gets element parent or null if parent is not set. + + + + + Gets or sets actual rendering bounds. + + + + + Gets or sets whether markup element is visible. + + + + + Gets or sets the element margin. + + + + + Gets or sets actual rendered bounds for a give markup element if applicable. + + + + + Returns whether markup element is an block element that always consumes a whole line in layout. + + + + + Indicates paragraph content alignment + + + + + Indicates paragraph content alignment + + + + + Gets reference to markup start element. + + + + + Returns whether layout manager can start new line with this element. + + + + + Gets or sets heading level. Values from 1 to 6 are valid. Default is 1. + + + + + Returns whether hyper-link contains specified coordinates. + + + + + + + Creates new instance of the class. + + + + Adds new object to the collection. + + Object to add. + Index of newly added object. + + + + Inserts new object into the collection. + + Position of the object. + Object to insert. + + + + Returns index of the object inside of the collection. + + Reference to the object. + Index of the object. + + + + Returns whether collection contains specified object. + + Object to look for. + true if object is part of the collection, otherwise false. + + + + Removes specified object from the collection. + + + + + + Copies collection into the specified array. + + Array to copy collection to. + Starting index. + + + + Copies contained items to the MarkupElement array. + + Array to copy to. + + + + Gets or sets the collection parent element. + + + + + Returns reference to the object in collection based on it's index. + + + + + Tests whether input text could be markup text. + + Text to test. + true if text could be markup, otherwise false + + + + Gets the style of the hyperlink in its default state. + + + + + Gets the style of the hyperlink when mouse is over the link. + + + + + Gets the style of the visited hyperlink. + + + + + + Represents the method that will handle the ResolveImage event. + + + + + Defines the text-markup hyperlink appearance style. + + + + + Initializes a new instance of the HyperlinkStyle class. + + + + + Initializes a new instance of the HyperlinkStyle class. + + + + + + + Initializes a new instance of the HyperlinkStyle class. + + + + + + + + Gets or sets hyperlink text color. + + + + + Gets or sets hyperlink back color. + + + + + Gets or sets the underline style for the hyperlink. + + + + + Gets whether style has been changed from its default state. + + + + + + Indicates that event has been handled and that ResolvedImage should be used. + + + + + Indicates the string key parameters in url-style for the image that needs to be resolved. + + + + + Indicates the resolved image value. + you need to set this value to the resolved image and you need to set Handled property to true. + + + + + Default constructor. + + + + + Gets or sets whether element size is valid. When size is not valid element Measure method will be called to validate size. + + + + + Returns whether layout manager switches to new line after processing this element. + + + + + Returns whether markup element is an block element that always consumes a whole line in layout. + + + + + Returns whether layout manager can start new line with this element. + + + + + Summary description for Themes. + + + + + Represents toast display control. This class is not for public use. + + + + + Initializes a new instance of the ToastDisplay class. + + + + + Specifies the alpha-blending, opacity for the content rendered by the control. Setting this property allows fading in and out of the control content. + + + + + Gets or sets the toast background color. + + + + + Gets or sets the toast glow color. + + + + + Gets or sets the image displayed on the toast. + + + + + Represents class used to display toast notifications. A toast notification is a message that appears on the surface of the screen for a moment, + but it does not take focus (or pause the current activity), so it cannot accept any user input. + Notification pops up on the surface of the specified Form or Control. + It only fills the amount of space required for the message and the user's current activity remains visible and interactive. + The notification automatically fades in and out after specified time interval. + Notification text supports text-markup. + + + + + Closes all toast notifications open on specified parent control. + + Parent control. + + + + Closes specified toast notification on parent control. + + Parent control. + Toast ID as returned by the Show method. + + + + Updates the already displayed toast text. Note that toast notification will not be resized. + + Parent control which was used to show toast. + Toast ID returned by the Show toast method. + New toast notification text. + + + + Displays the toast notification on top of the specified parent control, we recommend always using a parent form. + + Parent form to display toast notification on top of + Message to display. + Image to display next to toast text. + Interval in milliseconds after which the notification is hidden. + Specifies toast-glow color used. + Specifies the position of the toast notification. + + + + Displays the toast notification on top of the specified parent control, we recommend always using a parent form. + + Parent form to display toast notification on top of + Message to display. + Image to display next to toast text. + Interval in milliseconds after which the notification is hidden. + Specifies toast-glow color used. + Specifies the X position of the toast notification with its parent window. + Specifies the Y position of the toast notification with its parent window. + + + + Displays the toast notification on top of the specified parent control, we recommend always using a parent form. + + Parent form to display toast notification on top of + Message to display. + Image to display next to toast text. + Interval in milliseconds after which the notification is hidden. + /// Specifies toast-glow color used. + + + + Displays the toast notification on top of the specified parent control, we recommend always using a parent form, with default timeout interval. + + Parent control to display toast notification on top of + Message to display. + + + + Displays the toast notification on top of the specified parent control, we recommend always using a parent form, with default timeout interval. + + Parent control to display toast notification on top of + Message to display. + Specifies the position of the toast notification. + + + + Displays the toast notification on top of the specified parent control, we recommend always using a parent form, with default timeout interval. + + Parent control to display toast notification on top of + Message to display. + Image to display next to toast text. + + + + Displays the toast notification on top of the specified parent control, we recommend always using a parent form. + + Parent form to display toast notification on top of + Message to display. + Image to display next to toast text. + Interval in milliseconds after which the notification is hidden. + + + + Displays the toast notification on top of the specified parent control, we recommend always using a parent form. + + Parent form to display toast notification on top of + Message to display. + Interval in milliseconds after which the notification is hidden. + + + + Displays the toast notification on top of the specified parent control, we recommend always using a parent form. + + Parent form to display toast notification on top of + Message to display. + Interval in milliseconds after which the notification is hidden. + Specifies the position of the toast notification. + + + + Specifies the toast margin from the edges of the parent control. Default value is 16 pixels on all sides. + + + + + Specifies the default toast position within the parent control. Default value is BottomCenter. + + + + + Specifies default glow color around toast notification. Default value is Blue. + + + + + Specifies the default timeout interval for the toast notification. + + + + + Specifies the toast background color. + + + + + Specifies the toast text color. + + + + + Specifies the font used for the toast. + + + + + Specifies the custom glow color used when eToastGlowColor.Custom is used. + + + + + Specifies toast position within parent control. + + + + + Specifies the glow color around toast notification. + + + + + Summary description for NewToolbar. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Summary description for Tooltip. + + + + + Gets or sets the rectangle of the control or item tooltip is displayed for. + + + + + Gets or sets whether text-markup is enabled for the tooltips. + + + + + Specifies fixed location for tooltip window. + + + + + Raises PanBegin event. + + Provides event arguments. + + + + Raises PanBegin event. + + Provides event arguments. + + + + Raises PanBegin event. + + Provides event arguments. + + + + Raises Begin event. + + Provides event arguments. + + + + Raises End event. + + Provides event arguments. + + + + Raises PressAndTap event. + + Provides event arguments. + + + + Raises RotateBegin event. + + Provides event arguments. + + + + Raises Rotate event. + + Provides event arguments. + + + + Raises RotateEnd event. + + Provides event arguments. + + + + Raises TwoFingerTap event. + + Provides event arguments. + + + + Raises ZoomBegin event. + + Provides event arguments. + + + + Raises Zoom event. + + Provides event arguments. + + + + Raises ZoomEnd event. + + Provides event arguments. + + + + Raises TouchDown event. + + Provides event arguments. + + + + Raises TouchDown event. + + Provides event arguments. + + + + Raises TouchDown event. + + Provides event arguments. + + + + Initializes a new instance of the TouchHandler class. + + + + + + Initializes a new instance of the TouchHandler class. + + + + + + Initializes handler + + + + + The Windows message handler. + + + + + Decode the message and create a collection of event arguments + + + + + The last event in the current gesture event sequence + + + + + Register for touch event + + true if succeeded + + + + The event arguments that started the current gesture + + + + + Gets or sets whether palm rejection is enabled. + + + + + Check if Multi-touch support device is ready + + + + + Create new gesture event instance and decode the gesture info structure + + The gesture handler + The gesture information + + + + Gesture relative rotation angle for Rotate event. + + + + + Indicates calculated gesture center. + + + + + Gesture zoom factor for Zoom event. + + + + + Gesture relative panning translation for Pan event. + + + + + Gesture velocity vector of the pan gesture for custom inertia implementations. + + + + + The last touch arguments in this gesture event sequence. + + + + + The client location of gesture. + + + + + Is this the first event of a gesture. + + + + + It this last event of a gesture. + + + + + Has gesture triggered inertia. + + + + + The first touch arguments in this gesture event sequence. + + + + + Gets or sets whether event is handled. + + + + + EventArgs passed to Touch handlers + + + + + Create new touch event argument instance + + The target control + one of the inner touch input in the message + + + + Touch client coordinate in pixels + + + + + A touch point identifier that distinguishes a particular touch input + + + + + A set of bit flags that specify various aspects of touch point + press, release, and motion. + + + + + mask which fields in the structure are valid + + + + + touch event time + + + + + touch event time from system up + + + + + the size of the contact area in pixels + + + + + Is Primary Contact (The first touch sequence) + + + + + Specifies that movement occurred + + + + + Specifies that the corresponding touch point was established through a new contact + + + + + Specifies that a touch point was removed + + + + + Specifies that a touch point is in range + + + + + specifies that this input was not coalesced. + + + + + Specifies that the touch point is associated with a pen contact + + + + + The touch event came from the user's palm + + Set to true + + + + Gets or sets whether event is handled. + + + + + Get the current Digitizer Status + + + + + Initializes a new instance of the GESTURECONFIG structure. + + + + + + + + Specifies available digitizer capabilities + + + + + Gesture Info Interop Structure + + + + + A Simple POINTS Interop structure + + + + + A Simple POINT Interop structure + + + + + Touch API defined structures [winuser.h] + + + + + Represents class that holds User Interface static methods. + + + + + Gets the graphics path that represents triangle. + + Top left position of the triangle. + Size of the triangle. + Pointing direction of the triangle. + Returns graphics path for the triangle of given size and pointing in given direction. + + + + Creates the double arrow >> collapse expand image for the collapsable controls. + + Indicates the direction of the arrow + Color for the arrows + Indicates whether image is for vertical collapse/expand + + + + + Specifies the pointing direction of triangle. + + + + + Triangle point to the left. + + + + + Triangle point to the right. + + + + + Triangle point to the top. + + + + + Triangle point to the bottom. + + + + + Represents compare validator for SuperValidator control used to compare two input fields or input fields to specified value. + + + + + Represents base validator used by SuperValidator component. + + + + + Validates the input control. + + Input control to validate. + true if validation is successful otherwise false + + + + Gets the input control value. + + Control to return value for. + Controls value + + + + Gets the input control value. + + Control to return value for. + Controls value + + + + Raises the GetValue event. + + Event arguments. + + + + Occurs when validator retrieves the value for the control. It allows you to return value for the controls validator does not recognize. + + + + + Gets or sets the error message that is displayed by error provider when validation fails. + + + + + Gets the last validation result returned from Validate call. True if validation was successful or false if validation failed. + + + + + Returns SuperValidator control validator is assigned to. + + + + + Gets or sets whether error is displayed using the error provider on SuperValidator when validation fails. Default value is true. + + + + + Gets or sets whether validator is enabled. Default value is true. + + + + + Gets or sets the group name validation belongs to. When control belongs to optional validation group the validation is considered successful when any of the controls in the group validates. + + + + + Gets or sets the highlight color for control when validation fails if Highlighter component is used on SuperValidator. Default Value is None. + + + + + Gets or sets the value property name for the control to validate. + + + + + Initializes a new instance of the RequiredFieldValidator class. + + + + + Initializes a new instance of the RequiredFieldValidator class. + + + + + Initializes a new instance of the RequiredFieldValidator class. + + + + + Initializes a new instance of the RequiredFieldValidator class. + + + + + Initializes a new instance of the RequiredFieldValidator class. + + + + + Initializes a new instance of the RequiredFieldValidator class. + + + + + Initializes a new instance of the RequiredFieldValidator class. + + + + + Initializes a new instance of the RequiredFieldValidator class. + + + + + Gets or sets the control to compare validated control to. + + + + + Gets or sets the Value property name for the ControlToCompare control. + + + + + Gets or sets the value to compare to the validation control. + + + + + Gets or sets the operator used for comparison. + + + + + Specifies the validation comparison operators used by the CompareValidator. + + + + + A comparison for equality. + + + + + A comparison for inequality. + + + + + A comparison for greater than. + + + + + A comparison for greater than or equal to. + + + + + A comparison for less than. + + + + + A comparison for less than or equal to. + + + + + A comparison for data type only. + + + + + Initializes a new instance of the CustomValidator class. + + + + + Gets or sets custom data associated with the validator + + + + + Defines delegate for CustomValidator ValidateValue event. + + Sender + Event arguments + + + + Gets the reference to the control to validate. + + + + + Gets or sets whether control's value is valid. + + + + + Initializes a new instance of the ValidateValueEventArgs class. + + Control to validate. + + + + Defines an interface that can be implemented by custom error providers to be used with SuperValidator. + + + + + Sets the error state on the control. + + Control for which error state is being set. + The error message from validator. + + + + Clears the error state for the control. + + Control to clear error state for. + + + + Retrieves whether control is highlighted when it receives input focus. + + + + + Sets whether control is highlighted when it receives input focus. + + Reference to supported control. + Indicates whether to highlight control on focus. + + + + Retrieves the highlight color that is applied to the control. + + + + + Sets the highlight color for the control. + + Reference to supported control. + Highlight color. + + + + Updates the highlighted controls border. Usually call to this method is not needed but under + certain scenarios where highlighter does not automatically detects the change in visibility of + the highlighted control call to this method is necessary. + + + + + Indicates the highlight focus color. + + + + + Gets or sets the container control highlighter is bound to. The container control must be set in order for highlighter to work. + Container control should always be a form. + + + + + Gets or sets the array of colors used to render custom highlight color. Control expects 3 colors in array to be specified which define the highlight border. + + + + + Defines highlight colors provided by Highlighter control. + + + + + Initializes a new instance of the ErrorProviderWrapper class. + + + + + + Initializes a new instance of the ErrorProviderWrapper class. + + + + + + + Initializes a new instance of the HighlightPanel class. + + + + + + Gets or sets the array of colors used to render custom highlight color. Control expects 3 colors in array to be specified which define the highlight border. + + + + + Initializes a new instance of the HighlightRegion structure. + + + + + + + + Initializes a new instance of the RangeValidator class. + + + + + Initializes a new instance of the RangeValidator class. + + + + + Initializes a new instance of the RangeValidator class. + + + + + Gets or sets the maximum value control may have. + + + + + Gets or sets the minimum value control may have. + + + + + Indicates whether empty string of zero length is considered valid input. + + + + + Represents the regular expression validator used with SuperValidator control. + + + + + Initializes a new instance of the RegularExpressionValidator class. + + + + + Initializes a new instance of the RegularExpressionValidator class. + + + + + + Initializes a new instance of the RegularExpressionValidator class. + + + + + + Initializes a new instance of the RegularExpressionValidator class. + + + + + + Gets or sets regular expression used to validate controls value. + + + + + Gets or sets whether empty value is considered valid value by the validator. Default value is false. + + + + + Describes required field validator used with SuperValidator control. + + + + + Initializes a new instance of the RequiredFieldValidator class. + + + + + Initializes a new instance of the RequiredFieldValidator class. + + + + + Initializes a new instance of the RequiredFieldValidator class. + + + + + Raises EvaluateIsEmpty event. + + Event Arguments + + + + Occurs when controls value needs to be evaluated to check whether it is empty. You can use this event to perform custom evaluation. + + + + + Indicates whether empty string of zero length is considered valid input. + + + + + Initializes a new instance of the ValidatorGetValueEventArgs class. + + + + + + + Gets Control to retrieve value for. + + + + + Gets the Value to evaluate. + + + + + Gets validator that is requesting value. + + + + + Resets the Value set and indicates that validator will internally retrieve value for the control. + + + + + Gets or sets the value that will be used by validator. + + + + + Raises the CustomValidatorValidateValue event. + + Validator that needs validation. + Control to validate. + + + + Retrieves first level Validator for given control or return null if control does not have validator associated with it. + + + + + Associates first level Validator with given control. + + Reference to supported control. + Instance of validator class. If null is passed existing Validator is detached from the given control. + + + + Retrieves second level Validator for given control or return null if control does not have validator associated with it. + + + + + Associates second level Validator with given control. + + Reference to supported control. + Instance of validator class. If null is passed existing Validator is detached from the given control. + + + + Retrieves third level Validator for given control or return null if control does not have validator associated with it. + + + + + Associates third level Validator with given control. + + Reference to supported control. + Instance of validator class. If null is passed existing Validator is detached from the given control. + + + + Raises the GetValue event. + + Event arguments. + + + + Performs validation on all validators. It also uses error provider to display failed validations if validator has that enabled. + + Returns true if all validations succeeded or false if at least one validation has failed. + + + + Validate single control. Note that control must have validator assigned to it. This method will change LastFailedValidationResults collection. + + Control to validate. + returns true if validation succeeds or false if it fails + + + + Validate single control. Note that control must have validator assigned to it. This method will change LastFailedValidationResults collection. + + Control to validate. + Indicates whether to clear the last set of failed validations by calling ClearFailedValidations() method. + returns true if validation succeeds or false if it fails + + + + Removes all visual markers from failed validations that were placed on the controls. + + + + + Occurs when validator retrieves the value for the control. It allows you to return value for the controls validator does not recognize. + + + + + Occurs when CustomValidator needs to validate the control value. + + + + + Gets or sets whether validation is performed in steps meaning that if first level validation fails, second level is not validated + until first level validation succeeds. Default value is false which means that all validation levels are validated even if first level fails. + + + + + Gets the readonly collection that returns failed validations that were result of last Validate method call. + + + + + Indicates default ErrorProvider IconPadding when Highlighter is used with SuperValidator. Setting this property to 0 will allow you to set IconPadding for each control manually. + + + + + Gets or sets the error provider that is used by the validator to report validation errors. + + + + + Gets or sets the custom error provider that is used by validator to report errors. You can provide your own error validators by implementing IErrorProvider interface. + + + + + Gets or sets the Highlighter component that is used to highlight validation errors. + + + + + Gets or sets the validation type performed by the control. Default value is Manual. + + + + + Gets or sets the container control validator is bound to. The container control must be set for the ValidationType ValidatingEventOnContainer. + When ContainerControl is Form the validator handles the Closing event of the form to perform the validation and cancel the form closing. + You can disable that by setting either Enabled=false or Form.CausesValidation=false. + + + + + Gets or sets whether validation is performed. Default value is true. + + + + + Gets or sets whether Cancel argument in Validating event for validation type ValidatingEventPerControl is set to true when validation fails. + + + + + Specifies the validation type for SuperValidator control. + + + + + SuperValidator uses manual validation, i.e. you will call Validate method to perform validation. + + + + + Validation is performed per control from each controls Validating event. The Cancel is set to true on event arguments if validation fails. + + + + + Validation is performed for all controls from Validating event on container control. By default container control is Form that SuperValidator is on. + + + + + Defines validator control pair used by SuperValidator control. + + + + + Gets the validator associated with the control. + + + + + Gets control reference. + + + + + Initializes a new instance of the ValidatorControlPair structure. + + Validator associated with the control + Control reference + + + + Initializes a new instance of the ValidatorGetValueEventArgs class. + + + + + + + Gets Control to retrieve value for. + + + + + Gets validator that is requesting value. + + + + + Resets the Value set and indicates that validator will internally retrieve value for the control. + + + + + Gets or sets the value that will be used by validator. + + + + + Retrieves the show state and the restored, minimized, and maximized positions of the specified window. + + + A handle to the window. + + + A pointer to the WINDOWPLACEMENT structure that receives the show state and position information. + + Before calling GetWindowPlacement, set the length member to sizeof(WINDOWPLACEMENT). GetWindowPlacement fails if lpwndpl-> length is not set correctly. + + + + If the function succeeds, the return value is nonzero. + + If the function fails, the return value is zero. To get extended error information, call GetLastError. + + + + + Options available when a form is tested for mose positions. + + + HTERROR: On the screen background or on a dividing line between windows + (same as HTNOWHERE, except that the DefWindowProc function produces a system + beep to indicate an error). + + + HTTRANSPARENT: In a window currently covered by another window in the + same thread (the message will be sent to underlying windows in the same thread + until one of them returns a code that is not HTTRANSPARENT). + + + HTNOWHERE: On the screen background or on a dividing line between + windows. + + + HTCLIENT: In a client area. + + + HTCAPTION: In a title bar. + + + HTSYSMENU: In a window menu or in a Close button in a child window. + + + HTGROWBOX: In a size box (same as HTSIZE). + + + HTMENU: In a menu. + + + HTHSCROLL: In a horizontal scroll bar. + + + HTVSCROLL: In the vertical scroll bar. + + + HTMINBUTTON: In a Minimize button. + + + HTMAXBUTTON: In a Maximize button. + + + HTLEFT: In the left border of a resizable window (the user can click + the mouse to resize the window horizontally). + + + HTRIGHT: In the right border of a resizable window (the user can click + the mouse to resize the window horizontally). + + + HTTOP: In the upper-horizontal border of a window. + + + HTTOPLEFT: In the upper-left corner of a window border. + + + HTTOPRIGHT: In the upper-right corner of a window border. + + + HTBOTTOM: In the lower-horizontal border of a resizable window (the + user can click the mouse to resize the window vertically). + + + HTBOTTOMLEFT: In the lower-left corner of a border of a resizable + window (the user can click the mouse to resize the window diagonally). + + + HTBOTTOMRIGHT: In the lower-right corner of a border of a resizable + window (the user can click the mouse to resize the window diagonally). + + + HTBORDER: In the border of a window that does not have a sizing + border. + + + HTOBJECT: Unknown...No Documentation Found + + + HTCLOSE: In a Close button. + + + HTHELP: In a Help button. + + + HTSIZE: In a size box (same as HTGROWBOX). (Same as GrowBox). + + + HTREDUCE: In a Minimize button. (Same as MinimizeButton). + + + HTZOOM: In a Maximize button. (Same as MaximizeButton). + + + + Hides the window and activates another window. + + + + + Activates and displays a window. If the window is minimized or + maximized, the system restores it to its original size and position. + An application should specify this flag when displaying the window + for the first time. + + + + + Activates the window and displays it as a minimized window. + + + + + Maximizes the specified window. + + + + + Activates the window and displays it as a maximized window. + + + + + Displays a window in its most recent size and position. This value + is similar to , except + the window is not actived. + + + + + Activates the window and displays it in its current size and position. + + + + + Minimizes the specified window and activates the next top-level + window in the Z order. + + + + + Displays the window as a minimized window. This value is similar to + , except the + window is not activated. + + + + + Displays the window in its current size and position. This value is + similar to , except the + window is not activated. + + + + + Activates and displays the window. If the window is minimized or + maximized, the system restores it to its original size and position. + An application should specify this flag when restoring a minimized window. + + + + + Sets the show state based on the SW_* value specified in the + STARTUPINFO structure passed to the CreateProcess function by the + program that started the application. + + + + + Windows 2000/XP: Minimizes a window, even if the thread + that owns the window is not responding. This flag should only be + used when minimizing windows from a different thread. + + + + + Represents Wizard control. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Resets the style to it's default value. + + + + + Resets the style to it's default value. + + + + + Simulates Back button click on Wizard control. Note that this method will raise the same events as + standard Wizard Back button click. + + + + + Simulates Next button click on Wizard control. Note that this method will raise the same events as + standard Wizard Next button click. + + + + + Simulates Cancel button click on Wizard control. Note that this method will raise the same events as + standard Wizard Cancel button click. + + + + + Simulates Finish button click on Wizard control. Note that this method will raise the same events as + standard Wizard Finish button click. + + + + + Raises BackButtonClick event. + + Event arguments + + + + Raises NextButtonClick event. + + Event arguments + + + + Raises FinishButtonClick event. + + Event arguments + + + + Raises CancelButtonClick event. + + Event arguments + + + + Raises HelpButtonClick event. + + Event arguments + + + + Raises WizardPageChanging event. + + Provides event arguments + + + + Raises WizardPageChanged event. + + Provides event arguments + + + + Occurs when Back button is clicked. You can cancel any default processing performed by Wizard control by setting Cancel=true on event arguments. + + + + + Occurs when Next button is clicked. You can cancel any default processing performed by Wizard control by setting Cancel=true on event arguments. + + + + + Occurs when Finish button is clicked. You can cancel any default processing performed by Wizard control by setting Cancel=true on event arguments. + + + + + Occurs when Cancel button is clicked. You can cancel any default processing performed by Wizard control by setting Cancel=true on event arguments. + + + + + Occurs when Help button is clicked. You can cancel any default processing performed by Wizard control by setting Cancel=true on event arguments. + + + + + Occurs before wizard page has changed and gives you opportunity to cancel the change. + + + + + Occurs after wizard page has changed. This event cannot be cancelled. To cancel the page change please use WizardPageChanging event. + + + + + Occurs when wizard buttons (Back, Next, Finish etc) are positioned and resized. + + + + + Gets or sets the header image. Default value is null which means that internal header image is used. You can hide header image + by setting HeaderImageVisible property. + + + + + Gets or sets whether header image is visible. Default value is true. + + + + + Gets or sets wizard button that is clicked when ENTER key is pressed. Default value is eWizardFormAcceptButton.FinishAndNext which + indicates that finish button will be clicked if available otherwise next button will be clicked. + + + + + Gets or sets wizard button that is clicked when ESCAPE key is pressed. Default value is eWizardFormCancelButton.Cancel which + indicates that Cancel button will be clicked. + + + + + Gets or sets whether all buttons are disabled while wizard page is changed which prevents users from clicking the buttons + if page change is taking longer. Default value is true. + + + + + Gets or sets whether wait cursor is displayed while page is changed. Default value is true. + + + + + Gets or sets the selected page index. You can set this property to change the currently selected wizard page. + + + + + Gets or sets selected wizard page. You can set this property to change the currently selected wizard page. + + + + + Gets the collection of Wizard pages. The order of WizardPage objects inside of this collection determines the flow of the wizard. + + + + + Returns a Stack of page history. Each time next page is displayed by wizard, previously visited page is added to the history. + When user commands Wizard back, the last page from the history is shown and removed from the stack. You should not modify this collection + directly since it is maintained by Wizard control. + + + + + Gets or sets the FlatStyle setting for the wizard buttons. Default value is FlatStyle.System + + + + + Gets or sets height of wizard command buttons. Default value is 22 pixels. + + + + + Gets or sets whether back button causes validation to be performed on any controls that require validation when it receives focus. Default value is false. + + + + + Gets or sets tab index of back button. Default value is 1. + + + + + Gets or sets a value indicating whether the user can give the focus to this back button using the TAB key. Default value is true. + + + + + Gets or sets caption of the back button. + + + + + Gets or sets width of the back button. Default value is 74. + + + + + Gets or sets auto size of the button. Default value is false. + + + + + Gets or sets auto size mode of the button. Default value is AutoSizeMode.GrowOnly. + + + + + Gets or sets whether next button causes validation to be performed on any controls that require validation when it receives focus. Default value is true. + + + + + Gets or sets tab index of next button. Default value is 2. + + + + + Gets or sets a value indicating whether the user can give the focus to button using the TAB key. Default value is true. + + + + + Gets or sets caption of the next button. + + + + + Gets or sets width of the next button. Default value is 74. + + + + + Gets or sets auto size of the button. Default value is false. + + + + + Gets or sets auto size mode of the button. Default value is AutoSizeMode.GrowOnly. + + + + + Gets or sets whether button causes validation to be performed on any controls that require validation when it receives focus. Default value is false. + + + + + Gets or sets tab index of the button. Default value is 4. + + + + + Gets or sets a value indicating whether the user can give the focus to button using the TAB key. Default value is true. + + + + + Gets or sets caption of the button. + + + + + Gets or sets width of the button. Default value is 74. + + + + + Gets or sets auto size of the button. Default value is false. + + + + + Gets or sets auto size mode of the button. Default value is AutoSizeMode.GrowOnly. + + + + + Gets or sets whether button causes validation to be performed on any controls that require validation when it receives focus. Default value is true. + + + + + Gets or sets tab index of the button. Default value is 4. + + + + + Gets or sets a value indicating whether the user can give the focus to button using the TAB key. Default value is true. + + + + + Gets or sets caption of the button. + + + + + Gets or sets width of the button. Default value is 74. + + + + + Gets or sets whether finish button is always visible next to the Next button. Default value is false which means that Finish + button will be visible only on last Wizard page and it will replace the Next button. When set to true Finish button is always visible next + to the Next button except on first Welcome wizard page. + + + + + Gets or sets auto size of the button. Default value is false. + + + + + Gets or sets auto size mode of the button. Default value is AutoSizeMode.GrowOnly. + + + + + Gets or sets whether button causes validation to be performed on any controls that require validation when it receives focus. Default value is false. + + + + + Gets or sets whether button is visible. Default value is true. + + + + + Gets or sets tab index of the button. Default value is 5. + + + + + Gets or sets a value indicating whether the user can give the focus to button using the TAB key. Default value is true. + + + + + Gets or sets caption of the button. + + + + + Gets or sets width of the button. Default value is 74. + + + + + Gets or sets auto size of the button. Default value is false. + + + + + Gets or sets auto size mode of the button. Default value is AutoSizeMode.GrowOnly. + + + + + Gets or sets the height of the wizard footer. Default value is 46 + + + + + Gets or sets the height of the wizard header. Default value is 60 + + + + + Gets or sets the header image alignment. Default value is right. + + + + + Gets or sets the header image size for interior wizard pages. Default value is 48x48 + + + + + Gets or sets indentation of header title label. Default value is 16. + + + + + Gets or sets indentation of header description label. Default value is 44. + + + + + + Indicates the font used to render caption header text. + + + + + Gets or sets whether description text displayed in wizard header is visible. + + + + + Gets or sets the header background style. + + + + + Gets or sets the footer background style. + + + + + Returns reference to internal Next button control. + + + + + Returns reference to internal Cancel button control. + + + + + Returns reference to internal Finish button control. + + + + + Returns reference to internal Help button control. + + + + + Returns reference to internal Back button control. + + + + + Gets or sets whether Focus cues on wizard navigation buttons are enabled. Default value is true. + + + + + Gets or sets the visual style used for wizard buttons. + + + + + Provides data for LayoutWizardButtons event. + + + + + Gets or sets bounds of Back button. + + + + + Gets or sets bounds of Next button. + + + + + Gets or sets bounds of Finish button. + + + + + Gets or sets bounds of Cancel button. + + + + + Gets or sets bounds of Help button. + + + + + Creates new instance of the class. + + + + + Creates new instance of the class and initializes it with default values. + + + + + Defines delegate for WizardPageChange events. + + + + + Updates page state when one of the page appearance properties has changed. + + + + + Fires BeforePageDisplayed event. + + Event arguments + + + + Invokes the BeforePageDisplayed event. + + Event arguments + + + + Fires AfterPageDisplayed event. + + Event arguments. + + + + Invokes AfterPageDisplayed event. + + Event arguments + + + + Fires BeforePageDisplayed event. + + Event arguments + + + + Invokes the BeforePageDisplayed event. + + Event arguments + + + + Raises BackButtonClick event. + + Event arguments + + + + Invokes BackButtonClick event. + + + + + Raises NextButtonClick event. + + Event arguments + + + + Invokes NextButtonClick event. + + + + + Raises FinishButtonClick event. + + Event arguments + + + + Invokes FinishButtonClick event. + + + + + Raises CancelButtonClick event. + + Event arguments + + + + Invokes CancelButtonClick event. + + + + + Raises HelpButtonClick event. + + Event arguments + + + + Invokes HelpButtonClick event. + + + + + Occurs before page is displayed. This event can cancel the page change. You can perform any additional setup of the Wizard page in this event. + + + + + Occurs after page has been displayed.This event can cancel the page change. You can perform any additional setup of the Wizard page in this event. + + + + + Occurs after page is hidden. You can perform any additional steps that are needed to complete wizard step in this event. + + + + + Occurs when Back button is clicked. You can cancel any default processing performed by Wizard control by setting Cancel=true on event arguments. + + + + + Occurs when Next button is clicked. You can cancel any default processing performed by Wizard control by setting Cancel=true on event arguments. + + + + + Occurs when Finish button is clicked. You can cancel any default processing performed by Wizard control by setting Cancel=true on event arguments. + + + + + Occurs when Cancel button is clicked. You can cancel any default processing performed by Wizard control by setting Cancel=true on event arguments. + + + + + Occurs when Help button is clicked. You can cancel any default processing performed by Wizard control by setting Cancel=true on event arguments. + + + + + Gets whether page is currently selected page in Wizard. + + + + + Gets or sets whether back button is enabled when page is active. Default value is eWizardButtonState.Auto which indicates that state is + automatically managed by control. + + + + + Gets or sets whether back button is visible when page is active. Default value is eWizardButtonState.Auto. + + + + + Gets or sets whether next button is enabled when page is active. Default value is eWizardButtonState.Auto which indicates that state is + automatically managed by control. + + + + + Gets or sets whether next button is visible when page is active. Default value is eWizardButtonState.Auto. + + + + + Gets or sets whether finish button is enabled when page is active. Default value is eWizardButtonState.Auto which indicates that state is + automatically managed by control. + + + + + Gets or sets whether cancel button is enabled when page is active. Default value is eWizardButtonState.Auto which indicates that state is + automatically managed by control. + + + + + Gets or sets whether cancel button is visible when page is active. Default value is eWizardButtonState.Auto. + + + + + Gets or sets whether help button is enabled when page is active. Default value is eWizardButtonState.Auto which indicates that state is + automatically managed by control. + + + + + Gets or sets whether help button is visible when page is active. Default value is eWizardButtonState.Auto. + + + + + Gets or sets the page header image when page is an interior page, InteriorPage=true. Default value is null. + + + + + Gets or sets the text that is displayed as title in wizard header when page is active. + + + + + Gets or sets the text that is displayed as description in wizard header when page is active. + + + + + Gets or sets the text that is displayed on form caption when page is active. Default value is empty string which indicates that form caption + is not changed when page becomes active. + + + + + Gets or sets whether page is interior page. Interior pages use wizard header area to display page title, description and optional image. They are also padded and do not + fill the client area of the Wizard. Default value is true. + You can set this value to false to hide header area and make page fill the client area of the wizard. + + + + + Gets or sets whether page is visible. Page visibility is managed by Wizard control and it should not be set directly. + + + + + Represents the collection of WizardPage objects which determines the flow of the wizard. + + + + + Adds new object to the collection. + + Object to add. + Index of newly added object. + + + + Adds an array of objects to the collection. + + Array of WizardPage objects. + + + + Inserts new object into the collection. + + Position of the object. + Object to insert. + + + + Returns index of the object inside of the collection. + + Reference to the object. + Index of the object. + + + + Returns whether collection contains specified object. + + Object to look for. + true if object is part of the collection, otherwise false. + + + + Removes specified object from the collection. + + + + + + Copies collection into the specified array. + + Array to copy collection to. + Starting index. + + + + Copies contained items to the WizardPage array. + + Array to copy to. + + + + Copies contained items to the WizardPage array. + + Array to copy to. + + + + Gets the parent this collection is associated with. + + + + + Returns reference to the object in collection based on it's index. + + + + + Returns reference to the object in collection based on it's name. + + + + + Provides data for Wizard Page Change events. + + + + + Specifies the new active wizard page. You can change this argument when handling WizardPageChanging event and provide newly selected page of your own. + + + + + Specifies page that was or currently is active. + + + + + Indicates the wizard button that was source of page change. + + + + + Creates new instance of the class with default values. + + New wizard page + Old or current wizard page + Page change source + + + + Provides data for Wizard Page Change events. + + + + + Allows you to cancel the page change. + + + + + Creates new instance of the class with default values. + + New wizard page + Old or current wizard page + Page change source + + + + Defines delegate for WizardPageChange events. + + + + + Defines delegate for WizardPageChange events. + + + + diff --git a/ToolListRun/bin/Debug/FindLineTool.dll b/ToolListRun/bin/Debug/FindLineTool.dll new file mode 100644 index 0000000..42ced4b Binary files /dev/null and b/ToolListRun/bin/Debug/FindLineTool.dll differ diff --git a/ToolListRun/bin/Debug/FindLineTool.pdb b/ToolListRun/bin/Debug/FindLineTool.pdb new file mode 100644 index 0000000..31c4766 Binary files /dev/null and b/ToolListRun/bin/Debug/FindLineTool.pdb differ diff --git a/ToolListRun/bin/Debug/HalconTool.dll b/ToolListRun/bin/Debug/HalconTool.dll new file mode 100644 index 0000000..30f440c Binary files /dev/null and b/ToolListRun/bin/Debug/HalconTool.dll differ diff --git a/ToolListRun/bin/Debug/HalconTool.pdb b/ToolListRun/bin/Debug/HalconTool.pdb new file mode 100644 index 0000000..d3c66ef Binary files /dev/null and b/ToolListRun/bin/Debug/HalconTool.pdb differ diff --git a/ToolListRun/bin/Debug/HalconWindow.exe b/ToolListRun/bin/Debug/HalconWindow.exe new file mode 100644 index 0000000..da142c4 Binary files /dev/null and b/ToolListRun/bin/Debug/HalconWindow.exe differ diff --git a/ToolListRun/bin/Debug/HalconWindow.pdb b/ToolListRun/bin/Debug/HalconWindow.pdb new file mode 100644 index 0000000..1e05157 Binary files /dev/null and b/ToolListRun/bin/Debug/HalconWindow.pdb differ diff --git a/ToolListRun/bin/Debug/ToolBase.dll b/ToolListRun/bin/Debug/ToolBase.dll new file mode 100644 index 0000000..9799780 Binary files /dev/null and b/ToolListRun/bin/Debug/ToolBase.dll differ diff --git a/ToolListRun/bin/Debug/ToolBase.pdb b/ToolListRun/bin/Debug/ToolBase.pdb new file mode 100644 index 0000000..a2860c6 Binary files /dev/null and b/ToolListRun/bin/Debug/ToolBase.pdb differ diff --git a/ToolListRun/bin/Debug/ToolListRun.dll b/ToolListRun/bin/Debug/ToolListRun.dll new file mode 100644 index 0000000..32d0efd Binary files /dev/null and b/ToolListRun/bin/Debug/ToolListRun.dll differ diff --git a/ToolListRun/bin/Debug/ToolListRun.pdb b/ToolListRun/bin/Debug/ToolListRun.pdb new file mode 100644 index 0000000..48de1fb Binary files /dev/null and b/ToolListRun/bin/Debug/ToolListRun.pdb differ diff --git a/ToolListRun/bin/Debug/VisionEdit.exe b/ToolListRun/bin/Debug/VisionEdit.exe new file mode 100644 index 0000000..4cb4bd7 Binary files /dev/null and b/ToolListRun/bin/Debug/VisionEdit.exe differ diff --git a/ToolListRun/bin/Debug/VisionEdit.pdb b/ToolListRun/bin/Debug/VisionEdit.pdb new file mode 100644 index 0000000..f410c75 Binary files /dev/null and b/ToolListRun/bin/Debug/VisionEdit.pdb differ diff --git a/ToolListRun/bin/Debug/VisionJobFactory.dll b/ToolListRun/bin/Debug/VisionJobFactory.dll new file mode 100644 index 0000000..03ba36f Binary files /dev/null and b/ToolListRun/bin/Debug/VisionJobFactory.dll differ diff --git a/ToolListRun/bin/Debug/VisionJobFactory.pdb b/ToolListRun/bin/Debug/VisionJobFactory.pdb new file mode 100644 index 0000000..03985ba Binary files /dev/null and b/ToolListRun/bin/Debug/VisionJobFactory.pdb differ diff --git a/ToolListRun/bin/Debug/WeifenLuo.WinFormsUI.Docking.dll b/ToolListRun/bin/Debug/WeifenLuo.WinFormsUI.Docking.dll new file mode 100644 index 0000000..d8ef4d1 Binary files /dev/null and b/ToolListRun/bin/Debug/WeifenLuo.WinFormsUI.Docking.dll differ diff --git a/ToolListRun/bin/Debug/WeifenLuo.WinFormsUI.Docking.pdb b/ToolListRun/bin/Debug/WeifenLuo.WinFormsUI.Docking.pdb new file mode 100644 index 0000000..00441a9 Binary files /dev/null and b/ToolListRun/bin/Debug/WeifenLuo.WinFormsUI.Docking.pdb differ diff --git a/ToolListRun/bin/Debug/halcondotnet.dll b/ToolListRun/bin/Debug/halcondotnet.dll new file mode 100644 index 0000000..f058ee4 Binary files /dev/null and b/ToolListRun/bin/Debug/halcondotnet.dll differ diff --git a/ToolListRun/bin/Debug/halcondotnet.xml b/ToolListRun/bin/Debug/halcondotnet.xml new file mode 100644 index 0000000..d5e6ddf --- /dev/null +++ b/ToolListRun/bin/Debug/halcondotnet.xml @@ -0,0 +1,61480 @@ + + + + halcondotnet + + + + Represents an instance of a bar code reader. + + + Represents a generic instance of a handle. + + + Represents an uninitialized handle instance + + + Relinquish ownership of managed handle + + Caller must ensure that handle is destroyed at some time + after this instance is no longer used. + + + + + Returns true if the handle has been initialized. + + + A handle will be uninitialized when creating it with a + no-argument constructor or after calling Dispose(); + + + + Releases the resources used by this handle object + + + + Invalidates the handle but keeps the HALCON handle alive, which + only makes sense if the handle is used externally and cleared later, + e.g. by an HOperatorSet based module or another language interface. + + + + + Provides a simple string representation of the handle id + as hex number, which is mainly useful for debug outputs (to + see if two handles are identical) + + + + Cast to IntPtr returns HALCON ID of handle resources + Caller must ensure that input object is kept alive + + + Returns the HALCON ID for the handle + Caller must ensure that input handle is kept alive + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + + Clear the content of a handle. + Instance represents: Handle to clear. + + + + + Deserialize a serialized item. + Modified instance represents: Handle containing the deserialized item. + + Handle containing the serialized item to be deserialized. + + + + Serialize the content of a handle. + Instance represents: Handle that should be serialized. + + Handle containing the serialized item. + + + + Test if a tuple is serializable. + Instance represents: Tuple to check for serializability. + + Boolean value indicating if the input can be serialized. + + + + Check if a handle is valid. + Instance represents: The handle to check for validity. + + The validity of the handle, 1 or 0. + + + + Return the semantic type of a tuple. + Instance represents: Input tuple. + + Semantic type of the input tuple as a string. + + + + Read a bar code model from a file and create a new model. + Modified instance represents: Handle of the bar code model. + + Name of the bar code model file. Default: "bar_code_model.bcm" + + + + Create a model of a bar code reader. + Modified instance represents: Handle for using and accessing the bar code model. + + Names of the generic parameters that can be adjusted for the bar code model. Default: [] + Values of the generic parameters that can be adjusted for the bar code model. Default: [] + + + + Create a model of a bar code reader. + Modified instance represents: Handle for using and accessing the bar code model. + + Names of the generic parameters that can be adjusted for the bar code model. Default: [] + Values of the generic parameters that can be adjusted for the bar code model. Default: [] + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + + Deserialize a bar code model. + Modified instance represents: Handle of the bar code model. + + Handle of the serialized item. + + + + Serialize a bar code model. + Instance represents: Handle of the bar code model. + + Handle of the serialized item. + + + + Read a bar code model from a file and create a new model. + Modified instance represents: Handle of the bar code model. + + Name of the bar code model file. Default: "bar_code_model.bcm" + + + + Write a bar code model to a file. + Instance represents: Handle of the bar code model. + + Name of the bar code model file. Default: "bar_code_model.bcm" + + + + Access iconic objects that were created during the search or decoding of bar code symbols. + Instance represents: Handle of the bar code model. + + Indicating the bar code results respectively candidates for which the data is required. Default: "all" + Name of the iconic object to return. Default: "candidate_regions" + Objects that are created as intermediate results during the detection or evaluation of bar codes. + + + + Access iconic objects that were created during the search or decoding of bar code symbols. + Instance represents: Handle of the bar code model. + + Indicating the bar code results respectively candidates for which the data is required. Default: "all" + Name of the iconic object to return. Default: "candidate_regions" + Objects that are created as intermediate results during the detection or evaluation of bar codes. + + + + Get the alphanumerical results that were accumulated during the decoding of bar code symbols. + Instance represents: Handle of the bar code model. + + Indicating the bar code results respectively candidates for which the data is required. Default: "all" + Names of the resulting data to return. Default: "decoded_types" + List with the results. + + + + Get the alphanumerical results that were accumulated during the decoding of bar code symbols. + Instance represents: Handle of the bar code model. + + Indicating the bar code results respectively candidates for which the data is required. Default: "all" + Names of the resulting data to return. Default: "decoded_types" + List with the results. + + + + Decode bar code symbols within a rectangle. + Instance represents: Handle of the bar code model. + + Input image. + Type of the searched bar code. Default: "EAN-13" + Row index of the center. Default: 50.0 + Column index of the center. Default: 100.0 + Orientation of rectangle in radians. Default: 0.0 + Half of the length of the rectangle along the reading direction of the bar code. Default: 200.0 + Half of the length of the rectangle perpendicular to the reading direction of the bar code. Default: 100.0 + Data strings of all successfully decoded bar codes. + + + + Decode bar code symbols within a rectangle. + Instance represents: Handle of the bar code model. + + Input image. + Type of the searched bar code. Default: "EAN-13" + Row index of the center. Default: 50.0 + Column index of the center. Default: 100.0 + Orientation of rectangle in radians. Default: 0.0 + Half of the length of the rectangle along the reading direction of the bar code. Default: 200.0 + Half of the length of the rectangle perpendicular to the reading direction of the bar code. Default: 100.0 + Data strings of all successfully decoded bar codes. + + + + Detect and read bar code symbols in an image. + Instance represents: Handle of the bar code model. + + Input image. If the image has a reduced domain, the barcode search is reduced to that domain. This usually reduces the runtime of the operator. However, if the barcode is not fully inside the domain, the barcode cannot be decoded correctly. + Type of the searched bar code. Default: "auto" + Data strings of all successfully decoded bar codes. + Regions of the successfully decoded bar code symbols. + + + + Detect and read bar code symbols in an image. + Instance represents: Handle of the bar code model. + + Input image. If the image has a reduced domain, the barcode search is reduced to that domain. This usually reduces the runtime of the operator. However, if the barcode is not fully inside the domain, the barcode cannot be decoded correctly. + Type of the searched bar code. Default: "auto" + Data strings of all successfully decoded bar codes. + Regions of the successfully decoded bar code symbols. + + + + Get the names of the parameters that can be used in set_bar_code* and get_bar_code* operators for a given bar code model + Instance represents: Handle of the bar code model. + + Properties of the parameters. Default: "trained_general" + Names of the generic parameters. + + + + Get parameters that are used by the bar code reader when processing a specific bar code type. + Instance represents: Handle of the bar code model. + + Names of the bar code types for which parameters should be queried. Default: "EAN-13" + Names of the generic parameters that are to be queried for the bar code model. Default: "check_char" + Values of the generic parameters. + + + + Get parameters that are used by the bar code reader when processing a specific bar code type. + Instance represents: Handle of the bar code model. + + Names of the bar code types for which parameters should be queried. Default: "EAN-13" + Names of the generic parameters that are to be queried for the bar code model. Default: "check_char" + Values of the generic parameters. + + + + Get one or several parameters that describe the bar code model. + Instance represents: Handle of the bar code model. + + Names of the generic parameters that are to be queried for the bar code model. Default: "element_size_min" + Values of the generic parameters. + + + + Get one or several parameters that describe the bar code model. + Instance represents: Handle of the bar code model. + + Names of the generic parameters that are to be queried for the bar code model. Default: "element_size_min" + Values of the generic parameters. + + + + Set selected parameters of the bar code model for selected bar code types + Instance represents: Handle of the bar code model. + + Names of the bar code types for which parameters should be set. Default: "EAN-13" + Names of the generic parameters that shall be adjusted for finding and decoding bar codes. Default: "check_char" + Values of the generic parameters that are adjusted for finding and decoding bar codes. Default: "absent" + + + + Set selected parameters of the bar code model for selected bar code types + Instance represents: Handle of the bar code model. + + Names of the bar code types for which parameters should be set. Default: "EAN-13" + Names of the generic parameters that shall be adjusted for finding and decoding bar codes. Default: "check_char" + Values of the generic parameters that are adjusted for finding and decoding bar codes. Default: "absent" + + + + Set selected parameters of the bar code model. + Instance represents: Handle of the bar code model. + + Names of the generic parameters that shall be adjusted for finding and decoding bar codes. Default: "element_size_min" + Values of the generic parameters that are adjusted for finding and decoding bar codes. Default: 8 + + + + Set selected parameters of the bar code model. + Instance represents: Handle of the bar code model. + + Names of the generic parameters that shall be adjusted for finding and decoding bar codes. Default: "element_size_min" + Values of the generic parameters that are adjusted for finding and decoding bar codes. Default: 8 + + + Delete a bar code model and free the allocated memory + Handle of the bar code model. + + + + Delete a bar code model and free the allocated memory + Instance represents: Handle of the bar code model. + + + + + Create a model of a bar code reader. + Modified instance represents: Handle for using and accessing the bar code model. + + Names of the generic parameters that can be adjusted for the bar code model. Default: [] + Values of the generic parameters that can be adjusted for the bar code model. Default: [] + + + + Create a model of a bar code reader. + Modified instance represents: Handle for using and accessing the bar code model. + + Names of the generic parameters that can be adjusted for the bar code model. Default: [] + Values of the generic parameters that can be adjusted for the bar code model. Default: [] + + + Represents an instance of a barrier synchronization object. + + + + Create a barrier synchronization object. + Modified instance represents: Barrier synchronization object. + + Barrier attribute. Default: [] + Barrier attribute value. Default: [] + Barrier team size. Default: 1 + + + + Create a barrier synchronization object. + Modified instance represents: Barrier synchronization object. + + Barrier attribute. Default: [] + Barrier attribute value. Default: [] + Barrier team size. Default: 1 + + + + Destroy a barrier synchronization object. + Instance represents: Barrier synchronization object. + + + + + Wait on the release of a barrier synchronization object. + Instance represents: Barrier synchronization object. + + + + + Create a barrier synchronization object. + Modified instance represents: Barrier synchronization object. + + Barrier attribute. Default: [] + Barrier attribute value. Default: [] + Barrier team size. Default: 1 + + + + Create a barrier synchronization object. + Modified instance represents: Barrier synchronization object. + + Barrier attribute. Default: [] + Barrier attribute value. Default: [] + Barrier team size. Default: 1 + + + Represents an instance of the data structure used to inspect beads. + + + + Create a model to inspect beads or adhesive in images. + Modified instance represents: Handle for using and accessing the bead inspection model. + + XLD contour specifying the expected bead's shape and position. + Optimal bead thickness. Default: 50 + Tolerance of bead's thickness with respect to TargetThickness. Default: 15 + Tolerance of the bead's center position. Default: 15 + The bead's polarity. Default: "light" + Names of the generic parameters that can be adjusted for the bead inspection model. Default: [] + Values of the generic parameters that can be adjusted for the bead inspection model. Default: [] + + + + Create a model to inspect beads or adhesive in images. + Modified instance represents: Handle for using and accessing the bead inspection model. + + XLD contour specifying the expected bead's shape and position. + Optimal bead thickness. Default: 50 + Tolerance of bead's thickness with respect to TargetThickness. Default: 15 + Tolerance of the bead's center position. Default: 15 + The bead's polarity. Default: "light" + Names of the generic parameters that can be adjusted for the bead inspection model. Default: [] + Values of the generic parameters that can be adjusted for the bead inspection model. Default: [] + + + + Get the value of a parameter in a specific bead inspection model. + Instance represents: Handle of the bead inspection model. + + Name of the model parameter that is queried. Default: "target_thickness" + Value of the queried model parameter. + + + + Get the value of a parameter in a specific bead inspection model. + Instance represents: Handle of the bead inspection model. + + Name of the model parameter that is queried. Default: "target_thickness" + Value of the queried model parameter. + + + + Set parameters of the bead inspection model. + Instance represents: Handle of the bead inspection model. + + Name of the model parameter that shall be adjusted for the specified bead inspection model. Default: "target_thickness" + Value of the model parameter that shall be adjusted for the specified bead inspection model. Default: 40 + + + + Set parameters of the bead inspection model. + Instance represents: Handle of the bead inspection model. + + Name of the model parameter that shall be adjusted for the specified bead inspection model. Default: "target_thickness" + Value of the model parameter that shall be adjusted for the specified bead inspection model. Default: 40 + + + + Inspect beads in an image, as defined by the bead inspection model. + Instance represents: Handle of the bead inspection model to be used. + + Image to apply bead inspection on. + The detected right contour of the beads. + Detected error segments + Types of detected errors. + The detected left contour of the beads. + + + + Delete the bead inspection model and free the allocated memory. + Instance represents: Handle of the bead inspection model. + + + + + Create a model to inspect beads or adhesive in images. + Modified instance represents: Handle for using and accessing the bead inspection model. + + XLD contour specifying the expected bead's shape and position. + Optimal bead thickness. Default: 50 + Tolerance of bead's thickness with respect to TargetThickness. Default: 15 + Tolerance of the bead's center position. Default: 15 + The bead's polarity. Default: "light" + Names of the generic parameters that can be adjusted for the bead inspection model. Default: [] + Values of the generic parameters that can be adjusted for the bead inspection model. Default: [] + + + + Create a model to inspect beads or adhesive in images. + Modified instance represents: Handle for using and accessing the bead inspection model. + + XLD contour specifying the expected bead's shape and position. + Optimal bead thickness. Default: 50 + Tolerance of bead's thickness with respect to TargetThickness. Default: 15 + Tolerance of the bead's center position. Default: 15 + The bead's polarity. Default: "light" + Names of the generic parameters that can be adjusted for the bead inspection model. Default: [] + Values of the generic parameters that can be adjusted for the bead inspection model. Default: [] + + + Represents an instance of a background estimator. + + + + Generate and initialize a data set for the background estimation. + Modified instance represents: ID of the BgEsti data set. + + initialization image. + 1. system matrix parameter. Default: 0.7 + 2. system matrix parameter. Default: 0.7 + Gain type. Default: "fixed" + Kalman gain / foreground adaptation time. Default: 0.002 + Kalman gain / background adaptation time. Default: 0.02 + Threshold adaptation. Default: "on" + Foreground/background threshold. Default: 7.0 + Number of statistic data sets. Default: 10 + Confidence constant. Default: 3.25 + Constant for decay time. Default: 15.0 + + + + Delete the background estimation data set. + Instance represents: ID of the BgEsti data set. + + + + + Return the estimated background image. + Instance represents: ID of the BgEsti data set. + + Estimated background image of the current data set. + + + + Change the estimated background image. + Instance represents: ID of the BgEsti data set. + + Current image. + Region describing areas to change. + + + + Estimate the background and return the foreground region. + Instance represents: ID of the BgEsti data set. + + Current image. + Region of the detected foreground. + + + + Return the parameters of the data set. + Instance represents: ID of the BgEsti data set. + + 2. system matrix parameter. + Gain type. + Kalman gain / foreground adaptation time. + Kalman gain / background adaptation time. + Threshold adaptation. + Foreground / background threshold. + Number of statistic data sets. + Confidence constant. + Constant for decay time. + 1. system matrix parameter. + + + + Change the parameters of the data set. + Instance represents: ID of the BgEsti data set. + + 1. system matrix parameter. Default: 0.7 + 2. system matrix parameter. Default: 0.7 + Gain type. Default: "fixed" + Kalman gain / foreground adaptation time. Default: 0.002 + Kalman gain / background adaptation time. Default: 0.02 + Threshold adaptation. Default: "on" + Foreground/background threshold. Default: 7.0 + Number of statistic data sets. Default: 10 + Confidence constant. Default: 3.25 + Constant for decay time. Default: 15.0 + + + + Generate and initialize a data set for the background estimation. + Modified instance represents: ID of the BgEsti data set. + + initialization image. + 1. system matrix parameter. Default: 0.7 + 2. system matrix parameter. Default: 0.7 + Gain type. Default: "fixed" + Kalman gain / foreground adaptation time. Default: 0.002 + Kalman gain / background adaptation time. Default: 0.02 + Threshold adaptation. Default: "on" + Foreground/background threshold. Default: 7.0 + Number of statistic data sets. Default: 10 + Confidence constant. Default: 3.25 + Constant for decay time. Default: 15.0 + + + Represents an instance of a camera calibration model. + + + + Restore a calibration data model from a file. + Modified instance represents: Handle of a calibration data model. + + The path and file name of the model file. + + + + Create a HALCON calibration data model. + Modified instance represents: Handle of the created calibration data model. + + Type of the calibration setup. Default: "calibration_object" + Number of cameras in the calibration setup. Default: 1 + Number of calibration objects. Default: 1 + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + + Free the memory of a calibration data model. + Instance represents: Handle of a calibration data model. + + + + + Deserialize a serialized calibration data model. + Modified instance represents: Handle of a calibration data model. + + Handle of the serialized item. + + + + Serialize a calibration data model. + Instance represents: Handle of a calibration data model. + + Handle of the serialized item. + + + + Restore a calibration data model from a file. + Modified instance represents: Handle of a calibration data model. + + The path and file name of the model file. + + + + Store a calibration data model into a file. + Instance represents: Handle of a calibration data model. + + The file name of the model to be saved. + + + + Perform a hand-eye calibration. + Instance represents: Handle of a calibration data model. + + Average residual error of the optimization. + + + + Determine all camera parameters by a simultaneous minimization process. + Instance represents: Handle of a calibration data model. + + Back projection root mean square error (RMSE) of the optimization. + + + + Remove a data set from a calibration data model. + Instance represents: Handle of a calibration data model. + + Type of the calibration data item. Default: "tool" + Index of the affected item. Default: 0 + + + + Remove a data set from a calibration data model. + Instance represents: Handle of a calibration data model. + + Type of the calibration data item. Default: "tool" + Index of the affected item. Default: 0 + + + + Set data in a calibration data model. + Instance represents: Handle of a calibration data model. + + Type of calibration data item. Default: "model" + Index of the affected item (depending on the selected ItemType). Default: "general" + Parameter(s) to set. Default: "reference_camera" + New value(s). Default: 0 + + + + Set data in a calibration data model. + Instance represents: Handle of a calibration data model. + + Type of calibration data item. Default: "model" + Index of the affected item (depending on the selected ItemType). Default: "general" + Parameter(s) to set. Default: "reference_camera" + New value(s). Default: 0 + + + + Find the HALCON calibration plate and set the extracted points and contours in a calibration data model. + Instance represents: Handle of a calibration data model. + + Input image. + Index of the observing camera. Default: 0 + Index of the calibration object. Default: 0 + Index of the observed calibration object. Default: 0 + Names of the generic parameters to be set. Default: [] + Values of the generic parameters to be set. Default: [] + + + + Remove observation data from a calibration data model. + Instance represents: Handle of a calibration data model. + + Index of the observing camera. Default: 0 + Index of the observed calibration object. Default: 0 + Index of the observed calibration object pose. Default: 0 + + + + Get contour-based observation data from a calibration data model. + Instance represents: Handle of a calibration data model. + + Name of contour objects to be returned. Default: "marks" + Index of the observing camera. Default: 0 + Index of the observed calibration object. Default: 0 + Index of the observed calibration object pose. Default: 0 + Contour-based result(s). + + + + Get observed calibration object poses from a calibration data model. + Instance represents: Handle of a calibration data model. + + Index of the observing camera. Default: 0 + Index of the observed calibration object. Default: 0 + Index of the observed calibration object pose. Default: 0 + Stored observed calibration object pose relative to the observing camera. + + + + Set observed calibration object poses in a calibration data model. + Instance represents: Handle of a calibration data model. + + Index of the observing camera. Default: 0 + Index of the calibration object. Default: 0 + Index of the observed calibration object. Default: 0 + Pose of the observed calibration object relative to the observing camera. + + + + Get point-based observation data from a calibration data model. + Instance represents: Handle of a calibration data model. + + Index of the observing camera. Default: 0 + Index of the observed calibration object. Default: 0 + Index of the observed calibration object pose. Default: 0 + Row coordinates of the detected points. + Column coordinates of the detected points. + Correspondence of the detected points to the points of the observed calibration object. + Roughly estimated pose of the observed calibration object relative to the observing camera. + + + + Set point-based observation data in a calibration data model. + Instance represents: Handle of a calibration data model. + + Index of the observing camera. Default: 0 + Index of the calibration object. Default: 0 + Index of the observed calibration object. Default: 0 + Row coordinates of the extracted points. + Column coordinates of the extracted points. + Correspondence of the extracted points to the calibration marks of the observed calibration object. Default: "all" + Roughly estimated pose of the observed calibration object relative to the observing camera. + + + + Query information about the relations between cameras, calibration objects, and calibration object poses. + Instance represents: Handle of a calibration data model. + + Kind of referred object. Default: "camera" + Camera index or calibration object index (depending on the selected ItemType). Default: 0 + Calibration object numbers. + List of calibration object indices or list of camera indices (depending on ItemType). + + + + Query data stored or computed in a calibration data model. + Instance represents: Handle of a calibration data model. + + Type of calibration data item. Default: "camera" + Index of the affected item (depending on the selected ItemType). Default: 0 + The name of the inspected data. Default: "params" + Requested data. + + + + Query data stored or computed in a calibration data model. + Instance represents: Handle of a calibration data model. + + Type of calibration data item. Default: "camera" + Index of the affected item (depending on the selected ItemType). Default: 0 + The name of the inspected data. Default: "params" + Requested data. + + + + Define a calibration object in a calibration model. + Instance represents: Handle of a calibration data model. + + Calibration object index. Default: 0 + 3D point coordinates or a description file name. + + + + Define a calibration object in a calibration model. + Instance represents: Handle of a calibration data model. + + Calibration object index. Default: 0 + 3D point coordinates or a description file name. + + + + Set type and initial parameters of a camera in a calibration data model. + Instance represents: Handle of a calibration data model. + + Camera index. Default: 0 + Type of the camera. Default: [] + Initial camera internal parameters. + + + + Set type and initial parameters of a camera in a calibration data model. + Instance represents: Handle of a calibration data model. + + Camera index. Default: 0 + Type of the camera. Default: [] + Initial camera internal parameters. + + + + Create a HALCON calibration data model. + Modified instance represents: Handle of the created calibration data model. + + Type of the calibration setup. Default: "calibration_object" + Number of cameras in the calibration setup. Default: 1 + Number of calibration objects. Default: 1 + + + Represents an instance of a camera setup model. + + + + Restore a camera setup model from a file. + Modified instance represents: Handle to the camera setup model. + + The path and file name of the model file. + + + + Create a model for a setup of calibrated cameras. + Modified instance represents: Handle to the camera setup model. + + Number of cameras in the setup. Default: 2 + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + + Create a HALCON stereo model. + Instance represents: Handle to the camera setup model. + + Reconstruction method. Default: "surface_pairwise" + Name of the model parameter to be set. Default: [] + Value of the model parameter to be set. Default: [] + Handle of the stereo model. + + + + Create a HALCON stereo model. + Instance represents: Handle to the camera setup model. + + Reconstruction method. Default: "surface_pairwise" + Name of the model parameter to be set. Default: [] + Value of the model parameter to be set. Default: [] + Handle of the stereo model. + + + + Free the memory of a calibration setup model. + Instance represents: Handle of the camera setup model. + + + + + Serialize a camera setup model. + Instance represents: Handle to the camera setup model. + + Handle of the serialized item. + + + + Deserialize a serialized camera setup model. + Modified instance represents: Handle to the camera setup model. + + Handle of the serialized item. + + + + Store a camera setup model into a file. + Instance represents: Handle to the camera setup model. + + The file name of the model to be saved. + + + + Restore a camera setup model from a file. + Modified instance represents: Handle to the camera setup model. + + The path and file name of the model file. + + + + Get generic camera setup model parameters. + Instance represents: Handle to the camera setup model. + + Index of the camera in the setup. Default: 0 + Names of the generic parameters to be queried. + Values of the generic parameters to be queried. + + + + Get generic camera setup model parameters. + Instance represents: Handle to the camera setup model. + + Index of the camera in the setup. Default: 0 + Names of the generic parameters to be queried. + Values of the generic parameters to be queried. + + + + Set generic camera setup model parameters. + Instance represents: Handle to the camera setup model. + + Unique index of the camera in the setup. Default: 0 + Names of the generic parameters to be set. + Values of the generic parameters to be set. + + + + Set generic camera setup model parameters. + Instance represents: Handle to the camera setup model. + + Unique index of the camera in the setup. Default: 0 + Names of the generic parameters to be set. + Values of the generic parameters to be set. + + + + Define type, parameters, and relative pose of a camera in a camera setup model. + Instance represents: Handle to the camera setup model. + + Index of the camera in the setup. + Type of the camera. Default: [] + Internal camera parameters. + Pose of the camera relative to the setup's coordinate system. + + + + Define type, parameters, and relative pose of a camera in a camera setup model. + Instance represents: Handle to the camera setup model. + + Index of the camera in the setup. + Type of the camera. Default: [] + Internal camera parameters. + Pose of the camera relative to the setup's coordinate system. + + + + Create a model for a setup of calibrated cameras. + Modified instance represents: Handle to the camera setup model. + + Number of cameras in the setup. Default: 2 + + + Represents internal camera parameters. + + + + Provides access to the internally used tuple data + + + + + Provides access to the value at the specified index + + + + Create an uninitialized instance. + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + + Compute the distance values for a rectified stereo image pair using multi-scanline optimization. + Instance represents: Internal camera parameters of the rectified camera 1. + + Rectified image of camera 1. + Rectified image of camera 2. + Score of the calculated disparity. + Internal camera parameters of the rectified camera 2. + Point transformation from the rectified camera 2 to the rectified camera 1. + Minimum of the expected disparities. Default: -30 + Maximum of the expected disparities. Default: 30 + Smoothing of surfaces. Default: 50 + Smoothing of edges. Default: 50 + Parameter name(s) for the multi-scanline algorithm. Default: [] + Parameter value(s) for the multi-scanline algorithm. Default: [] + Distance image. + + + + Compute the distance values for a rectified stereo image pair using multi-scanline optimization. + Instance represents: Internal camera parameters of the rectified camera 1. + + Rectified image of camera 1. + Rectified image of camera 2. + Score of the calculated disparity. + Internal camera parameters of the rectified camera 2. + Point transformation from the rectified camera 2 to the rectified camera 1. + Minimum of the expected disparities. Default: -30 + Maximum of the expected disparities. Default: 30 + Smoothing of surfaces. Default: 50 + Smoothing of edges. Default: 50 + Parameter name(s) for the multi-scanline algorithm. Default: [] + Parameter value(s) for the multi-scanline algorithm. Default: [] + Distance image. + + + + Compute the distance values for a rectified stereo image pair using multigrid methods. + Instance represents: Internal camera parameters of the rectified camera 1. + + Rectified image of camera 1. + Rectified image of camera 2. + Score of the calculated disparity if CalculateScore is set to 'true'. + Internal camera parameters of the rectified camera 2. + Point transformation from the rectified camera 2 to the rectified camera 1. + Weight of the gray value constancy in the data term. Default: 1.0 + Weight of the gradient constancy in the data term. Default: 30.0 + Weight of the smoothness term in relation to the data term. Default: 5.0 + Initial guess of the disparity. Default: 0.0 + Should the quality measure be returned in Score? Default: "false" + Parameter name(s) for the multigrid algorithm. Default: "default_parameters" + Parameter value(s) for the multigrid algorithm. Default: "fast_accurate" + Distance image. + + + + Compute the distance values for a rectified stereo image pair using multigrid methods. + Instance represents: Internal camera parameters of the rectified camera 1. + + Rectified image of camera 1. + Rectified image of camera 2. + Score of the calculated disparity if CalculateScore is set to 'true'. + Internal camera parameters of the rectified camera 2. + Point transformation from the rectified camera 2 to the rectified camera 1. + Weight of the gray value constancy in the data term. Default: 1.0 + Weight of the gradient constancy in the data term. Default: 30.0 + Weight of the smoothness term in relation to the data term. Default: 5.0 + Initial guess of the disparity. Default: 0.0 + Should the quality measure be returned in Score? Default: "false" + Parameter name(s) for the multigrid algorithm. Default: "default_parameters" + Parameter value(s) for the multigrid algorithm. Default: "fast_accurate" + Distance image. + + + + Compute the fundamental matrix from the relative orientation of two cameras. + Instance represents: Parameters of the 1. camera. + + Relative orientation of the cameras (3D pose). + 6x6 covariance matrix of relative pose. Default: [] + Parameters of the 2. camera. + 9x9 covariance matrix of the fundamental matrix. + Computed fundamental matrix. + + + + Compute the relative orientation between two cameras given image point correspondences and known camera parameters and reconstruct 3D space points. + Instance represents: Camera parameters of the 1st camera. + + Input points in image 1 (row coordinate). + Input points in image 1 (column coordinate). + Input points in image 2 (row coordinate). + Input points in image 2 (column coordinate). + Row coordinate variance of the points in image 1. Default: [] + Covariance of the points in image 1. Default: [] + Column coordinate variance of the points in image 1. Default: [] + Row coordinate variance of the points in image 2. Default: [] + Covariance of the points in image 2. Default: [] + Column coordinate variance of the points in image 2. Default: [] + Camera parameters of the 2nd camera. + Algorithm for the computation of the relative pose and for special pose types. Default: "normalized_dlt" + 6x6 covariance matrix of the relative camera orientation. + Root-Mean-Square of the epipolar distance error. + X coordinates of the reconstructed 3D points. + Y coordinates of the reconstructed 3D points. + Z coordinates of the reconstructed 3D points. + Covariance matrices of the reconstructed 3D points. + Computed relative orientation of the cameras (3D pose). + + + + Compute the relative orientation between two cameras given image point correspondences and known camera parameters and reconstruct 3D space points. + Instance represents: Camera parameters of the 1st camera. + + Input points in image 1 (row coordinate). + Input points in image 1 (column coordinate). + Input points in image 2 (row coordinate). + Input points in image 2 (column coordinate). + Row coordinate variance of the points in image 1. Default: [] + Covariance of the points in image 1. Default: [] + Column coordinate variance of the points in image 1. Default: [] + Row coordinate variance of the points in image 2. Default: [] + Covariance of the points in image 2. Default: [] + Column coordinate variance of the points in image 2. Default: [] + Camera parameters of the 2nd camera. + Algorithm for the computation of the relative pose and for special pose types. Default: "normalized_dlt" + 6x6 covariance matrix of the relative camera orientation. + Root-Mean-Square of the epipolar distance error. + X coordinates of the reconstructed 3D points. + Y coordinates of the reconstructed 3D points. + Z coordinates of the reconstructed 3D points. + Covariance matrices of the reconstructed 3D points. + Computed relative orientation of the cameras (3D pose). + + + + Compute the relative orientation between two cameras by automatically finding correspondences between image points. + Instance represents: Parameters of the 1st camera. + + Input image 1. + Input image 2. + Row coordinates of characteristic points in image 1. + Column coordinates of characteristic points in image 1. + Row coordinates of characteristic points in image 2. + Column coordinates of characteristic points in image 2. + Parameters of the 2nd camera. + Gray value comparison metric. Default: "ssd" + Size of gray value masks. Default: 10 + Average row coordinate shift of corresponding points. Default: 0 + Average column coordinate shift of corresponding points. Default: 0 + Half height of matching search window. Default: 200 + Half width of matching search window. Default: 200 + Estimate of the relative orientation of the right image with respect to the left image. Default: 0.0 + Threshold for gray value matching. Default: 10 + Algorithm for the computation of the relative pose and for special pose types. Default: "normalized_dlt" + Maximal deviation of a point from its epipolar line. Default: 1 + Seed for the random number generator. Default: 0 + 6x6 covariance matrix of the relative orientation. + Root-Mean-Square of the epipolar distance error. + Indices of matched input points in image 1. + Indices of matched input points in image 2. + Computed relative orientation of the cameras (3D pose). + + + + Compute the relative orientation between two cameras by automatically finding correspondences between image points. + Instance represents: Parameters of the 1st camera. + + Input image 1. + Input image 2. + Row coordinates of characteristic points in image 1. + Column coordinates of characteristic points in image 1. + Row coordinates of characteristic points in image 2. + Column coordinates of characteristic points in image 2. + Parameters of the 2nd camera. + Gray value comparison metric. Default: "ssd" + Size of gray value masks. Default: 10 + Average row coordinate shift of corresponding points. Default: 0 + Average column coordinate shift of corresponding points. Default: 0 + Half height of matching search window. Default: 200 + Half width of matching search window. Default: 200 + Estimate of the relative orientation of the right image with respect to the left image. Default: 0.0 + Threshold for gray value matching. Default: 10 + Algorithm for the computation of the relative pose and for special pose types. Default: "normalized_dlt" + Maximal deviation of a point from its epipolar line. Default: 1 + Seed for the random number generator. Default: 0 + 6x6 covariance matrix of the relative orientation. + Root-Mean-Square of the epipolar distance error. + Indices of matched input points in image 1. + Indices of matched input points in image 2. + Computed relative orientation of the cameras (3D pose). + + + + Compute the distance values for a rectified stereo image pair using correlation techniques. + Instance represents: Internal camera parameters of the rectified camera 1. + + Rectified image of camera 1. + Rectified image of camera 2. + Evaluation of a distance value. + Internal camera parameters of the rectified camera 2. + Point transformation from the rectified camera 2 to the rectified camera 1. + Matching function. Default: "ncc" + Width of the correlation window. Default: 11 + Height of the correlation window. Default: 11 + Variance threshold of textured image regions. Default: 0.0 + Minimum of the expected disparities. Default: 0 + Maximum of the expected disparities. Default: 30 + Number of pyramid levels. Default: 1 + Threshold of the correlation function. Default: 0.0 + Downstream filters. Default: "none" + Distance interpolation. Default: "none" + Distance image. + + + + Compute the distance values for a rectified stereo image pair using correlation techniques. + Instance represents: Internal camera parameters of the rectified camera 1. + + Rectified image of camera 1. + Rectified image of camera 2. + Evaluation of a distance value. + Internal camera parameters of the rectified camera 2. + Point transformation from the rectified camera 2 to the rectified camera 1. + Matching function. Default: "ncc" + Width of the correlation window. Default: 11 + Height of the correlation window. Default: 11 + Variance threshold of textured image regions. Default: 0.0 + Minimum of the expected disparities. Default: 0 + Maximum of the expected disparities. Default: 30 + Number of pyramid levels. Default: 1 + Threshold of the correlation function. Default: 0.0 + Downstream filters. Default: "none" + Distance interpolation. Default: "none" + Distance image. + + + + Get a 3D point from the intersection of two lines of sight within a binocular camera system. + Instance represents: Internal parameters of the projective camera 1. + + Internal parameters of the projective camera 2. + Point transformation from camera 2 to camera 1. + Row coordinate of a point in image 1. + Column coordinate of a point in image 1. + Row coordinate of the corresponding point in image 2. + Column coordinate of the corresponding point in image 2. + X coordinate of the 3D point. + Y coordinate of the 3D point. + Z coordinate of the 3D point. + Distance of the 3D point to the lines of sight. + + + + Get a 3D point from the intersection of two lines of sight within a binocular camera system. + Instance represents: Internal parameters of the projective camera 1. + + Internal parameters of the projective camera 2. + Point transformation from camera 2 to camera 1. + Row coordinate of a point in image 1. + Column coordinate of a point in image 1. + Row coordinate of the corresponding point in image 2. + Column coordinate of the corresponding point in image 2. + X coordinate of the 3D point. + Y coordinate of the 3D point. + Z coordinate of the 3D point. + Distance of the 3D point to the lines of sight. + + + + Transform a disparity image into 3D points in a rectified stereo system. + Instance represents: Internal camera parameters of the rectified camera 1. + + Disparity image. + Y coordinates of the points in the rectified camera system 1. + Z coordinates of the points in the rectified camera system 1. + Internal camera parameters of the rectified camera 2. + Pose of the rectified camera 2 in relation to the rectified camera 1. + X coordinates of the points in the rectified camera system 1. + + + + Transform an image point and its disparity into a 3D point in a rectified stereo system. + Instance represents: Rectified internal camera parameters of camera 1. + + Rectified internal camera parameters of camera 2. + Pose of the rectified camera 2 in relation to the rectified camera 1. + Row coordinate of a point in the rectified image 1. + Column coordinate of a point in the rectified image 1. + Disparity of the images of the world point. + X coordinate of the 3D point. + Y coordinate of the 3D point. + Z coordinate of the 3D point. + + + + Transform an image point and its disparity into a 3D point in a rectified stereo system. + Instance represents: Rectified internal camera parameters of camera 1. + + Rectified internal camera parameters of camera 2. + Pose of the rectified camera 2 in relation to the rectified camera 1. + Row coordinate of a point in the rectified image 1. + Column coordinate of a point in the rectified image 1. + Disparity of the images of the world point. + X coordinate of the 3D point. + Y coordinate of the 3D point. + Z coordinate of the 3D point. + + + + Transform a disparity value into a distance value in a rectified binocular stereo system. + Instance represents: Rectified internal camera parameters of camera 1. + + Rectified internal camera parameters of camera 2. + Point transformation from the rectified camera 2 to the rectified camera 1. + Disparity between the images of the world point. + Distance of a world point to the rectified camera system. + + + + Transform a disparity value into a distance value in a rectified binocular stereo system. + Instance represents: Rectified internal camera parameters of camera 1. + + Rectified internal camera parameters of camera 2. + Point transformation from the rectified camera 2 to the rectified camera 1. + Disparity between the images of the world point. + Distance of a world point to the rectified camera system. + + + + Transfrom a distance value into a disparity in a rectified stereo system. + Instance represents: Rectified internal camera parameters of camera 1. + + Rectified internal camera parameters of camera 2. + Point transformation from the rectified camera 2 to the rectified camera 1. + Distance of a world point to camera 1. + Disparity between the images of the point. + + + + Transfrom a distance value into a disparity in a rectified stereo system. + Instance represents: Rectified internal camera parameters of camera 1. + + Rectified internal camera parameters of camera 2. + Point transformation from the rectified camera 2 to the rectified camera 1. + Distance of a world point to camera 1. + Disparity between the images of the point. + + + + Generate transformation maps that describe the mapping of the images of a binocular camera pair to a common rectified image plane. + Instance represents: Internal parameters of camera 1. + + Image containing the mapping data of camera 2. + Internal parameters of camera 2. + Point transformation from camera 2 to camera 1. + Subsampling factor. Default: 1.0 + Type of rectification. Default: "viewing_direction" + Type of mapping. Default: "bilinear" + Rectified internal parameters of camera 1. + Rectified internal parameters of camera 2. + Point transformation from the rectified camera 1 to the original camera 1. + Point transformation from the rectified camera 1 to the original camera 1. + Point transformation from the rectified camera 2 to the rectified camera 1. + Image containing the mapping data of camera 1. + + + + Determine all camera parameters of a binocular stereo system. + Instance represents: Initial values for the internal parameters of camera 1. + + Ordered Tuple with all X-coordinates of the calibration marks (in meters). + Ordered Tuple with all Y-coordinates of the calibration marks (in meters). + Ordered Tuple with all Z-coordinates of the calibration marks (in meters). + Ordered Tuple with all row-coordinates of the extracted calibration marks of camera 1 (in pixels). + Ordered Tuple with all column-coordinates of the extracted calibration marks of camera 1 (in pixels). + Ordered Tuple with all row-coordinates of the extracted calibration marks of camera 2 (in pixels). + Ordered Tuple with all column-coordinates of the extracted calibration marks of camera 2 (in pixels). + Initial values for the internal parameters of camera 2. + Ordered tuple with all initial values for the poses of the calibration model in relation to camera 1. + Ordered tuple with all initial values for the poses of the calibration model in relation to camera 2. + Camera parameters to be estimated. Default: "all" + Internal parameters of camera 2. + Ordered tuple with all poses of the calibration model in relation to camera 1. + Ordered tuple with all poses of the calibration model in relation to camera 2. + Pose of camera 2 in relation to camera 1. + Average error distances in pixels. + Internal parameters of camera 1. + + + + Determine all camera parameters of a binocular stereo system. + Instance represents: Initial values for the internal parameters of camera 1. + + Ordered Tuple with all X-coordinates of the calibration marks (in meters). + Ordered Tuple with all Y-coordinates of the calibration marks (in meters). + Ordered Tuple with all Z-coordinates of the calibration marks (in meters). + Ordered Tuple with all row-coordinates of the extracted calibration marks of camera 1 (in pixels). + Ordered Tuple with all column-coordinates of the extracted calibration marks of camera 1 (in pixels). + Ordered Tuple with all row-coordinates of the extracted calibration marks of camera 2 (in pixels). + Ordered Tuple with all column-coordinates of the extracted calibration marks of camera 2 (in pixels). + Initial values for the internal parameters of camera 2. + Ordered tuple with all initial values for the poses of the calibration model in relation to camera 1. + Ordered tuple with all initial values for the poses of the calibration model in relation to camera 2. + Camera parameters to be estimated. Default: "all" + Internal parameters of camera 2. + Ordered tuple with all poses of the calibration model in relation to camera 1. + Ordered tuple with all poses of the calibration model in relation to camera 2. + Pose of camera 2 in relation to camera 1. + Average error distances in pixels. + Internal parameters of camera 1. + + + + Find the best matches of a calibrated descriptor model in an image and return their 3D pose. + Instance represents: Camera parameter (inner orientation) obtained from camera calibration. + + Input image where the model should be found. + The handle to the descriptor model. + The detector's parameter names. Default: [] + Values of the detector's parameters. Default: [] + The descriptor's parameter names. Default: [] + Values of the descriptor's parameters. Default: [] + Minimum score of the instances of the models to be found. Default: 0.2 + Maximal number of found instances. Default: 1 + Score type to be evaluated in Score. Default: "num_points" + Score of the found instances according to the ScoreType input. + 3D pose of the object. + + + + Find the best matches of a calibrated descriptor model in an image and return their 3D pose. + Instance represents: Camera parameter (inner orientation) obtained from camera calibration. + + Input image where the model should be found. + The handle to the descriptor model. + The detector's parameter names. Default: [] + Values of the detector's parameters. Default: [] + The descriptor's parameter names. Default: [] + Values of the descriptor's parameters. Default: [] + Minimum score of the instances of the models to be found. Default: 0.2 + Maximal number of found instances. Default: 1 + Score type to be evaluated in Score. Default: "num_points" + Score of the found instances according to the ScoreType input. + 3D pose of the object. + + + + Create a descriptor model for calibrated perspective matching. + Instance represents: The parameters of the internal orientation of the camera. + + Input image whose domain will be used to create the model. + The reference pose of the object in the reference image. + The type of the detector. Default: "lepetit" + The detector's parameter names. Default: [] + Values of the detector's parameters. Default: [] + The descriptor's parameter names. Default: [] + Values of the descriptor's parameters. Default: [] + The seed for the random number generator. Default: 42 + The handle to the descriptor model. + + + + Prepare a deformable model for planar calibrated matching from XLD contours. + Instance represents: The parameters of the internal orientation of the camera. + + Input contours that will be used to create the model. + The reference pose of the object. + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in the column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "auto" + Match metric. Default: "ignore_local_polarity" + Minimum contrast of the objects in the search images. Default: 5 + The generic parameter names. Default: [] + Values of the generic parameter. Default: [] + Handle of the model. + + + + Prepare a deformable model for planar calibrated matching from XLD contours. + Instance represents: The parameters of the internal orientation of the camera. + + Input contours that will be used to create the model. + The reference pose of the object. + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in the column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "auto" + Match metric. Default: "ignore_local_polarity" + Minimum contrast of the objects in the search images. Default: 5 + The generic parameter names. Default: [] + Values of the generic parameter. Default: [] + Handle of the model. + + + + Create a deformable model for calibrated perspective matching. + Instance represents: The parameters of the internal orientation of the camera. + + Input image whose domain will be used to create the model. + The reference pose of the object in the reference image. + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in the column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "none" + Match metric. Default: "use_polarity" + Thresholds or hysteresis thresholds for the contrast of the object in the template image. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + The parameter names. Default: [] + Values of the parameters. Default: [] + Handle of the model. + + + + Create a deformable model for calibrated perspective matching. + Instance represents: The parameters of the internal orientation of the camera. + + Input image whose domain will be used to create the model. + The reference pose of the object in the reference image. + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in the column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "none" + Match metric. Default: "use_polarity" + Thresholds or hysteresis thresholds for the contrast of the object in the template image. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + The parameter names. Default: [] + Values of the parameters. Default: [] + Handle of the model. + + + + Project the edges of a 3D shape model into image coordinates. + Instance represents: Internal camera parameters. + + Handle of the 3D shape model. + 3D pose of the 3D shape model in the world coordinate system. + Remove hidden surfaces? Default: "true" + Smallest face angle for which the edge is displayed Default: 0.523599 + Contour representation of the model view. + + + + Project the edges of a 3D shape model into image coordinates. + Instance represents: Internal camera parameters. + + Handle of the 3D shape model. + 3D pose of the 3D shape model in the world coordinate system. + Remove hidden surfaces? Default: "true" + Smallest face angle for which the edge is displayed Default: 0.523599 + Contour representation of the model view. + + + + Prepare a 3D object model for matching. + Instance represents: Internal camera parameters. + + Handle of the 3D object model. + Reference orientation: Rotation around x-axis or x component of the Rodriguez vector (in radians or without unit). Default: 0 + Reference orientation: Rotation around y-axis or y component of the Rodriguez vector (in radians or without unit). Default: 0 + Reference orientation: Rotation around z-axis or z component of the Rodriguez vector (in radians or without unit). Default: 0 + Meaning of the rotation values of the reference orientation. Default: "gba" + Minimum longitude of the model views. Default: -0.35 + Maximum longitude of the model views. Default: 0.35 + Minimum latitude of the model views. Default: -0.35 + Maximum latitude of the model views. Default: 0.35 + Minimum camera roll angle of the model views. Default: -3.1416 + Maximum camera roll angle of the model views. Default: 3.1416 + Minimum camera-object-distance of the model views. Default: 0.3 + Maximum camera-object-distance of the model views. Default: 0.4 + Minimum contrast of the objects in the search images. Default: 10 + Names of (optional) parameters for controlling the behavior of the operator. Default: [] + Values of the optional generic parameters. Default: [] + Handle of the 3D shape model. + + + + Prepare a 3D object model for matching. + Instance represents: Internal camera parameters. + + Handle of the 3D object model. + Reference orientation: Rotation around x-axis or x component of the Rodriguez vector (in radians or without unit). Default: 0 + Reference orientation: Rotation around y-axis or y component of the Rodriguez vector (in radians or without unit). Default: 0 + Reference orientation: Rotation around z-axis or z component of the Rodriguez vector (in radians or without unit). Default: 0 + Meaning of the rotation values of the reference orientation. Default: "gba" + Minimum longitude of the model views. Default: -0.35 + Maximum longitude of the model views. Default: 0.35 + Minimum latitude of the model views. Default: -0.35 + Maximum latitude of the model views. Default: 0.35 + Minimum camera roll angle of the model views. Default: -3.1416 + Maximum camera roll angle of the model views. Default: 3.1416 + Minimum camera-object-distance of the model views. Default: 0.3 + Maximum camera-object-distance of the model views. Default: 0.4 + Minimum contrast of the objects in the search images. Default: 10 + Names of (optional) parameters for controlling the behavior of the operator. Default: [] + Values of the optional generic parameters. Default: [] + Handle of the 3D shape model. + + + + Remove points from a 3D object model by projecting it to a virtual view and removing all points outside of a given region. + Instance represents: Internal camera parameters. + + Region in the image plane. + Handle of the 3D object model. + 3D pose of the world coordinate system in camera coordinates. + Handle of the reduced 3D object model. + + + + Remove points from a 3D object model by projecting it to a virtual view and removing all points outside of a given region. + Instance represents: Internal camera parameters. + + Region in the image plane. + Handle of the 3D object model. + 3D pose of the world coordinate system in camera coordinates. + Handle of the reduced 3D object model. + + + + Render 3D object models to get an image. + Instance represents: Camera parameters of the scene. + + Handles of the 3D object models. + 3D poses of the objects. + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Rendered scene. + + + + Render 3D object models to get an image. + Instance represents: Camera parameters of the scene. + + Handles of the 3D object models. + 3D poses of the objects. + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Rendered scene. + + + + Display 3D object models. + Instance represents: Camera parameters of the scene. + + Window handle. + Handles of the 3D object models. + 3D poses of the objects. Default: [] + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + + + + Display 3D object models. + Instance represents: Camera parameters of the scene. + + Window handle. + Handles of the 3D object models. + 3D poses of the objects. Default: [] + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + + + + Transform 3D points from a 3D object model to images. + Instance represents: Camera parameters. + + Image with the Y-Coordinates of the 3D points. + Image with the Z-Coordinates of the 3D points. + Handle of the 3D object model. + Type of the conversion. Default: "cartesian" + Pose of the 3D object model. + Image with the X-Coordinates of the 3D points. + + + + Project a 3D object model into image coordinates. + Instance represents: Internal camera parameters. + + Handle of the 3D object model. + 3D pose of the world coordinate system in camera coordinates. + Name of the generic parameter. Default: [] + Value of the generic parameter. Default: [] + Projected model contours. + + + + Project a 3D object model into image coordinates. + Instance represents: Internal camera parameters. + + Handle of the 3D object model. + 3D pose of the world coordinate system in camera coordinates. + Name of the generic parameter. Default: [] + Value of the generic parameter. Default: [] + Projected model contours. + + + + Add a camera to a 3D scene. + Instance represents: Parameters of the new camera. + + Handle of the 3D scene. + Index of the new camera in the 3D scene. + + + + Compute the calibrated scene flow between two stereo image pairs. + Instance represents: Internal camera parameters of the rectified camera 1. + + Input image 1 at time @f$t_{1}$t_1. + Input image 2 at time @f$t_{1}$t_1. + Input image 1 at time @f$t_{2}$t_2. + Input image 2 at time @f$t_{2}$t_2. + Disparity between input images 1 and 2 at time @f$t_{1}$t_1. + Weight of the regularization term relative to the data term (derivatives of the optical flow). Default: 40.0 + Weight of the regularization term relative to the data term (derivatives of the disparity change). Default: 40.0 + Parameter name(s) for the algorithm. Default: "default_parameters" + Parameter value(s) for the algorithm. Default: "accurate" + Internal camera parameters of the rectified camera 2. + Pose of the rectified camera 2 in relation to the rectified camera 1. + Handle of the 3D object model. + + + + Compute the calibrated scene flow between two stereo image pairs. + Instance represents: Internal camera parameters of the rectified camera 1. + + Input image 1 at time @f$t_{1}$t_1. + Input image 2 at time @f$t_{1}$t_1. + Input image 1 at time @f$t_{2}$t_2. + Input image 2 at time @f$t_{2}$t_2. + Disparity between input images 1 and 2 at time @f$t_{1}$t_1. + Weight of the regularization term relative to the data term (derivatives of the optical flow). Default: 40.0 + Weight of the regularization term relative to the data term (derivatives of the disparity change). Default: 40.0 + Parameter name(s) for the algorithm. Default: "default_parameters" + Parameter value(s) for the algorithm. Default: "accurate" + Internal camera parameters of the rectified camera 2. + Pose of the rectified camera 2 in relation to the rectified camera 1. + Handle of the 3D object model. + + + + Compute an absolute pose out of point correspondences between world and image coordinates. + Instance represents: The inner camera parameters from camera calibration. + + X-Component of world coordinates. + Y-Component of world coordinates. + Z-Component of world coordinates. + Row-Component of image coordinates. + Column-Component of image coordinates. + Kind of algorithm Default: "iterative" + Type of pose quality to be returned in Quality. Default: "error" + Pose quality. + Pose. + + + + Compute an absolute pose out of point correspondences between world and image coordinates. + Instance represents: The inner camera parameters from camera calibration. + + X-Component of world coordinates. + Y-Component of world coordinates. + Z-Component of world coordinates. + Row-Component of image coordinates. + Column-Component of image coordinates. + Kind of algorithm Default: "iterative" + Type of pose quality to be returned in Quality. Default: "error" + Pose quality. + Pose. + + + + Calibrate the radial distortion. + Modified instance represents: Internal camera parameters. + + Contours that are available for the calibration. + Width of the images from which the contours were extracted. Default: 640 + Height of the images from which the contours were extracted. Default: 480 + Threshold for the classification of outliers. Default: 0.05 + Seed value for the random number generator. Default: 42 + Determines the distortion model. Default: "division" + Determines how the distortion center will be estimated. Default: "variable" + Controls the deviation of the distortion center from the image center; larger values allow larger deviations from the image center; 0 switches the penalty term off. Default: 0.0 + Contours that were used for the calibration + + + + Compute a camera matrix from internal camera parameters. + Instance represents: Internal camera parameters. + + Width of the images that correspond to CameraMatrix. + Height of the images that correspond to CameraMatrix. + 3x3 projective camera matrix that corresponds to CameraParam. + + + + Compute the internal camera parameters from a camera matrix. + Modified instance represents: Internal camera parameters. + + 3x3 projective camera matrix that determines the internal camera parameters. + Kappa. + Width of the images that correspond to CameraMatrix. + Height of the images that correspond to CameraMatrix. + + + + Determine the 3D pose of a rectangle from its perspective 2D projection + Instance represents: Internal camera parameters. + + Contour(s) to be examined. + Width of the rectangle in meters. + Height of the rectangle in meters. + Weighting mode for the optimization phase. Default: "nonweighted" + Clipping factor for the elimination of outliers (typical: 1.0 for 'huber' and 3.0 for 'tukey'). Default: 2.0 + Covariances of the pose values. + Root-mean-square value of the final residual error. + 3D pose of the rectangle. + + + + Determine the 3D pose of a rectangle from its perspective 2D projection + Instance represents: Internal camera parameters. + + Contour(s) to be examined. + Width of the rectangle in meters. + Height of the rectangle in meters. + Weighting mode for the optimization phase. Default: "nonweighted" + Clipping factor for the elimination of outliers (typical: 1.0 for 'huber' and 3.0 for 'tukey'). Default: 2.0 + Covariances of the pose values. + Root-mean-square value of the final residual error. + 3D pose of the rectangle. + + + + Determine the 3D pose of a circle from its perspective 2D projection. + Instance represents: Internal camera parameters. + + Contours to be examined. + Radius of the circle in object space. + Type of output parameters. Default: "pose" + 3D pose of the second circle. + 3D pose of the first circle. + + + + Determine the 3D pose of a circle from its perspective 2D projection. + Instance represents: Internal camera parameters. + + Contours to be examined. + Radius of the circle in object space. + Type of output parameters. Default: "pose" + 3D pose of the second circle. + 3D pose of the first circle. + + + + Generate a projection map that describes the mapping of images corresponding to a changing radial distortion. + Instance represents: Old camera parameters. + + New camera parameters. + Type of the mapping. Default: "bilinear" + Image containing the mapping data. + + + + Generate a projection map that describes the mapping between the image plane and a the plane z=0 of a world coordinate system. + Instance represents: Internal camera parameters. + + 3D pose of the world coordinate system in camera coordinates. + Width of the images to be transformed. + Height of the images to be transformed. + Width of the resulting mapped images in pixels. + Height of the resulting mapped images in pixels. + Scale or unit. Default: "m" + Type of the mapping. Default: "bilinear" + Image containing the mapping data. + + + + Generate a projection map that describes the mapping between the image plane and a the plane z=0 of a world coordinate system. + Instance represents: Internal camera parameters. + + 3D pose of the world coordinate system in camera coordinates. + Width of the images to be transformed. + Height of the images to be transformed. + Width of the resulting mapped images in pixels. + Height of the resulting mapped images in pixels. + Scale or unit. Default: "m" + Type of the mapping. Default: "bilinear" + Image containing the mapping data. + + + + Rectify an image by transforming it into the plane z=0 of a world coordinate system. + Instance represents: Internal camera parameters. + + Input image. + 3D pose of the world coordinate system in camera coordinates. + Width of the resulting image in pixels. + Height of the resulting image in pixels. + Scale or unit Default: "m" + Type of interpolation. Default: "bilinear" + Transformed image. + + + + Rectify an image by transforming it into the plane z=0 of a world coordinate system. + Instance represents: Internal camera parameters. + + Input image. + 3D pose of the world coordinate system in camera coordinates. + Width of the resulting image in pixels. + Height of the resulting image in pixels. + Scale or unit Default: "m" + Type of interpolation. Default: "bilinear" + Transformed image. + + + + Transform image points into the plane z=0 of a world coordinate system. + Instance represents: Internal camera parameters. + + 3D pose of the world coordinate system in camera coordinates. + Row coordinates of the points to be transformed. Default: 100.0 + Column coordinates of the points to be transformed. Default: 100.0 + Scale or dimension Default: "m" + X coordinates of the points in the world coordinate system. + Y coordinates of the points in the world coordinate system. + + + + Transform image points into the plane z=0 of a world coordinate system. + Instance represents: Internal camera parameters. + + 3D pose of the world coordinate system in camera coordinates. + Row coordinates of the points to be transformed. Default: 100.0 + Column coordinates of the points to be transformed. Default: 100.0 + Scale or dimension Default: "m" + X coordinates of the points in the world coordinate system. + Y coordinates of the points in the world coordinate system. + + + + Perform a hand-eye calibration. + Instance represents: Internal camera parameters. + + Linear list containing all the x coordinates of the calibration points (in the order of the images). + Linear list containing all the y coordinates of the calibration points (in the order of the images). + Linear list containing all the z coordinates of the calibration points (in the order of the images). + Linear list containing all row coordinates of the calibration points (in the order of the images). + Linear list containing all the column coordinates of the calibration points (in the order of the images). + Number of the calibration points for each image. + Known 3D pose of the robot for each image (moving camera: robot base in robot tool coordinates; stationary camera: robot tool in robot base coordinates). + Method of hand-eye calibration. Default: "nonlinear" + Type of quality assessment. Default: "error_pose" + Computed 3D pose of the calibration points in robot base coordinates (moving camera) or in robot tool coordinates (stationary camera), respectively. + Quality assessment of the result. + Computed relative camera pose: 3D pose of the robot tool (moving camera) or robot base (stationary camera), respectively, in camera coordinates. + + + + Perform a hand-eye calibration. + Instance represents: Internal camera parameters. + + Linear list containing all the x coordinates of the calibration points (in the order of the images). + Linear list containing all the y coordinates of the calibration points (in the order of the images). + Linear list containing all the z coordinates of the calibration points (in the order of the images). + Linear list containing all row coordinates of the calibration points (in the order of the images). + Linear list containing all the column coordinates of the calibration points (in the order of the images). + Number of the calibration points for each image. + Known 3D pose of the robot for each image (moving camera: robot base in robot tool coordinates; stationary camera: robot tool in robot base coordinates). + Method of hand-eye calibration. Default: "nonlinear" + Type of quality assessment. Default: "error_pose" + Computed 3D pose of the calibration points in robot base coordinates (moving camera) or in robot tool coordinates (stationary camera), respectively. + Quality assessment of the result. + Computed relative camera pose: 3D pose of the robot tool (moving camera) or robot base (stationary camera), respectively, in camera coordinates. + + + + Change the radial distortion of contours. + Instance represents: Internal camera parameter for Contours. + + Original contours. + Internal camera parameter for ContoursRectified. + Resulting contours with modified radial distortion. + + + + Change the radial distortion of pixel coordinates. + Instance represents: The inner camera parameters of the camera used to create the input pixel coordinates. + + Original row component of pixel coordinates. + Original column component of pixel coordinates. + The inner camera parameters of a camera. + Row component of pixel coordinates after changing the radial distortion. + Column component of pixel coordinates after changing the radial distortion. + + + + Change the radial distortion of an image. + Instance represents: Internal camera parameter for Image. + + Original image. + Region of interest in ImageRectified. + Internal camera parameter for Image. + Resulting image with modified radial distortion. + + + + Determine new camera parameters in accordance to the specified radial distortion. + Instance represents: Internal camera parameters (original). + + Mode Default: "adaptive" + Desired radial distortions. Default: 0.0 + Internal camera parameters (modified). + + + + Determine new camera parameters in accordance to the specified radial distortion. + Instance represents: Internal camera parameters (original). + + Mode Default: "adaptive" + Desired radial distortions. Default: 0.0 + Internal camera parameters (modified). + + + + Compute the line of sight corresponding to a point in the image. + Instance represents: Internal camera parameters. + + Row coordinate of the pixel. + Column coordinate of the pixel. + X coordinate of the first point on the line of sight in the camera coordinate system + Y coordinate of the first point on the line of sight in the camera coordinate system + Z coordinate of the first point on the line of sight in the camera coordinate system + X coordinate of the second point on the line of sight in the camera coordinate system + Y coordinate of the second point on the line of sight in the camera coordinate system + Z coordinate of the second point on the line of sight in the camera coordinate system + + + + Project 3D points into (sub-)pixel image coordinates. + Instance represents: Internal camera parameters. + + X coordinates of the 3D points to be projected in the camera coordinate system. + Y coordinates of the 3D points to be projected in the camera coordinate system. + Z coordinates of the 3D points to be projected in the camera coordinate system. + Row coordinates of the projected points (in pixels). + Column coordinates of the projected points (in pixels). + + + + Convert internal camera parameters and a 3D pose into a 3x4 projection matrix. + Instance represents: Internal camera parameters. + + 3D pose. + 3x4 projection matrix. + + + + Deserialize the serialized internal camera parameters. + Modified instance represents: Internal camera parameters. + + Handle of the serialized item. + + + + Serialize the internal camera parameters. + Instance represents: Internal camera parameters. + + Handle of the serialized item. + + + + Read internal camera parameters from a file. + Modified instance represents: Internal camera parameters. + + File name of internal camera parameters. Default: "campar.dat" + + + + Write internal camera parameters into a file. + Instance represents: Internal camera parameters. + + File name of internal camera parameters. Default: "campar.dat" + + + + Simulate an image with calibration plate. + Instance represents: Internal camera parameters. + + File name of the calibration plate description. Default: "calplate_320mm.cpd" + External camera parameters (3D pose of the calibration plate in camera coordinates). + Gray value of image background. Default: 128 + Gray value of calibration plate. Default: 80 + Gray value of calibration marks. Default: 224 + Scaling factor to reduce oversampling. Default: 1.0 + Simulated calibration image. + + + + Project and visualize the 3D model of the calibration plate in the image. + Instance represents: Internal camera parameters. + + Window in which the calibration plate should be visualized. + File name of the calibration plate description. Default: "calplate_320.cpd" + External camera parameters (3D pose of the calibration plate in camera coordinates). + Scaling factor for the visualization. Default: 1.0 + + + + Determine all camera parameters by a simultaneous minimization process. + Instance represents: Initial values for the internal camera parameters. + + Ordered tuple with all x coordinates of the calibration marks (in meters). + Ordered tuple with all y coordinates of the calibration marks (in meters). + Ordered tuple with all z coordinates of the calibration marks (in meters). + Ordered tuple with all row coordinates of the extracted calibration marks (in pixels). + Ordered tuple with all column coordinates of the extracted calibration marks (in pixels). + Ordered tuple with all initial values for the external camera parameters. + Camera parameters to be estimated. Default: "all" + Ordered tuple with all external camera parameters. + Average error distance in pixels. + Internal camera parameters. + + + + Determine all camera parameters by a simultaneous minimization process. + Instance represents: Initial values for the internal camera parameters. + + Ordered tuple with all x coordinates of the calibration marks (in meters). + Ordered tuple with all y coordinates of the calibration marks (in meters). + Ordered tuple with all z coordinates of the calibration marks (in meters). + Ordered tuple with all row coordinates of the extracted calibration marks (in pixels). + Ordered tuple with all column coordinates of the extracted calibration marks (in pixels). + Ordered tuple with all initial values for the external camera parameters. + Camera parameters to be estimated. Default: "all" + Ordered tuple with all external camera parameters. + Average error distance in pixels. + Internal camera parameters. + + + + Extract rectangularly arranged 2D calibration marks from the image and calculate initial values for the external camera parameters. + Instance represents: Initial values for the internal camera parameters. + + Input image. + Region of the calibration plate. + File name of the calibration plate description. Default: "caltab_100.descr" + Initial threshold value for contour detection. Default: 128 + Loop value for successive reduction of StartThresh. Default: 10 + Minimum threshold for contour detection. Default: 18 + Filter parameter for contour detection, see edges_image. Default: 0.9 + Minimum length of the contours of the marks. Default: 15.0 + Maximum expected diameter of the marks. Default: 100.0 + Tuple with column coordinates of the detected marks. + Estimation for the external camera parameters. + Tuple with row coordinates of the detected marks. + + + + Define type, parameters, and relative pose of a camera in a camera setup model. + Instance represents: Internal camera parameters. + + Handle to the camera setup model. + Index of the camera in the setup. + Type of the camera. Default: [] + Pose of the camera relative to the setup's coordinate system. + + + + Define type, parameters, and relative pose of a camera in a camera setup model. + Instance represents: Internal camera parameters. + + Handle to the camera setup model. + Index of the camera in the setup. + Type of the camera. Default: [] + Pose of the camera relative to the setup's coordinate system. + + + + Set type and initial parameters of a camera in a calibration data model. + Instance represents: Initial camera internal parameters. + + Handle of a calibration data model. + Camera index. Default: 0 + Type of the camera. Default: [] + + + + Set type and initial parameters of a camera in a calibration data model. + Instance represents: Initial camera internal parameters. + + Handle of a calibration data model. + Camera index. Default: 0 + Type of the camera. Default: [] + + + Represents an instance of a classifier. + + + + Create a new classifier. + Modified instance represents: Handle of the classifier. + + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + + Train a classificator using a multi-channel image. + Instance represents: Handle of the classifier. + + Foreground pixels to be trained. + Background pixels to be trained (rejection class). + Multi-channel training image. + + + + Classify pixels using hyper-cuboids. + Instance represents: Handle of the classifier. + + Multi channel input image. + Classification result. + + + + Deserialize a serialized classifier. + Instance represents: Handle of the classifier. + + Handle of the serialized item. + + + + Serialize a classifier. + Instance represents: Handle of the classifier. + + Handle of the serialized item. + + + + Save a classifier in a file. + Instance represents: Handle of the classifier. + + Name of the file which contains the written data. + + + + Set system parameters for classification. + Instance represents: Handle of the classifier. + + Name of the wanted parameter. Default: "split_error" + Value of the parameter. Default: 0.1 + + + + Set system parameters for classification. + Instance represents: Handle of the classifier. + + Name of the wanted parameter. Default: "split_error" + Value of the parameter. Default: 0.1 + + + + Read a classifier from a file. + Instance represents: Handle of the classifier. + + Filename of the classifier. + + + + Train the classifier with one data set. + Instance represents: Handle of the classifier. + + Number of the data set to train. + Name of the protocol file. Default: "training_prot" + Number of arrays of attributes to learn. Default: 500 + Classification error for termination. Default: 0.05 + Error during the assignment. Default: 100 + + + + Train the classifier. + Instance represents: Handle of the classifier. + + Array of attributes to learn. Default: [1.0,1.5,2.0] + Class to which the array has to be assigned. Default: 1 + + + + Get information about the current parameter. + Instance represents: Handle of the classifier. + + Name of the system parameter. Default: "split_error" + Value of the system parameter. + + + + Destroy the classifier. + Instance represents: Handle of the classifier. + + + + + Create a new classifier. + Modified instance represents: Handle of the classifier. + + + + + Describe the classes of a box classifier. + Instance represents: Handle of the classifier. + + Highest dimension for output. Default: 3 + Indices of the boxes. + Lower bounds of the boxes (for each dimension). + Higher bounds of the boxes (for each dimension). + Number of training samples that were used to define this box (for each dimension). + Number of training samples that were assigned incorrectly to the box. + Indices of the classes. + + + + Describe the classes of a box classifier. + Instance represents: Handle of the classifier. + + Highest dimension for output. Default: 3 + Indices of the boxes. + Lower bounds of the boxes (for each dimension). + Higher bounds of the boxes (for each dimension). + Number of training samples that were used to define this box (for each dimension). + Number of training samples that were assigned incorrectly to the box. + Indices of the classes. + + + + Classify a set of arrays. + Instance represents: Handle of the classifier. + + Key of the test data. + Error during the assignment. + + + + Classify a tuple of attributes with rejection class. + Instance represents: Handle of the classifier. + + Array of attributes which has to be classified. Default: 1.0 + Number of the class, to which the array of attributes had been assigned or -1 for the rejection class. + + + + Classify a tuple of attributes. + Instance represents: Handle of the classifier. + + Array of attributes which has to be classified. Default: 1.0 + Number of the class to which the array of attributes had been assigned. + + + Represents an instance of a Gaussian mixture model. + + + + Read a Gaussian Mixture Model from a file. + Modified instance represents: GMM handle. + + File name. + + + + Create a Gaussian Mixture Model for classification + Modified instance represents: GMM handle. + + Number of dimensions of the feature space. Default: 3 + Number of classes of the GMM. Default: 5 + Number of centers per class. Default: 1 + Type of the covariance matrices. Default: "spherical" + Type of preprocessing used to transform the feature vectors. Default: "normalization" + Preprocessing parameter: Number of transformed features (ignored for Preprocessing $=$ 'none' and Preprocessing $=$ 'normalization'). Default: 10 + Seed value of the random number generator that is used to initialize the GMM with random values. Default: 42 + + + + Create a Gaussian Mixture Model for classification + Modified instance represents: GMM handle. + + Number of dimensions of the feature space. Default: 3 + Number of classes of the GMM. Default: 5 + Number of centers per class. Default: 1 + Type of the covariance matrices. Default: "spherical" + Type of preprocessing used to transform the feature vectors. Default: "normalization" + Preprocessing parameter: Number of transformed features (ignored for Preprocessing $=$ 'none' and Preprocessing $=$ 'normalization'). Default: 10 + Seed value of the random number generator that is used to initialize the GMM with random values. Default: 42 + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + + Classify an image with a Gaussian Mixture Model. + Instance represents: GMM handle. + + Input image. + Threshold for the rejection of the classification. Default: 0.5 + Segmented classes. + + + + Add training samples from an image to the training data of a Gaussian Mixture Model. + Instance represents: GMM handle. + + Training image. + Regions of the classes to be trained. + Standard deviation of the Gaussian noise added to the training data. Default: 0.0 + + + + Get the training data of a Gaussian Mixture Model (GMM). + Instance represents: Handle of a GMM that contains training data. + + Handle of the training data of the classifier. + + + + Add training data to a Gaussian Mixture Model (GMM). + Instance represents: Handle of a GMM which receives the training data. + + Handle of training data for a classifier. + + + + Selects an optimal combination from a set of features to classify the provided data. + Modified instance represents: A trained GMM classifier using only the selected features. + + Handle of the training data. + Method to perform the selection. Default: "greedy" + Names of generic parameters to configure the classifier. Default: [] + Values of generic parameters to configure the classifier. Default: [] + The achieved score using two-fold cross-validation. + The selected feature set, contains indices or names. + + + + Selects an optimal combination from a set of features to classify the provided data. + Modified instance represents: A trained GMM classifier using only the selected features. + + Handle of the training data. + Method to perform the selection. Default: "greedy" + Names of generic parameters to configure the classifier. Default: [] + Values of generic parameters to configure the classifier. Default: [] + The achieved score using two-fold cross-validation. + The selected feature set, contains indices or names. + + + + Create a look-up table using a gaussian mixture model to classify byte images. + Instance represents: GMM handle. + + Names of the generic parameters that can be adjusted for the LUT classifier creation. Default: [] + Values of the generic parameters that can be adjusted for the LUT classifier creation. Default: [] + Handle of the LUT classifier. + + + Clear a Gaussian Mixture Model. + GMM handle. + + + + Clear a Gaussian Mixture Model. + Instance represents: GMM handle. + + + + Clear the training data of a Gaussian Mixture Model. + GMM handle. + + + + Clear the training data of a Gaussian Mixture Model. + Instance represents: GMM handle. + + + + + Deserialize a serialized Gaussian Mixture Model. + Modified instance represents: GMM handle. + + Handle of the serialized item. + + + + Serialize a Gaussian Mixture Model (GMM). + Instance represents: GMM handle. + + Handle of the serialized item. + + + + Read a Gaussian Mixture Model from a file. + Modified instance represents: GMM handle. + + File name. + + + + Write a Gaussian Mixture Model to a file. + Instance represents: GMM handle. + + File name. + + + + Read the training data of a Gaussian Mixture Model from a file. + Instance represents: GMM handle. + + File name. + + + + Write the training data of a Gaussian Mixture Model to a file. + Instance represents: GMM handle. + + File name. + + + + Calculate the class of a feature vector by a Gaussian Mixture Model. + Instance represents: GMM handle. + + Feature vector. + Number of best classes to determine. Default: 1 + A-posteriori probability of the classes. + Probability density of the feature vector. + Normalized k-sigma-probability for the feature vector. + Result of classifying the feature vector with the GMM. + + + + Evaluate a feature vector by a Gaussian Mixture Model. + Instance represents: GMM handle. + + Feature vector. + Probability density of the feature vector. + Normalized k-sigma-probability for the feature vector. + A-posteriori probability of the classes. + + + + Train a Gaussian Mixture Model. + Instance represents: GMM handle. + + Maximum number of iterations of the expectation maximization algorithm Default: 100 + Threshold for relative change of the error for the expectation maximization algorithm to terminate. Default: 0.001 + Mode to determine the a-priori probabilities of the classes Default: "training" + Regularization value for preventing covariance matrix singularity. Default: 0.0001 + Number of executed iterations per class + Number of found centers per class + + + + Compute the information content of the preprocessed feature vectors of a GMM. + Instance represents: GMM handle. + + Type of preprocessing used to transform the feature vectors. Default: "principal_components" + Cumulative information content of the transformed feature vectors. + Relative information content of the transformed feature vectors. + + + + Return the number of training samples stored in the training data of a Gaussian Mixture Model (GMM). + Instance represents: GMM handle. + + Number of stored training samples. + + + + Return a training sample from the training data of a Gaussian Mixture Models (GMM). + Instance represents: GMM handle. + + Index of the stored training sample. + Class of the training sample. + Feature vector of the training sample. + + + + Add a training sample to the training data of a Gaussian Mixture Model. + Instance represents: GMM handle. + + Feature vector of the training sample to be stored. + Class of the training sample to be stored. + Standard deviation of the Gaussian noise added to the training data. Default: 0.0 + + + + Return the parameters of a Gaussian Mixture Model. + Instance represents: GMM handle. + + Number of classes of the GMM. + Minimum number of centers per GMM class. + Maximum number of centers per GMM class. + Type of the covariance matrices. + Number of dimensions of the feature space. + + + + Create a Gaussian Mixture Model for classification + Modified instance represents: GMM handle. + + Number of dimensions of the feature space. Default: 3 + Number of classes of the GMM. Default: 5 + Number of centers per class. Default: 1 + Type of the covariance matrices. Default: "spherical" + Type of preprocessing used to transform the feature vectors. Default: "normalization" + Preprocessing parameter: Number of transformed features (ignored for Preprocessing $=$ 'none' and Preprocessing $=$ 'normalization'). Default: 10 + Seed value of the random number generator that is used to initialize the GMM with random values. Default: 42 + + + + Create a Gaussian Mixture Model for classification + Modified instance represents: GMM handle. + + Number of dimensions of the feature space. Default: 3 + Number of classes of the GMM. Default: 5 + Number of centers per class. Default: 1 + Type of the covariance matrices. Default: "spherical" + Type of preprocessing used to transform the feature vectors. Default: "normalization" + Preprocessing parameter: Number of transformed features (ignored for Preprocessing $=$ 'none' and Preprocessing $=$ 'normalization'). Default: 10 + Seed value of the random number generator that is used to initialize the GMM with random values. Default: 42 + + + Represents an instance of a k-NearestNeighbor classifier. + + + + Read the k-NN classifier from a file. + Modified instance represents: Handle of the k-NN classifier. + + File name of the classifier. + + + + Create a k-nearest neighbors (k-NN) classifier. + Modified instance represents: Handle of the k-NN classifier. + + Number of dimensions of the feature. Default: 10 + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + + Classify an image with a k-Nearest-Neighbor classifier. + Instance represents: Handle of the k-NN classifier. + + Input image. + Distance of the pixel's nearest neighbor. + Threshold for the rejection of the classification. Default: 0.5 + Segmented classes. + + + + Add training samples from an image to the training data of a k-Nearest-Neighbor classifier. + Instance represents: Handle of the k-NN classifier. + + Training image. + Regions of the classes to be trained. + + + + Get the training data of a k-nearest neighbors (k-NN) classifier. + Instance represents: Handle of the k-NN classifier that contains training data. + + Handle of the training data of the classifier. + + + + Add training data to a k-nearest neighbors (k-NN) classifier. + Instance represents: Handle of a k-NN which receives the training data. + + Training data for a classifier. + + + + Selects an optimal subset from a set of features to solve a certain classification problem. + Modified instance represents: A trained k-NN classifier using only the selected features. + + Handle of the training data. + Method to perform the selection. Default: "greedy" + Names of generic parameters to configure the selection process and the classifier. Default: [] + Values of generic parameters to configure the selection process and the classifier. Default: [] + The achieved score using two-fold cross-validation. + The selected feature set, contains indices or names. + + + + Selects an optimal subset from a set of features to solve a certain classification problem. + Modified instance represents: A trained k-NN classifier using only the selected features. + + Handle of the training data. + Method to perform the selection. Default: "greedy" + Names of generic parameters to configure the selection process and the classifier. Default: [] + Values of generic parameters to configure the selection process and the classifier. Default: [] + The achieved score using two-fold cross-validation. + The selected feature set, contains indices or names. + + + + Clear a k-NN classifier. + Instance represents: Handle of the k-NN classifier. + + + + + Return the number of training samples stored in the training data of a k-nearest neighbors (k-NN) classifier. + Instance represents: Handle of the k-NN classifier. + + Number of stored training samples. + + + + Return a training sample from the training data of a k-nearest neighbors (k-NN) classifier. + Instance represents: Handle of the k-NN classifier. + + Index of the training sample. + Class of the training sample. + Feature vector of the training sample. + + + + Deserialize a serialized k-NN classifier. + Modified instance represents: Handle of the k-NN classifier. + + Handle of the serialized item. + + + + Serialize a k-NN classifier. + Instance represents: Handle of the k-NN classifier. + + Handle of the serialized item. + + + + Read the k-NN classifier from a file. + Modified instance represents: Handle of the k-NN classifier. + + File name of the classifier. + + + + Save the k-NN classifier in a file. + Instance represents: Handle of the k-NN classifier. + + Name of the file in which the classifier will be written. + + + + Get parameters of a k-NN classification. + Instance represents: Handle of the k-NN classifier. + + Names of the parameters that can be read from the k-NN classifier. Default: ["method","k"] + Values of the selected parameters. + + + + Set parameters for k-NN classification. + Instance represents: Handle of the k-NN classifier. + + Names of the generic parameters that can be adjusted for the k-NN classifier. Default: ["method","k","max_num_classes"] + Values of the generic parameters that can be adjusted for the k-NN classifier. Default: ["classes_distance",5,1] + + + + Search for the next neighbors for a given feature vector. + Instance represents: Handle of the k-NN classifier. + + Features that should be classified. + A rating for the results. This value contains either a distance, a frequency or a weighted frequency. + The classification result, either class IDs or sample indices. + + + + Creates the search trees for a k-NN classifier. + Instance represents: Handle of the k-NN classifier. + + Names of the generic parameters that can be adjusted for the k-NN classifier creation. Default: [] + Values of the generic parameters that can be adjusted for the k-NN classifier creation. Default: [] + + + + Add a sample to a k-nearest neighbors (k-NN) classifier. + Instance represents: Handle of the k-NN classifier. + + List of features to add. + Class IDs of the features. + + + + Add a sample to a k-nearest neighbors (k-NN) classifier. + Instance represents: Handle of the k-NN classifier. + + List of features to add. + Class IDs of the features. + + + + Create a k-nearest neighbors (k-NN) classifier. + Modified instance represents: Handle of the k-NN classifier. + + Number of dimensions of the feature. Default: 10 + + + + Create a look-up table using a k-nearest neighbors classifier (k-NN) to classify byte images. + Instance represents: Handle of the k-NN classifier. + + Names of the generic parameters that can be adjusted for the LUT classifier creation. Default: [] + Values of the generic parameters that can be adjusted for the LUT classifier creation. Default: [] + Handle of the LUT classifier. + + + Represents an instance of a classification lookup table + + + + Create a look-up table using a k-nearest neighbors classifier (k-NN) to classify byte images. + Modified instance represents: Handle of the LUT classifier. + + Handle of the k-NN classifier. + Names of the generic parameters that can be adjusted for the LUT classifier creation. Default: [] + Values of the generic parameters that can be adjusted for the LUT classifier creation. Default: [] + + + + Create a look-up table using a gaussian mixture model to classify byte images. + Modified instance represents: Handle of the LUT classifier. + + GMM handle. + Names of the generic parameters that can be adjusted for the LUT classifier creation. Default: [] + Values of the generic parameters that can be adjusted for the LUT classifier creation. Default: [] + + + + Create a look-up table using a Support-Vector-Machine to classify byte images. + Modified instance represents: Handle of the LUT classifier. + + SVM handle. + Names of the generic parameters that can be adjusted for the LUT classifier creation. Default: [] + Values of the generic parameters that can be adjusted for the LUT classifier creation. Default: [] + + + + Create a look-up table using a multi-layer perceptron to classify byte images. + Modified instance represents: Handle of the LUT classifier. + + MLP handle. + Names of the generic parameters that can be adjusted for the LUT classifier creation. Default: [] + Values of the generic parameters that can be adjusted for the LUT classifier creation. Default: [] + + + + Classify a byte image using a look-up table. + Instance represents: Handle of the LUT classifier. + + Input image. + Segmented classes. + + + Clear a look-up table classifier. + Handle of the LUT classifier. + + + + Clear a look-up table classifier. + Instance represents: Handle of the LUT classifier. + + + + + Create a look-up table using a k-nearest neighbors classifier (k-NN) to classify byte images. + Modified instance represents: Handle of the LUT classifier. + + Handle of the k-NN classifier. + Names of the generic parameters that can be adjusted for the LUT classifier creation. Default: [] + Values of the generic parameters that can be adjusted for the LUT classifier creation. Default: [] + + + + Create a look-up table using a gaussian mixture model to classify byte images. + Modified instance represents: Handle of the LUT classifier. + + GMM handle. + Names of the generic parameters that can be adjusted for the LUT classifier creation. Default: [] + Values of the generic parameters that can be adjusted for the LUT classifier creation. Default: [] + + + + Create a look-up table using a Support-Vector-Machine to classify byte images. + Modified instance represents: Handle of the LUT classifier. + + SVM handle. + Names of the generic parameters that can be adjusted for the LUT classifier creation. Default: [] + Values of the generic parameters that can be adjusted for the LUT classifier creation. Default: [] + + + + Create a look-up table using a multi-layer perceptron to classify byte images. + Modified instance represents: Handle of the LUT classifier. + + MLP handle. + Names of the generic parameters that can be adjusted for the LUT classifier creation. Default: [] + Values of the generic parameters that can be adjusted for the LUT classifier creation. Default: [] + + + Represents an instance of a multilayer perceptron. + + + + Read a multilayer perceptron from a file. + Modified instance represents: MLP handle. + + File name. + + + + Create a multilayer perceptron for classification or regression. + Modified instance represents: MLP handle. + + Number of input variables (features) of the MLP. Default: 20 + Number of hidden units of the MLP. Default: 10 + Number of output variables (classes) of the MLP. Default: 5 + Type of the activation function in the output layer of the MLP. Default: "softmax" + Type of preprocessing used to transform the feature vectors. Default: "normalization" + Preprocessing parameter: Number of transformed features (ignored for Preprocessing $=$ 'none' and Preprocessing $=$ 'normalization'). Default: 10 + Seed value of the random number generator that is used to initialize the MLP with random values. Default: 42 + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + + Classify an image with a multilayer perceptron. + Instance represents: MLP handle. + + Input image. + Threshold for the rejection of the classification. Default: 0.5 + Segmented classes. + + + + Add training samples from an image to the training data of a multilayer perceptron. + Instance represents: MLP handle. + + Training image. + Regions of the classes to be trained. + + + + Get the training data of a multilayer perceptron (MLP). + Instance represents: Handle of a MLP that contains training data. + + Handle of the training data of the classifier. + + + + Add training data to a multilayer perceptron (MLP). + Instance represents: MLP handle which receives the training data. + + Training data for a classifier. + + + + Selects an optimal combination of features to classify the provided data. + Modified instance represents: A trained MLP classifier using only the selected features. + + Handle of the training data. + Method to perform the selection. Default: "greedy" + Names of generic parameters to configure the selection process and the classifier. Default: [] + Values of generic parameters to configure the selection process and the classifier. Default: [] + The achieved score using two-fold cross-validation. + The selected feature set, contains indices referring. + + + + Selects an optimal combination of features to classify the provided data. + Modified instance represents: A trained MLP classifier using only the selected features. + + Handle of the training data. + Method to perform the selection. Default: "greedy" + Names of generic parameters to configure the selection process and the classifier. Default: [] + Values of generic parameters to configure the selection process and the classifier. Default: [] + The achieved score using two-fold cross-validation. + The selected feature set, contains indices referring. + + + + Create a look-up table using a multi-layer perceptron to classify byte images. + Instance represents: MLP handle. + + Names of the generic parameters that can be adjusted for the LUT classifier creation. Default: [] + Values of the generic parameters that can be adjusted for the LUT classifier creation. Default: [] + Handle of the LUT classifier. + + + Clear a multilayer perceptron. + MLP handle. + + + + Clear a multilayer perceptron. + Instance represents: MLP handle. + + + + Clear the training data of a multilayer perceptron. + MLP handle. + + + + Clear the training data of a multilayer perceptron. + Instance represents: MLP handle. + + + + + Deserialize a serialized multilayer perceptron. + Modified instance represents: MLP handle. + + Handle of the serialized item. + + + + Serialize a multilayer perceptron (MLP). + Instance represents: MLP handle. + + Handle of the serialized item. + + + + Read a multilayer perceptron from a file. + Modified instance represents: MLP handle. + + File name. + + + + Write a multilayer perceptron to a file. + Instance represents: MLP handle. + + File name. + + + + Read the training data of a multilayer perceptron from a file. + Instance represents: MLP handle. + + File name. + + + + Write the training data of a multilayer perceptron to a file. + Instance represents: MLP handle. + + File name. + + + + Calculate the class of a feature vector by a multilayer perceptron. + Instance represents: MLP handle. + + Feature vector. + Number of best classes to determine. Default: 1 + Confidence(s) of the class(es) of the feature vector. + Result of classifying the feature vector with the MLP. + + + + Calculate the class of a feature vector by a multilayer perceptron. + Instance represents: MLP handle. + + Feature vector. + Number of best classes to determine. Default: 1 + Confidence(s) of the class(es) of the feature vector. + Result of classifying the feature vector with the MLP. + + + + Calculate the evaluation of a feature vector by a multilayer perceptron. + Instance represents: MLP handle. + + Feature vector. + Result of evaluating the feature vector with the MLP. + + + + Train a multilayer perceptron. + Instance represents: MLP handle. + + Maximum number of iterations of the optimization algorithm. Default: 200 + Threshold for the difference of the weights of the MLP between two iterations of the optimization algorithm. Default: 1.0 + Threshold for the difference of the mean error of the MLP on the training data between two iterations of the optimization algorithm. Default: 0.01 + Mean error of the MLP on the training data as a function of the number of iterations of the optimization algorithm. + Mean error of the MLP on the training data. + + + + Compute the information content of the preprocessed feature vectors of a multilayer perceptron. + Instance represents: MLP handle. + + Type of preprocessing used to transform the feature vectors. Default: "principal_components" + Cumulative information content of the transformed feature vectors. + Relative information content of the transformed feature vectors. + + + + Return the number of training samples stored in the training data of a multilayer perceptron. + Instance represents: MLP handle. + + Number of stored training samples. + + + + Return a training sample from the training data of a multilayer perceptron. + Instance represents: MLP handle. + + Number of stored training sample. + Target vector of the training sample. + Feature vector of the training sample. + + + + Get the parameters of a rejection class. + Instance represents: MLP handle. + + Names of the generic parameters to return. Default: "sampling_strategy" + Values of the generic parameters. + + + + Get the parameters of a rejection class. + Instance represents: MLP handle. + + Names of the generic parameters to return. Default: "sampling_strategy" + Values of the generic parameters. + + + + Set the parameters of a rejection class. + Instance represents: MLP handle. + + Names of the generic parameters. Default: "sampling_strategy" + Values of the generic parameters. Default: "hyperbox_around_all_classes" + + + + Set the parameters of a rejection class. + Instance represents: MLP handle. + + Names of the generic parameters. Default: "sampling_strategy" + Values of the generic parameters. Default: "hyperbox_around_all_classes" + + + + Add a training sample to the training data of a multilayer perceptron. + Instance represents: MLP handle. + + Feature vector of the training sample to be stored. + Class or target vector of the training sample to be stored. + + + + Add a training sample to the training data of a multilayer perceptron. + Instance represents: MLP handle. + + Feature vector of the training sample to be stored. + Class or target vector of the training sample to be stored. + + + + Return the regularization parameters of a multilayer perceptron. + Instance represents: MLP handle. + + Name of the regularization parameter to return. Default: "weight_prior" + Value of the regularization parameter. + + + + Set the regularization parameters of a multilayer perceptron. + Instance represents: MLP handle. + + Name of the regularization parameter to set. Default: "weight_prior" + Value of the regularization parameter. Default: 1.0 + + + + Set the regularization parameters of a multilayer perceptron. + Instance represents: MLP handle. + + Name of the regularization parameter to set. Default: "weight_prior" + Value of the regularization parameter. Default: 1.0 + + + + Return the parameters of a multilayer perceptron. + Instance represents: MLP handle. + + Number of hidden units of the MLP. + Number of output variables (classes) of the MLP. + Type of the activation function in the output layer of the MLP. + Type of preprocessing used to transform the feature vectors. + Preprocessing parameter: Number of transformed features. + Number of input variables (features) of the MLP. + + + + Create a multilayer perceptron for classification or regression. + Modified instance represents: MLP handle. + + Number of input variables (features) of the MLP. Default: 20 + Number of hidden units of the MLP. Default: 10 + Number of output variables (classes) of the MLP. Default: 5 + Type of the activation function in the output layer of the MLP. Default: "softmax" + Type of preprocessing used to transform the feature vectors. Default: "normalization" + Preprocessing parameter: Number of transformed features (ignored for Preprocessing $=$ 'none' and Preprocessing $=$ 'normalization'). Default: 10 + Seed value of the random number generator that is used to initialize the MLP with random values. Default: 42 + + + Represents an instance of a support vector machine. + + + + Read a support vector machine from a file. + Modified instance represents: SVM handle. + + File name. + + + + Create a support vector machine for pattern classification. + Modified instance represents: SVM handle. + + Number of input variables (features) of the SVM. Default: 10 + The kernel type. Default: "rbf" + Additional parameter for the kernel function. In case of RBF kernel the value for gamma@f$ Default: 0.02 + Regularisation constant of the SVM. Default: 0.05 + Number of classes. Default: 5 + The mode of the SVM. Default: "one-versus-one" + Type of preprocessing used to transform the feature vectors. Default: "normalization" + Preprocessing parameter: Number of transformed features (ignored for Preprocessing $=$ 'none' and Preprocessing $=$ 'normalization'). Default: 10 + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + + Classify an image with a support vector machine. + Instance represents: SVM handle. + + Input image. + Segmented classes. + + + + Add training samples from an image to the training data of a support vector machine. + Instance represents: SVM handle. + + Training image. + Regions of the classes to be trained. + + + + Get the training data of a support vector machine (SVM). + Instance represents: Handle of a SVM that contains training data. + + Handle of the training data of the classifier. + + + + Add training data to a support vector machine (SVM). + Instance represents: Handle of a SVM which receives the training data. + + Training data for a classifier. + + + + Selects an optimal combination of features to classify the provided data. + Modified instance represents: A trained SVM classifier using only the selected features. + + Handle of the training data. + Method to perform the selection. Default: "greedy" + Names of generic parameters to configure the selection process and the classifier. Default: [] + Values of generic parameters to configure the selection process and the classifier. Default: [] + The achieved score using two-fold cross-validation. + The selected feature set, contains indices. + + + + Selects an optimal combination of features to classify the provided data. + Modified instance represents: A trained SVM classifier using only the selected features. + + Handle of the training data. + Method to perform the selection. Default: "greedy" + Names of generic parameters to configure the selection process and the classifier. Default: [] + Values of generic parameters to configure the selection process and the classifier. Default: [] + The achieved score using two-fold cross-validation. + The selected feature set, contains indices. + + + + Create a look-up table using a Support-Vector-Machine to classify byte images. + Instance represents: SVM handle. + + Names of the generic parameters that can be adjusted for the LUT classifier creation. Default: [] + Values of the generic parameters that can be adjusted for the LUT classifier creation. Default: [] + Handle of the LUT classifier. + + + Clear a support vector machine. + SVM handle. + + + + Clear a support vector machine. + Instance represents: SVM handle. + + + + Clear the training data of a support vector machine. + SVM handle. + + + + Clear the training data of a support vector machine. + Instance represents: SVM handle. + + + + + Deserialize a serialized support vector machine (SVM). + Modified instance represents: SVM handle. + + Handle of the serialized item. + + + + Serialize a support vector machine (SVM). + Instance represents: SVM handle. + + Handle of the serialized item. + + + + Read a support vector machine from a file. + Modified instance represents: SVM handle. + + File name. + + + + Write a support vector machine to a file. + Instance represents: SVM handle. + + File name. + + + + Read the training data of a support vector machine from a file. + Instance represents: SVM handle. + + File name. + + + + Write the training data of a support vector machine to a file. + Instance represents: SVM handle. + + File name. + + + + Evaluate a feature vector by a support vector machine. + Instance represents: SVM handle. + + Feature vector. + Result of evaluating the feature vector with the SVM. + + + + Classify a feature vector by a support vector machine. + Instance represents: SVM handle. + + Feature vector. + Number of best classes to determine. Default: 1 + Result of classifying the feature vector with the SVM. + + + + Approximate a trained support vector machine by a reduced support vector machine for faster classification. + Instance represents: Original SVM handle. + + Type of postprocessing to reduce number of SV. Default: "bottom_up" + Minimum number of remaining SVs. Default: 2 + Maximum allowed error of reduction. Default: 0.001 + SVMHandle of reduced SVM. + + + + Train a support vector machine. + Instance represents: SVM handle. + + Stop parameter for training. Default: 0.001 + Mode of training. For normal operation: 'default'. If SVs already included in the SVM should be used for training: 'add_sv_to_train_set'. For alpha seeding: the respective SVM handle. Default: "default" + + + + Train a support vector machine. + Instance represents: SVM handle. + + Stop parameter for training. Default: 0.001 + Mode of training. For normal operation: 'default'. If SVs already included in the SVM should be used for training: 'add_sv_to_train_set'. For alpha seeding: the respective SVM handle. Default: "default" + + + + Compute the information content of the preprocessed feature vectors of a support vector machine + Instance represents: SVM handle. + + Type of preprocessing used to transform the feature vectors. Default: "principal_components" + Cumulative information content of the transformed feature vectors. + Relative information content of the transformed feature vectors. + + + + Return the number of support vectors of a support vector machine. + Instance represents: SVM handle. + + Number of SV of each sub-SVM. + Total number of support vectors. + + + + Return the index of a support vector from a trained support vector machine. + Instance represents: SVM handle. + + Index of the stored support vector. + Index of the support vector in the training set. + + + + Return the number of training samples stored in the training data of a support vector machine. + Instance represents: SVM handle. + + Number of stored training samples. + + + + Return a training sample from the training data of a support vector machine. + Instance represents: SVM handle. + + Number of the stored training sample. + Target vector of the training sample. + Feature vector of the training sample. + + + + Add a training sample to the training data of a support vector machine. + Instance represents: SVM handle. + + Feature vector of the training sample to be stored. + Class of the training sample to be stored. + + + + Add a training sample to the training data of a support vector machine. + Instance represents: SVM handle. + + Feature vector of the training sample to be stored. + Class of the training sample to be stored. + + + + Return the parameters of a support vector machine. + Instance represents: SVM handle. + + The kernel type. + Additional parameter for the kernel. + Regularization constant of the SVM. + Number of classes of the test data. + The mode of the SVM. + Type of preprocessing used to transform the feature vectors. + Preprocessing parameter: Number of transformed features (ignored for Preprocessing $=$ 'none' and Preprocessing $=$ 'normalization'). + Number of input variables (features) of the SVM. + + + + Create a support vector machine for pattern classification. + Modified instance represents: SVM handle. + + Number of input variables (features) of the SVM. Default: 10 + The kernel type. Default: "rbf" + Additional parameter for the kernel function. In case of RBF kernel the value for gamma@f$ Default: 0.02 + Regularisation constant of the SVM. Default: 0.05 + Number of classes. Default: 5 + The mode of the SVM. Default: "one-versus-one" + Type of preprocessing used to transform the feature vectors. Default: "normalization" + Preprocessing parameter: Number of transformed features (ignored for Preprocessing $=$ 'none' and Preprocessing $=$ 'normalization'). Default: 10 + + + Represents an instance of a training data management class. + + + + Read the training data for classifiers from a file. + Modified instance represents: Handle of the training data. + + File name of the training data. + + + + Create a handle for training data for classifiers. + Modified instance represents: Handle of the training data. + + Number of dimensions of the feature vector. Default: 10 + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + + Deserialize serialized training data for classifiers. + Modified instance represents: Handle of the training data. + + Handle of the serialized item. + + + + Serialize training data for classifiers. + Instance represents: Handle of the training data. + + Handle of the serialized item. + + + + Read the training data for classifiers from a file. + Modified instance represents: Handle of the training data. + + File name of the training data. + + + + Save the training data for classifiers in a file. + Instance represents: Handle of the training data. + + Name of the file in which the training data will be written. + + + + Select certain features from training data to create training data containing less features. + Instance represents: Handle of the training data. + + Indices or names to select the subfeatures or columns. + Handle of the reduced training data. + + + + Define subfeatures in training data. + Instance represents: Handle of the training data that should be partitioned into subfeatures. + + Length of the subfeatures. + Names of the subfeatures. + + + + Get the training data of a Gaussian Mixture Model (GMM). + Modified instance represents: Handle of the training data of the classifier. + + Handle of a GMM that contains training data. + + + + Add training data to a Gaussian Mixture Model (GMM). + Instance represents: Handle of training data for a classifier. + + Handle of a GMM which receives the training data. + + + + Get the training data of a multilayer perceptron (MLP). + Modified instance represents: Handle of the training data of the classifier. + + Handle of a MLP that contains training data. + + + + Add training data to a multilayer perceptron (MLP). + Instance represents: Training data for a classifier. + + MLP handle which receives the training data. + + + + Get the training data of a k-nearest neighbors (k-NN) classifier. + Modified instance represents: Handle of the training data of the classifier. + + Handle of the k-NN classifier that contains training data. + + + + Add training data to a k-nearest neighbors (k-NN) classifier. + Instance represents: Training data for a classifier. + + Handle of a k-NN which receives the training data. + + + + Get the training data of a support vector machine (SVM). + Modified instance represents: Handle of the training data of the classifier. + + Handle of a SVM that contains training data. + + + + Add training data to a support vector machine (SVM). + Instance represents: Training data for a classifier. + + Handle of a SVM which receives the training data. + + + + Return the number of training samples stored in the training data. + Instance represents: Handle of training data. + + Number of stored training samples. + + + + Return a training sample from training data. + Instance represents: Handle of training data for a classifier. + + Number of stored training sample. + Class of the training sample. + Feature vector of the training sample. + + + + Clears training data for classifiers. + Instance represents: Handle of training data for a classifier. + + + + + Add a training sample to training data. + Instance represents: Handle of the training data. + + The order of the feature vector. Default: "row" + Feature vector of the training sample. + Class of the training sample. + + + + Create a handle for training data for classifiers. + Modified instance represents: Handle of the training data. + + Number of dimensions of the feature vector. Default: 10 + + + + Selects an optimal combination of features to classify the provided data. + Instance represents: Handle of the training data. + + Method to perform the selection. Default: "greedy" + Names of generic parameters to configure the selection process and the classifier. Default: [] + Values of generic parameters to configure the selection process and the classifier. Default: [] + The selected feature set, contains indices referring. + The achieved score using two-fold cross-validation. + A trained MLP classifier using only the selected features. + + + + Selects an optimal combination of features to classify the provided data. + Instance represents: Handle of the training data. + + Method to perform the selection. Default: "greedy" + Names of generic parameters to configure the selection process and the classifier. Default: [] + Values of generic parameters to configure the selection process and the classifier. Default: [] + The selected feature set, contains indices referring. + The achieved score using two-fold cross-validation. + A trained MLP classifier using only the selected features. + + + + Selects an optimal combination of features to classify the provided data. + Instance represents: Handle of the training data. + + Method to perform the selection. Default: "greedy" + Names of generic parameters to configure the selection process and the classifier. Default: [] + Values of generic parameters to configure the selection process and the classifier. Default: [] + The selected feature set, contains indices. + The achieved score using two-fold cross-validation. + A trained SVM classifier using only the selected features. + + + + Selects an optimal combination of features to classify the provided data. + Instance represents: Handle of the training data. + + Method to perform the selection. Default: "greedy" + Names of generic parameters to configure the selection process and the classifier. Default: [] + Values of generic parameters to configure the selection process and the classifier. Default: [] + The selected feature set, contains indices. + The achieved score using two-fold cross-validation. + A trained SVM classifier using only the selected features. + + + + Selects an optimal combination from a set of features to classify the provided data. + Instance represents: Handle of the training data. + + Method to perform the selection. Default: "greedy" + Names of generic parameters to configure the classifier. Default: [] + Values of generic parameters to configure the classifier. Default: [] + The selected feature set, contains indices or names. + The achieved score using two-fold cross-validation. + A trained GMM classifier using only the selected features. + + + + Selects an optimal combination from a set of features to classify the provided data. + Instance represents: Handle of the training data. + + Method to perform the selection. Default: "greedy" + Names of generic parameters to configure the classifier. Default: [] + Values of generic parameters to configure the classifier. Default: [] + The selected feature set, contains indices or names. + The achieved score using two-fold cross-validation. + A trained GMM classifier using only the selected features. + + + + Selects an optimal subset from a set of features to solve a certain classification problem. + Instance represents: Handle of the training data. + + Method to perform the selection. Default: "greedy" + Names of generic parameters to configure the selection process and the classifier. Default: [] + Values of generic parameters to configure the selection process and the classifier. Default: [] + The selected feature set, contains indices or names. + The achieved score using two-fold cross-validation. + A trained k-NN classifier using only the selected features. + + + + Selects an optimal subset from a set of features to solve a certain classification problem. + Instance represents: Handle of the training data. + + Method to perform the selection. Default: "greedy" + Names of generic parameters to configure the selection process and the classifier. Default: [] + Values of generic parameters to configure the selection process and the classifier. Default: [] + The selected feature set, contains indices or names. + The achieved score using two-fold cross-validation. + A trained k-NN classifier using only the selected features. + + + Represents an instance of a color space transformation lookup table + + + + Creates the look-up-table for transformation of an image from the RGB color space to an arbitrary color space. + Modified instance represents: Handle of the look-up-table for color space transformation. + + Color space of the output image. Default: "hsv" + Direction of color space transformation. Default: "from_rgb" + Number of bits of the input image. Default: 8 + + + + Release the look-up-table needed for color space transformation. + Instance represents: Handle of the look-up-table handle for the color space transformation. + + + + + Color space transformation using pre-generated look-up-table. + Instance represents: Handle of the look-up-table for the color space transformation. + + Input image (channel 1). + Input image (channel 2). + Input image (channel 3). + Color-transformed output image (channel 2). + Color-transformed output image (channel 3). + Color-transformed output image (channel 1). + + + + Creates the look-up-table for transformation of an image from the RGB color space to an arbitrary color space. + Modified instance represents: Handle of the look-up-table for color space transformation. + + Color space of the output image. Default: "hsv" + Direction of color space transformation. Default: "from_rgb" + Number of bits of the input image. Default: 8 + + + Represents an instance of a model for the component-based matching. + + + + Read a component model from a file. + Modified instance represents: Handle of the component model. + + File name. + + + + Prepare a component model for matching based on explicitly specified components and relations. + Modified instance represents: Handle of the component model. + + Input image from which the shape models of the model components should be created. + Input regions from which the shape models of the model components should be created. + Variation of the model components in row direction. + Variation of the model components in column direction. + Angle variation of the model components. + Smallest rotation of the component model. Default: -0.39 + Extent of the rotation of the component model. Default: 0.79 + Lower hysteresis threshold for the contrast of the components in the model image. Default: "auto" + Upper hysteresis threshold for the contrast of the components in the model image. Default: "auto" + Minimum size of the contour regions in the model. Default: "auto" + Minimum contrast of the components in the search images. Default: "auto" + Minimum score of the instances of the components to be found. Default: 0.5 + Maximum number of pyramid levels for the components. Default: "auto" + Step length of the angles (resolution) for the components. Default: "auto" + Kind of optimization for the components. Default: "auto" + Match metric used for the components. Default: "use_polarity" + Complete pregeneration of the shape models for the components if equal to 'true'. Default: "false" + Ranking of the model components expressing the suitability to act as the root component. + + + + Prepare a component model for matching based on explicitly specified components and relations. + Modified instance represents: Handle of the component model. + + Input image from which the shape models of the model components should be created. + Input regions from which the shape models of the model components should be created. + Variation of the model components in row direction. + Variation of the model components in column direction. + Angle variation of the model components. + Smallest rotation of the component model. Default: -0.39 + Extent of the rotation of the component model. Default: 0.79 + Lower hysteresis threshold for the contrast of the components in the model image. Default: "auto" + Upper hysteresis threshold for the contrast of the components in the model image. Default: "auto" + Minimum size of the contour regions in the model. Default: "auto" + Minimum contrast of the components in the search images. Default: "auto" + Minimum score of the instances of the components to be found. Default: 0.5 + Maximum number of pyramid levels for the components. Default: "auto" + Step length of the angles (resolution) for the components. Default: "auto" + Kind of optimization for the components. Default: "auto" + Match metric used for the components. Default: "use_polarity" + Complete pregeneration of the shape models for the components if equal to 'true'. Default: "false" + Ranking of the model components expressing the suitability to act as the root component. + + + + Prepare a component model for matching based on trained components. + Modified instance represents: Handle of the component model. + + Handle of the training result. + Smallest rotation of the component model. Default: -0.39 + Extent of the rotation of the component model. Default: 0.79 + Minimum contrast of the components in the search images. Default: "auto" + Minimum score of the instances of the components to be found. Default: 0.5 + Maximum number of pyramid levels for the components. Default: "auto" + Step length of the angles (resolution) for the components. Default: "auto" + Kind of optimization for the components. Default: "auto" + Match metric used for the components. Default: "use_polarity" + Complete pregeneration of the shape models for the components if equal to 'true'. Default: "false" + Ranking of the model components expressing the suitability to act as the root component. + + + + Prepare a component model for matching based on trained components. + Modified instance represents: Handle of the component model. + + Handle of the training result. + Smallest rotation of the component model. Default: -0.39 + Extent of the rotation of the component model. Default: 0.79 + Minimum contrast of the components in the search images. Default: "auto" + Minimum score of the instances of the components to be found. Default: 0.5 + Maximum number of pyramid levels for the components. Default: "auto" + Step length of the angles (resolution) for the components. Default: "auto" + Kind of optimization for the components. Default: "auto" + Match metric used for the components. Default: "use_polarity" + Complete pregeneration of the shape models for the components if equal to 'true'. Default: "false" + Ranking of the model components expressing the suitability to act as the root component. + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + + Return the components of a found instance of a component model. + Instance represents: Handle of the component model. + + Start index of each found instance of the component model in the tuples describing the component matches. + End index of each found instance of the component model to the tuples describing the component matches. + Row coordinate of the found component matches. + Column coordinate of the found component matches. + Rotation angle of the found component matches. + Score of the found component matches. + Index of the found components. + Index of the found instance of the component model to be returned. + Mark the orientation of the components. Default: "false" + Row coordinate of all components of the selected model instance. + Column coordinate of all components of the selected model instance. + Rotation angle of all components of the selected model instance. + Score of all components of the selected model instance. + Found components of the selected component model instance. + + + + Return the components of a found instance of a component model. + Instance represents: Handle of the component model. + + Start index of each found instance of the component model in the tuples describing the component matches. + End index of each found instance of the component model to the tuples describing the component matches. + Row coordinate of the found component matches. + Column coordinate of the found component matches. + Rotation angle of the found component matches. + Score of the found component matches. + Index of the found components. + Index of the found instance of the component model to be returned. + Mark the orientation of the components. Default: "false" + Row coordinate of all components of the selected model instance. + Column coordinate of all components of the selected model instance. + Rotation angle of all components of the selected model instance. + Score of all components of the selected model instance. + Found components of the selected component model instance. + + + + Find the best matches of a component model in an image. + Instance represents: Handle of the component model. + + Input image in which the component model should be found. + Index of the root component. + Smallest rotation of the root component Default: -0.39 + Extent of the rotation of the root component. Default: 0.79 + Minimum score of the instances of the component model to be found. Default: 0.5 + Number of instances of the component model to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the component models to be found. Default: 0.5 + Behavior if the root component is missing. Default: "stop_search" + Behavior if a component is missing. Default: "prune_branch" + Pose prediction of components that are not found. Default: "none" + Minimum score of the instances of the components to be found. Default: 0.5 + Subpixel accuracy of the component poses if not equal to 'none'. Default: "least_squares" + Number of pyramid levels for the components used in the matching (and lowest pyramid level to use if $|NumLevelsComp| = 2n$). Default: 0 + "Greediness" of the search heuristic for the components (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + End index of each found instance of the component model in the tuples describing the component matches. + Score of the found instances of the component model. + Row coordinate of the found component matches. + Column coordinate of the found component matches. + Rotation angle of the found component matches. + Score of the found component matches. + Index of the found components. + Start index of each found instance of the component model in the tuples describing the component matches. + + + + Find the best matches of a component model in an image. + Instance represents: Handle of the component model. + + Input image in which the component model should be found. + Index of the root component. + Smallest rotation of the root component Default: -0.39 + Extent of the rotation of the root component. Default: 0.79 + Minimum score of the instances of the component model to be found. Default: 0.5 + Number of instances of the component model to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the component models to be found. Default: 0.5 + Behavior if the root component is missing. Default: "stop_search" + Behavior if a component is missing. Default: "prune_branch" + Pose prediction of components that are not found. Default: "none" + Minimum score of the instances of the components to be found. Default: 0.5 + Subpixel accuracy of the component poses if not equal to 'none'. Default: "least_squares" + Number of pyramid levels for the components used in the matching (and lowest pyramid level to use if $|NumLevelsComp| = 2n$). Default: 0 + "Greediness" of the search heuristic for the components (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + End index of each found instance of the component model in the tuples describing the component matches. + Score of the found instances of the component model. + Row coordinate of the found component matches. + Column coordinate of the found component matches. + Rotation angle of the found component matches. + Score of the found component matches. + Index of the found components. + Start index of each found instance of the component model in the tuples describing the component matches. + + + + Free the memory of a component model. + Instance represents: Handle of the component model. + + + + + Return the search tree of a component model. + Instance represents: Handle of the component model. + + Relations of components that are connected in the search tree. + Index of the root component. + Image for which the tree is to be returned. Default: "model_image" + Component index of the start node of an arc in the search tree. + Component index of the end node of an arc in the search tree. + Row coordinate of the center of the rectangle representing the relation. + Column index of the center of the rectangle representing the relation. + Orientation of the rectangle representing the relation (radians). + First radius (half length) of the rectangle representing the relation. + Second radius (half width) of the rectangle representing the relation. + Smallest relative orientation angle. + Extent of the relative orientation angle. + Search tree. + + + + Return the search tree of a component model. + Instance represents: Handle of the component model. + + Relations of components that are connected in the search tree. + Index of the root component. + Image for which the tree is to be returned. Default: "model_image" + Component index of the start node of an arc in the search tree. + Component index of the end node of an arc in the search tree. + Row coordinate of the center of the rectangle representing the relation. + Column index of the center of the rectangle representing the relation. + Orientation of the rectangle representing the relation (radians). + First radius (half length) of the rectangle representing the relation. + Second radius (half width) of the rectangle representing the relation. + Smallest relative orientation angle. + Extent of the relative orientation angle. + Search tree. + + + + Return the parameters of a component model. + Instance represents: Handle of the component model. + + Ranking of the model components expressing their suitability to act as root component. + Handles of the shape models of the individual model components. + Minimum score of the instances of the components to be found. + + + + Return the parameters of a component model. + Instance represents: Handle of the component model. + + Ranking of the model components expressing their suitability to act as root component. + Handles of the shape models of the individual model components. + Minimum score of the instances of the components to be found. + + + + Deserialize a serialized component model. + Modified instance represents: Handle of the component model. + + Handle of the serialized item. + + + + Serialize a component model. + Instance represents: Handle of the component model. + + Handle of the serialized item. + + + + Read a component model from a file. + Modified instance represents: Handle of the component model. + + File name. + + + + Write a component model to a file. + Instance represents: Handle of the component model. + + File name. + + + + Prepare a component model for matching based on explicitly specified components and relations. + Modified instance represents: Handle of the component model. + + Input image from which the shape models of the model components should be created. + Input regions from which the shape models of the model components should be created. + Variation of the model components in row direction. + Variation of the model components in column direction. + Angle variation of the model components. + Smallest rotation of the component model. Default: -0.39 + Extent of the rotation of the component model. Default: 0.79 + Lower hysteresis threshold for the contrast of the components in the model image. Default: "auto" + Upper hysteresis threshold for the contrast of the components in the model image. Default: "auto" + Minimum size of the contour regions in the model. Default: "auto" + Minimum contrast of the components in the search images. Default: "auto" + Minimum score of the instances of the components to be found. Default: 0.5 + Maximum number of pyramid levels for the components. Default: "auto" + Step length of the angles (resolution) for the components. Default: "auto" + Kind of optimization for the components. Default: "auto" + Match metric used for the components. Default: "use_polarity" + Complete pregeneration of the shape models for the components if equal to 'true'. Default: "false" + Ranking of the model components expressing the suitability to act as the root component. + + + + Prepare a component model for matching based on explicitly specified components and relations. + Modified instance represents: Handle of the component model. + + Input image from which the shape models of the model components should be created. + Input regions from which the shape models of the model components should be created. + Variation of the model components in row direction. + Variation of the model components in column direction. + Angle variation of the model components. + Smallest rotation of the component model. Default: -0.39 + Extent of the rotation of the component model. Default: 0.79 + Lower hysteresis threshold for the contrast of the components in the model image. Default: "auto" + Upper hysteresis threshold for the contrast of the components in the model image. Default: "auto" + Minimum size of the contour regions in the model. Default: "auto" + Minimum contrast of the components in the search images. Default: "auto" + Minimum score of the instances of the components to be found. Default: 0.5 + Maximum number of pyramid levels for the components. Default: "auto" + Step length of the angles (resolution) for the components. Default: "auto" + Kind of optimization for the components. Default: "auto" + Match metric used for the components. Default: "use_polarity" + Complete pregeneration of the shape models for the components if equal to 'true'. Default: "false" + Ranking of the model components expressing the suitability to act as the root component. + + + + Prepare a component model for matching based on trained components. + Modified instance represents: Handle of the component model. + + Handle of the training result. + Smallest rotation of the component model. Default: -0.39 + Extent of the rotation of the component model. Default: 0.79 + Minimum contrast of the components in the search images. Default: "auto" + Minimum score of the instances of the components to be found. Default: 0.5 + Maximum number of pyramid levels for the components. Default: "auto" + Step length of the angles (resolution) for the components. Default: "auto" + Kind of optimization for the components. Default: "auto" + Match metric used for the components. Default: "use_polarity" + Complete pregeneration of the shape models for the components if equal to 'true'. Default: "false" + Ranking of the model components expressing the suitability to act as the root component. + + + + Prepare a component model for matching based on trained components. + Modified instance represents: Handle of the component model. + + Handle of the training result. + Smallest rotation of the component model. Default: -0.39 + Extent of the rotation of the component model. Default: 0.79 + Minimum contrast of the components in the search images. Default: "auto" + Minimum score of the instances of the components to be found. Default: 0.5 + Maximum number of pyramid levels for the components. Default: "auto" + Step length of the angles (resolution) for the components. Default: "auto" + Kind of optimization for the components. Default: "auto" + Match metric used for the components. Default: "use_polarity" + Complete pregeneration of the shape models for the components if equal to 'true'. Default: "false" + Ranking of the model components expressing the suitability to act as the root component. + + + Represents an instance of a training result for the component-based matching. + + + + Train components and relations for the component-based matching. + Modified instance represents: Handle of the training result. + + Input image from which the shape models of the initial components should be created. + Contour regions or enclosing regions of the initial components. + Training images that are used for training the model components. + Contour regions of rigid model components. + Lower hysteresis threshold for the contrast of the initial components in the image. Default: "auto" + Upper hysteresis threshold for the contrast of the initial components in the image. Default: "auto" + Minimum size of connected contour regions. Default: "auto" + Minimum score of the instances of the initial components to be found. Default: 0.5 + Search tolerance in row direction. Default: -1 + Search tolerance in column direction. Default: -1 + Angle search tolerance. Default: -1 + Decision whether the training emphasis should lie on a fast computation or on a high robustness. Default: "speed" + Criterion for solving ambiguous matches of the initial components in the training images. Default: "rigidity" + Maximum contour overlap of the found initial components in a training image. Default: 0.2 + Threshold for clustering the initial components. Default: 0.5 + + + + Train components and relations for the component-based matching. + Modified instance represents: Handle of the training result. + + Input image from which the shape models of the initial components should be created. + Contour regions or enclosing regions of the initial components. + Training images that are used for training the model components. + Contour regions of rigid model components. + Lower hysteresis threshold for the contrast of the initial components in the image. Default: "auto" + Upper hysteresis threshold for the contrast of the initial components in the image. Default: "auto" + Minimum size of connected contour regions. Default: "auto" + Minimum score of the instances of the initial components to be found. Default: 0.5 + Search tolerance in row direction. Default: -1 + Search tolerance in column direction. Default: -1 + Angle search tolerance. Default: -1 + Decision whether the training emphasis should lie on a fast computation or on a high robustness. Default: "speed" + Criterion for solving ambiguous matches of the initial components in the training images. Default: "rigidity" + Maximum contour overlap of the found initial components in a training image. Default: 0.2 + Threshold for clustering the initial components. Default: 0.5 + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + + Prepare a component model for matching based on trained components. + Instance represents: Handle of the training result. + + Smallest rotation of the component model. Default: -0.39 + Extent of the rotation of the component model. Default: 0.79 + Minimum contrast of the components in the search images. Default: "auto" + Minimum score of the instances of the components to be found. Default: 0.5 + Maximum number of pyramid levels for the components. Default: "auto" + Step length of the angles (resolution) for the components. Default: "auto" + Kind of optimization for the components. Default: "auto" + Match metric used for the components. Default: "use_polarity" + Complete pregeneration of the shape models for the components if equal to 'true'. Default: "false" + Ranking of the model components expressing the suitability to act as the root component. + Handle of the component model. + + + + Prepare a component model for matching based on trained components. + Instance represents: Handle of the training result. + + Smallest rotation of the component model. Default: -0.39 + Extent of the rotation of the component model. Default: 0.79 + Minimum contrast of the components in the search images. Default: "auto" + Minimum score of the instances of the components to be found. Default: 0.5 + Maximum number of pyramid levels for the components. Default: "auto" + Step length of the angles (resolution) for the components. Default: "auto" + Kind of optimization for the components. Default: "auto" + Match metric used for the components. Default: "use_polarity" + Complete pregeneration of the shape models for the components if equal to 'true'. Default: "false" + Ranking of the model components expressing the suitability to act as the root component. + Handle of the component model. + + + + Free the memory of a component training result. + Instance represents: Handle of the training result. + + + + + Return the relations between the model components that are contained in a training result. + Instance represents: Handle of the training result. + + Index of reference component. + Image for which the component relations are to be returned. Default: "model_image" + Row coordinate of the center of the rectangle representing the relation. + Column index of the center of the rectangle representing the relation. + Orientation of the rectangle representing the relation (radians). + First radius (half length) of the rectangle representing the relation. + Second radius (half width) of the rectangle representing the relation. + Smallest relative orientation angle. + Extent of the relative orientation angles. + Region representation of the relations. + + + + Return the relations between the model components that are contained in a training result. + Instance represents: Handle of the training result. + + Index of reference component. + Image for which the component relations are to be returned. Default: "model_image" + Row coordinate of the center of the rectangle representing the relation. + Column index of the center of the rectangle representing the relation. + Orientation of the rectangle representing the relation (radians). + First radius (half length) of the rectangle representing the relation. + Second radius (half width) of the rectangle representing the relation. + Smallest relative orientation angle. + Extent of the relative orientation angles. + Region representation of the relations. + + + + Return the initial or model components in a certain image. + Instance represents: Handle of the training result. + + Type of returned components or index of an initial component. Default: "model_components" + Image for which the components are to be returned. Default: "model_image" + Mark the orientation of the components. Default: "false" + Row coordinate of the found instances of all initial components or model components. + Column coordinate of the found instances of all initial components or model components. + Rotation angle of the found instances of all components. + Score of the found instances of all components. + Contour regions of the initial components or of the model components. + + + + Return the initial or model components in a certain image. + Instance represents: Handle of the training result. + + Type of returned components or index of an initial component. Default: "model_components" + Image for which the components are to be returned. Default: "model_image" + Mark the orientation of the components. Default: "false" + Row coordinate of the found instances of all initial components or model components. + Column coordinate of the found instances of all initial components or model components. + Rotation angle of the found instances of all components. + Score of the found instances of all components. + Contour regions of the initial components or of the model components. + + + + Modify the relations within a training result. + Instance represents: Handle of the training result. + + Model component(s) relative to which the movement(s) should be modified. Default: "all" + Model component(s) of which the relative movement(s) should be modified. Default: "all" + Change of the position relation in pixels. + Change of the orientation relation in radians. + + + + Modify the relations within a training result. + Instance represents: Handle of the training result. + + Model component(s) relative to which the movement(s) should be modified. Default: "all" + Model component(s) of which the relative movement(s) should be modified. Default: "all" + Change of the position relation in pixels. + Change of the orientation relation in radians. + + + + Deserialize a component training result. + Modified instance represents: Handle of the training result. + + Handle of the serialized item. + + + + Serialize a component training result. + Instance represents: Handle of the training result. + + Handle of the serialized item. + + + + Read a component training result from a file. + Modified instance represents: Handle of the training result. + + File name. + + + + Write a component training result to a file. + Instance represents: Handle of the training result. + + File name. + + + + Adopt new parameters that are used to create the model components into the training result. + Instance represents: Handle of the training result. + + Training images that were used for training the model components. + Criterion for solving the ambiguities. Default: "rigidity" + Maximum contour overlap of the found initial components. Default: 0.2 + Threshold for clustering the initial components. Default: 0.5 + Contour regions of rigid model components. + + + + Inspect the rigid model components obtained from the training. + Instance represents: Handle of the training result. + + Criterion for solving the ambiguities. Default: "rigidity" + Maximum contour overlap of the found initial components. Default: 0.2 + Threshold for clustering the initial components. Default: 0.5 + Contour regions of rigid model components. + + + + Train components and relations for the component-based matching. + Modified instance represents: Handle of the training result. + + Input image from which the shape models of the initial components should be created. + Contour regions or enclosing regions of the initial components. + Training images that are used for training the model components. + Lower hysteresis threshold for the contrast of the initial components in the image. Default: "auto" + Upper hysteresis threshold for the contrast of the initial components in the image. Default: "auto" + Minimum size of connected contour regions. Default: "auto" + Minimum score of the instances of the initial components to be found. Default: 0.5 + Search tolerance in row direction. Default: -1 + Search tolerance in column direction. Default: -1 + Angle search tolerance. Default: -1 + Decision whether the training emphasis should lie on a fast computation or on a high robustness. Default: "speed" + Criterion for solving ambiguous matches of the initial components in the training images. Default: "rigidity" + Maximum contour overlap of the found initial components in a training image. Default: 0.2 + Threshold for clustering the initial components. Default: 0.5 + Contour regions of rigid model components. + + + + Train components and relations for the component-based matching. + Modified instance represents: Handle of the training result. + + Input image from which the shape models of the initial components should be created. + Contour regions or enclosing regions of the initial components. + Training images that are used for training the model components. + Lower hysteresis threshold for the contrast of the initial components in the image. Default: "auto" + Upper hysteresis threshold for the contrast of the initial components in the image. Default: "auto" + Minimum size of connected contour regions. Default: "auto" + Minimum score of the instances of the initial components to be found. Default: 0.5 + Search tolerance in row direction. Default: -1 + Search tolerance in column direction. Default: -1 + Angle search tolerance. Default: -1 + Decision whether the training emphasis should lie on a fast computation or on a high robustness. Default: "speed" + Criterion for solving ambiguous matches of the initial components in the training images. Default: "rigidity" + Maximum contour overlap of the found initial components in a training image. Default: 0.2 + Threshold for clustering the initial components. Default: 0.5 + Contour regions of rigid model components. + + + Class representing a compute device handle. + + + + Open a compute device. + Modified instance represents: Compute device handle. + + Compute device Identifier. + + + + Query compute device parameters. + Instance represents: Compute device handle. + + Name of the parameter to query. Default: "buffer_cache_capacity" + Value of the parameter. + + + + Set parameters of an compute device. + Instance represents: Compute device handle. + + Name of the parameter to set. Default: "buffer_cache_capacity" + New parameter value. + + + + Set parameters of an compute device. + Instance represents: Compute device handle. + + Name of the parameter to set. Default: "buffer_cache_capacity" + New parameter value. + + + Close all compute devices. + + + + Close a compute_device. + Instance represents: Compute device handle. + + + + Deactivate all compute devices. + + + + Deactivate a compute device. + Instance represents: Compute device handle. + + + + + Activate a compute device. + Instance represents: Compute device handle. + + + + + Initialize a compute device. + Instance represents: Compute device handle. + + List of operators to prepare. Default: "all" + + + + Open a compute device. + Modified instance represents: Compute device handle. + + Compute device Identifier. + + + Get information on a compute device. + Compute device handle. + Name of Information to query. Default: "name" + Returned information. + + + Get the list of available compute devices. + List of available compute devices. + + + Represents an instance of a condition synchronization object. + + + + Create a condition variable synchronization object. + Modified instance represents: Condition synchronization object. + + Mutex attribute. Default: [] + Mutex attribute value. Default: [] + + + + Create a condition variable synchronization object. + Modified instance represents: Condition synchronization object. + + Mutex attribute. Default: [] + Mutex attribute value. Default: [] + + + + Destroy a condition synchronization object. + Instance represents: Condition synchronization object. + + + + + Signal a condition synchronization object. + Instance represents: Condition synchronization object. + + + + + Signal a condition synchronization object. + Instance represents: Condition synchronization object. + + + + + Bounded wait on the signal of a condition synchronization object. + Instance represents: Condition synchronization object. + + Mutex synchronization object. + Timeout in micro seconds. + + + + wait on the signal of a condition synchronization object. + Instance represents: Condition synchronization object. + + Mutex synchronization object. + + + + Create a condition variable synchronization object. + Modified instance represents: Condition synchronization object. + + Mutex attribute. Default: [] + Mutex attribute value. Default: [] + + + + Create a condition variable synchronization object. + Modified instance represents: Condition synchronization object. + + Mutex attribute. Default: [] + Mutex attribute value. Default: [] + + + Represents an instance of a 2D data code reader. + + + + Read a 2D data code model from a file and create a new model. + Modified instance represents: Handle of the created 2D data code model. + + Name of the 2D data code model file. Default: "data_code_model.dcm" + + + + Create a model of a 2D data code class. + Modified instance represents: Handle for using and accessing the 2D data code model. + + Type of the 2D data code. Default: "Data Matrix ECC 200" + Names of the generic parameters that can be adjusted for the 2D data code model. Default: [] + Values of the generic parameters that can be adjusted for the 2D data code model. Default: [] + + + + Create a model of a 2D data code class. + Modified instance represents: Handle for using and accessing the 2D data code model. + + Type of the 2D data code. Default: "Data Matrix ECC 200" + Names of the generic parameters that can be adjusted for the 2D data code model. Default: [] + Values of the generic parameters that can be adjusted for the 2D data code model. Default: [] + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + + Access iconic objects that were created during the search for 2D data code symbols. + Instance represents: Handle of the 2D data code model. + + Handle of the 2D data code candidate. Either an integer (usually the ResultHandle of find_data_code_2d) or a string representing a group of candidates. Default: "all_candidates" + Name of the iconic object to return. Default: "candidate_xld" + Objects that are created as intermediate results during the detection or evaluation of 2D data codes. + + + + Access iconic objects that were created during the search for 2D data code symbols. + Instance represents: Handle of the 2D data code model. + + Handle of the 2D data code candidate. Either an integer (usually the ResultHandle of find_data_code_2d) or a string representing a group of candidates. Default: "all_candidates" + Name of the iconic object to return. Default: "candidate_xld" + Objects that are created as intermediate results during the detection or evaluation of 2D data codes. + + + + Get the alphanumerical results that were accumulated during the search for 2D data code symbols. + Instance represents: Handle of the 2D data code model. + + Handle of the 2D data code candidate. Either an integer (usually the ResultHandle of find_data_code_2d) or a string representing a group of candidates. Default: "all_candidates" + Names of the results of the 2D data code to return. Default: "status" + List with the results. + + + + Get the alphanumerical results that were accumulated during the search for 2D data code symbols. + Instance represents: Handle of the 2D data code model. + + Handle of the 2D data code candidate. Either an integer (usually the ResultHandle of find_data_code_2d) or a string representing a group of candidates. Default: "all_candidates" + Names of the results of the 2D data code to return. Default: "status" + List with the results. + + + + Detect and read 2D data code symbols in an image or train the 2D data code model. + Instance represents: Handle of the 2D data code model. + + Input image. If the image has a reduced domain, the data code search is reduced to that domain. This usually reduces the runtime of the operator. However, if the datacode is not fully inside the domain, the datacode might not be found correctly. In rare cases, data codes may be found outside the domain. If these results are undesirable, they have to be subsequently eliminated. + Names of (optional) parameters for controlling the behavior of the operator. Default: [] + Values of the optional generic parameters. Default: [] + Handles of all successfully decoded 2D data code symbols. + Decoded data strings of all detected 2D data code symbols in the image. + XLD contours that surround the successfully decoded data code symbols. The order of the contour points reflects the orientation of the detected symbols. The contours begin in the top left corner (see 'orientation' at get_data_code_2d_results) and continue clockwise. Alignment{left} Figure[1][1][60]{get_data_code_2d_results-xld_qrcode} Order of points of SymbolXLDs Figure Alignment @f$ + + + + Detect and read 2D data code symbols in an image or train the 2D data code model. + Instance represents: Handle of the 2D data code model. + + Input image. If the image has a reduced domain, the data code search is reduced to that domain. This usually reduces the runtime of the operator. However, if the datacode is not fully inside the domain, the datacode might not be found correctly. In rare cases, data codes may be found outside the domain. If these results are undesirable, they have to be subsequently eliminated. + Names of (optional) parameters for controlling the behavior of the operator. Default: [] + Values of the optional generic parameters. Default: [] + Handles of all successfully decoded 2D data code symbols. + Decoded data strings of all detected 2D data code symbols in the image. + XLD contours that surround the successfully decoded data code symbols. The order of the contour points reflects the orientation of the detected symbols. The contours begin in the top left corner (see 'orientation' at get_data_code_2d_results) and continue clockwise. Alignment{left} Figure[1][1][60]{get_data_code_2d_results-xld_qrcode} Order of points of SymbolXLDs Figure Alignment @f$ + + + + Set selected parameters of the 2D data code model. + Instance represents: Handle of the 2D data code model. + + Names of the generic parameters that shall be adjusted for the 2D data code. Default: "polarity" + Values of the generic parameters that are adjusted for the 2D data code. Default: "light_on_dark" + + + + Set selected parameters of the 2D data code model. + Instance represents: Handle of the 2D data code model. + + Names of the generic parameters that shall be adjusted for the 2D data code. Default: "polarity" + Values of the generic parameters that are adjusted for the 2D data code. Default: "light_on_dark" + + + + Get one or several parameters that describe the 2D data code model. + Instance represents: Handle of the 2D data code model. + + Names of the generic parameters that are to be queried for the 2D data code model. Default: "polarity" + Values of the generic parameters. + + + + Get one or several parameters that describe the 2D data code model. + Instance represents: Handle of the 2D data code model. + + Names of the generic parameters that are to be queried for the 2D data code model. Default: "polarity" + Values of the generic parameters. + + + + Get for a given 2D data code model the names of the generic parameters or objects that can be used in the other 2D data code operators. + Instance represents: Handle of the 2D data code model. + + Name of the parameter group. Default: "get_result_params" + List containing the names of the supported generic parameters. + + + + Deserialize a serialized 2D data code model. + Modified instance represents: Handle of the 2D data code model. + + Handle of the serialized item. + + + + Serialize a 2D data code model. + Instance represents: Handle of the 2D data code model. + + Handle of the serialized item. + + + + Read a 2D data code model from a file and create a new model. + Modified instance represents: Handle of the created 2D data code model. + + Name of the 2D data code model file. Default: "data_code_model.dcm" + + + + Writes a 2D data code model into a file. + Instance represents: Handle of the 2D data code model. + + Name of the 2D data code model file. Default: "data_code_model.dcm" + + + + Delete a 2D data code model and free the allocated memory. + Instance represents: Handle of the 2D data code model. + + + + + Create a model of a 2D data code class. + Modified instance represents: Handle for using and accessing the 2D data code model. + + Type of the 2D data code. Default: "Data Matrix ECC 200" + Names of the generic parameters that can be adjusted for the 2D data code model. Default: [] + Values of the generic parameters that can be adjusted for the 2D data code model. Default: [] + + + + Create a model of a 2D data code class. + Modified instance represents: Handle for using and accessing the 2D data code model. + + Type of the 2D data code. Default: "Data Matrix ECC 200" + Names of the generic parameters that can be adjusted for the 2D data code model. Default: [] + Values of the generic parameters that can be adjusted for the 2D data code model. Default: [] + + + Represents an instance of a deformable model for matching. + + + + Read a deformable model from a file. + Modified instance represents: Handle of the model. + + File name. + + + + Prepare a deformable model for planar calibrated matching from XLD contours. + Modified instance represents: Handle of the model. + + Input contours that will be used to create the model. + The parameters of the internal orientation of the camera. + The reference pose of the object. + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in the column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "auto" + Match metric. Default: "ignore_local_polarity" + Minimum contrast of the objects in the search images. Default: 5 + The generic parameter names. Default: [] + Values of the generic parameter. Default: [] + + + + Prepare a deformable model for planar calibrated matching from XLD contours. + Modified instance represents: Handle of the model. + + Input contours that will be used to create the model. + The parameters of the internal orientation of the camera. + The reference pose of the object. + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in the column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "auto" + Match metric. Default: "ignore_local_polarity" + Minimum contrast of the objects in the search images. Default: 5 + The generic parameter names. Default: [] + Values of the generic parameter. Default: [] + + + + Prepare a deformable model for planar uncalibrated matching from XLD contours. + Modified instance represents: Handle of the model. + + Input contours that will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in the column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "auto" + Match metric. Default: "ignore_local_polarity" + Minimum contrast of the objects in the search images. Default: 5 + The generic parameter names. Default: [] + Values of the generic parameters. Default: [] + + + + Prepare a deformable model for planar uncalibrated matching from XLD contours. + Modified instance represents: Handle of the model. + + Input contours that will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in the column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "auto" + Match metric. Default: "ignore_local_polarity" + Minimum contrast of the objects in the search images. Default: 5 + The generic parameter names. Default: [] + Values of the generic parameters. Default: [] + + + + Create a deformable model for calibrated perspective matching. + Modified instance represents: Handle of the model. + + Input image whose domain will be used to create the model. + The parameters of the internal orientation of the camera. + The reference pose of the object in the reference image. + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in the column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "none" + Match metric. Default: "use_polarity" + Thresholds or hysteresis thresholds for the contrast of the object in the template image. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + The parameter names. Default: [] + Values of the parameters. Default: [] + + + + Create a deformable model for calibrated perspective matching. + Modified instance represents: Handle of the model. + + Input image whose domain will be used to create the model. + The parameters of the internal orientation of the camera. + The reference pose of the object in the reference image. + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in the column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "none" + Match metric. Default: "use_polarity" + Thresholds or hysteresis thresholds for the contrast of the object in the template image. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + The parameter names. Default: [] + Values of the parameters. Default: [] + + + + Creates a deformable model for uncalibrated, perspective matching. + Modified instance represents: Handle of the model. + + Input image whose domain will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "none" + Match metric. Default: "use_polarity" + Thresholds or hysteresis thresholds for the contrast of the object in the template image. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + The generic parameter names. Default: [] + Values of the generic parameter. Default: [] + + + + Creates a deformable model for uncalibrated, perspective matching. + Modified instance represents: Handle of the model. + + Input image whose domain will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "none" + Match metric. Default: "use_polarity" + Thresholds or hysteresis thresholds for the contrast of the object in the template image. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + The generic parameter names. Default: [] + Values of the generic parameter. Default: [] + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + + Return the origin (reference point) of a deformable model. + Instance represents: Handle of the model. + + Row coordinate of the origin of the deformable model. + Column coordinate of the origin of the deformable model. + + + + Set the origin (reference point) of a deformable model. + Instance represents: Handle of the model. + + Row coordinate of the origin of the deformable model. + Column coordinate of the origin of the deformable model. + + + + Set selected parameters of the deformable model. + Instance represents: Handle of the model. + + Parameter names. + Parameter values. + + + + Return the parameters of a deformable model. + Instance represents: Handle of the model. + + Names of the generic parameters that are to be queried for the deformable model. Default: "angle_start" + Values of the generic parameters. + + + + Return the parameters of a deformable model. + Instance represents: Handle of the model. + + Names of the generic parameters that are to be queried for the deformable model. Default: "angle_start" + Values of the generic parameters. + + + + Return the contour representation of a deformable model. + Instance represents: Handle of the model. + + Pyramid level for which the contour representation should be returned. Default: 1 + Contour representation of the deformable model. + + + + Deserialize a deformable model. + Modified instance represents: Handle of the model. + + Handle of the serialized item. + + + + Serialize a deformable model. + Instance represents: Handle of a model to be saved. + + Handle of the serialized item. + + + + Read a deformable model from a file. + Modified instance represents: Handle of the model. + + File name. + + + + Write a deformable model to a file. + Instance represents: Handle of a model to be saved. + + The path and filename of the model to be saved. + + + Free the memory of a deformable model. + Handle of the model. + + + + Free the memory of a deformable model. + Instance represents: Handle of the model. + + + + + Find the best matches of a local deformable model in an image. + Instance represents: Handle of the model. + + Input image in which the model should be found. + Vector field of the rectification transformation. + Contours of the found instances of the model. + Smallest rotation of the model. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Minimum scale of the model in row direction. Default: 1.0 + Maximum scale of the model in row direction. Default: 1.0 + Minimum scale of the model in column direction. Default: 1.0 + Maximum scale of the model in column direction. Default: 1.0 + Minumum score of the instances of the model to be found. Default: 0.5 + Number of instances of the model to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the model to be found. Default: 1.0 + Number of pyramid levels used in the matching. Default: 0 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + Switch for requested iconic result. Default: [] + The general parameter names. Default: [] + Values of the general parameters. Default: [] + Scores of the found instances of the model. + Row coordinates of the found instances of the model. + Column coordinates of the found instances of the model. + Rectified image of the found model. + + + + Find the best matches of a calibrated deformable model in an image and return their 3D pose. + Instance represents: Handle of the model. + + Input image in which the model should be found. + Smallest rotation of the model. Default: -0.39 + Extent of the rotation angles. Default: 0.78 + Minimum scale of the model in row direction. Default: 1.0 + Maximum scale of the model in row direction. Default: 1.0 + Minimum scale of the model in column direction. Default: 1.0 + Maximum scale of the model in column direction. Default: 1.0 + Minimum score of the instances of the model to be found. Default: 0.5 + Number of instances of the model to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the model to be found. Default: 1.0 + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + The general parameter names. Default: [] + Values of the general parameters. Default: [] + 6 standard deviations or 36 covariances of the pose parameters. + Score of the found instances of the model. + Pose of the object. + + + + Find the best matches of a calibrated deformable model in an image and return their 3D pose. + Instance represents: Handle of the model. + + Input image in which the model should be found. + Smallest rotation of the model. Default: -0.39 + Extent of the rotation angles. Default: 0.78 + Minimum scale of the model in row direction. Default: 1.0 + Maximum scale of the model in row direction. Default: 1.0 + Minimum scale of the model in column direction. Default: 1.0 + Maximum scale of the model in column direction. Default: 1.0 + Minimum score of the instances of the model to be found. Default: 0.5 + Number of instances of the model to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the model to be found. Default: 1.0 + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + The general parameter names. Default: [] + Values of the general parameters. Default: [] + 6 standard deviations or 36 covariances of the pose parameters. + Score of the found instances of the model. + Pose of the object. + + + + Find the best matches of a planar projective invariant deformable model in an image. + Instance represents: Handle of the model. + + Input image in which the model should be found. + Smallest rotation of the model. Default: -0.39 + Extent of the rotation angles. Default: 0.78 + Minimum scale of the model in row direction. Default: 1.0 + Maximum scale of the model in row direction. Default: 1.0 + Minimum scale of the model in column direction. Default: 1.0 + Maximum scale of the model in column direction. Default: 1.0 + Minimum score of the instances of the model to be found. Default: 0.5 + Number of instances of the model to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the model to be found. Default: 1.0 + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + The general parameter names. Default: [] + Values of the general parameters. Default: [] + Score of the found instances of the model. + Homographies between model and found instances. + + + + Find the best matches of a planar projective invariant deformable model in an image. + Instance represents: Handle of the model. + + Input image in which the model should be found. + Smallest rotation of the model. Default: -0.39 + Extent of the rotation angles. Default: 0.78 + Minimum scale of the model in row direction. Default: 1.0 + Maximum scale of the model in row direction. Default: 1.0 + Minimum scale of the model in column direction. Default: 1.0 + Maximum scale of the model in column direction. Default: 1.0 + Minimum score of the instances of the model to be found. Default: 0.5 + Number of instances of the model to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the model to be found. Default: 1.0 + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + The general parameter names. Default: [] + Values of the general parameters. Default: [] + Score of the found instances of the model. + Homographies between model and found instances. + + + + Set the metric of a local deformable model that was created from XLD contours. + Instance represents: Handle of the model. + + Input image used for the determination of the polarity. + Vector field of the local deformation. + Match metric. Default: "use_polarity" + + + + Set the metric of a planar calibrated deformable model that was created from XLD contours. + Instance represents: Handle of the model. + + Input image used for the determination of the polarity. + Pose of the model in the image. + Match metric. Default: "use_polarity" + + + + Set the metric of a planar uncalibrated deformable model that was created from XLD contours. + Instance represents: Handle of the model. + + Input image used for the determination of the polarity. + Transformation matrix. + Match metric. Default: "use_polarity" + + + + Prepare a deformable model for local deformable matching from XLD contours. + Modified instance represents: Handle of the model. + + Input contours that will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "auto" + Match metric. Default: "ignore_local_polarity" + Minimum contrast of the objects in the search images. Default: 5 + The generic parameter names. Default: [] + Values of the generic parameters. Default: [] + + + + Prepare a deformable model for local deformable matching from XLD contours. + Modified instance represents: Handle of the model. + + Input contours that will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "auto" + Match metric. Default: "ignore_local_polarity" + Minimum contrast of the objects in the search images. Default: 5 + The generic parameter names. Default: [] + Values of the generic parameters. Default: [] + + + + Prepare a deformable model for planar calibrated matching from XLD contours. + Modified instance represents: Handle of the model. + + Input contours that will be used to create the model. + The parameters of the internal orientation of the camera. + The reference pose of the object. + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in the column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "auto" + Match metric. Default: "ignore_local_polarity" + Minimum contrast of the objects in the search images. Default: 5 + The generic parameter names. Default: [] + Values of the generic parameter. Default: [] + + + + Prepare a deformable model for planar calibrated matching from XLD contours. + Modified instance represents: Handle of the model. + + Input contours that will be used to create the model. + The parameters of the internal orientation of the camera. + The reference pose of the object. + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in the column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "auto" + Match metric. Default: "ignore_local_polarity" + Minimum contrast of the objects in the search images. Default: 5 + The generic parameter names. Default: [] + Values of the generic parameter. Default: [] + + + + Prepare a deformable model for planar uncalibrated matching from XLD contours. + Modified instance represents: Handle of the model. + + Input contours that will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in the column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "auto" + Match metric. Default: "ignore_local_polarity" + Minimum contrast of the objects in the search images. Default: 5 + The generic parameter names. Default: [] + Values of the generic parameters. Default: [] + + + + Prepare a deformable model for planar uncalibrated matching from XLD contours. + Modified instance represents: Handle of the model. + + Input contours that will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in the column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "auto" + Match metric. Default: "ignore_local_polarity" + Minimum contrast of the objects in the search images. Default: 5 + The generic parameter names. Default: [] + Values of the generic parameters. Default: [] + + + + Creates a deformable model for local, deformable matching. + Modified instance represents: Handle of the model. + + Input image whose domain will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "none" + Match metric. Default: "use_polarity" + Thresholds or hysteresis thresholds for the contrast of the object in the template image. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + The generic parameter names. Default: [] + Values of the generic parameters. Default: [] + + + + Creates a deformable model for local, deformable matching. + Modified instance represents: Handle of the model. + + Input image whose domain will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "none" + Match metric. Default: "use_polarity" + Thresholds or hysteresis thresholds for the contrast of the object in the template image. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + The generic parameter names. Default: [] + Values of the generic parameters. Default: [] + + + + Create a deformable model for calibrated perspective matching. + Modified instance represents: Handle of the model. + + Input image whose domain will be used to create the model. + The parameters of the internal orientation of the camera. + The reference pose of the object in the reference image. + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in the column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "none" + Match metric. Default: "use_polarity" + Thresholds or hysteresis thresholds for the contrast of the object in the template image. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + The parameter names. Default: [] + Values of the parameters. Default: [] + + + + Create a deformable model for calibrated perspective matching. + Modified instance represents: Handle of the model. + + Input image whose domain will be used to create the model. + The parameters of the internal orientation of the camera. + The reference pose of the object in the reference image. + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in the column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "none" + Match metric. Default: "use_polarity" + Thresholds or hysteresis thresholds for the contrast of the object in the template image. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + The parameter names. Default: [] + Values of the parameters. Default: [] + + + + Creates a deformable model for uncalibrated, perspective matching. + Modified instance represents: Handle of the model. + + Input image whose domain will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "none" + Match metric. Default: "use_polarity" + Thresholds or hysteresis thresholds for the contrast of the object in the template image. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + The generic parameter names. Default: [] + Values of the generic parameter. Default: [] + + + + Creates a deformable model for uncalibrated, perspective matching. + Modified instance represents: Handle of the model. + + Input image whose domain will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "none" + Match metric. Default: "use_polarity" + Thresholds or hysteresis thresholds for the contrast of the object in the template image. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + The generic parameter names. Default: [] + Values of the generic parameter. Default: [] + + + Represents an instance of a deformable surface matching result. + + + + Get details of a result from deformable surface based matching. + Instance represents: Handle of the deformable surface matching result. + + Name of the result property. Default: "sampled_scene" + Index of the result property. Default: 0 + Value of the result property. + + + + Get details of a result from deformable surface based matching. + Instance represents: Handle of the deformable surface matching result. + + Name of the result property. Default: "sampled_scene" + Index of the result property. Default: 0 + Value of the result property. + + + Free the memory of a deformable surface matching result. + Handle of the deformable surface matching result. + + + + Free the memory of a deformable surface matching result. + Instance represents: Handle of the deformable surface matching result. + + + + Refine the position and deformation of a deformable surface model in a 3D scene. + Handle of the deformable surface model. + Handle of the 3D object model containing the scene. + Relative sampling distance of the scene. Default: 0.05 + Initial deformation of the 3D object model + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Handle of the matching result. + Score of the refined model. + + + + Refine the position and deformation of a deformable surface model in a 3D scene. + Modified instance represents: Handle of the matching result. + + Handle of the deformable surface model. + Handle of the 3D object model containing the scene. + Relative sampling distance of the scene. Default: 0.05 + Initial deformation of the 3D object model + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Score of the refined model. + + + Find the best match of a deformable surface model in a 3D scene. + Handle of the deformable surface model. + Handle of the 3D object model containing the scene. + Scene sampling distance relative to the diameter of the surface model. Default: 0.05 + Minimum score of the returned match. Default: 0 + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Handle of the matching result. + Score of the found instances of the surface model. + + + + Find the best match of a deformable surface model in a 3D scene. + Modified instance represents: Handle of the matching result. + + Handle of the deformable surface model. + Handle of the 3D object model containing the scene. + Scene sampling distance relative to the diameter of the surface model. Default: 0.05 + Minimum score of the returned match. Default: 0 + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Score of the found instances of the surface model. + + + Represents an instance of a deformable surface model. + + + + Read a deformable surface model from a file. + Modified instance represents: Handle of the read deformable surface model. + + Name of the file to read. + + + + Create the data structure needed to perform deformable surface-based matching. + Modified instance represents: Handle of the deformable surface model. + + Handle of the 3D object model. + Sampling distance relative to the object's diameter Default: 0.05 + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + + + + Create the data structure needed to perform deformable surface-based matching. + Modified instance represents: Handle of the deformable surface model. + + Handle of the 3D object model. + Sampling distance relative to the object's diameter Default: 0.05 + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + Free the memory of a deformable surface model. + Handle of the deformable surface model. + + + + Free the memory of a deformable surface model. + Instance represents: Handle of the deformable surface model. + + + + + Deserialize a deformable surface model. + Modified instance represents: Handle of the deformable surface model. + + Handle of the serialized item. + + + + Serialize a deformable surface_model. + Instance represents: Handle of the deformable surface model. + + Handle of the serialized item. + + + + Read a deformable surface model from a file. + Modified instance represents: Handle of the read deformable surface model. + + Name of the file to read. + + + + Write a deformable surface model to a file. + Instance represents: Handle of the deformable surface model to write. + + File name to write to. + + + + Refine the position and deformation of a deformable surface model in a 3D scene. + Instance represents: Handle of the deformable surface model. + + Handle of the 3D object model containing the scene. + Relative sampling distance of the scene. Default: 0.05 + Initial deformation of the 3D object model + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Handle of the matching result. + Score of the refined model. + + + + Refine the position and deformation of a deformable surface model in a 3D scene. + Instance represents: Handle of the deformable surface model. + + Handle of the 3D object model containing the scene. + Relative sampling distance of the scene. Default: 0.05 + Initial deformation of the 3D object model + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Handle of the matching result. + Score of the refined model. + + + + Find the best match of a deformable surface model in a 3D scene. + Instance represents: Handle of the deformable surface model. + + Handle of the 3D object model containing the scene. + Scene sampling distance relative to the diameter of the surface model. Default: 0.05 + Minimum score of the returned match. Default: 0 + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Handle of the matching result. + Score of the found instances of the surface model. + + + + Find the best match of a deformable surface model in a 3D scene. + Instance represents: Handle of the deformable surface model. + + Handle of the 3D object model containing the scene. + Scene sampling distance relative to the diameter of the surface model. Default: 0.05 + Minimum score of the returned match. Default: 0 + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Handle of the matching result. + Score of the found instances of the surface model. + + + + Return the parameters and properties of a deformable surface model. + Instance represents: Handle of the deformable surface model. + + Name of the parameter. Default: "sampled_model" + Value of the parameter. + + + + Return the parameters and properties of a deformable surface model. + Instance represents: Handle of the deformable surface model. + + Name of the parameter. Default: "sampled_model" + Value of the parameter. + + + + Add a reference point to a deformable surface model. + Instance represents: Handle of the deformable surface model. + + x-coordinates of a reference point. + x-coordinates of a reference point. + x-coordinates of a reference point. + Index of the new reference point. + + + + Add a reference point to a deformable surface model. + Instance represents: Handle of the deformable surface model. + + x-coordinates of a reference point. + x-coordinates of a reference point. + x-coordinates of a reference point. + Index of the new reference point. + + + + Add a sample deformation to a deformable surface model + Instance represents: Handle of the deformable surface model. + + Handle of the deformed 3D object model. + + + + Add a sample deformation to a deformable surface model + Instance represents: Handle of the deformable surface model. + + Handle of the deformed 3D object model. + + + + Create the data structure needed to perform deformable surface-based matching. + Modified instance represents: Handle of the deformable surface model. + + Handle of the 3D object model. + Sampling distance relative to the object's diameter Default: 0.05 + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + + + + Create the data structure needed to perform deformable surface-based matching. + Modified instance represents: Handle of the deformable surface model. + + Handle of the 3D object model. + Sampling distance relative to the object's diameter Default: 0.05 + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + + + Represents an instance of a descriptor model. + + + + Read a descriptor model from a file. + Modified instance represents: Handle of the model. + + File name. + + + + Create a descriptor model for calibrated perspective matching. + Modified instance represents: The handle to the descriptor model. + + Input image whose domain will be used to create the model. + The parameters of the internal orientation of the camera. + The reference pose of the object in the reference image. + The type of the detector. Default: "lepetit" + The detector's parameter names. Default: [] + Values of the detector's parameters. Default: [] + The descriptor's parameter names. Default: [] + Values of the descriptor's parameters. Default: [] + The seed for the random number generator. Default: 42 + + + + Prepare a descriptor model for interest point matching. + Modified instance represents: The handle to the descriptor model. + + Input image whose domain will be used to create the model. + The type of the detector. Default: "lepetit" + The detector's parameter names. Default: [] + Values of the detector's parameters. Default: [] + The descriptor's parameter names. Default: [] + Values of the descriptor's parameters. Default: [] + The seed for the random number generator. Default: 42 + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + Free the memory of a descriptor model. + Handle of the descriptor model. + + + + Free the memory of a descriptor model. + Instance represents: Handle of the descriptor model. + + + + + Deserialize a descriptor model. + Modified instance represents: Handle of the model. + + Handle of the serialized item. + + + + Serialize a descriptor model. + Instance represents: Handle of a model to be saved. + + Handle of the serialized item. + + + + Read a descriptor model from a file. + Modified instance represents: Handle of the model. + + File name. + + + + Write a descriptor model to a file. + Instance represents: Handle of a model to be saved. + + The path and filename of the model to be saved. + + + + Find the best matches of a calibrated descriptor model in an image and return their 3D pose. + Instance represents: The handle to the descriptor model. + + Input image where the model should be found. + The detector's parameter names. Default: [] + Values of the detector's parameters. Default: [] + The descriptor's parameter names. Default: [] + Values of the descriptor's parameters. Default: [] + Minimum score of the instances of the models to be found. Default: 0.2 + Maximal number of found instances. Default: 1 + Camera parameter (inner orientation) obtained from camera calibration. + Score type to be evaluated in Score. Default: "num_points" + Score of the found instances according to the ScoreType input. + 3D pose of the object. + + + + Find the best matches of a calibrated descriptor model in an image and return their 3D pose. + Instance represents: The handle to the descriptor model. + + Input image where the model should be found. + The detector's parameter names. Default: [] + Values of the detector's parameters. Default: [] + The descriptor's parameter names. Default: [] + Values of the descriptor's parameters. Default: [] + Minimum score of the instances of the models to be found. Default: 0.2 + Maximal number of found instances. Default: 1 + Camera parameter (inner orientation) obtained from camera calibration. + Score type to be evaluated in Score. Default: "num_points" + Score of the found instances according to the ScoreType input. + 3D pose of the object. + + + + Find the best matches of a descriptor model in an image. + Instance represents: The handle to the descriptor model. + + Input image where the model should be found. + The detector's parameter names. Default: [] + Values of the detector's parameters. Default: [] + The descriptor's parameter names. Default: [] + Values of the descriptor's parameters. Default: [] + Minimum score of the instances of the models to be found. Default: 0.2 + Maximal number of found instances. Default: 1 + Score type to be evaluated in Score. Default: "num_points" + Score of the found instances according to the ScoreType input. + Homography between model and found instance. + + + + Find the best matches of a descriptor model in an image. + Instance represents: The handle to the descriptor model. + + Input image where the model should be found. + The detector's parameter names. Default: [] + Values of the detector's parameters. Default: [] + The descriptor's parameter names. Default: [] + Values of the descriptor's parameters. Default: [] + Minimum score of the instances of the models to be found. Default: 0.2 + Maximal number of found instances. Default: 1 + Score type to be evaluated in Score. Default: "num_points" + Score of the found instances according to the ScoreType input. + Homography between model and found instance. + + + + Query the interest points of the descriptor model or the last processed search image. + Instance represents: The handle to the descriptor model. + + Set of interest points. Default: "model" + Subset of interest points. Default: "all" + Row coordinates of interest points. + Column coordinates of interest points. + + + + Query the interest points of the descriptor model or the last processed search image. + Instance represents: The handle to the descriptor model. + + Set of interest points. Default: "model" + Subset of interest points. Default: "all" + Row coordinates of interest points. + Column coordinates of interest points. + + + + Return the parameters of a descriptor model. + Instance represents: The object handle to the descriptor model. + + The detectors parameter names. + Values of the detectors parameters. + The descriptors parameter names. + Values of the descriptors parameters. + The type of the detector. + + + + Create a descriptor model for calibrated perspective matching. + Modified instance represents: The handle to the descriptor model. + + Input image whose domain will be used to create the model. + The parameters of the internal orientation of the camera. + The reference pose of the object in the reference image. + The type of the detector. Default: "lepetit" + The detector's parameter names. Default: [] + Values of the detector's parameters. Default: [] + The descriptor's parameter names. Default: [] + Values of the descriptor's parameters. Default: [] + The seed for the random number generator. Default: 42 + + + + Prepare a descriptor model for interest point matching. + Modified instance represents: The handle to the descriptor model. + + Input image whose domain will be used to create the model. + The type of the detector. Default: "lepetit" + The detector's parameter names. Default: [] + Values of the detector's parameters. Default: [] + The descriptor's parameter names. Default: [] + Values of the descriptor's parameters. Default: [] + The seed for the random number generator. Default: 42 + + + + Query alphanumerical results that were accumulated during descriptor-based matching. + Instance represents: Handle of a descriptor model. + + Handle of the object for which the results are queried. Default: "all" + Name of the results to be queried. Default: "num_points" + Returned results. + + + + Query alphanumerical results that were accumulated during descriptor-based matching. + Instance represents: Handle of a descriptor model. + + Handle of the object for which the results are queried. Default: "all" + Name of the results to be queried. Default: "num_points" + Returned results. + + + + Return the origin of a descriptor model. + Instance represents: Handle of a descriptor model. + + Position of origin in row direction. + Position of origin in column direction. + + + + Return the origin of a descriptor model. + Instance represents: Handle of a descriptor model. + + Position of origin in row direction. + Position of origin in column direction. + + + + Sets the origin of a descriptor model. + Instance represents: Handle of a descriptor model. + + Translation of origin in row direction. Default: 0 + Translation of origin in column direction. Default: 0 + + + + Sets the origin of a descriptor model. + Instance represents: Handle of a descriptor model. + + Translation of origin in row direction. Default: 0 + Translation of origin in column direction. Default: 0 + + + Represents an instance of a Dictionary. + + + + Create a new empty dictionary. + Modified instance represents: Handle of the newly created dictionary. + + + + + Read a dictionary from a file. + Modified instance represents: Dictionary handle. + + File name. + Name of the generic parameter. Default: [] + Value of the generic parameter. Default: [] + + + + Read a dictionary from a file. + Modified instance represents: Dictionary handle. + + File name. + Name of the generic parameter. Default: [] + Value of the generic parameter. Default: [] + + + + Copy a dictionary. + Instance represents: Dictionary handle. + + Name of the generic parameter. Default: [] + Value of the generic parameter. Default: [] + Copied dictionary handle. + + + + Copy a dictionary. + Instance represents: Dictionary handle. + + Name of the generic parameter. Default: [] + Value of the generic parameter. Default: [] + Copied dictionary handle. + + + + Create a new empty dictionary. + Modified instance represents: Handle of the newly created dictionary. + + + + + Retrieve an object associated with the key from the dictionary. + Instance represents: Dictionary handle. + + Key string. + Object value retrieved from the dictionary. + + + + Retrieve an object associated with the key from the dictionary. + Instance represents: Dictionary handle. + + Key string. + Object value retrieved from the dictionary. + + + + Query dictionary parameters or information about a dictionary. + Instance represents: Dictionary handle. + + Names of the dictionary parameters or info queries. Default: "keys" + Dictionary keys the parameter/query should be applied to (empty for GenParamName = 'keys'). + Values of the dictionary parameters or info queries. + + + + Query dictionary parameters or information about a dictionary. + Instance represents: Dictionary handle. + + Names of the dictionary parameters or info queries. Default: "keys" + Dictionary keys the parameter/query should be applied to (empty for GenParamName = 'keys'). + Values of the dictionary parameters or info queries. + + + + Retrieve a tuple associated with the key from the dictionary. + Instance represents: Dictionary handle. + + Key string. + Tuple value retrieved from the dictionary. + + + + Retrieve a tuple associated with the key from the dictionary. + Instance represents: Dictionary handle. + + Key string. + Tuple value retrieved from the dictionary. + + + + Read a dictionary from a file. + Modified instance represents: Dictionary handle. + + File name. + Name of the generic parameter. Default: [] + Value of the generic parameter. Default: [] + + + + Read a dictionary from a file. + Modified instance represents: Dictionary handle. + + File name. + Name of the generic parameter. Default: [] + Value of the generic parameter. Default: [] + + + + Remove keys from a dictionary. + Instance represents: Dictionary handle. + + Key to remove. + + + + Remove keys from a dictionary. + Instance represents: Dictionary handle. + + Key to remove. + + + + Add a key/object pair to the dictionary. + Instance represents: Dictionary handle. + + Object to be associated with the key. + Key string. + + + + Add a key/object pair to the dictionary. + Instance represents: Dictionary handle. + + Object to be associated with the key. + Key string. + + + + Add a key/tuple pair to the dictionary. + Instance represents: Dictionary handle. + + Key string. + Tuple value to be associated with the key. + + + + Add a key/tuple pair to the dictionary. + Instance represents: Dictionary handle. + + Key string. + Tuple value to be associated with the key. + + + + Write a dictionary to a file. + Instance represents: Dictionary handle. + + File name. + Name of the generic parameter. Default: [] + Value of the generic parameter. Default: [] + + + + Write a dictionary to a file. + Instance represents: Dictionary handle. + + File name. + Name of the generic parameter. Default: [] + Value of the generic parameter. Default: [] + + + Represents an instance of a Deep Neural Network. + + + + Read a deep-learning-based classifier from a file. + Modified instance represents: Handle of the deep learning classifier. + + File name. Default: "pretrained_dl_classifier_compact.hdl" + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + + Infer the class affiliations for a set of images using a deep-learning-based classifier. + Instance represents: Handle of the deep-learning-based classifier. + + Tuple of input images. + Handle of the deep learning classification results. + + + Clear a deep-learning-based classifier. + Handle of the deep-learning-based classifier. + + + + Clear a deep-learning-based classifier. + Instance represents: Handle of the deep-learning-based classifier. + + + + + Deserialize a deep-learning-based classifier. + Modified instance represents: Handle of the deep-learning-based classifier. + + Handle of the serialized item. + + + + Return the parameters of a deep-learning-based classifier. + Instance represents: Handle of the deep-learning-based classifier. + + Name of the generic parameter. Default: "gpu" + Value of the generic parameter. + + + + Return the parameters of a deep-learning-based classifier. + Instance represents: Handle of the deep-learning-based classifier. + + Name of the generic parameter. Default: "gpu" + Value of the generic parameter. + + + + Read a deep-learning-based classifier from a file. + Modified instance represents: Handle of the deep learning classifier. + + File name. Default: "pretrained_dl_classifier_compact.hdl" + + + + Serialize a deep-learning-based classifier. + Instance represents: Handle of the deep-learning-based classifier. + + Handle of the serialized item. + + + + Set the parameters of a deep-learning-based classifier. + Instance represents: Handle of the deep-learning-based classifier. + + Name of the generic parameter. Default: "classes" + Value of the generic parameter. Default: ["class_1","class_2","class_3"] + + + + Set the parameters of a deep-learning-based classifier. + Instance represents: Handle of the deep-learning-based classifier. + + Name of the generic parameter. Default: "classes" + Value of the generic parameter. Default: ["class_1","class_2","class_3"] + + + + Write a deep-learning-based classifier in a file. + Instance represents: Handle of the deep-learning-based classifier. + + File name. + + + Represents an instance of a Deep Neural Network inference step result. + + + + Infer the class affiliations for a set of images using a deep-learning-based classifier. + Modified instance represents: Handle of the deep learning classification results. + + Tuple of input images. + Handle of the deep-learning-based classifier. + + + Clear a handle containing the results of the deep-learning-based classification. + Handle of the deep learning classification results. + + + + Clear a handle containing the results of the deep-learning-based classification. + Instance represents: Handle of the deep learning classification results. + + + + + Retrieve classification results inferred by a deep-learning-based classifier. + Instance represents: Handle of the deep learning classification results. + + Index of the image in the batch. Default: "all" + Name of the generic parameter. Default: "predicted_classes" + Value of the generic parameter, either the confidence values, the class names or class indices. + + + + Retrieve classification results inferred by a deep-learning-based classifier. + Instance represents: Handle of the deep learning classification results. + + Index of the image in the batch. Default: "all" + Name of the generic parameter. Default: "predicted_classes" + Value of the generic parameter, either the confidence values, the class names or class indices. + + + Represents an instance of a Deep Neural Network training step result. + + + + Perform a training step of a deep-learning-based classifier on a batch of images. + Modified instance represents: Handle of the training results from the deep-learning-based classifier. + + Images comprising the batch. + Handle of the deep-learning-based classifier. + Corresponding labels for each of the images. Default: [] + + + Clear the handle of a deep-learning-based classifier training result. + Handle of the training results from the deep-learning-based classifier. + + + + Clear the handle of a deep-learning-based classifier training result. + Instance represents: Handle of the training results from the deep-learning-based classifier. + + + + + Return the results for the single training step of a deep-learning-based classifier. + Instance represents: Handle of the training results from the deep-learning-based classifier. + + Name of the generic parameter. Default: "loss" + Value of the generic parameter. + + + + Return the results for the single training step of a deep-learning-based classifier. + Instance represents: Handle of the training results from the deep-learning-based classifier. + + Name of the generic parameter. Default: "loss" + Value of the generic parameter. + + + + Perform a training step of a deep-learning-based classifier on a batch of images. + Modified instance represents: Handle of the training results from the deep-learning-based classifier. + + Images comprising the batch. + Handle of the deep-learning-based classifier. + Corresponding labels for each of the images. Default: [] + + + Represents an instance of a Deep Neural Network. + + + + Create a deep learning network for object detection. + Modified instance represents: Deep learning model for object detection. + + Deep learning classifier, used as backbone network. Default: "pretrained_dl_classifier_compact.hdl" + Number of classes. Default: 3 + Parameters for the object detection model. Default: [] + + + + Read a deep learning model from a file. + Modified instance represents: Handle of the deep learning model. + + Filename Default: "pretrained_dl_segmentation_compact.hdl" + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + + Apply a deep-learning-based network on a set of images for inference. + Instance represents: Handle of the deep learning model. + + Input data. + Requested outputs. Default: [] + Handle containing result data. + + + Clear a deep learning model. + Handle of the deep learning model. + + + + Clear a deep learning model. + Instance represents: Handle of the deep learning model. + + + + + Create a deep learning network for object detection. + Modified instance represents: Deep learning model for object detection. + + Deep learning classifier, used as backbone network. Default: "pretrained_dl_classifier_compact.hdl" + Number of classes. Default: 3 + Parameters for the object detection model. Default: [] + + + + Deserialize a deep learning model. + Modified instance represents: Handle of the deep learning model. + + Handle of the serialized item. + + + + Return the parameters of a deep learning model. + Instance represents: Handle of the deep learning model. + + Name of the generic parameter. Default: "batch_size" + Value of the generic parameter. + + + + Read a deep learning model from a file. + Modified instance represents: Handle of the deep learning model. + + Filename Default: "pretrained_dl_segmentation_compact.hdl" + + + + Serialize a deep learning model. + Instance represents: Handle of the deep learning model. + + Handle of the serialized item. + + + + Set the parameters of a deep learning model. + Instance represents: Handle of the deep learning model. + + Name of the generic parameter. Default: "learning_rate" + Value of the generic parameter. Default: 0.001 + + + + Set the parameters of a deep learning model. + Instance represents: Handle of the deep learning model. + + Name of the generic parameter. Default: "learning_rate" + Value of the generic parameter. Default: 0.001 + + + + Train a deep learning model. + Instance represents: Deep learning model handle. + + Tuple of Dictionaries with input images and corresponding information. + Dictionary with the train result data. + + + + Write a deep learning model in a file. + Instance represents: Handle of the deep learning model. + + Filename + + + Represents an instance of a drawing object. + + + + Create a circle which can be modified interactively. + Modified instance represents: Handle of the drawing object. + + Row coordinate of the center. Default: 100 + Column coordinate of the center. Default: 100 + Radius of the circle. Default: 80 + + + + Create a rectangle of any orientation which can be modified interactively. + Modified instance represents: Handle of the drawing object. + + Row coordinate of the center. Default: 150 + Column coordinate of the center. Default: 150 + Orientation of the first half axis in radians. Default: 0 + First half axis. Default: 100 + Second half axis. Default: 100 + + + + Create a rectangle parallel to the coordinate axis which can be modified interactively. + Modified instance represents: Handle of the drawing object. + + Row coordinate of the upper left corner. Default: 100 + Column coordinate of the upper left corner. Default: 100 + Row coordinate of the lower right corner. Default: 200 + Column coordinate of the lower right corner. Default: 200 + + + Adds a callback for the resize event, that is, this callback is + executed whenever the user changes any of the dimensions of the draw + object. + Callback function with the signature defined by + HDrawingObjectCallback + + + Adds a callback for the attach event, that is, this callback is + executed when a drawing object is attached to the window. + Callback function with the signature defined by + HDrawingObjectCallback + + + Adds a callback for the detach event, that is, this callback is + executed when a drawing object is detached from the window. + Callback function with the signature defined by + HDrawingObjectCallback + + + Adds a callback for the resize event, that is, this callback is + executed whenever the drawing object's position changes. + Callback function with the signature defined by + HDrawingObjectCallback + + + Adds a callback for the resize event, that is, this callback is + executed whenever the drawing object is selected. + Callback function with the signature defined by + HDrawingObjectCallback + + + Adds a callback for the resize event, that is, this callback is + executed whenever the user changes any of the dimensions of the draw + object. + Callback function with the signature defined by + HDrawingObjectCallback + + + Adds a callback for the resize event, that is, this callback is + executed whenever the drawing object's position changes. + Callback function with the signature defined by + HDrawingObjectCallback + + + Adds a callback for the resize event, that is, this callback is + executed whenever the drawing object is selected. + Callback function with the signature defined by + HDrawingObjectCallback + + + Adds a callback for the attach event, that is, this callback is + executed when a drawing object is attached to the window. + Callback function with the signature defined by + HDrawingObjectCallback + + + Adds a callback for the detach event, that is, this callback is + executed when a drawing object is detached from the window. + Callback function with the signature defined by + HDrawingObjectCallback + + + Method to create drawing objects by explicitly specifying the type. + Type of the drawing object. Can be any of the specified by + the enum type HDrawingObjectType. + List of parameters for the corresponding drawing object. + See the constructors listed in HOperatorSet for more details. + + + + Add a callback function to a drawing object. + Instance represents: Handle of the drawing object. + + Events to be captured. + Callback functions. + + + + Add a callback function to a drawing object. + Instance represents: Handle of the drawing object. + + Events to be captured. + Callback functions. + + + Detach the background image from a HALCON window. + Window handle. + + + Attach a background image to a HALCON window. + Background image. + Window handle. + + + + Create a text object which can be moved interactively. + Modified instance represents: Handle of the drawing object. + + Row coordinate of the text position. Default: 12 + Column coordinate of the text position. Default: 12 + Character string to be displayed. Default: "Text" + + + + Return the iconic object of a drawing object. + Instance represents: Handle of the drawing object. + + Copy of the iconic object represented by the drawing object. + + + + Delete drawing object. + Instance represents: Handle of the drawing object. + + + + + Set the parameters of a drawing object. + Instance represents: Handle of the drawing object. + + Parameter names of the drawing object. + Parameter values. + + + + Set the parameters of a drawing object. + Instance represents: Handle of the drawing object. + + Parameter names of the drawing object. + Parameter values. + + + + Get the parameters of a drawing object. + Instance represents: Handle of the drawing object. + + Parameter names of the drawing object. + Parameter values. + + + + Get the parameters of a drawing object. + Instance represents: Handle of the drawing object. + + Parameter names of the drawing object. + Parameter values. + + + + Set the contour of an interactive draw XLD. + Instance represents: Handle of the drawing object. + + XLD contour. + + + + Create a XLD contour which can be modified interactively. + Modified instance represents: Handle of the drawing object. + + Row coordinates of the polygon. Default: [100,200,200,100] + Column coordinates of the polygon. Default: [100,100,200,200] + + + + Create a circle sector which can be modified interactively. + Modified instance represents: Handle of the drawing object. + + Row coordinate of the center. Default: 100 + Column coordinate of the center. Default: 100 + Radius of the circle. Default: 80 + Start angle of the arc. Default: 0 + End angle of the arc. Default: 3.14159 + + + + Create an elliptic sector which can be modified interactively. + Modified instance represents: Handle of the drawing object. + + Row index of the center. Default: 200 + Column index of the center. Default: 200 + Orientation of the first half axis in radians. Default: 0 + First half axis. Default: 100 + Second half axis. Default: 60 + Start angle of the arc. Default: 0 + End angle of the arc. Default: 3.14159 + + + + Create a line which can be modified interactively. + Modified instance represents: Handle of the drawing object. + + Row index of the first line point. Default: 100 + Column index of the first line point. Default: 100 + Row index of the second line point. Default: 200 + Column index of the second line point. Default: 200 + + + + Create a circle which can be modified interactively. + Modified instance represents: Handle of the drawing object. + + Row coordinate of the center. Default: 100 + Column coordinate of the center. Default: 100 + Radius of the circle. Default: 80 + + + + Create an ellipse which can be modified interactively. + Modified instance represents: Handle of the drawing object. + + Row index of the center. Default: 200 + Column index of the center. Default: 200 + Orientation of the first half axis in radians. Default: 0 + First half axis. Default: 100 + Second half axis. Default: 60 + + + + Create a rectangle of any orientation which can be modified interactively. + Modified instance represents: Handle of the drawing object. + + Row coordinate of the center. Default: 150 + Column coordinate of the center. Default: 150 + Orientation of the first half axis in radians. Default: 0 + First half axis. Default: 100 + Second half axis. Default: 100 + + + + Create a rectangle parallel to the coordinate axis which can be modified interactively. + Modified instance represents: Handle of the drawing object. + + Row coordinate of the upper left corner. Default: 100 + Column coordinate of the upper left corner. Default: 100 + Row coordinate of the lower right corner. Default: 200 + Column coordinate of the lower right corner. Default: 200 + + + Send an event to a buffer window signaling a mouse double click event. + Window handle of the buffer window. + Row coordinate of the mouse cursor in the image coordinate system. + Column coordinate of the mouse cursor in the image coordinate system. + Mouse button(s) pressed. + 'true', if HALCON processed the event. + + + Send an event to a buffer window signaling a mouse double click event. + Window handle of the buffer window. + Row coordinate of the mouse cursor in the image coordinate system. + Column coordinate of the mouse cursor in the image coordinate system. + Mouse button(s) pressed. + 'true', if HALCON processed the event. + + + Send an event to a window buffer signaling a mouse down event. + Window handle of the buffer window. + Row coordinate of the mouse cursor in the image coordinate system. + Column coordinate of the mouse cursor in the image coordinate system. + Mouse button(s) pressed. + 'true', if HALCON processed the event. + + + Send an event to a window buffer signaling a mouse down event. + Window handle of the buffer window. + Row coordinate of the mouse cursor in the image coordinate system. + Column coordinate of the mouse cursor in the image coordinate system. + Mouse button(s) pressed. + 'true', if HALCON processed the event. + + + Send an event to a buffer window signaling a mouse drag event. + Window handle of the buffer window. + Row coordinate of the mouse cursor in the image coordinate system. + Column coordinate of the mouse cursor in the image coordinate system. + Mouse button(s) pressed. + 'true', if HALCON processed the event. + + + Send an event to a buffer window signaling a mouse drag event. + Window handle of the buffer window. + Row coordinate of the mouse cursor in the image coordinate system. + Column coordinate of the mouse cursor in the image coordinate system. + Mouse button(s) pressed. + 'true', if HALCON processed the event. + + + Send an event to a buffer window signaling a mouse up event. + Window handle of the buffer window. + Row coordinate of the mouse cursor in the image coordinate system. + Column coordinate of the mouse cursor in the image coordinate system. + Mouse button(s) pressed. + 'true', if HALCON processed the event. + + + Send an event to a buffer window signaling a mouse up event. + Window handle of the buffer window. + Row coordinate of the mouse cursor in the image coordinate system. + Column coordinate of the mouse cursor in the image coordinate system. + Mouse button(s) pressed. + 'true', if HALCON processed the event. + + + Returns the corresponding HALCON id. + + + Signature for the drawing object callbacks in managed code. + + + Signature for the drawing object callbacks in managed code. + + + Represents a dual quaternion. + + + Create an uninitialized instance. + + + + Convert a 3D pose to a unit dual quaternion. + Modified instance represents: Unit dual quaternion. + + 3D pose. + + + + Convert a screw into a dual quaternion. + Modified instance represents: Dual quaternion. + + Format of the screw parameters. Default: "moment" + X component of the direction vector of the screw axis. + Y component of the direction vector of the screw axis. + Z component of the direction vector of the screw axis. + X component of the moment vector or a point on the screw axis. + Y component of the moment vector or a point on the screw axis. + Z component of the moment vector or a point on the screw axis. + Rotation angle in radians. + Translation. + + + + Convert a screw into a dual quaternion. + Modified instance represents: Dual quaternion. + + Format of the screw parameters. Default: "moment" + X component of the direction vector of the screw axis. + Y component of the direction vector of the screw axis. + Z component of the direction vector of the screw axis. + X component of the moment vector or a point on the screw axis. + Y component of the moment vector or a point on the screw axis. + Z component of the moment vector or a point on the screw axis. + Rotation angle in radians. + Translation. + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + Composes two dual quaternions + + + Convert to pose + + + Convert to matrix + + + Conjugate a dual quaternion + + + Create a dual quaternion from eight double values + + + Create a dual quaternion from two quaternions + + + + Deserialize a serialized dual quaternion. + Modified instance represents: Dual quaternion. + + Handle of the serialized item. + + + Multiply two dual quaternions. + Left dual quaternion. + Right dual quaternion. + Product of the dual quaternions. + + + + Multiply two dual quaternions. + Instance represents: Left dual quaternion. + + Right dual quaternion. + Product of the dual quaternions. + + + Conjugate a dual quaternion. + Dual quaternion. + Conjugate of the dual quaternion. + + + + Conjugate a dual quaternion. + Instance represents: Dual quaternion. + + Conjugate of the dual quaternion. + + + + Interpolate two dual quaternions. + Instance represents: Dual quaternion as the start point of the interpolation. + + Dual quaternion as the end point of the interpolation. + Interpolation parameter. Default: 0.5 + Interpolated dual quaternion. + + + + Interpolate two dual quaternions. + Instance represents: Dual quaternion as the start point of the interpolation. + + Dual quaternion as the end point of the interpolation. + Interpolation parameter. Default: 0.5 + Interpolated dual quaternion. + + + Normalize a dual quaternion. + Unit dual quaternion. + Normalized dual quaternion. + + + + Normalize a dual quaternion. + Instance represents: Unit dual quaternion. + + Normalized dual quaternion. + + + + Convert a unit dual quaternion into a homogeneous transformation matrix. + Instance represents: Unit dual quaternion. + + Transformation matrix. + + + Convert a dual quaternion to a 3D pose. + Unit dual quaternion. + 3D pose. + + + + Convert a dual quaternion to a 3D pose. + Instance represents: Unit dual quaternion. + + 3D pose. + + + + Convert a unit dual quaternion into a screw. + Instance represents: Unit dual quaternion. + + Format of the screw parameters. Default: "moment" + X component of the direction vector of the screw axis. + Y component of the direction vector of the screw axis. + Z component of the direction vector of the screw axis. + X component of the moment vector or a point on the screw axis. + Y component of the moment vector or a point on the screw axis. + Z component of the moment vector or a point on the screw axis. + Rotation angle in radians. + Translation. + + + + Transform a 3D line with a unit dual quaternion. + Instance represents: Unit dual quaternion representing the transformation. + + Format of the line parameters. Default: "moment" + X component of the direction vector of the line. + Y component of the direction vector of the line. + Z component of the direction vector of the line. + X component of the moment vector or a point on the line. + Y component of the moment vector or a point on the line. + Z component of the moment vector or a point on the line. + X component of the direction vector of the transformed line. + Y component of the direction vector of the transformed line. + Z component of the direction vector of the transformed line. + X component of the moment vector or a point on the transformed line. + Y component of the moment vector or a point on the transformed line. + Z component of the moment vector or a point on the transformed line. + + + + Transform a 3D line with a unit dual quaternion. + Instance represents: Unit dual quaternion representing the transformation. + + Format of the line parameters. Default: "moment" + X component of the direction vector of the line. + Y component of the direction vector of the line. + Z component of the direction vector of the line. + X component of the moment vector or a point on the line. + Y component of the moment vector or a point on the line. + Z component of the moment vector or a point on the line. + X component of the direction vector of the transformed line. + Y component of the direction vector of the transformed line. + Z component of the direction vector of the transformed line. + X component of the moment vector or a point on the transformed line. + Y component of the moment vector or a point on the transformed line. + Z component of the moment vector or a point on the transformed line. + + + Convert a 3D pose to a unit dual quaternion. + 3D pose. + Unit dual quaternion. + + + + Convert a 3D pose to a unit dual quaternion. + Modified instance represents: Unit dual quaternion. + + 3D pose. + + + + Convert a screw into a dual quaternion. + Modified instance represents: Dual quaternion. + + Format of the screw parameters. Default: "moment" + X component of the direction vector of the screw axis. + Y component of the direction vector of the screw axis. + Z component of the direction vector of the screw axis. + X component of the moment vector or a point on the screw axis. + Y component of the moment vector or a point on the screw axis. + Z component of the moment vector or a point on the screw axis. + Rotation angle in radians. + Translation. + + + + Convert a screw into a dual quaternion. + Modified instance represents: Dual quaternion. + + Format of the screw parameters. Default: "moment" + X component of the direction vector of the screw axis. + Y component of the direction vector of the screw axis. + Z component of the direction vector of the screw axis. + X component of the moment vector or a point on the screw axis. + Y component of the moment vector or a point on the screw axis. + Z component of the moment vector or a point on the screw axis. + Rotation angle in radians. + Translation. + + + + Serialize a dual quaternion. + Instance represents: Dual quaternion. + + Handle of the serialized item. + + + Normal return value + + + TRUE + + + FALSE + + + Stop processing + + + Call failed + + + for internal use + + + operator was canceled for hdevengine + + + operator was generally cancelled + + + Wrong type of control parameter: 1 + + + Wrong type of control parameter: 2 + + + Wrong type of control parameter: 3 + + + Wrong type of control parameter: 4 + + + Wrong type of control parameter: 5 + + + Wrong type of control parameter: 6 + + + Wrong type of control parameter: 7 + + + Wrong type of control parameter: 8 + + + Wrong type of control parameter: 9 + + + Wrong type of control parameter: 10 + + + Wrong type of control parameter: 11 + + + Wrong type of control parameter: 12 + + + Wrong type of control parameter: 13 + + + Wrong type of control parameter: 14 + + + Wrong type of control parameter: 15 + + + Wrong type of control parameter: 16 + + + Wrong type of control parameter: 17 + + + Wrong type of control parameter: 18 + + + Wrong type of control parameter: 19 + + + Wrong type of control parameter: 20 + + + Wrong value of control parameter: 1 + + + Wrong value of control parameter: 2 + + + Wrong value of control parameter: 3 + + + Wrong value of control parameter: 4 + + + Wrong value of control parameter: 5 + + + Wrong value of control parameter: 6 + + + Wrong value of control parameter: 7 + + + Wrong value of control parameter: 8 + + + Wrong value of control parameter: 9 + + + Wrong value of control parameter: 10 + + + Wrong value of control parameter: 11 + + + Wrong value of control parameter: 12 + + + Wrong value of control parameter: 13 + + + Wrong value of control parameter: 14 + + + Wrong value of control parameter: 15 + + + Wrong value of control parameter: 16 + + + Wrong value of control parameter: 17 + + + Wrong value of control parameter: 18 + + + Wrong value of control parameter: 19 + + + Wrong value of control parameter: 20 + + + Wrong value of component + + + Wrong value of gray value component + + + Wrong number of values of ctrl.par.: 1 + + + Wrong number of values of ctrl.par.: 2 + + + Wrong number of values of ctrl.par.: 3 + + + Wrong number of values of ctrl.par.: 4 + + + Wrong number of values of ctrl.par.: 5 + + + Wrong number of values of ctrl.par.: 6 + + + Wrong number of values of ctrl.par.: 7 + + + Wrong number of values of ctrl.par.: 8 + + + Wrong number of values of ctrl.par.: 9 + + + Wrong number of values of ctrl.par.: 10 + + + Wrong number of values of ctrl.par.: 11 + + + Wrong number of values of ctrl.par.: 12 + + + Wrong number of values of ctrl.par.: 13 + + + Wrong number of values of ctrl.par.: 14 + + + Wrong number of values of ctrl.par.: 15 + + + Wrong number of values of ctrl.par.: 16 + + + Wrong number of values of ctrl.par.: 17 + + + Wrong number of values of ctrl.par.: 18 + + + Wrong number of values of ctrl.par.: 19 + + + Wrong number of values of ctrl.par.: 20 + + + Number of input objects too big + + + Wrong number of values of object par.: 1 + + + Wrong number of values of object par.: 2 + + + Wrong number of values of object par.: 3 + + + Wrong number of values of object par.: 4 + + + Wrong number of values of object par.: 5 + + + Wrong number of values of object par.: 6 + + + Wrong number of values of object par.: 7 + + + Wrong number of values of object par.: 8 + + + Wrong number of values of object par.: 9 + + + Number of output objects too big + + + Wrong specification of parameter (error in file: xxx.def) + + + Initialize Halcon: reset_obj_db(Width,Height,Components) + + + Used number of symbolic object names too big + + + No license found + + + Lost connection to license server + + + No modules in license (no VENDOR_STRING) + + + No license for this operator + + + Time zone offset from GMT is > 24 hours + + + Vendor keys do not support this platform + + + Bad vendor keys + + + Unknown vendor key type + + + malloc() call failed + + + Vendor keys have expired + + + Second call to lc_inti() (multiple jobs), and vendorkeys do not support multiple jobs + + + Vendor key data not supplied + + + lmclient.h/liblmgr.a version mismatch + + + Networking software not available on this machine + + + Old vendor keys supplied + + + License key in license file does not match other data in file + + + Encryption handshake with daemon failed + + + 'key' structure is incorrect type, or feature == NULL, or num_licenses == 0 + + + System clock has been set back + + + Version argument is invalid floating point format + + + License server busy starting another copy of itself + + + Cannot establish a connection with a license server + + + Feature is queued. lc_status will determine when it is available + + + Vendor keys do not support this function + + + Checkout request filtered by the vendor-defined filter routine + + + Checkout exceeds MAX specified in options file + + + All licenses in use + + + No license server specified for counted license + + + Can not find feature in the license file + + + Server has different license file than client - client's license has feature, but server's does not + + + License file does not support a version this new + + + This platform not authorized by license - running on platform not included in PLATFORMS list + + + License server busy + + + Could not find license.dat + + + Invalid license file syntax + + + Cannot connect to a license server + + + No TCP "license" service exists + + + No socket connection to license manager server + + + Invalid host + + + Feature has expired + + + Invalid date format in license file + + + Invalid returned data from license server + + + Cannot find SERVER hostname in network database + + + Cannot read data from license server + + + Cannot write data to license server + + + Error in select system call + + + Feature checkin failure detected at license + + + Users are queued for this feature + + + License server does not support this version of this feature + + + Request for more licenses than this feature supports + + + Cannot read /dev/kmem + + + Cannot read /vmunix + + + Cannot find ethernet device + + + Cannot read license file + + + Feature not yet available + + + No such attribute + + + Clock difference too large between client and server + + + Feature database corrupted in daemon + + + Duplicate selection mismatch for this feature + + + User/host on EXCLUDE list for feature + + + User/host not on INCLUDE list for feature + + + Feature was never checked out + + + Invalid FLEXlm key data supplied + + + Clock setting check not available in daemon + + + Date too late for binary format + + + FLEXlm not initialized + + + Server did not respond to message + + + Request rejected by vendor defined filter + + + No FEATURESET line present in license file + + + Incorrect FEATURESET line in license file + + + Cannot compute FEATURESET line + + + socket() call failed + + + setsockopt() failed + + + Message checksum failure + + + Cannot read license file from server + + + Not a license administrator + + + lmremove request too soon + + + Attempt to read beyond the end of LF path + + + SYS$SETIMR call failed + + + Internal FLEXlm Erro - Please report to Globetrotter Software + + + FLEXadmin API functions not avilable + + + Invalid PACKAGE line in license file + + + Server FLEXlm version older than client's + + + Incorrect number of USERS/HOSTS INCLUDED in options file + + + Server doesn't support this request + + + This license object already in use + + + Future license file format + + + Feature removed during lmreread + + + This feature is available in a different license pool + + + Network connect to THIS_HOST failed + + + Server node is down or not responding + + + The desired vendor daemon is down + + + The decimal format license is typed incorrectly + + + All licenses are reserved for others + + + Terminal Server remote client not allowed + + + Cannot borrow that long + + + License server out of network connections + + + Dongle not attached, or can't read dongle + + + Missing dongle driver + + + FLEXlock checkouts attempted + + + SIGN= attribute required + + + CRO not supported for this platform + + + BORROW failed + + + BORROW period has expired + + + FLOAT_OK license must have exactly one dongle hostid + + + Unable to delete local borrow info" + + + Returning borrowed license early not enabled + + + Returning borrowed license on server failed + + + Checkout just a PACKAGE failed + + + Composite Hostid not initialized + + + An item needed for Composite Hostid missing or invalid + + + Borrowed license doesn't match any known server license + + + Error enabling event log + + + Event logging is disabled + + + Error writing to event log + + + Timeout + + + Bad message command + + + Error writing to socket + + + Failed to generate version specific license + + + Vers.-specific signatures not supported + + + License template contains redundant signature specifiers + + + Invalid V71_LK signature + + + Invalid V71_SIGN signature + + + Invalid V80_LK signature + + + Invalid V80_SIGN signature + + + Invalid V81_LK signature + + + Invalid V81_SIGN signature + + + Invalid V81_SIGN2 signature + + + Invalid V84_LK signature + + + Invalid V84_SIGN signature + + + Invalid V84_SIGN2 signature + + + License key required but missing from the certificate + + + Bad AUTH={} signature + + + TS record invalid + + + Cannot open TS + + + Invalid Fulfillment record + + + Invalid activation request received + + + No fulfillment exists in trusted storage which matches the request + + + Invalid activation response received + + + Can't return the fulfillment + + + Return would exceed max count(s) + + + No repair count left + + + Specified operation is not allowed + + + User/host on EXCLUDE list for entitlement + + + User/host not in INCLUDE list for entitlement + + + Activation error + + + Invalid date format in trusted storage + + + Message encryption failed + + + Message decryption failed + + + Bad filter context + + + SUPERSEDE feature conflict + + + Invalid SUPERSEDE_SIGN syntax + + + SUPERSEDE_SIGN does not contain a feature name and license signature + + + ONE_TS_OK is not supported in this Windows Platform + + + Internal error + + + Only one terminal server remote client checkout is allowed for this feature + + + Internal error + + + Internal error + + + Internal error + + + More than one ethernet hostid not supported in composite hostid definition + + + The number of characters in the license file paths exceeds the permissible limit + + + Invalid TZ keyword syntax + + + Invalid time zone override specification in the client + + + The time zone information could not be obtained + + + License client time zone not authorized for license rights + + + Invalid syntax for VM_PLATFORMS keyword + + + Feature can be checked out from physical machine only + + + Feature can be checked out from virtual machine only + + + Vendor keys do not support Virtualization feature + + + Checkout request denied as it exceeds the MAX limit specified in the options file + + + Binding agent API - Internal error + + + Binding agent communication error + + + Invalid Binding agent version + + + Failed to load ServerQuery request + + + Failed to generate ServerQuery response + + + Invalid IP address used while overriding + + + No CodeMeter Runtime installed + + + Installed CodeMeter Runtime is too old + + + License is for wrong HALCON edition + + + License contains unknown FLAGS + + + HALCON preview version expired + + + Error codes concerning the HALCON core, 2100..2199 + + + Wrong index for output object parameter + + + Wrong index for input object parameter + + + Wrong index for image object + + + Wrong number region/image component + + + Wrong relation name + + + Access to undefined gray value component + + + Wrong image width + + + Wrong image height + + + Undefined gray value component + + + Inconsistent data of data base (typing) + + + Wrong index for input control parameter + + + Data of data base not defined (internal error) + + + legacy: Number of operators too big + + + User extension not properly installed + + + legacy: Number of packages too large + + + No such package installed + + + incompatible HALCON versions + + + incompatible operator interface + + + wrong extension package id + + + wrong operator id + + + wrong operator information id + + + Wrong Hctuple array type + + + Wrong Hcpar type + + + Wrong Hctuple index + + + Wrong version of file + + + Wrong handle type + + + wrong vector type + + + wrong vector dimension + + + Wrong (unknown) HALCON handle + + + Wrong HALCON id, no data available + + + HALCON id out of range + + + Handle is NULL + + + Handle was cleared + + + Handle type does not serialize + + + hlibxpi Init function of an extension * that was build with xpi was not * called + + + hlib didn't find the init function * of the extension it is connecting to * -> old extension without hlibxpi or * the function export failed + + + Unresolved function in hlibxpi + + + HALCON extension requires a HALCON * version that is newer than the * connected hlib + + + the (major) version of the hlibxpi * which is used by the connecting * extension is too small for hlib + + + the major version of the hlibxpi * which is used by the hlib is too * small + + + the minor version of the hlibxpi * which is used by the hlib is too * small + + + Wrong major version in symbol struct * (internal: should not happen) + + + HLib version could not be detected + + + Wrong hardware information file format + + + Wrong hardware information file version + + + Error while reading the hardware knowledge + + + Error while writing the hardware knowledge + + + Tag not found + + + No CPU Info + + + No AOP Info + + + No AOP Info for this HALCON variant + + + No AOP Info for this HALCON architecture + + + No AOP Info for specified Operator found + + + undefined AOP model + + + wrong tag derivate + + + internal error + + + hw check was canceled + + + Wrong access to global variable + + + Used global variable does not exist + + + Used global variable not accessible via GLOBAL_ID + + + Halcon server to terminate is still working on a job + + + No such HALCON software agent + + + Hardware check for parallelization not possible on a single-processor machine + + + (Seq.) HALCON does not support parallel hardware check (use Parallel HALCON instead) + + + Initialization of agent failed + + + Termination of agent failed + + + Inconsistent hardware description file + + + Inconsistent agent information file + + + Inconsistent agent knowledge file + + + The file with the parallelization information does not match to the currently HALCON version/revision + + + The file with the parallelization information does not match to the currently used machine + + + Inconsistent knowledge base of HALCON software agent + + + Unknown communication type + + + Unknown message type for HALCON software agent + + + Error while saving the parallelization knowledge + + + Wrong type of work information + + + Wrong type of application information + + + Wrong type of experience information + + + Unknown name of HALCON software agent + + + Unknown name and communication address of HALCON software agent + + + cpu representative (HALCON software agent) not reachable + + + cpu refuses work + + + Description of scheduling resource not found + + + Not accessible function of HALCON software agent + + + Wrong type: HALCON scheduling resource + + + Wrong state: HALCON scheduling resource + + + Unknown parameter type: HALCON scheduling resource + + + Unknown parameter value: HALCON scheduling resource + + + Wrong post processing of control parameter + + + Error while trying to get time + + + Error while trying to get the number of processors + + + Error while accessing temporary file + + + message queue wait operation canceled + + + message queue overflow + + + Threads still wait on message queue while * clearing it. + + + Invalid file format for a message + + + Dict does not contain requested key + + + Incorrect tuple length in dict + + + Incorrect tuple type in dict + + + Error while forcing a context switch + + + Error while accessing cpu affinity + + + Error while setting cpu affinity + + + wrong synchronization object + + + wrong operator call object + + + input object not initialized + + + input control not initialized + + + output object not initialized + + + output control not initialized + + + Creation of pthread failed + + + pthread-detach failed + + + pthread-join failed + + + Initialization of mutex variable failed + + + Deletion of mutex variable failed + + + Lock of mutex variable failed + + + Unlock of mutex variable failed + + + Failed to signal pthread condition var. + + + Failed to wait for pthread cond. var. + + + Failed to init pthread condition var. + + + Failed to destroy pthread condition var. + + + Failed to signal event. + + + Failed to wait for event. + + + Failed to init event. + + + Failed to destroy event. + + + Failed to create a tsd key. + + + Failed to set a thread specific data key. + + + Failed to get a tsd key. + + + Failed to free a tsd key. + + + Aborted waiting at a barrier + + + 'Free list' is empty while scheduling + + + Communication partner not checked in + + + The communication system can't be started while running + + + Communication partner not checked in + + + Initialization of Barrier failed + + + Waiting at a barrier failed + + + Destroying of an barrier failed + + + Region completely outside of the image domain + + + Region (partially) outside of the definition range of the image + + + Intersected definition range region/image empty + + + Image with empty definition range + + + No common image point of two images + + + Wrong region for image (first row < 0) + + + Wrong region for image (column in last row >= image width) + + + Number of images unequal in input pars. + + + Image height too small + + + Image width too small + + + Internal error: Multiple call of HRLInitSeg() + + + Internal error: HRLSeg() not initialized + + + Wrong size of filter for Gauss + + + Filter size exceeds image size + + + Filter size evan + + + Filter size to big + + + Region is empty + + + Domains of the input images differ + + + Row value of a coordinate > 2^15-1 (XL: 2^31 - 1) + + + Row value of a coordinate < -2^15 (XL: -2^31) + + + Column value of a coordinate > 2^15-1 (XL: 2^31 - 1) + + + Column value of a coordinate < -2^15 (XL: -2^31) + + + Wrong segmentation threshold + + + Unknown feature + + + Unknown gray value feature + + + Internal error in HContCut + + + Error in HContToPol: distance of points too big + + + Error in HContToPol: contour too long + + + Too many rows (IPImageTransform) + + + Scaling factor = 0.0 (IPImageScale) + + + Wrong range in transformation matrix + + + Internal error in IPvvf: no element free + + + Number of input objects is zero + + + At least one input object has an empty region + + + Operation allowed for rectangular images 2**n only + + + Too many relevant points (IPHysterese) + + + Number of labels in image too big + + + No labels with negative values allowed + + + Wrong filter size (too small ?) + + + Images with different image size + + + Target image too wide or too far on the right + + + Target image too narrow or too far on the left + + + Target image too high or too far down + + + Target image too low or too far up + + + Number of channels in the input parameters are different + + + Wrong color filter array type + + + Wrong color filter array interpolation + + + Homogeneous matrix does not represent an affine transformation + + + Inpainting region too close to the image border + + + source and destination differ in size + + + to many features + + + Reflection axis undefined + + + Coocurrence Matrix: Too little columns for quantisation + + + Coocurrence Matrix: Too little rows for quantisation + + + Wrong number of columns + + + Wrong number of rows + + + Number has too many digits + + + Matrix is not symmetric + + + Matrix is too big + + + Wrong structure of file + + + Less than 2 matrices + + + Not enough memory + + + Can not read the file + + + Can not open file for writing + + + Too many lookup table colors + + + Too many Hough points (lines) + + + Target image has got wrong height (not big enough) + + + Wrong interpolation mode + + + Region not compact or not connected + + + Wrong filter index for filter size 3 + + + Wrong filter index for filter size 5 + + + Wrong filter index for filter size 7 + + + Wrong filter size; only 3/5/7 + + + Number of suitable pixels too small to reliably estimate the noise + + + Different number of entries/exits in HContCut + + + Reference to contour is missing + + + Wrong XLD type + + + Border point is set to FG + + + Maximum contour length exceeded + + + Maximum number of contours exceeded + + + Contour too short for fetch_angle_xld + + + Regression parameters of contours already computed + + + Regression parameters of contours not yet entered! + + + Data base: XLD object has been deleted + + + Data base: Object has no XLD-ID + + + Wrong number of contour points allocated + + + Contour attribute not defined + + + Ellipse fitting failed + + + Circle fitting failed + + + All points classified as outliers (ClippingFactor too small or used points not similar to primitive) + + + Quadrangle fitting failed + + + No points for at least one rectangle side + + + A contour point lies outside of the image + + + Not enough points for model fitting + + + No ARC/INFO world file + + + No ARC/INFO generate file + + + Unexpected end of file while reading DXF file + + + Cannot read DXF-group code from file + + + Inconsistent number of attributes per point in DXF file + + + Inconsistent number of attributes and names in DXF file + + + Inconsistent number of global attributes and names in DXF file + + + Cannot read attributes from DXF file + + + Cannot read global attributes from DXF file + + + Cannot read attribute names from DXF file + + + Wrong generic parameter name + + + Internal DXF I/O error: Wrong data type + + + Isolated point while contour merging + + + Constraints cannot be fulfilled + + + No segment in contour + + + Only one or no point in template contour + + + Syntax error in file for training + + + Maximum number of attributes per example exceeded + + + Not possible to open file for training + + + Too many data sets for training + + + Too many examples for one data set for training + + + Too many classes + + + Maximum number of cuboids exceeded + + + Not possible to open classificator's file + + + Error while saving the classificator + + + Not possible to open protocol file + + + Classificator with this name is already existent + + + Maximum number of classificators exceeded + + + Name of classificator is too long, >= 20 + + + Classificator with this name is not existent + + + Current classificator is not defined + + + Wrong id in classification file + + + The version of the classifier is not supported + + + Serialized item does not contain a valid classifier + + + Text model does not contain a classifier yet (use set_text_model_param) + + + Adding new features is not possible, because the dataset has been normalized during training. Please create a new classfier and add all training data again or disable normalization during training. + + + Invalid file format for GMM training samples + + + The version of the GMM training samples is not supported + + + Wrong training sample file format + + + nvalid file format for Gaussian Mixture Model (GMM) + + + The version of the Gaussian Mixture Model (GMM) is not supported + + + Unknown error when training GMM + + + Collapsed covariance matrix + + + No samples for at least one class + + + Too few samples for at least one class + + + GMM is not trained + + + GMM has no training data + + + Serialized item does not contain a valid Gaussian Mixture Model (GMM) + + + Unknown output function + + + Target not in 0-1 encoding + + + No training samples stored in the classifier + + + Invalid file format for MLP training samples + + + The version of the MLP training samples is not supported + + + Wrong training sample format + + + MLP is not a classifier + + + Invalid file format for multilayer perceptron (MLP) + + + The version of the multilayer perceptron (MLP) is not supported + + + Wrong number of channels + + + Wrong number of MLP parameters + + + Serialized item does not contain a valid multilayer perceptron (MLP) + + + The number of image channels and the number of dimensions of the look-up table do not match + + + A look-up table can be build for 2 or 3 channels only + + + Cannot create look-up table. Please choose a larger 'bit_depth' or select the 'fast' 'class_selection'. + + + No training samples stored in the classifier + + + Invalid file format for SVM training samples + + + The version of the SVM training samples is not supported + + + Wrong training sample format + + + Invalid file format for support vector machine (SVM) + + + The version of the support vector machine (SVM) is not supported + + + Wrong number of classes + + + Chosen nu is too big + + + SVM Training failed + + + SVMs do not fit together + + + No SV in SVM to add to training + + + Kernel must be RBF + + + Not all classes contained in training data + + + SVM not trained + + + Classifier not trained + + + Serialized item does not contain a valid support vector machine (SVM) + + + Wrong rotation number + + + Wrong letter for Golay element + + + Wrong reference point + + + Wrong number of iterations + + + Mophology: system error + + + Wrong type of boundary + + + Morphology: Wrong number of input obj. + + + Morphology: Wrong number of output obj. + + + Morphology: Wrong number of input control parameter + + + Morphology: Wrong number of output control parameter + + + Morphology: Struct. element is infinite + + + Morphology: Wrong name for struct. elem. + + + Wrong number of run length rows (chords): smaller than 0 + + + Number of chords too big, increase * current_runlength_number using set_system + + + Run length row with negative length + + + Run length row >= image height + + + Run length row < 0 + + + Run length column >= image width + + + Lauflaengenspalte < 0 + + + For CHORD_TYPE: Number of row too big + + + For CHORD_TYPE: Number of row too small + + + For CHORD_TYPE: Number of column too big + + + Exceeding the maximum number of run lengths while automatical expansion + + + Region->compl neither TRUE/FALSE + + + Region->max_num < Region->num + + + Number of chords too big for num_max + + + Operator cannot be implemented for complemented regions + + + Image width < 0 + + + Image width >= MAX_FORMAT + + + Image height <= 0 + + + Image height >= MAX_FORMAT + + + Image width <= 0 + + + Image height <= 0 + + + Too many segments + + + INT8 images are available on 64 bit systems only + + + Point at infinity cannot be converted to a Euclidean point + + + Covariance matrix could not be determined + + + RANSAC algorithm didn't find enough point correspondences + + + RANSAC algorithm didn't find enough point correspondences + + + Internal diagnosis: fallback method had to be used + + + Projective transformation is singular + + + Mosaic is under-determined + + + Input covariance matrix is not positive definite + + + The number of input points too large. + + + Inconsistent number of point correspondences. + + + No path from reference image to one or more images. + + + Image with specified index does not exist. + + + Matrix is not a camera matrix. + + + Skew is not zero. + + + Illegal focal length. + + + Kappa is not zero. + + + It is not possible to determine all parameters for in the variable case. + + + No valid implementation selected. + + + Kappa can only be determined with the gold-standard method for fixed camera parameters. + + + Conflicting number of images and projection mode. + + + Error in projection: Point not in any cube map. + + + No solution found. + + + Tilt is not zero. + + + Illegal combination of parameters and estimation method. + + + No suitable contours found + + + No stable solution found + + + Instable solution found + + + Not enough contours for calibration + + + Invalid file format for FFT optimization data + + + The version of the FFT optimization data is not supported + + + Optimization data was created with a different HALCON version (Standard HALCON / Parallel HALCON) + + + Storing of the optimization data failed + + + Serialized item does not contain valid FFT optimization data + + + Invalid disparity range for binocular_disparity_ms method + + + Epipoles are situated within the image domain + + + Fields of view of both cameras do not intersect each other + + + Rectification impossible + + + Wrong type of target_thickness parameter + + + Wrong type of thickness_tolerance parameter + + + Wrong type of position_tolerance parameter + + + Wrong type of sigma parameter + + + Wrong value of sigma parameter + + + Wrong type of threshold parameter + + + Wrong value of target_thickness parameter + + + Wrong value of thickness_tolerance parameter + + + Wrong value of position_tolerance parameter + + + Wrong value of threshold parameter + + + Wrong type of refinement parameter + + + Wrong value of refinement parameter + + + Wrong type of resolution parameter + + + Wrong type of resolution parameter + + + Wrong type of polarity parameter + + + Wrong type of polarity parameter + + + No sheet-of-light model available + + + Wrong input image size (width) + + + Wrong input image size (height) + + + profile region does not fit the domain of definition of the input image + + + Calibration extend not set + + + Undefined disparity image + + + Undefined domain for disparity image + + + Undefined camera parameter + + + Undefined pose of the lightplane + + + Undefined pose of the camera coordinate system + + + Undefined transformation from the camera to the lightplane coordinate system + + + Undefined movement pose for xyz calibration + + + Wrong value of scale parameter + + + Wrong parameter name + + + Wrong type of parameter method + + + Wrong type of parameter ambiguity + + + Wrong type of parameter score + + + Wrong type of parameter calibration + + + Wrong type of parameter number_profiles + + + Wrong type of element in parameter camera_parameter + + + Wrong type of element in pose + + + Wrong value of parameter method + + + Wrong type of parameter min_gray + + + Wrong value of parameter ambiguity + + + Wrong value of parameter score_type + + + Wrong value of parameter calibration + + + Wrong value of parameter number_profiles + + + Wrong type of camera + + + Wrong number of values of parameter camera_parameter + + + Wrong number of values of pose + + + Calibration target not found + + + The calibration algorithm failed to find a valid solution. + + + Wrong type of parameter calibration_object + + + Invalid calibration object + + + No calibration object set + + + Invalid file format for sheet-of-light model + + + The version of the sheet-of-light model is not supported + + + Camera type not supported by calibrate_sheet_of_light_model + + + Parameter does not match the set 'calibration' + + + The gray values of the disparity image do not fit the height of the camera + + + Wrong texture inspection model type + + + Texture Model is not trained + + + Texture Model has no training data + + + Invalid file format for Texture inspection model + + + The version of the Texture inspection model is not supported + + + Wrong training sample file format + + + The version of the training sample file is not supported + + + At least one of the images is too small + + + The samples do not match the current texture model + + + No images within the texture model + + + The light source positions are linearly dependent + + + No sufficient image indication + + + Internal error: Function has equal signs in HZBrent + + + Kalman: Dimension n,m or p has got a undefined value + + + Kalman: File does not exist + + + Kalman: Error in file (row of dimension) + + + Kalman: Error in file (row of marking) + + + Error in file (value is no float) + + + Kalman: Matrix A is missing in file + + + Kalman: In Datei fehlt Matrix C + + + Kalman: Matrix Q is missing in file + + + Kalman: Matrix R is missing in file + + + Kalman: G or u is missing in file + + + Kalman: Covariant matrix is not symmetric + + + Kalman: Equation system is singular + + + structured light model is not in persistent mode + + + the min_stripe_width is too large for the chosen pattern_width or pattern_height + + + the single_stripe_width is too large for the chosen pattern_width or pattern_height + + + min_stripe_width has to be smaller than single_stripe_width. + + + single_stripe_width is too small for min_stripe_width. + + + The SLM is not prepared for decoding. + + + The SLM does not contain the queried object. + + + The version of the structured light model is not supported + + + Invalid file format for a structured light model + + + Wrong pattern type + + + The SLM is not decoded. + + + Wrong model type + + + Object is a object tupel + + + Object has been deleted already + + + Wrong object-ID + + + Object tupel has been deleted already + + + Wrong object tupel-ID + + + Object tupel is a object + + + Object-ID is NULL (0) + + + Object-ID outside the valid range + + + Access to deleted image + + + Access to image with wrong key + + + Access to deleted region + + + Access to region with wrong key + + + Wrong value for image channel + + + Index too big + + + Index not defined + + + No OpenCL available + + + OpenCL Error occured + + + No compute devices available + + + No device implementation for this parameter + + + Out of device memory + + + Invalid work group shape + + + Invalid compute device + + + CUDA Error occured + + + cuDNN Error occured + + + cuBLAS Error occured + + + Set batch_size not supported + + + CUDA implementations not available + + + Unsupported version of cuDNN + + + Requested feature not supported by cuDNN + + + CUDA driver is out-of-date + + + Error occurred in HCPUDNN library + + + Training is unsupported with the selected runtime. Please switch to 'gpu' runtime. + + + CPU based inference is not supported on this platform + + + ACL error ocurred + + + Internal visualization error + + + Unexpected color type + + + Number of color settings exceeded + + + Wrong (logical) window number + + + Error while opening the window + + + Wrong window coordinates + + + It is not possible to open another window + + + Device resp. operator not available + + + Unknown color + + + No window has been opened for desired action + + + Wrong filling mode for regions + + + Wrong gray value (0..255) + + + Wrong pixel value + + + Wrong line width + + + Wrong name of cursor + + + Wrong color table + + + Wrong representation mode + + + Wrong representation color + + + Wrong dither matrix + + + Wrong image transformation + + + Unsuitable image type for image trafo. + + + Wrong zooming factor for image trafo. + + + Wrong representation mode + + + Wrong code of device + + + Wrong number for father window + + + Wrong window size + + + Wrong window type + + + No current window has been set + + + Wrong color combination or range (RGB) + + + Wrong number of pixels set + + + Wrong value for comprise + + + set_fix with 1/4 image levels and static not valid + + + set_lut not valid in child windows + + + Number of concurrent used color tables is too big + + + Wrong device for window dump + + + Wrong window size for window dump + + + System variable DISPLAY not defined + + + Wrong thickness for window margin + + + System variable DISPLAY has been set wrong (<host>:0.0) + + + Too many fonts loaded + + + Wrong font name + + + No valid cursor position + + + Window is not a textual window + + + Window is not a image window + + + String too long or too high + + + Too little space in the window rightw. + + + Window is not suitable for the mouse + + + Here Windows on a equal machine is permitted only + + + Wrong mode while opening a window + + + Wrong window mode for operation + + + Operation not possible with fixed pixel + + + Color tables for 8 image levels only + + + Wrong mode for pseudo real colors + + + Wrong pixel value for LUT + + + Wrong image size for pseudo real colors + + + Error in procedure HRLUT + + + Wrong number of entries in color table for set_lut + + + Wrong values for image area + + + Wrong line pattern + + + Wrong number of parameters for line pattern + + + Wrong number of colors + + + Wrong value for mode of area creation + + + Spy window is not set (set_spy) + + + No file for spy has been set (set_spy) + + + Wrong parameter output depth (set_spy) + + + Wrong window size for window dump + + + Wrong color table: Wrong file name or query_lut() + + + Wrong color table: Empty string ? + + + Using this hardware set_lut('default') is allowed only + + + Error while calling online help + + + Row can not be projected + + + Operation is unsuitable using a computer with fixed color table + + + Computer represents gray scales only + + + LUT of this display is full + + + Internal error: wrong color code + + + Wrong type for window attribute + + + Wrong name for window attribute + + + negativ height of area (or 0) + + + negativ width of area (or 0) + + + Window not completely visible + + + Font not allowed for this operation + + + Window was created in different thread + + + Drawing object already attached to another window + + + Internal error: only RGB-Mode + + + No more (image-)windows available + + + Depth was not stored with window + + + Object index was not stored with window + + + Operator does not support primitives without point coordinates + + + Maximum image size for Windows Remote Desktop exceeded + + + No OpenGL support available + + + No depth information available + + + OpenGL error + + + Required framebuffer object is unsupported + + + OpenGL accelerated hidden surface removal not supported on this machine + + + Invalid window parameter + + + Invalid value for window parameter + + + Unknown mode + + + No image attached + + + invalid navigation mode + + + Internal file error + + + Error while file synchronisation + + + insufficient rights + + + Bad file descriptor + + + File not found + + + Error while writing image data (sufficient memory ?) + + + Error while writing image descriptor (sufficient memory ?) + + + Error while reading image data (format of image too small ?) + + + Error while reading image data (format of image too big ?) + + + Error while reading image descriptor: File too small + + + Image matrices are different + + + Help file not found (setenv HALCONROOT) + + + Help index not found (setenv HALCONROOT) + + + File <standard_input> can not be closed + + + <standard_output/error> can not be closed + + + File can not be closed + + + Error while writing to file + + + Exceeding of maximum number of files + + + Wrong file name + + + Error while opening the file + + + Wrong file mode + + + Wrong type for pixel (e.g. byte) + + + Wrong image width (too big ?) + + + Wrong image height (too big ?) + + + File already exhausted before reading an image + + + File exhausted before terminating the image + + + Wrong value for resolution (dpi) + + + Wrong output image size (width) + + + Wrong output image size (height) + + + Wrong number of parameter values: Format description + + + Wrong parameter name for operator + + + Wrong slot name for parameter + + + Operator class is missing in help file + + + Wrong or inconsistent help/ *.idx or help/ *.sta + + + File help/ *.idx not found + + + File help/ *.sta not found + + + Inconsistent file help/ *.sta + + + No explication file (.exp) found + + + No file found in known graphic format + + + Wrong graphic format + + + Inconsistent file halcon.num + + + File with extension 'tiff' is no Tiff-file + + + Wrong file format + + + gnuplot could not be started + + + Output file for gnuplot could not be opened + + + Not a valid gnuplot output stream + + + No PNM format + + + Inconsistent or old help file + + + Invalid file encoding + + + File not open + + + No files in use so far (none opened) + + + Invalid file format for regions + + + Error while reading region data: Format of region too big. + + + Encoding for binary files not allowed + + + Serial port not open + + + No serial port available + + + Could not open serial port + + + Could not close serial port + + + Could not get serial port attributes + + + Could not set serial port attributes + + + Wrong baud rate for serial connection + + + Wrong number of data bits for serial connection + + + Wrong flow control for serial connection + + + Could not flush serial port + + + Error during write to serial port + + + Error during read from serial port + + + Serialized item does not contain valid regions. + + + The version of the regions is not supported. + + + Serialized item does not contain valid images. + + + The version of the images is not supported. + + + Serialized item does not contain valid XLD objects. + + + The version of the XLD objects is not supported. + + + Serialized item does not contain valid objects. + + + The version of the objects is not supported. + + + XLD object data can only be read by HALCON XL + + + Unexpected object detected + + + File has not been opened in text format + + + File has not been opened in binary file format + + + Cannot create directory + + + Cannot remove directory + + + Cannot get current directory + + + Cannot set current directory + + + Need to call XInitThreads() + + + No image acquisition device opened + + + IA: wrong color depth + + + IA: wrong device + + + IA: determination of video format not possible + + + IA: no video signal + + + Unknown image acquisition device + + + IA: failed grabbing of an image + + + IA: wrong resolution chosen + + + IA: wrong image part chosen + + + IA: wrong pixel ratio chosen + + + IA: handle not valid + + + IA: instance not valid (already closed?) + + + Image acquisition device could not be initialized + + + IA: external triggering not supported + + + IA: wrong camera input line (multiplex) + + + IA: wrong color space + + + IA: wrong port + + + IA: wrong camera type + + + IA: maximum number of acquisition device classes exceeded + + + IA: device busy + + + IA: asynchronous grab not supported + + + IA: unsupported parameter + + + IA: timeout + + + IA: invalid gain + + + IA: invalid field + + + IA: invalid parameter type + + + IA: invalid parameter value + + + IA: function not supported + + + IA: incompatible interface version + + + IA: could not set parameter value + + + IA: could not query parameter setting + + + IA: parameter not available in current configuration + + + IA: device could not be closed properly + + + IA: camera configuration file could not be opened + + + IA: unsupported callback type + + + IA: device lost + + + IA: grab aborted + + + IO: timeout + + + IO: incompatible interface version + + + IO: handle not valid + + + IO: device busy + + + IO: insufficient user rights + + + IO: device or channel not found + + + IO: invalid parameter type + + + IO: invalid parameter value + + + IO: invalid parameter number + + + IO: unsupported parameter + + + IO: parameter not available in curr config. + + + IO: function not supported + + + IO: maximum number of dio classes exceeded + + + IO: driver of io device not available + + + IO: operation aborted + + + IO: invalid data type + + + IO: device lost + + + IO: could not set parameter value + + + IO: could not query parameter setting + + + IO: device could not be closed properly + + + Image type is not supported + + + Invalid pixel format passed to filter function + + + Internal JpegXR error. + + + Syntax error in output format string + + + Maximum number of channels exceeded + + + Unspecified error in JXR library + + + Bad magic number in JXR library + + + Feature not implemented in JXR library + + + File read/write error in JXR library + + + Bad file format in JXR library + + + Error while closing the image file + + + Error while opening the image file + + + Premature end of the image file + + + Image dimensions too large for this file format + + + Image too large for this HALCON version + + + Too many iconic objects for this file format + + + File format is unsupported + + + File is no PCX-File + + + Unknown encoding + + + More than 4 image plains + + + Wrong magic in color table + + + Wrong number of bytes in span + + + Wrong number of bits/pixels + + + Wrong number of plains + + + File is no GIF-File + + + GIF: Wrong version + + + GIF: Wrong descriptor + + + GIF: Wrong color table + + + GIF: Premature end of file + + + GIF: Wrong number of images + + + GIF: Wrong image extension + + + GIF: Wrong left top width + + + GIF: Cyclic index of table + + + GIF: Wrong image data + + + File is no Sun-Raster-File + + + Wrong header + + + Wrong image width + + + Wrong image height + + + Wrong color map + + + Wrong image data + + + Wrong type of pixel + + + Wrong type of pixel + + + Wrong visual class + + + Wrong X10 header + + + Wrong X11 header + + + Wrong X10 colormap + + + Wrong X11 colormap + + + Wrong pixmap + + + Unknown version + + + Error while reading an image + + + Error while reading a file + + + Wrong colormap + + + Too many colors + + + Wrong photometric interpretation + + + Wrong photometric depth + + + Image is no binary file + + + Unsupported TIFF format + + + Wrong file format specification + + + TIFF file is corrupt + + + Required TIFF tag is missing + + + File is no BMP-File + + + Premature end of file + + + Incomplete header + + + Unknown bitmap format + + + Unknown compression format + + + Wrong color table + + + Write error on output + + + File does not contain a binary image + + + Wrong number of components in image + + + Unknown error from libjpeg + + + Not implemented feature in libjpeg + + + File access error in libjpeg + + + Tmp file access error in libjpeg + + + Memory error in libjpeg + + + Error in input image + + + File is not a PNG file + + + Unknown interlace type + + + Unsupported color type + + + Image is no binary file + + + Image size too big + + + File corrupt + + + Image precision too high + + + Error while encoding + + + Image size too big + + + File does not contain only images + + + Socket can not be set to block + + + Socket can not be set to unblock + + + Received data is no tuple + + + Received data is no image + + + Received data is no region + + + Received data is no xld object + + + Error while reading from socket + + + Error while writing to socket + + + Illegal number of bytes with get_rl + + + Buffer overflow in read_data + + + Socket can not be created + + + Bind on socket failed + + + Socket information is not available + + + Socket cannot listen for incoming connections + + + Connection could not be accepted + + + Connection request failed + + + Hostname could not be resolved + + + Unknown tuple type on socket + + + Timeout occured on socket + + + No more sockets available + + + Socket is not initialized + + + Invalid socket + + + Socket is NULL + + + Received data type is too large + + + Wrong socket type. + + + Received data is not packed. + + + Socket parameter operation failed. + + + The data does not match the format specification. + + + Invalid format specification. + + + Received data is no serialized item + + + Too many contours/polygons for this file format + + + The version of the quaternion is not supported + + + Serialized item does not contain a valid quaternion + + + The version of the homogeneous matrix is not supported + + + Serialized item does not contain a valid homogeneous matrix + + + The version of the homogeneous 3D matrix is not supported + + + Serialized item does not contain a valid homogeneous 3D matrix + + + The version of the tuple is not supported + + + Serialized item does not contain a valid tuple + + + Tuple data can only be read on 64-bit systems + + + The version of the camera parameters (pose) is not supported + + + Serialized item does not contain valid camera parameters (pose) + + + The version of the internal camera parameters is not supported + + + Serialized item does not contain valid internal camera parameters + + + The version of the dual quaternion is not supported + + + Serialized item does not contain a valid dual quaternion + + + Access to undefined memory area + + + Not enough memory available + + + Memory partition on heap has been overwritten + + + HAlloc: 0 bytes requested + + + Tmp-memory management: Call freeing memory although nothing had been allocated + + + Tmp-memory management: Null pointer while freeing + + + Tmp-memory management: Could not find memory element + + + memory management: wrong memory type + + + Not enough video memory available + + + No memory block allocated at last + + + System parameter for memory-allocation inconsistent + + + Invalid alignement + + + Process creation failed + + + Wrong index for output control par. + + + Wrong number of values: Output control parameter + + + Wrong type: Output control parameter + + + Wrong data type for object key (input objects) + + + Range for integer had been passed + + + Inconsistent Halcon version + + + Not enough memory for strings allocated + + + Internal error: Proc is NULL + + + Unknown symbolic object key (input obj.) + + + Wrong number of output object parameter + + + Output type <string> expected + + + Output type <long> expected + + + Output type <float> expected + + + Object parameter is a zero pointer + + + Tupel had been deleted; values are not valid any more + + + CNN: Internal data error + + + CNN: Invalid memory type + + + CNN: Invalid data serialization + + + CNN: Implementation not available + + + CNN: Wrong number of input data + + + CNN: Invalid implementation type + + + CNN: Training is not supported in the current environment. + + + For this operation a GPU with certain minimal requirements is required. See installation guide for details. + + + For this operation the CUDA library needs to be available. (See installation guide for details.) + + + OCR File: Error while reading classifier + + + Wrong generic parameter name + + + One of the parameters returns several values and has to be used exclusively + + + Wrong generic parameter name + + + Invalid labels. + + + OCR File: Wrong file version + + + Invalid classes: At least one class apears twice + + + For this operation the cuBLAS library needs to be available. (See installation guide for details.) + + + For this operation the CUDNN library needs to be available. (See installation guide for details.) + + + File 'find_text_support.hotc' not found (please place this file in the ocr subdirectory of the root directory of your HALCON installation or in the current working directory) + + + Training step failed. This might be caused by unsuitable training parameters + + + Weights in Graph have been overwritten previously and are lost. + + + New input size is too small to produce meaningful features + + + Result is not available. + + + New number of channels must be either 1 or 3. + + + New input number of channels can't be set to 3 if network is specified for number of channels 1 + + + Device batch size larger than batch size. + + + Invalid specification of a parameter. + + + Memory size exceeds maximal allowed value. + + + New batch size causes integer overflow + + + Invalid input image size for detection model + + + Invalid parameter value \ for current layer + + + Invalid parameter num \ for current layer + + + Invalid parameter type \ for current layer + + + Graph: Internal error + + + Graph: Invalid data serialization + + + Graph: Invalid index + + + HCNNGraph: Internal error + + + HCNNGraph: Invalid data serialization + + + HCNNGraph: Invalid layer specification + + + HCNNGraph: Graph not properly initialized + + + CNN-Graph: Invalid memory type + + + CNN-Graph: Invalid number of layers + + + CNN-Graph: Invalid index + + + CNN-Graph: Invalid specification status + + + CNN-Graph: Graph is not allowed to be changed after initialization + + + CNN-Graph: Missing preprocessing + + + CNN-Graph: Invalid vertex degree + + + CNN-Graph: Invalid output shape + + + CNN-Graph: Invalid specification + + + CNN-Graph: Invalid graph definition + + + CNN-Graph: Architecture not suitable for the adaption of the number of output classes + + + CNN-Graph: Architecture not suitable for the adaption of the image size" + + + DL: Error writing file + + + DL: Error reading file + + + DL: Wrong file version + + + DL: Inputs missing in input dict + + + DL: Inputs have incorrect batch size + + + DL: Invalid layer name + + + DL: Duplicate layer name + + + DL: Invalid output layer + + + DL: Parameter is not available + + + DL: Tuple inputs have incorrect length + + + DL: Tuple inputs have incorrect type + + + DL: Some inputs have incorrect values + + + DL: Some class ids are not unique + + + DL: Some class ids are invalid + + + DL: Input data of class id conversion is invalid. + + + DL: Type already defined + + + DL: Cannot identify inference inputs. + + + DL: Some class ids overlap with ignore class ids. + + + DL: Wrong number of output layer + + + DL: Batch size multiplier needs to be greater than 0 + + + DL: Inputs have incorrect batch size. The number of needed inputs is defined by batch_size * batch_size_multiplier + + + DL: Wrong scales during FPN creation + + + DL: Backbone unusable for FPN creation + + + DL: Backbone feature maps not divisible by 2 + + + DL: Internal error using anchors + + + DL: Invalid detector parameter + + + DL: Invalid detector parameter value + + + DL: Invalid docking layer + + + DL: Invalid detection type + + + apply_dl_model: no default outputs allowed + + + DLModule is not loaded + + + Unknown operator name + + + register_comp_used is not activated + + + Unknown operator class + + + convol/mask: Error while opening file + + + convol/mask: Premature end of file + + + convol/mask: Conversion error + + + convol/mask: Wrong row-/column number + + + convol/mask: Mask size overflow + + + convol/mask: Too many elements entered + + + convol: Wrong margin type + + + convol: No mask object has got empty region + + + convol: Weight factor is 0 + + + convol: Inconsistent number of weights + + + rank: Wrong rank value + + + convol/rank: Error while handling margin + + + Error while parsing filter mask file + + + Wrong number of coefficients for convolution (sigma too big?) + + + No valid ID for data set + + + No data set active (set_bg_esti) + + + ID already used for data set + + + No data set created (create_bg_esti) + + + Not possible to pass an object list + + + Image has other size than the background image in data set + + + Up-date-region is bigger than background image + + + Number of statistic data sets is too small + + + Wrong value for adapt mode + + + Wrong value for frame mode + + + Number of point corresponcences too small + + + Invalid method + + + Maximum number of fonts exceeded + + + Wrong ID (Number) for font + + + OCR internal error: wrong ID + + + OCR not initialised: no font was read in + + + No font activated + + + OCR internal error: Wrong threshold in angle determination + + + OCR internal error: Wrong attribute + + + The version of the OCR classifier is not supported + + + OCR File: Inconsistent number of nodes + + + OCR File: File too short + + + OCR: Internal error 1 + + + OCR: Internal error 2 + + + Wrong type of OCR tool (no 'box' or 'net') + + + The version of the OCR training characters is not supported + + + Image too large for training file + + + Region too large for training file + + + Protected OCR training file + + + Protected OCR training file: wrong passw. + + + Serialized item does not contain a valid OCR classifier + + + OCR training file concatenation failed: identical input and output files + + + Invalid file format for MLP classifier + + + The version of the MLP classifier is not supported + + + Serialized item does not contain a valid MLP classifier + + + Invalid file format for SVM classifier + + + The version of the SVM classifier is not supported + + + Serialized item does not contain a valid SVM classifier + + + Invalid file format for k-NN classifier + + + Serialized item does not contain a valid k-NN classifier + + + Invalid file format for CNN classifier + + + The version of the CNN classifier is not supported + + + Serialized item does not contain a valid CNN classifier + + + Result name is not available for this mode + + + OCV system not initialized + + + The version of the OCV tool is not supported + + + Wrong name for an OCV object + + + Training has already been applied + + + No training has been applied + + + Serialized item does not contain a valid OCV tool + + + Wrong number of function points + + + List of values is not a function + + + Wrong ordering of values (not ascending) + + + Illegal distance of function points + + + Function is not monotonic. + + + Wrong function type. + + + The input points could not be arranged in a regular grid + + + Error while creating the output map + + + Auto rotation failed + + + Mark segmentation failed + + + Contour extraction failed + + + No finder pattern found + + + At least 3 calibration points have to be indicated + + + Inconsistent finder pattern positions + + + No calibration table found + + + Error while reading calibration table description file + + + Minimum threshold while searching for ellipses + + + Read error / format error in calibration table description file + + + Error in projection: s_x = 0 or s_y = 0 or z = 0 + + + Error in inverse projection + + + Not possible to open camera parameter file + + + Format error in file: No colon + + + Format error in file: 2. colon is missing + + + Format error in file: Semicolon is missing + + + Not possible to open camera parameter (pose) file + + + Format error in camera parameter (pose) file + + + Not possible to open calibration target description file + + + Not possible to open postscript file of calibration target + + + Error while norming the vector + + + Fitting of calibration target failed + + + No next mark found + + + Normal equation system is not solvable + + + Average quadratic error is too big for 3D position of mark + + + Non elliptic contour + + + Wrong parameter value slvand() + + + Wrong function results slvand() + + + Distance of marks in calibration target description file is not possible + + + Specified flag for degree of freedom not valid + + + Minimum error did not fall below + + + Wrong type in Pose (rotation / translation) + + + Image size does not match the measurement in camera parameters + + + Point could not be projected into linescan image + + + Diameter of calibration marks could not be determined + + + Orientation of calibration plate could not be determined + + + Calibration plate does not lie completely inside the image + + + Wrong number of calibration marks extracted + + + Unknown name of parameter group + + + Focal length must be non-negative + + + Function not available for cameras with telecentric lenses + + + Function not available for line scan cameras + + + Ellipse is degenerated to a point + + + No orientation mark found + + + Camera calibration did not converge + + + Function not available for cameras with hypercentric lenses + + + Point cannot be distorted. + + + Wrong edge filter. + + + Pixel size must be non-negative or zero + + + Tilt is in the wrong range + + + Rot is in the wrong range + + + Camera parameters are invalid + + + Focal length must be positive + + + Magnification must be positive + + + Illegal image plane distance + + + model not optimized yet - no res's + + + auxilary model results not available + + + setup not 'visibly' interconnected + + + camera parameter mismatch + + + camera type mismatch + + + camera type not supported + + + invalid camera ID + + + invalid cal.obj. ID + + + invalid cal.obj. instance ID + + + undefined camera + + + repeated observ. index + + + undefined calib. object description + + + Invalid file format for calibration data model + + + The version of the calibration data model is not supported + + + zero-motion in linear scan camera + + + multi-camera and -calibobj not supported for all camera types + + + incomplete data, required for legacy calibration + + + Invalid file format for camera setup model + + + The version of the camera setup model is not supported + + + full HALCON-caltab descr'n required + + + invalid observation ID + + + Serialized item does not contain a valid camera setup model + + + Serialized item does not contain a valid calibration data model + + + Invalid tool pose id + + + Undefined tool pose + + + Invalid calib data model type + + + The camera setup model contains an uninitialized camera + + + The hand-eye algorithm failed to find a solution. + + + invalid observation pose + + + Not enough calibration object poses + + + undefined camera type + + + No camera pair set by set_stereo_model_image_pairs + + + No reconstructed point is visible for coloring + + + No camera pair yields reconstructed points (please check parameters of disparity method or bounding box) + + + Partitioning of bounding box is too fine (please adapt the parameter 'resolution' or the bounding box) + + + Invalid disparity range for binocular_disparity_ms method + + + Invalid param for binoculuar method + + + invalid stereo model type + + + stereo model is not in persistent mode + + + invalid bounding box + + + stereo reconstruction: image sizes must correspond to camera setup + + + bounding box is behind basis line + + + Ambigious calibration: Please, recalibrate with improved input data! + + + Pose of calibration plate not determined + + + Calibration failed: Please check your input data and calibrate again! + + + No observation data supplied! + + + The calibration object has to be seen at least once by every camera, if less than four cameras are used. + + + Invalid file format for template + + + The version of the template is not supported + + + Error during changing the file mode + + + Inconsistent match file: Coordinates out of range + + + The image(s) is not a pyramid + + + Number of template points too small + + + Template data can only be read by HALCON XL + + + Serialized item does not contain a valid NCC model + + + Serialized item does not contain a valid template + + + Number of shape model points too small + + + Gray and color shape models mixed + + + Shape model data can only be read by HALCON XL + + + Shape model was not created from XLDs + + + Serialized item does not contain a valid shape model + + + Shape model contour too near to clutter region + + + Shape model does not contain clutter parameters + + + Shape models are not of the same clutter type + + + Shape model has an invalid clutter contrast + + + Initial components have different region types + + + Solution of ambiguous matches failed + + + Computation of the incomplete gamma function not converged + + + Too many nodes while computing the minimum spanning arborescence + + + Component training data can only be read by HALCON XL + + + Component model data can only be read by HALCON XL + + + Serialized item does not contain a valid component model + + + Serialized item does not contain a valid component training result + + + Size of the training image and the variation model differ + + + Variation model has not been prepared for segmentation + + + Invalid variation model training mode + + + Invalid file format for variation model + + + The version of the variation model is not supported + + + Training data has been cleared + + + Serialized item does not contain a valid variation model + + + No more measure objects available + + + Measure object is not initialized + + + Invalid measure object + + + Measure object is NULL + + + Measure object has wrong image size + + + Invalid file format for measure object + + + The version of the measure object is not supported + + + Measure object data can only be read by HALCON XL + + + Serialized item does not contain a valid measure object + + + Metrology model is not initialized + + + Invalid metrology object + + + Not enough valid measures for fitting the metrology object + + + Invalid file format for metrology model + + + The version of the metrology model is not supported + + + Fuzzy function is not set + + + Serialized item does not contain a valid metrology model + + + Camera parameters are not set + + + Pose of the measurement plane is not set + + + Mode of metrology model cannot be set since an object has already been added + + + If the pose of the metrology object has been set several times, the operator is not longer allowed + + + All objects of a metrology model must have the same world pose and camera parameters. + + + Input type of metrology model does not correspond with the current input type + + + Dynamic library could not be opened + + + Dynamic library could not be closed + + + Symbol not found in dynamic library + + + Interface library not * available + + + Not enough information for rad. calib. + + + Wrong number of modules + + + Wrong number of elements + + + Unknown character (for this code) + + + Wrong name for attribute in barcode descriptor + + + Wrong thickness of element + + + No region found + + + Wrong type of bar code + + + Empty model list + + + Training cannot be done for multiple bar code types + + + Cannot get bar code type specific parameter with get_bar_code_param. Use get_bar_code_param_specific + + + Cannot get this object for multiple bar code types. Try again with single bar code type + + + Wrong binary (file) format + + + Wrong version of binary file + + + The model must be in persistency mode to deliver the required object/result + + + Incorrect index of scanline's gray values + + + Neither find_bar_code nor decode_bar_code_rectanlge2 has been called in 'persistent' mode on this model + + + Specified code type is not supported + + + Wrong foreground specified + + + Wrong matrix size specified + + + Wrong symbol shape specified + + + Wrong generic parameter name + + + Wrong generic parameter value + + + Wrong symbol printing mode + + + Symbol region too near to image border + + + No rectangular modul boundings found + + + Couldn't identify symbol finder + + + Symbol region with wrong dimension + + + Classification failed + + + Decoding failed + + + Reader programing not supported + + + General 2d data code error + + + Corrupt signature of 2d data code handle + + + Invalid 2d data code handle + + + List of 2d data code models is empty + + + Access to uninitialized (or not persistent) internal data + + + Invalid 'Candidate' parameter + + + It's not possible to return more than one parameter for several candidates + + + One of the parameters returns several values and has to be used exclucively for a single candidate + + + Parameter for default settings must be the first in the parameter list + + + Unexpected 2d data code error + + + Invalid parameter value + + + Unknown parameter name + + + Invalid 'polarity' + + + Invalid 'symbol_shape' + + + Invalid symbol size + + + Invalid module size + + + Invalid 'module_shape' + + + Invalid 'orientation' + + + Invalid 'contrast_min' + + + Invalid 'measure_thresh' + + + Invalid 'alt_measure_red' + + + Invalid 'slant_max' + + + Invalid 'L_dist_max' + + + Invalid 'L_length_min' + + + Invalid module gap + + + Invalid 'default_parameters' + + + Invalid 'back_texture' + + + Invalid 'mirrored' + + + Invalid 'classificator' + + + Invalid 'persistence' + + + Invalid model type + + + Invalid 'module_roi_part' + + + Invalid 'finder_pattern_tolerance' + + + Invalid 'mod_aspect_max' + + + Invalid 'small_modules_robustness' + + + Invalid 'contrast_tolerance' + + + Invalid header in 2d data code model file + + + Invalid code signature in 2d data code model file + + + Corrupted line in 2d data code model file + + + Invalid module aspect ratio + + + wrong number of layers + + + wrong data code model version + + + Serialized item does not contain a valid 2D data code model + + + Wrong binary (file) format + + + Invalid parameter value + + + Invalid 'num_levels' + + + Invalid 'optimization' + + + Invalid 'metric' + + + Invalid 'min_face_angle' + + + Invalid 'min_size' + + + Invalid 'model_tolerance' + + + Invalid 'fast_pose_refinment' + + + Invalid 'lowest_model_level' + + + Invalid 'part_size' + + + The projected model is too large (increase the value for DistMin or the image size in CamParam) + + + Invalid 'opengl_accuracy' + + + Invalid 'recompute_score' + + + Invalid 'longitude_min' + + + Invalid 'longitude_max' + + + Invalid 'latitude_min + + + Invalid 'latitude_max' + + + Invalid 'cam_roll_min' + + + Invalid 'cam_roll_max' + + + Invalid 'dist_min' + + + Invalid 'dist_max' + + + Invalid 'num_matches' + + + Invalid 'max_overlap' + + + Invalid 'pose_refinement' + + + Invalid 'cov_pose_mode' + + + In. 'outlier_suppression' + + + Invalid 'border_model' + + + Pose is not well-defined + + + Invalid file format for 3D shape model + + + The version of the 3D shape model is not supported + + + 3D shape model can only be read by HALCON XL + + + 3D object model does not contain any faces + + + Serialized item does not contain a valid 3D shape model + + + Invalid 'union_adjacent_contours' + + + Invalid file format for descriptor model + + + The version of the descriptor model is not supported + + + Invalid 'radius' + + + Invalid 'check_neighbor' + + + Invalid 'min_check_neighbor_diff' + + + Invalid 'min_score' + + + Invalid 'sigma_grad' + + + Invalid 'sigma_smooth' + + + Invalid 'alpha' + + + Invalid 'threshold' + + + Invalid 'depth' + + + Invalid 'number_trees' + + + Invalid 'min_score_descr' + + + Invalid 'patch_size' + + + Invalid 'tilt' + + + Invalid 'guided_matching' + + + Invalid 'subpix' + + + Too few feature points can be found + + + Invalid 'min_rot' + + + Invalid 'max_rot' + + + Invalid 'min_scale' + + + Invalid 'max_scale' + + + Invalid 'mask_size_grd' + + + Invalid 'mask_size_smooth' + + + Model broken + + + Invalid 'descriptor_type' + + + Invalid 'matcher' + + + Too many point classes - cannot be written to file + + + Serialized item does not contain a valid descriptor model + + + Function not implemented on this machine + + + Image to process has wrong gray value type + + + Wrong image component + + + Undefined gray values + + + Wrong image format for operation (too big or too small) + + + Wrong number of image components for image output + + + String is too long (max. 1024 characters) + + + Wrong pixel type for this operation + + + Operation not realized yet for this pixel type + + + Image is no color image with three channels + + + Image acquisition devices are not supported in the demo version + + + Packages are not supported in the demo version + + + Internal Error: Unknown value + + + Wrong paramter for this operation + + + Image domain too small + + + Draw operator has been canceled + + + Error during matching of regular * expression + + + Operator is not available in the student version of HALCON + + + Packages are not available in the student version of HALCON + + + The selected image acquisition device is not available in the student version of HALCON + + + No data points available + + + Object type is not supported. + + + Operator is disabled. + + + Too many unknown variables in linear equation + + + No (unique) solution for the linear equation + + + Too little equations in linear equation + + + Points do not define a line + + + Matrix is not invertible + + + Singular value decomposition did not converge + + + Matrix has too few rows for singular value partition + + + Eigenvalue computation did not converge + + + Eigenvalue computation did not converge + + + Matrix is singular + + + Function matching did not converge + + + Input matrix undefined + + + Input matrix with wrong dimension + + + Input matrix is not quadratic + + + Matrix operation failed + + + Matrix is not positive definite + + + Matrix element division by 0 + + + Matrix is not an upper triangular matrix + + + Matrix is not a lower triangular matrix + + + Matrix element is negative + + + Matrix file: Invalid character + + + Matrix file: matrix incomplete + + + Invalid file format for matrix + + + Resulting matrix has complex values + + + Wrong value in matrix of exponents + + + The version of the matrix is not supported + + + Serialized item does not contain a valid matrix + + + Internal Error: Wrong Node + + + Inconsistent red black tree + + + Internal error + + + Number of points too small + + + First 3 points are collinear + + + Identical points in triangulation + + + Array not allocated large enough + + + Triangle is degenerate + + + Inconsistent triangulation + + + Self-intersecting polygon + + + Inconsistent polygon data + + + Ambiguous great circle arc intersection + + + Ambiguous great circle arc + + + Illegal parameter + + + Not enough points for planar triangular meshing + + + The first three points of the triangular meshing are collinear + + + Planar triangular meshing contains identical input points + + + Invalid points for planar triangular meshing + + + Internal error: allocated array too small for planar triangular meshing + + + Internal error: planar triangular meshing inconsistent + + + Node index outside triangulation range + + + Local inconsistencies for all points with valid neighbors (parameters only allow few valid neighborhoods or point cloud not subsampled) + + + Eye point and reference point coincide + + + Real part of the dual quaternion has length 0 + + + Timeout occurred + + + Invalid 'timeout' + + + Timeout occured after cached transformations have been freed (internal error) + + + Invalid 'sub_object_size' + + + Invalid 'min_size' + + + Invalid number of least-squares iterations + + + Invalid 'angle_step' + + + Invalid 'scale_r_step' + + + Invalid 'scale_c_step' + + + Invalid 'max_angle_distortion' + + + Invalid 'max_aniso_scale_distortion' + + + Invalid 'min_size' + + + Invalid 'cov_pose_mode' + + + Model contains no calibration information + + + Generic parameter name does not exist + + + camera has different resolution than image + + + Invalid file format for deformable model + + + The version of the deformable model is not supported + + + Invalid 'deformation_smoothness' + + + Invalid 'expand_border' + + + Model origin outside of axis-aligned bounding rectangle of template region + + + Serialized item does not contain a valid deformable model + + + Object model has no points + + + Object model has no faces + + + Object model has no normals + + + Invalid file format for 3D surface model + + + The version of the 3D surface model is not supported + + + Serialized item does not contain a valid 3D surface model + + + Poses generate too many symmetries + + + Invalid 3D file + + + Invalid 3D Object Model + + + Unknown 3D file type + + + The version of the 3D object model is not supported + + + Required attribute is missing + + + Required attribute point_coord is missing + + + Required attribute point_normal is missing + + + Required attribute face_triangle is missing + + + Required attribute line_array is missing + + + Required attribute f_trineighb is missing + + + Required attribute face_polygon is missing + + + Required attribute xyz_mapping is missing + + + Required attribute o_primitive is missing + + + Required attribute shape_model is missing + + + Required extended attribute missing in 3D object model + + + Serialized item does not contain a valid 3D object model + + + Primitive in 3D object model has no extended data + + + Operation invalid, 3D object model already contains triangles + + + Operation invalid, 3D object model already contains lines + + + Operation invalid, 3D object model already contains faces or polygons + + + In a global registration an input object has no neighbors + + + All components of points must be set at once + + + All components of normals must be set at once + + + Number of values doesn't correspond to number of already existing points + + + Number of values doesn't correspond to number of already existing normals + + + Number of values doesn't correspond to already existing triangulation + + + Number of values doesn't correspond to length of already existing polygons + + + Number of values doesn't correspond to length of already existing polylines + + + Number of values doesn't correspond already existing 2D mapping + + + Number of values doesn't correspond to already existing extended attribute + + + Per-face intensity is used with point attribute + + + Attribute is not (yet) supported + + + No point within bounding box + + + distance_in_front is smaller than the resolution + + + The minimum thickness is smaller than the surface tolerance + + + Triangles of the 3D object model are not suitable for this operator + + + Too few suitable 3D points in the 3D object model + + + Not a valid serialized item file + + + Serialized item: premature end of file + + + Invalid 'image_resize_method' + + + Invalid 'image_resize_value' + + + Invalid 'rating_method' + + + At least one type of image information must be used + + + Sample identifier does not contain color information + + + Sample identifier does not contain texture information + + + Sample image does not contain enough information + + + Sample identifier does not contain unprepared data (use add_sample_identifier_preparation_data) + + + Sample identifier has not been prepared yet (use prepare_sample_identifier) + + + Sample identifier does not contain untrained data (use add_sample_identifier_training_data) + + + Sample identifier has not been trained yet (use train_sample_identifier) + + + Sample identifier does not contain result data + + + Sample identifier must contain at least two training objects (use add_sample_identifier_training_data) + + + More than one user thread still uses HALCON * resources during finalization + + + User defined error codes must be larger than this value + + + No license found + + + Lost connection to license server + + + No modules in license (no VENDOR_STRING) + + + No license for this operator + + + Time zone offset from GMT is > 24 hours + + + Vendor keys do not support this platform + + + Bad vendor keys + + + Unknown vendor key type + + + malloc() call failed + + + Vendor keys have expired + + + Second call to lc_inti() (multiple jobs), and vendore keys do not support multiple jobs + + + Vendor key data not supplied + + + lmclient.h/liblmgr.a version mismatch + + + Networking software not available on this machine + + + Old vendor keys supplied + + + License key in license file does not match other data in file + + + Encryption handshake with daemon failed + + + 'key' structure is incorrect type, or feature == NULL, or num_licenses == 0 + + + System clock has been set back + + + Version argument is invalid floating point format + + + License server busy starting another copy of itself + + + Cannot establish a connection with a license server + + + Feature is queued. lc_status will determine when it is available + + + Vendor keys do not support this function + + + Checkout request filtered by the vendor-defined filter routine + + + Checkout exceeds MAX specified in options file + + + All licenses in use + + + No license server specified for counted license + + + Can not find feature in the license file + + + Server has different license file than client - client's license has feature, but server's does not + + + License file does not support a version this new + + + This platform not authorized by license - running on platform not included in PLATFORMS list + + + License server busy + + + Could not find license.dat + + + Invalid license file syntax + + + Cannot connect to a license server + + + No TCP "license" service exists + + + No socket connection to license manager server + + + Invalid host + + + Feature has expired + + + Invalid date format in license file + + + Invalid returned data from license server + + + Cannot find SERVER hostname in network database + + + Cannot read data from license server + + + Cannot write data to license server + + + Error in select system call + + + Feature checkin failure detected at license + + + Users are queued for this feature + + + License server does not support this version of this feature + + + Request for more licenses than this feature supports + + + Cannot read /dev/kmem + + + Cannot read /vmunix + + + Cannot find ethernet device + + + Cannot read license file + + + Feature not yet available + + + No such attribute + + + Clock difference too large between client and server + + + Feature database corrupted in daemon + + + Duplicate selection mismatch for this feature + + + User/host on EXCLUDE list for feature + + + User/host not on INCLUDE list for feature + + + Feature was never checked out + + + Invalid FLEXlm key data supplied + + + Clock setting check not available in daemon + + + Date too late for binary format + + + FLEXlm not initialized + + + Server did not respond to message + + + Request rejected by vendor defined filter + + + No FEATURESET line present in license file + + + Incorrect FEATURESET line in license file + + + Cannot compute FEATURESET line + + + socket() call failed + + + setsockopt() failed + + + Message checksum failure + + + Cannot read license file from server + + + Not a license administrator + + + lmremove request too soon + + + Attempt to read beyond the end of LF path + + + SYS$SETIMR call failed + + + Internal FLEXlm Erro - Please report to Globetrotter Software + + + FLEXadmin API functions not avilable + + + Invalid PACKAGE line in license file + + + Server FLEXlm version older than client's + + + Incorrect number of USERS/HOSTS INCLUDED in options file + + + Server doesn't support this request + + + This license object already in use + + + Future license file format + + + Feature removed during lmreread + + + This feature is available in a different license pool + + + Network connect to THIS_HOST failed + + + Server node is down or not responding + + + The desired vendor daemon is down + + + The decimal format license is typed incorrectly + + + All licenses are reserved for others + + + Terminal Server remote client not allowed + + + Cannot borrow that long + + + License server out of network connections + + + Dongle not attached, or can't read dongle + + + Missing dongle driver + + + FLEXlock checkouts attempted + + + SIGN= attribute required + + + CRO not supported for this platform + + + BORROW failed + + + BORROW period has expired + + + FLOAT_OK license must have exactly one dongle hostid + + + Unable to delete local borrow info" + + + Returning borrowed license early not enabled + + + Returning borrowed license on server failed + + + Checkout just a PACKAGE failed + + + Composite Hostid not initialized + + + An item needed for Composite Hostid missing or invalid + + + Borrowed license doesn't match any known server license + + + Error enabling event log + + + Event logging is disabled + + + Error writing to event log + + + Timeout + + + Bad message command + + + Error writing to socket + + + Failed to generate version specific license + + + Vers.-specific signatures not supported + + + License template contains redundant signature specifiers + + + Invalid V71_LK signature + + + Invalid V71_SIGN signature + + + Invalid V80_LK signature + + + Invalid V80_SIGN signature + + + Invalid V81_LK signature + + + Invalid V81_SIGN signature + + + Invalid V81_SIGN2 signature + + + Invalid V84_LK signature + + + Invalid V84_SIGN signature + + + Invalid V84_SIGN2 signature + + + License key required but missing from the certificate + + + Bad AUTH={} signature + + + TS record invalid + + + Cannot open TS + + + Invalid Fulfillment record + + + Invalid activation request received + + + No fulfillment exists in trusted storage which matches the request + + + Invalid activation response received + + + Can't return the fulfillment + + + Return would exceed max count(s) + + + No repair count left + + + Specified operation is not allowed + + + User/host on EXCLUDE list for entitlement + + + User/host not in INCLUDE list for entitlement + + + Activation error + + + Invalid date format in trusted storage + + + Message encryption failed + + + Message decryption failed + + + Bad filter context + + + SUPERSEDE feature conflict + + + Invalid SUPERSEDE_SIGN syntax + + + SUPERSEDE_SIGN does not contain a feature name and license signature + + + ONE_TS_OK is not supported in this Windows Platform + + + Internal error + + + Only one terminal server remote client checkout is allowed for this feature + + + Internal error + + + Internal error + + + Internal error + + + More than one ethernet hostid not supported in composite hostid definition + + + The number of characters in the license file paths exceeds the permissible limit + + + Invalid TZ keyword syntax + + + Invalid time zone override specification in the client + + + The time zone information could not be obtained + + + License client time zone not authorized for license rights + + + Invalid syntax for VM_PLATFORMS keyword + + + Feature can be checked out from physical machine only + + + Feature can be checked out from virtual machine only + + + Vendor keys do not support Virtualization feature + + + Checkout request denied as it exceeds the MAX limit specified in the options file + + + Binding agent API - Internal error + + + Binding agent communication error + + + Invalid Binding agent version + + + Failed to load ServerQuery request + + + Failed to generate ServerQuery response + + + Invalid IP address used while overriding + + + + + + Represents an instance of an event synchronization object. + + + + Create an event synchronization object. + Modified instance represents: Event synchronization object. + + Mutex attribute. Default: [] + Mutex attribute value. Default: [] + + + + Create an event synchronization object. + Modified instance represents: Event synchronization object. + + Mutex attribute. Default: [] + Mutex attribute value. Default: [] + + + + Clear the event synchronization object. + Instance represents: Event synchronization object. + + + + + Unlock an event synchronization object. + Instance represents: Event synchronization object. + + + + + Lock an event synchronization object only if it is unlocked. + Instance represents: Event synchronization object. + + Object already locked? + + + + Lock an event synchronization object. + Instance represents: Event synchronization object. + + + + + Create an event synchronization object. + Modified instance represents: Event synchronization object. + + Mutex attribute. Default: [] + Mutex attribute value. Default: [] + + + + Create an event synchronization object. + Modified instance represents: Event synchronization object. + + Mutex attribute. Default: [] + Mutex attribute value. Default: [] + + + Represents an instance of a training used for the classifier. + + + + Read a training data set from a file. + Modified instance represents: Identification of the data set to train. + + Filename of the data set to train. Default: "sampset1" + + + + Read a training data set from a file. + Modified instance represents: Identification of the data set to train. + + Filename of the data set to train. Default: "sampset1" + + + + Train the classifier with one data set. + Instance represents: Number of the data set to train. + + Handle of the classifier. + Name of the protocol file. Default: "training_prot" + Number of arrays of attributes to learn. Default: 500 + Classification error for termination. Default: 0.05 + Error during the assignment. Default: 100 + + + + Free memory of a data set. + Instance represents: Number of the data set. + + + + + Classify a set of arrays. + Instance represents: Key of the test data. + + Handle of the classifier. + Error during the assignment. + + + Represents an instance of a file. + + + + Open a file in text or binary format. + Modified instance represents: File handle. + + Name of file to be opened. Default: "standard" + Type of file access and optional the string encoding. Default: "output" + + + + Open a file in text or binary format. + Modified instance represents: File handle. + + Name of file to be opened. Default: "standard" + Type of file access and optional the string encoding. Default: "output" + + + + Open a file in text or binary format. + Modified instance represents: File handle. + + Name of file to be opened. Default: "standard" + Type of file access and optional the string encoding. Default: "output" + + + + Open a file in text or binary format. + Modified instance represents: File handle. + + Name of file to be opened. Default: "standard" + Type of file access and optional the string encoding. Default: "output" + + + + Write strings and numbers into a text file. + Instance represents: File handle. + + Values to be written into the file. Default: "hallo" + + + + Write strings and numbers into a text file. + Instance represents: File handle. + + Values to be written into the file. Default: "hallo" + + + + Read a character line from a text file. + Instance represents: File handle. + + Reached end of file before any character was read. + Read line. + + + + Read a string from a text file. + Instance represents: File handle. + + Reached end of file before any character was added to the output string. + Read character sequence. + + + + Read one character from a text file. + Instance represents: File handle. + + Read character, which can be multi-byte or the control string 'eof'. + + + + Write a line break and clear the output buffer. + Instance represents: File handle. + + + + Closing a text file. + File handle. + + + + Closing a text file. + Instance represents: File handle. + + + + Represents an instance of an image acquisition device. + + + + Open and configure an image acquisition device. + Modified instance represents: Handle of the opened image acquisition device. + + HALCON image acquisition interface name, i.e., name of the corresponding DLL (Windows) or shared library (Linux/macOS). Default: "File" + Desired horizontal resolution of image acquisition interface (absolute value or 1 for full resolution, 2 for half resolution, or 4 for quarter resolution). Default: 1 + Desired vertical resolution of image acquisition interface (absolute value or 1 for full resolution, 2 for half resolution, or 4 for quarter resolution). Default: 1 + Width of desired image part (absolute value or 0 for HorizontalResolution - 2*StartColumn). Default: 0 + Height of desired image part (absolute value or 0 for VerticalResolution - 2*StartRow). Default: 0 + Line number of upper left corner of desired image part (or border height if ImageHeight = 0). Default: 0 + Column number of upper left corner of desired image part (or border width if ImageWidth = 0). Default: 0 + Desired half image or full image. Default: "default" + Number of transferred bits per pixel and image channel (-1: device-specific default value). Default: -1 + Output color format of the grabbed images, typically 'gray' or 'raw' for single-channel or 'rgb' or 'yuv' for three-channel images ('default': device-specific default value). Default: "default" + Generic parameter with device-specific meaning. Default: -1 + External triggering. Default: "default" + Type of used camera ('default': device-specific default value). Default: "default" + Device the image acquisition device is connected to ('default': device-specific default value). Default: "default" + Port the image acquisition device is connected to (-1: device-specific default value). Default: -1 + Camera input line of multiplexer (-1: device-specific default value). Default: -1 + + + + Open and configure an image acquisition device. + Modified instance represents: Handle of the opened image acquisition device. + + HALCON image acquisition interface name, i.e., name of the corresponding DLL (Windows) or shared library (Linux/macOS). Default: "File" + Desired horizontal resolution of image acquisition interface (absolute value or 1 for full resolution, 2 for half resolution, or 4 for quarter resolution). Default: 1 + Desired vertical resolution of image acquisition interface (absolute value or 1 for full resolution, 2 for half resolution, or 4 for quarter resolution). Default: 1 + Width of desired image part (absolute value or 0 for HorizontalResolution - 2*StartColumn). Default: 0 + Height of desired image part (absolute value or 0 for VerticalResolution - 2*StartRow). Default: 0 + Line number of upper left corner of desired image part (or border height if ImageHeight = 0). Default: 0 + Column number of upper left corner of desired image part (or border width if ImageWidth = 0). Default: 0 + Desired half image or full image. Default: "default" + Number of transferred bits per pixel and image channel (-1: device-specific default value). Default: -1 + Output color format of the grabbed images, typically 'gray' or 'raw' for single-channel or 'rgb' or 'yuv' for three-channel images ('default': device-specific default value). Default: "default" + Generic parameter with device-specific meaning. Default: -1 + External triggering. Default: "default" + Type of used camera ('default': device-specific default value). Default: "default" + Device the image acquisition device is connected to ('default': device-specific default value). Default: "default" + Port the image acquisition device is connected to (-1: device-specific default value). Default: -1 + Camera input line of multiplexer (-1: device-specific default value). Default: -1 + + + + Query specific parameters of an image acquisition device. + Instance represents: Handle of the acquisition device to be used. + + Parameter of interest. Default: "revision" + Parameter value. + + + + Query specific parameters of an image acquisition device. + Instance represents: Handle of the acquisition device to be used. + + Parameter of interest. Default: "revision" + Parameter value. + + + + Set specific parameters of an image acquistion device. + Instance represents: Handle of the acquisition device to be used. + + Parameter name. + Parameter value to be set. + + + + Set specific parameters of an image acquistion device. + Instance represents: Handle of the acquisition device to be used. + + Parameter name. + Parameter value to be set. + + + + Query callback function of an image acquisition device. + Instance represents: Handle of the acquisition device to be used. + + Callback type. Default: "transfer_end" + Pointer to user-specific context data. + Pointer to the callback function. + + + + Register a callback function for an image acquisition device. + Instance represents: Handle of the acquisition device to be used. + + Callback type. Default: "transfer_end" + Pointer to the callback function to be set. + Pointer to user-specific context data. + + + + Asynchronous grab of images and preprocessed image data from the specified image acquisition device. + Instance represents: Handle of the acquisition device to be used. + + Pre-processed image regions. + Pre-processed XLD contours. + Maximum tolerated delay between the start of the asynchronous grab and the delivery of the image [ms]. Default: -1.0 + Pre-processed control data. + Grabbed image data. + + + + Asynchronous grab of images and preprocessed image data from the specified image acquisition device. + Instance represents: Handle of the acquisition device to be used. + + Pre-processed image regions. + Pre-processed XLD contours. + Maximum tolerated delay between the start of the asynchronous grab and the delivery of the image [ms]. Default: -1.0 + Pre-processed control data. + Grabbed image data. + + + + Synchronous grab of images and preprocessed image data from the specified image acquisition device. + Instance represents: Handle of the acquisition device to be used. + + Preprocessed image regions. + Preprocessed XLD contours. + Preprocessed control data. + Grabbed image data. + + + + Synchronous grab of images and preprocessed image data from the specified image acquisition device. + Instance represents: Handle of the acquisition device to be used. + + Preprocessed image regions. + Preprocessed XLD contours. + Preprocessed control data. + Grabbed image data. + + + + Asynchronous grab of an image from the specified image acquisition device. + Instance represents: Handle of the acquisition device to be used. + + Maximum tolerated delay between the start of the asynchronous grab and the delivery of the image [ms]. Default: -1.0 + Grabbed image. + + + + Start an asynchronous grab from the specified image acquisition device. + Instance represents: Handle of the acquisition device to be used. + + This parameter is obsolete and has no effect. Default: -1.0 + + + + Synchronous grab of an image from the specified image acquisition device. + Instance represents: Handle of the acquisition device to be used. + + Grabbed image. + + + + Close specified image acquisition device. + Instance represents: Handle of the image acquisition device to be closed. + + + + + Open and configure an image acquisition device. + Modified instance represents: Handle of the opened image acquisition device. + + HALCON image acquisition interface name, i.e., name of the corresponding DLL (Windows) or shared library (Linux/macOS). Default: "File" + Desired horizontal resolution of image acquisition interface (absolute value or 1 for full resolution, 2 for half resolution, or 4 for quarter resolution). Default: 1 + Desired vertical resolution of image acquisition interface (absolute value or 1 for full resolution, 2 for half resolution, or 4 for quarter resolution). Default: 1 + Width of desired image part (absolute value or 0 for HorizontalResolution - 2*StartColumn). Default: 0 + Height of desired image part (absolute value or 0 for VerticalResolution - 2*StartRow). Default: 0 + Line number of upper left corner of desired image part (or border height if ImageHeight = 0). Default: 0 + Column number of upper left corner of desired image part (or border width if ImageWidth = 0). Default: 0 + Desired half image or full image. Default: "default" + Number of transferred bits per pixel and image channel (-1: device-specific default value). Default: -1 + Output color format of the grabbed images, typically 'gray' or 'raw' for single-channel or 'rgb' or 'yuv' for three-channel images ('default': device-specific default value). Default: "default" + Generic parameter with device-specific meaning. Default: -1 + External triggering. Default: "default" + Type of used camera ('default': device-specific default value). Default: "default" + Device the image acquisition device is connected to ('default': device-specific default value). Default: "default" + Port the image acquisition device is connected to (-1: device-specific default value). Default: -1 + Camera input line of multiplexer (-1: device-specific default value). Default: -1 + + + + Open and configure an image acquisition device. + Modified instance represents: Handle of the opened image acquisition device. + + HALCON image acquisition interface name, i.e., name of the corresponding DLL (Windows) or shared library (Linux/macOS). Default: "File" + Desired horizontal resolution of image acquisition interface (absolute value or 1 for full resolution, 2 for half resolution, or 4 for quarter resolution). Default: 1 + Desired vertical resolution of image acquisition interface (absolute value or 1 for full resolution, 2 for half resolution, or 4 for quarter resolution). Default: 1 + Width of desired image part (absolute value or 0 for HorizontalResolution - 2*StartColumn). Default: 0 + Height of desired image part (absolute value or 0 for VerticalResolution - 2*StartRow). Default: 0 + Line number of upper left corner of desired image part (or border height if ImageHeight = 0). Default: 0 + Column number of upper left corner of desired image part (or border width if ImageWidth = 0). Default: 0 + Desired half image or full image. Default: "default" + Number of transferred bits per pixel and image channel (-1: device-specific default value). Default: -1 + Output color format of the grabbed images, typically 'gray' or 'raw' for single-channel or 'rgb' or 'yuv' for three-channel images ('default': device-specific default value). Default: "default" + Generic parameter with device-specific meaning. Default: -1 + External triggering. Default: "default" + Type of used camera ('default': device-specific default value). Default: "default" + Device the image acquisition device is connected to ('default': device-specific default value). Default: "default" + Port the image acquisition device is connected to (-1: device-specific default value). Default: -1 + Camera input line of multiplexer (-1: device-specific default value). Default: -1 + + + + Query look-up table of the image acquisition device. + Instance represents: Handle of the acquisition device to be used. + + Red level of the LUT entries. + Green level of the LUT entries. + Blue level of the LUT entries. + + + + Set look-up table of the image acquisition device. + Instance represents: Handle of the acquisition device to be used. + + Red level of the LUT entries. + Green level of the LUT entries. + Blue level of the LUT entries. + + + Represents an instance of a 1d function. + + + Create an uninitialized instance. + + + + Create a function from a sequence of y-values. + Modified instance represents: Created function. + + X value for function points. + + + + Create a function from a sequence of y-values. + Modified instance represents: Created function. + + X value for function points. + + + + Create a function from a set of (x,y) pairs. + Modified instance represents: Created function. + + X value for function points. + Y-value for function points. + + + + Create a function from a set of (x,y) pairs. + Modified instance represents: Created function. + + X value for function points. + Y-value for function points. + + + Adds a constant offset to the function's Y values + + + Adds a constant offset to the function's Y values + + + Subtracts a constant offset from the function's Y values + + + Negates the Y values of the function + + + Scales the function's Y values + + + Scales the function's Y values + + + Scales the function's Y values + + + Composes two functions (not a pointwise multiplication) + + + Calculates the inverse of the function + + + + Plot a function using gnuplot. + Instance represents: Function to be plotted. + + Identifier for the gnuplot output stream. + + + + Compose two functions. + Instance represents: Input function 1. + + Input function 2. + Border treatment for the input functions. Default: "constant" + Composed function. + + + + Calculate the inverse of a function. + Instance represents: Input function. + + Inverse of the input function. + + + + Calculate the derivatives of a function. + Instance represents: Input function + + Type of derivative Default: "first" + Derivative of the input function + + + + Calculate the local minimum and maximum points of a function. + Instance represents: Input function + + Handling of plateaus Default: "strict_min_max" + Interpolation of the input function Default: "true" + Minimum points of the input function + Maximum points of the input function + + + + Calculate the zero crossings of a function. + Instance represents: Input function + + Zero crossings of the input function + + + + Multiplication and addition of the y values. + Instance represents: Input function. + + Factor for scaling of the y values. Default: 2.0 + Constant which is added to the y values. Default: 0.0 + Transformed function. + + + + Negation of the y values. + Instance represents: Input function. + + Function with the negated y values. + + + + Absolute value of the y values. + Instance represents: Input function. + + Function with the absolute values of the y values. + + + + Return the value of a function at an arbitrary position. + Instance represents: Input function. + + X coordinate at which the function should be evaluated. + Border treatment for the input function. Default: "constant" + Y value at the given x value. + + + + Return the value of a function at an arbitrary position. + Instance represents: Input function. + + X coordinate at which the function should be evaluated. + Border treatment for the input function. Default: "constant" + Y value at the given x value. + + + + Access a function value using the index of the control points. + Instance represents: Input function. + + Index of the control points. + X value at the given control points. + Y value at the given control points. + + + + Access a function value using the index of the control points. + Instance represents: Input function. + + Index of the control points. + X value at the given control points. + Y value at the given control points. + + + + Number of control points of the function. + Instance represents: Input function. + + Number of control points. + + + + Smallest and largest y value of the function. + Instance represents: Input function. + + Smallest y value. + Largest y value. + + + + Smallest and largest x value of the function. + Instance represents: Input function. + + Smallest x value. + Largest x value. + + + + Access to the x/y values of a function. + Instance represents: Input function. + + X values of the function. + Y values of the function. + + + + Sample a function equidistantly in an interval. + Instance represents: Input function. + + Minimum x value of the output function. + Maximum x value of the output function. + Distance of the samples. + Border treatment for the input function. Default: "constant" + Sampled function. + + + + Sample a function equidistantly in an interval. + Instance represents: Input function. + + Minimum x value of the output function. + Maximum x value of the output function. + Distance of the samples. + Border treatment for the input function. Default: "constant" + Sampled function. + + + + Transform a function using given transformation parameters. + Instance represents: Input function. + + Transformation parameters between the functions. + Transformed function. + + + + Calculate transformation parameters between two functions. + Instance represents: Function 1. + + Function 2. + Border treatment for function 2. Default: "constant" + Values of the parameters to remain constant. Default: [1.0,0.0,1.0,0.0] + Should a parameter be adapted for it? Default: ["true","true","true","true"] + Quadratic error of the output function. + Covariance Matrix of the transformation parameters. + Transformation parameters between the functions. + + + + Compute the distance of two functions. + Instance represents: Input function 1. + + Input function 2. + Modes of invariants. Default: "length" + Variance of the optional smoothing with a Gaussian filter. Default: 0.0 + Distance of the functions. + + + + Compute the distance of two functions. + Instance represents: Input function 1. + + Input function 2. + Modes of invariants. Default: "length" + Variance of the optional smoothing with a Gaussian filter. Default: 0.0 + Distance of the functions. + + + + Smooth an equidistant 1D function with a Gaussian function. + Instance represents: Function to be smoothed. + + Sigma of the Gaussian function for the smoothing. Default: 2.0 + Smoothed function. + + + + Compute the positive and negative areas of a function. + Instance represents: Input function. + + Area under the negative part of the function. + Area under the positive part of the function. + + + + Read a function from a file. + Modified instance represents: Function from the file. + + Name of the file to be read. + + + + Write a function to a file. + Instance represents: Function to be written. + + Name of the file to be written. + + + + Create a function from a sequence of y-values. + Modified instance represents: Created function. + + X value for function points. + + + + Create a function from a sequence of y-values. + Modified instance represents: Created function. + + X value for function points. + + + + Create a function from a set of (x,y) pairs. + Modified instance represents: Created function. + + X value for function points. + Y-value for function points. + + + + Create a function from a set of (x,y) pairs. + Modified instance represents: Created function. + + X value for function points. + Y-value for function points. + + + + Smooth an equidistant 1D function by averaging its values. + Instance represents: 1D function. + + Size of the averaging mask. Default: 9 + Number of iterations for the smoothing. Default: 3 + Smoothed function. + + + Represents an instance of a connection to a gnuplot process. + + + + Plot a function using gnuplot. + Instance represents: Identifier for the gnuplot output stream. + + Function to be plotted. + + + + Plot control values using gnuplot. + Instance represents: Identifier for the gnuplot output stream. + + Control values to be plotted (y-values). + + + + Visualize images using gnuplot. + Instance represents: Identifier for the gnuplot output stream. + + Image to be plotted. + Number of samples in the x-direction. Default: 64 + Number of samples in the y-direction. Default: 64 + Rotation of the plot about the x-axis. Default: 60 + Rotation of the plot about the z-axis. Default: 30 + Plot the image with hidden surfaces removed. Default: "hidden3d" + + + + Visualize images using gnuplot. + Instance represents: Identifier for the gnuplot output stream. + + Image to be plotted. + Number of samples in the x-direction. Default: 64 + Number of samples in the y-direction. Default: 64 + Rotation of the plot about the x-axis. Default: 60 + Rotation of the plot about the z-axis. Default: 30 + Plot the image with hidden surfaces removed. Default: "hidden3d" + + + + Close all open gnuplot files or terminate an active gnuplot sub-process. + Instance represents: Identifier for the gnuplot output stream. + + + + + Open a gnuplot file for visualization of images and control values. + Modified instance represents: Identifier for the gnuplot output stream. + + Base name for control and data files. + + + + Open a pipe to a gnuplot process for visualization of images and control values. + Modified instance represents: Identifier for the gnuplot output stream. + + + + Represents a homogeneous 2D transformation matrix. + + + + Generate the homogeneous transformation matrix of the identical 2D transformation. + Modified instance represents: Transformation matrix. + + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + + Read the geo coding from an ARC/INFO world file. + Modified instance represents: Transformation matrix from image to world coordinates. + + Name of the ARC/INFO world file. + + + + Apply a projective transformation to an XLD contour. + Instance represents: Homogeneous projective transformation matrix. + + Input contours. + Output contours. + + + + Apply an arbitrary affine transformation to XLD polygons. + Instance represents: Input transformation matrix. + + Input XLD polygons. + Transformed XLD polygons. + + + + Apply an arbitrary affine 2D transformation to XLD contours. + Instance represents: Input transformation matrix. + + Input XLD contours. + Transformed XLD contours. + + + + Deserialize a serialized homogeneous 2D transformation matrix. + Modified instance represents: Transformation matrix. + + Handle of the serialized item. + + + + Serialize a homogeneous 2D transformation matrix. + Instance represents: Transformation matrix. + + Handle of the serialized item. + + + Perform a bundle adjustment of an image mosaic. + Number of different images that are used for the calibration. + Index of the reference image. + Indices of the source images of the transformations. + Indices of the target images of the transformations. + Array of 3x3 projective transformation matrices. + Row coordinates of corresponding points in the respective source images. + Column coordinates of corresponding points in the respective source images. + Row coordinates of corresponding points in the respective destination images. + Column coordinates of corresponding points in the respective destination images. + Number of point correspondences in the respective image pair. + Transformation class to be used. Default: "projective" + Row coordinates of the points reconstructed by the bundle adjustment. + Column coordinates of the points reconstructed by the bundle adjustment. + Average error per reconstructed point. + Array of 3x3 projective transformation matrices that determine the position of the images in the mosaic. + + + Perform a bundle adjustment of an image mosaic. + Number of different images that are used for the calibration. + Index of the reference image. + Indices of the source images of the transformations. + Indices of the target images of the transformations. + Array of 3x3 projective transformation matrices. + Row coordinates of corresponding points in the respective source images. + Column coordinates of corresponding points in the respective source images. + Row coordinates of corresponding points in the respective destination images. + Column coordinates of corresponding points in the respective destination images. + Number of point correspondences in the respective image pair. + Transformation class to be used. Default: "projective" + Row coordinates of the points reconstructed by the bundle adjustment. + Column coordinates of the points reconstructed by the bundle adjustment. + Average error per reconstructed point. + Array of 3x3 projective transformation matrices that determine the position of the images in the mosaic. + + + + Compute a projective transformation matrix and the radial distortion coefficient between two images by finding correspondences between points based on known approximations of the projective transformation matrix and the radial distortion coefficient. + Instance represents: Approximation of the homogeneous projective transformation matrix between the two images. + + Input image 1. + Input image 2. + Input points in image 1 (row coordinate). + Input points in image 1 (column coordinate). + Input points in image 2 (row coordinate). + Input points in image 2 (column coordinate). + Gray value match metric. Default: "ncc" + Size of gray value masks. Default: 10 + Approximation of the radial distortion coefficient in the two images. + Tolerance for the matching search window. Default: 20.0 + Threshold for gray value matching. Default: 0.7 + Algorithm for the computation of the projective transformation matrix. Default: "gold_standard" + Threshold for transformation consistency check. Default: 1 + Seed for the random number generator. Default: 0 + Computed radial distortion coefficient. + Root-Mean-Square transformation error. + Indices of matched input points in image 1. + Indices of matched input points in image 2. + Computed homogeneous projective transformation matrix. + + + + Compute a projective transformation matrix and the radial distortion coefficient between two images by finding correspondences between points based on known approximations of the projective transformation matrix and the radial distortion coefficient. + Instance represents: Approximation of the homogeneous projective transformation matrix between the two images. + + Input image 1. + Input image 2. + Input points in image 1 (row coordinate). + Input points in image 1 (column coordinate). + Input points in image 2 (row coordinate). + Input points in image 2 (column coordinate). + Gray value match metric. Default: "ncc" + Size of gray value masks. Default: 10 + Approximation of the radial distortion coefficient in the two images. + Tolerance for the matching search window. Default: 20.0 + Threshold for gray value matching. Default: 0.7 + Algorithm for the computation of the projective transformation matrix. Default: "gold_standard" + Threshold for transformation consistency check. Default: 1 + Seed for the random number generator. Default: 0 + Computed radial distortion coefficient. + Root-Mean-Square transformation error. + Indices of matched input points in image 1. + Indices of matched input points in image 2. + Computed homogeneous projective transformation matrix. + + + + Compute a projective transformation matrix between two images and the radial distortion coefficient by automatically finding correspondences between points. + Modified instance represents: Computed homogeneous projective transformation matrix. + + Input image 1. + Input image 2. + Input points in image 1 (row coordinate). + Input points in image 1 (column coordinate). + Input points in image 2 (row coordinate). + Input points in image 2 (column coordinate). + Gray value match metric. Default: "ncc" + Size of gray value masks. Default: 10 + Average row coordinate offset of corresponding points. Default: 0 + Average column coordinate offset of corresponding points. Default: 0 + Half height of matching search window. Default: 200 + Half width of matching search window. Default: 200 + Estimate of the relative rotation of the second image with respect to the first image. Default: 0.0 + Threshold for gray value matching. Default: 0.7 + Algorithm for the computation of the projective transformation matrix. Default: "gold_standard" + Threshold for the transformation consistency check. Default: 1 + Seed for the random number generator. Default: 0 + Root-Mean-Square transformation error. + Indices of matched input points in image 1. + Indices of matched input points in image 2. + Computed radial distortion coefficient. + + + + Compute a projective transformation matrix between two images and the radial distortion coefficient by automatically finding correspondences between points. + Modified instance represents: Computed homogeneous projective transformation matrix. + + Input image 1. + Input image 2. + Input points in image 1 (row coordinate). + Input points in image 1 (column coordinate). + Input points in image 2 (row coordinate). + Input points in image 2 (column coordinate). + Gray value match metric. Default: "ncc" + Size of gray value masks. Default: 10 + Average row coordinate offset of corresponding points. Default: 0 + Average column coordinate offset of corresponding points. Default: 0 + Half height of matching search window. Default: 200 + Half width of matching search window. Default: 200 + Estimate of the relative rotation of the second image with respect to the first image. Default: 0.0 + Threshold for gray value matching. Default: 0.7 + Algorithm for the computation of the projective transformation matrix. Default: "gold_standard" + Threshold for the transformation consistency check. Default: 1 + Seed for the random number generator. Default: 0 + Root-Mean-Square transformation error. + Indices of matched input points in image 1. + Indices of matched input points in image 2. + Computed radial distortion coefficient. + + + + Compute a projective transformation matrix between two images by finding correspondences between points based on a known approximation of the projective transformation matrix. + Instance represents: Approximation of the Homogeneous projective transformation matrix between the two images. + + Input image 1. + Input image 2. + Row coordinates of characteristic points in image 1. + Column coordinates of characteristic points in image 1. + Row coordinates of characteristic points in image 2. + Column coordinates of characteristic points in image 2. + Gray value comparison metric. Default: "ssd" + Size of gray value masks. Default: 10 + Tolerance for the matching search window. Default: 20.0 + Threshold for gray value matching. Default: 10 + Transformation matrix estimation algorithm. Default: "normalized_dlt" + Threshold for transformation consistency check. Default: 0.2 + Seed for the random number generator. Default: 0 + Indices of matched input points in image 1. + Indices of matched input points in image 2. + Homogeneous projective transformation matrix. + + + + Compute a projective transformation matrix between two images by finding correspondences between points based on a known approximation of the projective transformation matrix. + Instance represents: Approximation of the Homogeneous projective transformation matrix between the two images. + + Input image 1. + Input image 2. + Row coordinates of characteristic points in image 1. + Column coordinates of characteristic points in image 1. + Row coordinates of characteristic points in image 2. + Column coordinates of characteristic points in image 2. + Gray value comparison metric. Default: "ssd" + Size of gray value masks. Default: 10 + Tolerance for the matching search window. Default: 20.0 + Threshold for gray value matching. Default: 10 + Transformation matrix estimation algorithm. Default: "normalized_dlt" + Threshold for transformation consistency check. Default: 0.2 + Seed for the random number generator. Default: 0 + Indices of matched input points in image 1. + Indices of matched input points in image 2. + Homogeneous projective transformation matrix. + + + + Compute a projective transformation matrix between two images by finding correspondences between points. + Modified instance represents: Homogeneous projective transformation matrix. + + Input image 1. + Input image 2. + Row coordinates of characteristic points in image 1. + Column coordinates of characteristic points in image 1. + Row coordinates of characteristic points in image 2. + Column coordinates of characteristic points in image 2. + Gray value comparison metric. Default: "ssd" + Size of gray value masks. Default: 10 + Average row coordinate shift. Default: 0 + Average column coordinate shift. Default: 0 + Half height of matching search window. Default: 256 + Half width of matching search window. Default: 256 + Range of rotation angles. Default: 0.0 + Threshold for gray value matching. Default: 10 + Transformation matrix estimation algorithm. Default: "normalized_dlt" + Threshold for transformation consistency check. Default: 0.2 + Seed for the random number generator. Default: 0 + Indices of matched input points in image 2. + Indices of matched input points in image 1. + + + + Compute a projective transformation matrix between two images by finding correspondences between points. + Modified instance represents: Homogeneous projective transformation matrix. + + Input image 1. + Input image 2. + Row coordinates of characteristic points in image 1. + Column coordinates of characteristic points in image 1. + Row coordinates of characteristic points in image 2. + Column coordinates of characteristic points in image 2. + Gray value comparison metric. Default: "ssd" + Size of gray value masks. Default: 10 + Average row coordinate shift. Default: 0 + Average column coordinate shift. Default: 0 + Half height of matching search window. Default: 256 + Half width of matching search window. Default: 256 + Range of rotation angles. Default: 0.0 + Threshold for gray value matching. Default: 10 + Transformation matrix estimation algorithm. Default: "normalized_dlt" + Threshold for transformation consistency check. Default: 0.2 + Seed for the random number generator. Default: 0 + Indices of matched input points in image 2. + Indices of matched input points in image 1. + + + + Compute a projective transformation matrix and the radial distortion coefficient using given image point correspondences. + Modified instance represents: Homogeneous projective transformation matrix. + + Input points in image 1 (row coordinate). + Input points in image 1 (column coordinate). + Input points in image 2 (row coordinate). + Input points in image 2 (column coordinate). + Row coordinate variance of the points in image 1. Default: [] + Covariance of the points in image 1. Default: [] + Column coordinate variance of the points in image 1. Default: [] + Row coordinate variance of the points in image 2. Default: [] + Covariance of the points in image 2. Default: [] + Column coordinate variance of the points in image 2. Default: [] + Width of the images from which the points were extracted. + Height of the images from which the points were extracted. + Estimation algorithm. Default: "gold_standard" + Root-Mean-Square transformation error. + Computed radial distortion coefficient. + + + + Compute a homogeneous transformation matrix using given point correspondences. + Modified instance represents: Homogeneous projective transformation matrix. + + Input points 1 (x coordinate). + Input points 1 (y coordinate). + Input points 1 (w coordinate). + Input points 2 (x coordinate). + Input points 2 (y coordinate). + Input points 2 (w coordinate). + Estimation algorithm. Default: "normalized_dlt" + + + + Compute a projective transformation matrix using given point correspondences. + Modified instance represents: Homogeneous projective transformation matrix. + + Input points in image 1 (row coordinate). + Input points in image 1 (column coordinate). + Input points in image 2 (row coordinate). + Input points in image 2 (column coordinate). + Estimation algorithm. Default: "normalized_dlt" + Row coordinate variance of the points in image 1. Default: [] + Column coordinate variance of the points in image 1. Default: [] + Covariance of the points in image 1. Default: [] + Row coordinate variance of the points in image 2. Default: [] + Column coordinate variance of the points in image 2. Default: [] + Covariance of the points in image 2. Default: [] + 9x9 covariance matrix of the projective transformation matrix. + + + + Compute the affine transformation parameters from a homogeneous 2D transformation matrix. + Instance represents: Input transformation matrix. + + Scaling factor along the y direction. + Rotation angle. + Slant angle. + Translation along the x direction. + Translation along the y direction. + Scaling factor along the x direction. + + + + Compute a rigid affine transformation from points and angles. + Modified instance represents: Output transformation matrix. + + Row coordinate of the original point. + Column coordinate of the original point. + Angle of the original point. + Row coordinate of the transformed point. + Column coordinate of the transformed point. + Angle of the transformed point. + + + + Compute a rigid affine transformation from points and angles. + Modified instance represents: Output transformation matrix. + + Row coordinate of the original point. + Column coordinate of the original point. + Angle of the original point. + Row coordinate of the transformed point. + Column coordinate of the transformed point. + Angle of the transformed point. + + + + Approximate an affine transformation from point-to-line correspondences. + Modified instance represents: Output transformation matrix. + + Type of the transformation to compute. Default: "rigid" + X coordinates of the original points. + Y coordinates of the original points. + X coordinates of the first point on the corresponding line. + Y coordinates of the first point on the corresponding line. + X coordinates of the second point on the corresponding line. + Y coordinates of the second point on the corresponding line. + + + + Approximate a rigid affine transformation from point correspondences. + Modified instance represents: Output transformation matrix. + + X coordinates of the original points. + Y coordinates of the original points. + X coordinates of the transformed points. + Y coordinates of the transformed points. + + + + Approximate an similarity transformation from point correspondences. + Modified instance represents: Output transformation matrix. + + X coordinates of the original points. + Y coordinates of the original points. + X coordinates of the transformed points. + Y coordinates of the transformed points. + + + + Approximate an anisotropic similarity transformation from point correspondences. + Modified instance represents: Output transformation matrix. + + X coordinates of the original points. + Y coordinates of the original points. + X coordinates of the transformed points. + Y coordinates of the transformed points. + + + + Approximate an affine transformation from point correspondences. + Modified instance represents: Output transformation matrix. + + X coordinates of the original points. + Y coordinates of the original points. + X coordinates of the transformed points. + Y coordinates of the transformed points. + + + + Project pixel coordinates using a homogeneous projective transformation matrix. + Instance represents: Homogeneous projective transformation matrix. + + Input pixel(s) (row coordinate). Default: 64 + Input pixel(s) (column coordinate). Default: 64 + Output pixel(s) (row coordinate). + Output pixel(s) (column coordinate). + + + + Project pixel coordinates using a homogeneous projective transformation matrix. + Instance represents: Homogeneous projective transformation matrix. + + Input pixel(s) (row coordinate). Default: 64 + Input pixel(s) (column coordinate). Default: 64 + Output pixel(s) (row coordinate). + Output pixel(s) (column coordinate). + + + + Project a homogeneous 2D point using a projective transformation matrix. + Instance represents: Homogeneous projective transformation matrix. + + Input point (x coordinate). + Input point (y coordinate). + Input point (w coordinate). + Output point (y coordinate). + Output point (w coordinate). + Output point (x coordinate). + + + + Project a homogeneous 2D point using a projective transformation matrix. + Instance represents: Homogeneous projective transformation matrix. + + Input point (x coordinate). + Input point (y coordinate). + Input point (w coordinate). + Output point (y coordinate). + Output point (w coordinate). + Output point (x coordinate). + + + + Apply an arbitrary affine 2D transformation to pixel coordinates. + Instance represents: Input transformation matrix. + + Input pixel(s) (row coordinate). Default: 64 + Input pixel(s) (column coordinate). Default: 64 + Output pixel(s) (row coordinate). + Output pixel(s) (column coordinate). + + + + Apply an arbitrary affine 2D transformation to pixel coordinates. + Instance represents: Input transformation matrix. + + Input pixel(s) (row coordinate). Default: 64 + Input pixel(s) (column coordinate). Default: 64 + Output pixel(s) (row coordinate). + Output pixel(s) (column coordinate). + + + + Apply an arbitrary affine 2D transformation to points. + Instance represents: Input transformation matrix. + + Input point(s) (x or row coordinate). Default: 64 + Input point(s) (y or column coordinate). Default: 64 + Output point(s) (y or column coordinate). + Output point(s) (x or row coordinate). + + + + Apply an arbitrary affine 2D transformation to points. + Instance represents: Input transformation matrix. + + Input point(s) (x or row coordinate). Default: 64 + Input point(s) (y or column coordinate). Default: 64 + Output point(s) (y or column coordinate). + Output point(s) (x or row coordinate). + + + + Compute the determinant of a homogeneous 2D transformation matrix. + Instance represents: Input transformation matrix. + + Determinant of the input matrix. + + + + Transpose a homogeneous 2D transformation matrix. + Instance represents: Input transformation matrix. + + Output transformation matrix. + + + + Invert a homogeneous 2D transformation matrix. + Instance represents: Input transformation matrix. + + Output transformation matrix. + + + + Multiply two homogeneous 2D transformation matrices. + Instance represents: Left input transformation matrix. + + Right input transformation matrix. + Output transformation matrix. + + + + Add a reflection to a homogeneous 2D transformation matrix. + Instance represents: Input transformation matrix. + + Point that defines the axis (x coordinate). Default: 16 + Point that defines the axis (y coordinate). Default: 32 + Output transformation matrix. + + + + Add a reflection to a homogeneous 2D transformation matrix. + Instance represents: Input transformation matrix. + + Point that defines the axis (x coordinate). Default: 16 + Point that defines the axis (y coordinate). Default: 32 + Output transformation matrix. + + + + Add a reflection to a homogeneous 2D transformation matrix. + Instance represents: Input transformation matrix. + + First point of the axis (x coordinate). Default: 0 + First point of the axis (y coordinate). Default: 0 + Second point of the axis (x coordinate). Default: 16 + Second point of the axis (y coordinate). Default: 32 + Output transformation matrix. + + + + Add a reflection to a homogeneous 2D transformation matrix. + Instance represents: Input transformation matrix. + + First point of the axis (x coordinate). Default: 0 + First point of the axis (y coordinate). Default: 0 + Second point of the axis (x coordinate). Default: 16 + Second point of the axis (y coordinate). Default: 32 + Output transformation matrix. + + + + Add a slant to a homogeneous 2D transformation matrix. + Instance represents: Input transformation matrix. + + Slant angle. Default: 0.78 + Coordinate axis that is slanted. Default: "x" + Output transformation matrix. + + + + Add a slant to a homogeneous 2D transformation matrix. + Instance represents: Input transformation matrix. + + Slant angle. Default: 0.78 + Coordinate axis that is slanted. Default: "x" + Output transformation matrix. + + + + Add a slant to a homogeneous 2D transformation matrix. + Instance represents: Input transformation matrix. + + Slant angle. Default: 0.78 + Coordinate axis that is slanted. Default: "x" + Fixed point of the transformation (x coordinate). Default: 0 + Fixed point of the transformation (y coordinate). Default: 0 + Output transformation matrix. + + + + Add a slant to a homogeneous 2D transformation matrix. + Instance represents: Input transformation matrix. + + Slant angle. Default: 0.78 + Coordinate axis that is slanted. Default: "x" + Fixed point of the transformation (x coordinate). Default: 0 + Fixed point of the transformation (y coordinate). Default: 0 + Output transformation matrix. + + + + Add a rotation to a homogeneous 2D transformation matrix. + Instance represents: Input transformation matrix. + + Rotation angle. Default: 0.78 + Output transformation matrix. + + + + Add a rotation to a homogeneous 2D transformation matrix. + Instance represents: Input transformation matrix. + + Rotation angle. Default: 0.78 + Output transformation matrix. + + + + Add a rotation to a homogeneous 2D transformation matrix. + Instance represents: Input transformation matrix. + + Rotation angle. Default: 0.78 + Fixed point of the transformation (x coordinate). Default: 0 + Fixed point of the transformation (y coordinate). Default: 0 + Output transformation matrix. + + + + Add a rotation to a homogeneous 2D transformation matrix. + Instance represents: Input transformation matrix. + + Rotation angle. Default: 0.78 + Fixed point of the transformation (x coordinate). Default: 0 + Fixed point of the transformation (y coordinate). Default: 0 + Output transformation matrix. + + + + Add a scaling to a homogeneous 2D transformation matrix. + Instance represents: Input transformation matrix. + + Scale factor along the x-axis. Default: 2 + Scale factor along the y-axis. Default: 2 + Output transformation matrix. + + + + Add a scaling to a homogeneous 2D transformation matrix. + Instance represents: Input transformation matrix. + + Scale factor along the x-axis. Default: 2 + Scale factor along the y-axis. Default: 2 + Output transformation matrix. + + + + Add a scaling to a homogeneous 2D transformation matrix. + Instance represents: Input transformation matrix. + + Scale factor along the x-axis. Default: 2 + Scale factor along the y-axis. Default: 2 + Fixed point of the transformation (x coordinate). Default: 0 + Fixed point of the transformation (y coordinate). Default: 0 + Output transformation matrix. + + + + Add a scaling to a homogeneous 2D transformation matrix. + Instance represents: Input transformation matrix. + + Scale factor along the x-axis. Default: 2 + Scale factor along the y-axis. Default: 2 + Fixed point of the transformation (x coordinate). Default: 0 + Fixed point of the transformation (y coordinate). Default: 0 + Output transformation matrix. + + + + Add a translation to a homogeneous 2D transformation matrix. + Instance represents: Input transformation matrix. + + Translation along the x-axis. Default: 64 + Translation along the y-axis. Default: 64 + Output transformation matrix. + + + + Add a translation to a homogeneous 2D transformation matrix. + Instance represents: Input transformation matrix. + + Translation along the x-axis. Default: 64 + Translation along the y-axis. Default: 64 + Output transformation matrix. + + + + Add a translation to a homogeneous 2D transformation matrix. + Instance represents: Input transformation matrix. + + Translation along the x-axis. Default: 64 + Translation along the y-axis. Default: 64 + Output transformation matrix. + + + + Add a translation to a homogeneous 2D transformation matrix. + Instance represents: Input transformation matrix. + + Translation along the x-axis. Default: 64 + Translation along the y-axis. Default: 64 + Output transformation matrix. + + + + Generate the homogeneous transformation matrix of the identical 2D transformation. + Modified instance represents: Transformation matrix. + + + + + Compute the projective 3d reconstruction of points based on the fundamental matrix. + Instance represents: Fundamental matrix. + + Input points in image 1 (row coordinate). + Input points in image 1 (column coordinate). + Input points in image 2 (row coordinate). + Input points in image 2 (column coordinate). + Row coordinate variance of the points in image 1. Default: [] + Covariance of the points in image 1. Default: [] + Column coordinate variance of the points in image 1. Default: [] + Row coordinate variance of the points in image 2. Default: [] + Covariance of the points in image 2. Default: [] + Column coordinate variance of the points in image 2. Default: [] + 9x9 covariance matrix of the fundamental matrix. Default: [] + X coordinates of the reconstructed points in projective 3D space. + Y coordinates of the reconstructed points in projective 3D space. + Z coordinates of the reconstructed points in projective 3D space. + W coordinates of the reconstructed points in projective 3D space. + Covariance matrices of the reconstructed points. + + + + Compute the projective 3d reconstruction of points based on the fundamental matrix. + Instance represents: Fundamental matrix. + + Input points in image 1 (row coordinate). + Input points in image 1 (column coordinate). + Input points in image 2 (row coordinate). + Input points in image 2 (column coordinate). + Row coordinate variance of the points in image 1. Default: [] + Covariance of the points in image 1. Default: [] + Column coordinate variance of the points in image 1. Default: [] + Row coordinate variance of the points in image 2. Default: [] + Covariance of the points in image 2. Default: [] + Column coordinate variance of the points in image 2. Default: [] + 9x9 covariance matrix of the fundamental matrix. Default: [] + X coordinates of the reconstructed points in projective 3D space. + Y coordinates of the reconstructed points in projective 3D space. + Z coordinates of the reconstructed points in projective 3D space. + W coordinates of the reconstructed points in projective 3D space. + Covariance matrices of the reconstructed points. + + + + Compute the projective rectification of weakly calibrated binocular stereo images. + Instance represents: Fundamental matrix. + + Image coding the rectification of the 2. image. + 9x9 covariance matrix of the fundamental matrix. Default: [] + Width of the 1. image. Default: 512 + Height of the 1. image. Default: 512 + Width of the 2. image. Default: 512 + Height of the 2. image. Default: 512 + Subsampling factor. Default: 1 + Type of mapping. Default: "no_map" + 9x9 covariance matrix of the rectified fundamental matrix. + Projective transformation of the 1. image. + Projective transformation of the 2. image. + Image coding the rectification of the 1. image. + + + + Compute the projective rectification of weakly calibrated binocular stereo images. + Instance represents: Fundamental matrix. + + Image coding the rectification of the 2. image. + 9x9 covariance matrix of the fundamental matrix. Default: [] + Width of the 1. image. Default: 512 + Height of the 1. image. Default: 512 + Width of the 2. image. Default: 512 + Height of the 2. image. Default: 512 + Subsampling factor. Default: 1 + Type of mapping. Default: "no_map" + 9x9 covariance matrix of the rectified fundamental matrix. + Projective transformation of the 1. image. + Projective transformation of the 2. image. + Image coding the rectification of the 1. image. + + + + Compute the fundamental matrix and the radial distortion coefficient given a set of image point correspondences and reconstruct 3D points. + Modified instance represents: Computed fundamental matrix. + + Input points in image 1 (row coordinate). + Input points in image 1 (column coordinate). + Input points in image 2 (row coordinate). + Input points in image 2 (column coordinate). + Row coordinate variance of the points in image 1. Default: [] + Covariance of the points in image 1. Default: [] + Column coordinate variance of the points in image 1. Default: [] + Row coordinate variance of the points in image 2. Default: [] + Covariance of the points in image 2. Default: [] + Column coordinate variance of the points in image 2. Default: [] + Width of the images from which the points were extracted. + Height of the images from which the points were extracted. + Estimation algorithm. Default: "gold_standard" + Root-Mean-Square epipolar distance error. + X coordinates of the reconstructed points in projective 3D space. + Y coordinates of the reconstructed points in projective 3D space. + Z coordinates of the reconstructed points in projective 3D space. + W coordinates of the reconstructed points in projective 3D space. + Computed radial distortion coefficient. + + + + Compute the fundamental matrix from the relative orientation of two cameras. + Modified instance represents: Computed fundamental matrix. + + Relative orientation of the cameras (3D pose). + 6x6 covariance matrix of relative pose. Default: [] + Parameters of the 1. camera. + Parameters of the 2. camera. + 9x9 covariance matrix of the fundamental matrix. + + + + Compute the fundamental matrix from an essential matrix. + Instance represents: Essential matrix. + + 9x9 covariance matrix of the essential matrix. Default: [] + Camera matrix of the 1. camera. + Camera matrix of the 2. camera. + 9x9 covariance matrix of the fundamental matrix. + Computed fundamental matrix. + + + + Compute the essential matrix given image point correspondences and known camera matrices and reconstruct 3D points. + Instance represents: Camera matrix of the 1st camera. + + Input points in image 1 (row coordinate). + Input points in image 1 (column coordinate). + Input points in image 2 (row coordinate). + Input points in image 2 (column coordinate). + Row coordinate variance of the points in image 1. Default: [] + Covariance of the points in image 1. Default: [] + Column coordinate variance of the points in image 1. Default: [] + Row coordinate variance of the points in image 2. Default: [] + Covariance of the points in image 2. Default: [] + Column coordinate variance of the points in image 2. Default: [] + Camera matrix of the 2nd camera. + Algorithm for the computation of the essential matrix and for special camera orientations. Default: "normalized_dlt" + 9x9 covariance matrix of the essential matrix. + Root-Mean-Square of the epipolar distance error. + X coordinates of the reconstructed 3D points. + Y coordinates of the reconstructed 3D points. + Z coordinates of the reconstructed 3D points. + Covariance matrices of the reconstructed 3D points. + Computed essential matrix. + + + + Compute the essential matrix given image point correspondences and known camera matrices and reconstruct 3D points. + Instance represents: Camera matrix of the 1st camera. + + Input points in image 1 (row coordinate). + Input points in image 1 (column coordinate). + Input points in image 2 (row coordinate). + Input points in image 2 (column coordinate). + Row coordinate variance of the points in image 1. Default: [] + Covariance of the points in image 1. Default: [] + Column coordinate variance of the points in image 1. Default: [] + Row coordinate variance of the points in image 2. Default: [] + Covariance of the points in image 2. Default: [] + Column coordinate variance of the points in image 2. Default: [] + Camera matrix of the 2nd camera. + Algorithm for the computation of the essential matrix and for special camera orientations. Default: "normalized_dlt" + 9x9 covariance matrix of the essential matrix. + Root-Mean-Square of the epipolar distance error. + X coordinates of the reconstructed 3D points. + Y coordinates of the reconstructed 3D points. + Z coordinates of the reconstructed 3D points. + Covariance matrices of the reconstructed 3D points. + Computed essential matrix. + + + + Compute the fundamental matrix given a set of image point correspondences and reconstruct 3D points. + Modified instance represents: Computed fundamental matrix. + + Input points in image 1 (row coordinate). + Input points in image 1 (column coordinate). + Input points in image 2 (row coordinate). + Input points in image 2 (column coordinate). + Row coordinate variance of the points in image 1. Default: [] + Covariance of the points in image 1. Default: [] + Column coordinate variance of the points in image 1. Default: [] + Row coordinate variance of the points in image 2. Default: [] + Covariance of the points in image 2. Default: [] + Column coordinate variance of the points in image 2. Default: [] + Estimation algorithm. Default: "normalized_dlt" + Root-Mean-Square of the epipolar distance error. + X coordinates of the reconstructed points in projective 3D space. + Y coordinates of the reconstructed points in projective 3D space. + Z coordinates of the reconstructed points in projective 3D space. + W coordinates of the reconstructed points in projective 3D space. + Covariance matrices of the reconstructed 3D points. + 9x9 covariance matrix of the fundamental matrix. + + + + Compute the fundamental matrix and the radial distortion coefficient for a pair of stereo images by automatically finding correspondences between image points. + Modified instance represents: Computed fundamental matrix. + + Input image 1. + Input image 2. + Input points in image 1 (row coordinate). + Input points in image 1 (column coordinate). + Input points in image 2 (row coordinate). + Input points in image 2 (column coordinate). + Gray value match metric. Default: "ncc" + Size of gray value masks. Default: 10 + Average row coordinate offset of corresponding points. Default: 0 + Average column coordinate offset of corresponding points. Default: 0 + Half height of matching search window. Default: 200 + Half width of matching search window. Default: 200 + Estimate of the relative rotation of the second image with respect to the first image. Default: 0.0 + Threshold for gray value matching. Default: 0.7 + Algorithm for the computation of the fundamental matrix and for special camera orientations. Default: "gold_standard" + Maximal deviation of a point from its epipolar line. Default: 1 + Seed for the random number generator. Default: 0 + Root-Mean-Square epipolar distance error. + Indices of matched input points in image 1. + Indices of matched input points in image 2. + Computed radial distortion coefficient. + + + + Compute the fundamental matrix and the radial distortion coefficient for a pair of stereo images by automatically finding correspondences between image points. + Modified instance represents: Computed fundamental matrix. + + Input image 1. + Input image 2. + Input points in image 1 (row coordinate). + Input points in image 1 (column coordinate). + Input points in image 2 (row coordinate). + Input points in image 2 (column coordinate). + Gray value match metric. Default: "ncc" + Size of gray value masks. Default: 10 + Average row coordinate offset of corresponding points. Default: 0 + Average column coordinate offset of corresponding points. Default: 0 + Half height of matching search window. Default: 200 + Half width of matching search window. Default: 200 + Estimate of the relative rotation of the second image with respect to the first image. Default: 0.0 + Threshold for gray value matching. Default: 0.7 + Algorithm for the computation of the fundamental matrix and for special camera orientations. Default: "gold_standard" + Maximal deviation of a point from its epipolar line. Default: 1 + Seed for the random number generator. Default: 0 + Root-Mean-Square epipolar distance error. + Indices of matched input points in image 1. + Indices of matched input points in image 2. + Computed radial distortion coefficient. + + + + Compute the essential matrix for a pair of stereo images by automatically finding correspondences between image points. + Instance represents: Camera matrix of the 1st camera. + + Input image 1. + Input image 2. + Row coordinates of characteristic points in image 1. + Column coordinates of characteristic points in image 1. + Row coordinates of characteristic points in image 2. + Column coordinates of characteristic points in image 2. + Camera matrix of the 2nd camera. + Gray value comparison metric. Default: "ssd" + Size of gray value masks. Default: 10 + Average row coordinate shift of corresponding points. Default: 0 + Average column coordinate shift of corresponding points. Default: 0 + Half height of matching search window. Default: 200 + Half width of matching search window. Default: 200 + Estimate of the relative orientation of the right image with respect to the left image. Default: 0.0 + Threshold for gray value matching. Default: 10 + Algorithm for the computation of the essential matrix and for special camera orientations. Default: "normalized_dlt" + Maximal deviation of a point from its epipolar line. Default: 1 + Seed for the random number generator. Default: 0 + 9x9 covariance matrix of the essential matrix. + Root-Mean-Square of the epipolar distance error. + Indices of matched input points in image 1. + Indices of matched input points in image 2. + Computed essential matrix. + + + + Compute the essential matrix for a pair of stereo images by automatically finding correspondences between image points. + Instance represents: Camera matrix of the 1st camera. + + Input image 1. + Input image 2. + Row coordinates of characteristic points in image 1. + Column coordinates of characteristic points in image 1. + Row coordinates of characteristic points in image 2. + Column coordinates of characteristic points in image 2. + Camera matrix of the 2nd camera. + Gray value comparison metric. Default: "ssd" + Size of gray value masks. Default: 10 + Average row coordinate shift of corresponding points. Default: 0 + Average column coordinate shift of corresponding points. Default: 0 + Half height of matching search window. Default: 200 + Half width of matching search window. Default: 200 + Estimate of the relative orientation of the right image with respect to the left image. Default: 0.0 + Threshold for gray value matching. Default: 10 + Algorithm for the computation of the essential matrix and for special camera orientations. Default: "normalized_dlt" + Maximal deviation of a point from its epipolar line. Default: 1 + Seed for the random number generator. Default: 0 + 9x9 covariance matrix of the essential matrix. + Root-Mean-Square of the epipolar distance error. + Indices of matched input points in image 1. + Indices of matched input points in image 2. + Computed essential matrix. + + + + Compute the fundamental matrix for a pair of stereo images by automatically finding correspondences between image points. + Modified instance represents: Computed fundamental matrix. + + Input image 1. + Input image 2. + Row coordinates of characteristic points in image 1. + Column coordinates of characteristic points in image 1. + Row coordinates of characteristic points in image 2. + Column coordinates of characteristic points in image 2. + Gray value comparison metric. Default: "ssd" + Size of gray value masks. Default: 10 + Average row coordinate shift of corresponding points. Default: 0 + Average column coordinate shift of corresponding points. Default: 0 + Half height of matching search window. Default: 200 + Half width of matching search window. Default: 200 + Estimate of the relative orientation of the right image with respect to the left image. Default: 0.0 + Threshold for gray value matching. Default: 10 + Algorithm for the computation of the fundamental matrix and for special camera orientations. Default: "normalized_dlt" + Maximal deviation of a point from its epipolar line. Default: 1 + Seed for the random number generator. Default: 0 + Root-Mean-Square of the epipolar distance error. + Indices of matched input points in image 1. + Indices of matched input points in image 2. + 9x9 covariance matrix of the fundamental matrix. + + + + Compute the fundamental matrix for a pair of stereo images by automatically finding correspondences between image points. + Modified instance represents: Computed fundamental matrix. + + Input image 1. + Input image 2. + Row coordinates of characteristic points in image 1. + Column coordinates of characteristic points in image 1. + Row coordinates of characteristic points in image 2. + Column coordinates of characteristic points in image 2. + Gray value comparison metric. Default: "ssd" + Size of gray value masks. Default: 10 + Average row coordinate shift of corresponding points. Default: 0 + Average column coordinate shift of corresponding points. Default: 0 + Half height of matching search window. Default: 200 + Half width of matching search window. Default: 200 + Estimate of the relative orientation of the right image with respect to the left image. Default: 0.0 + Threshold for gray value matching. Default: 10 + Algorithm for the computation of the fundamental matrix and for special camera orientations. Default: "normalized_dlt" + Maximal deviation of a point from its epipolar line. Default: 1 + Seed for the random number generator. Default: 0 + Root-Mean-Square of the epipolar distance error. + Indices of matched input points in image 1. + Indices of matched input points in image 2. + 9x9 covariance matrix of the fundamental matrix. + + + + Apply a projective transformation to a region. + Instance represents: Homogeneous projective transformation matrix. + + Input regions. + Interpolation method for the transformation. Default: "bilinear" + Output regions. + + + + Apply an arbitrary affine 2D transformation to regions. + Instance represents: Input transformation matrix. + + Region(s) to be rotated and scaled. + Should the transformation be done using interpolation? Default: "nearest_neighbor" + Transformed output region(s). + + + + Apply a projective transformation to an image and specify the output image size. + Instance represents: Homogeneous projective transformation matrix. + + Input image. + Interpolation method for the transformation. Default: "bilinear" + Output image width. + Output image height. + Should the domain of the input image also be transformed? Default: "false" + Output image. + + + + Apply a projective transformation to an image. + Instance represents: Homogeneous projective transformation matrix. + + Input image. + Interpolation method for the transformation. Default: "bilinear" + Adapt the size of the output image automatically? Default: "false" + Should the domain of the input image also be transformed? Default: "false" + Output image. + + + + Apply an arbitrary affine 2D transformation to an image and specify the output image size. + Instance represents: Input transformation matrix. + + Input image. + Type of interpolation. Default: "constant" + Width of the output image. Default: 640 + Height of the output image. Default: 480 + Transformed image. + + + + Apply an arbitrary affine 2D transformation to images. + Instance represents: Input transformation matrix. + + Input image. + Type of interpolation. Default: "constant" + Adaption of size of result image. Default: "false" + Transformed image. + + + + Approximate an affine map from a displacement vector field. + Modified instance represents: Output transformation matrix. + + Input image. + + + + Compute a camera matrix from internal camera parameters. + Modified instance represents: 3x3 projective camera matrix that corresponds to CameraParam. + + Internal camera parameters. + Width of the images that correspond to CameraMatrix. + Height of the images that correspond to CameraMatrix. + + + + Compute the internal camera parameters from a camera matrix. + Instance represents: 3x3 projective camera matrix that determines the internal camera parameters. + + Kappa. + Width of the images that correspond to CameraMatrix. + Height of the images that correspond to CameraMatrix. + Internal camera parameters. + + + Perform a self-calibration of a stationary projective camera. + Number of different images that are used for the calibration. + Width of the images from which the points were extracted. + Height of the images from which the points were extracted. + Index of the reference image. + Indices of the source images of the transformations. + Indices of the target images of the transformations. + Array of 3x3 projective transformation matrices. + Row coordinates of corresponding points in the respective source images. + Column coordinates of corresponding points in the respective source images. + Row coordinates of corresponding points in the respective destination images. + Column coordinates of corresponding points in the respective destination images. + Number of point correspondences in the respective image pair. + Estimation algorithm for the calibration. Default: "gold_standard" + Camera model to be used. Default: ["focus","principal_point"] + Are the camera parameters identical for all images? Default: "true" + Radial distortion of the camera. + Array of 3x3 transformation matrices that determine rotation of the camera in the respective image. + X-Component of the direction vector of each point if EstimationMethod $=$ 'gold_standard' is used. + Y-Component of the direction vector of each point if EstimationMethod $=$ 'gold_standard' is used. + Z-Component of the direction vector of each point if EstimationMethod $=$ 'gold_standard' is used. + Average error per reconstructed point if EstimationMethod $=$ 'gold_standard' is used. + (Array of) 3x3 projective camera matrices that determine the internal camera parameters. + + + Perform a self-calibration of a stationary projective camera. + Number of different images that are used for the calibration. + Width of the images from which the points were extracted. + Height of the images from which the points were extracted. + Index of the reference image. + Indices of the source images of the transformations. + Indices of the target images of the transformations. + Array of 3x3 projective transformation matrices. + Row coordinates of corresponding points in the respective source images. + Column coordinates of corresponding points in the respective source images. + Row coordinates of corresponding points in the respective destination images. + Column coordinates of corresponding points in the respective destination images. + Number of point correspondences in the respective image pair. + Estimation algorithm for the calibration. Default: "gold_standard" + Camera model to be used. Default: ["focus","principal_point"] + Are the camera parameters identical for all images? Default: "true" + Radial distortion of the camera. + Array of 3x3 transformation matrices that determine rotation of the camera in the respective image. + X-Component of the direction vector of each point if EstimationMethod $=$ 'gold_standard' is used. + Y-Component of the direction vector of each point if EstimationMethod $=$ 'gold_standard' is used. + Z-Component of the direction vector of each point if EstimationMethod $=$ 'gold_standard' is used. + Average error per reconstructed point if EstimationMethod $=$ 'gold_standard' is used. + (Array of) 3x3 projective camera matrices that determine the internal camera parameters. + + + Represents a homogeneous 3D transformation matrix. + + + + Generate the homogeneous transformation matrix of the identical 3D transformation. + Modified instance represents: Transformation matrix. + + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + + Deserialize a serialized homogeneous 3D transformation matrix. + Modified instance represents: Transformation matrix. + + Handle of the serialized item. + + + + Serialize a homogeneous 3D transformation matrix. + Instance represents: Transformation matrix. + + Handle of the serialized item. + + + + Project a homogeneous 3D point using a projective transformation matrix. + Instance represents: Homogeneous projective transformation matrix. + + Input point (x coordinate). + Input point (y coordinate). + Input point (z coordinate). + Input point (w coordinate). + Output point (y coordinate). + Output point (z coordinate). + Output point (w coordinate). + Output point (x coordinate). + + + + Project a homogeneous 3D point using a projective transformation matrix. + Instance represents: Homogeneous projective transformation matrix. + + Input point (x coordinate). + Input point (y coordinate). + Input point (z coordinate). + Input point (w coordinate). + Output point (y coordinate). + Output point (z coordinate). + Output point (w coordinate). + Output point (x coordinate). + + + + Project a 3D point using a projective transformation matrix. + Instance represents: Homogeneous projective transformation matrix. + + Input point (x coordinate). + Input point (y coordinate). + Input point (z coordinate). + Output point (y coordinate). + Output point (z coordinate). + Output point (x coordinate). + + + + Project a 3D point using a projective transformation matrix. + Instance represents: Homogeneous projective transformation matrix. + + Input point (x coordinate). + Input point (y coordinate). + Input point (z coordinate). + Output point (y coordinate). + Output point (z coordinate). + Output point (x coordinate). + + + + Apply an arbitrary affine 3D transformation to points. + Instance represents: Input transformation matrix. + + Input point(s) (x coordinate). Default: 64 + Input point(s) (y coordinate). Default: 64 + Input point(s) (z coordinate). Default: 64 + Output point(s) (y coordinate). + Output point(s) (z coordinate). + Output point(s) (x coordinate). + + + + Apply an arbitrary affine 3D transformation to points. + Instance represents: Input transformation matrix. + + Input point(s) (x coordinate). Default: 64 + Input point(s) (y coordinate). Default: 64 + Input point(s) (z coordinate). Default: 64 + Output point(s) (y coordinate). + Output point(s) (z coordinate). + Output point(s) (x coordinate). + + + + Approximate a 3D transformation from point correspondences. + Modified instance represents: Output transformation matrix. + + Type of the transformation to compute. Default: "rigid" + X coordinates of the original points. + Y coordinates of the original points. + Z coordinates of the original points. + X coordinates of the transformed points. + Y coordinates of the transformed points. + Z coordinates of the transformed points. + + + + Compute the determinant of a homogeneous 3D transformation matrix. + Instance represents: Input transformation matrix. + + Determinant of the input matrix. + + + + Transpose a homogeneous 3D transformation matrix. + Instance represents: Input transformation matrix. + + Output transformation matrix. + + + + Invert a homogeneous 3D transformation matrix. + Instance represents: Input transformation matrix. + + Output transformation matrix. + + + + Multiply two homogeneous 3D transformation matrices. + Instance represents: Left input transformation matrix. + + Right input transformation matrix. + Output transformation matrix. + + + + Add a rotation to a homogeneous 3D transformation matrix. + Instance represents: Input transformation matrix. + + Rotation angle. Default: 0.78 + Axis, to be rotated around. Default: "x" + Output transformation matrix. + + + + Add a rotation to a homogeneous 3D transformation matrix. + Instance represents: Input transformation matrix. + + Rotation angle. Default: 0.78 + Axis, to be rotated around. Default: "x" + Output transformation matrix. + + + + Add a rotation to a homogeneous 3D transformation matrix. + Instance represents: Input transformation matrix. + + Rotation angle. Default: 0.78 + Axis, to be rotated around. Default: "x" + Fixed point of the transformation (x coordinate). Default: 0 + Fixed point of the transformation (y coordinate). Default: 0 + Fixed point of the transformation (z coordinate). Default: 0 + Output transformation matrix. + + + + Add a rotation to a homogeneous 3D transformation matrix. + Instance represents: Input transformation matrix. + + Rotation angle. Default: 0.78 + Axis, to be rotated around. Default: "x" + Fixed point of the transformation (x coordinate). Default: 0 + Fixed point of the transformation (y coordinate). Default: 0 + Fixed point of the transformation (z coordinate). Default: 0 + Output transformation matrix. + + + + Add a scaling to a homogeneous 3D transformation matrix. + Instance represents: Input transformation matrix. + + Scale factor along the x-axis. Default: 2 + Scale factor along the y-axis. Default: 2 + Scale factor along the z-axis. Default: 2 + Output transformation matrix. + + + + Add a scaling to a homogeneous 3D transformation matrix. + Instance represents: Input transformation matrix. + + Scale factor along the x-axis. Default: 2 + Scale factor along the y-axis. Default: 2 + Scale factor along the z-axis. Default: 2 + Output transformation matrix. + + + + Add a scaling to a homogeneous 3D transformation matrix. + Instance represents: Input transformation matrix. + + Scale factor along the x-axis. Default: 2 + Scale factor along the y-axis. Default: 2 + Scale factor along the z-axis. Default: 2 + Fixed point of the transformation (x coordinate). Default: 0 + Fixed point of the transformation (y coordinate). Default: 0 + Fixed point of the transformation (z coordinate). Default: 0 + Output transformation matrix. + + + + Add a scaling to a homogeneous 3D transformation matrix. + Instance represents: Input transformation matrix. + + Scale factor along the x-axis. Default: 2 + Scale factor along the y-axis. Default: 2 + Scale factor along the z-axis. Default: 2 + Fixed point of the transformation (x coordinate). Default: 0 + Fixed point of the transformation (y coordinate). Default: 0 + Fixed point of the transformation (z coordinate). Default: 0 + Output transformation matrix. + + + + Add a translation to a homogeneous 3D transformation matrix. + Instance represents: Input transformation matrix. + + Translation along the x-axis. Default: 64 + Translation along the y-axis. Default: 64 + Translation along the z-axis. Default: 64 + Output transformation matrix. + + + + Add a translation to a homogeneous 3D transformation matrix. + Instance represents: Input transformation matrix. + + Translation along the x-axis. Default: 64 + Translation along the y-axis. Default: 64 + Translation along the z-axis. Default: 64 + Output transformation matrix. + + + + Add a translation to a homogeneous 3D transformation matrix. + Instance represents: Input transformation matrix. + + Translation along the x-axis. Default: 64 + Translation along the y-axis. Default: 64 + Translation along the z-axis. Default: 64 + Output transformation matrix. + + + + Add a translation to a homogeneous 3D transformation matrix. + Instance represents: Input transformation matrix. + + Translation along the x-axis. Default: 64 + Translation along the y-axis. Default: 64 + Translation along the z-axis. Default: 64 + Output transformation matrix. + + + + Generate the homogeneous transformation matrix of the identical 3D transformation. + Modified instance represents: Transformation matrix. + + + + + Project an affine 3D transformation matrix to a 2D projective transformation matrix. + Instance represents: 3x4 3D transformation matrix. + + Row coordinate of the principal point. Default: 256 + Column coordinate of the principal point. Default: 256 + Focal length in pixels. Default: 256 + Homogeneous projective transformation matrix. + + + + Project an affine 3D transformation matrix to a 2D projective transformation matrix. + Instance represents: 3x4 3D transformation matrix. + + Row coordinate of the principal point. Default: 256 + Column coordinate of the principal point. Default: 256 + Focal length in pixels. Default: 256 + Homogeneous projective transformation matrix. + + + + Project a homogeneous 3D point using a 3x4 projection matrix. + Instance represents: 3x4 projection matrix. + + Input point (x coordinate). + Input point (y coordinate). + Input point (z coordinate). + Input point (w coordinate). + Output point (y coordinate). + Output point (w coordinate). + Output point (x coordinate). + + + + Project a homogeneous 3D point using a 3x4 projection matrix. + Instance represents: 3x4 projection matrix. + + Input point (x coordinate). + Input point (y coordinate). + Input point (z coordinate). + Input point (w coordinate). + Output point (y coordinate). + Output point (w coordinate). + Output point (x coordinate). + + + + Project a 3D point using a 3x4 projection matrix. + Instance represents: 3x4 projection matrix. + + Input point (x coordinate). + Input point (y coordinate). + Input point (z coordinate). + Output point (y coordinate). + Output point (x coordinate). + + + + Project a 3D point using a 3x4 projection matrix. + Instance represents: 3x4 projection matrix. + + Input point (x coordinate). + Input point (y coordinate). + Input point (z coordinate). + Output point (y coordinate). + Output point (x coordinate). + + + + Convert a homogeneous transformation matrix into a 3D pose. + Instance represents: Homogeneous transformation matrix. + + Equivalent 3D pose. + + + Represents an instance of an image object(-array). + + + Represents an instance of an iconic object(-array). Base class for images, regions and XLDs + + + Represents an uninitialized HALCON object key + + + + Returns true if the iconic object has been initialized. + + + An object will be uninitialized when creating it with a + no-argument constructor or after calling Dispose(); + + + + + Returns a new HALCON ID referencing this iconic object, which will + remain valid even after this object is disposed (and vice versa). + This is only useful if the ID shall be used in another language + interface (in fact, the key needs to be externally disposed, + a feature not even offered by the .NET language interface). + + + + Releases the resources used by this tool object + + + Returns the HALCON ID for this iconic object + Caller must ensure that object is kept alive + + + Create an uninitialized iconic object + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + + Calculate the difference of two object tuples. + Instance represents: Object tuple 1. + + Object tuple 2. + Objects from Objects that are not part of ObjectsSub. + + + + Convert an "integer number" into an iconic object. + Modified instance represents: Created objects. + + Tuple of object surrogates. + + + + Convert an "integer number" into an iconic object. + Modified instance represents: Created objects. + + Tuple of object surrogates. + + + + Convert an iconic object into an "integer number." + Instance represents: Objects for which the surrogates are to be returned. + + Starting index of the surrogates to be returned. Default: 1 + Number of surrogates to be returned. Default: -1 + Tuple containing the surrogates. + + + + Copy an iconic object in the HALCON database. + Instance represents: Objects to be copied. + + Starting index of the objects to be copied. Default: 1 + Number of objects to be copied or -1. Default: 1 + Copied objects. + + + + Concatenate two iconic object tuples. + Instance represents: Object tuple 1. + + Object tuple 2. + Concatenated objects. + + + + Select objects from an object tuple. + Instance represents: Input objects. + + Indices of the objects to be selected. Default: 1 + Selected objects. + + + + Select objects from an object tuple. + Instance represents: Input objects. + + Indices of the objects to be selected. Default: 1 + Selected objects. + + + + Compare iconic objects regarding equality. + Instance represents: Reference objects. + + Test objects. + Maximum allowed difference between two gray values or coordinates etc. Default: 0.0 + Boolean result value. + + + + Compare iconic objects regarding equality. + Instance represents: Reference objects. + + Test objects. + Maximum allowed difference between two gray values or coordinates etc. Default: 0.0 + Boolean result value. + + + + Compare image objects regarding equality. + Instance represents: Test objects. + + Comparative objects. + boolean result value. + + + + Number of objects in a tuple. + Instance represents: Objects to be examined. + + Number of objects in the tuple Objects. + + + + Informations about the components of an image object. + Instance represents: Image object to be examined. + + Required information about object components. Default: "creator" + Components to be examined (0 for region/XLD). Default: 0 + Requested information. + + + + Informations about the components of an image object. + Instance represents: Image object to be examined. + + Required information about object components. Default: "creator" + Components to be examined (0 for region/XLD). Default: 0 + Requested information. + + + + Name of the class of an image object. + Instance represents: Image objects to be examined. + + Name of class. + + + + Create an empty object tuple. + Modified instance represents: No objects. + + + + + Displays image objects (image, region, XLD). + Instance represents: Image object to be displayed. + + Window handle. + + + + Read an iconic object. + Modified instance represents: Iconic object. + + Name of file. + + + + Write an iconic object. + Instance represents: Iconic object. + + Name of file. + + + + Deserialize a serialized iconic object. + Modified instance represents: Iconic object. + + Handle of the serialized item. + + + + Serialize an iconic object. + Instance represents: Iconic object. + + Handle of the serialized item. + + + + Insert objects into an iconic object tuple. + Instance represents: Input object tuple. + + Object tuple to insert. + Index to insert objects. + Extended object tuple. + + + + Remove objects from an iconic object tuple. + Instance represents: Input object tuple. + + Indices of the objects to be removed. + Remaining object tuple. + + + + Remove objects from an iconic object tuple. + Instance represents: Input object tuple. + + Indices of the objects to be removed. + Remaining object tuple. + + + + Replaces one or more elements of an iconic object tuple. + Instance represents: Iconic Input Object. + + Element(s) to replace. + Index/Indices of elements to be replaced. + Tuple with replaced elements. + + + + Replaces one or more elements of an iconic object tuple. + Instance represents: Iconic Input Object. + + Element(s) to replace. + Index/Indices of elements to be replaced. + Tuple with replaced elements. + + + Returns the iconic object(s) at the specified index + + + Create an uninitialized iconic object + + + + Create an image from a pointer to the pixels. + Modified instance represents: Created image with new image matrix. + + Pixel type. Default: "byte" + Width of image. Default: 512 + Height of image. Default: 512 + Pointer to first gray value. + + + + Create an image with constant gray value. + Modified instance represents: Created image with new image matrix. + + Pixel type. Default: "byte" + Width of image. Default: 512 + Height of image. Default: 512 + + + + Read an image with different file formats. + Modified instance represents: Read image. + + Name of the image to be read. Default: "printer_chip/printer_chip_01" + + + + Read an image with different file formats. + Modified instance represents: Read image. + + Name of the image to be read. Default: "printer_chip/printer_chip_01" + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + Inverts an image + + + Adds two images + + + Subtracts image2 from image1 + + + Multiplies two images + + + Adds a constant gray value offset + + + Adds a constant gray value offset + + + Subtracts a constant gray value offset + + + Scales an image by the specified factor + + + Scales an image by the specified factor + + + Scales an image by the specified divisor + + + Segment image using dynamic threshold + + + Segment image using dynamic threshold + + + Segment image using constant threshold + + + Segment image using constant threshold + + + Segment image using constant threshold + + + Segment image using constant threshold + + + Reduces the domain of an image + + + Returns the domain of an image + + + + Image restoration by Wiener filtering. + Instance represents: Corrupted image. + + impulse response (PSF) of degradation (in spatial domain). + Region for noise estimation. + Width of filter mask. Default: 3 + Height of filter mask. Default: 3 + Restored image. + + + + Image restoration by Wiener filtering. + Instance represents: Corrupted image. + + impulse response (PSF) of degradation (in spatial domain). + Smoothed version of corrupted image. + Restored image. + + + + Generate an impulse response of a (linearly) motion blurring. + Modified instance represents: Impulse response of motion-blur. + + Width of impulse response image. Default: 256 + Height of impulse response image. Default: 256 + Degree of motion-blur. Default: 20.0 + Angle between direction of motion and x-axis (anticlockwise). Default: 0 + PSF prototype resp. type of motion. Default: 3 + + + + Simulation of (linearly) motion blur. + Instance represents: image to be blurred. + + extent of blurring. Default: 20.0 + Angle between direction of motion and x-axis (anticlockwise). Default: 0 + impulse response of motion blur. Default: 3 + motion blurred image. + + + + Generate an impulse response of an uniform out-of-focus blurring. + Modified instance represents: Impulse response of uniform out-of-focus blurring. + + Width of result image. Default: 256 + Height of result image. Default: 256 + Degree of Blurring. Default: 5.0 + + + + Simulate an uniform out-of-focus blurring of an image. + Instance represents: Image to blur. + + Degree of blurring. Default: 5.0 + Blurred image. + + + + Compare an image to a variation model. + Instance represents: Image of the object to be compared. + + ID of the variation model. + Method used for comparing the variation model. Default: "absolute" + Region containing the points that differ substantially from the model. + + + + Compare an image to a variation model. + Instance represents: Image of the object to be compared. + + ID of the variation model. + Region containing the points that differ substantially from the model. + + + + Train a variation model. + Instance represents: Images of the object to be trained. + + ID of the variation model. + + + + Compute a projective transformation matrix and the radial distortion coefficient between two images by finding correspondences between points based on known approximations of the projective transformation matrix and the radial distortion coefficient. + Instance represents: Input image 1. + + Input image 2. + Input points in image 1 (row coordinate). + Input points in image 1 (column coordinate). + Input points in image 2 (row coordinate). + Input points in image 2 (column coordinate). + Gray value match metric. Default: "ncc" + Size of gray value masks. Default: 10 + Approximation of the homogeneous projective transformation matrix between the two images. + Approximation of the radial distortion coefficient in the two images. + Tolerance for the matching search window. Default: 20.0 + Threshold for gray value matching. Default: 0.7 + Algorithm for the computation of the projective transformation matrix. Default: "gold_standard" + Threshold for transformation consistency check. Default: 1 + Seed for the random number generator. Default: 0 + Computed radial distortion coefficient. + Root-Mean-Square transformation error. + Indices of matched input points in image 1. + Indices of matched input points in image 2. + Computed homogeneous projective transformation matrix. + + + + Compute a projective transformation matrix and the radial distortion coefficient between two images by finding correspondences between points based on known approximations of the projective transformation matrix and the radial distortion coefficient. + Instance represents: Input image 1. + + Input image 2. + Input points in image 1 (row coordinate). + Input points in image 1 (column coordinate). + Input points in image 2 (row coordinate). + Input points in image 2 (column coordinate). + Gray value match metric. Default: "ncc" + Size of gray value masks. Default: 10 + Approximation of the homogeneous projective transformation matrix between the two images. + Approximation of the radial distortion coefficient in the two images. + Tolerance for the matching search window. Default: 20.0 + Threshold for gray value matching. Default: 0.7 + Algorithm for the computation of the projective transformation matrix. Default: "gold_standard" + Threshold for transformation consistency check. Default: 1 + Seed for the random number generator. Default: 0 + Computed radial distortion coefficient. + Root-Mean-Square transformation error. + Indices of matched input points in image 1. + Indices of matched input points in image 2. + Computed homogeneous projective transformation matrix. + + + + Compute a projective transformation matrix between two images and the radial distortion coefficient by automatically finding correspondences between points. + Instance represents: Input image 1. + + Input image 2. + Input points in image 1 (row coordinate). + Input points in image 1 (column coordinate). + Input points in image 2 (row coordinate). + Input points in image 2 (column coordinate). + Gray value match metric. Default: "ncc" + Size of gray value masks. Default: 10 + Average row coordinate offset of corresponding points. Default: 0 + Average column coordinate offset of corresponding points. Default: 0 + Half height of matching search window. Default: 200 + Half width of matching search window. Default: 200 + Estimate of the relative rotation of the second image with respect to the first image. Default: 0.0 + Threshold for gray value matching. Default: 0.7 + Algorithm for the computation of the projective transformation matrix. Default: "gold_standard" + Threshold for the transformation consistency check. Default: 1 + Seed for the random number generator. Default: 0 + Computed radial distortion coefficient. + Root-Mean-Square transformation error. + Indices of matched input points in image 1. + Indices of matched input points in image 2. + Computed homogeneous projective transformation matrix. + + + + Compute a projective transformation matrix between two images and the radial distortion coefficient by automatically finding correspondences between points. + Instance represents: Input image 1. + + Input image 2. + Input points in image 1 (row coordinate). + Input points in image 1 (column coordinate). + Input points in image 2 (row coordinate). + Input points in image 2 (column coordinate). + Gray value match metric. Default: "ncc" + Size of gray value masks. Default: 10 + Average row coordinate offset of corresponding points. Default: 0 + Average column coordinate offset of corresponding points. Default: 0 + Half height of matching search window. Default: 200 + Half width of matching search window. Default: 200 + Estimate of the relative rotation of the second image with respect to the first image. Default: 0.0 + Threshold for gray value matching. Default: 0.7 + Algorithm for the computation of the projective transformation matrix. Default: "gold_standard" + Threshold for the transformation consistency check. Default: 1 + Seed for the random number generator. Default: 0 + Computed radial distortion coefficient. + Root-Mean-Square transformation error. + Indices of matched input points in image 1. + Indices of matched input points in image 2. + Computed homogeneous projective transformation matrix. + + + + Compute a projective transformation matrix between two images by finding correspondences between points based on a known approximation of the projective transformation matrix. + Instance represents: Input image 1. + + Input image 2. + Row coordinates of characteristic points in image 1. + Column coordinates of characteristic points in image 1. + Row coordinates of characteristic points in image 2. + Column coordinates of characteristic points in image 2. + Gray value comparison metric. Default: "ssd" + Size of gray value masks. Default: 10 + Approximation of the Homogeneous projective transformation matrix between the two images. + Tolerance for the matching search window. Default: 20.0 + Threshold for gray value matching. Default: 10 + Transformation matrix estimation algorithm. Default: "normalized_dlt" + Threshold for transformation consistency check. Default: 0.2 + Seed for the random number generator. Default: 0 + Indices of matched input points in image 1. + Indices of matched input points in image 2. + Homogeneous projective transformation matrix. + + + + Compute a projective transformation matrix between two images by finding correspondences between points based on a known approximation of the projective transformation matrix. + Instance represents: Input image 1. + + Input image 2. + Row coordinates of characteristic points in image 1. + Column coordinates of characteristic points in image 1. + Row coordinates of characteristic points in image 2. + Column coordinates of characteristic points in image 2. + Gray value comparison metric. Default: "ssd" + Size of gray value masks. Default: 10 + Approximation of the Homogeneous projective transformation matrix between the two images. + Tolerance for the matching search window. Default: 20.0 + Threshold for gray value matching. Default: 10 + Transformation matrix estimation algorithm. Default: "normalized_dlt" + Threshold for transformation consistency check. Default: 0.2 + Seed for the random number generator. Default: 0 + Indices of matched input points in image 1. + Indices of matched input points in image 2. + Homogeneous projective transformation matrix. + + + + Compute a projective transformation matrix between two images by finding correspondences between points. + Instance represents: Input image 1. + + Input image 2. + Row coordinates of characteristic points in image 1. + Column coordinates of characteristic points in image 1. + Row coordinates of characteristic points in image 2. + Column coordinates of characteristic points in image 2. + Gray value comparison metric. Default: "ssd" + Size of gray value masks. Default: 10 + Average row coordinate shift. Default: 0 + Average column coordinate shift. Default: 0 + Half height of matching search window. Default: 256 + Half width of matching search window. Default: 256 + Range of rotation angles. Default: 0.0 + Threshold for gray value matching. Default: 10 + Transformation matrix estimation algorithm. Default: "normalized_dlt" + Threshold for transformation consistency check. Default: 0.2 + Seed for the random number generator. Default: 0 + Indices of matched input points in image 1. + Indices of matched input points in image 2. + Homogeneous projective transformation matrix. + + + + Compute a projective transformation matrix between two images by finding correspondences between points. + Instance represents: Input image 1. + + Input image 2. + Row coordinates of characteristic points in image 1. + Column coordinates of characteristic points in image 1. + Row coordinates of characteristic points in image 2. + Column coordinates of characteristic points in image 2. + Gray value comparison metric. Default: "ssd" + Size of gray value masks. Default: 10 + Average row coordinate shift. Default: 0 + Average column coordinate shift. Default: 0 + Half height of matching search window. Default: 256 + Half width of matching search window. Default: 256 + Range of rotation angles. Default: 0.0 + Threshold for gray value matching. Default: 10 + Transformation matrix estimation algorithm. Default: "normalized_dlt" + Threshold for transformation consistency check. Default: 0.2 + Seed for the random number generator. Default: 0 + Indices of matched input points in image 1. + Indices of matched input points in image 2. + Homogeneous projective transformation matrix. + + + + Receive an image over a socket connection. + Modified instance represents: Received image. + + Socket number. + + + + Send an image over a socket connection. + Instance represents: Image to be sent. + + Socket number. + + + + Compute the distance values for a rectified stereo image pair using multi-scanline optimization. + Instance represents: Rectified image of camera 1. + + Rectified image of camera 2. + Score of the calculated disparity. + Internal camera parameters of the rectified camera 1. + Internal camera parameters of the rectified camera 2. + Point transformation from the rectified camera 2 to the rectified camera 1. + Minimum of the expected disparities. Default: -30 + Maximum of the expected disparities. Default: 30 + Smoothing of surfaces. Default: 50 + Smoothing of edges. Default: 50 + Parameter name(s) for the multi-scanline algorithm. Default: [] + Parameter value(s) for the multi-scanline algorithm. Default: [] + Distance image. + + + + Compute the distance values for a rectified stereo image pair using multi-scanline optimization. + Instance represents: Rectified image of camera 1. + + Rectified image of camera 2. + Score of the calculated disparity. + Internal camera parameters of the rectified camera 1. + Internal camera parameters of the rectified camera 2. + Point transformation from the rectified camera 2 to the rectified camera 1. + Minimum of the expected disparities. Default: -30 + Maximum of the expected disparities. Default: 30 + Smoothing of surfaces. Default: 50 + Smoothing of edges. Default: 50 + Parameter name(s) for the multi-scanline algorithm. Default: [] + Parameter value(s) for the multi-scanline algorithm. Default: [] + Distance image. + + + + Compute the disparities of a rectified stereo image pair using multi-scanline optimization. + Instance represents: Rectified image of camera 1. + + Rectified image of camera 2. + Score of the calculated disparity. + Minimum of the expected disparities. Default: -30 + Maximum of the expected disparities. Default: 30 + Smoothing of surfaces. Default: 50 + Smoothing of edges. Default: 50 + Parameter name(s) for the multi-scanline algorithm. Default: [] + Parameter value(s) for the multi-scanline algorithm. Default: [] + Disparity map. + + + + Compute the disparities of a rectified stereo image pair using multi-scanline optimization. + Instance represents: Rectified image of camera 1. + + Rectified image of camera 2. + Score of the calculated disparity. + Minimum of the expected disparities. Default: -30 + Maximum of the expected disparities. Default: 30 + Smoothing of surfaces. Default: 50 + Smoothing of edges. Default: 50 + Parameter name(s) for the multi-scanline algorithm. Default: [] + Parameter value(s) for the multi-scanline algorithm. Default: [] + Disparity map. + + + + Compute the distance values for a rectified stereo image pair using multigrid methods. + Instance represents: Rectified image of camera 1. + + Rectified image of camera 2. + Score of the calculated disparity if CalculateScore is set to 'true'. + Internal camera parameters of the rectified camera 1. + Internal camera parameters of the rectified camera 2. + Point transformation from the rectified camera 2 to the rectified camera 1. + Weight of the gray value constancy in the data term. Default: 1.0 + Weight of the gradient constancy in the data term. Default: 30.0 + Weight of the smoothness term in relation to the data term. Default: 5.0 + Initial guess of the disparity. Default: 0.0 + Should the quality measure be returned in Score? Default: "false" + Parameter name(s) for the multigrid algorithm. Default: "default_parameters" + Parameter value(s) for the multigrid algorithm. Default: "fast_accurate" + Distance image. + + + + Compute the distance values for a rectified stereo image pair using multigrid methods. + Instance represents: Rectified image of camera 1. + + Rectified image of camera 2. + Score of the calculated disparity if CalculateScore is set to 'true'. + Internal camera parameters of the rectified camera 1. + Internal camera parameters of the rectified camera 2. + Point transformation from the rectified camera 2 to the rectified camera 1. + Weight of the gray value constancy in the data term. Default: 1.0 + Weight of the gradient constancy in the data term. Default: 30.0 + Weight of the smoothness term in relation to the data term. Default: 5.0 + Initial guess of the disparity. Default: 0.0 + Should the quality measure be returned in Score? Default: "false" + Parameter name(s) for the multigrid algorithm. Default: "default_parameters" + Parameter value(s) for the multigrid algorithm. Default: "fast_accurate" + Distance image. + + + + Compute the disparities of a rectified stereo image pair using multigrid methods. + Instance represents: Rectified image of camera 1. + + Rectified image of camera 2. + Score of the calculated disparity if CalculateScore is set to 'true'. + Weight of the gray value constancy in the data term. Default: 1.0 + Weight of the gradient constancy in the data term. Default: 30.0 + Weight of the smoothness term in relation to the data term. Default: 5.0 + Initial guess of the disparity. Default: 0.0 + Should the quality measure should be returned in Score? Default: "false" + Parameter name(s) for the multigrid algorithm. Default: "default_parameters" + Parameter value(s) for the multigrid algorithm. Default: "fast_accurate" + Disparity map. + + + + Compute the disparities of a rectified stereo image pair using multigrid methods. + Instance represents: Rectified image of camera 1. + + Rectified image of camera 2. + Score of the calculated disparity if CalculateScore is set to 'true'. + Weight of the gray value constancy in the data term. Default: 1.0 + Weight of the gradient constancy in the data term. Default: 30.0 + Weight of the smoothness term in relation to the data term. Default: 5.0 + Initial guess of the disparity. Default: 0.0 + Should the quality measure should be returned in Score? Default: "false" + Parameter name(s) for the multigrid algorithm. Default: "default_parameters" + Parameter value(s) for the multigrid algorithm. Default: "fast_accurate" + Disparity map. + + + + Compute the projective rectification of weakly calibrated binocular stereo images. + Modified instance represents: Image coding the rectification of the 1. image. + + Fundamental matrix. + 9x9 covariance matrix of the fundamental matrix. Default: [] + Width of the 1. image. Default: 512 + Height of the 1. image. Default: 512 + Width of the 2. image. Default: 512 + Height of the 2. image. Default: 512 + Subsampling factor. Default: 1 + Type of mapping. Default: "no_map" + 9x9 covariance matrix of the rectified fundamental matrix. + Projective transformation of the 1. image. + Projective transformation of the 2. image. + Image coding the rectification of the 2. image. + + + + Compute the projective rectification of weakly calibrated binocular stereo images. + Modified instance represents: Image coding the rectification of the 1. image. + + Fundamental matrix. + 9x9 covariance matrix of the fundamental matrix. Default: [] + Width of the 1. image. Default: 512 + Height of the 1. image. Default: 512 + Width of the 2. image. Default: 512 + Height of the 2. image. Default: 512 + Subsampling factor. Default: 1 + Type of mapping. Default: "no_map" + 9x9 covariance matrix of the rectified fundamental matrix. + Projective transformation of the 1. image. + Projective transformation of the 2. image. + Image coding the rectification of the 2. image. + + + + Compute the fundamental matrix and the radial distortion coefficient for a pair of stereo images by automatically finding correspondences between image points. + Instance represents: Input image 1. + + Input image 2. + Input points in image 1 (row coordinate). + Input points in image 1 (column coordinate). + Input points in image 2 (row coordinate). + Input points in image 2 (column coordinate). + Gray value match metric. Default: "ncc" + Size of gray value masks. Default: 10 + Average row coordinate offset of corresponding points. Default: 0 + Average column coordinate offset of corresponding points. Default: 0 + Half height of matching search window. Default: 200 + Half width of matching search window. Default: 200 + Estimate of the relative rotation of the second image with respect to the first image. Default: 0.0 + Threshold for gray value matching. Default: 0.7 + Algorithm for the computation of the fundamental matrix and for special camera orientations. Default: "gold_standard" + Maximal deviation of a point from its epipolar line. Default: 1 + Seed for the random number generator. Default: 0 + Computed radial distortion coefficient. + Root-Mean-Square epipolar distance error. + Indices of matched input points in image 1. + Indices of matched input points in image 2. + Computed fundamental matrix. + + + + Compute the fundamental matrix and the radial distortion coefficient for a pair of stereo images by automatically finding correspondences between image points. + Instance represents: Input image 1. + + Input image 2. + Input points in image 1 (row coordinate). + Input points in image 1 (column coordinate). + Input points in image 2 (row coordinate). + Input points in image 2 (column coordinate). + Gray value match metric. Default: "ncc" + Size of gray value masks. Default: 10 + Average row coordinate offset of corresponding points. Default: 0 + Average column coordinate offset of corresponding points. Default: 0 + Half height of matching search window. Default: 200 + Half width of matching search window. Default: 200 + Estimate of the relative rotation of the second image with respect to the first image. Default: 0.0 + Threshold for gray value matching. Default: 0.7 + Algorithm for the computation of the fundamental matrix and for special camera orientations. Default: "gold_standard" + Maximal deviation of a point from its epipolar line. Default: 1 + Seed for the random number generator. Default: 0 + Computed radial distortion coefficient. + Root-Mean-Square epipolar distance error. + Indices of matched input points in image 1. + Indices of matched input points in image 2. + Computed fundamental matrix. + + + + Compute the relative orientation between two cameras by automatically finding correspondences between image points. + Instance represents: Input image 1. + + Input image 2. + Row coordinates of characteristic points in image 1. + Column coordinates of characteristic points in image 1. + Row coordinates of characteristic points in image 2. + Column coordinates of characteristic points in image 2. + Parameters of the 1st camera. + Parameters of the 2nd camera. + Gray value comparison metric. Default: "ssd" + Size of gray value masks. Default: 10 + Average row coordinate shift of corresponding points. Default: 0 + Average column coordinate shift of corresponding points. Default: 0 + Half height of matching search window. Default: 200 + Half width of matching search window. Default: 200 + Estimate of the relative orientation of the right image with respect to the left image. Default: 0.0 + Threshold for gray value matching. Default: 10 + Algorithm for the computation of the relative pose and for special pose types. Default: "normalized_dlt" + Maximal deviation of a point from its epipolar line. Default: 1 + Seed for the random number generator. Default: 0 + 6x6 covariance matrix of the relative orientation. + Root-Mean-Square of the epipolar distance error. + Indices of matched input points in image 1. + Indices of matched input points in image 2. + Computed relative orientation of the cameras (3D pose). + + + + Compute the relative orientation between two cameras by automatically finding correspondences between image points. + Instance represents: Input image 1. + + Input image 2. + Row coordinates of characteristic points in image 1. + Column coordinates of characteristic points in image 1. + Row coordinates of characteristic points in image 2. + Column coordinates of characteristic points in image 2. + Parameters of the 1st camera. + Parameters of the 2nd camera. + Gray value comparison metric. Default: "ssd" + Size of gray value masks. Default: 10 + Average row coordinate shift of corresponding points. Default: 0 + Average column coordinate shift of corresponding points. Default: 0 + Half height of matching search window. Default: 200 + Half width of matching search window. Default: 200 + Estimate of the relative orientation of the right image with respect to the left image. Default: 0.0 + Threshold for gray value matching. Default: 10 + Algorithm for the computation of the relative pose and for special pose types. Default: "normalized_dlt" + Maximal deviation of a point from its epipolar line. Default: 1 + Seed for the random number generator. Default: 0 + 6x6 covariance matrix of the relative orientation. + Root-Mean-Square of the epipolar distance error. + Indices of matched input points in image 1. + Indices of matched input points in image 2. + Computed relative orientation of the cameras (3D pose). + + + + Compute the essential matrix for a pair of stereo images by automatically finding correspondences between image points. + Instance represents: Input image 1. + + Input image 2. + Row coordinates of characteristic points in image 1. + Column coordinates of characteristic points in image 1. + Row coordinates of characteristic points in image 2. + Column coordinates of characteristic points in image 2. + Camera matrix of the 1st camera. + Camera matrix of the 2nd camera. + Gray value comparison metric. Default: "ssd" + Size of gray value masks. Default: 10 + Average row coordinate shift of corresponding points. Default: 0 + Average column coordinate shift of corresponding points. Default: 0 + Half height of matching search window. Default: 200 + Half width of matching search window. Default: 200 + Estimate of the relative orientation of the right image with respect to the left image. Default: 0.0 + Threshold for gray value matching. Default: 10 + Algorithm for the computation of the essential matrix and for special camera orientations. Default: "normalized_dlt" + Maximal deviation of a point from its epipolar line. Default: 1 + Seed for the random number generator. Default: 0 + 9x9 covariance matrix of the essential matrix. + Root-Mean-Square of the epipolar distance error. + Indices of matched input points in image 1. + Indices of matched input points in image 2. + Computed essential matrix. + + + + Compute the essential matrix for a pair of stereo images by automatically finding correspondences between image points. + Instance represents: Input image 1. + + Input image 2. + Row coordinates of characteristic points in image 1. + Column coordinates of characteristic points in image 1. + Row coordinates of characteristic points in image 2. + Column coordinates of characteristic points in image 2. + Camera matrix of the 1st camera. + Camera matrix of the 2nd camera. + Gray value comparison metric. Default: "ssd" + Size of gray value masks. Default: 10 + Average row coordinate shift of corresponding points. Default: 0 + Average column coordinate shift of corresponding points. Default: 0 + Half height of matching search window. Default: 200 + Half width of matching search window. Default: 200 + Estimate of the relative orientation of the right image with respect to the left image. Default: 0.0 + Threshold for gray value matching. Default: 10 + Algorithm for the computation of the essential matrix and for special camera orientations. Default: "normalized_dlt" + Maximal deviation of a point from its epipolar line. Default: 1 + Seed for the random number generator. Default: 0 + 9x9 covariance matrix of the essential matrix. + Root-Mean-Square of the epipolar distance error. + Indices of matched input points in image 1. + Indices of matched input points in image 2. + Computed essential matrix. + + + + Compute the fundamental matrix for a pair of stereo images by automatically finding correspondences between image points. + Instance represents: Input image 1. + + Input image 2. + Row coordinates of characteristic points in image 1. + Column coordinates of characteristic points in image 1. + Row coordinates of characteristic points in image 2. + Column coordinates of characteristic points in image 2. + Gray value comparison metric. Default: "ssd" + Size of gray value masks. Default: 10 + Average row coordinate shift of corresponding points. Default: 0 + Average column coordinate shift of corresponding points. Default: 0 + Half height of matching search window. Default: 200 + Half width of matching search window. Default: 200 + Estimate of the relative orientation of the right image with respect to the left image. Default: 0.0 + Threshold for gray value matching. Default: 10 + Algorithm for the computation of the fundamental matrix and for special camera orientations. Default: "normalized_dlt" + Maximal deviation of a point from its epipolar line. Default: 1 + Seed for the random number generator. Default: 0 + 9x9 covariance matrix of the fundamental matrix. + Root-Mean-Square of the epipolar distance error. + Indices of matched input points in image 1. + Indices of matched input points in image 2. + Computed fundamental matrix. + + + + Compute the fundamental matrix for a pair of stereo images by automatically finding correspondences between image points. + Instance represents: Input image 1. + + Input image 2. + Row coordinates of characteristic points in image 1. + Column coordinates of characteristic points in image 1. + Row coordinates of characteristic points in image 2. + Column coordinates of characteristic points in image 2. + Gray value comparison metric. Default: "ssd" + Size of gray value masks. Default: 10 + Average row coordinate shift of corresponding points. Default: 0 + Average column coordinate shift of corresponding points. Default: 0 + Half height of matching search window. Default: 200 + Half width of matching search window. Default: 200 + Estimate of the relative orientation of the right image with respect to the left image. Default: 0.0 + Threshold for gray value matching. Default: 10 + Algorithm for the computation of the fundamental matrix and for special camera orientations. Default: "normalized_dlt" + Maximal deviation of a point from its epipolar line. Default: 1 + Seed for the random number generator. Default: 0 + 9x9 covariance matrix of the fundamental matrix. + Root-Mean-Square of the epipolar distance error. + Indices of matched input points in image 1. + Indices of matched input points in image 2. + Computed fundamental matrix. + + + + Compute the distance values for a rectified stereo image pair using correlation techniques. + Instance represents: Rectified image of camera 1. + + Rectified image of camera 2. + Evaluation of a distance value. + Internal camera parameters of the rectified camera 1. + Internal camera parameters of the rectified camera 2. + Point transformation from the rectified camera 2 to the rectified camera 1. + Matching function. Default: "ncc" + Width of the correlation window. Default: 11 + Height of the correlation window. Default: 11 + Variance threshold of textured image regions. Default: 0.0 + Minimum of the expected disparities. Default: 0 + Maximum of the expected disparities. Default: 30 + Number of pyramid levels. Default: 1 + Threshold of the correlation function. Default: 0.0 + Downstream filters. Default: "none" + Distance interpolation. Default: "none" + Distance image. + + + + Compute the distance values for a rectified stereo image pair using correlation techniques. + Instance represents: Rectified image of camera 1. + + Rectified image of camera 2. + Evaluation of a distance value. + Internal camera parameters of the rectified camera 1. + Internal camera parameters of the rectified camera 2. + Point transformation from the rectified camera 2 to the rectified camera 1. + Matching function. Default: "ncc" + Width of the correlation window. Default: 11 + Height of the correlation window. Default: 11 + Variance threshold of textured image regions. Default: 0.0 + Minimum of the expected disparities. Default: 0 + Maximum of the expected disparities. Default: 30 + Number of pyramid levels. Default: 1 + Threshold of the correlation function. Default: 0.0 + Downstream filters. Default: "none" + Distance interpolation. Default: "none" + Distance image. + + + + Compute the disparities of a rectified image pair using correlation techniques. + Instance represents: Rectified image of camera 1. + + Rectified image of camera 2. + Evaluation of the disparity values. + Matching function. Default: "ncc" + Width of the correlation window. Default: 11 + Height of the correlation window. Default: 11 + Variance threshold of textured image regions. Default: 0.0 + Minimum of the expected disparities. Default: -30 + Maximum of the expected disparities. Default: 30 + Number of pyramid levels. Default: 1 + Threshold of the correlation function. Default: 0.5 + Downstream filters. Default: "none" + Subpixel interpolation of disparities. Default: "none" + Disparity map. + + + + Compute the disparities of a rectified image pair using correlation techniques. + Instance represents: Rectified image of camera 1. + + Rectified image of camera 2. + Evaluation of the disparity values. + Matching function. Default: "ncc" + Width of the correlation window. Default: 11 + Height of the correlation window. Default: 11 + Variance threshold of textured image regions. Default: 0.0 + Minimum of the expected disparities. Default: -30 + Maximum of the expected disparities. Default: 30 + Number of pyramid levels. Default: 1 + Threshold of the correlation function. Default: 0.5 + Downstream filters. Default: "none" + Subpixel interpolation of disparities. Default: "none" + Disparity map. + + + + Transform a disparity image into 3D points in a rectified stereo system. + Instance represents: Disparity image. + + Y coordinates of the points in the rectified camera system 1. + Z coordinates of the points in the rectified camera system 1. + Internal camera parameters of the rectified camera 1. + Internal camera parameters of the rectified camera 2. + Pose of the rectified camera 2 in relation to the rectified camera 1. + X coordinates of the points in the rectified camera system 1. + + + + Generate transformation maps that describe the mapping of the images of a binocular camera pair to a common rectified image plane. + Modified instance represents: Image containing the mapping data of camera 1. + + Internal parameters of camera 1. + Internal parameters of camera 2. + Point transformation from camera 2 to camera 1. + Subsampling factor. Default: 1.0 + Type of rectification. Default: "viewing_direction" + Type of mapping. Default: "bilinear" + Rectified internal parameters of camera 1. + Rectified internal parameters of camera 2. + Point transformation from the rectified camera 1 to the original camera 1. + Point transformation from the rectified camera 1 to the original camera 1. + Point transformation from the rectified camera 2 to the rectified camera 1. + Image containing the mapping data of camera 2. + + + + Get the iconic results of a measurement performed with the sheet-of light technique. + Modified instance represents: Desired measurement result. + + Handle of the sheet-of-light model to be used. + Specify which result of the measurement shall be provided. Default: "disparity" + + + + Get the iconic results of a measurement performed with the sheet-of light technique. + Modified instance represents: Desired measurement result. + + Handle of the sheet-of-light model to be used. + Specify which result of the measurement shall be provided. Default: "disparity" + + + + Apply the calibration transformations to the input disparity image. + Instance represents: Height or range image to be calibrated. + + Handle of the sheet-of-light model. + + + + Set sheet of light profiles by measured disparities. + Instance represents: Disparity image that contains several profiles. + + Handle of the sheet-of-light model. + Poses describing the movement of the scene under measurement between the previously processed profile image and the current profile image. + + + + Process the profile image provided as input and store the resulting disparity to the sheet-of-light model. + Instance represents: Input image. + + Handle of the sheet-of-light model. + Pose describing the movement of the scene under measurement between the previously processed profile image and the current profile image. + + + + Shade a height field. + Instance represents: Height field to be shaded. + + Angle between the light source and the positive z-axis (in degrees). Default: 0.0 + Angle between the light source and the x-axis after projection into the xy-plane (in degrees). Default: 0.0 + Amount of light reflected by the surface. Default: 1.0 + Amount of ambient light. Default: 0.0 + Should shadows be calculated? Default: "false" + Shaded image. + + + + Shade a height field. + Instance represents: Height field to be shaded. + + Angle between the light source and the positive z-axis (in degrees). Default: 0.0 + Angle between the light source and the x-axis after projection into the xy-plane (in degrees). Default: 0.0 + Amount of light reflected by the surface. Default: 1.0 + Amount of ambient light. Default: 0.0 + Should shadows be calculated? Default: "false" + Shaded image. + + + + Estimate the albedo of a surface and the amount of ambient light. + Instance represents: Image for which albedo and ambient are to be estimated. + + Amount of ambient light. + Amount of light reflected by the surface. + + + + Estimate the albedo of a surface and the amount of ambient light. + Instance represents: Image for which albedo and ambient are to be estimated. + + Amount of ambient light. + Amount of light reflected by the surface. + + + + Estimate the slant of a light source and the albedo of a surface. + Instance represents: Image for which slant and albedo are to be estimated. + + Amount of light reflected by the surface. + Angle of the light sources and the positive z-axis (in degrees). + + + + Estimate the slant of a light source and the albedo of a surface. + Instance represents: Image for which slant and albedo are to be estimated. + + Amount of light reflected by the surface. + Angle of the light sources and the positive z-axis (in degrees). + + + + Estimate the slant of a light source and the albedo of a surface. + Instance represents: Image for which slant and albedo are to be estimated. + + Amount of light reflected by the surface. + Angle between the light sources and the positive z-axis (in degrees). + + + + Estimate the slant of a light source and the albedo of a surface. + Instance represents: Image for which slant and albedo are to be estimated. + + Amount of light reflected by the surface. + Angle between the light sources and the positive z-axis (in degrees). + + + + Estimate the tilt of a light source. + Instance represents: Image for which the tilt is to be estimated. + + Angle between the light source and the x-axis after projection into the xy-plane (in degrees). + + + + Estimate the tilt of a light source. + Instance represents: Image for which the tilt is to be estimated. + + Angle between the light source and the x-axis after projection into the xy-plane (in degrees). + + + + Reconstruct a surface from surface gradients. + Instance represents: The gradient field of the image. + + Type of the reconstruction method. Default: "poisson" + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Reconstructed height field. + + + + Reconstruct a surface according to the photometric stereo technique. + Instance represents: Array with at least three input images with different directions of illumination. + + The gradient field of the surface. + The albedo of the surface. + Angle between the camera and the direction of illumination (in degrees). Default: 45.0 + Angle of the direction of illumination within the object plane (in degrees). Default: 45.0 + Types of the requested results. Default: "all" + Type of the reconstruction method. Default: "poisson" + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Reconstructed height field. + + + + Reconstruct a surface from a gray value image. + Instance represents: Shaded input image. + + Angle between the light source and the positive z-axis (in degrees). Default: 45.0 + Angle between the light source and the x-axis after projection into the xy-plane (in degrees). Default: 45.0 + Amount of light reflected by the surface. Default: 1.0 + Amount of ambient light. Default: 0.0 + Reconstructed height field. + + + + Reconstruct a surface from a gray value image. + Instance represents: Shaded input image. + + Angle between the light source and the positive z-axis (in degrees). Default: 45.0 + Angle between the light source and the x-axis after projection into the xy-plane (in degrees). Default: 45.0 + Amount of light reflected by the surface. Default: 1.0 + Amount of ambient light. Default: 0.0 + Reconstructed height field. + + + + Reconstruct a surface from a gray value image. + Instance represents: Shaded input image. + + Angle between the light source and the positive z-axis (in degrees). Default: 45.0 + Angle between the light source and the x-axis after projection into the xy-plane (in degrees). Default: 45.0 + Amount of light reflected by the surface. Default: 1.0 + Amount of ambient light. Default: 0.0 + Reconstructed height field. + + + + Reconstruct a surface from a gray value image. + Instance represents: Shaded input image. + + Angle between the light source and the positive z-axis (in degrees). Default: 45.0 + Angle between the light source and the x-axis after projection into the xy-plane (in degrees). Default: 45.0 + Amount of light reflected by the surface. Default: 1.0 + Amount of ambient light. Default: 0.0 + Reconstructed height field. + + + + Reconstruct a surface from a gray value image. + Instance represents: Shaded input image. + + Angle between the light source and the positive z-axis (in degrees). Default: 45.0 + Angle between the light source and the x-axis after projection into the xy-plane (in degrees). Default: 45.0 + Amount of light reflected by the surface. Default: 1.0 + Amount of ambient light. Default: 0.0 + Reconstructed height field. + + + + Reconstruct a surface from a gray value image. + Instance represents: Shaded input image. + + Angle between the light source and the positive z-axis (in degrees). Default: 45.0 + Angle between the light source and the x-axis after projection into the xy-plane (in degrees). Default: 45.0 + Amount of light reflected by the surface. Default: 1.0 + Amount of ambient light. Default: 0.0 + Reconstructed height field. + + + + Find text in an image. + Instance represents: Input image. + + Text model specifying the text to be segmented. + Result of the segmentation. + + + + Classify a byte image using a look-up table. + Instance represents: Input image. + + Handle of the LUT classifier. + Segmented classes. + + + + Classify an image with a k-Nearest-Neighbor classifier. + Instance represents: Input image. + + Distance of the pixel's nearest neighbor. + Handle of the k-NN classifier. + Threshold for the rejection of the classification. Default: 0.5 + Segmented classes. + + + + Add training samples from an image to the training data of a k-Nearest-Neighbor classifier. + Instance represents: Training image. + + Regions of the classes to be trained. + Handle of the k-NN classifier. + + + + Classify an image with a Gaussian Mixture Model. + Instance represents: Input image. + + GMM handle. + Threshold for the rejection of the classification. Default: 0.5 + Segmented classes. + + + + Add training samples from an image to the training data of a Gaussian Mixture Model. + Instance represents: Training image. + + Regions of the classes to be trained. + GMM handle. + Standard deviation of the Gaussian noise added to the training data. Default: 0.0 + + + + Classify an image with a support vector machine. + Instance represents: Input image. + + SVM handle. + Segmented classes. + + + + Add training samples from an image to the training data of a support vector machine. + Instance represents: Training image. + + Regions of the classes to be trained. + SVM handle. + + + + Classify an image with a multilayer perceptron. + Instance represents: Input image. + + MLP handle. + Threshold for the rejection of the classification. Default: 0.5 + Segmented classes. + + + + Add training samples from an image to the training data of a multilayer perceptron. + Instance represents: Training image. + + Regions of the classes to be trained. + MLP handle. + + + + Construct classes for class_ndim_norm. + Instance represents: Multi-channel training image. + + Foreground pixels to be trained. + Background pixels to be trained (rejection class). + Metric to be used. Default: "euclid" + Maximum cluster radius. Default: 10.0 + The ratio of the number of pixels in a cluster to the total number of pixels (in percent) must be larger than MinNumberPercent (otherwise the cluster is not output). Default: 0.01 + Coordinates of all cluster centers. + Overlap of the rejection class with the classified objects (1: no overlap). + Cluster radii or half edge lengths. + + + + Construct classes for class_ndim_norm. + Instance represents: Multi-channel training image. + + Foreground pixels to be trained. + Background pixels to be trained (rejection class). + Metric to be used. Default: "euclid" + Maximum cluster radius. Default: 10.0 + The ratio of the number of pixels in a cluster to the total number of pixels (in percent) must be larger than MinNumberPercent (otherwise the cluster is not output). Default: 0.01 + Coordinates of all cluster centers. + Overlap of the rejection class with the classified objects (1: no overlap). + Cluster radii or half edge lengths. + + + + Train a classificator using a multi-channel image. + Instance represents: Multi-channel training image. + + Foreground pixels to be trained. + Background pixels to be trained (rejection class). + Handle of the classifier. + + + + Classify pixels using hyper-cuboids. + Instance represents: Multi channel input image. + + Handle of the classifier. + Classification result. + + + + Classify pixels using hyper-spheres or hyper-cubes. + Instance represents: Multi channel input image. + + Metric to be used. Default: "euclid" + Return one region or one region for each cluster. Default: "single" + Cluster radii or half edge lengths (returned by learn_ndim_norm). + Coordinates of the cluster centers (returned by learn_ndim_norm). + Classification result. + + + + Classify pixels using hyper-spheres or hyper-cubes. + Instance represents: Multi channel input image. + + Metric to be used. Default: "euclid" + Return one region or one region for each cluster. Default: "single" + Cluster radii or half edge lengths (returned by learn_ndim_norm). + Coordinates of the cluster centers (returned by learn_ndim_norm). + Classification result. + + + + Segment an image using two-dimensional pixel classification. + Instance represents: Input image (first channel). + + Input image (second channel). + Region defining the feature space. + Classified regions. + + + + Segment two images by clustering. + Instance represents: First input image. + + Second input image. + Threshold (maximum distance to the cluster's center). Default: 15 + Number of classes (cluster centers). Default: 5 + Classification result. + + + + Compare two images pixel by pixel. + Instance represents: Input image. + + Comparison image. + Mode: return similar or different pixels. Default: "diff_outside" + Lower bound of the tolerated gray value difference. Default: -5 + Upper bound of the tolerated gray value difference. Default: 5 + Offset gray value subtracted from the input image. Default: 0 + Row coordinate by which the comparison image is translated. Default: 0 + Column coordinate by which the comparison image is translated. Default: 0 + Points in which the two images are similar/different. + + + + Perform a threshold segmentation for extracting characters. + Instance represents: Input image. + + Region in which the histogram is computed. + Sigma for the Gaussian smoothing of the histogram. Default: 2.0 + Percentage for the gray value difference. Default: 95 + Calculated threshold. + Dark regions (characters). + + + + Perform a threshold segmentation for extracting characters. + Instance represents: Input image. + + Region in which the histogram is computed. + Sigma for the Gaussian smoothing of the histogram. Default: 2.0 + Percentage for the gray value difference. Default: 95 + Calculated threshold. + Dark regions (characters). + + + + Extract regions with equal gray values from an image. + Instance represents: Label image. + + Regions having a constant gray value. + + + + Suppress non-maximum points on an edge. + Instance represents: Amplitude (gradient magnitude) image. + + Select horizontal/vertical or undirected NMS. Default: "hvnms" + Image with thinned edge regions. + + + + Suppress non-maximum points on an edge using a direction image. + Instance represents: Amplitude (gradient magnitude) image. + + Direction image. + Select non-maximum-suppression or interpolating NMS. Default: "nms" + Image with thinned edge regions. + + + + Perform a hysteresis threshold operation on an image. + Instance represents: Input image. + + Lower threshold for the gray values. Default: 30 + Upper threshold for the gray values. Default: 60 + Maximum length of a path of "potential" points to reach a "secure" point. Default: 10 + Segmented region. + + + + Perform a hysteresis threshold operation on an image. + Instance represents: Input image. + + Lower threshold for the gray values. Default: 30 + Upper threshold for the gray values. Default: 60 + Maximum length of a path of "potential" points to reach a "secure" point. Default: 10 + Segmented region. + + + + Segment an image using binary thresholding. + Instance represents: Input Image. + + Segmentation method. Default: "max_separability" + Extract foreground or background? Default: "dark" + Used threshold. + Segmented output region. + + + + Segment an image using binary thresholding. + Instance represents: Input Image. + + Segmentation method. Default: "max_separability" + Extract foreground or background? Default: "dark" + Used threshold. + Segmented output region. + + + + Segment an image using local thresholding. + Instance represents: Input Image. + + Segmentation method. Default: "adapted_std_deviation" + Extract foreground or background? Default: "dark" + List of generic parameter names. Default: [] + List of generic parameter values. Default: [] + Segmented output region. + + + + Segment an image using local thresholding. + Instance represents: Input Image. + + Segmentation method. Default: "adapted_std_deviation" + Extract foreground or background? Default: "dark" + List of generic parameter names. Default: [] + List of generic parameter values. Default: [] + Segmented output region. + + + + Threshold an image by local mean and standard deviation analysis. + Instance represents: Input image. + + Mask width for mean and deviation calculation. Default: 15 + Mask height for mean and deviation calculation. Default: 15 + Factor for the standard deviation of the gray values. Default: 0.2 + Minimum gray value difference from the mean. Default: 2 + Threshold type. Default: "dark" + Segmented regions. + + + + Threshold an image by local mean and standard deviation analysis. + Instance represents: Input image. + + Mask width for mean and deviation calculation. Default: 15 + Mask height for mean and deviation calculation. Default: 15 + Factor for the standard deviation of the gray values. Default: 0.2 + Minimum gray value difference from the mean. Default: 2 + Threshold type. Default: "dark" + Segmented regions. + + + + Segment an image using a local threshold. + Instance represents: Input image. + + Image containing the local thresholds. + Offset applied to ThresholdImage. Default: 5.0 + Extract light, dark or similar areas? Default: "light" + Segmented regions. + + + + Segment an image using a local threshold. + Instance represents: Input image. + + Image containing the local thresholds. + Offset applied to ThresholdImage. Default: 5.0 + Extract light, dark or similar areas? Default: "light" + Segmented regions. + + + + Segment an image using global threshold. + Instance represents: Input image. + + Lower threshold for the gray values. Default: 128.0 + Upper threshold for the gray values. Default: 255.0 + Segmented region. + + + + Segment an image using global threshold. + Instance represents: Input image. + + Lower threshold for the gray values. Default: 128.0 + Upper threshold for the gray values. Default: 255.0 + Segmented region. + + + + Extract level crossings from an image with subpixel accuracy. + Instance represents: Input image. + + Threshold for the level crossings. Default: 128 + Extracted level crossings. + + + + Extract level crossings from an image with subpixel accuracy. + Instance represents: Input image. + + Threshold for the level crossings. Default: 128 + Extracted level crossings. + + + + Segment an image using regiongrowing for multi-channel images. + Instance represents: Input image. + + Metric for the distance of the feature vectors. Default: "2-norm" + Lower threshold for the features' distance. Default: 0.0 + Upper threshold for the features' distance. Default: 20.0 + Minimum size of the output regions. Default: 30 + Segmented regions. + + + + Segment an image using regiongrowing for multi-channel images. + Instance represents: Input image. + + Metric for the distance of the feature vectors. Default: "2-norm" + Lower threshold for the features' distance. Default: 0.0 + Upper threshold for the features' distance. Default: 20.0 + Minimum size of the output regions. Default: 30 + Segmented regions. + + + + Segment an image using regiongrowing. + Instance represents: Input image. + + Vertical distance between tested pixels (height of the raster). Default: 3 + Horizontal distance between tested pixels (height of the raster). Default: 3 + Points with a gray value difference less then or equal to tolerance are accumulated into the same object. Default: 6.0 + Minimum size of the output regions. Default: 100 + Segmented regions. + + + + Segment an image using regiongrowing. + Instance represents: Input image. + + Vertical distance between tested pixels (height of the raster). Default: 3 + Horizontal distance between tested pixels (height of the raster). Default: 3 + Points with a gray value difference less then or equal to tolerance are accumulated into the same object. Default: 6.0 + Minimum size of the output regions. Default: 100 + Segmented regions. + + + + Perform a regiongrowing using mean gray values. + Instance represents: Input image. + + Row coordinates of the starting points. Default: [] + Column coordinates of the starting points. Default: [] + Maximum deviation from the mean. Default: 5.0 + Minimum size of a region. Default: 100 + Segmented regions. + + + + Perform a regiongrowing using mean gray values. + Instance represents: Input image. + + Row coordinates of the starting points. Default: [] + Column coordinates of the starting points. Default: [] + Maximum deviation from the mean. Default: 5.0 + Minimum size of a region. Default: 100 + Segmented regions. + + + + Segment an image by "pouring water" over it. + Instance represents: Input image. + + Mode of operation. Default: "all" + All gray values smaller than this threshold are disregarded. Default: 0 + All gray values larger than this threshold are disregarded. Default: 255 + Segmented regions. + + + + Extract watershed basins from an image using a threshold. + Instance represents: Image to be segmented. + + Threshold for the watersheds. Default: 10 + Segments found (dark basins). + + + + Extract watershed basins from an image using a threshold. + Instance represents: Image to be segmented. + + Threshold for the watersheds. Default: 10 + Segments found (dark basins). + + + + Extract watersheds and basins from an image. + Instance represents: Input image. + + Watersheds between the basins. + Segmented basins. + + + + Extract zero crossings from an image. + Instance represents: Input image. + + Zero crossings. + + + + Extract zero crossings from an image with subpixel accuracy. + Instance represents: Input image. + + Extracted zero crossings. + + + + Threshold operator for signed images. + Instance represents: Input image. + + Regions smaller than MinSize are suppressed. Default: 20 + Regions whose maximum absolute gray value is smaller than MinGray are suppressed. Default: 5.0 + Regions that have a gray value smaller than Threshold (or larger than -Threshold) are suppressed. Default: 2.0 + Positive and negative regions. + + + + Expand a region starting at a given line. + Instance represents: Input image. + + Row or column coordinate. Default: 256 + Stopping criterion. Default: "gradient" + Segmentation mode (row or column). Default: "row" + Threshold for the expansion. Default: 3.0 + Extracted segments. + + + + Expand a region starting at a given line. + Instance represents: Input image. + + Row or column coordinate. Default: 256 + Stopping criterion. Default: "gradient" + Segmentation mode (row or column). Default: "row" + Threshold for the expansion. Default: 3.0 + Extracted segments. + + + + Detect all local minima in an image. + Instance represents: Image to be processed. + + Extracted local minima as regions. + + + + Detect all gray value lowlands. + Instance represents: Image to be processed. + + Extracted lowlands as regions (one region for each lowland). + + + + Detect the centers of all gray value lowlands. + Instance represents: Image to be processed. + + Centers of gravity of the extracted lowlands as regions (one region for each lowland). + + + + Detect all local maxima in an image. + Instance represents: Input image. + + Extracted local maxima as a region. + + + + Detect all gray value plateaus. + Instance represents: Input image. + + Extracted plateaus as regions (one region for each plateau). + + + + Detect the centers of all gray value plateaus. + Instance represents: Input image. + + Centers of gravity of the extracted plateaus as regions (one region for each plateau). + + + + Segment an image using thresholds determined from its histogram. + Instance represents: Input image. + + Sigma for the Gaussian smoothing of the histogram. Default: 2.0 + Regions with gray values within the automatically determined intervals. + + + + Segment an image using thresholds determined from its histogram. + Instance represents: Input image. + + Sigma for the Gaussian smoothing of the histogram. Default: 2.0 + Regions with gray values within the automatically determined intervals. + + + + Segment an image using an automatically determined threshold. + Instance represents: Input image. + + Dark regions of the image. + + + + Fast thresholding of images using global thresholds. + Instance represents: Input image. + + Lower threshold for the gray values. Default: 128 + Upper threshold for the gray values. Default: 255.0 + Minimum size of objects to be extracted. Default: 20 + Segmented regions. + + + + Fast thresholding of images using global thresholds. + Instance represents: Input image. + + Lower threshold for the gray values. Default: 128 + Upper threshold for the gray values. Default: 255.0 + Minimum size of objects to be extracted. Default: 20 + Segmented regions. + + + + Fill gaps between regions (depending on gray value or color) or split overlapping regions. + Instance represents: Image (possibly multi-channel) for gray value or color comparison. + + Regions for which the gaps are to be closed, or which are to be separated. + Regions in which no expansion takes place. + Number of iterations. Default: "maximal" + Expansion mode. Default: "image" + Maximum difference between the gray value or color at the region's border and a candidate for expansion. Default: 32 + Expanded or separated regions. + + + + Fill gaps between regions (depending on gray value or color) or split overlapping regions. + Instance represents: Image (possibly multi-channel) for gray value or color comparison. + + Regions for which the gaps are to be closed, or which are to be separated. + Regions in which no expansion takes place. + Number of iterations. Default: "maximal" + Expansion mode. Default: "image" + Maximum difference between the gray value or color at the region's border and a candidate for expansion. Default: 32 + Expanded or separated regions. + + + + Fill gaps between regions (depending on gray value or color) or split overlapping regions. + Instance represents: Image (possibly multi-channel) for gray value or color comparison. + + Regions for which the gaps are to be closed, or which are to be separated. + Regions in which no expansion takes place. + Number of iterations. Default: "maximal" + Expansion mode. Default: "image" + Reference gray value or color for comparison. Default: 128 + Maximum difference between the reference gray value or color and a candidate for expansion. Default: 32 + Expanded or separated regions. + + + + Fill gaps between regions (depending on gray value or color) or split overlapping regions. + Instance represents: Image (possibly multi-channel) for gray value or color comparison. + + Regions for which the gaps are to be closed, or which are to be separated. + Regions in which no expansion takes place. + Number of iterations. Default: "maximal" + Expansion mode. Default: "image" + Reference gray value or color for comparison. Default: 128 + Maximum difference between the reference gray value or color and a candidate for expansion. Default: 32 + Expanded or separated regions. + + + + Calculate the difference of two object tuples. + Instance represents: Object tuple 1. + + Object tuple 2. + Objects from Objects that are not part of ObjectsSub. + + + + Set single gray values in an image. + Instance represents: Image to be modified. + + Row coordinates of the pixels to be modified. Default: 0 + Column coordinates of the pixels to be modified. Default: 0 + Gray values to be used. Default: 255.0 + + + + Set single gray values in an image. + Instance represents: Image to be modified. + + Row coordinates of the pixels to be modified. Default: 0 + Column coordinates of the pixels to be modified. Default: 0 + Gray values to be used. Default: 255.0 + + + + Paint XLD objects into an image. + Instance represents: Image in which the xld objects are to be painted. + + XLD objects to be painted into the input image. + Desired gray value of the xld object. Default: 255.0 + Image containing the result. + + + + Paint XLD objects into an image. + Instance represents: Image in which the xld objects are to be painted. + + XLD objects to be painted into the input image. + Desired gray value of the xld object. Default: 255.0 + Image containing the result. + + + + Paint regions into an image. + Instance represents: Image in which the regions are to be painted. + + Regions to be painted into the input image. + Desired gray values of the regions. Default: 255.0 + Paint regions filled or as boundaries. Default: "fill" + Image containing the result. + + + + Paint regions into an image. + Instance represents: Image in which the regions are to be painted. + + Regions to be painted into the input image. + Desired gray values of the regions. Default: 255.0 + Paint regions filled or as boundaries. Default: "fill" + Image containing the result. + + + + Overpaint regions in an image. + Instance represents: Image in which the regions are to be painted. + + Regions to be painted into the input image. + Desired gray values of the regions. Default: 255.0 + Paint regions filled or as boundaries. Default: "fill" + + + + Overpaint regions in an image. + Instance represents: Image in which the regions are to be painted. + + Regions to be painted into the input image. + Desired gray values of the regions. Default: 255.0 + Paint regions filled or as boundaries. Default: "fill" + + + + Create an image with a specified constant gray value. + Instance represents: Input image. + + Gray value to be used for the output image. Default: 0 + Image with constant gray value. + + + + Create an image with a specified constant gray value. + Instance represents: Input image. + + Gray value to be used for the output image. Default: 0 + Image with constant gray value. + + + + Paint the gray values of an image into another image. + Instance represents: Input image containing the desired gray values. + + Input image to be painted over. + Result image. + + + + Overpaint the gray values of an image. + Instance represents: Input image to be painted over. + + Input image containing the desired gray values. + + + + Copy an iconic object in the HALCON database. + Instance represents: Objects to be copied. + + Starting index of the objects to be copied. Default: 1 + Number of objects to be copied or -1. Default: 1 + Copied objects. + + + + Concatenate two iconic object tuples. + Instance represents: Object tuple 1. + + Object tuple 2. + Concatenated objects. + + + + Copy an image and allocate new memory for it. + Instance represents: Image to be copied. + + Copied image. + + + + Select objects from an object tuple. + Instance represents: Input objects. + + Indices of the objects to be selected. Default: 1 + Selected objects. + + + + Select objects from an object tuple. + Instance represents: Input objects. + + Indices of the objects to be selected. Default: 1 + Selected objects. + + + + Compare iconic objects regarding equality. + Instance represents: Reference objects. + + Test objects. + Maximum allowed difference between two gray values or coordinates etc. Default: 0.0 + Boolean result value. + + + + Compare iconic objects regarding equality. + Instance represents: Reference objects. + + Test objects. + Maximum allowed difference between two gray values or coordinates etc. Default: 0.0 + Boolean result value. + + + + Compare image objects regarding equality. + Instance represents: Test objects. + + Comparative objects. + boolean result value. + + + + Create a three-channel image from a pointer to the interleaved pixels. + Modified instance represents: Created image with new image matrix. + + Pointer to interleaved pixels. + Format of the input pixels. Default: "rgb" + Width of input image. Default: 512 + Height of input image. Default: 512 + Reserved. + Pixel type of output image. Default: "byte" + Width of output image. Default: 0 + Height of output image. Default: 0 + Line number of upper left corner of desired image part. Default: 0 + Column number of upper left corner of desired image part. Default: 0 + Number of used bits per pixel and channel of the output image (-1: All bits are used). Default: -1 + Number of bits that the color values of the input pixels are shifted to the right (only uint2 images). Default: 0 + + + + Create an image from three pointers to the pixels (red/green/blue). + Modified instance represents: Created image with new image matrix. + + Pixel type. Default: "byte" + Width of image. Default: 512 + Height of image. Default: 512 + Pointer to first red value (channel 1). + Pointer to first green value (channel 2). + Pointer to first blue value (channel 3). + + + + Create an image from a pointer to the pixels. + Modified instance represents: Created image with new image matrix. + + Pixel type. Default: "byte" + Width of image. Default: 512 + Height of image. Default: 512 + Pointer to first gray value. + + + + Create an image with constant gray value. + Modified instance represents: Created image with new image matrix. + + Pixel type. Default: "byte" + Width of image. Default: 512 + Height of image. Default: 512 + + + + Create a gray value ramp. + Modified instance represents: Created image with new image matrix. + + Gradient in line direction. Default: 1.0 + Gradient in column direction. Default: 1.0 + Mean gray value. Default: 128 + Line index of reference point. Default: 256 + Column index of reference point. Default: 256 + Width of image. Default: 512 + Height of image. Default: 512 + + + + Create a three-channel image from three pointers on the pixels with storage management. + Modified instance represents: Created HALCON image. + + Pixel type. Default: "byte" + Width of image. Default: 512 + Height of image. Default: 512 + Pointer to the first gray value of the first channel. + Pointer to the first gray value of the second channel. + Pointer to the first gray value of the third channel. + Pointer to the procedure re-releasing the memory of the image when deleting the object. Default: 0 + + + + Create an image from a pointer on the pixels with storage management. + Modified instance represents: Created HALCON image. + + Pixel type. Default: "byte" + Width of image. Default: 512 + Height of image. Default: 512 + Pointer to the first gray value. + Pointer to the procedure re-releasing the memory of the image when deleting the object. Default: 0 + + + + Create an image with a rectangular domain from a pointer on the pixels (with storage management). + Modified instance represents: Created HALCON image. + + Pointer to the first pixel. + Width of the image. Default: 512 + Height of the image. Default: 512 + Distance (in bytes) between pixel m in row n and pixel m in row n+1 of the 'input image'. + Distance between two neighboring pixels in bits . Default: 8 + Number of used bits per pixel. Default: 8 + Copy image data. Default: "false" + Pointer to the procedure releasing the memory of the image when deleting the object. Default: 0 + + + + Access to the image data pointer and the image data inside the smallest rectangle of the domain of the input image. + Instance represents: Input image (Himage). + + Width of the output image. + Height of the output image. + Width(input image)*(HorizontalBitPitch/8). + Distance between two neighboring pixels in bits . + Number of used bits per pixel. + Pointer to the image data. + + + + Access the pointers of a colored image. + Instance represents: Input image. + + Pointer to the pixels of the first channel. + Pointer to the pixels of the second channel. + Pointer to the pixels of the third channel. + Type of image. + Width of image. + Height of image. + + + + Access the pointers of a colored image. + Instance represents: Input image. + + Pointer to the pixels of the first channel. + Pointer to the pixels of the second channel. + Pointer to the pixels of the third channel. + Type of image. + Width of image. + Height of image. + + + + Access the pointer of a channel. + Instance represents: Input image. + + Type of image. + Width of image. + Height of image. + Pointer to the image data in the HALCON database. + + + + Access the pointer of a channel. + Instance represents: Input image. + + Type of image. + Width of image. + Height of image. + Pointer to the image data in the HALCON database. + + + + Return the type of an image. + Instance represents: Input image. + + Type of image. + + + + Return the size of an image. + Instance represents: Input image. + + Width of image. + Height of image. + + + + Return the size of an image. + Instance represents: Input image. + + Width of image. + Height of image. + + + + Request time at which the image was created. + Instance represents: Input image. + + Seconds (0..59). + Minutes (0..59). + Hours (0..23). + Day of the month (1..31). + Day of the year (1..366). + Month (1..12). + Year (xxxx). + Milliseconds (0..999). + + + + Return gray values of an image at the positions given by tuples of rows and columns. + Instance represents: Image whose gray values are to be accessed. + + Row coordinates of positions. Default: 0 + Column coordinates of positions. Default: 0 + Interpolation method. Default: "bilinear" + Gray values of the selected image coordinates. + + + + Return gray values of an image at the positions given by tuples of rows and columns. + Instance represents: Image whose gray values are to be accessed. + + Row coordinates of positions. Default: 0 + Column coordinates of positions. Default: 0 + Interpolation method. Default: "bilinear" + Gray values of the selected image coordinates. + + + + Access the gray values of an image object. + Instance represents: Image whose gray value is to be accessed. + + Row coordinates of pixels to be viewed. Default: 0 + Column coordinates of pixels to be viewed. Default: 0 + Gray values of indicated pixels. + + + + Access the gray values of an image object. + Instance represents: Image whose gray value is to be accessed. + + Row coordinates of pixels to be viewed. Default: 0 + Column coordinates of pixels to be viewed. Default: 0 + Gray values of indicated pixels. + + + + Verification of a pattern using an OCV tool. + Instance represents: Characters to be verified. + + Handle of the OCV tool. + Name of the character. Default: "a" + Adaption to vertical and horizontal translation. Default: "true" + Adaption to vertical and horizontal scaling of the size. Default: "true" + Adaption to changes of the orientation (not implemented). Default: "false" + Adaption to additive and scaling gray value changes. Default: "true" + Minimum difference between objects. Default: 10 + Evaluation of the character. + + + + Verification of a pattern using an OCV tool. + Instance represents: Characters to be verified. + + Handle of the OCV tool. + Name of the character. Default: "a" + Adaption to vertical and horizontal translation. Default: "true" + Adaption to vertical and horizontal scaling of the size. Default: "true" + Adaption to changes of the orientation (not implemented). Default: "false" + Adaption to additive and scaling gray value changes. Default: "true" + Minimum difference between objects. Default: 10 + Evaluation of the character. + + + + Training of an OCV tool. + Instance represents: Pattern to be trained. + + Handle of the OCV tool to be trained. + Name(s) of the object(s) to analyse. Default: "a" + Mode for training (only one mode implemented). Default: "single" + + + + Training of an OCV tool. + Instance represents: Pattern to be trained. + + Handle of the OCV tool to be trained. + Name(s) of the object(s) to analyse. Default: "a" + Mode for training (only one mode implemented). Default: "single" + + + + Compute the features of a character. + Instance represents: Input character. + + Handle of the k-NN classifier. + Should the feature vector be transformed with the preprocessing? Default: "true" + Feature vector of the character. + + + + Compute the features of a character. + Instance represents: Input character. + + Handle of the OCR classifier. + Should the feature vector be transformed with the preprocessing? Default: "true" + Feature vector of the character. + + + + Compute the features of a character. + Instance represents: Input character. + + Handle of the OCR classifier. + Should the feature vector be transformed with the preprocessing? Default: "true" + Feature vector of the character. + + + + Cut out an image area relative to the domain. + Instance represents: Input image. + + Number of rows clipped at the top. Default: -1 + Number of columns clipped at the left. Default: -1 + Number of rows clipped at the bottom. Default: -1 + Number of columns clipped at the right. Default: -1 + Image area. + + + + Access the features which correspond to a character. + Instance represents: Characters to be trained. + + ID of the desired OCR-classifier. + Feature vector. + + + + Write characters into a training file. + Instance represents: Characters to be trained. + + Class (name) of the characters. + Name of the training file. Default: "train_ocr" + + + + Write characters into a training file. + Instance represents: Characters to be trained. + + Class (name) of the characters. + Name of the training file. Default: "train_ocr" + + + + Read training specific characters from files and convert to images. + Modified instance represents: Images read from file. + + Names of the training files. Default: "" + Names of the characters to be extracted. Default: "0" + Names of the read characters. + + + + Read training specific characters from files and convert to images. + Modified instance represents: Images read from file. + + Names of the training files. Default: "" + Names of the characters to be extracted. Default: "0" + Names of the read characters. + + + + Read training characters from files and convert to images. + Modified instance represents: Images read from file. + + Names of the training files. Default: "" + Names of the read characters. + + + + Read training characters from files and convert to images. + Modified instance represents: Images read from file. + + Names of the training files. Default: "" + Names of the read characters. + + + + Perform a gray value bottom hat transformation on an image. + Instance represents: Input image. + + Structuring element. + Bottom hat image. + + + + Perform a gray value top hat transformation on an image. + Instance represents: Input image. + + Structuring element. + Top hat image. + + + + Perform a gray value closing on an image. + Instance represents: Input image. + + Structuring element. + Gray-closed image. + + + + Perform a gray value opening on an image. + Instance represents: Input image. + + Structuring element. + Gray-opened image. + + + + Perform a gray value dilation on an image. + Instance represents: Input image. + + Structuring element. + Gray-dilated image. + + + + Perform a gray value erosion on an image. + Instance represents: Input image. + + Structuring element. + Gray-eroded image. + + + + Load a structuring element for gray morphology. + Modified instance represents: Generated structuring element. + + Name of the file containing the structuring element. + + + + Generate ellipsoidal structuring elements for gray morphology. + Modified instance represents: Generated structuring element. + + Pixel type. Default: "byte" + Width of the structuring element. Default: 5 + Height of the structuring element. Default: 5 + Maximum gray value of the structuring element. Default: 0 + + + + Generate ellipsoidal structuring elements for gray morphology. + Modified instance represents: Generated structuring element. + + Pixel type. Default: "byte" + Width of the structuring element. Default: 5 + Height of the structuring element. Default: 5 + Maximum gray value of the structuring element. Default: 0 + + + + Extracting points with a particular gray value along a rectangle or an annular arc. + Instance represents: Input image. + + Measure object handle. + Sigma of gaussian smoothing. Default: 1.0 + Threshold. Default: 128.0 + Selection of points. Default: "all" + Row coordinates of points with threshold value. + Column coordinates of points with threshold value. + Distance between consecutive points. + + + + Extract a gray value profile perpendicular to a rectangle or annular arc. + Instance represents: Input image. + + Measure object handle. + Gray value profile. + + + + Extract straight edge pairs perpendicular to a rectangle or an annular arc. + Instance represents: Input image. + + Measure object handle. + Sigma of Gaussian smoothing. Default: 1.0 + Minimum edge amplitude. Default: 30.0 + Minimum fuzzy value. Default: 0.5 + Select the first gray value transition of the edge pairs. Default: "all" + Constraint of pairing. Default: "no_restriction" + Number of edge pairs. Default: 10 + Row coordinate of the first edge. + Column coordinate of the first edge. + Edge amplitude of the first edge (with sign). + Row coordinate of the second edge. + Column coordinate of the second edge. + Edge amplitude of the second edge (with sign). + Row coordinate of the center of the edge pair. + Column coordinate of the center of the edge pair. + Fuzzy evaluation of the edge pair. + Distance between the edges of the edge pair. + + + + Extract straight edge pairs perpendicular to a rectangle or an annular arc. + Instance represents: Input image. + + Measure object handle. + Sigma of Gaussian smoothing. Default: 1.0 + Minimum edge amplitude. Default: 30.0 + Minimum fuzzy value. Default: 0.5 + Select the first gray value transition of the edge pairs. Default: "all" + Row coordinate of the first edge point. + Column coordinate of the first edge point. + Edge amplitude of the first edge (with sign). + Row coordinate of the second edge point. + Column coordinate of the second edge point. + Edge amplitude of the second edge (with sign). + Row coordinate of the center of the edge pair. + Column coordinate of the center of the edge pair. + Fuzzy evaluation of the edge pair. + Distance between edges of an edge pair. + Distance between consecutive edge pairs. + + + + Extract straight edges perpendicular to a rectangle or an annular arc. + Instance represents: Input image. + + Measure object handle. + Sigma of Gaussian smoothing. Default: 1.0 + Minimum edge amplitude. Default: 30.0 + Minimum fuzzy value. Default: 0.5 + Select light/dark or dark/light edges. Default: "all" + Row coordinate of the edge point. + Column coordinate of the edge point. + Edge amplitude of the edge (with sign). + Fuzzy evaluation of the edges. + Distance between consecutive edges. + + + + Extract straight edge pairs perpendicular to a rectangle or annular arc. + Instance represents: Input image. + + Measure object handle. + Sigma of gaussian smoothing. Default: 1.0 + Minimum edge amplitude. Default: 30.0 + Type of gray value transition that determines how edges are grouped to edge pairs. Default: "all" + Selection of edge pairs. Default: "all" + Row coordinate of the center of the first edge. + Column coordinate of the center of the first edge. + Edge amplitude of the first edge (with sign). + Row coordinate of the center of the second edge. + Column coordinate of the center of the second edge. + Edge amplitude of the second edge (with sign). + Distance between edges of an edge pair. + Distance between consecutive edge pairs. + + + + Extract straight edges perpendicular to a rectangle or annular arc. + Instance represents: Input image. + + Measure object handle. + Sigma of gaussian smoothing. Default: 1.0 + Minimum edge amplitude. Default: 30.0 + Light/dark or dark/light edge. Default: "all" + Selection of end points. Default: "all" + Row coordinate of the center of the edge. + Column coordinate of the center of the edge. + Edge amplitude of the edge (with sign). + Distance between consecutive edges. + + + + Identify objects with a sample identifier. + Instance represents: Image showing the object to be identified. + + Handle of the sample identifier. + Number of suggested object indices. Default: 1 + Rating threshold. Default: 0.0 + Generic parameter name. Default: [] + Generic parameter value. Default: [] + Rating value of the identified object. + Index of the identified object. + + + + Identify objects with a sample identifier. + Instance represents: Image showing the object to be identified. + + Handle of the sample identifier. + Number of suggested object indices. Default: 1 + Rating threshold. Default: 0.0 + Generic parameter name. Default: [] + Generic parameter value. Default: [] + Rating value of the identified object. + Index of the identified object. + + + + Add training data to an existing sample identifier. + Instance represents: Image that shows an object. + + Handle of the sample identifier. + Index of the object visible in the SampleImage. + Generic parameter name. Default: [] + Generic parameter value. Default: [] + Index of the object sample. + + + + Add training data to an existing sample identifier. + Instance represents: Image that shows an object. + + Handle of the sample identifier. + Index of the object visible in the SampleImage. + Generic parameter name. Default: [] + Generic parameter value. Default: [] + Index of the object sample. + + + + Add preparation data to an existing sample identifier. + Instance represents: Image that shows an object. + + Handle of the sample identifier. + Index of the object visible in the SampleImage. Default: "unknown" + Generic parameter name. Default: [] + Generic parameter value. Default: [] + Index of the object sample. + + + + Add preparation data to an existing sample identifier. + Instance represents: Image that shows an object. + + Handle of the sample identifier. + Index of the object visible in the SampleImage. Default: "unknown" + Generic parameter name. Default: [] + Generic parameter value. Default: [] + Index of the object sample. + + + + Determine the parameters of a shape model. + Instance represents: Input image whose domain will be used to create the model. + + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the model. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Minimum scale of the model. Default: 0.9 + Maximum scale of the model. Default: 1.1 + Kind of optimization. Default: "auto" + Match metric. Default: "use_polarity" + Threshold or hysteresis thresholds for the contrast of the object in the template image and optionally minimum size of the object parts. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + Parameters to be determined automatically. Default: "all" + Value of the automatically determined parameter. + Name of the automatically determined parameter. + + + + Determine the parameters of a shape model. + Instance represents: Input image whose domain will be used to create the model. + + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the model. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Minimum scale of the model. Default: 0.9 + Maximum scale of the model. Default: 1.1 + Kind of optimization. Default: "auto" + Match metric. Default: "use_polarity" + Threshold or hysteresis thresholds for the contrast of the object in the template image and optionally minimum size of the object parts. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + Parameters to be determined automatically. Default: "all" + Value of the automatically determined parameter. + Name of the automatically determined parameter. + + + + Find the best matches of multiple anisotropically scaled shape models. + Instance represents: Input image in which the models should be found. + + Handle of the models. + Smallest rotation of the models. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Minimum scale of the models in the row direction. Default: 0.9 + Maximum scale of the models in the row direction. Default: 1.1 + Minimum scale of the models in the column direction. Default: 0.9 + Maximum scale of the models in the column direction. Default: 1.1 + Minimum score of the instances of the models to be found. Default: 0.5 + Number of instances of the models to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the models to be found. Default: 0.5 + Subpixel accuracy if not equal to 'none'. Default: "least_squares" + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + Row coordinate of the found instances of the models. + Column coordinate of the found instances of the models. + Rotation angle of the found instances of the models. + Scale of the found instances of the models in the row direction. + Scale of the found instances of the models in the column direction. + Score of the found instances of the models. + Index of the found instances of the models. + + + + Find the best matches of multiple anisotropically scaled shape models. + Instance represents: Input image in which the models should be found. + + Handle of the models. + Smallest rotation of the models. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Minimum scale of the models in the row direction. Default: 0.9 + Maximum scale of the models in the row direction. Default: 1.1 + Minimum scale of the models in the column direction. Default: 0.9 + Maximum scale of the models in the column direction. Default: 1.1 + Minimum score of the instances of the models to be found. Default: 0.5 + Number of instances of the models to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the models to be found. Default: 0.5 + Subpixel accuracy if not equal to 'none'. Default: "least_squares" + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + Row coordinate of the found instances of the models. + Column coordinate of the found instances of the models. + Rotation angle of the found instances of the models. + Scale of the found instances of the models in the row direction. + Scale of the found instances of the models in the column direction. + Score of the found instances of the models. + Index of the found instances of the models. + + + + Find the best matches of multiple isotropically scaled shape models. + Instance represents: Input image in which the models should be found. + + Handle of the models. + Smallest rotation of the models. Default: -0.39 + Extent of the rotation angles. Default: 0.78 + Minimum scale of the models. Default: 0.9 + Maximum scale of the models. Default: 1.1 + Minimum score of the instances of the models to be found. Default: 0.5 + Number of instances of the models to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the models to be found. Default: 0.5 + Subpixel accuracy if not equal to 'none'. Default: "least_squares" + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + Row coordinate of the found instances of the models. + Column coordinate of the found instances of the models. + Rotation angle of the found instances of the models. + Scale of the found instances of the models. + Score of the found instances of the models. + Index of the found instances of the models. + + + + Find the best matches of multiple isotropically scaled shape models. + Instance represents: Input image in which the models should be found. + + Handle of the models. + Smallest rotation of the models. Default: -0.39 + Extent of the rotation angles. Default: 0.78 + Minimum scale of the models. Default: 0.9 + Maximum scale of the models. Default: 1.1 + Minimum score of the instances of the models to be found. Default: 0.5 + Number of instances of the models to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the models to be found. Default: 0.5 + Subpixel accuracy if not equal to 'none'. Default: "least_squares" + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + Row coordinate of the found instances of the models. + Column coordinate of the found instances of the models. + Rotation angle of the found instances of the models. + Scale of the found instances of the models. + Score of the found instances of the models. + Index of the found instances of the models. + + + + Find the best matches of multiple shape models. + Instance represents: Input image in which the models should be found. + + Handle of the models. + Smallest rotation of the models. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Minimum score of the instances of the models to be found. Default: 0.5 + Number of instances of the models to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the models to be found. Default: 0.5 + Subpixel accuracy if not equal to 'none'. Default: "least_squares" + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + Row coordinate of the found instances of the models. + Column coordinate of the found instances of the models. + Rotation angle of the found instances of the models. + Score of the found instances of the models. + Index of the found instances of the models. + + + + Find the best matches of multiple shape models. + Instance represents: Input image in which the models should be found. + + Handle of the models. + Smallest rotation of the models. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Minimum score of the instances of the models to be found. Default: 0.5 + Number of instances of the models to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the models to be found. Default: 0.5 + Subpixel accuracy if not equal to 'none'. Default: "least_squares" + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + Row coordinate of the found instances of the models. + Column coordinate of the found instances of the models. + Rotation angle of the found instances of the models. + Score of the found instances of the models. + Index of the found instances of the models. + + + + Find the best matches of an anisotropically scaled shape model in an image. + Instance represents: Input image in which the model should be found. + + Handle of the model. + Smallest rotation of the model. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Minimum scale of the model in the row direction. Default: 0.9 + Maximum scale of the model in the row direction. Default: 1.1 + Minimum scale of the model in the column direction. Default: 0.9 + Maximum scale of the model in the column direction. Default: 1.1 + Minimum score of the instances of the model to be found. Default: 0.5 + Number of instances of the model to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the model to be found. Default: 0.5 + Subpixel accuracy if not equal to 'none'. Default: "least_squares" + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + Row coordinate of the found instances of the model. + Column coordinate of the found instances of the model. + Rotation angle of the found instances of the model. + Scale of the found instances of the model in the row direction. + Scale of the found instances of the model in the column direction. + Score of the found instances of the model. + + + + Find the best matches of an anisotropically scaled shape model in an image. + Instance represents: Input image in which the model should be found. + + Handle of the model. + Smallest rotation of the model. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Minimum scale of the model in the row direction. Default: 0.9 + Maximum scale of the model in the row direction. Default: 1.1 + Minimum scale of the model in the column direction. Default: 0.9 + Maximum scale of the model in the column direction. Default: 1.1 + Minimum score of the instances of the model to be found. Default: 0.5 + Number of instances of the model to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the model to be found. Default: 0.5 + Subpixel accuracy if not equal to 'none'. Default: "least_squares" + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + Row coordinate of the found instances of the model. + Column coordinate of the found instances of the model. + Rotation angle of the found instances of the model. + Scale of the found instances of the model in the row direction. + Scale of the found instances of the model in the column direction. + Score of the found instances of the model. + + + + Find the best matches of an isotropically scaled shape model in an image. + Instance represents: Input image in which the model should be found. + + Handle of the model. + Smallest rotation of the model. Default: -0.39 + Extent of the rotation angles. Default: 0.78 + Minimum scale of the model. Default: 0.9 + Maximum scale of the model. Default: 1.1 + Minimum score of the instances of the model to be found. Default: 0.5 + Number of instances of the model to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the model to be found. Default: 0.5 + Subpixel accuracy if not equal to 'none'. Default: "least_squares" + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + Row coordinate of the found instances of the model. + Column coordinate of the found instances of the model. + Rotation angle of the found instances of the model. + Scale of the found instances of the model. + Score of the found instances of the model. + + + + Find the best matches of an isotropically scaled shape model in an image. + Instance represents: Input image in which the model should be found. + + Handle of the model. + Smallest rotation of the model. Default: -0.39 + Extent of the rotation angles. Default: 0.78 + Minimum scale of the model. Default: 0.9 + Maximum scale of the model. Default: 1.1 + Minimum score of the instances of the model to be found. Default: 0.5 + Number of instances of the model to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the model to be found. Default: 0.5 + Subpixel accuracy if not equal to 'none'. Default: "least_squares" + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + Row coordinate of the found instances of the model. + Column coordinate of the found instances of the model. + Rotation angle of the found instances of the model. + Scale of the found instances of the model. + Score of the found instances of the model. + + + + Find the best matches of a shape model in an image. + Instance represents: Input image in which the model should be found. + + Handle of the model. + Smallest rotation of the model. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Minimum score of the instances of the model to be found. Default: 0.5 + Number of instances of the model to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the model to be found. Default: 0.5 + Subpixel accuracy if not equal to 'none'. Default: "least_squares" + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + Row coordinate of the found instances of the model. + Column coordinate of the found instances of the model. + Rotation angle of the found instances of the model. + Score of the found instances of the model. + + + + Find the best matches of a shape model in an image. + Instance represents: Input image in which the model should be found. + + Handle of the model. + Smallest rotation of the model. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Minimum score of the instances of the model to be found. Default: 0.5 + Number of instances of the model to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the model to be found. Default: 0.5 + Subpixel accuracy if not equal to 'none'. Default: "least_squares" + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + Row coordinate of the found instances of the model. + Column coordinate of the found instances of the model. + Rotation angle of the found instances of the model. + Score of the found instances of the model. + + + + Set the metric of a shape model that was created from XLD contours. + Instance represents: Input image used for the determination of the polarity. + + Handle of the model. + Transformation matrix. + Match metric. Default: "use_polarity" + + + Set selected parameters of the shape model. + Handle of the model. + Parameter names. + Parameter values. + + + + Prepare an anisotropically scaled shape model for matching. + Instance represents: Input image whose domain will be used to create the model. + + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in the row direction. Default: 0.9 + Maximum scale of the pattern in the row direction. Default: 1.1 + Scale step length (resolution) in the row direction. Default: "auto" + Minimum scale of the pattern in the column direction. Default: 0.9 + Maximum scale of the pattern in the column direction. Default: 1.1 + Scale step length (resolution) in the column direction. Default: "auto" + Kind of optimization and optionally method used for generating the model. Default: "auto" + Match metric. Default: "use_polarity" + Threshold or hysteresis thresholds for the contrast of the object in the template image and optionally minimum size of the object parts. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + Handle of the model. + + + + Prepare an anisotropically scaled shape model for matching. + Instance represents: Input image whose domain will be used to create the model. + + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in the row direction. Default: 0.9 + Maximum scale of the pattern in the row direction. Default: 1.1 + Scale step length (resolution) in the row direction. Default: "auto" + Minimum scale of the pattern in the column direction. Default: 0.9 + Maximum scale of the pattern in the column direction. Default: 1.1 + Scale step length (resolution) in the column direction. Default: "auto" + Kind of optimization and optionally method used for generating the model. Default: "auto" + Match metric. Default: "use_polarity" + Threshold or hysteresis thresholds for the contrast of the object in the template image and optionally minimum size of the object parts. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + Handle of the model. + + + + Prepare an isotropically scaled shape model for matching. + Instance represents: Input image whose domain will be used to create the model. + + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern. Default: 0.9 + Maximum scale of the pattern. Default: 1.1 + Scale step length (resolution). Default: "auto" + Kind of optimization and optionally method used for generating the model. Default: "auto" + Match metric. Default: "use_polarity" + Threshold or hysteresis thresholds for the contrast of the object in the template image and optionally minimum size of the object parts. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + Handle of the model. + + + + Prepare an isotropically scaled shape model for matching. + Instance represents: Input image whose domain will be used to create the model. + + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern. Default: 0.9 + Maximum scale of the pattern. Default: 1.1 + Scale step length (resolution). Default: "auto" + Kind of optimization and optionally method used for generating the model. Default: "auto" + Match metric. Default: "use_polarity" + Threshold or hysteresis thresholds for the contrast of the object in the template image and optionally minimum size of the object parts. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + Handle of the model. + + + + Prepare a shape model for matching. + Instance represents: Input image whose domain will be used to create the model. + + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Kind of optimization and optionally method used for generating the model. Default: "auto" + Match metric. Default: "use_polarity" + Threshold or hysteresis thresholds for the contrast of the object in the template image and optionally minimum size of the object parts. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + Handle of the model. + + + + Prepare a shape model for matching. + Instance represents: Input image whose domain will be used to create the model. + + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Kind of optimization and optionally method used for generating the model. Default: "auto" + Match metric. Default: "use_polarity" + Threshold or hysteresis thresholds for the contrast of the object in the template image and optionally minimum size of the object parts. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + Handle of the model. + + + + Create the representation of a shape model. + Instance represents: Input image. + + Model region pyramid + Number of pyramid levels. Default: 4 + Threshold or hysteresis thresholds for the contrast of the object in the image and optionally minimum size of the object parts. Default: 30 + Image pyramid of the input image + + + + Create the representation of a shape model. + Instance represents: Input image. + + Model region pyramid + Number of pyramid levels. Default: 4 + Threshold or hysteresis thresholds for the contrast of the object in the image and optionally minimum size of the object parts. Default: 30 + Image pyramid of the input image + + + + Find the best matches of a calibrated descriptor model in an image and return their 3D pose. + Instance represents: Input image where the model should be found. + + The handle to the descriptor model. + The detector's parameter names. Default: [] + Values of the detector's parameters. Default: [] + The descriptor's parameter names. Default: [] + Values of the descriptor's parameters. Default: [] + Minimum score of the instances of the models to be found. Default: 0.2 + Maximal number of found instances. Default: 1 + Camera parameter (inner orientation) obtained from camera calibration. + Score type to be evaluated in Score. Default: "num_points" + Score of the found instances according to the ScoreType input. + 3D pose of the object. + + + + Find the best matches of a calibrated descriptor model in an image and return their 3D pose. + Instance represents: Input image where the model should be found. + + The handle to the descriptor model. + The detector's parameter names. Default: [] + Values of the detector's parameters. Default: [] + The descriptor's parameter names. Default: [] + Values of the descriptor's parameters. Default: [] + Minimum score of the instances of the models to be found. Default: 0.2 + Maximal number of found instances. Default: 1 + Camera parameter (inner orientation) obtained from camera calibration. + Score type to be evaluated in Score. Default: "num_points" + Score of the found instances according to the ScoreType input. + 3D pose of the object. + + + + Find the best matches of a descriptor model in an image. + Instance represents: Input image where the model should be found. + + The handle to the descriptor model. + The detector's parameter names. Default: [] + Values of the detector's parameters. Default: [] + The descriptor's parameter names. Default: [] + Values of the descriptor's parameters. Default: [] + Minimum score of the instances of the models to be found. Default: 0.2 + Maximal number of found instances. Default: 1 + Score type to be evaluated in Score. Default: "num_points" + Score of the found instances according to the ScoreType input. + Homography between model and found instance. + + + + Find the best matches of a descriptor model in an image. + Instance represents: Input image where the model should be found. + + The handle to the descriptor model. + The detector's parameter names. Default: [] + Values of the detector's parameters. Default: [] + The descriptor's parameter names. Default: [] + Values of the descriptor's parameters. Default: [] + Minimum score of the instances of the models to be found. Default: 0.2 + Maximal number of found instances. Default: 1 + Score type to be evaluated in Score. Default: "num_points" + Score of the found instances according to the ScoreType input. + Homography between model and found instance. + + + + Create a descriptor model for calibrated perspective matching. + Instance represents: Input image whose domain will be used to create the model. + + The parameters of the internal orientation of the camera. + The reference pose of the object in the reference image. + The type of the detector. Default: "lepetit" + The detector's parameter names. Default: [] + Values of the detector's parameters. Default: [] + The descriptor's parameter names. Default: [] + Values of the descriptor's parameters. Default: [] + The seed for the random number generator. Default: 42 + The handle to the descriptor model. + + + + Prepare a descriptor model for interest point matching. + Instance represents: Input image whose domain will be used to create the model. + + The type of the detector. Default: "lepetit" + The detector's parameter names. Default: [] + Values of the detector's parameters. Default: [] + The descriptor's parameter names. Default: [] + Values of the descriptor's parameters. Default: [] + The seed for the random number generator. Default: 42 + The handle to the descriptor model. + + + + Determine the parameters of a deformable model. + Instance represents: Input image whose domain will be used to create the model. + + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the model. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Minimum scale of the model. Default: 0.9 + Maximum scale of the model. Default: 1.1 + Kind of optimization. Default: "auto" + Match metric. Default: "use_polarity" + Threshold or hysteresis thresholds for the contrast of the object in the template image and optionally minimum size of the object parts. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + The general parameter names. Default: [] + Values of the general parameter. Default: [] + Parameters to be determined automatically. Default: "all" + Value of the automatically determined parameter. + Name of the automatically determined parameter. + + + + Determine the parameters of a deformable model. + Instance represents: Input image whose domain will be used to create the model. + + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the model. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Minimum scale of the model. Default: 0.9 + Maximum scale of the model. Default: 1.1 + Kind of optimization. Default: "auto" + Match metric. Default: "use_polarity" + Threshold or hysteresis thresholds for the contrast of the object in the template image and optionally minimum size of the object parts. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + The general parameter names. Default: [] + Values of the general parameter. Default: [] + Parameters to be determined automatically. Default: "all" + Value of the automatically determined parameter. + Name of the automatically determined parameter. + + + + Find the best matches of a local deformable model in an image. + Instance represents: Input image in which the model should be found. + + Vector field of the rectification transformation. + Contours of the found instances of the model. + Handle of the model. + Smallest rotation of the model. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Minimum scale of the model in row direction. Default: 1.0 + Maximum scale of the model in row direction. Default: 1.0 + Minimum scale of the model in column direction. Default: 1.0 + Maximum scale of the model in column direction. Default: 1.0 + Minumum score of the instances of the model to be found. Default: 0.5 + Number of instances of the model to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the model to be found. Default: 1.0 + Number of pyramid levels used in the matching. Default: 0 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + Switch for requested iconic result. Default: [] + The general parameter names. Default: [] + Values of the general parameters. Default: [] + Scores of the found instances of the model. + Row coordinates of the found instances of the model. + Column coordinates of the found instances of the model. + Rectified image of the found model. + + + + Find the best matches of a calibrated deformable model in an image and return their 3D pose. + Instance represents: Input image in which the model should be found. + + Handle of the model. + Smallest rotation of the model. Default: -0.39 + Extent of the rotation angles. Default: 0.78 + Minimum scale of the model in row direction. Default: 1.0 + Maximum scale of the model in row direction. Default: 1.0 + Minimum scale of the model in column direction. Default: 1.0 + Maximum scale of the model in column direction. Default: 1.0 + Minimum score of the instances of the model to be found. Default: 0.5 + Number of instances of the model to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the model to be found. Default: 1.0 + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + The general parameter names. Default: [] + Values of the general parameters. Default: [] + 6 standard deviations or 36 covariances of the pose parameters. + Score of the found instances of the model. + Pose of the object. + + + + Find the best matches of a calibrated deformable model in an image and return their 3D pose. + Instance represents: Input image in which the model should be found. + + Handle of the model. + Smallest rotation of the model. Default: -0.39 + Extent of the rotation angles. Default: 0.78 + Minimum scale of the model in row direction. Default: 1.0 + Maximum scale of the model in row direction. Default: 1.0 + Minimum scale of the model in column direction. Default: 1.0 + Maximum scale of the model in column direction. Default: 1.0 + Minimum score of the instances of the model to be found. Default: 0.5 + Number of instances of the model to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the model to be found. Default: 1.0 + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + The general parameter names. Default: [] + Values of the general parameters. Default: [] + 6 standard deviations or 36 covariances of the pose parameters. + Score of the found instances of the model. + Pose of the object. + + + + Find the best matches of a planar projective invariant deformable model in an image. + Instance represents: Input image in which the model should be found. + + Handle of the model. + Smallest rotation of the model. Default: -0.39 + Extent of the rotation angles. Default: 0.78 + Minimum scale of the model in row direction. Default: 1.0 + Maximum scale of the model in row direction. Default: 1.0 + Minimum scale of the model in column direction. Default: 1.0 + Maximum scale of the model in column direction. Default: 1.0 + Minimum score of the instances of the model to be found. Default: 0.5 + Number of instances of the model to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the model to be found. Default: 1.0 + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + The general parameter names. Default: [] + Values of the general parameters. Default: [] + Score of the found instances of the model. + Homographies between model and found instances. + + + + Find the best matches of a planar projective invariant deformable model in an image. + Instance represents: Input image in which the model should be found. + + Handle of the model. + Smallest rotation of the model. Default: -0.39 + Extent of the rotation angles. Default: 0.78 + Minimum scale of the model in row direction. Default: 1.0 + Maximum scale of the model in row direction. Default: 1.0 + Minimum scale of the model in column direction. Default: 1.0 + Maximum scale of the model in column direction. Default: 1.0 + Minimum score of the instances of the model to be found. Default: 0.5 + Number of instances of the model to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the model to be found. Default: 1.0 + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + The general parameter names. Default: [] + Values of the general parameters. Default: [] + Score of the found instances of the model. + Homographies between model and found instances. + + + + Set the metric of a local deformable model that was created from XLD contours. + Instance represents: Input image used for the determination of the polarity. + + Vector field of the local deformation. + Handle of the model. + Match metric. Default: "use_polarity" + + + + Set the metric of a planar calibrated deformable model that was created from XLD contours. + Instance represents: Input image used for the determination of the polarity. + + Handle of the model. + Pose of the model in the image. + Match metric. Default: "use_polarity" + + + + Set the metric of a planar uncalibrated deformable model that was created from XLD contours. + Instance represents: Input image used for the determination of the polarity. + + Handle of the model. + Transformation matrix. + Match metric. Default: "use_polarity" + + + + Creates a deformable model for local, deformable matching. + Instance represents: Input image whose domain will be used to create the model. + + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "none" + Match metric. Default: "use_polarity" + Thresholds or hysteresis thresholds for the contrast of the object in the template image. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + The generic parameter names. Default: [] + Values of the generic parameters. Default: [] + Handle of the model. + + + + Creates a deformable model for local, deformable matching. + Instance represents: Input image whose domain will be used to create the model. + + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "none" + Match metric. Default: "use_polarity" + Thresholds or hysteresis thresholds for the contrast of the object in the template image. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + The generic parameter names. Default: [] + Values of the generic parameters. Default: [] + Handle of the model. + + + + Create a deformable model for calibrated perspective matching. + Instance represents: Input image whose domain will be used to create the model. + + The parameters of the internal orientation of the camera. + The reference pose of the object in the reference image. + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in the column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "none" + Match metric. Default: "use_polarity" + Thresholds or hysteresis thresholds for the contrast of the object in the template image. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + The parameter names. Default: [] + Values of the parameters. Default: [] + Handle of the model. + + + + Create a deformable model for calibrated perspective matching. + Instance represents: Input image whose domain will be used to create the model. + + The parameters of the internal orientation of the camera. + The reference pose of the object in the reference image. + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in the column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "none" + Match metric. Default: "use_polarity" + Thresholds or hysteresis thresholds for the contrast of the object in the template image. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + The parameter names. Default: [] + Values of the parameters. Default: [] + Handle of the model. + + + + Creates a deformable model for uncalibrated, perspective matching. + Instance represents: Input image whose domain will be used to create the model. + + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "none" + Match metric. Default: "use_polarity" + Thresholds or hysteresis thresholds for the contrast of the object in the template image. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + The generic parameter names. Default: [] + Values of the generic parameter. Default: [] + Handle of the model. + + + + Creates a deformable model for uncalibrated, perspective matching. + Instance represents: Input image whose domain will be used to create the model. + + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "none" + Match metric. Default: "use_polarity" + Thresholds or hysteresis thresholds for the contrast of the object in the template image. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + The generic parameter names. Default: [] + Values of the generic parameter. Default: [] + Handle of the model. + + + + Find the best matches of an NCC model in an image. + Instance represents: Input image in which the model should be found. + + Handle of the model. + Smallest rotation of the model. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Minimum score of the instances of the model to be found. Default: 0.8 + Number of instances of the model to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the model to be found. Default: 0.5 + Subpixel accuracy. Default: "true" + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + Row coordinate of the found instances of the model. + Column coordinate of the found instances of the model. + Rotation angle of the found instances of the model. + Score of the found instances of the model. + + + + Find the best matches of an NCC model in an image. + Instance represents: Input image in which the model should be found. + + Handle of the model. + Smallest rotation of the model. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Minimum score of the instances of the model to be found. Default: 0.8 + Number of instances of the model to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the model to be found. Default: 0.5 + Subpixel accuracy. Default: "true" + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + Row coordinate of the found instances of the model. + Column coordinate of the found instances of the model. + Rotation angle of the found instances of the model. + Score of the found instances of the model. + + + Set selected parameters of the NCC model. + Handle of the model. + Parameter names. + Parameter values. + + + + Prepare an NCC model for matching. + Instance represents: Input image whose domain will be used to create the model. + + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Match metric. Default: "use_polarity" + Handle of the model. + + + + Prepare an NCC model for matching. + Instance represents: Input image whose domain will be used to create the model. + + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Match metric. Default: "use_polarity" + Handle of the model. + + + + Find the best matches of a component model in an image. + Instance represents: Input image in which the component model should be found. + + Handle of the component model. + Index of the root component. + Smallest rotation of the root component Default: -0.39 + Extent of the rotation of the root component. Default: 0.79 + Minimum score of the instances of the component model to be found. Default: 0.5 + Number of instances of the component model to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the component models to be found. Default: 0.5 + Behavior if the root component is missing. Default: "stop_search" + Behavior if a component is missing. Default: "prune_branch" + Pose prediction of components that are not found. Default: "none" + Minimum score of the instances of the components to be found. Default: 0.5 + Subpixel accuracy of the component poses if not equal to 'none'. Default: "least_squares" + Number of pyramid levels for the components used in the matching (and lowest pyramid level to use if $|NumLevelsComp| = 2n$). Default: 0 + "Greediness" of the search heuristic for the components (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + End index of each found instance of the component model in the tuples describing the component matches. + Score of the found instances of the component model. + Row coordinate of the found component matches. + Column coordinate of the found component matches. + Rotation angle of the found component matches. + Score of the found component matches. + Index of the found components. + Start index of each found instance of the component model in the tuples describing the component matches. + + + + Find the best matches of a component model in an image. + Instance represents: Input image in which the component model should be found. + + Handle of the component model. + Index of the root component. + Smallest rotation of the root component Default: -0.39 + Extent of the rotation of the root component. Default: 0.79 + Minimum score of the instances of the component model to be found. Default: 0.5 + Number of instances of the component model to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the component models to be found. Default: 0.5 + Behavior if the root component is missing. Default: "stop_search" + Behavior if a component is missing. Default: "prune_branch" + Pose prediction of components that are not found. Default: "none" + Minimum score of the instances of the components to be found. Default: 0.5 + Subpixel accuracy of the component poses if not equal to 'none'. Default: "least_squares" + Number of pyramid levels for the components used in the matching (and lowest pyramid level to use if $|NumLevelsComp| = 2n$). Default: 0 + "Greediness" of the search heuristic for the components (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + End index of each found instance of the component model in the tuples describing the component matches. + Score of the found instances of the component model. + Row coordinate of the found component matches. + Column coordinate of the found component matches. + Rotation angle of the found component matches. + Score of the found component matches. + Index of the found components. + Start index of each found instance of the component model in the tuples describing the component matches. + + + + Prepare a component model for matching based on explicitly specified components and relations. + Instance represents: Input image from which the shape models of the model components should be created. + + Input regions from which the shape models of the model components should be created. + Variation of the model components in row direction. + Variation of the model components in column direction. + Angle variation of the model components. + Smallest rotation of the component model. Default: -0.39 + Extent of the rotation of the component model. Default: 0.79 + Lower hysteresis threshold for the contrast of the components in the model image. Default: "auto" + Upper hysteresis threshold for the contrast of the components in the model image. Default: "auto" + Minimum size of the contour regions in the model. Default: "auto" + Minimum contrast of the components in the search images. Default: "auto" + Minimum score of the instances of the components to be found. Default: 0.5 + Maximum number of pyramid levels for the components. Default: "auto" + Step length of the angles (resolution) for the components. Default: "auto" + Kind of optimization for the components. Default: "auto" + Match metric used for the components. Default: "use_polarity" + Complete pregeneration of the shape models for the components if equal to 'true'. Default: "false" + Ranking of the model components expressing the suitability to act as the root component. + Handle of the component model. + + + + Prepare a component model for matching based on explicitly specified components and relations. + Instance represents: Input image from which the shape models of the model components should be created. + + Input regions from which the shape models of the model components should be created. + Variation of the model components in row direction. + Variation of the model components in column direction. + Angle variation of the model components. + Smallest rotation of the component model. Default: -0.39 + Extent of the rotation of the component model. Default: 0.79 + Lower hysteresis threshold for the contrast of the components in the model image. Default: "auto" + Upper hysteresis threshold for the contrast of the components in the model image. Default: "auto" + Minimum size of the contour regions in the model. Default: "auto" + Minimum contrast of the components in the search images. Default: "auto" + Minimum score of the instances of the components to be found. Default: 0.5 + Maximum number of pyramid levels for the components. Default: "auto" + Step length of the angles (resolution) for the components. Default: "auto" + Kind of optimization for the components. Default: "auto" + Match metric used for the components. Default: "use_polarity" + Complete pregeneration of the shape models for the components if equal to 'true'. Default: "false" + Ranking of the model components expressing the suitability to act as the root component. + Handle of the component model. + + + + Adopt new parameters that are used to create the model components into the training result. + Instance represents: Training images that were used for training the model components. + + Handle of the training result. + Criterion for solving the ambiguities. Default: "rigidity" + Maximum contour overlap of the found initial components. Default: 0.2 + Threshold for clustering the initial components. Default: 0.5 + Contour regions of rigid model components. + + + + Train components and relations for the component-based matching. + Instance represents: Input image from which the shape models of the initial components should be created. + + Contour regions or enclosing regions of the initial components. + Training images that are used for training the model components. + Lower hysteresis threshold for the contrast of the initial components in the image. Default: "auto" + Upper hysteresis threshold for the contrast of the initial components in the image. Default: "auto" + Minimum size of connected contour regions. Default: "auto" + Minimum score of the instances of the initial components to be found. Default: 0.5 + Search tolerance in row direction. Default: -1 + Search tolerance in column direction. Default: -1 + Angle search tolerance. Default: -1 + Decision whether the training emphasis should lie on a fast computation or on a high robustness. Default: "speed" + Criterion for solving ambiguous matches of the initial components in the training images. Default: "rigidity" + Maximum contour overlap of the found initial components in a training image. Default: 0.2 + Threshold for clustering the initial components. Default: 0.5 + Handle of the training result. + Contour regions of rigid model components. + + + + Train components and relations for the component-based matching. + Instance represents: Input image from which the shape models of the initial components should be created. + + Contour regions or enclosing regions of the initial components. + Training images that are used for training the model components. + Lower hysteresis threshold for the contrast of the initial components in the image. Default: "auto" + Upper hysteresis threshold for the contrast of the initial components in the image. Default: "auto" + Minimum size of connected contour regions. Default: "auto" + Minimum score of the instances of the initial components to be found. Default: 0.5 + Search tolerance in row direction. Default: -1 + Search tolerance in column direction. Default: -1 + Angle search tolerance. Default: -1 + Decision whether the training emphasis should lie on a fast computation or on a high robustness. Default: "speed" + Criterion for solving ambiguous matches of the initial components in the training images. Default: "rigidity" + Maximum contour overlap of the found initial components in a training image. Default: 0.2 + Threshold for clustering the initial components. Default: 0.5 + Handle of the training result. + Contour regions of rigid model components. + + + + Extract the initial components of a component model. + Instance represents: Input image from which the initial components should be extracted. + + Lower hysteresis threshold for the contrast of the initial components in the image. Default: "auto" + Upper hysteresis threshold for the contrast of the initial components in the image. Default: "auto" + Minimum size of the initial components. Default: "auto" + Type of automatic segmentation. Default: "connection" + Names of optional control parameters. Default: [] + Values of optional control parameters. Default: [] + Contour regions of initial components. + + + + Extract the initial components of a component model. + Instance represents: Input image from which the initial components should be extracted. + + Lower hysteresis threshold for the contrast of the initial components in the image. Default: "auto" + Upper hysteresis threshold for the contrast of the initial components in the image. Default: "auto" + Minimum size of the initial components. Default: "auto" + Type of automatic segmentation. Default: "connection" + Names of optional control parameters. Default: [] + Values of optional control parameters. Default: [] + Contour regions of initial components. + + + + Find the best matches of a 3D shape model in an image. + Instance represents: Input image in which the model should be found. + + Handle of the 3D shape model. + Minimum score of the instances of the model to be found. Default: 0.7 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + Names of (optional) parameters for controlling the behavior of the operator. Default: [] + Values of the optional generic parameters. Default: [] + 6 standard deviations or 36 covariances of the pose parameters. + Score of the found instances of the 3D shape model. + 3D pose of the 3D shape model. + + + + Convert one-channel images into a multi-channel image + Instance represents: One-channel images to be combined into a one-channel image. + + Multi-channel image. + + + + Convert a multi-channel image into One-channel images + Instance represents: Multi-channel image to be decomposed. + + Generated one-channel images. + + + + Convert 7 images into a seven-channel image. + Instance represents: Input image 1. + + Input image 2. + Input image 3. + Input image 4. + Input image 5. + Input image 6. + Input image 7. + Multi-channel image. + + + + Convert 6 images into a six-channel image. + Instance represents: Input image 1. + + Input image 2. + Input image 3. + Input image 4. + Input image 5. + Input image 6. + Multi-channel image. + + + + Convert 5 images into a five-channel image. + Instance represents: Input image 1. + + Input image 2. + Input image 3. + Input image 4. + Input image 5. + Multi-channel image. + + + + Convert 4 images into a four-channel image. + Instance represents: Input image 1. + + Input image 2. + Input image 3. + Input image 4. + Multi-channel image. + + + + Convert 3 images into a three-channel image. + Instance represents: Input image 1. + + Input image 2. + Input image 3. + Multi-channel image. + + + + Convert two images into a two-channel image. + Instance represents: Input image 1. + + Input image 2. + Multi-channel image. + + + + Convert a seven-channel image into seven images. + Instance represents: Multi-channel image. + + Output image 2. + Output image 3. + Output image 4. + Output image 5. + Output image 6. + Output image 7. + Output image 1. + + + + Convert a six-channel image into six images. + Instance represents: Multi-channel image. + + Output image 2. + Output image 3. + Output image 4. + Output image 5. + Output image 6. + Output image 1. + + + + Convert a five-channel image into five images. + Instance represents: Multi-channel image. + + Output image 2. + Output image 3. + Output image 4. + Output image 5. + Output image 1. + + + + Convert a four-channel image into four images. + Instance represents: Multi-channel image. + + Output image 2. + Output image 3. + Output image 4. + Output image 1. + + + + Convert a three-channel image into three images. + Instance represents: Multi-channel image. + + Output image 2. + Output image 3. + Output image 1. + + + + Convert a two-channel image into two images. + Instance represents: Multi-channel image. + + Output image 2. + Output image 1. + + + + Count channels of image. + Instance represents: One- or multi-channel image. + + Number of channels. + + + + Append additional matrices (channels) to the image. + Instance represents: Multi-channel image. + + Image to be appended. + Image appended by Image. + + + + Access a channel of a multi-channel image. + Instance represents: Multi-channel image. + + Index of channel to be accessed. Default: 1 + One channel of MultiChannelImage. + + + + Tile multiple image objects into a large image with explicit positioning information. + Instance represents: Input images. + + Row coordinate of the upper left corner of the input images in the output image. Default: 0 + Column coordinate of the upper left corner of the input images in the output image. Default: 0 + Row coordinate of the upper left corner of the copied part of the respective input image. Default: -1 + Column coordinate of the upper left corner of the copied part of the respective input image. Default: -1 + Row coordinate of the lower right corner of the copied part of the respective input image. Default: -1 + Column coordinate of the lower right corner of the copied part of the respective input image. Default: -1 + Width of the output image. Default: 512 + Height of the output image. Default: 512 + Tiled output image. + + + + Tile multiple image objects into a large image with explicit positioning information. + Instance represents: Input images. + + Row coordinate of the upper left corner of the input images in the output image. Default: 0 + Column coordinate of the upper left corner of the input images in the output image. Default: 0 + Row coordinate of the upper left corner of the copied part of the respective input image. Default: -1 + Column coordinate of the upper left corner of the copied part of the respective input image. Default: -1 + Row coordinate of the lower right corner of the copied part of the respective input image. Default: -1 + Column coordinate of the lower right corner of the copied part of the respective input image. Default: -1 + Width of the output image. Default: 512 + Height of the output image. Default: 512 + Tiled output image. + + + + Tile multiple image objects into a large image. + Instance represents: Input images. + + Number of columns to use for the output image. Default: 1 + Order of the input images in the output image. Default: "vertical" + Tiled output image. + + + + Tile multiple images into a large image. + Instance represents: Input image. + + Number of columns to use for the output image. Default: 1 + Order of the input images in the output image. Default: "vertical" + Tiled output image. + + + + Cut out of defined gray values. + Instance represents: Input image. + + Image area. + + + + Cut out one or more rectangular image areas. + Instance represents: Input image. + + Line index of upper left corner of image area. Default: 100 + Column index of upper left corner of image area. Default: 100 + Line index of lower right corner of image area. Default: 200 + Column index of lower right corner of image area. Default: 200 + Image area. + + + + Cut out one or more rectangular image areas. + Instance represents: Input image. + + Line index of upper left corner of image area. Default: 100 + Column index of upper left corner of image area. Default: 100 + Line index of lower right corner of image area. Default: 200 + Column index of lower right corner of image area. Default: 200 + Image area. + + + + Cut out one or more rectangular image areas. + Instance represents: Input image. + + Line index of upper left corner of image area. Default: 100 + Column index of upper left corner of image area. Default: 100 + Width of new image. Default: 128 + Height of new image. Default: 128 + Image area. + + + + Cut out one or more rectangular image areas. + Instance represents: Input image. + + Line index of upper left corner of image area. Default: 100 + Column index of upper left corner of image area. Default: 100 + Width of new image. Default: 128 + Height of new image. Default: 128 + Image area. + + + + Change image size. + Instance represents: Input image. + + Width of new image. Default: 512 + Height of new image. Default: 512 + Image with new format. + + + + Change definition domain of an image. + Instance represents: Input image. + + New definition domain. + Image with new definition domain. + + + + Reduce the domain of an image to a rectangle. + Instance represents: Input image. + + Line index of upper left corner of image area. Default: 100 + Column index of upper left corner of image area. Default: 100 + Line index of lower right corner of image area. Default: 200 + Column index of lower right corner of image area. Default: 200 + Image with reduced definition domain. + + + + Reduce the domain of an image. + Instance represents: Input image. + + New definition domain. + Image with reduced definition domain. + + + + Expand the domain of an image to maximum. + Instance represents: Input image. + + Image with maximum definition domain. + + + + Get the domain of an image. + Instance represents: Input images. + + Definition domains of input images. + + + + Detect lines in edge images with the help of the Hough transform using local gradient direction and return them in normal form. + Instance represents: Image containing the edge direction. The edges are described by the image domain. + + Regions of the input image that contributed to the local maxima. + Uncertainty of edge direction (in degrees). Default: 2 + Resolution in the angle area (in 1/degrees). Default: 4 + Smoothing filter for hough image. Default: "mean" + Required smoothing filter size. Default: 5 + Threshold value in the Hough image. Default: 100 + Minimum distance of two maxima in the Hough image (direction: angle). Default: 5 + Minimum distance of two maxima in the Hough image (direction: distance). Default: 5 + Create line regions if 'true'. Default: "true" + Angles (in radians) of the detected lines' normal vectors. + Distance of the detected lines from the origin. + Hough transform. + + + + Compute the Hough transform for lines using local gradient direction. + Instance represents: Image containing the edge direction. The edges must be described by the image domain. + + Uncertainty of the edge direction (in degrees). Default: 2 + Resolution in the angle area (in 1/degrees). Default: 4 + Hough transform. + + + + Segment the rectification grid region in the image. + Instance represents: Input image. + + Minimum contrast. Default: 8.0 + Radius of the circular structuring element. Default: 7.5 + Output region containing the rectification grid. + + + + Segment the rectification grid region in the image. + Instance represents: Input image. + + Minimum contrast. Default: 8.0 + Radius of the circular structuring element. Default: 7.5 + Output region containing the rectification grid. + + + + Establish connections between the grid points of the rectification grid. + Instance represents: Input image. + + Row coordinates of the grid points. + Column coordinates of the grid points. + Size of the applied Gaussians. Default: 0.9 + Maximum distance of the connecting lines from the grid points. Default: 5.5 + Output contours. + + + + Establish connections between the grid points of the rectification grid. + Instance represents: Input image. + + Row coordinates of the grid points. + Column coordinates of the grid points. + Size of the applied Gaussians. Default: 0.9 + Maximum distance of the connecting lines from the grid points. Default: 5.5 + Output contours. + + + + Compute the mapping between the distorted image and the rectified image based upon the points of a regular grid. + Instance represents: Input image. + + Input contours. + Output contours. + Distance of the grid points in the rectified image. + Rotation to be applied to the point grid. Default: "auto" + Row coordinates of the grid points. + Column coordinates of the grid points. + Type of mapping. Default: "bilinear" + Image containing the mapping data. + + + + Compute the mapping between the distorted image and the rectified image based upon the points of a regular grid. + Instance represents: Input image. + + Input contours. + Output contours. + Distance of the grid points in the rectified image. + Rotation to be applied to the point grid. Default: "auto" + Row coordinates of the grid points. + Column coordinates of the grid points. + Type of mapping. Default: "bilinear" + Image containing the mapping data. + + + + Calculates image coordinates for a point in a 3D plot window. + Instance represents: Displayed image. + + Window handle. + Row coordinate in the window. + Column coordinate in the window. + Row coordinate in the image. + Column coordinate in the image. + Height value. + + + + Calculates image coordinates for a point in a 3D plot window. + Instance represents: Displayed image. + + Window handle. + Row coordinate in the window. + Column coordinate in the window. + Row coordinate in the image. + Column coordinate in the image. + Height value. + + + + Write the window content in an image object. + Modified instance represents: Saved image. + + Window handle. + + + + Displays gray value images. + Instance represents: Gray value image to display. + + Window handle. + + + + Displays images with several channels. + Instance represents: Multichannel images to be displayed. + + Window handle. + Number of channel or the numbers of the RGB-channels Default: 1 + + + + Displays images with several channels. + Instance represents: Multichannel images to be displayed. + + Window handle. + Number of channel or the numbers of the RGB-channels Default: 1 + + + + Displays a color (RGB) image + Instance represents: Color image to display. + + Window handle. + + + + Visualize images using gnuplot. + Instance represents: Image to be plotted. + + Identifier for the gnuplot output stream. + Number of samples in the x-direction. Default: 64 + Number of samples in the y-direction. Default: 64 + Rotation of the plot about the x-axis. Default: 60 + Rotation of the plot about the z-axis. Default: 30 + Plot the image with hidden surfaces removed. Default: "hidden3d" + + + + Visualize images using gnuplot. + Instance represents: Image to be plotted. + + Identifier for the gnuplot output stream. + Number of samples in the x-direction. Default: 64 + Number of samples in the y-direction. Default: 64 + Rotation of the plot about the x-axis. Default: 60 + Rotation of the plot about the z-axis. Default: 30 + Plot the image with hidden surfaces removed. Default: "hidden3d" + + + + Filter an image using a Laws texture filter. + Instance represents: Images to which the texture transformation is to be applied. + + Desired filter. Default: "el" + Shift to reduce the gray value dynamics. Default: 2 + Size of the filter kernel. Default: 5 + Texture images. + + + + Calculate the standard deviation of gray values within rectangular windows. + Instance represents: Image for which the standard deviation is to be calculated. + + Width of the mask in which the standard deviation is calculated. Default: 11 + Height of the mask in which the standard deviation is calculated. Default: 11 + Image containing the standard deviation. + + + + Calculate the entropy of gray values within a rectangular window. + Instance represents: Image for which the entropy is to be calculated. + + Width of the mask in which the entropy is calculated. Default: 9 + Height of the mask in which the entropy is calculated. Default: 9 + Entropy image. + + + + Perform an isotropic diffusion of an image. + Instance represents: Input image. + + Standard deviation of the Gauss distribution. Default: 1.0 + Number of iterations. Default: 10 + Output image. + + + + Perform an anisotropic diffusion of an image. + Instance represents: Input image. + + Diffusion coefficient as a function of the edge amplitude. Default: "weickert" + Contrast parameter. Default: 5.0 + Time step. Default: 1.0 + Number of iterations. Default: 10 + Output image. + + + + Smooth an image using various filters. + Instance represents: Image to be smoothed. + + Filter. Default: "deriche2" + Filterparameter: small values cause strong smoothing (vice versa by using bei 'gauss'). Default: 0.5 + Smoothed image. + + + + Non-linear smoothing with the sigma filter. + Instance represents: Image to be smoothed. + + Height of the mask (number of lines). Default: 5 + Width of the mask (number of columns). Default: 5 + Max. deviation to the average. Default: 3 + Smoothed image. + + + + Calculate the average of maximum and minimum inside any mask. + Instance represents: Image to be filtered. + + Filter mask. + Border treatment. Default: "mirrored" + Filtered image. + + + + Calculate the average of maximum and minimum inside any mask. + Instance represents: Image to be filtered. + + Filter mask. + Border treatment. Default: "mirrored" + Filtered image. + + + + Smooth an image with an arbitrary rank mask. + Instance represents: Image to be filtered. + + Image whose region serves as filter mask. + Number of averaged pixels. Typical value: Surface(Mask) / 2. Default: 5 + Border treatment. Default: "mirrored" + Filtered output image. + + + + Smooth an image with an arbitrary rank mask. + Instance represents: Image to be filtered. + + Image whose region serves as filter mask. + Number of averaged pixels. Typical value: Surface(Mask) / 2. Default: 5 + Border treatment. Default: "mirrored" + Filtered output image. + + + + Separated median filtering with rectangle masks. + Instance represents: Image to be filtered. + + Width of rank mask. Default: 25 + Height of rank mask. Default: 25 + Border treatment. Default: "mirrored" + Median filtered image. + + + + Separated median filtering with rectangle masks. + Instance represents: Image to be filtered. + + Width of rank mask. Default: 25 + Height of rank mask. Default: 25 + Border treatment. Default: "mirrored" + Median filtered image. + + + + Compute a median filter with rectangular masks. + Instance represents: Image to be filtered. + + Width of the filter mask. Default: 15 + Height of the filter mask. Default: 15 + Filtered image. + + + + Compute a median filter with various masks. + Instance represents: Image to be filtered. + + Filter mask type. Default: "circle" + Radius of the filter mask. Default: 1 + Border treatment. Default: "mirrored" + Filtered image. + + + + Compute a median filter with various masks. + Instance represents: Image to be filtered. + + Filter mask type. Default: "circle" + Radius of the filter mask. Default: 1 + Border treatment. Default: "mirrored" + Filtered image. + + + + Weighted median filtering with different rank masks. + Instance represents: Image to be filtered. + + Type of median mask. Default: "inner" + mask size. Default: 3 + Median filtered image. + + + + Compute a rank filter with rectangular masks. + Instance represents: Image to be filtered. + + Width of the filter mask. Default: 15 + Height of the filter mask. Default: 15 + Rank of the output gray value. Default: 5 + Filtered image. + + + + Compute a rank filter with arbitrary masks. + Instance represents: Image to be filtered. + + Filter mask. + Rank of the output gray value. Default: 5 + Border treatment. Default: "mirrored" + Filtered image. + + + + Compute a rank filter with arbitrary masks. + Instance represents: Image to be filtered. + + Filter mask. + Rank of the output gray value. Default: 5 + Border treatment. Default: "mirrored" + Filtered image. + + + + Opening, Median and Closing with circle or rectangle mask. + Instance represents: Image to be filtered. + + Shape of the mask. Default: "circle" + Radius of the filter mask. Default: 1 + Filter Mode: 0 corresponds to a gray value opening , 50 corresponds to a median and 100 to a gray values closing. Default: 10 + Border treatment. Default: "mirrored" + Filtered Image. + + + + Opening, Median and Closing with circle or rectangle mask. + Instance represents: Image to be filtered. + + Shape of the mask. Default: "circle" + Radius of the filter mask. Default: 1 + Filter Mode: 0 corresponds to a gray value opening , 50 corresponds to a median and 100 to a gray values closing. Default: 10 + Border treatment. Default: "mirrored" + Filtered Image. + + + + Smooth by averaging. + Instance represents: Image to be smoothed. + + Width of filter mask. Default: 9 + Height of filter mask. Default: 9 + Smoothed image. + + + + Smooth an image using the binomial filter. + Instance represents: Input image. + + Filter width. Default: 5 + Filter height. Default: 5 + Smoothed image. + + + + Smooth an image using discrete Gaussian functions. + Instance represents: Image to be smoothed. + + Required filter size. Default: 5 + Filtered image. + + + + Smooth using discrete gauss functions. + Instance represents: Image to be smoothed. + + Required filter size. Default: 5 + Filtered image. + + + + Smooth an image in the spatial domain to suppress noise. + Instance represents: Image to smooth. + + Width of filter mask. Default: 3 + Height of filter mask. Default: 3 + Gap between local maximum/minimum and all other gray values of the neighborhood. Default: 1.0 + Replacement rule (1 = next minimum/maximum, 2 = average, 3 =median). Default: 3 + Smoothed image. + + + + Interpolate 2 video half images. + Instance represents: Gray image consisting of two half images. + + Instruction whether even or odd lines should be replaced/removed. Default: "odd" + Full image with interpolated/removed lines. + + + + Return gray values with given rank from multiple channels. + Instance represents: Multichannel gray image. + + Rank of the gray value images to return. Default: 2 + Result of the rank function. + + + + Average gray values over several channels. + Instance represents: Multichannel gray image. + + Result of averaging. + + + + Replace values outside of thresholds with average value. + Instance represents: Input image. + + Width of filter mask. Default: 3 + Height of filter mask. Default: 3 + Minimum gray value. Default: 1 + Maximum gray value. Default: 254 + Smoothed image. + + + + Suppress salt and pepper noise. + Instance represents: Input image. + + Width of filter mask. Default: 3 + Height of filter mask. Default: 3 + Minimum gray value. Default: 1 + Maximum gray value. Default: 254 + Smoothed image. + + + + Find corners using the Sojka operator. + Instance represents: Input image. + + Required filter size. Default: 9 + Sigma of the weight function according to the distance to the corner candidate. Default: 2.5 + Sigma of the weight function for the distance to the ideal gray value edge. Default: 0.75 + Threshold for the magnitude of the gradient. Default: 30.0 + Threshold for Apparentness. Default: 90.0 + Threshold for the direction change in a corner point (radians). Default: 0.5 + Subpixel precise calculation of the corner points. Default: "false" + Row coordinates of the detected corner points. + Column coordinates of the detected corner points. + + + + Find corners using the Sojka operator. + Instance represents: Input image. + + Required filter size. Default: 9 + Sigma of the weight function according to the distance to the corner candidate. Default: 2.5 + Sigma of the weight function for the distance to the ideal gray value edge. Default: 0.75 + Threshold for the magnitude of the gradient. Default: 30.0 + Threshold for Apparentness. Default: 90.0 + Threshold for the direction change in a corner point (radians). Default: 0.5 + Subpixel precise calculation of the corner points. Default: "false" + Row coordinates of the detected corner points. + Column coordinates of the detected corner points. + + + + Enhance circular dots in an image. + Instance represents: Input image. + + Diameter of the dots to be enhanced. Default: 5 + Enhance dark, light, or all dots. Default: "light" + Shift of the filter response. Default: 0 + Output image. + + + + Subpixel precise detection of local minima in an image. + Instance represents: Input image. + + Method for the calculation of the partial derivatives. Default: "facet" + Sigma of the Gaussian. If Filter is 'facet', Sigma may be 0.0 to avoid the smoothing of the input image. + Minimum absolute value of the eigenvalues of the Hessian matrix. Default: 5.0 + Row coordinates of the detected minima. + Column coordinates of the detected minima. + + + + Subpixel precise detection of local maxima in an image. + Instance represents: Input image. + + Method for the calculation of the partial derivatives. Default: "facet" + Sigma of the Gaussian. If Filter is 'facet', Sigma may be 0.0 to avoid the smoothing of the input image. + Minimum absolute value of the eigenvalues of the Hessian matrix. Default: 5.0 + Row coordinates of the detected maxima. + Column coordinates of the detected maxima. + + + + Subpixel precise detection of saddle points in an image. + Instance represents: Input image. + + Method for the calculation of the partial derivatives. Default: "facet" + Sigma of the Gaussian. If Filter is 'facet', Sigma may be 0.0 to avoid the smoothing of the input image. + Minimum absolute value of the eigenvalues of the Hessian matrix. Default: 5.0 + Row coordinates of the detected saddle points. + Column coordinates of the detected saddle points. + + + + Subpixel precise detection of critical points in an image. + Instance represents: Input image. + + Method for the calculation of the partial derivatives. Default: "facet" + Sigma of the Gaussian. If Filter is 'facet', Sigma may be 0.0 to avoid the smoothing of the input image. + Minimum absolute value of the eigenvalues of the Hessian matrix. Default: 5.0 + Row coordinates of the detected minima. + Column coordinates of the detected minima. + Row coordinates of the detected maxima. + Column coordinates of the detected maxima. + Row coordinates of the detected saddle points. + Column coordinates of the detected saddle points. + + + + Detect points of interest using the Harris operator. + Instance represents: Input image. + + Amount of smoothing used for the calculation of the gradient. Default: 0.7 + Amount of smoothing used for the integration of the gradients. Default: 2.0 + Weight of the squared trace of the squared gradient matrix. Default: 0.08 + Minimum filter response for the points. Default: 1000.0 + Row coordinates of the detected points. + Column coordinates of the detected points. + + + + Detect points of interest using the Harris operator. + Instance represents: Input image. + + Amount of smoothing used for the calculation of the gradient. Default: 0.7 + Amount of smoothing used for the integration of the gradients. Default: 2.0 + Weight of the squared trace of the squared gradient matrix. Default: 0.08 + Minimum filter response for the points. Default: 1000.0 + Row coordinates of the detected points. + Column coordinates of the detected points. + + + + Detect points of interest using the binomial approximation of the Harris operator. + Instance represents: Input image. + + Amount of binomial smoothing used for the calculation of the gradient. Default: 5 + Amount of smoothing used for the integration of the gradients. Default: 15 + Weight of the squared trace of the squared gradient matrix. Default: 0.08 + Minimum filter response for the points. Default: 1000.0 + Turn on or off subpixel refinement. Default: "on" + Row coordinates of the detected points. + Column coordinates of the detected points. + + + + Detect points of interest using the binomial approximation of the Harris operator. + Instance represents: Input image. + + Amount of binomial smoothing used for the calculation of the gradient. Default: 5 + Amount of smoothing used for the integration of the gradients. Default: 15 + Weight of the squared trace of the squared gradient matrix. Default: 0.08 + Minimum filter response for the points. Default: 1000.0 + Turn on or off subpixel refinement. Default: "on" + Row coordinates of the detected points. + Column coordinates of the detected points. + + + + Detect points of interest using the Lepetit operator. + Instance represents: Input image. + + Radius of the circle. Default: 3 + Number of checked neighbors on the circle. Default: 1 + Threshold of grayvalue difference to each circle point. Default: 15 + Threshold of grayvalue difference to all circle points. Default: 30 + Subpixel accuracy of point coordinates. Default: "interpolation" + Row-coordinates of the detected points. + Column-coordinates of the detected points. + + + + Detect points of interest using the Foerstner operator. + Instance represents: Input image. + + Amount of smoothing used for the calculation of the gradient. If Smoothing is 'mean', SigmaGrad is ignored. Default: 1.0 + Amount of smoothing used for the integration of the gradients. Default: 2.0 + Amount of smoothing used in the optimization functions. Default: 3.0 + Threshold for the segmentation of inhomogeneous image areas. Default: 200 + Threshold for the segmentation of point areas. Default: 0.3 + Used smoothing method. Default: "gauss" + Elimination of multiply detected points. Default: "false" + Row coordinates of the detected junction points. + Column coordinates of the detected junction points. + Row part of the covariance matrix of the detected junction points. + Mixed part of the covariance matrix of the detected junction points. + Column part of the covariance matrix of the detected junction points. + Row coordinates of the detected area points. + Column coordinates of the detected area points. + Row part of the covariance matrix of the detected area points. + Mixed part of the covariance matrix of the detected area points. + Column part of the covariance matrix of the detected area points. + + + + Detect points of interest using the Foerstner operator. + Instance represents: Input image. + + Amount of smoothing used for the calculation of the gradient. If Smoothing is 'mean', SigmaGrad is ignored. Default: 1.0 + Amount of smoothing used for the integration of the gradients. Default: 2.0 + Amount of smoothing used in the optimization functions. Default: 3.0 + Threshold for the segmentation of inhomogeneous image areas. Default: 200 + Threshold for the segmentation of point areas. Default: 0.3 + Used smoothing method. Default: "gauss" + Elimination of multiply detected points. Default: "false" + Row coordinates of the detected junction points. + Column coordinates of the detected junction points. + Row part of the covariance matrix of the detected junction points. + Mixed part of the covariance matrix of the detected junction points. + Column part of the covariance matrix of the detected junction points. + Row coordinates of the detected area points. + Column coordinates of the detected area points. + Row part of the covariance matrix of the detected area points. + Mixed part of the covariance matrix of the detected area points. + Column part of the covariance matrix of the detected area points. + + + + Estimate the image noise from a single image. + Instance represents: Input image. + + Method to estimate the image noise. Default: "foerstner" + Percentage of used image points. Default: 20 + Standard deviation of the image noise. + + + + Estimate the image noise from a single image. + Instance represents: Input image. + + Method to estimate the image noise. Default: "foerstner" + Percentage of used image points. Default: 20 + Standard deviation of the image noise. + + + + Determine the noise distribution of an image. + Instance represents: Corresponding image. + + Region from which the noise distribution is to be estimated. + Size of the mean filter. Default: 21 + Noise distribution of all input regions. + + + + Add noise to an image. + Instance represents: Input image. + + Maximum noise amplitude. Default: 60.0 + Noisy image. + + + + Add noise to an image. + Instance represents: Input image. + + Noise distribution. + Noisy image. + + + + Calculate standard deviation over several channels. + Instance represents: Multichannel gray image. + + Result of calculation. + + + + Perform an inpainting by texture propagation. + Instance represents: Input image. + + Inpainting region. + Size of the inpainting blocks. Default: 9 + Size of the search window. Default: 30 + Influence of the edge amplitude on the inpainting order. Default: 1.0 + Post-iteration for artifact reduction. Default: "none" + Gray value tolerance for post-iteration. Default: 1.0 + Output image. + + + + Perform an inpainting by coherence transport. + Instance represents: Input image. + + Inpainting region. + Radius of the pixel neighborhood. Default: 5.0 + Sharpness parameter in percent. Default: 25.0 + Pre-smoothing parameter. Default: 1.41 + Smoothing parameter for the direction estimation. Default: 4.0 + Channel weights. Default: 1 + Output image. + + + + Perform an inpainting by coherence transport. + Instance represents: Input image. + + Inpainting region. + Radius of the pixel neighborhood. Default: 5.0 + Sharpness parameter in percent. Default: 25.0 + Pre-smoothing parameter. Default: 1.41 + Smoothing parameter for the direction estimation. Default: 4.0 + Channel weights. Default: 1 + Output image. + + + + Perform an inpainting by smoothing of level lines. + Instance represents: Input image. + + Inpainting region. + Smoothing for derivative operator. Default: 0.5 + Time step. Default: 0.5 + Number of iterations. Default: 10 + Output image. + + + + Perform an inpainting by coherence enhancing diffusion. + Instance represents: Input image. + + Inpainting region. + Smoothing for derivative operator. Default: 0.5 + Smoothing for diffusion coefficients. Default: 3.0 + Time step. Default: 0.5 + Number of iterations. Default: 10 + Output image. + + + + Perform an inpainting by anisotropic diffusion. + Instance represents: Input image. + + Inpainting region. + Type of edge sharpening algorithm. Default: "weickert" + Contrast parameter. Default: 5.0 + Step size. Default: 0.5 + Number of iterations. Default: 10 + Smoothing coefficient for edge information. Default: 3.0 + Output image. + + + + Perform a harmonic interpolation on an image region. + Instance represents: Input image. + + Inpainting region. + Computational accuracy. Default: 0.001 + Output image. + + + + Expand the domain of an image and set the gray values in the expanded domain. + Instance represents: Input image with domain to be expanded. + + Radius of the gray value expansion, measured in pixels. Default: 2 + Output image with new gray values in the expanded domain. + + + + Compute the topographic primal sketch of an image. + Instance represents: Image for which the topographic primal sketch is to be computed. + + Label image containing the 11 classes. + + + + Compute an affine transformation of the color values of a multichannel image. + Instance represents: Multichannel input image. + + Transformation matrix for the color values. + Multichannel output image. + + + + Compute the transformation matrix of the principal component analysis of multichannel images. + Instance represents: Multichannel input image. + + Transformation matrix for the computation of the inverse PCA. + Mean gray value of the channels. + Covariance matrix of the channels. + Information content of the transformed channels. + Transformation matrix for the computation of the PCA. + + + + Compute the principal components of multichannel images. + Instance represents: Multichannel input image. + + Information content of each output channel. + Multichannel output image. + + + + Determine the fuzzy entropy of regions. + Instance represents: Input image containing the fuzzy membership values. + + Regions for which the fuzzy entropy is to be calculated. + Start of the fuzzy function. Default: 0 + End of the fuzzy function. Default: 255 + Fuzzy entropy of a region. + + + + Calculate the fuzzy perimeter of a region. + Instance represents: Input image containing the fuzzy membership values. + + Regions for which the fuzzy perimeter is to be calculated. + Start of the fuzzy function. Default: 0 + End of the fuzzy function. Default: 255 + Fuzzy perimeter of a region. + + + + Perform a gray value closing with a selected mask. + Instance represents: Image for which the minimum gray values are to be calculated. + + Height of the filter mask. Default: 11 + Width of the filter mask. Default: 11 + Shape of the mask. Default: "octagon" + Image containing the minimum gray values. + + + + Perform a gray value closing with a selected mask. + Instance represents: Image for which the minimum gray values are to be calculated. + + Height of the filter mask. Default: 11 + Width of the filter mask. Default: 11 + Shape of the mask. Default: "octagon" + Image containing the minimum gray values. + + + + Perform a gray value opening with a selected mask. + Instance represents: Image for which the minimum gray values are to be calculated. + + Height of the filter mask. Default: 11 + Width of the filter mask. Default: 11 + Shape of the mask. Default: "octagon" + Image containing the minimum gray values. + + + + Perform a gray value opening with a selected mask. + Instance represents: Image for which the minimum gray values are to be calculated. + + Height of the filter mask. Default: 11 + Width of the filter mask. Default: 11 + Shape of the mask. Default: "octagon" + Image containing the minimum gray values. + + + + Determine the minimum gray value within a selected mask. + Instance represents: Image for which the minimum gray values are to be calculated. + + Height of the filter mask. Default: 11 + Width of the filter mask. Default: 11 + Shape of the mask. Default: "octagon" + Image containing the minimum gray values. + + + + Determine the minimum gray value within a selected mask. + Instance represents: Image for which the minimum gray values are to be calculated. + + Height of the filter mask. Default: 11 + Width of the filter mask. Default: 11 + Shape of the mask. Default: "octagon" + Image containing the minimum gray values. + + + + Determine the maximum gray value within a selected mask. + Instance represents: Image for which the maximum gray values are to be calculated. + + Height of the filter mask. Default: 11 + Width of the filter mask. Default: 11 + Shape of the mask. Default: "octagon" + Image containing the maximum gray values. + + + + Determine the maximum gray value within a selected mask. + Instance represents: Image for which the maximum gray values are to be calculated. + + Height of the filter mask. Default: 11 + Width of the filter mask. Default: 11 + Shape of the mask. Default: "octagon" + Image containing the maximum gray values. + + + + Determine the gray value range within a rectangle. + Instance represents: Image for which the gray value range is to be calculated. + + Height of the filter mask. Default: 11 + Width of the filter mask. Default: 11 + Image containing the gray value range. + + + + Perform a gray value closing with a rectangular mask. + Instance represents: Input image. + + Height of the filter mask. Default: 11 + Width of the filter mask. Default: 11 + Gray-closed image. + + + + Perform a gray value opening with a rectangular mask. + Instance represents: Input image. + + Height of the filter mask. Default: 11 + Width of the filter mask. Default: 11 + Gray-opened image. + + + + Determine the minimum gray value within a rectangle. + Instance represents: Image for which the minimum gray values are to be calculated. + + Height of the filter mask. Default: 11 + Width of the filter mask. Default: 11 + Image containing the minimum gray values. + + + + Determine the maximum gray value within a rectangle. + Instance represents: Image for which the maximum gray values are to be calculated. + + Height of the filter mask. Default: 11 + Width of the filter mask. Default: 11 + Image containing the maximum gray values. + + + + Thinning of gray value images. + Instance represents: Image to be thinned. + + Thinned image. + + + + Transform an image with a gray-value look-up-table + Instance represents: Image whose gray values are to be transformed. + + Table containing the transformation. + Transformed image. + + + + Calculate the correlation between an image and an arbitrary filter mask + Instance represents: Images for which the correlation will be calculated. + + Filter mask as file name or tuple. Default: "sobel" + Border treatment. Default: "mirrored" + Result of the correlation. + + + + Calculate the correlation between an image and an arbitrary filter mask + Instance represents: Images for which the correlation will be calculated. + + Filter mask as file name or tuple. Default: "sobel" + Border treatment. Default: "mirrored" + Result of the correlation. + + + + Convert the type of an image. + Instance represents: Image whose image type is to be changed. + + Desired image type (i.e., type of the gray values). Default: "byte" + Converted image. + + + + Convert two real-valued images into a vector field image. + Instance represents: Vector component in the row direction. + + Vector component in the column direction. + Semantic kind of the vector field. Default: "vector_field_relative" + Displacement vector field. + + + + Convert a vector field image into two real-valued images. + Instance represents: Vector field. + + Vector component in the column direction. + Vector component in the row direction. + + + + Convert two real images into a complex image. + Instance represents: Real part. + + Imaginary part. + Complex image. + + + + Convert a complex image into two real images. + Instance represents: Complex image. + + Imaginary part. + Real part. + + + + Paint regions with their average gray value. + Instance represents: original gray-value image. + + Input regions. + Result image with painted regions. + + + + Calculate the lowest possible gray value on an arbitrary path to the image border for each point in the image. + Instance represents: Image being processed. + + Result image. + + + + Symmetry of gray values along a row. + Instance represents: Input image. + + Extension of search area. Default: 40 + Angle of test direction. Default: 0.0 + Exponent for weighting. Default: 0.5 + Symmetry image. + + + + Selection of gray values of a multi-channel image using an index image. + Instance represents: Multi-channel gray value image. + + Image, where pixel values are interpreted as channel index. + Resulting image. + + + + Extract depth using multiple focus levels. + Instance represents: Multichannel gray image consisting of multiple focus levels. + + Confidence of depth estimation. + Filter used to find sharp pixels. Default: "highpass" + Method used to find sharp pixels. Default: "next_maximum" + Depth image. + + + + Extract depth using multiple focus levels. + Instance represents: Multichannel gray image consisting of multiple focus levels. + + Confidence of depth estimation. + Filter used to find sharp pixels. Default: "highpass" + Method used to find sharp pixels. Default: "next_maximum" + Depth image. + + + + Compute the uncalibrated scene flow between two stereo image pairs. + Instance represents: Input image 1 at time @f$t_{1}$t_1. + + Input image 2 at time @f$t_{1}$t_1. + Input image 1 at time @f$t_{2}$t_2. + Input image 2 at time @f$t_{2}$t_2. + Disparity between input images 1 and 2 at time @f$t_{1}$t_1. + Estimated change in disparity. + Weight of the regularization term relative to the data term (derivatives of the optical flow). Default: 40.0 + Weight of the regularization term relative to the data term (derivatives of the disparity change). Default: 40.0 + Parameter name(s) for the algorithm. Default: "default_parameters" + Parameter value(s) for the algorithm. Default: "accurate" + Estimated optical flow. + + + + Compute the uncalibrated scene flow between two stereo image pairs. + Instance represents: Input image 1 at time @f$t_{1}$t_1. + + Input image 2 at time @f$t_{1}$t_1. + Input image 1 at time @f$t_{2}$t_2. + Input image 2 at time @f$t_{2}$t_2. + Disparity between input images 1 and 2 at time @f$t_{1}$t_1. + Estimated change in disparity. + Weight of the regularization term relative to the data term (derivatives of the optical flow). Default: 40.0 + Weight of the regularization term relative to the data term (derivatives of the disparity change). Default: 40.0 + Parameter name(s) for the algorithm. Default: "default_parameters" + Parameter value(s) for the algorithm. Default: "accurate" + Estimated optical flow. + + + + Unwarp an image using a vector field. + Instance represents: Input image. + + Input vector field. + Unwarped image. + + + + Convolve a vector field with derivatives of the Gaussian. + Instance represents: Input vector field. + + Sigma of the Gaussian. Default: 1.0 + Component to be calculated. Default: "mean_curvature" + Filtered result images. + + + + Convolve a vector field with derivatives of the Gaussian. + Instance represents: Input vector field. + + Sigma of the Gaussian. Default: 1.0 + Component to be calculated. Default: "mean_curvature" + Filtered result images. + + + + Compute the length of the vectors of a vector field. + Instance represents: Input vector field + + Mode for computing the length of the vectors. Default: "length" + Length of the vectors of the vector field. + + + + Compute the optical flow between two images. + Instance represents: Input image 1. + + Input image 2. + Algorithm for computing the optical flow. Default: "fdrig" + Standard deviation for initial Gaussian smoothing. Default: 0.8 + Standard deviation of the integration filter. Default: 1.0 + Weight of the smoothing term relative to the data term. Default: 20.0 + Weight of the gradient constancy relative to the gray value constancy. Default: 5.0 + Parameter name(s) for the multigrid algorithm. Default: "default_parameters" + Parameter value(s) for the multigrid algorithm. Default: "accurate" + Optical flow. + + + + Compute the optical flow between two images. + Instance represents: Input image 1. + + Input image 2. + Algorithm for computing the optical flow. Default: "fdrig" + Standard deviation for initial Gaussian smoothing. Default: 0.8 + Standard deviation of the integration filter. Default: 1.0 + Weight of the smoothing term relative to the data term. Default: 20.0 + Weight of the gradient constancy relative to the gray value constancy. Default: 5.0 + Parameter name(s) for the multigrid algorithm. Default: "default_parameters" + Parameter value(s) for the multigrid algorithm. Default: "accurate" + Optical flow. + + + + Matching a template and an image in a resolution pyramid. + Instance represents: Input image. + + The domain of this image will be matched with Image. + Desired matching criterion. Default: "dfd" + Startlevel in the resolution pyramid (highest resolution: Level 0). Default: 1 + Threshold to determine the "region of interest". Default: 30 + Result image and result region: values of the matching criterion within the determined "region of interest". + + + + Preparing a pattern for template matching with rotation. + Instance represents: Input image whose domain will be processed for the pattern matching. + + Maximal number of pyramid levels. Default: 4 + Smallest Rotation of the pattern. Default: -0.39 + Maximum positive Extension of AngleStart. Default: 0.79 + Step rate (angle precision) of matching. Default: 0.0982 + Kind of optimizing. Default: "sort" + Kind of grayvalues. Default: "original" + Template number. + + + + Preparing a pattern for template matching. + Instance represents: Input image whose domain will be processed for the pattern matching. + + Not yet in use. Default: 255 + Maximal number of pyramid levels. Default: 4 + Kind of optimizing. Default: "sort" + Kind of grayvalues. Default: "original" + Template number. + + + + Adapting a template to the size of an image. + Instance represents: Image which determines the size of the later matching. + + Template number. + + + + Searching all good gray value matches in a pyramid. + Instance represents: Input image inside of which the pattern has to be found. + + Template number. + Maximal average difference of the grayvalues. Default: 30.0 + Number of levels in the pyramid. Default: 3 + All points which have an error below a certain threshold. + + + + Searching all good gray value matches in a pyramid. + Instance represents: Input image inside of which the pattern has to be found. + + Template number. + Maximal average difference of the grayvalues. Default: 30.0 + Number of levels in the pyramid. Default: 3 + All points which have an error below a certain threshold. + + + + Searching the best gray value matches in a pre generated pyramid. + Instance represents: Image pyramid inside of which the pattern has to be found. + + Template number. + Maximal average difference of the grayvalues. Default: 30.0 + Exactness in subpixels in case of 'true'. Default: "false" + Number of the used resolution levels. Default: 3 + Resolution level up to which the method "best match" is used. Default: "original" + Row position of the best match. + Column position of the best match. + Average divergence of the grayvalues in the best match. + + + + Searching the best gray value matches in a pre generated pyramid. + Instance represents: Image pyramid inside of which the pattern has to be found. + + Template number. + Maximal average difference of the grayvalues. Default: 30.0 + Exactness in subpixels in case of 'true'. Default: "false" + Number of the used resolution levels. Default: 3 + Resolution level up to which the method "best match" is used. Default: "original" + Row position of the best match. + Column position of the best match. + Average divergence of the grayvalues in the best match. + + + + Searching the best gray value matches in a pyramid. + Instance represents: Input image inside of which the pattern has to be found. + + Template number. + Maximal average difference of the grayvalues. Default: 30.0 + Exactness in subpixels in case of 'true'. Default: "false" + Number of the used resolution levels. Default: 4 + Resolution level up to which the method "best match" is used. Default: 2 + Row position of the best match. + Column position of the best match. + Average divergence of the grayvalues in the best match. + + + + Searching the best gray value matches in a pyramid. + Instance represents: Input image inside of which the pattern has to be found. + + Template number. + Maximal average difference of the grayvalues. Default: 30.0 + Exactness in subpixels in case of 'true'. Default: "false" + Number of the used resolution levels. Default: 4 + Resolution level up to which the method "best match" is used. Default: 2 + Row position of the best match. + Column position of the best match. + Average divergence of the grayvalues in the best match. + + + + Searching all good matches of a template and an image. + Instance represents: Input image inside of which the pattern has to be found. + + Template number. + Maximal average difference of the grayvalues. Default: 20.0 + All points whose error lies below a certain threshold. + + + + Searching the best matching of a template and a pyramid with rotation. + Instance represents: Input image inside of which the pattern has to be found. + + Template number. + Smallest Rotation of the pattern. Default: -0.39 + Maximum positive Extension of AngleStart. Default: 0.79 + Maximum average difference of the grayvalues. Default: 40.0 + Subpixel accuracy in case of 'true'. Default: "false" + Number of the used resolution levels. Default: 3 + Row position of the best match. + Column position of the best match. + Rotation angle of pattern. + Average divergence of the grayvalues of the best match. + + + + Searching the best matching of a template and a pyramid with rotation. + Instance represents: Input image inside of which the pattern has to be found. + + Template number. + Smallest Rotation of the pattern. Default: -0.39 + Maximum positive Extension of AngleStart. Default: 0.79 + Maximum average difference of the grayvalues. Default: 40.0 + Subpixel accuracy in case of 'true'. Default: "false" + Number of the used resolution levels. Default: 3 + Row position of the best match. + Column position of the best match. + Rotation angle of pattern. + Average divergence of the grayvalues of the best match. + + + + Searching the best matching of a template and an image with rotation. + Instance represents: Input image inside of which the pattern has to be found. + + Template number. + Smallest Rotation of the pattern. Default: -0.39 + Maximum positive Extension of AngleStart. Default: 0.79 + Maximum average difference of the grayvalues. Default: 30.0 + Subpixel accuracy in case of 'true'. Default: "false" + Row position of the best match. + Column position of the best match. + Rotation angle of pattern. + Average divergence of the grayvalues of the best match. + + + + Searching the best matching of a template and an image with rotation. + Instance represents: Input image inside of which the pattern has to be found. + + Template number. + Smallest Rotation of the pattern. Default: -0.39 + Maximum positive Extension of AngleStart. Default: 0.79 + Maximum average difference of the grayvalues. Default: 30.0 + Subpixel accuracy in case of 'true'. Default: "false" + Row position of the best match. + Column position of the best match. + Rotation angle of pattern. + Average divergence of the grayvalues of the best match. + + + + Searching the best matching of a template and an image. + Instance represents: Input image inside of which the pattern has to be found. + + Template number. + Maximum average difference of the grayvalues. Default: 20.0 + Subpixel accuracy in case of 'true'. Default: "false" + Row position of the best match. + Column position of the best match. + Average divergence of the grayvalues of the best match. + + + + Searching the best matching of a template and an image. + Instance represents: Input image inside of which the pattern has to be found. + + Template number. + Maximum average difference of the grayvalues. Default: 20.0 + Subpixel accuracy in case of 'true'. Default: "false" + Row position of the best match. + Column position of the best match. + Average divergence of the grayvalues of the best match. + + + + Matching of a template and an image. + Instance represents: Input image. + + Area to be searched in the input image. + This area will be "matched" by Image within the RegionOfInterest. + Desired matching criterion. Default: "dfd" + Result image: values of the matching criterion. + + + + Searching corners in images. + Instance represents: Input image. + + Desired filtersize of the graymask. Default: 3 + Weighting. Default: 0.04 + Result of the filtering. + + + + Calculating a Gauss pyramid. + Instance represents: Input image. + + Kind of filtermask. Default: "weighted" + Factor for scaling down. Default: 0.5 + Output images. + + + + Calculating the monotony operation. + Instance represents: Input image. + + Result of the monotony operator. + + + + Edge extraction using bandpass filters. + Instance represents: Input images. + + Filter type: currently only 'lines' is supported. Default: "lines" + Bandpass-filtered images. + + + + Detect color lines and their width. + Instance represents: Input image. + + Amount of Gaussian smoothing to be applied. Default: 1.5 + Lower threshold for the hysteresis threshold operation. Default: 3 + Upper threshold for the hysteresis threshold operation. Default: 8 + Should the line width be extracted? Default: "true" + Should junctions be added where they cannot be extracted? Default: "true" + Extracted lines. + + + + Detect color lines and their width. + Instance represents: Input image. + + Amount of Gaussian smoothing to be applied. Default: 1.5 + Lower threshold for the hysteresis threshold operation. Default: 3 + Upper threshold for the hysteresis threshold operation. Default: 8 + Should the line width be extracted? Default: "true" + Should junctions be added where they cannot be extracted? Default: "true" + Extracted lines. + + + + Detect lines and their width. + Instance represents: Input image. + + Amount of Gaussian smoothing to be applied. Default: 1.5 + Lower threshold for the hysteresis threshold operation. Default: 3 + Upper threshold for the hysteresis threshold operation. Default: 8 + Extract bright or dark lines. Default: "light" + Should the line width be extracted? Default: "true" + Line model used to correct the line position and width. Default: "bar-shaped" + Should junctions be added where they cannot be extracted? Default: "true" + Extracted lines. + + + + Detect lines and their width. + Instance represents: Input image. + + Amount of Gaussian smoothing to be applied. Default: 1.5 + Lower threshold for the hysteresis threshold operation. Default: 3 + Upper threshold for the hysteresis threshold operation. Default: 8 + Extract bright or dark lines. Default: "light" + Should the line width be extracted? Default: "true" + Line model used to correct the line position and width. Default: "bar-shaped" + Should junctions be added where they cannot be extracted? Default: "true" + Extracted lines. + + + + Detection of lines using the facet model. + Instance represents: Input image. + + Size of the facet model mask. Default: 5 + Lower threshold for the hysteresis threshold operation. Default: 3 + Upper threshold for the hysteresis threshold operation. Default: 8 + Extract bright or dark lines. Default: "light" + Extracted lines. + + + + Detection of lines using the facet model. + Instance represents: Input image. + + Size of the facet model mask. Default: 5 + Lower threshold for the hysteresis threshold operation. Default: 3 + Upper threshold for the hysteresis threshold operation. Default: 8 + Extract bright or dark lines. Default: "light" + Extracted lines. + + + + Store a filter mask in the spatial domain as a real-image. + Modified instance represents: Filter in the spatial domain. + + Filter mask as file name or tuple. Default: "gauss" + Scaling factor. Default: 1.0 + Width of the image (filter). Default: 512 + Height of the image (filter). Default: 512 + + + + Store a filter mask in the spatial domain as a real-image. + Modified instance represents: Filter in the spatial domain. + + Filter mask as file name or tuple. Default: "gauss" + Scaling factor. Default: 1.0 + Width of the image (filter). Default: 512 + Height of the image (filter). Default: 512 + + + + Generate a mean filter in the frequency domain. + Modified instance represents: Mean filter as image in the frequency domain. + + Shape of the filter mask in the spatial domain. Default: "ellipse" + Diameter of the mean filter in the principal direction of the filter in the spatial domain. Default: 11.0 + Diameter of the mean filter perpendicular to the principal direction of the filter in the spatial domain. Default: 11.0 + Principal direction of the filter in the spatial domain. Default: 0.0 + Normalizing factor of the filter. Default: "none" + Location of the DC term in the frequency domain. Default: "dc_center" + Width of the image (filter). Default: 512 + Height of the image (filter). Default: 512 + + + + Generate a Gaussian filter in the frequency domain. + Modified instance represents: Gaussian filter as image in the frequency domain. + + Standard deviation of the Gaussian in the principal direction of the filter in the spatial domain. Default: 1.0 + Standard deviation of the Gaussian perpendicular to the principal direction of the filter in the spatial domain. Default: 1.0 + Principal direction of the filter in the spatial domain. Default: 0.0 + Normalizing factor of the filter. Default: "none" + Location of the DC term in the frequency domain. Default: "dc_center" + Width of the image (filter). Default: 512 + Height of the image (filter). Default: 512 + + + + Generate a derivative filter in the frequency domain. + Modified instance represents: Derivative filter as image in the frequency domain. + + Derivative to be computed. Default: "x" + Exponent used in the reverse transform. Default: 1 + Normalizing factor of the filter. Default: "none" + Location of the DC term in the frequency domain. Default: "dc_center" + Width of the image (filter). Default: 512 + Height of the image (filter). Default: 512 + + + + Generate a bandpass filter with Gaussian or sinusoidal shape. + Modified instance represents: Bandpass filter as image in the frequency domain. + + Distance of the filter's maximum from the DC term. Default: 0.1 + Bandwidth of the filter (standard deviation). Default: 0.01 + Filter type. Default: "sin" + Normalizing factor of the filter. Default: "none" + Location of the DC term in the frequency domain. Default: "dc_center" + Width of the image (filter). Default: 512 + Height of the image (filter). Default: 512 + + + + Generate a bandpass filter with sinusoidal shape. + Modified instance represents: Bandpass filter as image in the frequency domain. + + Distance of the filter's maximum from the DC term. Default: 0.1 + Normalizing factor of the filter. Default: "none" + Location of the DC term in the frequency domain. Default: "dc_center" + Width of the image (filter). Default: 512 + Height of the image (filter). Default: 512 + + + + Generate an ideal band filter. + Modified instance represents: Band filter in the frequency domain. + + Minimum frequency. Default: 0.1 + Maximum frequency. Default: 0.2 + Normalizing factor of the filter. Default: "none" + Location of the DC term in the frequency domain. Default: "dc_center" + Width of the image (filter). Default: 512 + Height of the image (filter). Default: 512 + + + + Generate an ideal bandpass filter. + Modified instance represents: Bandpass filter in the frequency domain. + + Minimum frequency. Default: 0.1 + Maximum frequency. Default: 0.2 + Normalizing factor of the filter. Default: "none" + Location of the DC term in the frequency domain. Default: "dc_center" + Width of the image (filter). Default: 512 + Height of the image (filter). Default: 512 + + + + Generate an ideal lowpass filter. + Modified instance represents: Lowpass filter in the frequency domain. + + Cutoff frequency. Default: 0.1 + Normalizing factor of the filter. Default: "none" + Location of the DC term in the frequency domain. Default: "dc_center" + Width of the image (filter). Default: 512 + Height of the image (filter). Default: 512 + + + + Generate an ideal highpass filter. + Modified instance represents: Highpass filter in the frequency domain. + + Cutoff frequency. Default: 0.1 + Normalizing factor of the filter. Default: "none" + Location of the DC term in the frequency domain. Default: "dc_center" + Width of the image (filter). Default: 512 + Height of the image (filter). Default: 512 + + + + Return the power spectrum of a complex image. + Instance represents: Input image in frequency domain. + + Power spectrum of the input image. + + + + Return the power spectrum of a complex image. + Instance represents: Input image in frequency domain. + + Power spectrum of the input image. + + + + Return the power spectrum of a complex image. + Instance represents: Input image in frequency domain. + + Power spectrum of the input image. + + + + Return the phase of a complex image in degrees. + Instance represents: Input image in frequency domain. + + Phase of the image in degrees. + + + + Return the phase of a complex image in radians. + Instance represents: Input image in frequency domain. + + Phase of the image in radians. + + + + Calculate the energy of a two-channel image. + Instance represents: 1st channel of input image (usually: Gabor image). + + 2nd channel of input image (usually: Hilbert image). + Image containing the local energy. + + + + Convolve an image with a Gabor filter in the frequency domain. + Instance represents: Input image. + + Gabor/Hilbert-Filter. + Result of the Hilbert filter. + Result of the Gabor filter. + + + + Generate a Gabor filter. + Modified instance represents: Gabor and Hilbert filter. + + Angle range, inversely proportional to the range of orientations. Default: 1.4 + Distance of the center of the filter to the DC term. Default: 0.4 + Bandwidth range, inversely proportional to the range of frequencies being passed. Default: 1.0 + Angle of the principal orientation. Default: 1.5 + Normalizing factor of the filter. Default: "none" + Location of the DC term in the frequency domain. Default: "dc_center" + Width of the image (filter). Default: 512 + Height of the image (filter). Default: 512 + + + + Compute the phase correlation of two images in the frequency domain. + Instance represents: Fourier-transformed input image 1. + + Fourier-transformed input image 2. + Phase correlation of the input images in the frequency domain. + + + + Compute the correlation of two images in the frequency domain. + Instance represents: Fourier-transformed input image 1. + + Fourier-transformed input image 2. + Correlation of the input images in the frequency domain. + + + + Convolve an image with a filter in the frequency domain. + Instance represents: Complex input image. + + Filter in frequency domain. + Result of applying the filter. + + + + Compute the real-valued fast Fourier transform of an image. + Instance represents: Input image. + + Calculate forward or reverse transform. Default: "to_freq" + Normalizing factor of the transform. Default: "sqrt" + Image type of the output image. Default: "complex" + Width of the image for which the runtime should be optimized. Default: 512 + Fourier-transformed image. + + + + Compute the inverse fast Fourier transform of an image. + Instance represents: Input image. + + Inverse-Fourier-transformed image. + + + + Compute the fast Fourier transform of an image. + Instance represents: Input image. + + Fourier-transformed image. + + + + Compute the fast Fourier transform of an image. + Instance represents: Input image. + + Calculate forward or reverse transform. Default: "to_freq" + Sign of the exponent. Default: -1 + Normalizing factor of the transform. Default: "sqrt" + Location of the DC term in the frequency domain. Default: "dc_center" + Image type of the output image. Default: "complex" + Fourier-transformed image. + + + + Apply a shock filter to an image. + Instance represents: Input image. + + Time step. Default: 0.5 + Number of iterations. Default: 10 + Type of edge detector. Default: "canny" + Smoothing of edge detector. Default: 1.0 + Output image. + + + + Apply the mean curvature flow to an image. + Instance represents: Input image. + + Smoothing parameter for derivative operator. Default: 0.5 + Time step. Default: 0.5 + Number of iterations. Default: 10 + Output image. + + + + Perform a coherence enhancing diffusion of an image. + Instance represents: Input image. + + Smoothing for derivative operator. Default: 0.5 + Smoothing for diffusion coefficients. Default: 3.0 + Time step. Default: 0.5 + Number of iterations. Default: 10 + Output image. + + + + Histogram linearization of images + Instance represents: Image to be enhanced. + + Image with linearized gray values. + + + + Illuminate image. + Instance represents: Image to be enhanced. + + Width of low pass mask. Default: 101 + Height of low pass mask. Default: 101 + Scales the "`correction gray value"' added to the original gray values. Default: 0.7 + "`Illuminated"' image. + + + + Enhance contrast of the image. + Instance represents: Image to be enhanced. + + Width of low pass mask. Default: 7 + Height of the low pass mask. Default: 7 + Intensity of contrast emphasis. Default: 1.0 + contrast enhanced image. + + + + Maximum gray value spreading in the value range 0 to 255. + Instance represents: Image to be scaled. + + contrast enhanced image. + + + + Detect edges (amplitude and direction) using the Robinson operator. + Instance represents: Input image. + + Edge direction image. + Edge amplitude (gradient magnitude) image. + + + + Detect edges (amplitude) using the Robinson operator. + Instance represents: Input image. + + Edge amplitude (gradient magnitude) image. + + + + Detect edges (amplitude and direction) using the Kirsch operator. + Instance represents: Input image. + + Edge direction image. + Edge amplitude (gradient magnitude) image. + + + + Detect edges (amplitude) using the Kirsch operator. + Instance represents: Input image. + + Edge amplitude (gradient magnitude) image. + + + + Detect edges (amplitude and direction) using the Frei-Chen operator. + Instance represents: Input image. + + Edge direction image. + Edge amplitude (gradient magnitude) image. + + + + Detect edges (amplitude) using the Frei-Chen operator. + Instance represents: Input image. + + Edge amplitude (gradient magnitude) image. + + + + Detect edges (amplitude and direction) using the Prewitt operator. + Instance represents: Input image. + + Edge direction image. + Edge amplitude (gradient magnitude) image. + + + + Detect edges (amplitude) using the Prewitt operator. + Instance represents: Input image. + + Edge amplitude (gradient magnitude) image. + + + + Detect edges (amplitude) using the Sobel operator. + Instance represents: Input image. + + Filter type. Default: "sum_abs" + Size of filter mask. Default: 3 + Edge amplitude (gradient magnitude) image. + + + + Detect edges (amplitude) using the Sobel operator. + Instance represents: Input image. + + Filter type. Default: "sum_abs" + Size of filter mask. Default: 3 + Edge amplitude (gradient magnitude) image. + + + + Detect edges (amplitude and direction) using the Sobel operator. + Instance represents: Input image. + + Edge direction image. + Filter type. Default: "sum_abs" + Size of filter mask. Default: 3 + Edge amplitude (gradient magnitude) image. + + + + Detect edges (amplitude and direction) using the Sobel operator. + Instance represents: Input image. + + Edge direction image. + Filter type. Default: "sum_abs" + Size of filter mask. Default: 3 + Edge amplitude (gradient magnitude) image. + + + + Detect edges using the Roberts filter. + Instance represents: Input image. + + Filter type. Default: "gradient_sum" + Roberts-filtered result images. + + + + Calculate the Laplace operator by using finite differences. + Instance represents: Input image. + + Type of the result image, whereas for byte and uint2 the absolute value is used. Default: "absolute" + Size of filter mask. Default: 3 + Filter mask used in the Laplace operator Default: "n_4" + Laplace-filtered result image. + + + + Calculate the Laplace operator by using finite differences. + Instance represents: Input image. + + Type of the result image, whereas for byte and uint2 the absolute value is used. Default: "absolute" + Size of filter mask. Default: 3 + Filter mask used in the Laplace operator Default: "n_4" + Laplace-filtered result image. + + + + Extract high frequency components from an image. + Instance represents: Input image. + + Width of the filter mask. Default: 9 + Height of the filter mask. Default: 9 + High-pass-filtered result image. + + + + Extract subpixel precise color edges using Deriche, Shen, or Canny filters. + Instance represents: Input image. + + Edge operator to be applied. Default: "canny" + Filter parameter: small values result in strong smoothing, and thus less detail (opposite for 'canny'). Default: 1.0 + Lower threshold for the hysteresis threshold operation. Default: 20 + Upper threshold for the hysteresis threshold operation. Default: 40 + Extracted edges. + + + + Extract subpixel precise color edges using Deriche, Shen, or Canny filters. + Instance represents: Input image. + + Edge operator to be applied. Default: "canny" + Filter parameter: small values result in strong smoothing, and thus less detail (opposite for 'canny'). Default: 1.0 + Lower threshold for the hysteresis threshold operation. Default: 20 + Upper threshold for the hysteresis threshold operation. Default: 40 + Extracted edges. + + + + Extract color edges using Canny, Deriche, or Shen filters. + Instance represents: Input image. + + Edge direction image. + Edge operator to be applied. Default: "canny" + Filter parameter: small values result in strong smoothing, and thus less detail (opposite for 'canny'). Default: 1.0 + Non-maximum suppression ('none', if not desired). Default: "nms" + Lower threshold for the hysteresis threshold operation (negative if no thresholding is desired). Default: 20 + Upper threshold for the hysteresis threshold operation (negative if no thresholding is desired). Default: 40 + Edge amplitude (gradient magnitude) image. + + + + Extract sub-pixel precise edges using Deriche, Lanser, Shen, or Canny filters. + Instance represents: Input image. + + Edge operator to be applied. Default: "canny" + Filter parameter: small values result in strong smoothing, and thus less detail (opposite for 'canny'). Default: 1.0 + Lower threshold for the hysteresis threshold operation. Default: 20 + Upper threshold for the hysteresis threshold operation. Default: 40 + Extracted edges. + + + + Extract sub-pixel precise edges using Deriche, Lanser, Shen, or Canny filters. + Instance represents: Input image. + + Edge operator to be applied. Default: "canny" + Filter parameter: small values result in strong smoothing, and thus less detail (opposite for 'canny'). Default: 1.0 + Lower threshold for the hysteresis threshold operation. Default: 20 + Upper threshold for the hysteresis threshold operation. Default: 40 + Extracted edges. + + + + Extract edges using Deriche, Lanser, Shen, or Canny filters. + Instance represents: Input image. + + Edge direction image. + Edge operator to be applied. Default: "canny" + Filter parameter: small values result in strong smoothing, and thus less detail (opposite for 'canny'). Default: 1.0 + Non-maximum suppression ('none', if not desired). Default: "nms" + Lower threshold for the hysteresis threshold operation (negative, if no thresholding is desired). Default: 20 + Upper threshold for the hysteresis threshold operation (negative, if no thresholding is desired). Default: 40 + Edge amplitude (gradient magnitude) image. + + + + Extract edges using Deriche, Lanser, Shen, or Canny filters. + Instance represents: Input image. + + Edge direction image. + Edge operator to be applied. Default: "canny" + Filter parameter: small values result in strong smoothing, and thus less detail (opposite for 'canny'). Default: 1.0 + Non-maximum suppression ('none', if not desired). Default: "nms" + Lower threshold for the hysteresis threshold operation (negative, if no thresholding is desired). Default: 20 + Upper threshold for the hysteresis threshold operation (negative, if no thresholding is desired). Default: 40 + Edge amplitude (gradient magnitude) image. + + + + Convolve an image with derivatives of the Gaussian. + Instance represents: Input images. + + Sigma of the Gaussian. Default: 1.0 + Derivative or feature to be calculated. Default: "x" + Filtered result images. + + + + Convolve an image with derivatives of the Gaussian. + Instance represents: Input images. + + Sigma of the Gaussian. Default: 1.0 + Derivative or feature to be calculated. Default: "x" + Filtered result images. + + + + LoG-Operator (Laplace of Gaussian). + Instance represents: Input image. + + Smoothing parameter of the Gaussian. Default: 2.0 + Laplace filtered image. + + + + LoG-Operator (Laplace of Gaussian). + Instance represents: Input image. + + Smoothing parameter of the Gaussian. Default: 2.0 + Laplace filtered image. + + + + Approximate the LoG operator (Laplace of Gaussian). + Instance represents: Input image + + Smoothing parameter of the Laplace operator to approximate. Default: 3.0 + Ratio of the standard deviations used (Marr recommends 1.6). Default: 1.6 + LoG image. + + + + Detect straight edge segments. + Instance represents: Input image. + + Mask size of the Sobel operator. Default: 5 + Minimum edge strength. Default: 32 + Maximum distance of the approximating line to its original edge. Default: 3 + Minimum length of to resulting line segments. Default: 10 + Row coordinate of the line segments' start points. + Column coordinate of the line segments' start points. + Row coordinate of the line segments' end points. + Column coordinate of the line segments' end points. + + + Release the look-up-table needed for color space transformation. + Handle of the look-up-table handle for the color space transformation. + + + + Color space transformation using pre-generated look-up-table. + Instance represents: Input image (channel 1). + + Input image (channel 2). + Input image (channel 3). + Color-transformed output image (channel 2). + Color-transformed output image (channel 3). + Handle of the look-up-table for the color space transformation. + Color-transformed output image (channel 1). + + + Creates the look-up-table for transformation of an image from the RGB color space to an arbitrary color space. + Color space of the output image. Default: "hsv" + Direction of color space transformation. Default: "from_rgb" + Number of bits of the input image. Default: 8 + Handle of the look-up-table for color space transformation. + + + + Convert a single-channel color filter array image into an RGB image. + Instance represents: Input image. + + Color filter array type. Default: "bayer_gb" + Interpolation type. Default: "bilinear" + Output image. + + + + Transform an RGB image into a gray scale image. + Instance represents: Three-channel RBG image. + + Gray scale image. + + + + Transform an RGB image to a gray scale image. + Instance represents: Input image (red channel). + + Input image (green channel). + Input image (blue channel). + Gray scale image. + + + + Transform an image from the RGB color space to an arbitrary color space. + Instance represents: Input image (red channel). + + Input image (green channel). + Input image (blue channel). + Color-transformed output image (channel 1). + Color-transformed output image (channel 1). + Color space of the output image. Default: "hsv" + Color-transformed output image (channel 1). + + + + Transform an image from an arbitrary color space to the RGB color space. + Instance represents: Input image (channel 1). + + Input image (channel 2). + Input image (channel 3). + Green channel. + Blue channel. + Color space of the input image. Default: "hsv" + Red channel. + + + + Logical "AND" of each pixel using a bit mask. + Instance represents: Input image(s). + + Bit field Default: 128 + Result image(s) by combination with mask. + + + + Extract a bit from the pixels. + Instance represents: Input image(s). + + Bit to be selected. Default: 8 + Result image(s) by extraction. + + + + Right shift of all pixels of the image. + Instance represents: Input image(s). + + shift value Default: 3 + Result image(s) by shift operation. + + + + Left shift of all pixels of the image. + Instance represents: Input image(s). + + Shift value. Default: 3 + Result image(s) by shift operation. + + + + Complement all bits of the pixels. + Instance represents: Input image(s). + + Result image(s) by complement operation. + + + + Bit-by-bit XOR of all pixels of the input images. + Instance represents: Input image(s) 1. + + Input image(s) 2. + Result image(s) by XOR-operation. + + + + Bit-by-bit OR of all pixels of the input images. + Instance represents: Input image(s) 1. + + Input image(s) 2. + Result image(s) by OR-operation. + + + + Bit-by-bit AND of all pixels of the input images. + Instance represents: Input image(s) 1. + + Input image(s) 2. + Result image(s) by AND-operation. + + + + Perform a gamma encoding or decoding of an image. + Instance represents: Input image. + + Gamma coefficient of the exponential part of the transformation. Default: 0.416666666667 + Offset of the exponential part of the transformation. Default: 0.055 + Gray value for which the transformation switches from linear to exponential. Default: 0.0031308 + Maximum gray value of the input image type. Default: 255.0 + If 'true', perform a gamma encoding, otherwise a gamma decoding. Default: "true" + Output image. + + + + Perform a gamma encoding or decoding of an image. + Instance represents: Input image. + + Gamma coefficient of the exponential part of the transformation. Default: 0.416666666667 + Offset of the exponential part of the transformation. Default: 0.055 + Gray value for which the transformation switches from linear to exponential. Default: 0.0031308 + Maximum gray value of the input image type. Default: 255.0 + If 'true', perform a gamma encoding, otherwise a gamma decoding. Default: "true" + Output image. + + + + Raise an image to a power. + Instance represents: Input image. + + Power to which the gray values are raised. Default: 2 + Output image. + + + + Raise an image to a power. + Instance represents: Input image. + + Power to which the gray values are raised. Default: 2 + Output image. + + + + Calculate the exponentiation of an image. + Instance represents: Input image. + + Base of the exponentiation. Default: "e" + Output image. + + + + Calculate the exponentiation of an image. + Instance represents: Input image. + + Base of the exponentiation. Default: "e" + Output image. + + + + Calculate the logarithm of an image. + Instance represents: Input image. + + Base of the logarithm. Default: "e" + Output image. + + + + Calculate the logarithm of an image. + Instance represents: Input image. + + Base of the logarithm. Default: "e" + Output image. + + + + Calculate the arctangent of two images. + Instance represents: Input image 1. + + Input image 2. + Output image. + + + + Calculate the arctangent of an image. + Instance represents: Input image. + + Output image. + + + + Calculate the arccosine of an image. + Instance represents: Input image. + + Output image. + + + + Calculate the arcsine of an image. + Instance represents: Input image. + + Output image. + + + + Calculate the tangent of an image. + Instance represents: Input image. + + Output image. + + + + Calculate the cosine of an image. + Instance represents: Input image. + + Output image. + + + + Calculate the sine of an image. + Instance represents: Input image. + + Output image. + + + + Calculate the absolute difference of two images. + Instance represents: Input image 1. + + Input image 2. + Scale factor. Default: 1.0 + Absolute value of the difference of the input images. + + + + Calculate the absolute difference of two images. + Instance represents: Input image 1. + + Input image 2. + Scale factor. Default: 1.0 + Absolute value of the difference of the input images. + + + + Calculate the square root of an image. + Instance represents: Input image + + Output image + + + + Subtract two images. + Instance represents: Minuend(s). + + Subtrahend(s). + Correction factor. Default: 1.0 + Correction value. Default: 128.0 + Result image(s) by the subtraction. + + + + Subtract two images. + Instance represents: Minuend(s). + + Subtrahend(s). + Correction factor. Default: 1.0 + Correction value. Default: 128.0 + Result image(s) by the subtraction. + + + + Scale the gray values of an image. + Instance represents: Image(s) whose gray values are to be scaled. + + Scale factor. Default: 0.01 + Offset. Default: 0 + Result image(s) by the scale. + + + + Scale the gray values of an image. + Instance represents: Image(s) whose gray values are to be scaled. + + Scale factor. Default: 0.01 + Offset. Default: 0 + Result image(s) by the scale. + + + + Divide two images. + Instance represents: Image(s) 1. + + Image(s) 2. + Factor for gray range adaption. Default: 255 + Value for gray range adaption. Default: 0 + Result image(s) by the division. + + + + Divide two images. + Instance represents: Image(s) 1. + + Image(s) 2. + Factor for gray range adaption. Default: 255 + Value for gray range adaption. Default: 0 + Result image(s) by the division. + + + + Multiply two images. + Instance represents: Image(s) 1. + + Image(s) 2. + Factor for gray range adaption. Default: 0.005 + Value for gray range adaption. Default: 0 + Result image(s) by the product. + + + + Multiply two images. + Instance represents: Image(s) 1. + + Image(s) 2. + Factor for gray range adaption. Default: 0.005 + Value for gray range adaption. Default: 0 + Result image(s) by the product. + + + + Add two images. + Instance represents: Image(s) 1. + + Image(s) 2. + Factor for gray value adaption. Default: 0.5 + Value for gray value range adaption. Default: 0 + Result image(s) by the addition. + + + + Add two images. + Instance represents: Image(s) 1. + + Image(s) 2. + Factor for gray value adaption. Default: 0.5 + Value for gray value range adaption. Default: 0 + Result image(s) by the addition. + + + + Calculate the absolute value (modulus) of an image. + Instance represents: Image(s) for which the absolute gray values are to be calculated. + + Result image(s). + + + + Calculate the minimum of two images pixel by pixel. + Instance represents: Image(s) 1. + + Image(s) 2. + Result image(s) by the minimization. + + + + Calculate the maximum of two images pixel by pixel. + Instance represents: Image(s) 1. + + Image(s) 2. + Result image(s) by the maximization. + + + + Invert an image. + Instance represents: Input image(s). + + Image(s) with inverted gray values. + + + + Apply an automatic color correction to panorama images. + Instance represents: Input images. + + List of source images. + List of destination images. + Reference image. + Projective matrices. + Estimation algorithm for the correction. Default: "standard" + Parameters to be estimated. Default: ["mult_gray"] + Model of OECF to be used. Default: ["laguerre"] + Output images. + + + + Apply an automatic color correction to panorama images. + Instance represents: Input images. + + List of source images. + List of destination images. + Reference image. + Projective matrices. + Estimation algorithm for the correction. Default: "standard" + Parameters to be estimated. Default: ["mult_gray"] + Model of OECF to be used. Default: ["laguerre"] + Output images. + + + + Create 6 cube map images of a spherical mosaic. + Instance represents: Input images. + + Rear cube map. + Left cube map. + Right cube map. + Top cube map. + Bottom cube map. + (Array of) 3x3 projective camera matrices that determine the internal camera parameters. + Array of 3x3 transformation matrices that determine rotation of the camera in the respective image. + Width and height of the resulting cube maps. Default: 1000 + Mode of adding the images to the mosaic image. Default: "voronoi" + Mode of image interpolation. Default: "bilinear" + Front cube map. + + + + Create 6 cube map images of a spherical mosaic. + Instance represents: Input images. + + Rear cube map. + Left cube map. + Right cube map. + Top cube map. + Bottom cube map. + (Array of) 3x3 projective camera matrices that determine the internal camera parameters. + Array of 3x3 transformation matrices that determine rotation of the camera in the respective image. + Width and height of the resulting cube maps. Default: 1000 + Mode of adding the images to the mosaic image. Default: "voronoi" + Mode of image interpolation. Default: "bilinear" + Front cube map. + + + + Create a spherical mosaic image. + Instance represents: Input images. + + (Array of) 3x3 projective camera matrices that determine the internal camera parameters. + Array of 3x3 transformation matrices that determine rotation of the camera in the respective image. + Minimum latitude of points in the spherical mosaic image. Default: -90 + Maximum latitude of points in the spherical mosaic image. Default: 90 + Minimum longitude of points in the spherical mosaic image. Default: -180 + Maximum longitude of points in the spherical mosaic image. Default: 180 + Latitude and longitude angle step width. Default: 0.1 + Mode of adding the images to the mosaic image. Default: "voronoi" + Mode of interpolation when creating the mosaic image. Default: "bilinear" + Output image. + + + + Create a spherical mosaic image. + Instance represents: Input images. + + (Array of) 3x3 projective camera matrices that determine the internal camera parameters. + Array of 3x3 transformation matrices that determine rotation of the camera in the respective image. + Minimum latitude of points in the spherical mosaic image. Default: -90 + Maximum latitude of points in the spherical mosaic image. Default: 90 + Minimum longitude of points in the spherical mosaic image. Default: -180 + Maximum longitude of points in the spherical mosaic image. Default: 180 + Latitude and longitude angle step width. Default: 0.1 + Mode of adding the images to the mosaic image. Default: "voronoi" + Mode of interpolation when creating the mosaic image. Default: "bilinear" + Output image. + + + + Combine multiple images into a mosaic image. + Instance represents: Input images. + + Array of 3x3 projective transformation matrices. + Stacking order of the images in the mosaic. Default: "default" + Should the domains of the input images also be transformed? Default: "false" + 3x3 projective transformation matrix that describes the translation that was necessary to transform all images completely into the output image. + Output image. + + + + Combine multiple images into a mosaic image. + Instance represents: Input images. + + Array of 3x3 projective transformation matrices. + Stacking order of the images in the mosaic. Default: "default" + Should the domains of the input images also be transformed? Default: "false" + 3x3 projective transformation matrix that describes the translation that was necessary to transform all images completely into the output image. + Output image. + + + + Combine multiple images into a mosaic image. + Instance represents: Input images. + + Index of the central input image. + Indices of the source images of the transformations. + Indices of the target images of the transformations. + Array of 3x3 projective transformation matrices. + Stacking order of the images in the mosaic. Default: "default" + Should the domains of the input images also be transformed? Default: "false" + Array of 3x3 projective transformation matrices that determine the position of the images in the mosaic. + Output image. + + + + Combine multiple images into a mosaic image. + Instance represents: Input images. + + Index of the central input image. + Indices of the source images of the transformations. + Indices of the target images of the transformations. + Array of 3x3 projective transformation matrices. + Stacking order of the images in the mosaic. Default: "default" + Should the domains of the input images also be transformed? Default: "false" + Array of 3x3 projective transformation matrices that determine the position of the images in the mosaic. + Output image. + + + + Apply a projective transformation to an image and specify the output image size. + Instance represents: Input image. + + Homogeneous projective transformation matrix. + Interpolation method for the transformation. Default: "bilinear" + Output image width. + Output image height. + Should the domain of the input image also be transformed? Default: "false" + Output image. + + + + Apply a projective transformation to an image. + Instance represents: Input image. + + Homogeneous projective transformation matrix. + Interpolation method for the transformation. Default: "bilinear" + Adapt the size of the output image automatically? Default: "false" + Should the domain of the input image also be transformed? Default: "false" + Output image. + + + + Apply an arbitrary affine 2D transformation to an image and specify the output image size. + Instance represents: Input image. + + Input transformation matrix. + Type of interpolation. Default: "constant" + Width of the output image. Default: 640 + Height of the output image. Default: 480 + Transformed image. + + + + Apply an arbitrary affine 2D transformation to images. + Instance represents: Input image. + + Input transformation matrix. + Type of interpolation. Default: "constant" + Adaption of size of result image. Default: "false" + Transformed image. + + + + Zoom an image by a given factor. + Instance represents: Input image. + + Scale factor for the width of the image. Default: 0.5 + Scale factor for the height of the image. Default: 0.5 + Type of interpolation. Default: "constant" + Scaled image. + + + + Zoom an image to a given size. + Instance represents: Input image. + + Width of the resulting image. Default: 512 + Height of the resulting image. Default: 512 + Type of interpolation. Default: "constant" + Scaled image. + + + + Mirror an image. + Instance represents: Input image. + + Axis of reflection. Default: "row" + Reflected image. + + + + Rotate an image about its center. + Instance represents: Input image. + + Rotation angle. Default: 90 + Type of interpolation. Default: "constant" + Rotated image. + + + + Rotate an image about its center. + Instance represents: Input image. + + Rotation angle. Default: 90 + Type of interpolation. Default: "constant" + Rotated image. + + + + Transform an image in polar coordinates back to cartesian coordinates + Instance represents: Input image. + + Row coordinate of the center of the arc. Default: 256 + Column coordinate of the center of the arc. Default: 256 + Angle of the ray to map the first column of the input image to. Default: 0.0 + Angle of the ray to map the last column of the input image to. Default: 6.2831853 + Radius of the circle to map the first row of the input image to. Default: 0 + Radius of the circle to map the last row of the input image to. Default: 100 + Width of the output image. Default: 512 + Height of the output image. Default: 512 + Interpolation method for the transformation. Default: "nearest_neighbor" + Output image. + + + + Transform an image in polar coordinates back to cartesian coordinates + Instance represents: Input image. + + Row coordinate of the center of the arc. Default: 256 + Column coordinate of the center of the arc. Default: 256 + Angle of the ray to map the first column of the input image to. Default: 0.0 + Angle of the ray to map the last column of the input image to. Default: 6.2831853 + Radius of the circle to map the first row of the input image to. Default: 0 + Radius of the circle to map the last row of the input image to. Default: 100 + Width of the output image. Default: 512 + Height of the output image. Default: 512 + Interpolation method for the transformation. Default: "nearest_neighbor" + Output image. + + + + Transform an annular arc in an image to polar coordinates. + Instance represents: Input image. + + Row coordinate of the center of the arc. Default: 256 + Column coordinate of the center of the arc. Default: 256 + Angle of the ray to be mapped to the first column of the output image. Default: 0.0 + Angle of the ray to be mapped to the last column of the output image. Default: 6.2831853 + Radius of the circle to be mapped to the first row of the output image. Default: 0 + Radius of the circle to be mapped to the last row of the output image. Default: 100 + Width of the output image. Default: 512 + Height of the output image. Default: 512 + Interpolation method for the transformation. Default: "nearest_neighbor" + Output image. + + + + Transform an annular arc in an image to polar coordinates. + Instance represents: Input image. + + Row coordinate of the center of the arc. Default: 256 + Column coordinate of the center of the arc. Default: 256 + Angle of the ray to be mapped to the first column of the output image. Default: 0.0 + Angle of the ray to be mapped to the last column of the output image. Default: 6.2831853 + Radius of the circle to be mapped to the first row of the output image. Default: 0 + Radius of the circle to be mapped to the last row of the output image. Default: 100 + Width of the output image. Default: 512 + Height of the output image. Default: 512 + Interpolation method for the transformation. Default: "nearest_neighbor" + Output image. + + + + Transform an image to polar coordinates + Instance represents: Input image in cartesian coordinates. + + Row coordinate of the center of the coordinate system. Default: 100 + Column coordinate of the center of the coordinate system. Default: 100 + Width of the result image. Default: 314 + Height of the result image. Default: 200 + Result image in polar coordinates. + + + + Approximate an affine map from a displacement vector field. + Instance represents: Input image. + + Output transformation matrix. + + + + Deserialize a serialized image object. + Modified instance represents: Image object. + + Handle of the serialized item. + + + + Serialize an image object. + Instance represents: Image object. + + Handle of the serialized item. + + + + Write images in graphic formats. + Instance represents: Input images. + + Graphic format. Default: "tiff" + Fill gray value for pixels not belonging to the image domain (region). Default: 0 + Name of image file. + + + + Write images in graphic formats. + Instance represents: Input images. + + Graphic format. Default: "tiff" + Fill gray value for pixels not belonging to the image domain (region). Default: 0 + Name of image file. + + + + Read images. + Modified instance represents: Image read. + + Number of bytes for file header. Default: 0 + Number of image columns of the filed image. Default: 512 + Number of image lines of the filed image. Default: 512 + Starting point of image area (line). Default: 0 + Starting point of image area (column). Default: 0 + Number of image columns of output image. Default: 512 + Number of image lines of output image. Default: 512 + Type of pixel values. Default: "byte" + Sequence of bits within one byte. Default: "MSBFirst" + Sequence of bytes within one 'short' unit. Default: "MSBFirst" + Data units within one image line (alignment). Default: "byte" + Number of images in the file. Default: 1 + Name of input file. + + + + Read an image with different file formats. + Modified instance represents: Read image. + + Name of the image to be read. Default: "printer_chip/printer_chip_01" + + + + Read an image with different file formats. + Modified instance represents: Read image. + + Name of the image to be read. Default: "printer_chip/printer_chip_01" + + + + Return gray values of an image at the positions of an XLD contour. + Instance represents: Image whose gray values are to be accessed. + + Input XLD contour with the coordinates of the positions. + Interpolation method. Default: "nearest_neighbor" + Gray values of the selected image coordinates. + + + + Calculate gray value moments and approximation by a first order surface (plane). + Instance represents: Corresponding gray values. + + Regions to be checked. + Algorithm for the fitting. Default: "regression" + Maximum number of iterations (unused for 'regression'). Default: 5 + Clipping factor for the elimination of outliers. Default: 2.0 + Parameter Beta of the approximating surface. + Parameter Gamma of the approximating surface. + Parameter Alpha of the approximating surface. + + + + Calculate gray value moments and approximation by a first order surface (plane). + Instance represents: Corresponding gray values. + + Regions to be checked. + Algorithm for the fitting. Default: "regression" + Maximum number of iterations (unused for 'regression'). Default: 5 + Clipping factor for the elimination of outliers. Default: 2.0 + Parameter Beta of the approximating surface. + Parameter Gamma of the approximating surface. + Parameter Alpha of the approximating surface. + + + + Calculate gray value moments and approximation by a second order surface. + Instance represents: Corresponding gray values. + + Regions to be checked. + Algorithm for the fitting. Default: "regression" + Maximum number of iterations (unused for 'regression'). Default: 5 + Clipping factor for the elimination of outliers. Default: 2.0 + Parameter Beta of the approximating surface. + Parameter Gamma of the approximating surface. + Parameter Delta of the approximating surface. + Parameter Epsilon of the approximating surface. + Parameter Zeta of the approximating surface. + Parameter Alpha of the approximating surface. + + + + Calculate gray value moments and approximation by a second order surface. + Instance represents: Corresponding gray values. + + Regions to be checked. + Algorithm for the fitting. Default: "regression" + Maximum number of iterations (unused for 'regression'). Default: 5 + Clipping factor for the elimination of outliers. Default: 2.0 + Parameter Beta of the approximating surface. + Parameter Gamma of the approximating surface. + Parameter Delta of the approximating surface. + Parameter Epsilon of the approximating surface. + Parameter Zeta of the approximating surface. + Parameter Alpha of the approximating surface. + + + + Create a curved gray surface with second order polynomial. + Modified instance represents: Created image with new image matrix. + + Pixel type. Default: "byte" + Second order coefficient in vertical direction. Default: 1.0 + Second order coefficient in horizontal direction. Default: 1.0 + Mixed second order coefficient. Default: 1.0 + First order coefficient in vertical direction. Default: 1.0 + First order coefficient in horizontal direction. Default: 1.0 + Zero order coefficient. Default: 1.0 + Row coordinate of the reference point of the surface. Default: 256.0 + Column coordinate of the reference point of the surface. Default: 256.0 + Width of image. Default: 512 + Height of image. Default: 512 + + + + Create a tilted gray surface with first order polynomial. + Modified instance represents: Created image with new image matrix. + + Pixel type. Default: "byte" + First order coefficient in vertical direction. Default: 1.0 + First order coefficient in horizontal direction. Default: 1.0 + Zero order coefficient. Default: 1.0 + Row coordinate of the reference point of the surface. Default: 256.0 + Column coordinate of the reference point of the surface. Default: 256.0 + Width of image. Default: 512 + Height of image. Default: 512 + + + + Determine the minimum and maximum gray values within regions. + Instance represents: Gray value image. + + Regions, the features of which are to be calculated. + Percentage below (above) the absolute maximum (minimum). Default: 0 + "Minimum" gray value. + "Maximum" gray value. + Difference between Max and Min. + + + + Determine the minimum and maximum gray values within regions. + Instance represents: Gray value image. + + Regions, the features of which are to be calculated. + Percentage below (above) the absolute maximum (minimum). Default: 0 + "Minimum" gray value. + "Maximum" gray value. + Difference between Max and Min. + + + + Calculate the mean and deviation of gray values. + Instance represents: Gray value image. + + Regions in which the features are calculated. + Deviation of gray values within a region. + Mean gray value of a region. + + + + Calculate the mean and deviation of gray values. + Instance represents: Gray value image. + + Regions in which the features are calculated. + Deviation of gray values within a region. + Mean gray value of a region. + + + + Calculate the gray value distribution of a single channel image within a certain gray value range. + Instance represents: Input image. + + Region in which the histogram is to be calculated. + Minimum gray value. Default: 0 + Maximum gray value. Default: 255 + Number of bins. Default: 256 + Bin size. + Histogram to be calculated. + + + + Calculate the gray value distribution of a single channel image within a certain gray value range. + Instance represents: Input image. + + Region in which the histogram is to be calculated. + Minimum gray value. Default: 0 + Maximum gray value. Default: 255 + Number of bins. Default: 256 + Bin size. + Histogram to be calculated. + + + + Calculate the histogram of two-channel gray value images. + Instance represents: Channel 1. + + Region in which the histogram is to be calculated. + Channel 2. + Histogram to be calculated. + + + + Calculate the gray value distribution. + Instance represents: Image the gray value distribution of which is to be calculated. + + Region in which the histogram is to be calculated. + Quantization of the gray values. Default: 1.0 + Absolute frequencies of the gray values. + + + + Calculate the gray value distribution. + Instance represents: Image the gray value distribution of which is to be calculated. + + Region in which the histogram is to be calculated. + Quantization of the gray values. Default: 1.0 + Absolute frequencies of the gray values. + + + + Calculate the gray value distribution. + Instance represents: Image the gray value distribution of which is to be calculated. + + Region in which the histogram is to be calculated. + Frequencies, normalized to the area of the region. + Absolute frequencies of the gray values. + + + + Determine the entropy and anisotropy of images. + Instance represents: Gray value image. + + Regions where the features are to be determined. + Measure of the symmetry of gray value distribution. + Information content (entropy) of the gray values. + + + + Determine the entropy and anisotropy of images. + Instance represents: Gray value image. + + Regions where the features are to be determined. + Measure of the symmetry of gray value distribution. + Information content (entropy) of the gray values. + + + + Calculate gray value features from a co-occurrence matrix. + Instance represents: Co-occurrence matrix. + + Correlation of gray values. + Local homogeneity of gray values. + Gray value contrast. + Homogeneity of the gray values. + + + + Calculate a co-occurrence matrix and derive gray value features thereof. + Instance represents: Corresponding gray values. + + Region to be examined. + Number of gray values to be distinguished (2^LdGray@f$2^{LdGray}$). Default: 6 + Direction in which the matrix is to be calculated. Default: 0 + Correlation of gray values. + Local homogeneity of gray values. + Gray value contrast. + Gray value energy. + + + + Calculate a co-occurrence matrix and derive gray value features thereof. + Instance represents: Corresponding gray values. + + Region to be examined. + Number of gray values to be distinguished (2^LdGray@f$2^{LdGray}$). Default: 6 + Direction in which the matrix is to be calculated. Default: 0 + Correlation of gray values. + Local homogeneity of gray values. + Gray value contrast. + Gray value energy. + + + + Calculate the co-occurrence matrix of a region in an image. + Instance represents: Image providing the gray values. + + Region to be checked. + Number of gray values to be distinguished (2^LdGray@f$2^{LdGray}$). Default: 6 + Direction of neighbor relation. Default: 0 + Co-occurrence matrix (matrices). + + + + Calculate gray value moments and approximation by a plane. + Instance represents: Corresponding gray values. + + Regions to be checked. + Mixed moments along a line. + Mixed moments along a column. + Parameter Alpha of the approximating plane. + Parameter Beta of the approximating plane. + Mean gray value. + + + + Calculate gray value moments and approximation by a plane. + Instance represents: Corresponding gray values. + + Regions to be checked. + Mixed moments along a line. + Mixed moments along a column. + Parameter Alpha of the approximating plane. + Parameter Beta of the approximating plane. + Mean gray value. + + + + Calculate the deviation of the gray values from the approximating image plane. + Instance represents: Gray value image. + + Regions, of which the plane deviation is to be calculated. + Deviation of the gray values within a region. + + + + Compute the orientation and major axes of a region in a gray value image. + Instance represents: Gray value image. + + Region(s) to be examined. + Minor axis of the region. + Angle enclosed by the major axis and the x-axis. + Major axis of the region. + + + + Compute the orientation and major axes of a region in a gray value image. + Instance represents: Gray value image. + + Region(s) to be examined. + Minor axis of the region. + Angle enclosed by the major axis and the x-axis. + Major axis of the region. + + + + Compute the area and center of gravity of a region in a gray value image. + Instance represents: Gray value image. + + Region(s) to be examined. + Row coordinate of the gray value center of gravity. + Column coordinate of the gray value center of gravity. + Gray value volume of the region. + + + + Compute the area and center of gravity of a region in a gray value image. + Instance represents: Gray value image. + + Region(s) to be examined. + Row coordinate of the gray value center of gravity. + Column coordinate of the gray value center of gravity. + Gray value volume of the region. + + + + Calculate horizontal and vertical gray-value projections. + Instance represents: Grayvalues for projections. + + Region to be processed. + Method to compute the projections. Default: "simple" + Vertical projection. + Horizontal projection. + + + + Detect and read 2D data code symbols in an image or train the 2D data code model. + Instance represents: Input image. If the image has a reduced domain, the data code search is reduced to that domain. This usually reduces the runtime of the operator. However, if the datacode is not fully inside the domain, the datacode might not be found correctly. In rare cases, data codes may be found outside the domain. If these results are undesirable, they have to be subsequently eliminated. + + Handle of the 2D data code model. + Names of (optional) parameters for controlling the behavior of the operator. Default: [] + Values of the optional generic parameters. Default: [] + Handles of all successfully decoded 2D data code symbols. + Decoded data strings of all detected 2D data code symbols in the image. + XLD contours that surround the successfully decoded data code symbols. The order of the contour points reflects the orientation of the detected symbols. The contours begin in the top left corner (see 'orientation' at get_data_code_2d_results) and continue clockwise. Alignment{left} Figure[1][1][60]{get_data_code_2d_results-xld_qrcode} Order of points of SymbolXLDs Figure Alignment @f$ + + + + Detect and read 2D data code symbols in an image or train the 2D data code model. + Instance represents: Input image. If the image has a reduced domain, the data code search is reduced to that domain. This usually reduces the runtime of the operator. However, if the datacode is not fully inside the domain, the datacode might not be found correctly. In rare cases, data codes may be found outside the domain. If these results are undesirable, they have to be subsequently eliminated. + + Handle of the 2D data code model. + Names of (optional) parameters for controlling the behavior of the operator. Default: [] + Values of the optional generic parameters. Default: [] + Handles of all successfully decoded 2D data code symbols. + Decoded data strings of all detected 2D data code symbols in the image. + XLD contours that surround the successfully decoded data code symbols. The order of the contour points reflects the orientation of the detected symbols. The contours begin in the top left corner (see 'orientation' at get_data_code_2d_results) and continue clockwise. Alignment{left} Figure[1][1][60]{get_data_code_2d_results-xld_qrcode} Order of points of SymbolXLDs Figure Alignment @f$ + + + + Convert image maps into other map types. + Instance represents: Input map. + + Type of MapConverted. Default: "coord_map_sub_pix" + Width of images to be mapped. Default: "map_width" + Converted map. + + + + Convert image maps into other map types. + Instance represents: Input map. + + Type of MapConverted. Default: "coord_map_sub_pix" + Width of images to be mapped. Default: "map_width" + Converted map. + + + Compute an absolute pose out of point correspondences between world and image coordinates. + X-Component of world coordinates. + Y-Component of world coordinates. + Z-Component of world coordinates. + Row-Component of image coordinates. + Column-Component of image coordinates. + The inner camera parameters from camera calibration. + Kind of algorithm Default: "iterative" + Type of pose quality to be returned in Quality. Default: "error" + Pose quality. + Pose. + + + Compute an absolute pose out of point correspondences between world and image coordinates. + X-Component of world coordinates. + Y-Component of world coordinates. + Z-Component of world coordinates. + Row-Component of image coordinates. + Column-Component of image coordinates. + The inner camera parameters from camera calibration. + Kind of algorithm Default: "iterative" + Type of pose quality to be returned in Quality. Default: "error" + Pose quality. + Pose. + + + Compute a pose out of a homography describing the relation between world and image coordinates. + The homography from world- to image coordinates. + The camera calibration matrix K. + Type of pose computation. Default: "decomposition" + Pose of the 2D object. + + + + Perform a radiometric self-calibration of a camera. + Instance represents: Input images. + + Ratio of the exposure energies of successive image pairs. Default: 0.5 + Features that are used to compute the inverse response function of the camera. Default: "2d_histogram" + Type of the inverse response function of the camera. Default: "discrete" + Smoothness of the inverse response function of the camera. Default: 1.0 + Degree of the polynomial if FunctionType = 'polynomial'. Default: 5 + Inverse response function of the camera. + + + + Perform a radiometric self-calibration of a camera. + Instance represents: Input images. + + Ratio of the exposure energies of successive image pairs. Default: 0.5 + Features that are used to compute the inverse response function of the camera. Default: "2d_histogram" + Type of the inverse response function of the camera. Default: "discrete" + Smoothness of the inverse response function of the camera. Default: 1.0 + Degree of the polynomial if FunctionType = 'polynomial'. Default: 5 + Inverse response function of the camera. + + + + Apply a general transformation to an image. + Instance represents: Image to be mapped. + + Image containing the mapping data. + Mapped image. + + + + Generate a projection map that describes the mapping of images corresponding to a changing radial distortion. + Modified instance represents: Image containing the mapping data. + + Old camera parameters. + New camera parameters. + Type of the mapping. Default: "bilinear" + + + + Generate a projection map that describes the mapping between the image plane and a the plane z=0 of a world coordinate system. + Modified instance represents: Image containing the mapping data. + + Internal camera parameters. + 3D pose of the world coordinate system in camera coordinates. + Width of the images to be transformed. + Height of the images to be transformed. + Width of the resulting mapped images in pixels. + Height of the resulting mapped images in pixels. + Scale or unit. Default: "m" + Type of the mapping. Default: "bilinear" + + + + Generate a projection map that describes the mapping between the image plane and a the plane z=0 of a world coordinate system. + Modified instance represents: Image containing the mapping data. + + Internal camera parameters. + 3D pose of the world coordinate system in camera coordinates. + Width of the images to be transformed. + Height of the images to be transformed. + Width of the resulting mapped images in pixels. + Height of the resulting mapped images in pixels. + Scale or unit. Default: "m" + Type of the mapping. Default: "bilinear" + + + + Rectify an image by transforming it into the plane z=0 of a world coordinate system. + Instance represents: Input image. + + Internal camera parameters. + 3D pose of the world coordinate system in camera coordinates. + Width of the resulting image in pixels. + Height of the resulting image in pixels. + Scale or unit Default: "m" + Type of interpolation. Default: "bilinear" + Transformed image. + + + + Rectify an image by transforming it into the plane z=0 of a world coordinate system. + Instance represents: Input image. + + Internal camera parameters. + 3D pose of the world coordinate system in camera coordinates. + Width of the resulting image in pixels. + Height of the resulting image in pixels. + Scale or unit Default: "m" + Type of interpolation. Default: "bilinear" + Transformed image. + + + + Change the radial distortion of an image. + Instance represents: Original image. + + Region of interest in ImageRectified. + Internal camera parameter for Image. + Internal camera parameter for Image. + Resulting image with modified radial distortion. + + + + Simulate an image with calibration plate. + Modified instance represents: Simulated calibration image. + + File name of the calibration plate description. Default: "calplate_320mm.cpd" + Internal camera parameters. + External camera parameters (3D pose of the calibration plate in camera coordinates). + Gray value of image background. Default: 128 + Gray value of calibration plate. Default: 80 + Gray value of calibration marks. Default: 224 + Scaling factor to reduce oversampling. Default: 1.0 + + + + Extract rectangularly arranged 2D calibration marks from the image and calculate initial values for the external camera parameters. + Instance represents: Input image. + + Region of the calibration plate. + File name of the calibration plate description. Default: "caltab_100.descr" + Initial values for the internal camera parameters. + Initial threshold value for contour detection. Default: 128 + Loop value for successive reduction of StartThresh. Default: 10 + Minimum threshold for contour detection. Default: 18 + Filter parameter for contour detection, see edges_image. Default: 0.9 + Minimum length of the contours of the marks. Default: 15.0 + Maximum expected diameter of the marks. Default: 100.0 + Tuple with column coordinates of the detected marks. + Estimation for the external camera parameters. + Tuple with row coordinates of the detected marks. + + + + Segment the region of a standard calibration plate with rectangularly arranged marks in the image. + Instance represents: Input image. + + File name of the calibration plate description. Default: "caltab_100.descr" + Filter size of the Gaussian. Default: 3 + Threshold value for mark extraction. Default: 112 + Expected minimal diameter of the marks on the calibration plate. Default: 5 + Output region. + + + + Segment the region of a standard calibration plate with rectangularly arranged marks in the image. + Instance represents: Input image. + + File name of the calibration plate description. Default: "caltab_100.descr" + Filter size of the Gaussian. Default: 3 + Threshold value for mark extraction. Default: 112 + Expected minimal diameter of the marks on the calibration plate. Default: 5 + Output region. + + + + Decode bar code symbols within a rectangle. + Instance represents: Input image. + + Handle of the bar code model. + Type of the searched bar code. Default: "EAN-13" + Row index of the center. Default: 50.0 + Column index of the center. Default: 100.0 + Orientation of rectangle in radians. Default: 0.0 + Half of the length of the rectangle along the reading direction of the bar code. Default: 200.0 + Half of the length of the rectangle perpendicular to the reading direction of the bar code. Default: 100.0 + Data strings of all successfully decoded bar codes. + + + + Decode bar code symbols within a rectangle. + Instance represents: Input image. + + Handle of the bar code model. + Type of the searched bar code. Default: "EAN-13" + Row index of the center. Default: 50.0 + Column index of the center. Default: 100.0 + Orientation of rectangle in radians. Default: 0.0 + Half of the length of the rectangle along the reading direction of the bar code. Default: 200.0 + Half of the length of the rectangle perpendicular to the reading direction of the bar code. Default: 100.0 + Data strings of all successfully decoded bar codes. + + + + Detect and read bar code symbols in an image. + Instance represents: Input image. If the image has a reduced domain, the barcode search is reduced to that domain. This usually reduces the runtime of the operator. However, if the barcode is not fully inside the domain, the barcode cannot be decoded correctly. + + Handle of the bar code model. + Type of the searched bar code. Default: "auto" + Data strings of all successfully decoded bar codes. + Regions of the successfully decoded bar code symbols. + + + + Detect and read bar code symbols in an image. + Instance represents: Input image. If the image has a reduced domain, the barcode search is reduced to that domain. This usually reduces the runtime of the operator. However, if the barcode is not fully inside the domain, the barcode cannot be decoded correctly. + + Handle of the bar code model. + Type of the searched bar code. Default: "auto" + Data strings of all successfully decoded bar codes. + Regions of the successfully decoded bar code symbols. + + + + Return the estimated background image. + Modified instance represents: Estimated background image of the current data set. + + ID of the BgEsti data set. + + + + Change the estimated background image. + Instance represents: Current image. + + Region describing areas to change. + ID of the BgEsti data set. + + + + Estimate the background and return the foreground region. + Instance represents: Current image. + + ID of the BgEsti data set. + Region of the detected foreground. + + + + Generate and initialize a data set for the background estimation. + Instance represents: initialization image. + + 1. system matrix parameter. Default: 0.7 + 2. system matrix parameter. Default: 0.7 + Gain type. Default: "fixed" + Kalman gain / foreground adaptation time. Default: 0.002 + Kalman gain / background adaptation time. Default: 0.02 + Threshold adaptation. Default: "on" + Foreground/background threshold. Default: 7.0 + Number of statistic data sets. Default: 10 + Confidence constant. Default: 3.25 + Constant for decay time. Default: 15.0 + ID of the BgEsti data set. + + + + Asynchronous grab of images and preprocessed image data from the specified image acquisition device. + Modified instance represents: Grabbed image data. + + Pre-processed XLD contours. + Handle of the acquisition device to be used. + Maximum tolerated delay between the start of the asynchronous grab and the delivery of the image [ms]. Default: -1.0 + Pre-processed control data. + Pre-processed image regions. + + + + Asynchronous grab of images and preprocessed image data from the specified image acquisition device. + Modified instance represents: Grabbed image data. + + Pre-processed XLD contours. + Handle of the acquisition device to be used. + Maximum tolerated delay between the start of the asynchronous grab and the delivery of the image [ms]. Default: -1.0 + Pre-processed control data. + Pre-processed image regions. + + + + Synchronous grab of images and preprocessed image data from the specified image acquisition device. + Modified instance represents: Grabbed image data. + + Preprocessed XLD contours. + Handle of the acquisition device to be used. + Preprocessed control data. + Preprocessed image regions. + + + + Synchronous grab of images and preprocessed image data from the specified image acquisition device. + Modified instance represents: Grabbed image data. + + Preprocessed XLD contours. + Handle of the acquisition device to be used. + Preprocessed control data. + Preprocessed image regions. + + + + Asynchronous grab of an image from the specified image acquisition device. + Modified instance represents: Grabbed image. + + Handle of the acquisition device to be used. + Maximum tolerated delay between the start of the asynchronous grab and the delivery of the image [ms]. Default: -1.0 + + + + Synchronous grab of an image from the specified image acquisition device. + Modified instance represents: Grabbed image. + + Handle of the acquisition device to be used. + + + + Add training images to the texture inspection model. + Instance represents: Image of flawless texture. + + Handle of the texture inspection model. + Indices of the images that have been added to the texture inspection model. + + + + Inspection of the texture within an image. + Instance represents: Image of the texture to be inspected. + + Handle of the texture inspection model. + Handle of the inspection results. + Novelty regions. + + + + bilateral filtering of an image. + Instance represents: Image to be filtered. + + Joint image. + Size of the Gaussian of the closeness function. Default: 3.0 + Size of the Gaussian of the similarity function. Default: 20.0 + Generic parameter name. Default: [] + Generic parameter value. Default: [] + Filtered output image. + + + + bilateral filtering of an image. + Instance represents: Image to be filtered. + + Joint image. + Size of the Gaussian of the closeness function. Default: 3.0 + Size of the Gaussian of the similarity function. Default: 20.0 + Generic parameter name. Default: [] + Generic parameter value. Default: [] + Filtered output image. + + + + Find the best matches of multiple NCC models. + Instance represents: Input image in which the model should be found. + + Handle of the models. + Smallest rotation of the models. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Minimum score of the instances of the models to be found. Default: 0.8 + Number of instances of the models to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the models to be found. Default: 0.5 + Subpixel accuracy if not equal to 'none'. Default: "true" + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + Row coordinate of the found instances of the models. + Column coordinate of the found instances of the models. + Rotation angle of the found instances of the models. + Score of the found instances of the models. + Index of the found instances of the models. + + + + Find the best matches of multiple NCC models. + Instance represents: Input image in which the model should be found. + + Handle of the models. + Smallest rotation of the models. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Minimum score of the instances of the models to be found. Default: 0.8 + Number of instances of the models to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the models to be found. Default: 0.5 + Subpixel accuracy if not equal to 'none'. Default: "true" + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + Row coordinate of the found instances of the models. + Column coordinate of the found instances of the models. + Rotation angle of the found instances of the models. + Score of the found instances of the models. + Index of the found instances of the models. + + + + Get the training images contained in a texture inspection model. + Modified instance represents: Training images contained in the texture inspection model. + + Handle of the texture inspection model. + + + + Guided filtering of an image. + Instance represents: Input image. + + Guidance image. + Radius of the filtering operation. Default: 3 + Controls the influence of edges on the smoothing. Default: 20.0 + Output image. + + + + Create an interleaved image from a multichannel image. + Instance represents: Input multichannel image. + + Target format for InterleavedImage. Default: "rgba" + Number of bytes in a row of the output image. Default: "match" + Alpha value for three channel input images. Default: 255 + Output interleaved image. + + + + Create an interleaved image from a multichannel image. + Instance represents: Input multichannel image. + + Target format for InterleavedImage. Default: "rgba" + Number of bytes in a row of the output image. Default: "match" + Alpha value for three channel input images. Default: 255 + Output interleaved image. + + + + Segment image using Maximally Stable Extremal Regions (MSER). + Instance represents: Input image. + + Segmented light MSERs. + The polarity of the returned MSERs. Default: "both" + Minimal size of an MSER. Default: 10 + Maximal size of an MSER. Default: [] + Amount of thresholds for which a region needs to be stable. Default: 15 + List of generic parameter names. Default: [] + List of generic parameter values. Default: [] + Segmented dark MSERs. + + + + Segment image using Maximally Stable Extremal Regions (MSER). + Instance represents: Input image. + + Segmented light MSERs. + The polarity of the returned MSERs. Default: "both" + Minimal size of an MSER. Default: 10 + Maximal size of an MSER. Default: [] + Amount of thresholds for which a region needs to be stable. Default: 15 + List of generic parameter names. Default: [] + List of generic parameter values. Default: [] + Segmented dark MSERs. + + + Train a texture inspection model. + Handle of the texture inspection model. + + + + Reconstruct a surface from several, differently illuminated images. + Instance represents: The Images. + + The Gradient. + The Albedo. + The Result type. Default: "all" + The NormalField. + + + + Insert objects into an iconic object tuple. + Instance represents: Input object tuple. + + Object tuple to insert. + Index to insert objects. + Extended object tuple. + + + + Remove objects from an iconic object tuple. + Instance represents: Input object tuple. + + Indices of the objects to be removed. + Remaining object tuple. + + + + Remove objects from an iconic object tuple. + Instance represents: Input object tuple. + + Indices of the objects to be removed. + Remaining object tuple. + + + + Replaces one or more elements of an iconic object tuple. + Instance represents: Iconic Input Object. + + Element(s) to replace. + Index/Indices of elements to be replaced. + Tuple with replaced elements. + + + + Replaces one or more elements of an iconic object tuple. + Instance represents: Iconic Input Object. + + Element(s) to replace. + Index/Indices of elements to be replaced. + Tuple with replaced elements. + + + Get the clutter parameters of a shape model. + Handle of the model. + Parameter names. Default: "use_clutter" + Parameter values. + Transformation matrix. + Minimum contrast of clutter in the search images. + Region where no clutter should occur. + + + Get the clutter parameters of a shape model. + Handle of the model. + Parameter names. Default: "use_clutter" + Parameter values. + Transformation matrix. + Minimum contrast of clutter in the search images. + Region where no clutter should occur. + + + Set the clutter parameters of a shape model. + Region where no clutter should occur. + Handle of the model. + Transformation matrix. + Minimum contrast of clutter in the search images. Default: 128 + Parameter names. + Parameter values. + + + Set the clutter parameters of a shape model. + Region where no clutter should occur. + Handle of the model. + Transformation matrix. + Minimum contrast of clutter in the search images. Default: 128 + Parameter names. + Parameter values. + + + Returns the iconic object(s) at the specified index + + + Class grouping system information related functionality. + + + Query slots concerning information with relation to the operator get_operator_info. + Slotnames of the operator get_operator_info. + + + Query slots of the online-information concerning the operator get_param_info. + Slotnames for the operator get_param_info. + + + Get operators with the given string as a substring of their name. + Substring of the seeked names (empty $ less than = greater than $ all names). Default: "info" + Detected operator names. + + + Get default data type for the control parameters of a HALCON-operator. + Name of the operator. Default: "get_param_types" + Default type of the output control parameters. + Default type of the input control parameters. + + + Get number of the different parameter classes of a HALCON-operator. + Name of the operator. Default: "get_param_num" + Number of the input object parameters. + Number of the output object parameters. + Number of the input control parameters. + Number of the output control parameters. + System operator or user procedure. + Name of the called C-function. + + + Get the names of the parameters of a HALCON-operator. + Name of the operator. Default: "get_param_names" + Names of the output objects. + Names of the input control parameters. + Names of the output control parameters. + Names of the input objects. + + + Get information concerning a HALCON-operator. + Name of the operator on which more information is needed. Default: "get_operator_info" + Desired information. Default: "abstract" + Information (empty if no information is available) + + + Get information concerning the operator parameters. + Name of the operator on whose parameter more information is needed. Default: "get_param_info" + Name of the parameter on which more information is needed. Default: "Slot" + Desired information. Default: "description" + Information (empty in case there is no information available). + + + Search names of all operators assigned to one keyword. + Keyword for which corresponding operators are searched. Default: "Information" + Operators whose slot 'keyword' contains the keyword. + + + Get keywords which are assigned to operators. + Substring in the names of those operators for which keywords are needed. Default: "get_keywords" + Keywords for the operators. + + + Get information concerning the chapters on operators. + Operator class or subclass of interest. Default: "" + Operator classes (Chapter = ") or operator subclasses respectively operators. + + + Get information concerning the chapters on operators. + Operator class or subclass of interest. Default: "" + Operator classes (Chapter = ") or operator subclasses respectively operators. + + + Query all available window types. + Names of available window types. + + + Get the output treatment of an image matrix. + Window handle. + Display mode for images. + + + Query the region display modes. + region display mode names. + + + Query the possible line widths. + Displayable minimum width. + Displayable maximum width. + + + Query the number of colors for color output. + Tuple of the possible numbers of colors. + + + Query information about the specified image acquisition interface. + HALCON image acquisition interface name, i.e., name of the corresponding DLL (Windows) or shared library (Linux/macOS). Default: "File" + Name of the chosen query. Default: "info_boards" + List of values (according to Query). + Textual information (according to Query). + + + Represents an instance of a channel of an I/O device. + + + + Open and configure I/O channels. + Modified instance represents: Handles of the opened I/O channel. + + Handle of the opened I/O device. + HALCON I/O channel names of the specified device. + Parameter names. Default: [] + Parameter values. Default: [] + + + Perform an action on I/O channels. + Handles of the opened I/O channels. + Name of the action to perform. + List of arguments for the action. Default: [] + List of values returned by the action. + + + + Perform an action on I/O channels. + Instance represents: Handles of the opened I/O channels. + + Name of the action to perform. + List of arguments for the action. Default: [] + List of values returned by the action. + + + Write a value to the specified I/O channels. + Handles of the opened I/O channels. + Write values. + Status of written values. + + + + Write a value to the specified I/O channels. + Instance represents: Handles of the opened I/O channels. + + Write values. + Status of written values. + + + Read a value from the specified I/O channels. + Handles of the opened I/O channels. + Status of read value. + Read value. + + + + Read a value from the specified I/O channels. + Instance represents: Handles of the opened I/O channels. + + Status of read value. + Read value. + + + Set specific parameters of I/O channels. + Handles of the opened I/O channels. + Parameter names. Default: [] + Parameter values to set. Default: [] + + + + Set specific parameters of I/O channels. + Instance represents: Handles of the opened I/O channels. + + Parameter names. Default: [] + Parameter values to set. Default: [] + + + Query specific parameters of I/O channels. + Handles of the opened I/O channels. + Parameter names. Default: "param_name" + Parameter values. + + + + Query specific parameters of I/O channels. + Instance represents: Handles of the opened I/O channels. + + Parameter names. Default: "param_name" + Parameter values. + + + Close I/O channels. + Handles of the opened I/O channels. + + + + Close I/O channels. + Instance represents: Handles of the opened I/O channels. + + + + Open and configure I/O channels. + Handle of the opened I/O device. + HALCON I/O channel names of the specified device. + Parameter names. Default: [] + Parameter values. Default: [] + Handles of the opened I/O channel. + + + + Open and configure I/O channels. + Modified instance represents: Handles of the opened I/O channel. + + Handle of the opened I/O device. + HALCON I/O channel names of the specified device. + Parameter names. Default: [] + Parameter values. Default: [] + + + Represents an instance of an I/O device. + + + + Open and configure an I/O device. + Modified instance represents: Handle of the opened I/O device. + + HALCON I/O interface name. Default: [] + I/O device name. Default: [] + Dynamic parameter names. Default: [] + Dynamic parameter values. Default: [] + + + + Open and configure I/O channels. + Instance represents: Handle of the opened I/O device. + + HALCON I/O channel names of the specified device. + Parameter names. Default: [] + Parameter values. Default: [] + Handles of the opened I/O channel. + + + + Open and configure I/O channels. + Instance represents: Handle of the opened I/O device. + + HALCON I/O channel names of the specified device. + Parameter names. Default: [] + Parameter values. Default: [] + Handles of the opened I/O channel. + + + + Query information about channels of the specified I/O device. + Instance represents: Handle of the opened I/O device. + + Channel names to query. + Name of the query. Default: "param_name" + List of values (according to Query). + + + + Query information about channels of the specified I/O device. + Instance represents: Handle of the opened I/O device. + + Channel names to query. + Name of the query. Default: "param_name" + List of values (according to Query). + + + + Perform an action on the I/O device. + Instance represents: Handle of the opened I/O device. + + Name of the action to perform. + List of arguments for the action. Default: [] + List of result values returned by the action. + + + + Perform an action on the I/O device. + Instance represents: Handle of the opened I/O device. + + Name of the action to perform. + List of arguments for the action. Default: [] + List of result values returned by the action. + + + + Configure a specific I/O device instance. + Instance represents: Handle of the opened I/O device. + + Parameter names. Default: [] + Parameter values to set. Default: [] + + + + Configure a specific I/O device instance. + Instance represents: Handle of the opened I/O device. + + Parameter names. Default: [] + Parameter values to set. Default: [] + + + + Query settings of an I/O device instance. + Instance represents: Handle of the opened I/O device. + + Parameter names. Default: "param_name" + Parameter values. + + + + Query settings of an I/O device instance. + Instance represents: Handle of the opened I/O device. + + Parameter names. Default: "param_name" + Parameter values. + + + + Close the specified I/O device. + Instance represents: Handle of the opened I/O device. + + + + + Open and configure an I/O device. + Modified instance represents: Handle of the opened I/O device. + + HALCON I/O interface name. Default: [] + I/O device name. Default: [] + Dynamic parameter names. Default: [] + Dynamic parameter values. Default: [] + + + Perform an action on the I/O interface. + HALCON I/O interface name. Default: [] + Name of the action to perform. + List of arguments for the action. Default: [] + List of results returned by the action. + + + Perform an action on the I/O interface. + HALCON I/O interface name. Default: [] + Name of the action to perform. + List of arguments for the action. Default: [] + List of results returned by the action. + + + Query information about the specified I/O device interface. + HALCON I/O interface name. Default: [] + Parameter name of the query. Default: "io_device_names" + List of result values (according to Query). + + + Query information about the specified I/O device interface. + HALCON I/O interface name. Default: [] + Parameter name of the query. Default: "io_device_names" + List of result values (according to Query). + + + Represents an instance of a lexicon. + + + + Create a lexicon from a text file. + Modified instance represents: Handle of the lexicon. + + Unique name for the new lexicon. Default: "lex1" + Name of a text file containing words for the new lexicon. Default: "words.txt" + + + + Create a lexicon from a tuple of words. + Modified instance represents: Handle of the lexicon. + + Unique name for the new lexicon. Default: "lex1" + Word list for the new lexicon. Default: ["word1","word2","word3"] + + + + Clear a lexicon. + Instance represents: Handle of the lexicon. + + + + + Find a similar word in a lexicon. + Instance represents: Handle of the lexicon. + + Word to be looked up. Default: "word" + Difference between the words in edit operations. + Most similar word found in the lexicon. + + + + Check if a word is contained in a lexicon. + Instance represents: Handle of the lexicon. + + Word to be looked up. Default: "word" + Result of the search. + + + + Query all words from a lexicon. + Instance represents: Handle of the lexicon. + + List of all words. + + + + Create a lexicon from a text file. + Modified instance represents: Handle of the lexicon. + + Unique name for the new lexicon. Default: "lex1" + Name of a text file containing words for the new lexicon. Default: "words.txt" + + + + Create a lexicon from a tuple of words. + Modified instance represents: Handle of the lexicon. + + Unique name for the new lexicon. Default: "lex1" + Word list for the new lexicon. Default: ["word1","word2","word3"] + + + Represents an instance of a matrix. + + + + Read a matrix from a file. + Modified instance represents: Matrix handle. + + File name. + + + + Create a matrix. + Modified instance represents: Matrix handle. + + Number of rows of the matrix. Default: 3 + Number of columns of the matrix. Default: 3 + Values for initializing the elements of the matrix. Default: 0 + + + + Create a matrix. + Modified instance represents: Matrix handle. + + Number of rows of the matrix. Default: 3 + Number of columns of the matrix. Default: 3 + Values for initializing the elements of the matrix. Default: 0 + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + Negate the matrix + + + Add two matrices + + + Subtract two matrices + + + Multiplies two matrices + + + Scale a matrix + + + Scale a matrix + + + Solve linear system matrix2 * x = matrix1 + + + + Deserialize a serialized matrix. + Modified instance represents: Matrix handle. + + Handle of the serialized item. + + + + Serialize a matrix. + Instance represents: Matrix handle. + + Handle of the serialized item. + + + + Read a matrix from a file. + Modified instance represents: Matrix handle. + + File name. + + + + Write a matrix to a file. + Instance represents: Matrix handle of the input matrix. + + Format of the file. Default: "binary" + File name. + + + + Perform an orthogonal decomposition of a matrix. + Instance represents: Matrix handle of the input matrix. + + Method of decomposition. Default: "qr" + Type of output matrices. Default: "full" + Computation of the orthogonal matrix. Default: "true" + Matrix handle with the triangular part of the decomposed input matrix. + Matrix handle with the orthogonal part of the decomposed input matrix. + + + + Decompose a matrix. + Instance represents: Matrix handle of the input matrix. + + Type of the input matrix. Default: "general" + Matrix handle with the output matrix 2. + Matrix handle with the output matrix 1. + + + + Compute the singular value decomposition of a matrix. + Instance represents: Matrix handle of the input matrix. + + Type of computation. Default: "full" + Computation of singular values. Default: "both" + Matrix handle with singular values. + Matrix handle with the right singular vectors. + Matrix handle with the left singular vectors. + + + + Compute the generalized eigenvalues and optionally the generalized eigenvectors of general matrices. + Instance represents: Matrix handle of the input matrix A. + + Matrix handle of the input matrix B. + Computation of the eigenvectors. Default: "none" + Matrix handle with the real parts of the eigenvalues. + Matrix handle with the imaginary parts of the eigenvalues. + Matrix handle with the real parts of the eigenvectors. + Matrix handle with the imaginary parts of the eigenvectors. + + + + Compute the generalized eigenvalues and optionally generalized eigenvectors of symmetric input matrices. + Instance represents: Matrix handle of the symmetric input matrix A. + + Matrix handle of the symmetric positive definite input matrix B. + Computation of the eigenvectors. Default: "false" + Matrix handle with the eigenvectors. + Matrix handle with the eigenvalues. + + + + Compute the eigenvalues and optionally the eigenvectors of a general matrix. + Instance represents: Matrix handle of the input matrix. + + Computation of the eigenvectors. Default: "none" + Matrix handle with the real parts of the eigenvalues. + Matrix handle with the imaginary parts of the eigenvalues. + Matrix handle with the real parts of the eigenvectors. + Matrix handle with the imaginary parts of the eigenvectors. + + + + Compute the eigenvalues and optionally eigenvectors of a symmetric matrix. + Instance represents: Matrix handle of the input matrix. + + Computation of the eigenvectors. Default: "false" + Matrix handle with the eigenvectors. + Matrix handle with the eigenvalues. + + + + Compute the solution of a system of equations. + Instance represents: Matrix handle of the input matrix of the left hand side. + + The type of the input matrix of the left hand side. Default: "general" + Type of solving and limitation to set singular values to be 0. Default: 0.0 + Matrix handle of the input matrix of right hand side. + New matrix handle with the solution. + + + + Compute the determinant of a matrix. + Instance represents: Matrix handle of the input matrix. + + The type of the input matrix. Default: "general" + Determinant of the input matrix. + + + + Invert a matrix. + Instance represents: Matrix handle of the input matrix. + + The type of the input matrix. Default: "general" + Type of inversion. Default: 0.0 + + + + Invert a matrix. + Instance represents: Matrix handle of the input matrix. + + The type of the input matrix. Default: "general" + Type of inversion. Default: 0.0 + Matrix handle with the inverse matrix. + + + + Transpose a matrix. + Instance represents: Matrix handle of the input matrix. + + + + + Transpose a matrix. + Instance represents: Matrix handle of the input matrix. + + Matrix handle with the transpose of the input matrix. + + + + Returns the elementwise maximum of a matrix. + Instance represents: Matrix handle of the input matrix. + + Type of maximum determination. Default: "columns" + Matrix handle with the maximum values of the input matrix. + + + + Returns the elementwise minimum of a matrix. + Instance represents: Matrix handle of the input matrix. + + Type of minimum determination. Default: "columns" + Matrix handle with the minimum values of the input matrix. + + + + Compute the power functions of a matrix. + Instance represents: Matrix handle of the input matrix. + + The type of the input matrix. Default: "general" + The power. Default: 2.0 + + + + Compute the power functions of a matrix. + Instance represents: Matrix handle of the input matrix. + + The type of the input matrix. Default: "general" + The power. Default: 2.0 + + + + Compute the power functions of a matrix. + Instance represents: Matrix handle of the input matrix. + + The type of the input matrix. Default: "general" + The power. Default: 2.0 + Matrix handle with the raised powered matrix. + + + + Compute the power functions of a matrix. + Instance represents: Matrix handle of the input matrix. + + The type of the input matrix. Default: "general" + The power. Default: 2.0 + Matrix handle with the raised powered matrix. + + + + Compute the power functions of the elements of a matrix. + Instance represents: Matrix handle of the input matrix of the base. + + Matrix handle of the input matrix with exponents. + + + + Compute the power functions of the elements of a matrix. + Instance represents: Matrix handle of the input matrix of the base. + + Matrix handle of the input matrix with exponents. + Matrix handle with the raised power of the input matrix. + + + + Compute the power functions of the elements of a matrix. + Instance represents: Matrix handle of the input matrix. + + The power. Default: 2.0 + + + + Compute the power functions of the elements of a matrix. + Instance represents: Matrix handle of the input matrix. + + The power. Default: 2.0 + + + + Compute the power functions of the elements of a matrix. + Instance represents: Matrix handle of the input matrix. + + The power. Default: 2.0 + Matrix handle with the raised power of the input matrix. + + + + Compute the power functions of the elements of a matrix. + Instance represents: Matrix handle of the input matrix. + + The power. Default: 2.0 + Matrix handle with the raised power of the input matrix. + + + + Compute the square root values of the elements of a matrix. + Instance represents: Matrix handle of the input matrix. + + + + + Compute the square root values of the elements of a matrix. + Instance represents: Matrix handle of the input matrix. + + Matrix handle with the square root values of the input matrix. + + + + Compute the absolute values of the elements of a matrix. + Instance represents: Matrix handle of the input matrix. + + + + + Compute the absolute values of the elements of a matrix. + Instance represents: Matrix handle of the input matrix. + + Matrix handle with the absolute values of the input matrix. + + + + Norm of a matrix. + Instance represents: Matrix handle of the input matrix. + + Type of norm. Default: "2-norm" + Norm of the input matrix. + + + + Returns the elementwise mean of a matrix. + Instance represents: Matrix handle of the input matrix. + + Type of mean determination. Default: "columns" + Matrix handle with the mean values of the input matrix. + + + + Returns the elementwise sum of a matrix. + Instance represents: Matrix handle of the input matrix. + + Type of summation. Default: "columns" + Matrix handle with the sum of the input matrix. + + + + Divide matrices element-by-element. + Instance represents: Matrix handle of the input matrix A. + + Matrix handle of the input matrix B. + + + + Divide matrices element-by-element. + Instance represents: Matrix handle of the input matrix A. + + Matrix handle of the input matrix B. + Matrix handle with the divided values of input matrices. + + + + Multiply matrices element-by-element. + Instance represents: Matrix handle of the input matrix A. + + Matrix handle of the input matrix B. + + + + Multiply matrices element-by-element. + Instance represents: Matrix handle of the input matrix A. + + Matrix handle of the input matrix B. + Matrix handle with the multiplied values of the input matrices. + + + + Scale a matrix. + Instance represents: Matrix handle of the input matrix. + + Scale factor. Default: 2.0 + + + + Scale a matrix. + Instance represents: Matrix handle of the input matrix. + + Scale factor. Default: 2.0 + + + + Scale a matrix. + Instance represents: Matrix handle of the input matrix. + + Scale factor. Default: 2.0 + Matrix handle with the scaled elements. + + + + Scale a matrix. + Instance represents: Matrix handle of the input matrix. + + Scale factor. Default: 2.0 + Matrix handle with the scaled elements. + + + + Subtract two matrices. + Instance represents: Matrix handle of the input matrix A. + + Matrix handle of the input matrix B. + + + + Subtract two matrices. + Instance represents: Matrix handle of the input matrix A. + + Matrix handle of the input matrix B. + Matrix handle with the difference of the input matrices. + + + + Add two matrices. + Instance represents: Matrix handle of the input matrix A. + + Matrix handle of the input matrix B. + + + + Add two matrices. + Instance represents: Matrix handle of the input matrix A. + + Matrix handle of the input matrix B. + Matrix handle with the sum of the input matrices. + + + + Multiply two matrices. + Instance represents: Matrix handle of the input matrix A. + + Matrix handle of the input matrix B. + Type of the input matrices. Default: "AB" + + + + Multiply two matrices. + Instance represents: Matrix handle of the input matrix A. + + Matrix handle of the input matrix B. + Type of the input matrices. Default: "AB" + Matrix handle of the multiplied matrices. + + + + Get the size of a matrix. + Instance represents: Matrix handle of the input matrix. + + Number of rows of the matrix. + Number of columns of the matrix. + + + + Repeat a matrix. + Instance represents: Matrix handle of the input matrix. + + Number of copies of input matrix in row direction. Default: 2 + Number of copies of input matrix in column direction. Default: 2 + Matrix handle of the repeated copied matrix. + + + + Copy a matrix. + Instance represents: Matrix handle of the input matrix. + + Matrix handle of the copied matrix. + + + + Set the diagonal elements of a matrix. + Instance represents: Matrix handle of the input matrix. + + Matrix handle containing the diagonal elements to be set. + Position of the diagonal. Default: 0 + + + + Get the diagonal elements of a matrix. + Instance represents: Matrix handle of the input matrix. + + Number of the desired diagonal. Default: 0 + Matrix handle containing the diagonal elements. + + + + Set a sub-matrix of a matrix. + Instance represents: Matrix handle of the input matrix. + + Matrix handle of the input sub-matrix. + Upper row position of the sub-matrix in the matrix. Default: 0 + Left column position of the sub-matrix in the matrix. Default: 0 + + + + Get a sub-matrix of a matrix. + Instance represents: Matrix handle of the input matrix. + + Upper row position of the sub-matrix in the input matrix. Default: 0 + Left column position of the sub-matrix in the input matrix. Default: 0 + Number of rows of the sub-matrix. Default: 1 + Number of columns of the sub-matrix. Default: 1 + Matrix handle of the sub-matrix. + + + + Set all values of a matrix. + Instance represents: Matrix handle of the input matrix. + + Values to be set. + + + + Set all values of a matrix. + Instance represents: Matrix handle of the input matrix. + + Values to be set. + + + + Return all values of a matrix. + Instance represents: Matrix handle of the input matrix. + + Values of the matrix elements. + + + + Set one or more elements of a matrix. + Instance represents: Matrix handle of the input matrix. + + Row numbers of the matrix elements to be modified. Default: 0 + Column numbers of the matrix elements to be modified. Default: 0 + Values to be set in the indicated matrix elements. Default: 0 + + + + Set one or more elements of a matrix. + Instance represents: Matrix handle of the input matrix. + + Row numbers of the matrix elements to be modified. Default: 0 + Column numbers of the matrix elements to be modified. Default: 0 + Values to be set in the indicated matrix elements. Default: 0 + + + + Return one ore more elements of a matrix. + Instance represents: Matrix handle of the input matrix. + + Row numbers of matrix elements to be returned. Default: 0 + Column numbers of matrix elements to be returned. Default: 0 + Values of indicated matrix elements. + + + + Return one ore more elements of a matrix. + Instance represents: Matrix handle of the input matrix. + + Row numbers of matrix elements to be returned. Default: 0 + Column numbers of matrix elements to be returned. Default: 0 + Values of indicated matrix elements. + + + Free the memory of a matrix. + Matrix handle. + + + + Free the memory of a matrix. + Instance represents: Matrix handle. + + + + + Create a matrix. + Modified instance represents: Matrix handle. + + Number of rows of the matrix. Default: 3 + Number of columns of the matrix. Default: 3 + Values for initializing the elements of the matrix. Default: 0 + + + + Create a matrix. + Modified instance represents: Matrix handle. + + Number of rows of the matrix. Default: 3 + Number of columns of the matrix. Default: 3 + Values for initializing the elements of the matrix. Default: 0 + + + Indexer for accessing matrix elements + + + Get the number of rows + + + Get the number of columns + + + Represents an instance of a tool to measure distances. + + + + Prepare the extraction of straight edges perpendicular to an annular arc. + Modified instance represents: Measure object handle. + + Row coordinate of the center of the arc. Default: 100.0 + Column coordinate of the center of the arc. Default: 100.0 + Radius of the arc. Default: 50.0 + Start angle of the arc in radians. Default: 0.0 + Angular extent of the arc in radians. Default: 6.28318 + Radius (half width) of the annulus. Default: 10.0 + Width of the image to be processed subsequently. Default: 512 + Height of the image to be processed subsequently. Default: 512 + Type of interpolation to be used. Default: "nearest_neighbor" + + + + Prepare the extraction of straight edges perpendicular to an annular arc. + Modified instance represents: Measure object handle. + + Row coordinate of the center of the arc. Default: 100.0 + Column coordinate of the center of the arc. Default: 100.0 + Radius of the arc. Default: 50.0 + Start angle of the arc in radians. Default: 0.0 + Angular extent of the arc in radians. Default: 6.28318 + Radius (half width) of the annulus. Default: 10.0 + Width of the image to be processed subsequently. Default: 512 + Height of the image to be processed subsequently. Default: 512 + Type of interpolation to be used. Default: "nearest_neighbor" + + + + Prepare the extraction of straight edges perpendicular to a rectangle. + Modified instance represents: Measure object handle. + + Row coordinate of the center of the rectangle. Default: 300.0 + Column coordinate of the center of the rectangle. Default: 200.0 + Angle of longitudinal axis of the rectangle to horizontal (radians). Default: 0.0 + Half width of the rectangle. Default: 100.0 + Half height of the rectangle. Default: 20.0 + Width of the image to be processed subsequently. Default: 512 + Height of the image to be processed subsequently. Default: 512 + Type of interpolation to be used. Default: "nearest_neighbor" + + + + Prepare the extraction of straight edges perpendicular to a rectangle. + Modified instance represents: Measure object handle. + + Row coordinate of the center of the rectangle. Default: 300.0 + Column coordinate of the center of the rectangle. Default: 200.0 + Angle of longitudinal axis of the rectangle to horizontal (radians). Default: 0.0 + Half width of the rectangle. Default: 100.0 + Half height of the rectangle. Default: 20.0 + Width of the image to be processed subsequently. Default: 512 + Height of the image to be processed subsequently. Default: 512 + Type of interpolation to be used. Default: "nearest_neighbor" + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + + Serialize a measure object. + Instance represents: Measure object handle. + + Handle of the serialized item. + + + + Deserialize a serialized measure object. + Modified instance represents: Measure object handle. + + Handle of the serialized item. + + + + Write a measure object to a file. + Instance represents: Measure object handle. + + File name. + + + + Read a measure object from a file. + Modified instance represents: Measure object handle. + + File name. + + + + Extracting points with a particular gray value along a rectangle or an annular arc. + Instance represents: Measure object handle. + + Input image. + Sigma of gaussian smoothing. Default: 1.0 + Threshold. Default: 128.0 + Selection of points. Default: "all" + Row coordinates of points with threshold value. + Column coordinates of points with threshold value. + Distance between consecutive points. + + + + Delete a measure object. + Instance represents: Measure object handle. + + + + + Extract a gray value profile perpendicular to a rectangle or annular arc. + Instance represents: Measure object handle. + + Input image. + Gray value profile. + + + + Reset a fuzzy function. + Instance represents: Measure object handle. + + Selection of the fuzzy set. Default: "contrast" + + + + Specify a normalized fuzzy function for edge pairs. + Instance represents: Measure object handle. + + Favored width of edge pairs. Default: 10.0 + Selection of the fuzzy set. Default: "size_abs_diff" + Fuzzy function. + + + + Specify a normalized fuzzy function for edge pairs. + Instance represents: Measure object handle. + + Favored width of edge pairs. Default: 10.0 + Selection of the fuzzy set. Default: "size_abs_diff" + Fuzzy function. + + + + Specify a fuzzy function. + Instance represents: Measure object handle. + + Selection of the fuzzy set. Default: "contrast" + Fuzzy function. + + + + Extract straight edge pairs perpendicular to a rectangle or an annular arc. + Instance represents: Measure object handle. + + Input image. + Sigma of Gaussian smoothing. Default: 1.0 + Minimum edge amplitude. Default: 30.0 + Minimum fuzzy value. Default: 0.5 + Select the first gray value transition of the edge pairs. Default: "all" + Constraint of pairing. Default: "no_restriction" + Number of edge pairs. Default: 10 + Row coordinate of the first edge. + Column coordinate of the first edge. + Edge amplitude of the first edge (with sign). + Row coordinate of the second edge. + Column coordinate of the second edge. + Edge amplitude of the second edge (with sign). + Row coordinate of the center of the edge pair. + Column coordinate of the center of the edge pair. + Fuzzy evaluation of the edge pair. + Distance between the edges of the edge pair. + + + + Extract straight edge pairs perpendicular to a rectangle or an annular arc. + Instance represents: Measure object handle. + + Input image. + Sigma of Gaussian smoothing. Default: 1.0 + Minimum edge amplitude. Default: 30.0 + Minimum fuzzy value. Default: 0.5 + Select the first gray value transition of the edge pairs. Default: "all" + Row coordinate of the first edge point. + Column coordinate of the first edge point. + Edge amplitude of the first edge (with sign). + Row coordinate of the second edge point. + Column coordinate of the second edge point. + Edge amplitude of the second edge (with sign). + Row coordinate of the center of the edge pair. + Column coordinate of the center of the edge pair. + Fuzzy evaluation of the edge pair. + Distance between edges of an edge pair. + Distance between consecutive edge pairs. + + + + Extract straight edges perpendicular to a rectangle or an annular arc. + Instance represents: Measure object handle. + + Input image. + Sigma of Gaussian smoothing. Default: 1.0 + Minimum edge amplitude. Default: 30.0 + Minimum fuzzy value. Default: 0.5 + Select light/dark or dark/light edges. Default: "all" + Row coordinate of the edge point. + Column coordinate of the edge point. + Edge amplitude of the edge (with sign). + Fuzzy evaluation of the edges. + Distance between consecutive edges. + + + + Extract straight edge pairs perpendicular to a rectangle or annular arc. + Instance represents: Measure object handle. + + Input image. + Sigma of gaussian smoothing. Default: 1.0 + Minimum edge amplitude. Default: 30.0 + Type of gray value transition that determines how edges are grouped to edge pairs. Default: "all" + Selection of edge pairs. Default: "all" + Row coordinate of the center of the first edge. + Column coordinate of the center of the first edge. + Edge amplitude of the first edge (with sign). + Row coordinate of the center of the second edge. + Column coordinate of the center of the second edge. + Edge amplitude of the second edge (with sign). + Distance between edges of an edge pair. + Distance between consecutive edge pairs. + + + + Extract straight edges perpendicular to a rectangle or annular arc. + Instance represents: Measure object handle. + + Input image. + Sigma of gaussian smoothing. Default: 1.0 + Minimum edge amplitude. Default: 30.0 + Light/dark or dark/light edge. Default: "all" + Selection of end points. Default: "all" + Row coordinate of the center of the edge. + Column coordinate of the center of the edge. + Edge amplitude of the edge (with sign). + Distance between consecutive edges. + + + + Translate a measure object. + Instance represents: Measure object handle. + + Row coordinate of the new reference point. Default: 50.0 + Column coordinate of the new reference point. Default: 100.0 + + + + Translate a measure object. + Instance represents: Measure object handle. + + Row coordinate of the new reference point. Default: 50.0 + Column coordinate of the new reference point. Default: 100.0 + + + + Prepare the extraction of straight edges perpendicular to an annular arc. + Modified instance represents: Measure object handle. + + Row coordinate of the center of the arc. Default: 100.0 + Column coordinate of the center of the arc. Default: 100.0 + Radius of the arc. Default: 50.0 + Start angle of the arc in radians. Default: 0.0 + Angular extent of the arc in radians. Default: 6.28318 + Radius (half width) of the annulus. Default: 10.0 + Width of the image to be processed subsequently. Default: 512 + Height of the image to be processed subsequently. Default: 512 + Type of interpolation to be used. Default: "nearest_neighbor" + + + + Prepare the extraction of straight edges perpendicular to an annular arc. + Modified instance represents: Measure object handle. + + Row coordinate of the center of the arc. Default: 100.0 + Column coordinate of the center of the arc. Default: 100.0 + Radius of the arc. Default: 50.0 + Start angle of the arc in radians. Default: 0.0 + Angular extent of the arc in radians. Default: 6.28318 + Radius (half width) of the annulus. Default: 10.0 + Width of the image to be processed subsequently. Default: 512 + Height of the image to be processed subsequently. Default: 512 + Type of interpolation to be used. Default: "nearest_neighbor" + + + + Prepare the extraction of straight edges perpendicular to a rectangle. + Modified instance represents: Measure object handle. + + Row coordinate of the center of the rectangle. Default: 300.0 + Column coordinate of the center of the rectangle. Default: 200.0 + Angle of longitudinal axis of the rectangle to horizontal (radians). Default: 0.0 + Half width of the rectangle. Default: 100.0 + Half height of the rectangle. Default: 20.0 + Width of the image to be processed subsequently. Default: 512 + Height of the image to be processed subsequently. Default: 512 + Type of interpolation to be used. Default: "nearest_neighbor" + + + + Prepare the extraction of straight edges perpendicular to a rectangle. + Modified instance represents: Measure object handle. + + Row coordinate of the center of the rectangle. Default: 300.0 + Column coordinate of the center of the rectangle. Default: 200.0 + Angle of longitudinal axis of the rectangle to horizontal (radians). Default: 0.0 + Half width of the rectangle. Default: 100.0 + Half height of the rectangle. Default: 20.0 + Width of the image to be processed subsequently. Default: 512 + Height of the image to be processed subsequently. Default: 512 + Type of interpolation to be used. Default: "nearest_neighbor" + + + Represents an instance of a data container to be sent via message queues. + + + + Create a new empty message. + Modified instance represents: Handle of the newly created message. + + + + + Read a message from a file. + Modified instance represents: Message handle. + + File name. + Name of the generic parameter. Default: [] + Value of the generic parameter. Default: [] + + + + Read a message from a file. + Modified instance represents: Message handle. + + File name. + Name of the generic parameter. Default: [] + Value of the generic parameter. Default: [] + + + + Query message parameters or information about the message. + Instance represents: Message handle. + + Names of the message parameters or info queries. Default: "message_keys" + Message keys the parameter/query should be applied to. + Values of the message parameters or info queries. + + + + Query message parameters or information about the message. + Instance represents: Message handle. + + Names of the message parameters or info queries. Default: "message_keys" + Message keys the parameter/query should be applied to. + Values of the message parameters or info queries. + + + + Set message parameter or invoke commands on the message. + Instance represents: Message handle. + + Names of the message parameters or action commands. Default: "remove_key" + Message keys the parameter/command should be applied to. + Values of the message parameters or action commands. + + + + Set message parameter or invoke commands on the message. + Instance represents: Message handle. + + Names of the message parameters or action commands. Default: "remove_key" + Message keys the parameter/command should be applied to. + Values of the message parameters or action commands. + + + + Retrieve an object associated with the key from the message. + Instance represents: Message handle. + + Key string or integer. + Tuple value retrieved from the message. + + + + Retrieve an object associated with the key from the message. + Instance represents: Message handle. + + Key string or integer. + Tuple value retrieved from the message. + + + + Add a key/object pair to the message. + Instance represents: Message handle. + + Object to be associated with the key. + Key string or integer. + + + + Add a key/object pair to the message. + Instance represents: Message handle. + + Object to be associated with the key. + Key string or integer. + + + + Retrieve a tuple associated with the key from the message. + Instance represents: Message handle. + + Key string or integer. + Tuple value retrieved from the message. + + + + Retrieve a tuple associated with the key from the message. + Instance represents: Message handle. + + Key string or integer. + Tuple value retrieved from the message. + + + + Add a key/tuple pair to the message. + Instance represents: Message handle. + + Key string or integer. + Tuple value to be associated with the key. + + + + Add a key/tuple pair to the message. + Instance represents: Message handle. + + Key string or integer. + Tuple value to be associated with the key. + + + Close a message handle and release all associated resources. + Message handle(s) to be closed. + + + + Close a message handle and release all associated resources. + Instance represents: Message handle(s) to be closed. + + + + + Create a new empty message. + Modified instance represents: Handle of the newly created message. + + + + + Read a message from a file. + Modified instance represents: Message handle. + + File name. + Name of the generic parameter. Default: [] + Value of the generic parameter. Default: [] + + + + Read a message from a file. + Modified instance represents: Message handle. + + File name. + Name of the generic parameter. Default: [] + Value of the generic parameter. Default: [] + + + + Write a message to a file. + Instance represents: Message handle. + + File name. + Name of the generic parameter. Default: [] + Value of the generic parameter. Default: [] + + + + Write a message to a file. + Instance represents: Message handle. + + File name. + Name of the generic parameter. Default: [] + Value of the generic parameter. Default: [] + + + Represents an instance of a message queue for inter-thread communication. + + + + Create a new empty message queue. + Modified instance represents: Handle of the newly created message queue. + + + + + Query message queue parameters or information about the queue. + Instance represents: Message queue handle. + + Names of the queue parameters or info queries. Default: "max_message_num" + Values of the queue parameters or info queries. + + + + Query message queue parameters or information about the queue. + Instance represents: Message queue handle. + + Names of the queue parameters or info queries. Default: "max_message_num" + Values of the queue parameters or info queries. + + + + Set message queue parameters or invoke commands on the queue. + Instance represents: Message queue handle. + + Names of the queue parameters or action commands. Default: "max_message_num" + Values of the queue parameters or action commands. Default: 1 + + + + Set message queue parameters or invoke commands on the queue. + Instance represents: Message queue handle. + + Names of the queue parameters or action commands. Default: "max_message_num" + Values of the queue parameters or action commands. Default: 1 + + + + Receive one or more messages from the message queue. + Instance represents: Message queue handle. + + Names of optional generic parameters Default: "timeout" + Values of optional generic parameters Default: "infinite" + Handle(s) of the dequeued message(s). + + + + Receive one or more messages from the message queue. + Instance represents: Message queue handle. + + Names of optional generic parameters Default: "timeout" + Values of optional generic parameters Default: "infinite" + Handle(s) of the dequeued message(s). + + + + Enqueue one or more messages to the message queue. + Instance represents: Message queue handle. + + Handle(s) of message(s) to be enqueued. + Names of optional generic parameters. + Values of optional generic parameters. + + + + Enqueue one or more messages to the message queue. + Instance represents: Message queue handle. + + Handle(s) of message(s) to be enqueued. + Names of optional generic parameters. + Values of optional generic parameters. + + + Close a message queue handle and release all associated resources. + Message queue handle(s) to be closed. + + + + Close a message queue handle and release all associated resources. + Instance represents: Message queue handle(s) to be closed. + + + + + Create a new empty message queue. + Modified instance represents: Handle of the newly created message queue. + + + + Represents an instance of a metrology model. + + + + Read a metrology model from a file. + Modified instance represents: Handle of the metrology model. + + File name. + + + + Create the data structure that is needed to measure geometric shapes. + Modified instance represents: Handle of the metrology model. + + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + + Query the model contour of a metrology object in image coordinates. + Instance represents: Handle of the metrology model. + + Index of the metrology object. Default: 0 + Distance between neighboring contour points. Default: 1.5 + Model contour. + + + + Query the model contour of a metrology object in image coordinates. + Instance represents: Handle of the metrology model. + + Index of the metrology object. Default: 0 + Distance between neighboring contour points. Default: 1.5 + Model contour. + + + + Query the result contour of a metrology object. + Instance represents: Handle of the metrology model. + + Index of the metrology object. Default: 0 + Instance of the metrology object. Default: "all" + Distance between neighboring contour points. Default: 1.5 + Result contour for the given metrology object. + + + + Query the result contour of a metrology object. + Instance represents: Handle of the metrology model. + + Index of the metrology object. Default: 0 + Instance of the metrology object. Default: "all" + Distance between neighboring contour points. Default: 1.5 + Result contour for the given metrology object. + + + + Alignment of a metrology model. + Instance represents: Handle of the metrology model. + + Row coordinate of the alignment. Default: 0 + Column coordinate of the alignment. Default: 0 + Rotation angle of the alignment. Default: 0 + + + + Alignment of a metrology model. + Instance represents: Handle of the metrology model. + + Row coordinate of the alignment. Default: 0 + Column coordinate of the alignment. Default: 0 + Rotation angle of the alignment. Default: 0 + + + + Add a metrology object to a metrology model. + Instance represents: Handle of the metrology model. + + Type of the metrology object to be added. Default: "circle" + Parameters of the metrology object to be added. + Half length of the measure regions perpendicular to the boundary. Default: 20.0 + Half length of the measure regions tangetial to the boundary. Default: 5.0 + Sigma of the Gaussian function for the smoothing. Default: 1.0 + Minimum edge amplitude. Default: 30.0 + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Index of the created metrology object. + + + + Add a metrology object to a metrology model. + Instance represents: Handle of the metrology model. + + Type of the metrology object to be added. Default: "circle" + Parameters of the metrology object to be added. + Half length of the measure regions perpendicular to the boundary. Default: 20.0 + Half length of the measure regions tangetial to the boundary. Default: 5.0 + Sigma of the Gaussian function for the smoothing. Default: 1.0 + Minimum edge amplitude. Default: 30.0 + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Index of the created metrology object. + + + + Get parameters that are valid for the entire metrology model. + Instance represents: Handle of the metrology model. + + Name of the generic parameter. Default: "camera_param" + Value of the generic parameter. + + + + Set parameters that are valid for the entire metrology model. + Instance represents: Handle of the metrology model. + + Name of the generic parameter. Default: "camera_param" + Value of the generic parameter. Default: [] + + + + Set parameters that are valid for the entire metrology model. + Instance represents: Handle of the metrology model. + + Name of the generic parameter. Default: "camera_param" + Value of the generic parameter. Default: [] + + + + Deserialize a serialized metrology model. + Modified instance represents: Handle of the metrology model. + + Handle of the serialized item. + + + + Serialize a metrology model. + Instance represents: Handle of the metrology model. + + Handle of the serialized item. + + + + Transform metrology objects of a metrology model, e.g. for alignment. + Instance represents: Handle of the metrology model. + + Index of the metrology objects. Default: "all" + Translation in row direction. + Translation in column direction. + Rotation angle. + Mode of the transformation. Default: "absolute" + + + + Transform metrology objects of a metrology model, e.g. for alignment. + Instance represents: Handle of the metrology model. + + Index of the metrology objects. Default: "all" + Translation in row direction. + Translation in column direction. + Rotation angle. + Mode of the transformation. Default: "absolute" + + + + Write a metrology model to a file. + Instance represents: Handle of the metrology model. + + File name. + + + + Read a metrology model from a file. + Modified instance represents: Handle of the metrology model. + + File name. + + + + Copy a metrology model. + Instance represents: Handle of the metrology model. + + Index of the metrology objects. Default: "all" + Handle of the copied metrology model. + + + + Copy a metrology model. + Instance represents: Handle of the metrology model. + + Index of the metrology objects. Default: "all" + Handle of the copied metrology model. + + + + Copy metrology metrology objects of a metrology model. + Instance represents: Handle of the metrology model. + + Index of the metrology objects. Default: "all" + Indices of the copied metrology objects. + + + + Copy metrology metrology objects of a metrology model. + Instance represents: Handle of the metrology model. + + Index of the metrology objects. Default: "all" + Indices of the copied metrology objects. + + + + Get the number of instances of the metrology objects of a metrology model. + Instance represents: Handle of the metrology model. + + Index of the metrology objects. Default: 0 + Number of Instances of the metrology objects. + + + + Get the number of instances of the metrology objects of a metrology model. + Instance represents: Handle of the metrology model. + + Index of the metrology objects. Default: 0 + Number of Instances of the metrology objects. + + + + Get the results of the measurement of a metrology model. + Instance represents: Handle of the metrology model. + + Index of the metrology object. Default: 0 + Instance of the metrology object. Default: "all" + Name of the generic parameter. Default: "result_type" + Value of the generic parameter. Default: "all_param" + Result values. + + + + Get the results of the measurement of a metrology model. + Instance represents: Handle of the metrology model. + + Index of the metrology object. Default: 0 + Instance of the metrology object. Default: "all" + Name of the generic parameter. Default: "result_type" + Value of the generic parameter. Default: "all_param" + Result values. + + + + Get the measure regions and the results of the edge location for the metrology objects of a metrology model. + Instance represents: Handle of the metrology model. + + Index of the metrology objects. Default: "all" + Select light/dark or dark/light edges. Default: "all" + Row coordinates of the measured edges. + Column coordinates of the measured edges. + Rectangular XLD Contours of measure regions. + + + + Get the measure regions and the results of the edge location for the metrology objects of a metrology model. + Instance represents: Handle of the metrology model. + + Index of the metrology objects. Default: "all" + Select light/dark or dark/light edges. Default: "all" + Row coordinates of the measured edges. + Column coordinates of the measured edges. + Rectangular XLD Contours of measure regions. + + + + Measure and fit the geometric shapes of all metrology objects of a metrology model. + Instance represents: Handle of the metrology model. + + Input image. + + + + Get the indices of the metrology objects of a metrology model. + Instance represents: Handle of the metrology model. + + Indices of the metrology objects. + + + + Reset all fuzzy parameters and fuzzy functions of a metrology model. + Instance represents: Handle of the metrology model. + + Index of the metrology objects. Default: "all" + + + + Reset all fuzzy parameters and fuzzy functions of a metrology model. + Instance represents: Handle of the metrology model. + + Index of the metrology objects. Default: "all" + + + + Reset all parameters of a metrology model. + Instance represents: Handle of the metrology model. + + Index of the metrology objects. Default: "all" + + + + Reset all parameters of a metrology model. + Instance represents: Handle of the metrology model. + + Index of the metrology objects. Default: "all" + + + + Get a fuzzy parameter of a metroloy model. + Instance represents: Handle of the metrology model. + + Index of the metrology objects. Default: "all" + Names of the generic parameters. Default: "fuzzy_thresh" + Values of the generic parameters. + + + + Get a fuzzy parameter of a metroloy model. + Instance represents: Handle of the metrology model. + + Index of the metrology objects. Default: "all" + Names of the generic parameters. Default: "fuzzy_thresh" + Values of the generic parameters. + + + + Get one or several parameters of a metroloy model. + Instance represents: Handle of the metrology model. + + Index of the metrology objects. Default: "all" + Names of the generic parameters. Default: "num_measures" + Values of the generic parameters. + + + + Get one or several parameters of a metroloy model. + Instance represents: Handle of the metrology model. + + Index of the metrology objects. Default: "all" + Names of the generic parameters. Default: "num_measures" + Values of the generic parameters. + + + + Set fuzzy parameters or fuzzy functions for a metrology model. + Instance represents: Handle of the metrology model. + + Index of the metrology objects. Default: "all" + Names of the generic parameters. Default: "fuzzy_thresh" + Values of the generic parameters. Default: 0.5 + + + + Set fuzzy parameters or fuzzy functions for a metrology model. + Instance represents: Handle of the metrology model. + + Index of the metrology objects. Default: "all" + Names of the generic parameters. Default: "fuzzy_thresh" + Values of the generic parameters. Default: 0.5 + + + + Set parameters for the metrology objects of a metrology model. + Instance represents: Handle of the metrology model. + + Index of the metrology objects. Default: "all" + Names of the generic parameters. Default: "num_instances" + Values of the generic parameters. Default: 1 + + + + Set parameters for the metrology objects of a metrology model. + Instance represents: Handle of the metrology model. + + Index of the metrology objects. Default: "all" + Names of the generic parameters. Default: "num_instances" + Values of the generic parameters. Default: 1 + + + + Add a rectangle to a metrology model. + Instance represents: Handle of the metrology model. + + Row (or Y) coordinate of the center of the rectangle. + Column (or X) coordinate of the center of the rectangle. + Orientation of the main axis [rad]. + Length of the larger half edge of the rectangle. + Length of the smaller half edge of the rectangle. + Half length of the measure regions perpendicular to the boundary. Default: 20.0 + Half length of the measure regions tangetial to the boundary. Default: 5.0 + Sigma of the Gaussian function for the smoothing. Default: 1.0 + Minimum edge amplitude. Default: 30.0 + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Index of the created metrology object. + + + + Add a rectangle to a metrology model. + Instance represents: Handle of the metrology model. + + Row (or Y) coordinate of the center of the rectangle. + Column (or X) coordinate of the center of the rectangle. + Orientation of the main axis [rad]. + Length of the larger half edge of the rectangle. + Length of the smaller half edge of the rectangle. + Half length of the measure regions perpendicular to the boundary. Default: 20.0 + Half length of the measure regions tangetial to the boundary. Default: 5.0 + Sigma of the Gaussian function for the smoothing. Default: 1.0 + Minimum edge amplitude. Default: 30.0 + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Index of the created metrology object. + + + + Add a line to a metrology model. + Instance represents: Handle of the metrology model. + + Row (or Y) coordinate of the start of the line. + Column (or X) coordinate of the start of the line. + Row (or Y) coordinate of the end of the line. + Column (or X) coordinate of the end of the line. + Half length of the measure regions perpendicular to the boundary. Default: 20.0 + Half length of the measure regions tangetial to the boundary. Default: 5.0 + Sigma of the Gaussian function for the smoothing. Default: 1.0 + Minimum edge amplitude. Default: 30.0 + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Index of the created metrology object. + + + + Add a line to a metrology model. + Instance represents: Handle of the metrology model. + + Row (or Y) coordinate of the start of the line. + Column (or X) coordinate of the start of the line. + Row (or Y) coordinate of the end of the line. + Column (or X) coordinate of the end of the line. + Half length of the measure regions perpendicular to the boundary. Default: 20.0 + Half length of the measure regions tangetial to the boundary. Default: 5.0 + Sigma of the Gaussian function for the smoothing. Default: 1.0 + Minimum edge amplitude. Default: 30.0 + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Index of the created metrology object. + + + + Add an ellipse or an elliptic arc to a metrology model. + Instance represents: Handle of the metrology model. + + Row (or Y) coordinate of the center of the ellipse. + Column (or X) coordinate of the center of the ellipse. + Orientation of the main axis [rad]. + Length of the larger half axis. + Length of the smaller half axis. + Half length of the measure regions perpendicular to the boundary. Default: 20.0 + Half length of the measure regions tangetial to the boundary. Default: 5.0 + Sigma of the Gaussian function for the smoothing. Default: 1.0 + Minimum edge amplitude. Default: 30.0 + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Index of the created metrology object. + + + + Add an ellipse or an elliptic arc to a metrology model. + Instance represents: Handle of the metrology model. + + Row (or Y) coordinate of the center of the ellipse. + Column (or X) coordinate of the center of the ellipse. + Orientation of the main axis [rad]. + Length of the larger half axis. + Length of the smaller half axis. + Half length of the measure regions perpendicular to the boundary. Default: 20.0 + Half length of the measure regions tangetial to the boundary. Default: 5.0 + Sigma of the Gaussian function for the smoothing. Default: 1.0 + Minimum edge amplitude. Default: 30.0 + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Index of the created metrology object. + + + + Add a circle or a circular arc to a metrology model. + Instance represents: Handle of the metrology model. + + Row coordinate (or Y) of the center of the circle or circular arc. + Column (or X) coordinate of the center of the circle or circular arc. + Radius of the circle or circular arc. + Half length of the measure regions perpendicular to the boundary. Default: 20.0 + Half length of the measure regions tangetial to the boundary. Default: 5.0 + Sigma of the Gaussian function for the smoothing. Default: 1.0 + Minimum edge amplitude. Default: 30.0 + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Index of the created metrology object. + + + + Add a circle or a circular arc to a metrology model. + Instance represents: Handle of the metrology model. + + Row coordinate (or Y) of the center of the circle or circular arc. + Column (or X) coordinate of the center of the circle or circular arc. + Radius of the circle or circular arc. + Half length of the measure regions perpendicular to the boundary. Default: 20.0 + Half length of the measure regions tangetial to the boundary. Default: 5.0 + Sigma of the Gaussian function for the smoothing. Default: 1.0 + Minimum edge amplitude. Default: 30.0 + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Index of the created metrology object. + + + + Delete a metrology model and free the allocated memory. + Instance represents: Handle of the metrology model. + + + + + Delete metrology objects and free the allocated memory. + Instance represents: Handle of the metrology model. + + Index of the metrology objects. Default: "all" + + + + Delete metrology objects and free the allocated memory. + Instance represents: Handle of the metrology model. + + Index of the metrology objects. Default: "all" + + + + Set the size of the image of metrology objects. + Instance represents: Handle of the metrology model. + + Width of the image to be processed. Default: 640 + Height of the image to be processed. Default: 480 + + + + Create the data structure that is needed to measure geometric shapes. + Modified instance represents: Handle of the metrology model. + + + + Class grouping methods belonging to no other HALCON class. + + + Write a tuple to a file. + Tuple with any kind of data. + Name of the file to be written. + + + Read a tuple from a file. + Name of the file to be read. + Tuple with any kind of data. + + + This operator is inoperable. It had the following function: Close all serial devices. + + + This operator is inoperable. It had the following function: Clear all OCV tools. + + + This operator is inoperable. It had the following function: Destroy all OCR classifiers. + + + Concat training files. + Names of the single training files. Default: "" + Name of the composed training file. Default: "all_characters" + + + Concat training files. + Names of the single training files. Default: "" + Name of the composed training file. Default: "all_characters" + + + Query which characters are stored in a (protected) training file. + Names of the training files. Default: "" + Passwords for protected training files. + Number of characters. + Names of the read characters. + + + Query which characters are stored in a (protected) training file. + Names of the training files. Default: "" + Passwords for protected training files. + Number of characters. + Names of the read characters. + + + Query which characters are stored in a training file. + Names of the training files. Default: "" + Number of characters. + Names of the read characters. + + + Query which characters are stored in a training file. + Names of the training files. Default: "" + Number of characters. + Names of the read characters. + + + This operator is inoperable. It had the following function: Delete all measure objects. + + + Convert spherical coordinates of a 3D point to Cartesian coordinates. + Longitude of the 3D point. + Latitude of the 3D point. + Radius of the 3D point. + Normal vector of the equatorial plane (points to the north pole). Default: "-y" + Coordinate axis in the equatorial plane that points to the zero meridian. Default: "-z" + X coordinate of the 3D point. + Y coordinate of the 3D point. + Z coordinate of the 3D point. + + + Convert spherical coordinates of a 3D point to Cartesian coordinates. + Longitude of the 3D point. + Latitude of the 3D point. + Radius of the 3D point. + Normal vector of the equatorial plane (points to the north pole). Default: "-y" + Coordinate axis in the equatorial plane that points to the zero meridian. Default: "-z" + X coordinate of the 3D point. + Y coordinate of the 3D point. + Z coordinate of the 3D point. + + + Convert Cartesian coordinates of a 3D point to spherical coordinates. + X coordinate of the 3D point. + Y coordinate of the 3D point. + Z coordinate of the 3D point. + Normal vector of the equatorial plane (points to the north pole). Default: "-y" + Coordinate axis in the equatorial plane that points to the zero meridian. Default: "-z" + Latitude of the 3D point. + Radius of the 3D point. + Longitude of the 3D point. + + + Convert Cartesian coordinates of a 3D point to spherical coordinates. + X coordinate of the 3D point. + Y coordinate of the 3D point. + Z coordinate of the 3D point. + Normal vector of the equatorial plane (points to the north pole). Default: "-y" + Coordinate axis in the equatorial plane that points to the zero meridian. Default: "-z" + Latitude of the 3D point. + Radius of the 3D point. + Longitude of the 3D point. + + + Read the description file of a Kalman filter. + Description file for a Kalman filter. Default: "kalman.init" + The lined up matrices A, C, Q, possibly G and u, and if necessary L stored in row-major order. + The matrix R stored in row-major order. + The matrix P0@f$P_{0}$ (error covariance matrix of the initial state estimate) stored in row-major order and the initial state estimate x0@f$x_{0}$ lined up. + The dimensions of the state vector, the measurement vector and the controller vector. + + + Read an update file of a Kalman filter. + Update file for a Kalman filter. Default: "kalman.updt" + The dimensions of the state vector, measurement vector and controller vector. Default: [3,1,0] + The lined up matrices A,C,Q, possibly G and u, and if necessary L which all have been stored in row-major order. Default: [1.0,1.0,0.5,0.0,1.0,1.0,0.0,0.0,1.0,1.0,0.0,0.0,54.3,37.9,48.0,37.9,34.3,42.5,48.0,42.5,43.7] + The matrix R stored in row-major order. Default: [1,2] + The lined up matrices A,C,Q, possibly G and u, and if necessary L which all have been stored in row-major order. + The matrix R stored in row-major order. + The dimensions of the state vector, measurement vector and controller vector. + + + Estimate the current state of a system with the help of the Kalman filtering. + The dimensions of the state vector, the measurement and the controller vector. Default: [3,1,0] + The lined up matrices A,C,Q, possibly G and u, and if necessary L which have been stored in row-major order. Default: [1.0,1.0,0.5,0.0,1.0,1.0,0.0,0.0,1.0,1.0,0.0,0.0,54.3,37.9,48.0,37.9,34.3,42.5,48.0,42.5,43.7] + The matrix R stored in row-major order and the measurement vector y lined up. Default: [1.2,1.0] + The matrix P*@f$P$ (the extrapolation-error covariances) stored in row-major order and the extrapolation vector x*@f$x$ lined up. Default: [0.0,0.0,0.0,0.0,180.5,0.0,0.0,0.0,100.0,0.0,100.0,0.0] + The matrix P~@f$P$ (the estimation-error covariances) stored in row-major order and the estimated state x~@f$x$ lined up. + The matrix P* (the extrapolation-error covariances)stored in row-major order and the extrapolation vector x*@f$x$ lined up. + + + Generate a PostScript file, which describes the rectification grid. + Width of the checkered pattern in meters (without the two frames). Default: 0.17 + Number of squares per row and column. Default: 17 + File name of the PostScript file. Default: "rectification_grid.ps" + + + Generate a projection map that describes the mapping between an arbitrarily distorted image and the rectified image. + Distance of the grid points in the rectified image. + Row coordinates of the grid points in the distorted image. + Column coordinates of the grid points in the distorted image. + Width of the point grid (number of grid points). + Width of the images to be rectified. + Height of the images to be rectified. + Type of mapping. Default: "bilinear" + Image containing the mapping data. + + + Calculate the projection of a point onto a line. + Row coordinate of the point. + Column coordinate of the point. + Row coordinate of the first point on the line. + Column coordinate of the first point on the line. + Row coordinate of the second point on the line. + Column coordinate of the second point on the line. + Row coordinate of the projected point. + Column coordinate of the projected point + + + Calculate the projection of a point onto a line. + Row coordinate of the point. + Column coordinate of the point. + Row coordinate of the first point on the line. + Column coordinate of the first point on the line. + Row coordinate of the second point on the line. + Column coordinate of the second point on the line. + Row coordinate of the projected point. + Column coordinate of the projected point + + + Calculate a point of an ellipse corresponding to a specific angle. + Angle corresponding to the resulting point [rad]. Default: 0 + Row coordinate of the center of the ellipse. + Column coordinate of the center of the ellipse. + Orientation of the main axis [rad]. + Length of the larger half axis. + Length of the smaller half axis. + Row coordinate of the point on the ellipse. + Column coordinates of the point on the ellipse. + + + Calculate a point of an ellipse corresponding to a specific angle. + Angle corresponding to the resulting point [rad]. Default: 0 + Row coordinate of the center of the ellipse. + Column coordinate of the center of the ellipse. + Orientation of the main axis [rad]. + Length of the larger half axis. + Length of the smaller half axis. + Row coordinate of the point on the ellipse. + Column coordinates of the point on the ellipse. + + + Calculate the intersection point of two lines. + Row coordinate of the first point of the first line. + Column coordinate of the first point of the first line. + Row coordinate of the second point of the first line. + Column coordinate of the second point of the first line. + Row coordinate of the first point of the second line. + Column coordinate of the first point of the second line. + Row coordinate of the second point of the second line. + Column coordinate of the second point of the second line. + Row coordinate of the intersection point. + Column coordinate of the intersection point. + Are the two lines parallel? + + + Calculate the intersection point of two lines. + Row coordinate of the first point of the first line. + Column coordinate of the first point of the first line. + Row coordinate of the second point of the first line. + Column coordinate of the second point of the first line. + Row coordinate of the first point of the second line. + Column coordinate of the first point of the second line. + Row coordinate of the second point of the second line. + Column coordinate of the second point of the second line. + Row coordinate of the intersection point. + Column coordinate of the intersection point. + Are the two lines parallel? + + + Calculate the angle between one line and the horizontal axis. + Row coordinate the first point of the line. + Column coordinate of the first point of the line. + Row coordinate of the second point of the line. + Column coordinate of the second point of the line. + Angle between the line and the horizontal axis [rad]. + + + Calculate the angle between one line and the horizontal axis. + Row coordinate the first point of the line. + Column coordinate of the first point of the line. + Row coordinate of the second point of the line. + Column coordinate of the second point of the line. + Angle between the line and the horizontal axis [rad]. + + + Calculate the angle between two lines. + Row coordinate of the first point of the first line. + Column coordinate of the first point of the first line. + Row coordinate of the second point of the first line. + Column coordinate of the second point of the first line. + Row coordinate of the first point of the second line. + Column coordinate of the first point of the second line. + Row coordinate of the second point of the second line. + Column coordinate of the second point of the second line. + Angle between the lines [rad]. + + + Calculate the angle between two lines. + Row coordinate of the first point of the first line. + Column coordinate of the first point of the first line. + Row coordinate of the second point of the first line. + Column coordinate of the second point of the first line. + Row coordinate of the first point of the second line. + Column coordinate of the first point of the second line. + Row coordinate of the second point of the second line. + Column coordinate of the second point of the second line. + Angle between the lines [rad]. + + + Calculate the distances between a line segment and a line. + Row coordinate of the first point of the line segment. + Column coordinate of the first point of the line segment. + Row coordinate of the second point of the line segment. + Column coordinate of the second point of the line segment. + Row coordinate of the first point of the line. + Column coordinate of the first point of the line. + Row coordinate of the second point of the line. + Column coordinate of the second point of the line. + Minimum distance between the line segment and the line. + Maximum distance between the line segment and the line. + + + Calculate the distances between a line segment and a line. + Row coordinate of the first point of the line segment. + Column coordinate of the first point of the line segment. + Row coordinate of the second point of the line segment. + Column coordinate of the second point of the line segment. + Row coordinate of the first point of the line. + Column coordinate of the first point of the line. + Row coordinate of the second point of the line. + Column coordinate of the second point of the line. + Minimum distance between the line segment and the line. + Maximum distance between the line segment and the line. + + + Calculate the distances between two line segments. + Row coordinate of the first point of the line segment. + Column coordinate of the first point of the line segment. + Row coordinate of the second point of the line segment. + Column coordinate of the second point of the line segment. + Row coordinate of the first point of the line. + Column of the first point of the line. + Row coordinate of the second point of the line. + Column coordinate of the second point of the line. + Minimum distance between the line segments. + Maximum distance between the line segments. + + + Calculate the distances between two line segments. + Row coordinate of the first point of the line segment. + Column coordinate of the first point of the line segment. + Row coordinate of the second point of the line segment. + Column coordinate of the second point of the line segment. + Row coordinate of the first point of the line. + Column of the first point of the line. + Row coordinate of the second point of the line. + Column coordinate of the second point of the line. + Minimum distance between the line segments. + Maximum distance between the line segments. + + + Calculate the distances between a point and a line segment. + Row coordinate of the first point. + Column coordinate of the first point. + Row coordinate of the first point of the line segment. + Column coordinate of the first point of the line segment. + Row coordinate of the second point of the line segment. + Column coordinate of the second point of the line segment. + Minimum distance between the point and the line segment. + Maximum distance between the point and the line segment. + + + Calculate the distances between a point and a line segment. + Row coordinate of the first point. + Column coordinate of the first point. + Row coordinate of the first point of the line segment. + Column coordinate of the first point of the line segment. + Row coordinate of the second point of the line segment. + Column coordinate of the second point of the line segment. + Minimum distance between the point and the line segment. + Maximum distance between the point and the line segment. + + + Calculate the distance between one point and one line. + Row coordinate of the point. + Column of the point. + Row coordinate of the first point of the line. + Column coordinate of the first point of the line. + Row coordinate of the second point of the line. + Column coordinate of the second point of the line. + Distance between the points. + + + Calculate the distance between one point and one line. + Row coordinate of the point. + Column of the point. + Row coordinate of the first point of the line. + Column coordinate of the first point of the line. + Row coordinate of the second point of the line. + Column coordinate of the second point of the line. + Distance between the points. + + + Calculate the distance between two points. + Row coordinate of the first point. + Column coordinate of the first point. + Row coordinate of the second point. + Column coordinate of the second point. + Distance between the points. + + + Calculate the distance between two points. + Row coordinate of the first point. + Column coordinate of the first point. + Row coordinate of the second point. + Column coordinate of the second point. + Distance between the points. + + + Information on smoothing filter smooth_image. + Name of required filter. Default: "deriche2" + Filter parameter: small values effect strong smoothing (reversed in case of 'gauss'). Default: 0.5 + In case of gauss filter: coefficients of the "positive" half of the 1D impulse answer. + Width of filter is approx. size x size pixels. + + + Generate a Gaussian noise distribution. + Standard deviation of the Gaussian noise distribution. Default: 2.0 + Resulting Gaussian noise distribution. + + + Generate a salt-and-pepper noise distribution. + Percentage of salt (white noise pixels). Default: 5.0 + Percentage of pepper (black noise pixels). Default: 5.0 + Resulting noise distribution. + + + Generate a salt-and-pepper noise distribution. + Percentage of salt (white noise pixels). Default: 5.0 + Percentage of pepper (black noise pixels). Default: 5.0 + Resulting noise distribution. + + + Deserialize FFT speed optimization data. + Handle of the serialized item. + + + Serialize FFT speed optimization data. + Handle of the serialized item. + + + Load FFT speed optimization data from a file. + File name of the optimization data. Default: "fft_opt.dat" + + + Store FFT speed optimization data in a file. + File name of the optimization data. Default: "fft_opt.dat" + + + Optimize the runtime of the real-valued FFT. + Width of the image for which the runtime should be optimized. Default: 512 + Height of the image for which the runtime should be optimized. Default: 512 + Thoroughness of the search for the optimum runtime. Default: "standard" + + + Optimize the runtime of the FFT. + Width of the image for which the runtime should be optimized. Default: 512 + Height of the image for which the runtime should be optimized. Default: 512 + Thoroughness of the search for the optimum runtime. Default: "standard" + + + Return the filter coefficients of a filter in edges_image. + Name of the edge operator. Default: "lanser2" + 1D edge filter ('edge') or 1D smoothing filter ('smooth'). Default: "edge" + Filter parameter: small values result in strong smoothing, and thus less detail (opposite for 'canny'). Default: 0.5 + For Canny filters: Coefficients of the "positive" half of the 1D impulse response. All others: Coefficients of a corresponding non-recursive filter. + Filter width in pixels. + + + Copy a file to a new location. + File to be copied. + Target location. + + + Set the current working directory. + Name of current working directory to be set. + + + Get the current working directory. + Name of current working directory. + + + Delete an empty directory. + Name of directory to be deleted. + + + Make a directory. + Name of directory to be created. + + + List all files in a directory. + Name of directory to be listed. + Processing options. Default: "files" + Found files (and directories). + + + List all files in a directory. + Name of directory to be listed. + Processing options. Default: "files" + Found files (and directories). + + + Delete a file. + File to be deleted. + + + Check whether file exists. + Name of file to be checked. Default: "/bin/cc" + boolean number. + + + This operator is inoperable. It had the following function: Close all open files. + + + Select the longest input lines. + Row coordinates of the starting points of the input lines. + Column coordinates of the starting points of the input lines. + Row coordinates of the ending points of the input lines. + Column coordinates of the ending points of the input lines. + (Maximum) desired number of output lines. Default: 10 + Row coordinates of the starting points of the output lines. + Column coordinates of the starting points of the output lines. + Row coordinates of the ending points of the output lines. + Column coordinates of the ending points of the output lines. + + + Partition lines according to various criteria. + Row coordinates of the starting points of the input lines. + Column coordinates of the starting points of the input lines. + Row coordinates of the ending points of the input lines. + Column coordinates of the ending points of the input lines. + Features to be used for selection. + Desired combination of the features. + Lower limits of the features or 'min'. Default: "min" + Upper limits of the features or 'max'. Default: "max" + Row coordinates of the starting points of the lines fulfilling the conditions. + Column coordinates of the starting points of the lines fulfilling the conditions. + Row coordinates of the ending points of the lines fulfilling the conditions. + Column coordinates of the ending points of the lines fulfilling the conditions. + Row coordinates of the starting points of the lines not fulfilling the conditions. + Column coordinates of the starting points of the lines not fulfilling the conditions. + Row coordinates of the ending points of the lines not fulfilling the conditions. + Column coordinates of the ending points of the lines not fulfilling the conditions. + + + Partition lines according to various criteria. + Row coordinates of the starting points of the input lines. + Column coordinates of the starting points of the input lines. + Row coordinates of the ending points of the input lines. + Column coordinates of the ending points of the input lines. + Features to be used for selection. + Desired combination of the features. + Lower limits of the features or 'min'. Default: "min" + Upper limits of the features or 'max'. Default: "max" + Row coordinates of the starting points of the lines fulfilling the conditions. + Column coordinates of the starting points of the lines fulfilling the conditions. + Row coordinates of the ending points of the lines fulfilling the conditions. + Column coordinates of the ending points of the lines fulfilling the conditions. + Row coordinates of the starting points of the lines not fulfilling the conditions. + Column coordinates of the starting points of the lines not fulfilling the conditions. + Row coordinates of the ending points of the lines not fulfilling the conditions. + Column coordinates of the ending points of the lines not fulfilling the conditions. + + + Select lines according to various criteria. + Row coordinates of the starting points of the input lines. + Column coordinates of the starting points of the input lines. + Row coordinates of the ending points of the input lines. + Column coordinates of the ending points of the input lines. + Features to be used for selection. Default: "length" + Desired combination of the features. Default: "and" + Lower limits of the features or 'min'. Default: "min" + Upper limits of the features or 'max'. Default: "max" + Row coordinates of the starting points of the output lines. + Column coordinates of the starting points of the output lines. + Row coordinates of the ending points of the output lines. + Column coordinates of the ending points of the output lines. + + + Select lines according to various criteria. + Row coordinates of the starting points of the input lines. + Column coordinates of the starting points of the input lines. + Row coordinates of the ending points of the input lines. + Column coordinates of the ending points of the input lines. + Features to be used for selection. Default: "length" + Desired combination of the features. Default: "and" + Lower limits of the features or 'min'. Default: "min" + Upper limits of the features or 'max'. Default: "max" + Row coordinates of the starting points of the output lines. + Column coordinates of the starting points of the output lines. + Row coordinates of the ending points of the output lines. + Column coordinates of the ending points of the output lines. + + + Calculate the center of gravity, length, and orientation of a line. + Row coordinates of the starting points of the input lines. + Column coordinates of the starting points of the input lines. + Row coordinates of the ending points of the input lines. + Column coordinates of the ending points of the input lines. + Row coordinates of the centers of gravity of the input lines. + Column coordinates of the centers of gravity of the input lines. + Euclidean length of the input lines. + Orientation of the input lines. + + + Calculate the center of gravity, length, and orientation of a line. + Row coordinates of the starting points of the input lines. + Column coordinates of the starting points of the input lines. + Row coordinates of the ending points of the input lines. + Column coordinates of the ending points of the input lines. + Row coordinates of the centers of gravity of the input lines. + Column coordinates of the centers of gravity of the input lines. + Euclidean length of the input lines. + Orientation of the input lines. + + + Calculate the orientation of lines. + Row coordinates of the starting points of the input lines. + Column coordinates of the starting points of the input lines. + Row coordinates of the ending points of the input lines. + Column coordinates of the ending points of the input lines. + Orientation of the input lines. + + + Calculate the orientation of lines. + Row coordinates of the starting points of the input lines. + Column coordinates of the starting points of the input lines. + Row coordinates of the ending points of the input lines. + Column coordinates of the ending points of the input lines. + Orientation of the input lines. + + + Approximate a contour by arcs and lines. + Row of the contour. Default: 32 + Column of the contour. Default: 32 + Row of the center of an arc. + Column of the center of an arc. + Angle of an arc. + Row of the starting point of an arc. + Column of the starting point of an arc. + Row of the starting point of a line segment. + Column of the starting point of a line segment. + Row of the ending point of a line segment. + Column of the ending point of a line segment. + Sequence of line (value 0) and arc segments (value 1). + + + Approximate a contour by arcs and lines. + Row of the contour. Default: 32 + Column of the contour. Default: 32 + Minimum width of Gauss operator for coordinate smoothing ($ greater than $ 0.4). Default: 0.5 + Maximum width of Gauss operator for coordinate smoothing ($ greater than $ 0.4). Default: 2.4 + Minimum threshold value of the curvature for accepting a corner (relative to the largest curvature present). Default: 0.3 + Maximum threshold value of the curvature for accepting a corner (relative to the largest curvature present). Default: 0.9 + Step width for threshold increase. Default: 0.2 + Minimum width of Gauss operator for smoothing the curvature function ($ greater than $ 0.4). Default: 0.5 + Maximum width of Gauss operator for smoothing the curvature function. Default: 2.4 + Minimum width of curve area for curvature determination ($ greater than $ 0.4). Default: 2 + Maximum width of curve area for curvature determination. Default: 12 + Weighting factor for approximation precision. Default: 1.0 + Weighting factor for large segments. Default: 1.0 + Weighting factor for small segments. Default: 1.0 + Row of the center of an arc. + Column of the center of an arc. + Angle of an arc. + Row of the starting point of an arc. + Column of the starting point of an arc. + Row of the starting point of a line segment. + Column of the starting point of a line segment. + Row of the ending point of a line segment. + Column of the ending point of a line segment. + Sequence of line (value 0) and arc segments (value 1). + + + This operator is inoperable. It had the following function: Destroy all classifiers. + + + Generate a calibration plate description file and a corresponding PostScript file for a calibration plate with rectangularly arranged marks. + Number of marks in x direction. Default: 7 + Number of marks in y direction. Default: 7 + Distance of the marks in meters. Default: 0.0125 + Ratio of the mark diameter to the mark distance. Default: 0.5 + File name of the calibration plate description. Default: "caltab.descr" + File name of the PostScript file. Default: "caltab.ps" + + + Generate a calibration plate description file and a corresponding PostScript file for a calibration plate with hexagonally arranged marks. + Number of rows. Default: 27 + Number of marks per row. Default: 31 + Diameter of the marks. Default: 0.00258065 + Row indices of the finder patterns. Default: [13,6,6,20,20] + Column indices of the finder patterns. Default: [15,6,24,6,24] + Polarity of the marks Default: "light_on_dark" + File name of the calibration plate description. Default: "calplate.cpd" + File name of the PostScript file. Default: "calplate.ps" + + + Generate a calibration plate description file and a corresponding PostScript file for a calibration plate with hexagonally arranged marks. + Number of rows. Default: 27 + Number of marks per row. Default: 31 + Diameter of the marks. Default: 0.00258065 + Row indices of the finder patterns. Default: [13,6,6,20,20] + Column indices of the finder patterns. Default: [15,6,24,6,24] + Polarity of the marks Default: "light_on_dark" + File name of the calibration plate description. Default: "calplate.cpd" + File name of the PostScript file. Default: "calplate.ps" + + + Read the mark center points from the calibration plate description file. + File name of the calibration plate description. Default: "calplate_320mm.cpd" + X coordinates of the mark center points in the coordinate system of the calibration plate. + Y coordinates of the mark center points in the coordinate system of the calibration plate. + Z coordinates of the mark center points in the coordinate system of the calibration plate. + + + This operator is inoperable. It had the following function: Delete all background estimation data sets. + + + This operator is inoperable. It had the following function: Close all image acquisition devices. + + + Represents an instance of a mutex synchronization object. + + + + Create a mutual exclusion synchronization object. + Modified instance represents: Mutex synchronization object. + + Mutex attribute class. Default: [] + Mutex attribute kind. Default: [] + + + + Create a mutual exclusion synchronization object. + Modified instance represents: Mutex synchronization object. + + Mutex attribute class. Default: [] + Mutex attribute kind. Default: [] + + + + Clear the mutex synchronization object. + Instance represents: Mutex synchronization object. + + + + + Unlock a mutex synchronization object. + Instance represents: Mutex synchronization object. + + + + + Lock a mutex synchronization object. + Instance represents: Mutex synchronization object. + + Mutex already locked? + + + + Lock a mutex synchronization object. + Instance represents: Mutex synchronization object. + + + + + Create a mutual exclusion synchronization object. + Modified instance represents: Mutex synchronization object. + + Mutex attribute class. Default: [] + Mutex attribute kind. Default: [] + + + + Create a mutual exclusion synchronization object. + Modified instance represents: Mutex synchronization object. + + Mutex attribute class. Default: [] + Mutex attribute kind. Default: [] + + + Represents an instance of an NCC model for matching. + + + + Read an NCC model from a file. + Modified instance represents: Handle of the model. + + File name. + + + + Prepare an NCC model for matching. + Modified instance represents: Handle of the model. + + Input image whose domain will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Match metric. Default: "use_polarity" + + + + Prepare an NCC model for matching. + Modified instance represents: Handle of the model. + + Input image whose domain will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Match metric. Default: "use_polarity" + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + + Free the memory of an NCC model. + Instance represents: Handle of the model. + + + + + Deserialize an NCC model. + Modified instance represents: Handle of the model. + + Handle of the serialized item. + + + + Serialize an NCC model. + Instance represents: Handle of the model. + + Handle of the serialized item. + + + + Read an NCC model from a file. + Modified instance represents: Handle of the model. + + File name. + + + + Write an NCC model to a file. + Instance represents: Handle of the model. + + File name. + + + Determine the parameters of an NCC model. + Input image whose domain will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the model. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Match metric. Default: "use_polarity" + Parameters to be determined automatically. Default: "all" + Value of the automatically determined parameter. + Name of the automatically determined parameter. + + + Determine the parameters of an NCC model. + Input image whose domain will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the model. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Match metric. Default: "use_polarity" + Parameters to be determined automatically. Default: "all" + Value of the automatically determined parameter. + Name of the automatically determined parameter. + + + + Return the parameters of an NCC model. + Instance represents: Handle of the model. + + Smallest rotation of the pattern. + Extent of the rotation angles. + Step length of the angles (resolution). + Match metric. + Number of pyramid levels. + + + + Return the origin (reference point) of an NCC model. + Instance represents: Handle of the model. + + Row coordinate of the origin of the NCC model. + Column coordinate of the origin of the NCC model. + + + + Set the origin (reference point) of an NCC model. + Instance represents: Handle of the model. + + Row coordinate of the origin of the NCC model. + Column coordinate of the origin of the NCC model. + + + + Find the best matches of an NCC model in an image. + Instance represents: Handle of the model. + + Input image in which the model should be found. + Smallest rotation of the model. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Minimum score of the instances of the model to be found. Default: 0.8 + Number of instances of the model to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the model to be found. Default: 0.5 + Subpixel accuracy. Default: "true" + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + Row coordinate of the found instances of the model. + Column coordinate of the found instances of the model. + Rotation angle of the found instances of the model. + Score of the found instances of the model. + + + + Find the best matches of an NCC model in an image. + Instance represents: Handle of the model. + + Input image in which the model should be found. + Smallest rotation of the model. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Minimum score of the instances of the model to be found. Default: 0.8 + Number of instances of the model to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the model to be found. Default: 0.5 + Subpixel accuracy. Default: "true" + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + Row coordinate of the found instances of the model. + Column coordinate of the found instances of the model. + Rotation angle of the found instances of the model. + Score of the found instances of the model. + + + + Set selected parameters of the NCC model. + Instance represents: Handle of the model. + + Parameter names. + Parameter values. + + + + Prepare an NCC model for matching. + Modified instance represents: Handle of the model. + + Input image whose domain will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Match metric. Default: "use_polarity" + + + + Prepare an NCC model for matching. + Modified instance represents: Handle of the model. + + Input image whose domain will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Match metric. Default: "use_polarity" + + + Find the best matches of multiple NCC models. + Input image in which the model should be found. + Handle of the models. + Smallest rotation of the models. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Minimum score of the instances of the models to be found. Default: 0.8 + Number of instances of the models to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the models to be found. Default: 0.5 + Subpixel accuracy if not equal to 'none'. Default: "true" + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + Row coordinate of the found instances of the models. + Column coordinate of the found instances of the models. + Rotation angle of the found instances of the models. + Score of the found instances of the models. + Index of the found instances of the models. + + + + Find the best matches of multiple NCC models. + Instance represents: Handle of the models. + + Input image in which the model should be found. + Smallest rotation of the models. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Minimum score of the instances of the models to be found. Default: 0.8 + Number of instances of the models to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the models to be found. Default: 0.5 + Subpixel accuracy if not equal to 'none'. Default: "true" + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + Row coordinate of the found instances of the models. + Column coordinate of the found instances of the models. + Rotation angle of the found instances of the models. + Score of the found instances of the models. + Index of the found instances of the models. + + + + Return the region used to create an NCC model. + Instance represents: Handle of the model. + + Model region of the NCC model. + + + Represents an instance of a 3D object model. + + + + Create an empty 3D object model. + Modified instance represents: Handle of the new 3D object model. + + + + + Create a 3D object model that represents a point cloud from a set of 3D points. + Modified instance represents: Handle of the resulting 3D object model. + + The x-coordinates of the points in the 3D point cloud. + The y-coordinates of the points in the 3D point cloud. + The z-coordinates of the points in the 3D point cloud. + + + + Create a 3D object model that represents a point cloud from a set of 3D points. + Modified instance represents: Handle of the resulting 3D object model. + + The x-coordinates of the points in the 3D point cloud. + The y-coordinates of the points in the 3D point cloud. + The z-coordinates of the points in the 3D point cloud. + + + + Transform 3D points from images to a 3D object model. + Modified instance represents: Handle of the 3D object model. + + Image with the X-Coordinates and the ROI of the 3D points. + Image with the Y-Coordinates of the 3D points. + Image with the Z-Coordinates of the 3D points. + + + + Read a 3D object model from a file. + Modified instance represents: Handle of the 3D object model. + + Filename of the file to be read. Default: "mvtec_bunny_normals" + Scale of the data in the file. Default: "m" + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Status information. + + + + Read a 3D object model from a file. + Modified instance represents: Handle of the 3D object model. + + Filename of the file to be read. Default: "mvtec_bunny_normals" + Scale of the data in the file. Default: "m" + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Status information. + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + + Get the result of a calibrated measurement performed with the sheet-of-light technique as a 3D object model. + Modified instance represents: Handle of the resulting 3D object model. + + Handle for accessing the sheet-of-light model. + + + Fit 3D primitives into a set of 3D points. + Handle of the input 3D object model. + Names of the generic parameters. + Values of the generic parameters. + Handle of the output 3D object model. + + + + Fit 3D primitives into a set of 3D points. + Instance represents: Handle of the input 3D object model. + + Names of the generic parameters. + Values of the generic parameters. + Handle of the output 3D object model. + + + Segment a set of 3D points into sub-sets with similar characteristics. + Handle of the input 3D object model. + Names of the generic parameters. + Values of the generic parameters. + Handle of the output 3D object model. + + + + Segment a set of 3D points into sub-sets with similar characteristics. + Instance represents: Handle of the input 3D object model. + + Names of the generic parameters. + Values of the generic parameters. + Handle of the output 3D object model. + + + Calculate the 3D surface normals of a 3D object model. + Handle of the 3D object model containing 3D point data. + Normals calculation method. Default: "mls" + Names of generic smoothing parameters. Default: [] + Values of generic smoothing parameters. Default: [] + Handle of the 3D object model with calculated 3D normals. + + + + Calculate the 3D surface normals of a 3D object model. + Instance represents: Handle of the 3D object model containing 3D point data. + + Normals calculation method. Default: "mls" + Names of generic smoothing parameters. Default: [] + Values of generic smoothing parameters. Default: [] + Handle of the 3D object model with calculated 3D normals. + + + Smooth the 3D points of a 3D object model. + Handle of the 3D object model containing 3D point data. + Smoothing method. Default: "mls" + Names of generic smoothing parameters. Default: [] + Values of generic smoothing parameters. Default: [] + Handle of the 3D object model with the smoothed 3D point data. + + + + Smooth the 3D points of a 3D object model. + Instance represents: Handle of the 3D object model containing 3D point data. + + Smoothing method. Default: "mls" + Names of generic smoothing parameters. Default: [] + Values of generic smoothing parameters. Default: [] + Handle of the 3D object model with the smoothed 3D point data. + + + Create a surface triangulation for a 3D object model. + Handle of the 3D object model containing 3D point data. + Triangulation method. Default: "greedy" + Names of the generic triangulation parameters. Default: [] + Values of the generic triangulation parameters. Default: [] + Additional information about the triangulation process. + Handle of the 3D object model with the triangulated surface. + + + + Create a surface triangulation for a 3D object model. + Instance represents: Handle of the 3D object model containing 3D point data. + + Triangulation method. Default: "greedy" + Names of the generic triangulation parameters. Default: [] + Values of the generic triangulation parameters. Default: [] + Additional information about the triangulation process. + Handle of the 3D object model with the triangulated surface. + + + + Reconstruct surface from calibrated multi-view stereo images. + Modified instance represents: Handle to the resulting surface. + + An image array acquired by the camera setup associated with the stereo model. + Handle of the stereo model. + + + + Refine the position and deformation of a deformable surface model in a 3D scene. + Instance represents: Handle of the 3D object model containing the scene. + + Handle of the deformable surface model. + Relative sampling distance of the scene. Default: 0.05 + Initial deformation of the 3D object model + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Handle of the matching result. + Score of the refined model. + + + + Refine the position and deformation of a deformable surface model in a 3D scene. + Instance represents: Handle of the 3D object model containing the scene. + + Handle of the deformable surface model. + Relative sampling distance of the scene. Default: 0.05 + Initial deformation of the 3D object model + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Handle of the matching result. + Score of the refined model. + + + + Find the best match of a deformable surface model in a 3D scene. + Instance represents: Handle of the 3D object model containing the scene. + + Handle of the deformable surface model. + Scene sampling distance relative to the diameter of the surface model. Default: 0.05 + Minimum score of the returned match. Default: 0 + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Handle of the matching result. + Score of the found instances of the surface model. + + + + Find the best match of a deformable surface model in a 3D scene. + Instance represents: Handle of the 3D object model containing the scene. + + Handle of the deformable surface model. + Scene sampling distance relative to the diameter of the surface model. Default: 0.05 + Minimum score of the returned match. Default: 0 + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Handle of the matching result. + Score of the found instances of the surface model. + + + Add a sample deformation to a deformable surface model + Handle of the deformable surface model. + Handle of the deformed 3D object model. + + + + Add a sample deformation to a deformable surface model + Instance represents: Handle of the deformed 3D object model. + + Handle of the deformable surface model. + + + + Create the data structure needed to perform deformable surface-based matching. + Instance represents: Handle of the 3D object model. + + Sampling distance relative to the object's diameter Default: 0.05 + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Handle of the deformable surface model. + + + + Create the data structure needed to perform deformable surface-based matching. + Instance represents: Handle of the 3D object model. + + Sampling distance relative to the object's diameter Default: 0.05 + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Handle of the deformable surface model. + + + + Refine the pose of a surface model in a 3D scene. + Instance represents: Handle of the 3D object model containing the scene. + + Handle of the surface model. + Initial pose of the surface model in the scene. + Minimum score of the returned poses. Default: 0 + Enable returning a result handle in SurfaceMatchingResultID. Default: "false" + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Score of the found instances of the model. + Handle of the matching result, if enabled in ReturnResultHandle. + 3D pose of the surface model in the scene. + + + + Refine the pose of a surface model in a 3D scene. + Instance represents: Handle of the 3D object model containing the scene. + + Handle of the surface model. + Initial pose of the surface model in the scene. + Minimum score of the returned poses. Default: 0 + Enable returning a result handle in SurfaceMatchingResultID. Default: "false" + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Score of the found instances of the model. + Handle of the matching result, if enabled in ReturnResultHandle. + 3D pose of the surface model in the scene. + + + + Find the best matches of a surface model in a 3D scene. + Instance represents: Handle of the 3D object model containing the scene. + + Handle of the surface model. + Scene sampling distance relative to the diameter of the surface model. Default: 0.05 + Fraction of sampled scene points used as key points. Default: 0.2 + Minimum score of the returned poses. Default: 0 + Enable returning a result handle in SurfaceMatchingResultID. Default: "false" + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Score of the found instances of the surface model. + Handle of the matching result, if enabled in ReturnResultHandle. + 3D pose of the surface model in the scene. + + + + Find the best matches of a surface model in a 3D scene. + Instance represents: Handle of the 3D object model containing the scene. + + Handle of the surface model. + Scene sampling distance relative to the diameter of the surface model. Default: 0.05 + Fraction of sampled scene points used as key points. Default: 0.2 + Minimum score of the returned poses. Default: 0 + Enable returning a result handle in SurfaceMatchingResultID. Default: "false" + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Score of the found instances of the surface model. + Handle of the matching result, if enabled in ReturnResultHandle. + 3D pose of the surface model in the scene. + + + + Create the data structure needed to perform surface-based matching. + Instance represents: Handle of the 3D object model. + + Sampling distance relative to the object's diameter Default: 0.03 + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Handle of the surface model. + + + + Create the data structure needed to perform surface-based matching. + Instance represents: Handle of the 3D object model. + + Sampling distance relative to the object's diameter Default: 0.03 + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Handle of the surface model. + + + Simplify a triangulated 3D object model. + Handle of the 3D object model that should be simplified. + Method that should be used for simplification. Default: "preserve_point_coordinates" + Degree of simplification (default: percentage of remaining model points). + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Handle of the simplified 3D object model. + + + + Simplify a triangulated 3D object model. + Instance represents: Handle of the 3D object model that should be simplified. + + Method that should be used for simplification. Default: "preserve_point_coordinates" + Degree of simplification (default: percentage of remaining model points). + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Handle of the simplified 3D object model. + + + + Compute the distances of the points of one 3D object model to another 3D object model. + Instance represents: Handle of the source 3D object model. + + Handle of the target 3D object model. + Pose of the source 3D object model in the target 3D object model. Default: [] + Maximum distance of interest. Default: 0 + Names of the generic input parameters. Default: [] + Values of the generic input parameters. Default: [] + + + + Compute the distances of the points of one 3D object model to another 3D object model. + Instance represents: Handle of the source 3D object model. + + Handle of the target 3D object model. + Pose of the source 3D object model in the target 3D object model. Default: [] + Maximum distance of interest. Default: 0 + Names of the generic input parameters. Default: [] + Values of the generic input parameters. Default: [] + + + Combine several 3D object models to a new 3D object model. + Handle of input 3D object models. + Method used for the union. Default: "points_surface" + Handle of the resulting 3D object model. + + + + Combine several 3D object models to a new 3D object model. + Instance represents: Handle of input 3D object models. + + Method used for the union. Default: "points_surface" + Handle of the resulting 3D object model. + + + + Set attributes of a 3D object model. + Instance represents: Handle of the 3D object model. + + Name of the attributes. + Defines where extended attributes are attached to. Default: [] + Attribute values. + + + + Set attributes of a 3D object model. + Instance represents: Handle of the 3D object model. + + Name of the attributes. + Defines where extended attributes are attached to. Default: [] + Attribute values. + + + + Set attributes of a 3D object model. + Instance represents: Handle of the input 3D object model. + + Name of the attributes. + Defines where extended attributes are attached to. Default: [] + Attribute values. + Handle of the resulting 3D object model. + + + + Set attributes of a 3D object model. + Instance represents: Handle of the input 3D object model. + + Name of the attributes. + Defines where extended attributes are attached to. Default: [] + Attribute values. + Handle of the resulting 3D object model. + + + + Create an empty 3D object model. + Modified instance represents: Handle of the new 3D object model. + + + + Sample a 3D object model. + Handle of the 3D object model to be sampled. + Selects between the different subsampling methods. Default: "fast" + Sampling distance. Default: 0.05 + Names of the generic parameters that can be adjusted. Default: [] + Values of the generic parameters that can be adjusted. Default: [] + Handle of the 3D object model that contains the sampled points. + + + + Sample a 3D object model. + Instance represents: Handle of the 3D object model to be sampled. + + Selects between the different subsampling methods. Default: "fast" + Sampling distance. Default: 0.05 + Names of the generic parameters that can be adjusted. Default: [] + Values of the generic parameters that can be adjusted. Default: [] + Handle of the 3D object model that contains the sampled points. + + + Improve the relative transformations between 3D object models based on their overlaps. + Handles of several 3D object models. + Approximate relative transformations between the 3D object models. + Type of interpretation for the transformations. Default: "global" + Target indices of the transformations if From specifies the source indices, otherwise the parameter must be empty. Default: [] + Names of the generic parameters that can be adjusted for the global 3D object model registration. Default: [] + Values of the generic parameters that can be adjusted for the global 3D object model registration. Default: [] + Number of overlapping neighbors for each 3D object model. + Resulting Transformations. + + + + Improve the relative transformations between 3D object models based on their overlaps. + Instance represents: Handles of several 3D object models. + + Approximate relative transformations between the 3D object models. + Type of interpretation for the transformations. Default: "global" + Target indices of the transformations if From specifies the source indices, otherwise the parameter must be empty. Default: [] + Names of the generic parameters that can be adjusted for the global 3D object model registration. Default: [] + Values of the generic parameters that can be adjusted for the global 3D object model registration. Default: [] + Number of overlapping neighbors for each 3D object model. + Resulting Transformations. + + + + Search for a transformation between two 3D object models. + Instance represents: Handle of the first 3D object model. + + Handle of the second 3D object model. + Method for the registration. Default: "matching" + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Overlapping of the two 3D object models. + Pose to transform ObjectModel3D1 in the reference frame of ObjectModel3D2. + + + + Search for a transformation between two 3D object models. + Instance represents: Handle of the first 3D object model. + + Handle of the second 3D object model. + Method for the registration. Default: "matching" + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Overlapping of the two 3D object models. + Pose to transform ObjectModel3D1 in the reference frame of ObjectModel3D2. + + + + Create a 3D object model that represents a point cloud from a set of 3D points. + Modified instance represents: Handle of the resulting 3D object model. + + The x-coordinates of the points in the 3D point cloud. + The y-coordinates of the points in the 3D point cloud. + The z-coordinates of the points in the 3D point cloud. + + + + Create a 3D object model that represents a point cloud from a set of 3D points. + Modified instance represents: Handle of the resulting 3D object model. + + The x-coordinates of the points in the 3D point cloud. + The y-coordinates of the points in the 3D point cloud. + The z-coordinates of the points in the 3D point cloud. + + + Create a 3D object model that represents a box. + The pose that describes the position and orientation of the box. The pose has its origin in the center of the box. + The length of the box along the x-axis. + The length of the box along the y-axis. + The length of the box along the z-axis. + Handle of the resulting 3D object model. + + + + Create a 3D object model that represents a box. + Modified instance represents: Handle of the resulting 3D object model. + + The pose that describes the position and orientation of the box. The pose has its origin in the center of the box. + The length of the box along the x-axis. + The length of the box along the y-axis. + The length of the box along the z-axis. + + + + Create a 3D object model that represents a plane. + Modified instance represents: Handle of the resulting 3D object model. + + The center and the rotation of the plane. + x coordinates specifying the extent of the plane. + y coordinates specifying the extent of the plane. + + + + Create a 3D object model that represents a plane. + Modified instance represents: Handle of the resulting 3D object model. + + The center and the rotation of the plane. + x coordinates specifying the extent of the plane. + y coordinates specifying the extent of the plane. + + + Create a 3D object model that represents a sphere from x,y,z coordinates. + The x-coordinate of the center point of the sphere. + The y-coordinate of the center point of the sphere. + The z-coordinate of the center point of the sphere. + The radius of the sphere. + Handle of the resulting 3D object model. + + + + Create a 3D object model that represents a sphere from x,y,z coordinates. + Modified instance represents: Handle of the resulting 3D object model. + + The x-coordinate of the center point of the sphere. + The y-coordinate of the center point of the sphere. + The z-coordinate of the center point of the sphere. + The radius of the sphere. + + + Create a 3D object model that represents a sphere. + The pose that describes the position of the sphere. + The radius of the sphere. + Handle of the resulting 3D object model. + + + + Create a 3D object model that represents a sphere. + Modified instance represents: Handle of the resulting 3D object model. + + The pose that describes the position of the sphere. + The radius of the sphere. + + + Create a 3D object model that represents a cylinder. + The pose that describes the position and orientation of the cylinder. + The radius of the cylinder. + Lowest z-coordinate of the cylinder in the direction of the rotation axis. + Highest z-coordinate of the cylinder in the direction of the rotation axis. + Handle of the resulting 3D object model. + + + + Create a 3D object model that represents a cylinder. + Modified instance represents: Handle of the resulting 3D object model. + + The pose that describes the position and orientation of the cylinder. + The radius of the cylinder. + Lowest z-coordinate of the cylinder in the direction of the rotation axis. + Highest z-coordinate of the cylinder in the direction of the rotation axis. + + + Calculate the smallest bounding box around the points of a 3D object model. + Handle of the 3D object model. + The method that is used to estimate the smallest box. Default: "oriented" + The length of the longest side of the box. + The length of the second longest side of the box. + The length of the third longest side of the box. + The pose that describes the position and orientation of the box that is generated. The pose has its origin in the center of the box and is oriented such that the x-axis is aligned with the longest side of the box. + + + + Calculate the smallest bounding box around the points of a 3D object model. + Instance represents: Handle of the 3D object model. + + The method that is used to estimate the smallest box. Default: "oriented" + The length of the longest side of the box. + The length of the second longest side of the box. + The length of the third longest side of the box. + The pose that describes the position and orientation of the box that is generated. The pose has its origin in the center of the box and is oriented such that the x-axis is aligned with the longest side of the box. + + + Calculate the smallest sphere around the points of a 3D object model. + Handle of the 3D object model. + The estimated radius of the sphere. + x-, y-, and z-coordinates describing the center point of the sphere. + + + + Calculate the smallest sphere around the points of a 3D object model. + Instance represents: Handle of the 3D object model. + + The estimated radius of the sphere. + x-, y-, and z-coordinates describing the center point of the sphere. + + + Intersect a 3D object model with a plane. + Handle of the 3D object model. + Pose of the plane. Default: [0,0,0,0,0,0,0] + Handle of the 3D object model that describes the intersection as a set of lines. + + + + Intersect a 3D object model with a plane. + Instance represents: Handle of the 3D object model. + + Pose of the plane. Default: [0,0,0,0,0,0,0] + Handle of the 3D object model that describes the intersection as a set of lines. + + + Calculate the convex hull of a 3D object model. + Handle of the 3D object model. + Handle of the 3D object model that describes the convex hull. + + + + Calculate the convex hull of a 3D object model. + Instance represents: Handle of the 3D object model. + + Handle of the 3D object model that describes the convex hull. + + + Select 3D object models from an array of 3D object models according to global features. + Handles of the available 3D object models to select. + List of features a test is performed on. Default: "has_triangles" + Logical operation to combine the features given in Feature. Default: "and" + Minimum value for the given feature. Default: 1 + Maximum value for the given feature. Default: 1 + A subset of ObjectModel3D fulfilling the given conditions. + + + + Select 3D object models from an array of 3D object models according to global features. + Instance represents: Handles of the available 3D object models to select. + + List of features a test is performed on. Default: "has_triangles" + Logical operation to combine the features given in Feature. Default: "and" + Minimum value for the given feature. Default: 1 + Maximum value for the given feature. Default: 1 + A subset of ObjectModel3D fulfilling the given conditions. + + + Calculate the area of all faces of a 3D object model. + Handle of the 3D object model. + Calculated area. + + + + Calculate the area of all faces of a 3D object model. + Instance represents: Handle of the 3D object model. + + Calculated area. + + + Calculate the maximal diameter of a 3D object model. + Handle of the 3D object model. + Calculated diameter. + + + + Calculate the maximal diameter of a 3D object model. + Instance represents: Handle of the 3D object model. + + Calculated diameter. + + + Calculates the mean or the central moment of second order for a 3D object model. + Handle of the 3D object model. + Moment to calculate. Default: "mean_points" + Calculated moment. + + + + Calculates the mean or the central moment of second order for a 3D object model. + Instance represents: Handle of the 3D object model. + + Moment to calculate. Default: "mean_points" + Calculated moment. + + + Calculate the volume of a 3D object model. + Handle of the 3D object model. + Pose of the plane. Default: [0,0,0,0,0,0,0] + Method to combine volumes laying above and below the reference plane. Default: "signed" + Decides whether the orientation of a face should affect the resulting sign of the underlying volume. Default: "true" + Absolute value of the calculated volume. + + + + Calculate the volume of a 3D object model. + Instance represents: Handle of the 3D object model. + + Pose of the plane. Default: [0,0,0,0,0,0,0] + Method to combine volumes laying above and below the reference plane. Default: "signed" + Decides whether the orientation of a face should affect the resulting sign of the underlying volume. Default: "true" + Absolute value of the calculated volume. + + + Remove points from a 3D object model by projecting it to a virtual view and removing all points outside of a given region. + Region in the image plane. + Handle of the 3D object model. + Internal camera parameters. + 3D pose of the world coordinate system in camera coordinates. + Handle of the reduced 3D object model. + + + + Remove points from a 3D object model by projecting it to a virtual view and removing all points outside of a given region. + Instance represents: Handle of the 3D object model. + + Region in the image plane. + Internal camera parameters. + 3D pose of the world coordinate system in camera coordinates. + Handle of the reduced 3D object model. + + + Determine the connected components of the 3D object model. + Handle of the 3D object model. + Attribute used to calculate the connected components. Default: "distance_3d" + Maximum value for the distance between two connected components. Default: 1.0 + Handle of the 3D object models that represent the connected components. + + + + Determine the connected components of the 3D object model. + Instance represents: Handle of the 3D object model. + + Attribute used to calculate the connected components. Default: "distance_3d" + Maximum value for the distance between two connected components. Default: 1.0 + Handle of the 3D object models that represent the connected components. + + + Apply a threshold to an attribute of 3D object models. + Handle of the 3D object models. + Attributes the threshold is applied to. Default: "point_coord_z" + Minimum value for the attributes specified by Attrib. Default: 0.5 + Maximum value for the attributes specified by Attrib. Default: 1.0 + Handle of the reduced 3D object models. + + + + Apply a threshold to an attribute of 3D object models. + Instance represents: Handle of the 3D object models. + + Attributes the threshold is applied to. Default: "point_coord_z" + Minimum value for the attributes specified by Attrib. Default: 0.5 + Maximum value for the attributes specified by Attrib. Default: 1.0 + Handle of the reduced 3D object models. + + + Get the depth or the index of a displayed 3D object model. + Window handle. + Row coordinates. + Column coordinates. + Information. Default: "depth" + Indices or the depth of the objects at (Row,Column). + + + Get the depth or the index of a displayed 3D object model. + Window handle. + Row coordinates. + Column coordinates. + Information. Default: "depth" + Indices or the depth of the objects at (Row,Column). + + + Render 3D object models to get an image. + Handles of the 3D object models. + Camera parameters of the scene. + 3D poses of the objects. + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Rendered scene. + + + + Render 3D object models to get an image. + Instance represents: Handles of the 3D object models. + + Camera parameters of the scene. + 3D poses of the objects. + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Rendered scene. + + + Display 3D object models. + Window handle. + Handles of the 3D object models. + Camera parameters of the scene. Default: [] + 3D poses of the objects. Default: [] + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + + + + Display 3D object models. + Instance represents: Handles of the 3D object models. + + Window handle. + Camera parameters of the scene. Default: [] + 3D poses of the objects. Default: [] + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + + + + Copy a 3D object model. + Instance represents: Handle of the input 3D object model. + + Attributes to be copied. Default: "all" + Handle of the copied 3D object model. + + + + Copy a 3D object model. + Instance represents: Handle of the input 3D object model. + + Attributes to be copied. Default: "all" + Handle of the copied 3D object model. + + + Prepare a 3D object model for a certain operation. + Handle of the 3D object model. + Purpose of the 3D object model. Default: "shape_based_matching_3d" + Specify if already existing data should be overwritten. Default: "true" + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + + + + Prepare a 3D object model for a certain operation. + Instance represents: Handle of the 3D object model. + + Purpose of the 3D object model. Default: "shape_based_matching_3d" + Specify if already existing data should be overwritten. Default: "true" + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + + + + Transform 3D points from a 3D object model to images. + Instance represents: Handle of the 3D object model. + + Image with the Y-Coordinates of the 3D points. + Image with the Z-Coordinates of the 3D points. + Type of the conversion. Default: "cartesian" + Camera parameters. + Pose of the 3D object model. + Image with the X-Coordinates of the 3D points. + + + + Transform 3D points from images to a 3D object model. + Modified instance represents: Handle of the 3D object model. + + Image with the X-Coordinates and the ROI of the 3D points. + Image with the Y-Coordinates of the 3D points. + Image with the Z-Coordinates of the 3D points. + + + Return attributes of 3D object models. + Handle of the 3D object model. + Names of the generic attributes that are queried for the 3D object model. Default: "num_points" + Values of the generic parameters. + + + + Return attributes of 3D object models. + Instance represents: Handle of the 3D object model. + + Names of the generic attributes that are queried for the 3D object model. Default: "num_points" + Values of the generic parameters. + + + + Project a 3D object model into image coordinates. + Instance represents: Handle of the 3D object model. + + Internal camera parameters. + 3D pose of the world coordinate system in camera coordinates. + Name of the generic parameter. Default: [] + Value of the generic parameter. Default: [] + Projected model contours. + + + + Project a 3D object model into image coordinates. + Instance represents: Handle of the 3D object model. + + Internal camera parameters. + 3D pose of the world coordinate system in camera coordinates. + Name of the generic parameter. Default: [] + Value of the generic parameter. Default: [] + Projected model contours. + + + Apply a rigid 3D transformation to 3D object models. + Handles of the 3D object models. + Poses. + Handles of the transformed 3D object models. + + + + Apply a rigid 3D transformation to 3D object models. + Instance represents: Handles of the 3D object models. + + Poses. + Handles of the transformed 3D object models. + + + Apply an arbitrary projective 3D transformation to 3D object models. + Handles of the 3D object models. + Homogeneous projective transformation matrix. + Handles of the transformed 3D object models. + + + + Apply an arbitrary projective 3D transformation to 3D object models. + Instance represents: Handles of the 3D object models. + + Homogeneous projective transformation matrix. + Handles of the transformed 3D object models. + + + Apply an arbitrary affine 3D transformation to 3D object models. + Handles of the 3D object models. + Transformation matrices. + Handles of the transformed 3D object models. + + + + Apply an arbitrary affine 3D transformation to 3D object models. + Instance represents: Handles of the 3D object models. + + Transformation matrices. + Handles of the transformed 3D object models. + + + Free the memory of a 3D object model. + Handle of the 3D object model. + + + + Free the memory of a 3D object model. + Instance represents: Handle of the 3D object model. + + + + + Serialize a 3D object model. + Instance represents: Handle of the 3D object model. + + Handle of the serialized item. + + + + Deserialize a serialized 3D object model. + Modified instance represents: Handle of the 3D object model. + + Handle of the serialized item. + + + + Writes a 3D object model to a file. + Instance represents: Handle of the 3D object model. + + Type of the file that is written. Default: "om3" + Name of the file that is written. + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + + + + Writes a 3D object model to a file. + Instance represents: Handle of the 3D object model. + + Type of the file that is written. Default: "om3" + Name of the file that is written. + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + + + + Read a 3D object model from a file. + Modified instance represents: Handle of the 3D object model. + + Filename of the file to be read. Default: "mvtec_bunny_normals" + Scale of the data in the file. Default: "m" + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Status information. + + + + Read a 3D object model from a file. + Modified instance represents: Handle of the 3D object model. + + Filename of the file to be read. Default: "mvtec_bunny_normals" + Scale of the data in the file. Default: "m" + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Status information. + + + Compute the calibrated scene flow between two stereo image pairs. + Input image 1 at time @f$t_{1}$t_1. + Input image 2 at time @f$t_{1}$t_1. + Input image 1 at time @f$t_{2}$t_2. + Input image 2 at time @f$t_{2}$t_2. + Disparity between input images 1 and 2 at time @f$t_{1}$t_1. + Weight of the regularization term relative to the data term (derivatives of the optical flow). Default: 40.0 + Weight of the regularization term relative to the data term (derivatives of the disparity change). Default: 40.0 + Parameter name(s) for the algorithm. Default: "default_parameters" + Parameter value(s) for the algorithm. Default: "accurate" + Internal camera parameters of the rectified camera 1. + Internal camera parameters of the rectified camera 2. + Pose of the rectified camera 2 in relation to the rectified camera 1. + Handle of the 3D object model. + + + + Compute the calibrated scene flow between two stereo image pairs. + Modified instance represents: Handle of the 3D object model. + + Input image 1 at time @f$t_{1}$t_1. + Input image 2 at time @f$t_{1}$t_1. + Input image 1 at time @f$t_{2}$t_2. + Input image 2 at time @f$t_{2}$t_2. + Disparity between input images 1 and 2 at time @f$t_{1}$t_1. + Weight of the regularization term relative to the data term (derivatives of the optical flow). Default: 40.0 + Weight of the regularization term relative to the data term (derivatives of the disparity change). Default: 40.0 + Parameter name(s) for the algorithm. Default: "default_parameters" + Parameter value(s) for the algorithm. Default: "accurate" + Internal camera parameters of the rectified camera 1. + Internal camera parameters of the rectified camera 2. + Pose of the rectified camera 2 in relation to the rectified camera 1. + + + + Find edges in a 3D object model. + Instance represents: Handle of the 3D object model whose edges should be computed. + + Edge threshold. + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + 3D object model containing the edges. + + + + Find edges in a 3D object model. + Instance represents: Handle of the 3D object model whose edges should be computed. + + Edge threshold. + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + 3D object model containing the edges. + + + + Find the best matches of a surface model in a 3D scene and images. + Instance represents: Handle of the 3D object model containing the scene. + + Images of the scene. + Handle of the surface model. + Scene sampling distance relative to the diameter of the surface model. Default: 0.05 + Fraction of sampled scene points used as key points. Default: 0.2 + Minimum score of the returned poses. Default: 0 + Enable returning a result handle in SurfaceMatchingResultID. Default: "false" + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Score of the found instances of the surface model. + Handle of the matching result, if enabled in ReturnResultHandle. + 3D pose of the surface model in the scene. + + + + Find the best matches of a surface model in a 3D scene and images. + Instance represents: Handle of the 3D object model containing the scene. + + Images of the scene. + Handle of the surface model. + Scene sampling distance relative to the diameter of the surface model. Default: 0.05 + Fraction of sampled scene points used as key points. Default: 0.2 + Minimum score of the returned poses. Default: 0 + Enable returning a result handle in SurfaceMatchingResultID. Default: "false" + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Score of the found instances of the surface model. + Handle of the matching result, if enabled in ReturnResultHandle. + 3D pose of the surface model in the scene. + + + + Refine the pose of a surface model in a 3D scene and in images. + Instance represents: Handle of the 3D object model containing the scene. + + Images of the scene. + Handle of the surface model. + Initial pose of the surface model in the scene. + Minimum score of the returned poses. Default: 0 + Enable returning a result handle in SurfaceMatchingResultID. Default: "false" + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Score of the found instances of the model. + Handle of the matching result, if enabled in ReturnResultHandle. + 3D pose of the surface model in the scene. + + + + Refine the pose of a surface model in a 3D scene and in images. + Instance represents: Handle of the 3D object model containing the scene. + + Images of the scene. + Handle of the surface model. + Initial pose of the surface model in the scene. + Minimum score of the returned poses. Default: 0 + Enable returning a result handle in SurfaceMatchingResultID. Default: "false" + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Score of the found instances of the model. + Handle of the matching result, if enabled in ReturnResultHandle. + 3D pose of the surface model in the scene. + + + Fuse 3D object models into a surface. + Handles of the 3D object models. + The two opposite bound box corners. + Used resolution within the bounding box. Default: 1.0 + Distance of expected noise to surface. Default: 1.0 + Minimum thickness of the object in direction of the surface normal. Default: 1.0 + Weight factor for data fidelity. Default: 1.0 + Direction of normals of the input models. Default: "inwards" + Name of the generic parameter. Default: [] + Value of the generic parameter. Default: [] + Handle of the fused 3D object model. + + + + Fuse 3D object models into a surface. + Instance represents: Handles of the 3D object models. + + The two opposite bound box corners. + Used resolution within the bounding box. Default: 1.0 + Distance of expected noise to surface. Default: 1.0 + Minimum thickness of the object in direction of the surface normal. Default: 1.0 + Weight factor for data fidelity. Default: 1.0 + Direction of normals of the input models. Default: "inwards" + Name of the generic parameter. Default: [] + Value of the generic parameter. Default: [] + Handle of the fused 3D object model. + + + Represents an instance of an OCR box classifier. + + + + Read an OCR classifier from a file. + Modified instance represents: ID of the read OCR classifier. + + Name of the OCR classifier file. Default: "testnet" + + + + Create a new OCR-classifier. + Modified instance represents: ID of the created OCR classifier. + + Width of the input layer of the network. Default: 8 + Height of the input layer of the network. Default: 10 + Interpolation mode concerning scaling of characters. Default: 1 + Additional features. Default: "default" + All characters of a set. Default: ["a","b","c"] + + + + Create a new OCR-classifier. + Modified instance represents: ID of the created OCR classifier. + + Width of the input layer of the network. Default: 8 + Height of the input layer of the network. Default: 10 + Interpolation mode concerning scaling of characters. Default: 1 + Additional features. Default: "default" + All characters of a set. Default: ["a","b","c"] + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + + Serialize an OCR classifier. + Instance represents: ID of the OCR classifier. + + Handle of the serialized item. + + + + Deserialize a serialized OCR classifier. + Modified instance represents: ID of the OCR classifier. + + Handle of the serialized item. + + + + Writing an OCR classifier into a file. + Instance represents: ID of the OCR classifier. + + Name of the file for the OCR classifier (without extension). Default: "my_ocr" + + + + Read an OCR classifier from a file. + Modified instance represents: ID of the read OCR classifier. + + Name of the OCR classifier file. Default: "testnet" + + + + Classify one character. + Instance represents: ID of the OCR classifier. + + Character to be recognized. + Gray values of the characters. + Confidence values of the characters. + Classes (names) of the characters. + + + + Classify characters. + Instance represents: ID of the OCR classifier. + + Characters to be recognized. + Gray values for the characters. + Confidence values of the characters. + Class (name) of the characters. + + + + Classify characters. + Instance represents: ID of the OCR classifier. + + Characters to be recognized. + Gray values for the characters. + Confidence values of the characters. + Class (name) of the characters. + + + + Get information about an OCR classifier. + Instance represents: ID of the OCR classifier. + + Width of the scaled characters. + Height of the scaled characters. + Interpolation mode for scaling the characters. + Width of the largest trained character. + Height of the largest trained character. + Used features. + All characters of the set. + + + + Create a new OCR-classifier. + Modified instance represents: ID of the created OCR classifier. + + Width of the input layer of the network. Default: 8 + Height of the input layer of the network. Default: 10 + Interpolation mode concerning scaling of characters. Default: 1 + Additional features. Default: "default" + All characters of a set. Default: ["a","b","c"] + + + + Create a new OCR-classifier. + Modified instance represents: ID of the created OCR classifier. + + Width of the input layer of the network. Default: 8 + Height of the input layer of the network. Default: 10 + Interpolation mode concerning scaling of characters. Default: 1 + Additional features. Default: "default" + All characters of a set. Default: ["a","b","c"] + + + + Train an OCR classifier by the input of regions. + Instance represents: ID of the desired OCR-classifier. + + Characters to be trained. + Gray values for the characters. + Class (name) of the characters. Default: "a" + Average confidence during a re-classification of the trained characters. + + + + Train an OCR classifier by the input of regions. + Instance represents: ID of the desired OCR-classifier. + + Characters to be trained. + Gray values for the characters. + Class (name) of the characters. Default: "a" + Average confidence during a re-classification of the trained characters. + + + + Train an OCR classifier with the help of a training file. + Instance represents: ID of the desired OCR-network. + + Names of the training files. Default: "train_ocr" + Average confidence during a re-classification of the trained characters. + + + + Train an OCR classifier with the help of a training file. + Instance represents: ID of the desired OCR-network. + + Names of the training files. Default: "train_ocr" + Average confidence during a re-classification of the trained characters. + + + + Define a new conversion table for the characters. + Instance represents: ID of the OCR-network to be changed. + + New assign of characters. Default: ["a","b","c"] + + + + Deallocation of the memory of an OCR classifier. + Instance represents: ID of the OCR classifier to be deleted. + + + + + Test an OCR classifier. + Instance represents: ID of the desired OCR-classifier. + + Characters to be tested. + Gray values for the characters. + Class (name) of the characters. Default: "a" + Confidence for the character to belong to the class. + + + + Test an OCR classifier. + Instance represents: ID of the desired OCR-classifier. + + Characters to be tested. + Gray values for the characters. + Class (name) of the characters. Default: "a" + Confidence for the character to belong to the class. + + + + Access the features which correspond to a character. + Instance represents: ID of the desired OCR-classifier. + + Characters to be trained. + Feature vector. + + + Represents an instance of a CNN OCR classifier. + + + + Read an CNN-based OCR classifier from a file. + Modified instance represents: Handle of the OCR classifier. + + File name. Default: "Universal_Rej.occ" + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + Clear an CNN-based OCR classifier. + Handle of the OCR classifier. + + + + Clear an CNN-based OCR classifier. + Instance represents: Handle of the OCR classifier. + + + + + Deserialize a serialized CNN-based OCR classifier. + Modified instance represents: Handle of the OCR classifier. + + Handle of the serialized item. + + + + Classify multiple characters with an CNN-based OCR classifier. + Instance represents: Handle of the OCR classifier. + + Characters to be recognized. + Gray values of the characters. + Confidence of the class of the characters. + Result of classifying the characters with the CNN. + + + + Classify multiple characters with an CNN-based OCR classifier. + Instance represents: Handle of the OCR classifier. + + Characters to be recognized. + Gray values of the characters. + Confidence of the class of the characters. + Result of classifying the characters with the CNN. + + + + Classify a single character with an CNN-based OCR classifier. + Instance represents: Handle of the OCR classifier. + + Character to be recognized. + Gray values of the character. + Number of best classes to determine. Default: 1 + Confidence(s) of the class(es) of the character. + Result of classifying the character with the CNN. + + + + Classify a single character with an CNN-based OCR classifier. + Instance represents: Handle of the OCR classifier. + + Character to be recognized. + Gray values of the character. + Number of best classes to determine. Default: 1 + Confidence(s) of the class(es) of the character. + Result of classifying the character with the CNN. + + + + Classify a related group of characters with an CNN-based OCR classifier. + Instance represents: Handle of the OCR classifier. + + Characters to be recognized. + Gray values of the characters. + Expression describing the allowed word structure. + Number of classes per character considered for the internal word correction. Default: 3 + Maximum number of corrected characters. Default: 2 + Confidence of the class of the characters. + Word text after classification and correction. + Measure of similarity between corrected word and uncorrected classification results. + Result of classifying the characters with the CNN. + + + + Classify a related group of characters with an CNN-based OCR classifier. + Instance represents: Handle of the OCR classifier. + + Characters to be recognized. + Gray values of the characters. + Expression describing the allowed word structure. + Number of classes per character considered for the internal word correction. Default: 3 + Maximum number of corrected characters. Default: 2 + Confidence of the class of the characters. + Word text after classification and correction. + Measure of similarity between corrected word and uncorrected classification results. + Result of classifying the characters with the CNN. + + + + Return the parameters of a CNN-based OCR classifier. + Instance represents: Handle of the OCR classifier. + + A tuple of generic parameter names. Default: "characters" + A tuple of generic parameter values. + + + + Return the parameters of a CNN-based OCR classifier. + Instance represents: Handle of the OCR classifier. + + A tuple of generic parameter names. Default: "characters" + A tuple of generic parameter values. + + + + Get the names of the parameters that can be used in get_params_ocr_class_cnn for a given CNN-based OCR classifier. + Instance represents: Handle of OCR classifier. + + Names of the generic parameters. + + + + Read an CNN-based OCR classifier from a file. + Modified instance represents: Handle of the OCR classifier. + + File name. Default: "Universal_Rej.occ" + + + + Serialize a CNN-based OCR classifier + Instance represents: Handle of the OCR classifier. + + Handle of the serialized item. + + + Represents an instance of a k-NearestNeighbor OCR classifier. + + + + Read an OCR classifier from a file. + Modified instance represents: Handle of the OCR classifier. + + File name. + + + + Create an OCR classifier using a k-Nearest Neighbor (k-NN) classifier. + Modified instance represents: Handle of the k-NN classifier. + + Width of the rectangle to which the gray values of the segmented character are zoomed. Default: 8 + Height of the rectangle to which the gray values of the segmented character are zoomed. Default: 10 + Interpolation mode for the zooming of the characters. Default: "constant" + Features to be used for classification. Default: "default" + All characters of the character set to be read. Default: ["0","1","2","3","4","5","6","7","8","9"] + This parameter is not yet supported. Default: [] + This parameter is not yet supported. Default: [] + + + + Create an OCR classifier using a k-Nearest Neighbor (k-NN) classifier. + Modified instance represents: Handle of the k-NN classifier. + + Width of the rectangle to which the gray values of the segmented character are zoomed. Default: 8 + Height of the rectangle to which the gray values of the segmented character are zoomed. Default: 10 + Interpolation mode for the zooming of the characters. Default: "constant" + Features to be used for classification. Default: "default" + All characters of the character set to be read. Default: ["0","1","2","3","4","5","6","7","8","9"] + This parameter is not yet supported. Default: [] + This parameter is not yet supported. Default: [] + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + + Classify a related group of characters with an OCR classifier. + Instance represents: Handle of the OCR classifier. + + Characters to be recognized. + Gray values of the characters. + Expression describing the allowed word structure. + Number of classes per character considered for the internal word correction. Default: 3 + Maximum number of corrected characters. Default: 2 + Confidence of the class of the characters. + Word text after classification and correction. + Measure of similarity between corrected word and uncorrected classification results. + Result of classifying the characters with the k-NN. + + + + Classify a related group of characters with an OCR classifier. + Instance represents: Handle of the OCR classifier. + + Characters to be recognized. + Gray values of the characters. + Expression describing the allowed word structure. + Number of classes per character considered for the internal word correction. Default: 3 + Maximum number of corrected characters. Default: 2 + Confidence of the class of the characters. + Word text after classification and correction. + Measure of similarity between corrected word and uncorrected classification results. + Result of classifying the characters with the k-NN. + + + + Deserialize a serialized k-NN-based OCR classifier. + Modified instance represents: Handle of the OCR classifier. + + Handle of the serialized item. + + + + Serialize a k-NN-based OCR classifier. + Instance represents: Handle of the OCR classifier. + + Handle of the serialized item. + + + + Read an OCR classifier from a file. + Modified instance represents: Handle of the OCR classifier. + + File name. + + + + Write a k-NN classifier for an OCR task to a file. + Instance represents: Handle of the k-NN classifier for an OCR task. + + File name. + + + + Clear an OCR classifier. + Instance represents: Handle of the OCR classifier. + + + + + Create an OCR classifier using a k-Nearest Neighbor (k-NN) classifier. + Modified instance represents: Handle of the k-NN classifier. + + Width of the rectangle to which the gray values of the segmented character are zoomed. Default: 8 + Height of the rectangle to which the gray values of the segmented character are zoomed. Default: 10 + Interpolation mode for the zooming of the characters. Default: "constant" + Features to be used for classification. Default: "default" + All characters of the character set to be read. Default: ["0","1","2","3","4","5","6","7","8","9"] + This parameter is not yet supported. Default: [] + This parameter is not yet supported. Default: [] + + + + Create an OCR classifier using a k-Nearest Neighbor (k-NN) classifier. + Modified instance represents: Handle of the k-NN classifier. + + Width of the rectangle to which the gray values of the segmented character are zoomed. Default: 8 + Height of the rectangle to which the gray values of the segmented character are zoomed. Default: 10 + Interpolation mode for the zooming of the characters. Default: "constant" + Features to be used for classification. Default: "default" + All characters of the character set to be read. Default: ["0","1","2","3","4","5","6","7","8","9"] + This parameter is not yet supported. Default: [] + This parameter is not yet supported. Default: [] + + + + Trains an k-NN classifier for an OCR task. + Instance represents: Handle of the k-NN classifier. + + Names of the training files. Default: "ocr.trf" + Names of the generic parameters that can be adjusted for the k-NN classifier creation. Default: [] + Values of the generic parameters that can be adjusted for the k-NN classifier creation. Default: [] + + + + Trains an k-NN classifier for an OCR task. + Instance represents: Handle of the k-NN classifier. + + Names of the training files. Default: "ocr.trf" + Names of the generic parameters that can be adjusted for the k-NN classifier creation. Default: [] + Values of the generic parameters that can be adjusted for the k-NN classifier creation. Default: [] + + + + Compute the features of a character. + Instance represents: Handle of the k-NN classifier. + + Input character. + Should the feature vector be transformed with the preprocessing? Default: "true" + Feature vector of the character. + + + + Return the parameters of an OCR classifier. + Instance represents: Handle of the OCR classifier. + + Width of the rectangle to which the gray values of the segmented character are zoomed. + Height of the rectangle to which the gray values of the segmented character are zoomed. + Interpolation mode for the zooming of the characters. + Features to be used for classification. + Characters of the character set to be read. + Type of preprocessing used to transform the feature vectors. + Number of different trees used during the classifcation. + + + + Return the parameters of an OCR classifier. + Instance represents: Handle of the OCR classifier. + + Width of the rectangle to which the gray values of the segmented character are zoomed. + Height of the rectangle to which the gray values of the segmented character are zoomed. + Interpolation mode for the zooming of the characters. + Features to be used for classification. + Characters of the character set to be read. + Type of preprocessing used to transform the feature vectors. + Number of different trees used during the classifcation. + + + + Classify multiple characters with an k-NN classifier. + Instance represents: Handle of the k-NN classifier. + + Characters to be recognized. + Gray values of the characters. + Confidence of the class of the characters. + Result of classifying the characters with the k-NN. + + + + Classify multiple characters with an k-NN classifier. + Instance represents: Handle of the k-NN classifier. + + Characters to be recognized. + Gray values of the characters. + Confidence of the class of the characters. + Result of classifying the characters with the k-NN. + + + + Classify a single character with an OCR classifier. + Instance represents: Handle of the k-NN classifier. + + Character to be recognized. + Gray values of the character. + Number of maximal classes to determine. Default: 1 + Number of neighbors to consider. Default: 1 + Confidence(s) of the class(es) of the character. + Results of classifying the character with the k-NN. + + + + Classify a single character with an OCR classifier. + Instance represents: Handle of the k-NN classifier. + + Character to be recognized. + Gray values of the character. + Number of maximal classes to determine. Default: 1 + Number of neighbors to consider. Default: 1 + Confidence(s) of the class(es) of the character. + Results of classifying the character with the k-NN. + + + + Select an optimal combination of features to classify OCR data. + Modified instance represents: Trained OCR-k-NN classifier. + + Names of the training files. Default: "" + List of features that should be considered for selection. Default: ["zoom_factor","ratio","width","height","foreground","foreground_grid_9","foreground_grid_16","anisometry","compactness","convexity","moments_region_2nd_invar","moments_region_2nd_rel_invar","moments_region_3rd_invar","moments_central","phi","num_connect","num_holes","projection_horizontal","projection_vertical","projection_horizontal_invar","projection_vertical_invar","chord_histo","num_runs","pixel","pixel_invar","pixel_binary","gradient_8dir","cooc","moments_gray_plane"] + Method to perform the selection. Default: "greedy" + Width of the rectangle to which the gray values of the segmented character are zoomed. Default: 15 + Height of the rectangle to which the gray values of the segmented character are zoomed. Default: 16 + Names of generic parameters to configure the selection process and the classifier. Default: [] + Values of generic parameters to configure the selection process and the classifier. Default: [] + Achieved score using tow-fold cross-validation. + Selected feature set, contains only entries from FeatureList. + + + + Select an optimal combination of features to classify OCR data. + Modified instance represents: Trained OCR-k-NN classifier. + + Names of the training files. Default: "" + List of features that should be considered for selection. Default: ["zoom_factor","ratio","width","height","foreground","foreground_grid_9","foreground_grid_16","anisometry","compactness","convexity","moments_region_2nd_invar","moments_region_2nd_rel_invar","moments_region_3rd_invar","moments_central","phi","num_connect","num_holes","projection_horizontal","projection_vertical","projection_horizontal_invar","projection_vertical_invar","chord_histo","num_runs","pixel","pixel_invar","pixel_binary","gradient_8dir","cooc","moments_gray_plane"] + Method to perform the selection. Default: "greedy" + Width of the rectangle to which the gray values of the segmented character are zoomed. Default: 15 + Height of the rectangle to which the gray values of the segmented character are zoomed. Default: 16 + Names of generic parameters to configure the selection process and the classifier. Default: [] + Values of generic parameters to configure the selection process and the classifier. Default: [] + Achieved score using tow-fold cross-validation. + Selected feature set, contains only entries from FeatureList. + + + Represents an instance of a MLP OCR classifier. + + + + Read an OCR classifier from a file. + Modified instance represents: Handle of the OCR classifier. + + File name. + + + + Create an OCR classifier using a multilayer perceptron. + Modified instance represents: Handle of the OCR classifier. + + Width of the rectangle to which the gray values of the segmented character are zoomed. Default: 8 + Height of the rectangle to which the gray values of the segmented character are zoomed. Default: 10 + Interpolation mode for the zooming of the characters. Default: "constant" + Features to be used for classification. Default: "default" + All characters of the character set to be read. Default: ["0","1","2","3","4","5","6","7","8","9"] + Number of hidden units of the MLP. Default: 80 + Type of preprocessing used to transform the feature vectors. Default: "none" + Preprocessing parameter: Number of transformed features (ignored for Preprocessing $=$ 'none' and Preprocessing $=$ 'normalization'). Default: 10 + Seed value of the random number generator that is used to initialize the MLP with random values. Default: 42 + + + + Create an OCR classifier using a multilayer perceptron. + Modified instance represents: Handle of the OCR classifier. + + Width of the rectangle to which the gray values of the segmented character are zoomed. Default: 8 + Height of the rectangle to which the gray values of the segmented character are zoomed. Default: 10 + Interpolation mode for the zooming of the characters. Default: "constant" + Features to be used for classification. Default: "default" + All characters of the character set to be read. Default: ["0","1","2","3","4","5","6","7","8","9"] + Number of hidden units of the MLP. Default: 80 + Type of preprocessing used to transform the feature vectors. Default: "none" + Preprocessing parameter: Number of transformed features (ignored for Preprocessing $=$ 'none' and Preprocessing $=$ 'normalization'). Default: 10 + Seed value of the random number generator that is used to initialize the MLP with random values. Default: 42 + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + + Select an optimal combination of features to classify OCR data from a (protected) training file. + Modified instance represents: Trained OCR-MLP classifier. + + Names of the training files. Default: "" + Passwords for protected training files. + List of features that should be considered for selection. Default: ["zoom_factor","ratio","width","height","foreground","foreground_grid_9","foreground_grid_16","anisometry","compactness","convexity","moments_region_2nd_invar","moments_region_2nd_rel_invar","moments_region_3rd_invar","moments_central","phi","num_connect","num_holes","projection_horizontal","projection_vertical","projection_horizontal_invar","projection_vertical_invar","chord_histo","num_runs","pixel","pixel_invar","pixel_binary","gradient_8dir","cooc","moments_gray_plane"] + Method to perform the selection. Default: "greedy" + Width of the rectangle to which the gray values of the segmented character are zoomed. Default: 15 + Height of the rectangle to which the gray values of the segmented character are zoomed. Default: 16 + Names of generic parameters to configure the selection process and the classifier. Default: [] + Values of generic parameters to configure the selection process and the classifier. Default: [] + Achieved score using tow-fold cross-validation. + Selected feature set, contains only entries from FeatureList. + + + + Select an optimal combination of features to classify OCR data from a (protected) training file. + Modified instance represents: Trained OCR-MLP classifier. + + Names of the training files. Default: "" + Passwords for protected training files. + List of features that should be considered for selection. Default: ["zoom_factor","ratio","width","height","foreground","foreground_grid_9","foreground_grid_16","anisometry","compactness","convexity","moments_region_2nd_invar","moments_region_2nd_rel_invar","moments_region_3rd_invar","moments_central","phi","num_connect","num_holes","projection_horizontal","projection_vertical","projection_horizontal_invar","projection_vertical_invar","chord_histo","num_runs","pixel","pixel_invar","pixel_binary","gradient_8dir","cooc","moments_gray_plane"] + Method to perform the selection. Default: "greedy" + Width of the rectangle to which the gray values of the segmented character are zoomed. Default: 15 + Height of the rectangle to which the gray values of the segmented character are zoomed. Default: 16 + Names of generic parameters to configure the selection process and the classifier. Default: [] + Values of generic parameters to configure the selection process and the classifier. Default: [] + Achieved score using tow-fold cross-validation. + Selected feature set, contains only entries from FeatureList. + + + + Selects an optimal combination of features to classify OCR data. + Modified instance represents: Trained OCR-MLP classifier. + + Names of the training files. Default: "" + List of features that should be considered for selection. Default: ["zoom_factor","ratio","width","height","foreground","foreground_grid_9","foreground_grid_16","anisometry","compactness","convexity","moments_region_2nd_invar","moments_region_2nd_rel_invar","moments_region_3rd_invar","moments_central","phi","num_connect","num_holes","projection_horizontal","projection_vertical","projection_horizontal_invar","projection_vertical_invar","chord_histo","num_runs","pixel","pixel_invar","pixel_binary","gradient_8dir","cooc","moments_gray_plane"] + Method to perform the selection. Default: "greedy" + Width of the rectangle to which the gray values of the segmented character are zoomed. Default: 15 + Height of the rectangle to which the gray values of the segmented character are zoomed. Default: 16 + Names of generic parameters to configure the selection process and the classifier. Default: [] + Values of generic parameters to configure the selection process and the classifier. Default: [] + Achieved score using tow-fold cross-validation. + Selected feature set, contains only entries from FeatureList. + + + + Selects an optimal combination of features to classify OCR data. + Modified instance represents: Trained OCR-MLP classifier. + + Names of the training files. Default: "" + List of features that should be considered for selection. Default: ["zoom_factor","ratio","width","height","foreground","foreground_grid_9","foreground_grid_16","anisometry","compactness","convexity","moments_region_2nd_invar","moments_region_2nd_rel_invar","moments_region_3rd_invar","moments_central","phi","num_connect","num_holes","projection_horizontal","projection_vertical","projection_horizontal_invar","projection_vertical_invar","chord_histo","num_runs","pixel","pixel_invar","pixel_binary","gradient_8dir","cooc","moments_gray_plane"] + Method to perform the selection. Default: "greedy" + Width of the rectangle to which the gray values of the segmented character are zoomed. Default: 15 + Height of the rectangle to which the gray values of the segmented character are zoomed. Default: 16 + Names of generic parameters to configure the selection process and the classifier. Default: [] + Values of generic parameters to configure the selection process and the classifier. Default: [] + Achieved score using tow-fold cross-validation. + Selected feature set, contains only entries from FeatureList. + + + Clear an OCR classifier. + Handle of the OCR classifier. + + + + Clear an OCR classifier. + Instance represents: Handle of the OCR classifier. + + + + + Deserialize a serialized MLP-based OCR classifier. + Modified instance represents: Handle of the OCR classifier. + + Handle of the serialized item. + + + + Serialize a MLP-based OCR classifier. + Instance represents: Handle of the OCR classifier. + + Handle of the serialized item. + + + + Read an OCR classifier from a file. + Modified instance represents: Handle of the OCR classifier. + + File name. + + + + Write an OCR classifier to a file. + Instance represents: Handle of the OCR classifier. + + File name. + + + + Compute the features of a character. + Instance represents: Handle of the OCR classifier. + + Input character. + Should the feature vector be transformed with the preprocessing? Default: "true" + Feature vector of the character. + + + + Classify a related group of characters with an OCR classifier. + Instance represents: Handle of the OCR classifier. + + Characters to be recognized. + Gray values of the characters. + Expression describing the allowed word structure. + Number of classes per character considered for the internal word correction. Default: 3 + Maximum number of corrected characters. Default: 2 + Confidence of the class of the characters. + Word text after classification and correction. + Measure of similarity between corrected word and uncorrected classification results. + Result of classifying the characters with the MLP. + + + + Classify a related group of characters with an OCR classifier. + Instance represents: Handle of the OCR classifier. + + Characters to be recognized. + Gray values of the characters. + Expression describing the allowed word structure. + Number of classes per character considered for the internal word correction. Default: 3 + Maximum number of corrected characters. Default: 2 + Confidence of the class of the characters. + Word text after classification and correction. + Measure of similarity between corrected word and uncorrected classification results. + Result of classifying the characters with the MLP. + + + + Classify multiple characters with an OCR classifier. + Instance represents: Handle of the OCR classifier. + + Characters to be recognized. + Gray values of the characters. + Confidence of the class of the characters. + Result of classifying the characters with the MLP. + + + + Classify multiple characters with an OCR classifier. + Instance represents: Handle of the OCR classifier. + + Characters to be recognized. + Gray values of the characters. + Confidence of the class of the characters. + Result of classifying the characters with the MLP. + + + + Classify a single character with an OCR classifier. + Instance represents: Handle of the OCR classifier. + + Character to be recognized. + Gray values of the character. + Number of best classes to determine. Default: 1 + Confidence(s) of the class(es) of the character. + Result of classifying the character with the MLP. + + + + Classify a single character with an OCR classifier. + Instance represents: Handle of the OCR classifier. + + Character to be recognized. + Gray values of the character. + Number of best classes to determine. Default: 1 + Confidence(s) of the class(es) of the character. + Result of classifying the character with the MLP. + + + + Train an OCR classifier with data from a (protected) training file. + Instance represents: Handle of the OCR classifier. + + Names of the training files. Default: "ocr.trf" + Passwords for protected training files. + Maximum number of iterations of the optimization algorithm. Default: 200 + Threshold for the difference of the weights of the MLP between two iterations of the optimization algorithm. Default: 1.0 + Threshold for the difference of the mean error of the MLP on the training data between two iterations of the optimization algorithm. Default: 0.01 + Mean error of the MLP on the training data as a function of the number of iterations of the optimization algorithm. + Mean error of the MLP on the training data. + + + + Train an OCR classifier with data from a (protected) training file. + Instance represents: Handle of the OCR classifier. + + Names of the training files. Default: "ocr.trf" + Passwords for protected training files. + Maximum number of iterations of the optimization algorithm. Default: 200 + Threshold for the difference of the weights of the MLP between two iterations of the optimization algorithm. Default: 1.0 + Threshold for the difference of the mean error of the MLP on the training data between two iterations of the optimization algorithm. Default: 0.01 + Mean error of the MLP on the training data as a function of the number of iterations of the optimization algorithm. + Mean error of the MLP on the training data. + + + + Train an OCR classifier. + Instance represents: Handle of the OCR classifier. + + Names of the training files. Default: "ocr.trf" + Maximum number of iterations of the optimization algorithm. Default: 200 + Threshold for the difference of the weights of the MLP between two iterations of the optimization algorithm. Default: 1.0 + Threshold for the difference of the mean error of the MLP on the training data between two iterations of the optimization algorithm. Default: 0.01 + Mean error of the MLP on the training data as a function of the number of iterations of the optimization algorithm. + Mean error of the MLP on the training data. + + + + Train an OCR classifier. + Instance represents: Handle of the OCR classifier. + + Names of the training files. Default: "ocr.trf" + Maximum number of iterations of the optimization algorithm. Default: 200 + Threshold for the difference of the weights of the MLP between two iterations of the optimization algorithm. Default: 1.0 + Threshold for the difference of the mean error of the MLP on the training data between two iterations of the optimization algorithm. Default: 0.01 + Mean error of the MLP on the training data as a function of the number of iterations of the optimization algorithm. + Mean error of the MLP on the training data. + + + + Compute the information content of the preprocessed feature vectors of an OCR classifier. + Instance represents: Handle of the OCR classifier. + + Names of the training files. Default: "ocr.trf" + Type of preprocessing used to transform the feature vectors. Default: "principal_components" + Cumulative information content of the transformed feature vectors. + Relative information content of the transformed feature vectors. + + + + Compute the information content of the preprocessed feature vectors of an OCR classifier. + Instance represents: Handle of the OCR classifier. + + Names of the training files. Default: "ocr.trf" + Type of preprocessing used to transform the feature vectors. Default: "principal_components" + Cumulative information content of the transformed feature vectors. + Relative information content of the transformed feature vectors. + + + + Return the rejection class parameters of an OCR classifier. + Instance represents: Handle of the OCR classifier. + + Name of the general parameter. Default: "sampling_strategy" + Value of the general parameter. + + + + Return the rejection class parameters of an OCR classifier. + Instance represents: Handle of the OCR classifier. + + Name of the general parameter. Default: "sampling_strategy" + Value of the general parameter. + + + + Set the rejection class parameters of an OCR classifier. + Instance represents: Handle of the OCR classifier. + + Name of the general parameter. Default: "sampling_strategy" + Value of the general parameter. Default: "hyperbox_around_all_classes" + + + + Set the rejection class parameters of an OCR classifier. + Instance represents: Handle of the OCR classifier. + + Name of the general parameter. Default: "sampling_strategy" + Value of the general parameter. Default: "hyperbox_around_all_classes" + + + + Return the regularization parameters of an OCR classifier. + Instance represents: Handle of the OCR classifier. + + Name of the regularization parameter to return. Default: "weight_prior" + Value of the regularization parameter. + + + + Set the regularization parameters of an OCR classifier. + Instance represents: Handle of the OCR classifier. + + Name of the regularization parameter to return. Default: "weight_prior" + Value of the regularization parameter. Default: 1.0 + + + + Set the regularization parameters of an OCR classifier. + Instance represents: Handle of the OCR classifier. + + Name of the regularization parameter to return. Default: "weight_prior" + Value of the regularization parameter. Default: 1.0 + + + + Return the parameters of an OCR classifier. + Instance represents: Handle of the OCR classifier. + + Width of the rectangle to which the gray values of the segmented character are zoomed. + Height of the rectangle to which the gray values of the segmented character are zoomed. + Interpolation mode for the zooming of the characters. + Features to be used for classification. + Characters of the character set to be read. + Number of hidden units of the MLP. + Type of preprocessing used to transform the feature vectors. + Preprocessing parameter: Number of transformed features. + + + + Return the parameters of an OCR classifier. + Instance represents: Handle of the OCR classifier. + + Width of the rectangle to which the gray values of the segmented character are zoomed. + Height of the rectangle to which the gray values of the segmented character are zoomed. + Interpolation mode for the zooming of the characters. + Features to be used for classification. + Characters of the character set to be read. + Number of hidden units of the MLP. + Type of preprocessing used to transform the feature vectors. + Preprocessing parameter: Number of transformed features. + + + + Create an OCR classifier using a multilayer perceptron. + Modified instance represents: Handle of the OCR classifier. + + Width of the rectangle to which the gray values of the segmented character are zoomed. Default: 8 + Height of the rectangle to which the gray values of the segmented character are zoomed. Default: 10 + Interpolation mode for the zooming of the characters. Default: "constant" + Features to be used for classification. Default: "default" + All characters of the character set to be read. Default: ["0","1","2","3","4","5","6","7","8","9"] + Number of hidden units of the MLP. Default: 80 + Type of preprocessing used to transform the feature vectors. Default: "none" + Preprocessing parameter: Number of transformed features (ignored for Preprocessing $=$ 'none' and Preprocessing $=$ 'normalization'). Default: 10 + Seed value of the random number generator that is used to initialize the MLP with random values. Default: 42 + + + + Create an OCR classifier using a multilayer perceptron. + Modified instance represents: Handle of the OCR classifier. + + Width of the rectangle to which the gray values of the segmented character are zoomed. Default: 8 + Height of the rectangle to which the gray values of the segmented character are zoomed. Default: 10 + Interpolation mode for the zooming of the characters. Default: "constant" + Features to be used for classification. Default: "default" + All characters of the character set to be read. Default: ["0","1","2","3","4","5","6","7","8","9"] + Number of hidden units of the MLP. Default: 80 + Type of preprocessing used to transform the feature vectors. Default: "none" + Preprocessing parameter: Number of transformed features (ignored for Preprocessing $=$ 'none' and Preprocessing $=$ 'normalization'). Default: 10 + Seed value of the random number generator that is used to initialize the MLP with random values. Default: 42 + + + Represents an instance of a SVM OCR classifier. + + + + Read a SVM-based OCR classifier from a file. + Modified instance represents: Handle of the OCR classifier. + + File name. + + + + Create an OCR classifier using a support vector machine. + Modified instance represents: Handle of the OCR classifier. + + Width of the rectangle to which the gray values of the segmented character are zoomed. Default: 8 + Height of the rectangle to which the gray values of the segmented character are zoomed. Default: 10 + Interpolation mode for the zooming of the characters. Default: "constant" + Features to be used for classification. Default: "default" + All characters of the character set to be read. Default: ["0","1","2","3","4","5","6","7","8","9"] + The kernel type. Default: "rbf" + Additional parameter for the kernel function. Default: 0.02 + Regularization constant of the SVM. Default: 0.05 + The mode of the SVM. Default: "one-versus-one" + Type of preprocessing used to transform the feature vectors. Default: "normalization" + Preprocessing parameter: Number of transformed features (ignored for Preprocessing $=$ 'none' and Preprocessing $=$ 'normalization'). Default: 10 + + + + Create an OCR classifier using a support vector machine. + Modified instance represents: Handle of the OCR classifier. + + Width of the rectangle to which the gray values of the segmented character are zoomed. Default: 8 + Height of the rectangle to which the gray values of the segmented character are zoomed. Default: 10 + Interpolation mode for the zooming of the characters. Default: "constant" + Features to be used for classification. Default: "default" + All characters of the character set to be read. Default: ["0","1","2","3","4","5","6","7","8","9"] + The kernel type. Default: "rbf" + Additional parameter for the kernel function. Default: 0.02 + Regularization constant of the SVM. Default: 0.05 + The mode of the SVM. Default: "one-versus-one" + Type of preprocessing used to transform the feature vectors. Default: "normalization" + Preprocessing parameter: Number of transformed features (ignored for Preprocessing $=$ 'none' and Preprocessing $=$ 'normalization'). Default: 10 + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + + Select an optimal combination of features to classify OCR data from a (protected) training file. + Modified instance represents: Trained OCR-SVM Classifier. + + Names of the training files. Default: "" + Passwords for protected training files. + List of features that should be considered for selection. Default: ["zoom_factor","ratio","width","height","foreground","foreground_grid_9","foreground_grid_16","anisometry","compactness","convexity","moments_region_2nd_invar","moments_region_2nd_rel_invar","moments_region_3rd_invar","moments_central","phi","num_connect","num_holes","projection_horizontal","projection_vertical","projection_horizontal_invar","projection_vertical_invar","chord_histo","num_runs","pixel","pixel_invar","pixel_binary","gradient_8dir","cooc","moments_gray_plane"] + Method to perform the selection. Default: "greedy" + Width of the rectangle to which the gray values of the segmented character are zoomed. Default: 15 + Height of the rectangle to which the gray values of the segmented character are zoomed. Default: 16 + Names of generic parameters to configure the selection process and the classifier. Default: [] + Values of generic parameters to configure the selection process and the classifier. Default: [] + Achieved score using tow-fold cross-validation. + Selected feature set, contains only entries from FeatureList. + + + + Select an optimal combination of features to classify OCR data from a (protected) training file. + Modified instance represents: Trained OCR-SVM Classifier. + + Names of the training files. Default: "" + Passwords for protected training files. + List of features that should be considered for selection. Default: ["zoom_factor","ratio","width","height","foreground","foreground_grid_9","foreground_grid_16","anisometry","compactness","convexity","moments_region_2nd_invar","moments_region_2nd_rel_invar","moments_region_3rd_invar","moments_central","phi","num_connect","num_holes","projection_horizontal","projection_vertical","projection_horizontal_invar","projection_vertical_invar","chord_histo","num_runs","pixel","pixel_invar","pixel_binary","gradient_8dir","cooc","moments_gray_plane"] + Method to perform the selection. Default: "greedy" + Width of the rectangle to which the gray values of the segmented character are zoomed. Default: 15 + Height of the rectangle to which the gray values of the segmented character are zoomed. Default: 16 + Names of generic parameters to configure the selection process and the classifier. Default: [] + Values of generic parameters to configure the selection process and the classifier. Default: [] + Achieved score using tow-fold cross-validation. + Selected feature set, contains only entries from FeatureList. + + + + Selects an optimal combination of features to classify OCR data. + Modified instance represents: Trained OCR-SVM Classifier. + + Names of the training files. Default: "" + List of features that should be considered for selection. Default: ["zoom_factor","ratio","width","height","foreground","foreground_grid_9","foreground_grid_16","anisometry","compactness","convexity","moments_region_2nd_invar","moments_region_2nd_rel_invar","moments_region_3rd_invar","moments_central","phi","num_connect","num_holes","projection_horizontal","projection_vertical","projection_horizontal_invar","projection_vertical_invar","chord_histo","num_runs","pixel","pixel_invar","pixel_binary","gradient_8dir","cooc","moments_gray_plane"] + Method to perform the selection. Default: "greedy" + Width of the rectangle to which the gray values of the segmented character are zoomed. Default: 15 + Height of the rectangle to which the gray values of the segmented character are zoomed. Default: 16 + Names of generic parameters to configure the selection process and the classifier. Default: [] + Values of generic parameters to configure the selection process and the classifier. Default: [] + Achieved score using tow-fold cross-validation. + Selected feature set, contains only entries from FeatureList. + + + + Selects an optimal combination of features to classify OCR data. + Modified instance represents: Trained OCR-SVM Classifier. + + Names of the training files. Default: "" + List of features that should be considered for selection. Default: ["zoom_factor","ratio","width","height","foreground","foreground_grid_9","foreground_grid_16","anisometry","compactness","convexity","moments_region_2nd_invar","moments_region_2nd_rel_invar","moments_region_3rd_invar","moments_central","phi","num_connect","num_holes","projection_horizontal","projection_vertical","projection_horizontal_invar","projection_vertical_invar","chord_histo","num_runs","pixel","pixel_invar","pixel_binary","gradient_8dir","cooc","moments_gray_plane"] + Method to perform the selection. Default: "greedy" + Width of the rectangle to which the gray values of the segmented character are zoomed. Default: 15 + Height of the rectangle to which the gray values of the segmented character are zoomed. Default: 16 + Names of generic parameters to configure the selection process and the classifier. Default: [] + Values of generic parameters to configure the selection process and the classifier. Default: [] + Achieved score using tow-fold cross-validation. + Selected feature set, contains only entries from FeatureList. + + + Clear an SVM-based OCR classifier. + Handle of the OCR classifier. + + + + Clear an SVM-based OCR classifier. + Instance represents: Handle of the OCR classifier. + + + + + Deserialize a serialized SVM-based OCR classifier. + Modified instance represents: Handle of the OCR classifier. + + Handle of the serialized item. + + + + Serialize a SVM-based OCR classifier + Instance represents: Handle of the OCR classifier. + + Handle of the serialized item. + + + + Read a SVM-based OCR classifier from a file. + Modified instance represents: Handle of the OCR classifier. + + File name. + + + + Write an OCR classifier to a file. + Instance represents: Handle of the OCR classifier. + + File name. + + + + Compute the features of a character. + Instance represents: Handle of the OCR classifier. + + Input character. + Should the feature vector be transformed with the preprocessing? Default: "true" + Feature vector of the character. + + + + Classify a related group of characters with an OCR classifier. + Instance represents: Handle of the OCR classifier. + + Characters to be recognized. + Gray values of the characters. + Expression describing the allowed word structure. + Number of classes per character considered for the internal word correction. Default: 3 + Maximum number of corrected characters. Default: 2 + Word text after classification and correction. + Measure of similarity between corrected word and uncorrected classification results. + Result of classifying the characters with the SVM. + + + + Classify multiple characters with an SVM-based OCR classifier. + Instance represents: Handle of the OCR classifier. + + Characters to be recognized. + Gray values of the characters. + Result of classifying the characters with the SVM. + + + + Classify a single character with an SVM-based OCR classifier. + Instance represents: Handle of the OCR classifier. + + Character to be recognized. + Gray values of the character. + Number of best classes to determine. Default: 1 + Result of classifying the character with the SVM. + + + + Approximate a trained SVM-based OCR classifier by a reduced SVM. + Instance represents: Original handle of SVM-based OCR-classifier. + + Type of postprocessing to reduce number of SVs. Default: "bottom_up" + Minimum number of remaining SVs. Default: 2 + Maximum allowed error of reduction. Default: 0.001 + SVMHandle of reduced OCR classifier. + + + + Train an OCR classifier with data from a (protected) training file. + Instance represents: Handle of the OCR classifier. + + Names of the training files. Default: "ocr.trf" + Passwords for protected training files. + Stop parameter for training. Default: 0.001 + Mode of training. Default: "default" + + + + Train an OCR classifier with data from a (protected) training file. + Instance represents: Handle of the OCR classifier. + + Names of the training files. Default: "ocr.trf" + Passwords for protected training files. + Stop parameter for training. Default: 0.001 + Mode of training. Default: "default" + + + + Train an OCR classifier. + Instance represents: Handle of the OCR classifier. + + Names of the training files. Default: "ocr.trf" + Stop parameter for training. Default: 0.001 + Mode of training. Default: "default" + + + + Train an OCR classifier. + Instance represents: Handle of the OCR classifier. + + Names of the training files. Default: "ocr.trf" + Stop parameter for training. Default: 0.001 + Mode of training. Default: "default" + + + + Compute the information content of the preprocessed feature vectors of an SVM-based OCR classifier. + Instance represents: Handle of the OCR classifier. + + Names of the training files. Default: "ocr.trf" + Type of preprocessing used to transform the feature vectors. Default: "principal_components" + Cumulative information content of the transformed feature vectors. + Relative information content of the transformed feature vectors. + + + + Compute the information content of the preprocessed feature vectors of an SVM-based OCR classifier. + Instance represents: Handle of the OCR classifier. + + Names of the training files. Default: "ocr.trf" + Type of preprocessing used to transform the feature vectors. Default: "principal_components" + Cumulative information content of the transformed feature vectors. + Relative information content of the transformed feature vectors. + + + + Return the number of support vectors of an OCR classifier. + Instance represents: OCR handle. + + Number of SV of each sub-SVM. + Total number of support vectors. + + + + Return the index of a support vector from a trained OCR classifier that is based on support vector machines. + Instance represents: OCR handle. + + Number of stored support vectors. + Index of the support vector in the training set. + + + + Return the parameters of an OCR classifier. + Instance represents: Handle of the OCR classifier. + + Width of the rectangle to which the gray values of the segmented character are zoomed. + Height of the rectangle to which the gray values of the segmented character are zoomed. + Interpolation mode for the zooming of the characters. + Features to be used for classification. + Characters of the character set to be read. + The kernel type. + Additional parameters for the kernel function. + Regularization constant of the SVM. + The mode of the SVM. + Type of preprocessing used to transform the feature vectors. + Preprocessing parameter: Number of transformed features (ignored for Preprocessing $=$ 'none' and Preprocessing $=$ 'normalization'). + + + + Return the parameters of an OCR classifier. + Instance represents: Handle of the OCR classifier. + + Width of the rectangle to which the gray values of the segmented character are zoomed. + Height of the rectangle to which the gray values of the segmented character are zoomed. + Interpolation mode for the zooming of the characters. + Features to be used for classification. + Characters of the character set to be read. + The kernel type. + Additional parameters for the kernel function. + Regularization constant of the SVM. + The mode of the SVM. + Type of preprocessing used to transform the feature vectors. + Preprocessing parameter: Number of transformed features (ignored for Preprocessing $=$ 'none' and Preprocessing $=$ 'normalization'). + + + + Create an OCR classifier using a support vector machine. + Modified instance represents: Handle of the OCR classifier. + + Width of the rectangle to which the gray values of the segmented character are zoomed. Default: 8 + Height of the rectangle to which the gray values of the segmented character are zoomed. Default: 10 + Interpolation mode for the zooming of the characters. Default: "constant" + Features to be used for classification. Default: "default" + All characters of the character set to be read. Default: ["0","1","2","3","4","5","6","7","8","9"] + The kernel type. Default: "rbf" + Additional parameter for the kernel function. Default: 0.02 + Regularization constant of the SVM. Default: 0.05 + The mode of the SVM. Default: "one-versus-one" + Type of preprocessing used to transform the feature vectors. Default: "normalization" + Preprocessing parameter: Number of transformed features (ignored for Preprocessing $=$ 'none' and Preprocessing $=$ 'normalization'). Default: 10 + + + + Create an OCR classifier using a support vector machine. + Modified instance represents: Handle of the OCR classifier. + + Width of the rectangle to which the gray values of the segmented character are zoomed. Default: 8 + Height of the rectangle to which the gray values of the segmented character are zoomed. Default: 10 + Interpolation mode for the zooming of the characters. Default: "constant" + Features to be used for classification. Default: "default" + All characters of the character set to be read. Default: ["0","1","2","3","4","5","6","7","8","9"] + The kernel type. Default: "rbf" + Additional parameter for the kernel function. Default: 0.02 + Regularization constant of the SVM. Default: 0.05 + The mode of the SVM. Default: "one-versus-one" + Type of preprocessing used to transform the feature vectors. Default: "normalization" + Preprocessing parameter: Number of transformed features (ignored for Preprocessing $=$ 'none' and Preprocessing $=$ 'normalization'). Default: 10 + + + Represents an instance of a tool for optical character verification. + + + + Reading an OCV tool from file. + Modified instance represents: Handle of read OCV tool. + + Name of the file which has to be read. Default: "test_ocv" + + + + Create a new OCV tool based on gray value projections. + Modified instance represents: Handle of the created OCV tool. + + List of names for patterns to be trained. Default: "a" + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + + Verification of a pattern using an OCV tool. + Instance represents: Handle of the OCV tool. + + Characters to be verified. + Name of the character. Default: "a" + Adaption to vertical and horizontal translation. Default: "true" + Adaption to vertical and horizontal scaling of the size. Default: "true" + Adaption to changes of the orientation (not implemented). Default: "false" + Adaption to additive and scaling gray value changes. Default: "true" + Minimum difference between objects. Default: 10 + Evaluation of the character. + + + + Verification of a pattern using an OCV tool. + Instance represents: Handle of the OCV tool. + + Characters to be verified. + Name of the character. Default: "a" + Adaption to vertical and horizontal translation. Default: "true" + Adaption to vertical and horizontal scaling of the size. Default: "true" + Adaption to changes of the orientation (not implemented). Default: "false" + Adaption to additive and scaling gray value changes. Default: "true" + Minimum difference between objects. Default: 10 + Evaluation of the character. + + + + Training of an OCV tool. + Instance represents: Handle of the OCV tool to be trained. + + Pattern to be trained. + Name(s) of the object(s) to analyse. Default: "a" + Mode for training (only one mode implemented). Default: "single" + + + + Training of an OCV tool. + Instance represents: Handle of the OCV tool to be trained. + + Pattern to be trained. + Name(s) of the object(s) to analyse. Default: "a" + Mode for training (only one mode implemented). Default: "single" + + + + Deserialize a serialized OCV tool. + Modified instance represents: Handle of the OCV tool. + + Handle of the serialized item. + + + + Serialize an OCV tool. + Instance represents: Handle of the OCV tool. + + Handle of the serialized item. + + + + Reading an OCV tool from file. + Modified instance represents: Handle of read OCV tool. + + Name of the file which has to be read. Default: "test_ocv" + + + + Saving an OCV tool to file. + Instance represents: Handle of the OCV tool to be written. + + Name of the file where the tool has to be saved. Default: "test_ocv" + + + + Clear an OCV tool. + Instance represents: Handle of the OCV tool which has to be freed. + + + + + Create a new OCV tool based on gray value projections. + Modified instance represents: Handle of the created OCV tool. + + List of names for patterns to be trained. Default: "a" + + + + Create a new OCV tool based on gray value projections. + Modified instance represents: Handle of the created OCV tool. + + List of names for patterns to be trained. Default: "a" + + + Class grouping all HALCON operators. + + + Compute the union of cotangential contours. + Input XLD contours. + Output XLD contours. + Length of the part of a contour to skip for the determination of tangents. Default: 0.0 + Length of the part of a contour to use for the determination of tangents. Default: 30.0 + Maximum angle difference between two contours' tangents. Default: 0.78539816 + Maximum distance of the contours' end points. Default: 25.0 + Maximum distance of the contours' end points perpendicular to their tangents. Default: 10.0 + Maximum overlap of two contours. Default: 2.0 + Mode describing the treatment of the contours' attributes. Default: "attr_forget" + + + Transform a contour in polar coordinates back to Cartesian coordinates + Input contour. + Output contour. + Row coordinate of the center of the arc. Default: 256 + Column coordinate of the center of the arc. Default: 256 + Angle of the ray to map the column coordinate 0 of PolarContour to. Default: 0.0 + Angle of the ray to map the column coordinate $WidthIn-1$ of PolarContour to. Default: 6.2831853 + Radius of the circle to map the row coordinate 0 of PolarContour to. Default: 0 + Radius of the circle to map the row coordinate $HeightIn-1$ of PolarContour to. Default: 100 + Width of the virtual input image. Default: 512 + Height of the virtual input image. Default: 512 + Width of the virtual output image. Default: 512 + Height of the virtual output image. Default: 512 + + + Transform a contour in an annular arc to polar coordinates. + Input contour. + Output contour. + Row coordinate of the center of the arc. Default: 256 + Column coordinate of the center of the arc. Default: 256 + Angle of the ray to be mapped to the column coordinate 0 of PolarTransContour. Default: 0.0 + Angle of the ray to be mapped to the column coordinate $Width-1$ of PolarTransContour to. Default: 6.2831853 + Radius of the circle to be mapped to the row coordinate 0 of PolarTransContour. Default: 0 + Radius of the circle to be mapped to the row coordinate $Height-1$ of PolarTransContour. Default: 100 + Width of the virtual output image. Default: 512 + Height of the virtual output image. Default: 512 + + + Create control data of a NURBS curve that interpolates given points. + Row coordinates of input point list. + Column coordinates of input point list. + Tangents at first and last point. Default: [] + Order of the output curve. Default: 3 + Row coordinates of the control polygon. + Column coordinates of the control polygon. + The knot vector of the output curve. + + + Transform a NURBS curve into an XLD contour. + The contour that approximates the NURBS curve. + Row coordinates of the control polygon. + Column coordinates of the control polygon. + The knot vector $u$. Default: "auto" + The weight vector $w$. Default: "auto" + The degree $p$ of the NURBS curve. Default: 3 + Maximum distance between the NURBS curve and its approximation. Default: 1.0 + Maximum distance between two subsequent Contour points. Default: 5.0 + + + Compute the union of closed polygons. + Polygons enclosing the first region. + Polygons enclosing the second region. + Polygons enclosing the union. + + + Compute the union of closed contours. + Contours enclosing the first region. + Contours enclosing the second region. + Contours enclosing the union. + + + Compute the symmetric difference of closed polygons. + Polygons enclosing the first region. + Polygons enclosing the second region. + Polygons enclosing the symmetric difference. + + + Compute the symmetric difference of closed contours. + Contours enclosing the first region. + Contours enclosing the second region. + Contours enclosing the symmetric difference. + + + Compute the difference of closed polygons. + Polygons enclosing the region from which the second region is subtracted. + Polygons enclosing the region that is subtracted from the first region. + Polygons enclosing the difference. + + + Compute the difference of closed contours. + Contours enclosing the region from which the second region is subtracted. + Contours enclosing the region that is subtracted from the first region. + Contours enclosing the difference. + + + Intersect closed polygons. + Polygons enclosing the first region to be intersected. + Polygons enclosing the second region to be intersected. + Polygons enclosing the intersection. + + + Intersect closed contours. + Contours enclosing the first region to be intersected. + Contours enclosing the second region to be intersected. + Contours enclosing the intersection. + + + Compute the union of contours that belong to the same circle. + Contours to be merged. + Merged contours. + Maximum angular distance of two circular arcs. Default: 0.5 + Maximum overlap of two circular arcs. Default: 0.1 + Maximum angle between the connecting line and the tangents of circular arcs. Default: 0.2 + Maximum length of the gap between two circular arcs in pixels. Default: 30 + Maximum radius difference of the circles fitted to two arcs. Default: 10 + Maximum center distance of the circles fitted to two arcs. Default: 10 + Determine whether small contours without fitted circles should also be merged. Default: "true" + Number of iterations. Default: 1 + + + Crop an XLD contour. + Input contours. + Output contours. + Upper border of the cropping rectangle. Default: 0 + Left border of the cropping rectangle. Default: 0 + Lower border of the cropping rectangle. Default: 512 + Right border of the cropping rectangle. Default: 512 + Should closed contours produce closed output contours? Default: "true" + + + Generate one XLD contour in the shape of a cross for each input point. + Generated XLD contours. + Row coordinates of the input points. + Column coordinates of the input points. + Length of the cross bars. Default: 6.0 + Orientation of the crosses. Default: 0.785398 + + + Sort contours with respect to their relative position. + Contours to be sorted. + Sorted contours. + Kind of sorting. Default: "upper_left" + Increasing or decreasing sorting order. Default: "true" + Sorting first with respect to row, then to column. Default: "row" + + + Merge XLD contours from successive line scan images. + Current input contours. + Merged contours from the previous iteration. + Current contours, merged with old ones where applicable. + Contours from the previous iteration which could not be merged with the current ones. + Height of the line scan images. Default: 512 + Maximum distance of contours from the image border. Default: 0.0 + Image line of the current image, which touches the previous image. Default: "top" + Maximum number of images covered by one contour. Default: 3 + + + Read XLD polygons from a file in ARC/INFO generate format. + Read XLD polygons. + Name of the ARC/INFO file. + + + Write XLD polygons to a file in ARC/INFO generate format. + XLD polygons to be written. + Name of the ARC/INFO file. + + + Read XLD contours to a file in ARC/INFO generate format. + Read XLD contours. + Name of the ARC/INFO file. + + + Write XLD contours to a file in ARC/INFO generate format. + XLD contours to be written. + Name of the ARC/INFO file. + + + Read the geo coding from an ARC/INFO world file. + Name of the ARC/INFO world file. + Transformation matrix from image to world coordinates. + + + Compute the parallel contour of an XLD contour. + Contours to be transformed. + Parallel contours. + Mode, with which the direction information is computed. Default: "regression_normal" + Distance of the parallel contour. Default: 1 + + + Create an XLD contour in the shape of a rectangle. + Rectangle contour. + Row coordinate of the center of the rectangle. Default: 300.0 + Column coordinate of the center of the rectangle. Default: 200.0 + Orientation of the main axis of the rectangle [rad]. Default: 0.0 + First radius (half length) of the rectangle. Default: 100.5 + Second radius (half width) of the rectangle. Default: 20.5 + + + Compute the distances of all contour points to a rectangle. + Input contour. + Number of points at the beginning and the end of the contours to be ignored for the computation of distances. Default: 0 + Row coordinate of the center of the rectangle. + Column coordinate of the center of the rectangle. + Orientation of the main axis of the rectangle [rad]. + First radius (half length) of the rectangle. + Second radius (half width) of the rectangle. + Distances of the contour points to the rectangle. + + + Fit rectangles to XLD contours. + Input contours. + Algorithm for fitting the rectangles. Default: "regression" + Maximum number of contour points used for the computation (-1 for all points). Default: -1 + Maximum distance between the end points of a contour to be considered as closed. Default: 0.0 + Number of points at the beginning and at the end of the contours to be ignored for the fitting. Default: 0 + Maximum number of iterations (not used for 'regression'). Default: 3 + Clipping factor for the elimination of outliers (typical: 1.0 for 'huber' and 2.0 for 'tukey'). Default: 2.0 + Row coordinate of the center of the rectangle. + Column coordinate of the center of the rectangle. + Orientation of the main axis of the rectangle [rad]. + First radius (half length) of the rectangle. + Second radius (half width) of the rectangle. + Point order of the contour. + + + Segment XLD contour parts whose local attributes fulfill given conditions. + Contour to be segmented. + Segmented contour parts. + Contour attributes to be checked. Default: "distance" + Linkage type of the individual attributes. Default: "and" + Lower limits of the attribute values. Default: 150.0 + Upper limits of the attribute values. Default: 99999.0 + + + Segment XLD contours into line segments and circular or elliptic arcs. + Contours to be segmented. + Segmented contours. + Mode for the segmentation of the contours. Default: "lines_circles" + Number of points used for smoothing the contours. Default: 5 + Maximum distance between a contour and the approximating line (first iteration). Default: 4.0 + Maximum distance between a contour and the approximating line (second iteration). Default: 2.0 + + + Approximate XLD contours by circles. + Input contours. + Algorithm for the fitting of circles. Default: "algebraic" + Maximum number of contour points used for the computation (-1 for all points). Default: -1 + Maximum distance between the end points of a contour to be considered as 'closed'. Default: 0.0 + Number of points at the beginning and at the end of the contours to be ignored for the fitting. Default: 0 + Maximum number of iterations for the robust weighted fitting. Default: 3 + Clipping factor for the elimination of outliers (typical: 1.0 for Huber and 2.0 for Tukey). Default: 2.0 + Row coordinate of the center of the circle. + Column coordinate of the center of the circle. + Radius of circle. + Angle of the start point [rad]. + Angle of the end point [rad]. + Point order along the boundary. + + + Approximate XLD contours by line segments. + Input contours. + Algorithm for the fitting of lines. Default: "tukey" + Maximum number of contour points used for the computation (-1 for all points). Default: -1 + Number of points at the beginning and at the end of the contours to be ignored for the fitting. Default: 0 + Maximum number of iterations (unused for 'regression'). Default: 5 + Clipping factor for the elimination of outliers (typical: 1.0 for 'huber' and 'drop' and 2.0 for 'tukey'). Default: 2.0 + Row coordinates of the starting points of the line segments. + Column coordinates of the starting points of the line segments. + Row coordinates of the end points of the line segments. + Column coordinates of the end points of the line segments. + Line parameter: Row coordinate of the normal vector + Line parameter: Column coordinate of the normal vector + Line parameter: Distance of the line from the origin + + + Compute the distances of all contour points to an ellipse. + Input contours. + Mode for unsigned or signed distance values. Default: "unsigned" + Number of points at the beginning and the end of the contours to be ignored for the computation of distances. Default: 0 + Row coordinate of the center of the ellipse. + Column coordinate of the center of the ellipse. + Orientation of the main axis in radian. + Length of the larger half axis. + Length of the smaller half axis. + Distances of the contour points to the ellipse. + + + Compute the distance of contours to an ellipse. + Input contours. + Method for the determination of the distances. Default: "geometric" + Maximum number of contour points used for the computation (-1 for all points). Default: -1 + Number of points at the beginning and the end of the contours to be ignored for the computation of distances. Default: 0 + Row coordinate of the center of the ellipse. + Column coordinate of the center of the ellipse. + Orientation of the main axis in radian. + Length of the larger half axis. + Length of the smaller half axis. + Minimum distance. + Maximum distance. + Mean distance. + Standard deviation of the distance. + + + Approximate XLD contours by ellipses or elliptic arcs. + Input contours. + Algorithm for the fitting of ellipses. Default: "fitzgibbon" + Maximum number of contour points used for the computation (-1 for all points). Default: -1 + Maximum distance between the end points of a contour to be considered as 'closed'. Default: 0.0 + Number of points at the beginning and at the end of the contours to be ignored for the fitting. Default: 0 + Number of circular segments used for the Voss approach. Default: 200 + Maximum number of iterations for the robust weighted fitting. Default: 3 + Clipping factor for the elimination of outliers (typical: 1.0 for '*huber' and 2.0 for '*tukey'). Default: 2.0 + Row coordinate of the center of the ellipse. + Column coordinate of the center of the ellipse. + Orientation of the main axis [rad]. + Length of the larger half axis. + Length of the smaller half axis. + Angle of the start point [rad]. + Angle of the end point [rad]. + point order along the boundary. + + + Create XLD contours corresponding to circles or circular arcs. + Resulting contours. + Row coordinate of the center of the circles or circular arcs. Default: 200.0 + Column coordinate of the center of the circles or circular arcs. Default: 200.0 + Radius of the circles or circular arcs. Default: 100.0 + Angle of the start points of the circles or circular arcs [rad]. Default: 0.0 + Angle of the end points of the circles or circular arcs [rad]. Default: 6.28318 + Point order along the circles or circular arcs. Default: "positive" + Distance between neighboring contour points. Default: 1.0 + + + Create an XLD contour that corresponds to an elliptic arc. + Resulting contour. + Row coordinate of the center of the ellipse. Default: 200.0 + Column coordinate of the center of the ellipse. Default: 200.0 + Orientation of the main axis [rad]. Default: 0.0 + Length of the larger half axis. Default: 100.0 + Length of the smaller half axis. Default: 50.0 + Angle of the start point on the smallest surrounding circle [rad]. Default: 0.0 + Angle of the end point on the smallest surrounding circle [rad]. Default: 6.28318 + point order along the boundary. Default: "positive" + Resolution: Maximum distance between neighboring contour points. Default: 1.5 + + + Add noise to XLD contours. + Original contours. + Noisy contours. + Number of points used to calculate the regression line. Default: 5 + Maximum amplitude of the added noise (equally distributed in [-Amp,Amp]). Default: 1.0 + + + Combine road hypotheses from two resolution levels. + XLD polygons to be examined. + Modified parallels obtained from EdgePolygons. + Extended parallels obtained from EdgePolygons. + Road-center-line polygons to be examined. + Roadsides found. + Maximum angle between two parallel line segments. Default: 0.523598775598 + Maximum angle between two collinear line segments. Default: 0.261799387799 + Maximum distance between two parallel line segments. Default: 40 + Maximum distance between two collinear line segments. Default: 40 + + + Join modified XLD parallels lying on the same polygon. + Extended XLD parallels. + Maximally extended parallels. + + + Extract parallel XLD polygons enclosing a homogeneous area. + Input XLD parallels. + Corresponding gray value image. + Modified XLD parallels. + Extended XLD parallels. + Minimum quality factor (measure of parallelism). Default: 0.4 + Minimum mean gray value. Default: 160 + Maximum mean gray value. Default: 220 + Maximum allowed standard deviation. Default: 10.0 + + + Return information about the gray values of the area enclosed by XLD parallels. + Input XLD Parallels. + Corresponding gray value image. + Minimum quality factor. + Maximum quality factor. + Minimum mean gray value. + Maximum mean gray value. + Minimum standard deviation. + Maximum standard deviation. + + + Return an XLD parallel's data (as lines). + Input XLD parallels. + Row coordinates of the points on polygon P1. + Column coordinates of the points on polygon P1. + Lengths of the line segments on polygon P1. + Angles of the line segments on polygon P1. + Row coordinates of the points on polygon P2. + Column coordinates of the points on polygon P2. + Lengths of the line segments on polygon P2. + Angles of the line segments on polygon P2. + + + Extract parallel XLD polygons. + Input polygons. + Parallel polygons. + Minimum length of the individual polygon segments. Default: 10.0 + Maximum distance between the polygon segments. Default: 30.0 + Maximum angle difference of the polygon segments. Default: 0.15 + Should adjacent parallel relations be merged? Default: "true" + + + Return an XLD polygon's data (as lines). + Input XLD polygons. + Row coordinates of the lines' start points. + Column coordinates of the lines' start points. + Column coordinates of the lines' end points. + Column coordinates of the lines' end points. + Lengths of the line segments. + Angles of the line segments. + + + Return an XLD polygon's data. + Input XLD polygon. + Row coordinates of the polygons' points. + Column coordinates of the polygons' points. + Lengths of the line segments. + Angles of the line segments. + + + Approximate XLD contours by polygons. + Contours to be approximated. + Approximating polygons. + Type of approximation. Default: "ramer" + Threshold for the approximation. Default: 2.0 + + + Split XLD contours at dominant points. + Polygons for which the corresponding contours are to be split. + Split contours. + Mode for the splitting of the contours. Default: "polygon" + Weight for the sensitiveness. Default: 1 + Width of the smoothing mask. Default: 5 + + + Apply a projective transformation to an XLD contour. + Input contours. + Output contours. + Homogeneous projective transformation matrix. + + + Apply an arbitrary affine transformation to XLD polygons. + Input XLD polygons. + Transformed XLD polygons. + Input transformation matrix. + + + Apply an arbitrary affine 2D transformation to XLD contours. + Input XLD contours. + Transformed XLD contours. + Input transformation matrix. + + + Close an XLD contour. + Contours to be closed. + Closed contours. + + + Clip the end points of an XLD contour. + Input contour + Clipped contour + Clipping mode. Default: "num_points" + Clipping length in unit pixels (Mode $=$ 'length') or number (Mode $=$ 'num_points') Default: 3 + + + Clip an XLD contour. + Contours to be clipped. + Clipped contours. + Row coordinate of the upper left corner of the clip rectangle. Default: 0 + Column coordinate of the upper left corner of the clip rectangle. Default: 0 + Row coordinate of the lower right corner of the clip rectangle. Default: 512 + Column coordinate of the lower right corner of the clip rectangle. Default: 512 + + + Select XLD contours with a local maximum of gray values. + XLD contours to be examined. + Corresponding gray value image. + Selected contours. + Minimum percentage of maximum points. Default: 70 + Minimum amount by which the gray value at the maximum must be larger than in the profile. Default: 15 + Maximum width of profile used to check for maxima. Default: 4 + + + Compute the union of neighboring straight contours that have a similar distance from a given line. + Input XLD contours. + Output XLD contours. + Output XLD contours. + y coordinate of the starting point of the reference line. Default: 0 + x coordinate of the starting point of the reference line. Default: 0 + y coordinate of the endpoint of the reference line. Default: 0 + x coordinate of the endpoint of the reference line. Default: 0 + Maximum distance. Default: 1 + Maximum Width between two minimas. Default: 1 + Size of Smoothfilter Default: 1 + Output Values of Histogram. + + + Compute the union of neighboring straight contours that have a similar direction. + Input XLD contours. + Output XLD contours. + Maximum distance of the contours' endpoints. Default: 5.0 + Maximum difference in direction. Default: 0.5 + Weighting factor for the two selection criteria. Default: 50.0 + Should parallel contours be taken into account? Default: "noparallel" + Number of iterations or 'maximum'. Default: "maximum" + + + Compute the union of collinear contours (operator with extended functionality). + Input XLD contours. + Output XLD contours. + Maximum distance of the contours' end points in the direction of the reference regression line. Default: 10.0 + Maximum distance of the contours' end points in the direction of the reference regression line in relation to the length of the contour which is to be elongated. Default: 1.0 + Maximum distance of the contour from the reference regression line (i.e., perpendicular to the line). Default: 2.0 + Maximum angle difference between the two contours. Default: 0.1 + Maximum range of the overlap. Default: 0.0 + Maximum regression error of the resulting contours (NOT USED). Default: -1.0 + Threshold for reducing the total costs of unification. Default: 1.0 + Influence of the distance in the line direction on the total costs. Default: 1.0 + Influence of the distance from the regression line on the total costs. Default: 1.0 + Influence of the angle difference on the total costs. Default: 1.0 + Influence of the line disturbance by the linking segment (overlap and angle difference) on the total costs. Default: 1.0 + Influence of the regression error on the total costs (NOT USED). Default: 0.0 + Mode describing the treatment of the contours' attributes Default: "attr_keep" + + + Unite approximately collinear contours. + Input XLD contours. + Output XLD contours. + Maximum length of the gap between two contours, measured along the regression line of the reference contour. Default: 10.0 + Maximum length of the gap between two contours, relative to the length of the reference contour, both measured along the regression line of the reference contour. Default: 1.0 + Maximum distance of the second contour from the regression line of the reference contour. Default: 2.0 + Maximum angle between the regression lines of two contours. Default: 0.1 + Mode that defines the treatment of contour attributes, i.e., if the contour attributes are kept or discarded. Default: "attr_keep" + + + Compute the union of contours whose end points are close together. + Input XLD contours. + Output XLD contours. + Maximum distance of the contours' end points. Default: 10.0 + Maximum distance of the contours' end points in relation to the length of the longer contour. Default: 1.0 + Mode describing the treatment of the contours' attributes. Default: "attr_keep" + + + Select XLD contours according to several features. + Input XLD contours. + Output XLD contours. + Feature to select contours with. Default: "contour_length" + Lower threshold. Default: 0.5 + Upper threshold. Default: 200.0 + Lower threshold. Default: -0.5 + Upper threshold. Default: 0.5 + + + Return XLD contour parameters. + Input XLD contours. + Number of contour points. + X-coordinate of the normal vector of the regression line. + Y-coordinate of the normal vector of the regression line. + Distance of the regression line from the origin. + X-coordinate of the projection of the start point of the contour onto the regression line. + Y-coordinate of the projection of the start point of the contour onto the regression line. + X-coordinate of the projection of the end point of the contour onto the regression line. + Y-coordinate of the projection of the end point of the contour onto the regression line. + Mean distance of the contour points from the regression line. + Standard deviation of the distances from the regression line. + + + Calculate the parameters of a regression line to an XLD contour. + Input XLD contours. + Resulting XLD contours. + Type of outlier treatment. Default: "no" + Number of iterations for the outlier treatment. Default: 1 + + + Calculate the direction of an XLD contour for each contour point. + Input contour. + Return type of the angles. Default: "abs" + Method for computing the angles. Default: "range" + Number of points to take into account. Default: 3 + Direction of the tangent to the contour points. + + + Smooth an XLD contour. + Contour to be smoothed. + Smoothed contour. + Number of points used to calculate the regression line. Default: 5 + + + Return the number of points in an XLD contour. + Input XLD contour. + Number of contour points. + + + Return the names of the defined global attributes of an XLD contour. + Input contour. + List of the defined global contour attributes. + + + Return global attributes values of an XLD contour. + Input XLD contour. + Name of the attribute. Default: "regr_norm_row" + Attribute values. + + + Return the names of the defined attributes of an XLD contour. + Input contour. + List of the defined contour attributes. + + + Return point attribute values of an XLD contour. + Input XLD contour. + Name of the attribute. Default: "angle" + Attribute values. + + + Return the coordinates of an XLD contour. + Input XLD contour. + Row coordinate of the contour's points. + Column coordinate of the contour's points. + + + Generate XLD contours from regions. + Input regions. + Resulting contours. + Mode of contour generation. Default: "border" + + + Generate an XLD contour with rounded corners from a polygon (given as tuples). + Resulting contour. + Row coordinates of the polygon. Default: [20,80,80,20,20] + Column coordinates of the polygon. Default: [20,20,80,80,20] + Radii of the rounded corners. Default: [20,20,20,20,20] + Distance of the samples. Default: 1.0 + + + Generate an XLD contour from a polygon (given as tuples). + Resulting contour. + Row coordinates of the polygon. Default: [0,1,2,2,2] + Column coordinates of the polygon. Default: [0,0,0,1,2] + + + Convert a skeleton into XLD contours. + Skeleton of which the contours are to be determined. + Resulting contours. + Minimum number of points a contour has to have. Default: 1 + Contour filter mode. Default: "filter" + + + Display an XLD object. + XLD object to display. + Window handle. + + + Image restoration by Wiener filtering. + Corrupted image. + impulse response (PSF) of degradation (in spatial domain). + Region for noise estimation. + Restored image. + Width of filter mask. Default: 3 + Height of filter mask. Default: 3 + + + Image restoration by Wiener filtering. + Corrupted image. + impulse response (PSF) of degradation (in spatial domain). + Smoothed version of corrupted image. + Restored image. + + + Generate an impulse response of a (linearly) motion blurring. + Impulse response of motion-blur. + Width of impulse response image. Default: 256 + Height of impulse response image. Default: 256 + Degree of motion-blur. Default: 20.0 + Angle between direction of motion and x-axis (anticlockwise). Default: 0 + PSF prototype resp. type of motion. Default: 3 + + + Simulation of (linearly) motion blur. + image to be blurred. + motion blurred image. + extent of blurring. Default: 20.0 + Angle between direction of motion and x-axis (anticlockwise). Default: 0 + impulse response of motion blur. Default: 3 + + + Generate an impulse response of an uniform out-of-focus blurring. + Impulse response of uniform out-of-focus blurring. + Width of result image. Default: 256 + Height of result image. Default: 256 + Degree of Blurring. Default: 5.0 + + + Simulate an uniform out-of-focus blurring of an image. + Image to blur. + Blurred image. + Degree of blurring. Default: 5.0 + + + Deserialize a variation model. + Handle of the serialized item. + ID of the variation model. + + + Serialize a variation model. + ID of the variation model. + Handle of the serialized item. + + + Read a variation model from a file. + File name. + ID of the variation model. + + + Write a variation model to a file. + ID of the variation model. + File name. + + + Return the threshold images used for image comparison by a variation model. + Threshold image for the lower threshold. + Threshold image for the upper threshold. + ID of the variation model. + + + Return the images used for image comparison by a variation model. + Image of the trained object. + Variation image of the trained object. + ID of the variation model. + + + Compare an image to a variation model. + Image of the object to be compared. + Region containing the points that differ substantially from the model. + ID of the variation model. + Method used for comparing the variation model. Default: "absolute" + + + Compare an image to a variation model. + Image of the object to be compared. + Region containing the points that differ substantially from the model. + ID of the variation model. + + + Prepare a variation model for comparison with an image. + Reference image of the object. + Variation image of the object. + ID of the variation model. + Absolute minimum threshold for the differences between the image and the variation model. Default: 10 + Threshold for the differences based on the variation of the variation model. Default: 2 + + + Prepare a variation model for comparison with an image. + ID of the variation model. + Absolute minimum threshold for the differences between the image and the variation model. Default: 10 + Threshold for the differences based on the variation of the variation model. Default: 2 + + + Train a variation model. + Images of the object to be trained. + ID of the variation model. + + + This operator is inoperable. It had the following function: Free the memory of all variation models. + + + Free the memory of a variation model. + ID of the variation model. + + + Free the memory of the training data of a variation model. + ID of the variation model. + + + Create a variation model for image comparison. + Width of the images to be compared. Default: 640 + Height of the images to be compared. Default: 480 + Type of the images to be compared. Default: "byte" + Method used for computing the variation model. Default: "standard" + ID of the variation model. + + + Compute the union set of two input tuples. + Input tuple. + Input tuple. + The union set of two input tuples. + + + Compute the intersection set of two input tuples. + Input tuple. + Input tuple. + The intersection set of two input tuples. + + + Compute the difference set of two input tuples. + Input tuple. + Input tuple. + The difference set of two input tuples. + + + Compute the symmetric difference set of two input tuples. + Input tuple. + Input tuple. + The symmetric difference set of two input tuples. + + + Test whether the types of the elements of a tuple are of type string. + Input tuple. + Are the elements of the input tuple of type string? + + + Test whether the types of the elements of a tuple are of type real. + Input tuple. + Are the elements of the input tuple of type real? + + + Test whether the types of the elements of a tuple are of type integer. + Input tuple. + Are the elements of the input tuple of type integer? + + + Return the types of the elements of a tuple. + Input tuple. + Types of the elements of the input tuple as integer values. + + + Test whether a tuple is of type mixed. + Input tuple. + Is the input tuple of type mixed? + + + Test if the internal representation of a tuple is of type string. + Input tuple. + Is the input tuple of type string? + + + Test if the internal representation of a tuple is of type real. + Input tuple. + Is the input tuple of type real? + + + Test if the internal representation of a tuple is of type integer. + Input tuple. + Is the input tuple of type integer? + + + Return the type of a tuple. + Input tuple. + Type of the input tuple as an integer number. + + + Calculate the value distribution of a tuple within a certain value range. + Input tuple. + Minimum value. + Maximum value. + Number of bins. + Histogram to be calculated. + Bin size. + + + Select tuple elements matching a regular expression. + Input strings to match. + Regular expression. Default: ".*" + Matching strings + + + Test if a string matches a regular expression. + Input strings to match. + Regular expression. Default: ".*" + Number of matching strings + + + Replace a substring using regular expressions. + Input strings to process. + Regular expression. Default: ".*" + Replacement expression. + Processed strings. + + + Extract substrings using regular expressions. + Input strings to match. + Regular expression. Default: ".*" + Found matches. + + + Return a tuple of random numbers between 0 and 1. + Length of tuple to generate. + Tuple of random numbers. + + + Return the number of elements of a tuple. + Input tuple. + Number of elements of input tuple. + + + Calculate the sign of a tuple. + Input tuple. + Signs of the input tuple as integer numbers. + + + Calculate the elementwise maximum of two tuples. + Input tuple 1. + Input tuple 2. + Elementwise maximum of the input tuples. + + + Calculate the elementwise minimum of two tuples. + Input tuple 1. + Input tuple 2. + Elementwise minimum of the input tuples. + + + Return the maximal element of a tuple. + Input tuple. + Maximal element of the input tuple elements. + + + Return the minimal element of a tuple. + Input tuple. + Minimal element of the input tuple elements. + + + Calculate the cumulative sums of a tuple. + Input tuple. + Cumulative sum of the corresponding tuple elements. + + + Select the element of rank n of a tuple. + Input tuple. + Rank of the element to select. + Selected tuple element. + + + Return the median of the elements of a tuple. + Input tuple. + Median of the tuple elements. + + + Return the sum of all elements of a tuple. + Input tuple. + Sum of tuple elements. + + + Return the mean value of a tuple of numbers. + Input tuple. + Mean value of tuple elements. + + + Return the standard deviation of the elements of a tuple. + Input tuple. + Standard deviation of tuple elements. + + + Discard all but one of successive identical elements of a tuple. + Input tuple. + Tuple without successive identical elements. + + + Return the index of the last occurrence of a tuple within another tuple. + Input tuple to examine. + Input tuple with values to find. + Index of the last occurrence of the values to find. + + + Return the index of the first occurrence of a tuple within another tuple. + Input tuple to examine. + Input tuple with values to find. + Index of the first occurrence of the values to find. + + + Return the indices of all occurrences of a tuple within another tuple. + Input tuple to examine. + Input tuple with values to find. + Indices of the occurrences of the values to find in the tuple to examine. + + + Sort the elements of a tuple and return the indices of the sorted tuple. + Input tuple. + Sorted tuple. + + + Sort the elements of a tuple in ascending order. + Input tuple. + Sorted tuple. + + + Invert a tuple. + Input tuple. + Inverted input tuple. + + + Concatenate two tuples to a new one. + Input tuple 1. + Input tuple 2. + Concatenation of input tuples. + + + Select several elements of a tuple. + Input tuple. + Index of first element to select. + Index of last element to select. + Selected tuple elements. + + + Select all elements from index "n" to the end of a tuple. + Input tuple. + Index of the first element to select. + Selected tuple elements. + + + Select the first elements of a tuple up to the index "n". + Input tuple. + Index of the last element to select. + Selected tuple elements. + + + Inserts one or more elements into a tuple at index. + Input tuple. + Start index of elements to be inserted. + Element(s) to insert at index. + Tuple with inserted elements. + + + Replaces one or more elements of a tuple. + Input tuple. + Index/Indices of elements to be replaced. + Element(s) to replace. + Tuple with replaced elements. + + + Remove elements from a tuple. + Input tuple. + Indices of the elements to remove. + Reduced tuple. + + + Select in mask specified elements of a tuple. + Input tuple. + greater than 0 specifies the elements to select. + Selected tuple elements. + + + Select single elements of a tuple. + Input tuple. + Indices of the elements to select. + Selected tuple element. + + + Select single character or bit from a tuple. + Input tuple. + Position of character or bit to select. + Tuple containing the selected characters and bits. + + + Generate a tuple with a sequence of equidistant values. + Start value of the tuple. + Maximum value for the last entry. + Increment value. + The resulting sequence. + + + Generate a tuple of a specific length and initialize its elements. + Length of tuple to generate. + Constant for initializing the tuple elements. + New Tuple. + + + Read one or more environment variables. + Tuple containing name(s) of the environment variable(s). + Content of the environment variable(s). + + + Split strings into substrings using predefined separator symbol(s). + Input tuple with string(s) to split. + Input tuple with separator symbol(s). + Substrings after splitting the input strings. + + + Cut characters from position "n1" through "n2" out of a string tuple. + Input tuple with string(s) to examine. + Input tuple with start position(s) "n1". + Input tuple with end position(s) "n2". + Characters of the string(s) from position "n1" to "n2". + + + Cut all characters starting at position "n" out of a string tuple. + Input tuple with string(s) to examine. + Input tuple with position(s) "n". + The last characters of the string(s) starting at position "n". + + + Cut the first characters up to position "n" out of a string tuple. + Input tuple with string(s) to examine. + Input tuple with position(s) "n". + The first characters of the string(s) up to position "n". + + + Backward search for characters within a string tuple. + Input tuple with string(s) to examine. + Input tuple with character(s) to search. + Position of searched character(s) within the string(s). + + + Forward search for characters within a string tuple. + Input tuple with string(s) to examine. + Input tuple with character(s) to search. + Position of searched character(s) within the string(s). + + + Backward search for strings within a string tuple. + Input tuple with string(s) to examine. + Input tuple with string(s) to search. + Position of searched string(s) within the examined string(s). + + + Forward search for strings within a string tuple. + Input tuple with string(s) to examine. + Input tuple with string(s) to search. + Position of searched string(s) within the examined string(s). + + + Determine the length of every string within a tuple of strings. + Input tuple. + Lengths of the single strings of the input tuple. + + + Test, whether a tuple is elementwise less or equal to another tuple. + Input tuple 1. + Input tuple 2. + Result of the comparison of the input tuples. + + + Test, whether a tuple is elementwise less than another tuple. + Input tuple 1. + Input tuple 2. + Result of the comparison of the input tuples. + + + Test, whether a tuple is elementwise greater or equal to another tuple. + Input tuple 1. + Input tuple 2. + Result of the comparison of the input tuples. + + + Test, whether a tuple is elementwise greater than another tuple. + Input tuple 1. + Input tuple 2. + Result of the comparison of the input tuples. + + + Test, whether two tuples are elementwise not equal. + Input tuple 1. + Input tuple 2. + Result of the comparison of the input tuples. + + + Test, whether two tuples are elementwise equal. + Input tuple 1. + Input tuple 2. + Result of the comparison of the input tuples. + + + Test whether a tuple is less or equal to another tuple. + Input tuple 1. + Input tuple 2. + Result of the comparison of the input tuples. + + + Test whether a tuple is less than another tuple. + Input tuple 1. + Input tuple 2. + Result of the comparison of the input tuples. + + + Test whether a tuple is greater or equal to another tuple. + Input tuple 1. + Input tuple 2. + Result of the comparison of the input tuples. + + + Test whether a tuple is greater than another tuple. + Input tuple 1. + Input tuple 2. + Result of the comparison of the input tuples. + + + Test whether two tuples are not equal. + Input tuple 1. + Input tuple 2. + Result of the comparison of the input tuples. + + + Test whether two tuples are equal. + Input tuple 1. + Input tuple 2. + Result of the comparison of the input tuples. + + + Compute the logical not of a tuple. + Input tuple. + Binary not of the input tuple. + + + Compute the logical exclusive or of two tuples. + Input tuple 1. + Input tuple 2. + Binary exclusive or of the input tuples. + + + Compute the logical or of two tuples. + Input tuple 1. + Input tuple 2. + Logical or of the input tuples. + + + Compute the logical and of two tuples. + Input tuple 1. + Input tuple 2. + Logical and of the input tuples. + + + Compute the bitwise not of a tuple. + Input tuple. + Binary not of the input tuple. + + + Compute the bitwise exclusive or of two tuples. + Input tuple 1. + Input tuple 2. + Binary exclusive or of the input tuples. + + + Compute the bitwise or of two tuples. + Input tuple 1. + Input tuple 2. + Binary or of the input tuples. + + + Compute the bitwise and of two tuples. + Input tuple 1. + Input tuple 2. + Binary and of the input tuples. + + + Shift a tuple bitwise to the right. + Input tuple. + Number of places to shift the input tuple. + Shifted input tuple. + + + Shift a tuple bitwise to the left. + Input tuple. + Number of places to shift the input tuple. + Shifted input tuple. + + + Convert a tuple of integer numbers into strings. + Input tuple with integer numbers. + Output tuple with strings that are separated by the number 0. + + + Convert a tuple of strings into a tuple of integer numbers. + Input tuple with strings. + Output tuple with the Unicode character codes or ANSI codes of the input string. + + + Convert a tuple of integer numbers into strings. + Input tuple with Unicode character codes or ANSI codes. + Output tuple with strings built from the character codes in the input tuple. + + + Convert a tuple of strings of length 1 into a tuple of integer numbers. + Input tuple with strings of length 1. + Output tuple with Unicode character codes or ANSI codes of the characters passed in the input tuple. + + + Convert a tuple into a tuple of strings. + Input tuple. + Format string. + Input tuple converted to strings. + + + Check a tuple (of strings) whether it represents numbers. + Input tuple. + Tuple with boolean numbers. + + + Convert a tuple (of strings) into a tuple of numbers. + Input tuple. + Input tuple as numbers. + + + Convert a tuple into a tuple of integer numbers. + Input tuple. + Result of the rounding. + + + Convert a tuple into a tuple of integer numbers. + Input tuple. + Result of the conversion into integer numbers. + + + Convert a tuple into a tuple of floating point numbers. + Input tuple. + Input tuple as floating point numbers. + + + Calculate the ldexp function of two tuples. + Input tuple 1. + Input tuple 2. + Ldexp function of the input tuples. + + + Calculate the remainder of the floating point division of two tuples. + Input tuple 1. + Input tuple 2. + Remainder of the division of the input tuples. + + + Calculate the remainder of the integer division of two tuples. + Input tuple 1. + Input tuple 2. + Remainder of the division of the input tuples. + + + Compute the ceiling function of a tuple. + Input tuple. + Ceiling function of the input tuple. + + + Compute the floor function of a tuple. + Input tuple. + Floor function of the input tuple. + + + Calculate the power function of two tuples. + Input tuple 1. + Input tuple 2. + Power function of the input tuples. + + + Compute the base 10 logarithm of a tuple. + Input tuple. + Base 10 logarithm of the input tuple. + + + Compute the natural logarithm of a tuple. + Input tuple. + Natural logarithm of the input tuple. + + + Compute the exponential of a tuple. + Input tuple. + Exponential of the input tuple. + + + Compute the hyperbolic tangent of a tuple. + Input tuple. + Hyperbolic tangent of the input tuple. + + + Compute the hyperbolic cosine of a tuple. + Input tuple. + Hyperbolic cosine of the input tuple. + + + Compute the hyperbolic sine of a tuple. + Input tuple. + Hyperbolic sine of the input tuple. + + + Convert a tuple from degrees to radians. + Input tuple. + Input tuple in radians. + + + Convert a tuple from radians to degrees. + Input tuple. + Input tuple in degrees. + + + Compute the arctangent of a tuple for all four quadrants. + Input tuple of the y-values. + Input tuple of the x-values. + Arctangent of the input tuple. + + + Compute the arctangent of a tuple. + Input tuple. + Arctangent of the input tuple. + + + Compute the arccosine of a tuple. + Input tuple. + Arccosine of the input tuple. + + + Compute the arcsine of a tuple. + Input tuple. + Arcsine of the input tuple. + + + Compute the tangent of a tuple. + Input tuple. + Tangent of the input tuple. + + + Compute the cosine of a tuple. + Input tuple. + Cosine of the input tuple. + + + Compute the sine of a tuple. + Input tuple. + Sine of the input tuple. + + + Compute the absolute value of a tuple (as floating point numbers). + Input tuple. + Absolute value of the input tuple. + + + Compute the square root of a tuple. + Input tuple. + Square root of the input tuple. + + + Compute the absolute value of a tuple. + Input tuple. + Absolute value of the input tuple. + + + Negate a tuple. + Input tuple. + Negation of the input tuple. + + + Divide two tuples. + Input tuple 1. + Input tuple 2. + Quotient of the input tuples. + + + Multiply two tuples. + Input tuple 1. + Input tuple 2. + Product of the input tuples. + + + Subtract two tuples. + Input tuple 1. + Input tuple 2. + Difference of the input tuples. + + + Add two tuples. + Input tuple 1. + Input tuple 2. + Sum of the input tuples. + + + Deserialize a serialized tuple. + Handle of the serialized item. + Tuple. + + + Serialize a tuple. + Tuple. + Handle of the serialized item. + + + Write a tuple to a file. + Tuple with any kind of data. + Name of the file to be written. + + + Read a tuple from a file. + Name of the file to be read. + Tuple with any kind of data. + + + Compute the average of a set of poses. + Set of poses of which the average if computed. + Empty tuple, or one weight per pose. Default: [] + Averaging mode. Default: "iterative" + Weight of the translation. Default: "auto" + Weight of the rotation. Default: "auto" + Weighted mean of the poses. + Deviation of the mean from the input poses. + + + Perform a rotation by a unit quaternion. + Rotation quaternion. + X coordinate of the point to be rotated. + Y coordinate of the point to be rotated. + Z coordinate of the point to be rotated. + X coordinate of the rotated point. + Y coordinate of the rotated point. + Z coordinate of the rotated point. + + + Generate the conjugation of a quaternion. + Input quaternion. + Conjugated quaternion. + + + Normalize a quaternion. + Input quaternion. + Normalized quaternion. + + + Create a rotation quaternion. + X component of the rotation axis. + Y component of the rotation axis. + Z component of the rotation axis. + Rotation angle in radians. + Rotation quaternion. + + + Convert a quaternion into the corresponding 3D pose. + Rotation quaternion. + 3D Pose. + + + Invert each pose in a tuple of 3D poses. + Tuple of 3D poses. + Tuple of inverted 3D poses. + + + Combine 3D poses given in two tuples. + Tuple containing the left poses. + Tuple containing the right poses. + Tuple containing the returned poses. + + + Convert a quaternion into the corresponding rotation matrix. + Rotation quaternion. + Rotation matrix. + + + Convert the rotational part of a 3D pose to a quaternion. + 3D Pose. + Rotation quaternion. + + + Interpolation of two quaternions. + Start quaternion. + End quaternion. + Interpolation parameter. Default: 0.5 + Interpolated quaternion. + + + Multiply two quaternions. + Left quaternion. + Right quaternion. + Product of the input quaternions. + + + Deserialize a serialized homogeneous 3D transformation matrix. + Handle of the serialized item. + Transformation matrix. + + + Serialize a homogeneous 3D transformation matrix. + Transformation matrix. + Handle of the serialized item. + + + Deserialize a serialized homogeneous 2D transformation matrix. + Handle of the serialized item. + Transformation matrix. + + + Serialize a homogeneous 2D transformation matrix. + Transformation matrix. + Handle of the serialized item. + + + Deserialize a serialized quaternion. + Handle of the serialized item. + Quaternion. + + + Serialize a quaternion. + Quaternion. + Handle of the serialized item. + + + Project a homogeneous 3D point using a projective transformation matrix. + Homogeneous projective transformation matrix. + Input point (x coordinate). + Input point (y coordinate). + Input point (z coordinate). + Input point (w coordinate). + Output point (x coordinate). + Output point (y coordinate). + Output point (z coordinate). + Output point (w coordinate). + + + Project a 3D point using a projective transformation matrix. + Homogeneous projective transformation matrix. + Input point (x coordinate). + Input point (y coordinate). + Input point (z coordinate). + Output point (x coordinate). + Output point (y coordinate). + Output point (z coordinate). + + + Apply an arbitrary affine 3D transformation to points. + Input transformation matrix. + Input point(s) (x coordinate). Default: 64 + Input point(s) (y coordinate). Default: 64 + Input point(s) (z coordinate). Default: 64 + Output point(s) (x coordinate). + Output point(s) (y coordinate). + Output point(s) (z coordinate). + + + Approximate a 3D transformation from point correspondences. + Type of the transformation to compute. Default: "rigid" + X coordinates of the original points. + Y coordinates of the original points. + Z coordinates of the original points. + X coordinates of the transformed points. + Y coordinates of the transformed points. + Z coordinates of the transformed points. + Output transformation matrix. + + + Compute the determinant of a homogeneous 3D transformation matrix. + Input transformation matrix. + Determinant of the input matrix. + + + Transpose a homogeneous 3D transformation matrix. + Input transformation matrix. + Output transformation matrix. + + + Invert a homogeneous 3D transformation matrix. + Input transformation matrix. + Output transformation matrix. + + + Multiply two homogeneous 3D transformation matrices. + Left input transformation matrix. + Right input transformation matrix. + Output transformation matrix. + + + Add a rotation to a homogeneous 3D transformation matrix. + Input transformation matrix. + Rotation angle. Default: 0.78 + Axis, to be rotated around. Default: "x" + Output transformation matrix. + + + Add a rotation to a homogeneous 3D transformation matrix. + Input transformation matrix. + Rotation angle. Default: 0.78 + Axis, to be rotated around. Default: "x" + Fixed point of the transformation (x coordinate). Default: 0 + Fixed point of the transformation (y coordinate). Default: 0 + Fixed point of the transformation (z coordinate). Default: 0 + Output transformation matrix. + + + Add a scaling to a homogeneous 3D transformation matrix. + Input transformation matrix. + Scale factor along the x-axis. Default: 2 + Scale factor along the y-axis. Default: 2 + Scale factor along the z-axis. Default: 2 + Output transformation matrix. + + + Add a scaling to a homogeneous 3D transformation matrix. + Input transformation matrix. + Scale factor along the x-axis. Default: 2 + Scale factor along the y-axis. Default: 2 + Scale factor along the z-axis. Default: 2 + Fixed point of the transformation (x coordinate). Default: 0 + Fixed point of the transformation (y coordinate). Default: 0 + Fixed point of the transformation (z coordinate). Default: 0 + Output transformation matrix. + + + Add a translation to a homogeneous 3D transformation matrix. + Input transformation matrix. + Translation along the x-axis. Default: 64 + Translation along the y-axis. Default: 64 + Translation along the z-axis. Default: 64 + Output transformation matrix. + + + Add a translation to a homogeneous 3D transformation matrix. + Input transformation matrix. + Translation along the x-axis. Default: 64 + Translation along the y-axis. Default: 64 + Translation along the z-axis. Default: 64 + Output transformation matrix. + + + Generate the homogeneous transformation matrix of the identical 3D transformation. + Transformation matrix. + + + Project an affine 3D transformation matrix to a 2D projective transformation matrix. + 3x4 3D transformation matrix. + Row coordinate of the principal point. Default: 256 + Column coordinate of the principal point. Default: 256 + Focal length in pixels. Default: 256 + Homogeneous projective transformation matrix. + + + Perform a bundle adjustment of an image mosaic. + Number of different images that are used for the calibration. + Index of the reference image. + Indices of the source images of the transformations. + Indices of the target images of the transformations. + Array of 3x3 projective transformation matrices. + Row coordinates of corresponding points in the respective source images. + Column coordinates of corresponding points in the respective source images. + Row coordinates of corresponding points in the respective destination images. + Column coordinates of corresponding points in the respective destination images. + Number of point correspondences in the respective image pair. + Transformation class to be used. Default: "projective" + Array of 3x3 projective transformation matrices that determine the position of the images in the mosaic. + Row coordinates of the points reconstructed by the bundle adjustment. + Column coordinates of the points reconstructed by the bundle adjustment. + Average error per reconstructed point. + + + Compute a projective transformation matrix and the radial distortion coefficient between two images by finding correspondences between points based on known approximations of the projective transformation matrix and the radial distortion coefficient. + Input image 1. + Input image 2. + Input points in image 1 (row coordinate). + Input points in image 1 (column coordinate). + Input points in image 2 (row coordinate). + Input points in image 2 (column coordinate). + Gray value match metric. Default: "ncc" + Size of gray value masks. Default: 10 + Approximation of the homogeneous projective transformation matrix between the two images. + Approximation of the radial distortion coefficient in the two images. + Tolerance for the matching search window. Default: 20.0 + Threshold for gray value matching. Default: 0.7 + Algorithm for the computation of the projective transformation matrix. Default: "gold_standard" + Threshold for transformation consistency check. Default: 1 + Seed for the random number generator. Default: 0 + Computed homogeneous projective transformation matrix. + Computed radial distortion coefficient. + Root-Mean-Square transformation error. + Indices of matched input points in image 1. + Indices of matched input points in image 2. + + + Compute a projective transformation matrix between two images and the radial distortion coefficient by automatically finding correspondences between points. + Input image 1. + Input image 2. + Input points in image 1 (row coordinate). + Input points in image 1 (column coordinate). + Input points in image 2 (row coordinate). + Input points in image 2 (column coordinate). + Gray value match metric. Default: "ncc" + Size of gray value masks. Default: 10 + Average row coordinate offset of corresponding points. Default: 0 + Average column coordinate offset of corresponding points. Default: 0 + Half height of matching search window. Default: 200 + Half width of matching search window. Default: 200 + Estimate of the relative rotation of the second image with respect to the first image. Default: 0.0 + Threshold for gray value matching. Default: 0.7 + Algorithm for the computation of the projective transformation matrix. Default: "gold_standard" + Threshold for the transformation consistency check. Default: 1 + Seed for the random number generator. Default: 0 + Computed homogeneous projective transformation matrix. + Computed radial distortion coefficient. + Root-Mean-Square transformation error. + Indices of matched input points in image 1. + Indices of matched input points in image 2. + + + Compute a projective transformation matrix between two images by finding correspondences between points based on a known approximation of the projective transformation matrix. + Input image 1. + Input image 2. + Row coordinates of characteristic points in image 1. + Column coordinates of characteristic points in image 1. + Row coordinates of characteristic points in image 2. + Column coordinates of characteristic points in image 2. + Gray value comparison metric. Default: "ssd" + Size of gray value masks. Default: 10 + Approximation of the Homogeneous projective transformation matrix between the two images. + Tolerance for the matching search window. Default: 20.0 + Threshold for gray value matching. Default: 10 + Transformation matrix estimation algorithm. Default: "normalized_dlt" + Threshold for transformation consistency check. Default: 0.2 + Seed for the random number generator. Default: 0 + Homogeneous projective transformation matrix. + Indices of matched input points in image 1. + Indices of matched input points in image 2. + + + Compute a projective transformation matrix between two images by finding correspondences between points. + Input image 1. + Input image 2. + Row coordinates of characteristic points in image 1. + Column coordinates of characteristic points in image 1. + Row coordinates of characteristic points in image 2. + Column coordinates of characteristic points in image 2. + Gray value comparison metric. Default: "ssd" + Size of gray value masks. Default: 10 + Average row coordinate shift. Default: 0 + Average column coordinate shift. Default: 0 + Half height of matching search window. Default: 256 + Half width of matching search window. Default: 256 + Range of rotation angles. Default: 0.0 + Threshold for gray value matching. Default: 10 + Transformation matrix estimation algorithm. Default: "normalized_dlt" + Threshold for transformation consistency check. Default: 0.2 + Seed for the random number generator. Default: 0 + Homogeneous projective transformation matrix. + Indices of matched input points in image 1. + Indices of matched input points in image 2. + + + Compute a projective transformation matrix and the radial distortion coefficient using given image point correspondences. + Input points in image 1 (row coordinate). + Input points in image 1 (column coordinate). + Input points in image 2 (row coordinate). + Input points in image 2 (column coordinate). + Row coordinate variance of the points in image 1. Default: [] + Covariance of the points in image 1. Default: [] + Column coordinate variance of the points in image 1. Default: [] + Row coordinate variance of the points in image 2. Default: [] + Covariance of the points in image 2. Default: [] + Column coordinate variance of the points in image 2. Default: [] + Width of the images from which the points were extracted. + Height of the images from which the points were extracted. + Estimation algorithm. Default: "gold_standard" + Homogeneous projective transformation matrix. + Computed radial distortion coefficient. + Root-Mean-Square transformation error. + + + Compute a homogeneous transformation matrix using given point correspondences. + Input points 1 (x coordinate). + Input points 1 (y coordinate). + Input points 1 (w coordinate). + Input points 2 (x coordinate). + Input points 2 (y coordinate). + Input points 2 (w coordinate). + Estimation algorithm. Default: "normalized_dlt" + Homogeneous projective transformation matrix. + + + Compute a projective transformation matrix using given point correspondences. + Input points in image 1 (row coordinate). + Input points in image 1 (column coordinate). + Input points in image 2 (row coordinate). + Input points in image 2 (column coordinate). + Estimation algorithm. Default: "normalized_dlt" + Row coordinate variance of the points in image 1. Default: [] + Column coordinate variance of the points in image 1. Default: [] + Covariance of the points in image 1. Default: [] + Row coordinate variance of the points in image 2. Default: [] + Column coordinate variance of the points in image 2. Default: [] + Covariance of the points in image 2. Default: [] + Homogeneous projective transformation matrix. + 9x9 covariance matrix of the projective transformation matrix. + + + Compute the affine transformation parameters from a homogeneous 2D transformation matrix. + Input transformation matrix. + Scaling factor along the x direction. + Scaling factor along the y direction. + Rotation angle. + Slant angle. + Translation along the x direction. + Translation along the y direction. + + + Compute a rigid affine transformation from points and angles. + Row coordinate of the original point. + Column coordinate of the original point. + Angle of the original point. + Row coordinate of the transformed point. + Column coordinate of the transformed point. + Angle of the transformed point. + Output transformation matrix. + + + Approximate an affine transformation from point-to-line correspondences. + Type of the transformation to compute. Default: "rigid" + X coordinates of the original points. + Y coordinates of the original points. + X coordinates of the first point on the corresponding line. + Y coordinates of the first point on the corresponding line. + X coordinates of the second point on the corresponding line. + Y coordinates of the second point on the corresponding line. + Output transformation matrix. + + + Approximate a rigid affine transformation from point correspondences. + X coordinates of the original points. + Y coordinates of the original points. + X coordinates of the transformed points. + Y coordinates of the transformed points. + Output transformation matrix. + + + Approximate an similarity transformation from point correspondences. + X coordinates of the original points. + Y coordinates of the original points. + X coordinates of the transformed points. + Y coordinates of the transformed points. + Output transformation matrix. + + + Approximate an anisotropic similarity transformation from point correspondences. + X coordinates of the original points. + Y coordinates of the original points. + X coordinates of the transformed points. + Y coordinates of the transformed points. + Output transformation matrix. + + + Approximate an affine transformation from point correspondences. + X coordinates of the original points. + Y coordinates of the original points. + X coordinates of the transformed points. + Y coordinates of the transformed points. + Output transformation matrix. + + + Project pixel coordinates using a homogeneous projective transformation matrix. + Homogeneous projective transformation matrix. + Input pixel(s) (row coordinate). Default: 64 + Input pixel(s) (column coordinate). Default: 64 + Output pixel(s) (row coordinate). + Output pixel(s) (column coordinate). + + + Project a homogeneous 2D point using a projective transformation matrix. + Homogeneous projective transformation matrix. + Input point (x coordinate). + Input point (y coordinate). + Input point (w coordinate). + Output point (x coordinate). + Output point (y coordinate). + Output point (w coordinate). + + + Apply an arbitrary affine 2D transformation to pixel coordinates. + Input transformation matrix. + Input pixel(s) (row coordinate). Default: 64 + Input pixel(s) (column coordinate). Default: 64 + Output pixel(s) (row coordinate). + Output pixel(s) (column coordinate). + + + Apply an arbitrary affine 2D transformation to points. + Input transformation matrix. + Input point(s) (x or row coordinate). Default: 64 + Input point(s) (y or column coordinate). Default: 64 + Output point(s) (x or row coordinate). + Output point(s) (y or column coordinate). + + + Compute the determinant of a homogeneous 2D transformation matrix. + Input transformation matrix. + Determinant of the input matrix. + + + Transpose a homogeneous 2D transformation matrix. + Input transformation matrix. + Output transformation matrix. + + + Invert a homogeneous 2D transformation matrix. + Input transformation matrix. + Output transformation matrix. + + + Multiply two homogeneous 2D transformation matrices. + Left input transformation matrix. + Right input transformation matrix. + Output transformation matrix. + + + Add a reflection to a homogeneous 2D transformation matrix. + Input transformation matrix. + Point that defines the axis (x coordinate). Default: 16 + Point that defines the axis (y coordinate). Default: 32 + Output transformation matrix. + + + Add a reflection to a homogeneous 2D transformation matrix. + Input transformation matrix. + First point of the axis (x coordinate). Default: 0 + First point of the axis (y coordinate). Default: 0 + Second point of the axis (x coordinate). Default: 16 + Second point of the axis (y coordinate). Default: 32 + Output transformation matrix. + + + Add a slant to a homogeneous 2D transformation matrix. + Input transformation matrix. + Slant angle. Default: 0.78 + Coordinate axis that is slanted. Default: "x" + Output transformation matrix. + + + Add a slant to a homogeneous 2D transformation matrix. + Input transformation matrix. + Slant angle. Default: 0.78 + Coordinate axis that is slanted. Default: "x" + Fixed point of the transformation (x coordinate). Default: 0 + Fixed point of the transformation (y coordinate). Default: 0 + Output transformation matrix. + + + Add a rotation to a homogeneous 2D transformation matrix. + Input transformation matrix. + Rotation angle. Default: 0.78 + Output transformation matrix. + + + Add a rotation to a homogeneous 2D transformation matrix. + Input transformation matrix. + Rotation angle. Default: 0.78 + Fixed point of the transformation (x coordinate). Default: 0 + Fixed point of the transformation (y coordinate). Default: 0 + Output transformation matrix. + + + Add a scaling to a homogeneous 2D transformation matrix. + Input transformation matrix. + Scale factor along the x-axis. Default: 2 + Scale factor along the y-axis. Default: 2 + Output transformation matrix. + + + Add a scaling to a homogeneous 2D transformation matrix. + Input transformation matrix. + Scale factor along the x-axis. Default: 2 + Scale factor along the y-axis. Default: 2 + Fixed point of the transformation (x coordinate). Default: 0 + Fixed point of the transformation (y coordinate). Default: 0 + Output transformation matrix. + + + Add a translation to a homogeneous 2D transformation matrix. + Input transformation matrix. + Translation along the x-axis. Default: 64 + Translation along the y-axis. Default: 64 + Output transformation matrix. + + + Add a translation to a homogeneous 2D transformation matrix. + Input transformation matrix. + Translation along the x-axis. Default: 64 + Translation along the y-axis. Default: 64 + Output transformation matrix. + + + Generate the homogeneous transformation matrix of the identical 2D transformation. + Transformation matrix. + + + This operator is inoperable. It had the following function: Clear all scattered data interpolators. + + + Clear a scattered data interpolator. + Handle of the scattered data interpolator + + + Interpolation of scattered data using a scattered data interpolator. + Handle of the scattered data interpolator + Row coordinates of points to be interpolated + Column coordinates of points to be interpolated + Values of interpolated points + + + Creates an interpolator for the interpolation of scattered data. + Method for the interpolation Default: "thin_plate_splines" + Row coordinates of the points used for the interpolation + Column coordinates of the points used for the interpolation + Values of the points used for the interpolation + Names of the generic parameters that can be adjusted Default: [] + Values of the generic parameters that can be adjusted Default: [] + Handle of the scattered data interpolator + + + Creating an image from the interpolation of scattered data. + Interpolated image + Method for the interpolation Default: "thin_plate_splines" + Row coordinates of the points used for the interpolation + Column coordinates of the points used for the interpolation + Values of the points used for the interpolation + Width of the interpolated image Default: 640 + Height of the interpolated image Default: 480 + Names of the generic parameters that can be adjusted Default: [] + Values of the generic parameters that can be adjusted Default: [] + + + Interpolation of an image. + Image to interpolate + Region to interpolate + Interpolated image + Method for the interpolation Default: "thin_plate_splines" + Names of the generic parameters that can be adjusted Default: [] + Values of the generic parameters that can be adjusted Default: [] + + + Read out the system time. + Milliseconds (0..999). + Seconds (0..59). + Minutes (0..59). + Hours (0..23). + Day of the month (1..31). + Day of the year (1..366). + Month (1..12). + Year (xxxx). + + + Query compute device parameters. + Compute device handle. + Name of the parameter to query. Default: "buffer_cache_capacity" + Value of the parameter. + + + Set parameters of an compute device. + Compute device handle. + Name of the parameter to set. Default: "buffer_cache_capacity" + New parameter value. + + + Close all compute devices. + + + Close a compute_device. + Compute device handle. + + + Deactivate all compute devices. + + + Deactivate a compute device. + Compute device handle. + + + Activate a compute device. + Compute device handle. + + + Initialize a compute device. + Compute device handle. + List of operators to prepare. Default: "all" + + + Open a compute device. + Compute device Identifier. + Compute device handle. + + + Get information on a compute device. + Compute device handle. + Name of Information to query. Default: "name" + Returned information. + + + Get the list of available compute devices. + List of available compute devices. + + + Clear the buffer of a serial connection. + Serial interface handle. + Buffer to be cleared. Default: "input" + + + Write to a serial connection. + Serial interface handle. + Characters to write (as tuple of integers). + + + Read from a serial device. + Serial interface handle. + Number of characters to read. Default: 1 + Read characters (as tuple of integers). + + + Get the parameters of a serial device. + Serial interface handle. + Speed of the serial interface. + Number of data bits of the serial interface. + Type of flow control of the serial interface. + Parity of the serial interface. + Number of stop bits of the serial interface. + Total timeout of the serial interface in ms. + Inter-character timeout of the serial interface in ms. + + + Set the parameters of a serial device. + Serial interface handle. + Speed of the serial interface. Default: "unchanged" + Number of data bits of the serial interface. Default: "unchanged" + Type of flow control of the serial interface. Default: "unchanged" + Parity of the serial interface. Default: "unchanged" + Number of stop bits of the serial interface. Default: "unchanged" + Total timeout of the serial interface in ms. Default: "unchanged" + Inter-character timeout of the serial interface in ms. Default: "unchanged" + + + This operator is inoperable. It had the following function: Close all serial devices. + + + Close a serial device. + Serial interface handle. + + + Open a serial device. + Name of the serial port. Default: "COM1" + Serial interface handle. + + + Delaying the execution of the program. + Number of seconds by which the execution of the program will be delayed. Default: 10 + + + Execute a system command. + Command to be called by the system. Default: "ls" + + + Set HALCON system parameters. + Name of the system parameter to be changed. Default: "init_new_image" + New value of the system parameter. Default: "true" + + + Activating and deactivating of HALCON control modes. + Desired control mode. Default: "default" + + + Initialization of the HALCON system. + Default image width (in pixels). Default: 128 + Default image height (in pixels). Default: 128 + Usual number of channels. Default: 0 + + + Get current value of HALCON system parameters. + Desired system parameter. Default: "init_new_image" + Current value of the system parameter. + + + State of the HALCON control modes. + Tuplet of the currently activated control modes. + + + Inquiry after the error text of a HALCON error number. + HALCON error code. + Corresponding error message. + + + Passed Time. + Processtime since the program start. + + + Number of entries in the HALCON database. + Relation of interest of the HALCON database. Default: "object" + Number of tuples in the relation. + + + Receive an image over a socket connection. + Received image. + Socket number. + + + Send an image over a socket connection. + Image to be sent. + Socket number. + + + Receive regions over a socket connection. + Received regions. + Socket number. + + + Send regions over a socket connection. + Regions to be sent. + Socket number. + + + Receive an XLD object over a socket connection. + Received XLD object. + Socket number. + + + Send an XLD object over a socket connection. + XLD object to be sent. + Socket number. + + + Receive a tuple over a socket connection. + Socket number. + Received tuple. + + + Send a tuple over a socket connection. + Socket number. + Tuple to be sent. + + + Receive arbitrary data from external devices or applications using a generic socket connection. + Socket number. + Specification how to convert the data to tuples. Default: "z" + Value (or tuple of values) holding the received and converted data. + IP address or hostname and network port of the communication partner. + + + Send arbitrary data to external devices or applications using a generic socket communication. + Socket number. + Specification how to convert the data. Default: "z" + Value (or tuple of values) holding the data to send. + IP address or hostname and network port of the communication partner. Default: [] + + + Get the value of a socket parameter. + Socket number. + Name of the socket parameter. + Value of the socket parameter. + + + Set a socket parameter. + Socket number. + Name of the socket parameter. + Value of the socket parameter. Default: "on" + + + Determine the HALCON data type of the next socket data. + Socket number. + Data type of next HALCON data. + + + Get the socket descriptor of a socket used by the operating system. + Socket number. + Socket descriptor used by the operating system. + + + This operator is inoperable. It had the following function: Close all opened sockets. + + + Close a socket. + Socket number. + + + Accept a connection request on a listening socket of the protocol type 'HALCON' or 'TCP'/'TCP4'/'TCP6'. + Socket number of the accepting socket. + Should the operator wait until a connection request arrives? Default: "auto" + Socket number. + + + Open a socket and connect it to an accepting socket. + Hostname of the computer to connect to. Default: "localhost" + Port number. + Names of the generic parameters that can be adjusted for the socket. Default: [] + Values of the generic parameters that can be adjusted for the socket. Default: [] + Socket number. + + + Open a socket that accepts connection requests. + Port number. Default: 3000 + Names of the generic parameters that can be adjusted for the socket. Default: [] + Values of the generic parameters that can be adjusted for the socket. Default: [] + Socket number. + + + Returns the extended error information for the calling thread's last HALCON error. + Operator that set the error code. + Extended error code. + Extended error message. + + + Query of used modules and the module key. + Names of used modules. + Key for license manager. + + + Compute the distance values for a rectified stereo image pair using multi-scanline optimization. + Rectified image of camera 1. + Rectified image of camera 2. + Distance image. + Score of the calculated disparity. + Internal camera parameters of the rectified camera 1. + Internal camera parameters of the rectified camera 2. + Point transformation from the rectified camera 2 to the rectified camera 1. + Minimum of the expected disparities. Default: -30 + Maximum of the expected disparities. Default: 30 + Smoothing of surfaces. Default: 50 + Smoothing of edges. Default: 50 + Parameter name(s) for the multi-scanline algorithm. Default: [] + Parameter value(s) for the multi-scanline algorithm. Default: [] + + + Compute the disparities of a rectified stereo image pair using multi-scanline optimization. + Rectified image of camera 1. + Rectified image of camera 2. + Disparity map. + Score of the calculated disparity. + Minimum of the expected disparities. Default: -30 + Maximum of the expected disparities. Default: 30 + Smoothing of surfaces. Default: 50 + Smoothing of edges. Default: 50 + Parameter name(s) for the multi-scanline algorithm. Default: [] + Parameter value(s) for the multi-scanline algorithm. Default: [] + + + Compute the distance values for a rectified stereo image pair using multigrid methods. + Rectified image of camera 1. + Rectified image of camera 2. + Distance image. + Score of the calculated disparity if CalculateScore is set to 'true'. + Internal camera parameters of the rectified camera 1. + Internal camera parameters of the rectified camera 2. + Point transformation from the rectified camera 2 to the rectified camera 1. + Weight of the gray value constancy in the data term. Default: 1.0 + Weight of the gradient constancy in the data term. Default: 30.0 + Weight of the smoothness term in relation to the data term. Default: 5.0 + Initial guess of the disparity. Default: 0.0 + Should the quality measure be returned in Score? Default: "false" + Parameter name(s) for the multigrid algorithm. Default: "default_parameters" + Parameter value(s) for the multigrid algorithm. Default: "fast_accurate" + + + Compute the disparities of a rectified stereo image pair using multigrid methods. + Rectified image of camera 1. + Rectified image of camera 2. + Disparity map. + Score of the calculated disparity if CalculateScore is set to 'true'. + Weight of the gray value constancy in the data term. Default: 1.0 + Weight of the gradient constancy in the data term. Default: 30.0 + Weight of the smoothness term in relation to the data term. Default: 5.0 + Initial guess of the disparity. Default: 0.0 + Should the quality measure should be returned in Score? Default: "false" + Parameter name(s) for the multigrid algorithm. Default: "default_parameters" + Parameter value(s) for the multigrid algorithm. Default: "fast_accurate" + + + Compute the projective 3d reconstruction of points based on the fundamental matrix. + Input points in image 1 (row coordinate). + Input points in image 1 (column coordinate). + Input points in image 2 (row coordinate). + Input points in image 2 (column coordinate). + Row coordinate variance of the points in image 1. Default: [] + Covariance of the points in image 1. Default: [] + Column coordinate variance of the points in image 1. Default: [] + Row coordinate variance of the points in image 2. Default: [] + Covariance of the points in image 2. Default: [] + Column coordinate variance of the points in image 2. Default: [] + Fundamental matrix. + 9x9 covariance matrix of the fundamental matrix. Default: [] + X coordinates of the reconstructed points in projective 3D space. + Y coordinates of the reconstructed points in projective 3D space. + Z coordinates of the reconstructed points in projective 3D space. + W coordinates of the reconstructed points in projective 3D space. + Covariance matrices of the reconstructed points. + + + Compute the projective rectification of weakly calibrated binocular stereo images. + Image coding the rectification of the 1. image. + Image coding the rectification of the 2. image. + Fundamental matrix. + 9x9 covariance matrix of the fundamental matrix. Default: [] + Width of the 1. image. Default: 512 + Height of the 1. image. Default: 512 + Width of the 2. image. Default: 512 + Height of the 2. image. Default: 512 + Subsampling factor. Default: 1 + Type of mapping. Default: "no_map" + 9x9 covariance matrix of the rectified fundamental matrix. + Projective transformation of the 1. image. + Projective transformation of the 2. image. + + + Compute the fundamental matrix and the radial distortion coefficient given a set of image point correspondences and reconstruct 3D points. + Input points in image 1 (row coordinate). + Input points in image 1 (column coordinate). + Input points in image 2 (row coordinate). + Input points in image 2 (column coordinate). + Row coordinate variance of the points in image 1. Default: [] + Covariance of the points in image 1. Default: [] + Column coordinate variance of the points in image 1. Default: [] + Row coordinate variance of the points in image 2. Default: [] + Covariance of the points in image 2. Default: [] + Column coordinate variance of the points in image 2. Default: [] + Width of the images from which the points were extracted. + Height of the images from which the points were extracted. + Estimation algorithm. Default: "gold_standard" + Computed fundamental matrix. + Computed radial distortion coefficient. + Root-Mean-Square epipolar distance error. + X coordinates of the reconstructed points in projective 3D space. + Y coordinates of the reconstructed points in projective 3D space. + Z coordinates of the reconstructed points in projective 3D space. + W coordinates of the reconstructed points in projective 3D space. + + + Compute the fundamental matrix from the relative orientation of two cameras. + Relative orientation of the cameras (3D pose). + 6x6 covariance matrix of relative pose. Default: [] + Parameters of the 1. camera. + Parameters of the 2. camera. + Computed fundamental matrix. + 9x9 covariance matrix of the fundamental matrix. + + + Compute the fundamental matrix from an essential matrix. + Essential matrix. + 9x9 covariance matrix of the essential matrix. Default: [] + Camera matrix of the 1. camera. + Camera matrix of the 2. camera. + Computed fundamental matrix. + 9x9 covariance matrix of the fundamental matrix. + + + Compute the relative orientation between two cameras given image point correspondences and known camera parameters and reconstruct 3D space points. + Input points in image 1 (row coordinate). + Input points in image 1 (column coordinate). + Input points in image 2 (row coordinate). + Input points in image 2 (column coordinate). + Row coordinate variance of the points in image 1. Default: [] + Covariance of the points in image 1. Default: [] + Column coordinate variance of the points in image 1. Default: [] + Row coordinate variance of the points in image 2. Default: [] + Covariance of the points in image 2. Default: [] + Column coordinate variance of the points in image 2. Default: [] + Camera parameters of the 1st camera. + Camera parameters of the 2nd camera. + Algorithm for the computation of the relative pose and for special pose types. Default: "normalized_dlt" + Computed relative orientation of the cameras (3D pose). + 6x6 covariance matrix of the relative camera orientation. + Root-Mean-Square of the epipolar distance error. + X coordinates of the reconstructed 3D points. + Y coordinates of the reconstructed 3D points. + Z coordinates of the reconstructed 3D points. + Covariance matrices of the reconstructed 3D points. + + + Compute the essential matrix given image point correspondences and known camera matrices and reconstruct 3D points. + Input points in image 1 (row coordinate). + Input points in image 1 (column coordinate). + Input points in image 2 (row coordinate). + Input points in image 2 (column coordinate). + Row coordinate variance of the points in image 1. Default: [] + Covariance of the points in image 1. Default: [] + Column coordinate variance of the points in image 1. Default: [] + Row coordinate variance of the points in image 2. Default: [] + Covariance of the points in image 2. Default: [] + Column coordinate variance of the points in image 2. Default: [] + Camera matrix of the 1st camera. + Camera matrix of the 2nd camera. + Algorithm for the computation of the essential matrix and for special camera orientations. Default: "normalized_dlt" + Computed essential matrix. + 9x9 covariance matrix of the essential matrix. + Root-Mean-Square of the epipolar distance error. + X coordinates of the reconstructed 3D points. + Y coordinates of the reconstructed 3D points. + Z coordinates of the reconstructed 3D points. + Covariance matrices of the reconstructed 3D points. + + + Compute the fundamental matrix given a set of image point correspondences and reconstruct 3D points. + Input points in image 1 (row coordinate). + Input points in image 1 (column coordinate). + Input points in image 2 (row coordinate). + Input points in image 2 (column coordinate). + Row coordinate variance of the points in image 1. Default: [] + Covariance of the points in image 1. Default: [] + Column coordinate variance of the points in image 1. Default: [] + Row coordinate variance of the points in image 2. Default: [] + Covariance of the points in image 2. Default: [] + Column coordinate variance of the points in image 2. Default: [] + Estimation algorithm. Default: "normalized_dlt" + Computed fundamental matrix. + 9x9 covariance matrix of the fundamental matrix. + Root-Mean-Square of the epipolar distance error. + X coordinates of the reconstructed points in projective 3D space. + Y coordinates of the reconstructed points in projective 3D space. + Z coordinates of the reconstructed points in projective 3D space. + W coordinates of the reconstructed points in projective 3D space. + Covariance matrices of the reconstructed 3D points. + + + Compute the fundamental matrix and the radial distortion coefficient for a pair of stereo images by automatically finding correspondences between image points. + Input image 1. + Input image 2. + Input points in image 1 (row coordinate). + Input points in image 1 (column coordinate). + Input points in image 2 (row coordinate). + Input points in image 2 (column coordinate). + Gray value match metric. Default: "ncc" + Size of gray value masks. Default: 10 + Average row coordinate offset of corresponding points. Default: 0 + Average column coordinate offset of corresponding points. Default: 0 + Half height of matching search window. Default: 200 + Half width of matching search window. Default: 200 + Estimate of the relative rotation of the second image with respect to the first image. Default: 0.0 + Threshold for gray value matching. Default: 0.7 + Algorithm for the computation of the fundamental matrix and for special camera orientations. Default: "gold_standard" + Maximal deviation of a point from its epipolar line. Default: 1 + Seed for the random number generator. Default: 0 + Computed fundamental matrix. + Computed radial distortion coefficient. + Root-Mean-Square epipolar distance error. + Indices of matched input points in image 1. + Indices of matched input points in image 2. + + + Compute the relative orientation between two cameras by automatically finding correspondences between image points. + Input image 1. + Input image 2. + Row coordinates of characteristic points in image 1. + Column coordinates of characteristic points in image 1. + Row coordinates of characteristic points in image 2. + Column coordinates of characteristic points in image 2. + Parameters of the 1st camera. + Parameters of the 2nd camera. + Gray value comparison metric. Default: "ssd" + Size of gray value masks. Default: 10 + Average row coordinate shift of corresponding points. Default: 0 + Average column coordinate shift of corresponding points. Default: 0 + Half height of matching search window. Default: 200 + Half width of matching search window. Default: 200 + Estimate of the relative orientation of the right image with respect to the left image. Default: 0.0 + Threshold for gray value matching. Default: 10 + Algorithm for the computation of the relative pose and for special pose types. Default: "normalized_dlt" + Maximal deviation of a point from its epipolar line. Default: 1 + Seed for the random number generator. Default: 0 + Computed relative orientation of the cameras (3D pose). + 6x6 covariance matrix of the relative orientation. + Root-Mean-Square of the epipolar distance error. + Indices of matched input points in image 1. + Indices of matched input points in image 2. + + + Compute the essential matrix for a pair of stereo images by automatically finding correspondences between image points. + Input image 1. + Input image 2. + Row coordinates of characteristic points in image 1. + Column coordinates of characteristic points in image 1. + Row coordinates of characteristic points in image 2. + Column coordinates of characteristic points in image 2. + Camera matrix of the 1st camera. + Camera matrix of the 2nd camera. + Gray value comparison metric. Default: "ssd" + Size of gray value masks. Default: 10 + Average row coordinate shift of corresponding points. Default: 0 + Average column coordinate shift of corresponding points. Default: 0 + Half height of matching search window. Default: 200 + Half width of matching search window. Default: 200 + Estimate of the relative orientation of the right image with respect to the left image. Default: 0.0 + Threshold for gray value matching. Default: 10 + Algorithm for the computation of the essential matrix and for special camera orientations. Default: "normalized_dlt" + Maximal deviation of a point from its epipolar line. Default: 1 + Seed for the random number generator. Default: 0 + Computed essential matrix. + 9x9 covariance matrix of the essential matrix. + Root-Mean-Square of the epipolar distance error. + Indices of matched input points in image 1. + Indices of matched input points in image 2. + + + Compute the fundamental matrix for a pair of stereo images by automatically finding correspondences between image points. + Input image 1. + Input image 2. + Row coordinates of characteristic points in image 1. + Column coordinates of characteristic points in image 1. + Row coordinates of characteristic points in image 2. + Column coordinates of characteristic points in image 2. + Gray value comparison metric. Default: "ssd" + Size of gray value masks. Default: 10 + Average row coordinate shift of corresponding points. Default: 0 + Average column coordinate shift of corresponding points. Default: 0 + Half height of matching search window. Default: 200 + Half width of matching search window. Default: 200 + Estimate of the relative orientation of the right image with respect to the left image. Default: 0.0 + Threshold for gray value matching. Default: 10 + Algorithm for the computation of the fundamental matrix and for special camera orientations. Default: "normalized_dlt" + Maximal deviation of a point from its epipolar line. Default: 1 + Seed for the random number generator. Default: 0 + Computed fundamental matrix. + 9x9 covariance matrix of the fundamental matrix. + Root-Mean-Square of the epipolar distance error. + Indices of matched input points in image 1. + Indices of matched input points in image 2. + + + Compute the distance values for a rectified stereo image pair using correlation techniques. + Rectified image of camera 1. + Rectified image of camera 2. + Distance image. + Evaluation of a distance value. + Internal camera parameters of the rectified camera 1. + Internal camera parameters of the rectified camera 2. + Point transformation from the rectified camera 2 to the rectified camera 1. + Matching function. Default: "ncc" + Width of the correlation window. Default: 11 + Height of the correlation window. Default: 11 + Variance threshold of textured image regions. Default: 0.0 + Minimum of the expected disparities. Default: 0 + Maximum of the expected disparities. Default: 30 + Number of pyramid levels. Default: 1 + Threshold of the correlation function. Default: 0.0 + Downstream filters. Default: "none" + Distance interpolation. Default: "none" + + + Compute the disparities of a rectified image pair using correlation techniques. + Rectified image of camera 1. + Rectified image of camera 2. + Disparity map. + Evaluation of the disparity values. + Matching function. Default: "ncc" + Width of the correlation window. Default: 11 + Height of the correlation window. Default: 11 + Variance threshold of textured image regions. Default: 0.0 + Minimum of the expected disparities. Default: -30 + Maximum of the expected disparities. Default: 30 + Number of pyramid levels. Default: 1 + Threshold of the correlation function. Default: 0.5 + Downstream filters. Default: "none" + Subpixel interpolation of disparities. Default: "none" + + + Get a 3D point from the intersection of two lines of sight within a binocular camera system. + Internal parameters of the projective camera 1. + Internal parameters of the projective camera 2. + Point transformation from camera 2 to camera 1. + Row coordinate of a point in image 1. + Column coordinate of a point in image 1. + Row coordinate of the corresponding point in image 2. + Column coordinate of the corresponding point in image 2. + X coordinate of the 3D point. + Y coordinate of the 3D point. + Z coordinate of the 3D point. + Distance of the 3D point to the lines of sight. + + + Transform a disparity image into 3D points in a rectified stereo system. + Disparity image. + X coordinates of the points in the rectified camera system 1. + Y coordinates of the points in the rectified camera system 1. + Z coordinates of the points in the rectified camera system 1. + Internal camera parameters of the rectified camera 1. + Internal camera parameters of the rectified camera 2. + Pose of the rectified camera 2 in relation to the rectified camera 1. + + + Transform an image point and its disparity into a 3D point in a rectified stereo system. + Rectified internal camera parameters of camera 1. + Rectified internal camera parameters of camera 2. + Pose of the rectified camera 2 in relation to the rectified camera 1. + Row coordinate of a point in the rectified image 1. + Column coordinate of a point in the rectified image 1. + Disparity of the images of the world point. + X coordinate of the 3D point. + Y coordinate of the 3D point. + Z coordinate of the 3D point. + + + Transform a disparity value into a distance value in a rectified binocular stereo system. + Rectified internal camera parameters of camera 1. + Rectified internal camera parameters of camera 2. + Point transformation from the rectified camera 2 to the rectified camera 1. + Disparity between the images of the world point. + Distance of a world point to the rectified camera system. + + + Transfrom a distance value into a disparity in a rectified stereo system. + Rectified internal camera parameters of camera 1. + Rectified internal camera parameters of camera 2. + Point transformation from the rectified camera 2 to the rectified camera 1. + Distance of a world point to camera 1. + Disparity between the images of the point. + + + Generate transformation maps that describe the mapping of the images of a binocular camera pair to a common rectified image plane. + Image containing the mapping data of camera 1. + Image containing the mapping data of camera 2. + Internal parameters of camera 1. + Internal parameters of camera 2. + Point transformation from camera 2 to camera 1. + Subsampling factor. Default: 1.0 + Type of rectification. Default: "viewing_direction" + Type of mapping. Default: "bilinear" + Rectified internal parameters of camera 1. + Rectified internal parameters of camera 2. + Point transformation from the rectified camera 1 to the original camera 1. + Point transformation from the rectified camera 1 to the original camera 1. + Point transformation from the rectified camera 2 to the rectified camera 1. + + + Determine all camera parameters of a binocular stereo system. + Ordered Tuple with all X-coordinates of the calibration marks (in meters). + Ordered Tuple with all Y-coordinates of the calibration marks (in meters). + Ordered Tuple with all Z-coordinates of the calibration marks (in meters). + Ordered Tuple with all row-coordinates of the extracted calibration marks of camera 1 (in pixels). + Ordered Tuple with all column-coordinates of the extracted calibration marks of camera 1 (in pixels). + Ordered Tuple with all row-coordinates of the extracted calibration marks of camera 2 (in pixels). + Ordered Tuple with all column-coordinates of the extracted calibration marks of camera 2 (in pixels). + Initial values for the internal parameters of camera 1. + Initial values for the internal parameters of camera 2. + Ordered tuple with all initial values for the poses of the calibration model in relation to camera 1. + Ordered tuple with all initial values for the poses of the calibration model in relation to camera 2. + Camera parameters to be estimated. Default: "all" + Internal parameters of camera 1. + Internal parameters of camera 2. + Ordered tuple with all poses of the calibration model in relation to camera 1. + Ordered tuple with all poses of the calibration model in relation to camera 2. + Pose of camera 2 in relation to camera 1. + Average error distances in pixels. + + + Inquiring for possible settings of the HALCON debugging tool. + Available control modes (see also set_spy). + Corresponding state of the control modes. + + + Control of the HALCON Debugging Tools. + Control mode Default: "mode" + State of the control mode to be set. Default: "on" + + + Current configuration of the HALCON debugging-tool. + Control mode Default: "mode" + State of the control mode. + + + Read a sheet-of-light model from a file and create a new model. + Name of the sheet-of-light model file. Default: "sheet_of_light_model.solm" + Handle of the sheet-of-light model. + + + Write a sheet-of-light model to a file. + Handle of the sheet-of-light model. + Name of the sheet-of-light model file. Default: "sheet_of_light_model.solm" + + + Deserialize a sheet-of-light model. + Handle of the serialized item. + Handle of the sheet-of-light model. + + + Serialize a sheet-of-light model. + Handle of the sheet-of-light model. + Handle of the serialized item. + + + Create a calibration object for sheet-of-light calibration. + Width of the object. Default: 0.1 + Length of the object. Default: 0.15 + Minimum height of the ramp. Default: 0.005 + Maximum height of the ramp. Default: 0.04 + Filename of the model of the calibration object. Default: "calib_object.dxf" + + + Calibrate a sheet-of-light setup with a 3D calibration object. + Handle of the sheet-of-light model. + Average back projection error of the optimization. + + + Get the result of a calibrated measurement performed with the sheet-of-light technique as a 3D object model. + Handle for accessing the sheet-of-light model. + Handle of the resulting 3D object model. + + + Get the iconic results of a measurement performed with the sheet-of light technique. + Desired measurement result. + Handle of the sheet-of-light model to be used. + Specify which result of the measurement shall be provided. Default: "disparity" + + + Apply the calibration transformations to the input disparity image. + Height or range image to be calibrated. + Handle of the sheet-of-light model. + + + Set sheet of light profiles by measured disparities. + Disparity image that contains several profiles. + Handle of the sheet-of-light model. + Poses describing the movement of the scene under measurement between the previously processed profile image and the current profile image. + + + Process the profile image provided as input and store the resulting disparity to the sheet-of-light model. + Input image. + Handle of the sheet-of-light model. + Pose describing the movement of the scene under measurement between the previously processed profile image and the current profile image. + + + Set selected parameters of the sheet-of-light model. + Handle of the sheet-of-light model. + Name of the model parameter that shall be adjusted for the sheet-of-light model. Default: "method" + Value of the model parameter that shall be adjusted for the sheet-of-light model. Default: "center_of_gravity" + + + Get the value of a parameter, which has been set in a sheet-of-light model. + Handle of the sheet-of-light model. + Name of the generic parameter that shall be queried. Default: "method" + Value of the model parameter that shall be queried. + + + For a given sheet-of-light model get the names of the generic iconic or control parameters that can be used in the different sheet-of-light operators. + Handle of the sheet-of-light model. + Name of the parameter group. Default: "create_model_params" + List containing the names of the supported generic parameters. + + + Reset a sheet-of-light model. + Handle of the sheet-of-light model. + + + This operator is inoperable. It had the following function: Delete all sheet-of-light models and free the allocated memory. + + + Delete a sheet-of-light model and free the allocated memory. + Handle of the sheet-of-light model. + + + Create a model to perform 3D-measurements using the sheet-of-light technique. + Region of the images containing the profiles to be processed. If the provided region is not rectangular, its smallest enclosing rectangle will be used. + Names of the generic parameters that can be adjusted for the sheet-of-light model. Default: "min_gray" + Values of the generic parameters that can be adjusted for the sheet-of-light model. Default: 50 + Handle for using and accessing the sheet-of-light model. + + + Shade a height field. + Height field to be shaded. + Shaded image. + Angle between the light source and the positive z-axis (in degrees). Default: 0.0 + Angle between the light source and the x-axis after projection into the xy-plane (in degrees). Default: 0.0 + Amount of light reflected by the surface. Default: 1.0 + Amount of ambient light. Default: 0.0 + Should shadows be calculated? Default: "false" + + + Estimate the albedo of a surface and the amount of ambient light. + Image for which albedo and ambient are to be estimated. + Amount of light reflected by the surface. + Amount of ambient light. + + + Estimate the slant of a light source and the albedo of a surface. + Image for which slant and albedo are to be estimated. + Angle of the light sources and the positive z-axis (in degrees). + Amount of light reflected by the surface. + + + Estimate the slant of a light source and the albedo of a surface. + Image for which slant and albedo are to be estimated. + Angle between the light sources and the positive z-axis (in degrees). + Amount of light reflected by the surface. + + + Estimate the tilt of a light source. + Image for which the tilt is to be estimated. + Angle between the light source and the x-axis after projection into the xy-plane (in degrees). + + + Estimate the tilt of a light source. + Image for which the tilt is to be estimated. + Angle between the light source and the x-axis after projection into the xy-plane (in degrees). + + + Reconstruct a surface from surface gradients. + The gradient field of the image. + Reconstructed height field. + Type of the reconstruction method. Default: "poisson" + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + + + Reconstruct a surface according to the photometric stereo technique. + Array with at least three input images with different directions of illumination. + Reconstructed height field. + The gradient field of the surface. + The albedo of the surface. + Angle between the camera and the direction of illumination (in degrees). Default: 45.0 + Angle of the direction of illumination within the object plane (in degrees). Default: 45.0 + Types of the requested results. Default: "all" + Type of the reconstruction method. Default: "poisson" + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + + + Reconstruct a surface from a gray value image. + Shaded input image. + Reconstructed height field. + Angle between the light source and the positive z-axis (in degrees). Default: 45.0 + Angle between the light source and the x-axis after projection into the xy-plane (in degrees). Default: 45.0 + Amount of light reflected by the surface. Default: 1.0 + Amount of ambient light. Default: 0.0 + + + Reconstruct a surface from a gray value image. + Shaded input image. + Reconstructed height field. + Angle between the light source and the positive z-axis (in degrees). Default: 45.0 + Angle between the light source and the x-axis after projection into the xy-plane (in degrees). Default: 45.0 + Amount of light reflected by the surface. Default: 1.0 + Amount of ambient light. Default: 0.0 + + + Reconstruct a surface from a gray value image. + Shaded input image. + Reconstructed height field. + Angle between the light source and the positive z-axis (in degrees). Default: 45.0 + Angle between the light source and the x-axis after projection into the xy-plane (in degrees). Default: 45.0 + Amount of light reflected by the surface. Default: 1.0 + Amount of ambient light. Default: 0.0 + + + Receive a serialized item over a socket connection. + Socket number. + Handle of the serialized item. + + + Send a serialized item over a socket connection. + Socket number. + Handle of the serialized item. + + + Write a serialized item to a file. + File handle. + Handle of the serialized item. + + + Read a serialized item from a file. + File handle. + Handle of the serialized item. + + + This operator is inoperable. It had the following function: Delete all current existing serialized items. + + + Delete a serialized item. + Handle of the serialized item. + + + Access the data pointer of a serialized item. + Handle of the serialized item. + Data pointer of the serialized item. + Size of the serialized item. + + + Create a serialized item. + Data pointer of the serialized item. + Size of the serialized item. + Copy mode of the serialized item. Default: "true" + Handle of the serialized item. + + + Fit 3D primitives into a set of 3D points. + Handle of the input 3D object model. + Names of the generic parameters. + Values of the generic parameters. + Handle of the output 3D object model. + + + Segment a set of 3D points into sub-sets with similar characteristics. + Handle of the input 3D object model. + Names of the generic parameters. + Values of the generic parameters. + Handle of the output 3D object model. + + + This operator is inoperable. It had the following function: Clear all text results. + + + Clear a text result. + Text result to be cleared. + + + Query an iconic value of a text segmentation result. + Returned result. + Text result. + Name of the result to be returned. Default: "all_lines" + + + Query a control value of a text segmentation result. + Text result. + Name of the result to be returned. Default: "class" + Value of ResultName. + + + Find text in an image. + Input image. + Text model specifying the text to be segmented. + Result of the segmentation. + + + Query parameters of a text model. + Text model. + Parameters to be queried. Default: "min_contrast" + Values of Parameters. + + + Set parameters of a text model. + Text model. + Names of the parameters to be set. Default: "min_contrast" + Values of the parameters to be set. Default: 10 + + + This operator is inoperable. It had the following function: Clear all text models. + + + Clear a text model. + Text model to be cleared. + + + Create a text model. + The Mode of the text model. Default: "auto" + OCR Classifier. Default: "Universal_Rej.occ" + New text model. + + + Create a text model. + New text model. + + + Selects characters from a given region. + Region of text lines in which to select the characters. + Selected characters. + Should dot print characters be detected? Default: "false" + Stroke width of a character. Default: "medium" + Width of a character. Default: 25 + Height of a character. Default: 25 + Add punctuation? Default: "false" + Exist diacritic marks? Default: "false" + Method to partition neighbored characters. Default: "none" + Should lines be partitioned? Default: "false" + Distance of fragments. Default: "medium" + Connect fragments? Default: "false" + Maximum size of clutter. Default: 0 + Stop execution after this step. Default: "completion" + + + Segments characters in a given region of an image. + Area in the image where the text lines are located. + Input image. + Image used for the segmentation. + Region of characters. + Method to segment the characters. Default: "local_auto_shape" + Eliminate horizontal and vertical lines? Default: "false" + Should dot print characters be detected? Default: "false" + Stroke width of a character. Default: "medium" + Width of a character. Default: 25 + Height of a character. Default: 25 + Value to adjust the segmentation. Default: 0 + Minimum gray value difference between text and background. Default: 10 + Threshold used to segment the characters. + + + Determines the slant of characters of a text line or paragraph. + Area of text lines. + Input image. + Height of the text lines. Default: 25 + Minimum slant of the characters Default: -0.523599 + Maximum slant of the characters Default: 0.523599 + Calculated slant of the characters in the region + + + Determines the orientation of a text line or paragraph. + Area of text lines. + Input image. + Height of the text lines. Default: 25 + Minimum rotation of the text lines. Default: -0.523599 + Maximum rotation of the text lines. Default: 0.523599 + Calculated rotation angle of the text lines. + + + Classify a byte image using a look-up table. + Input image. + Segmented classes. + Handle of the LUT classifier. + + + Classify an image with a k-Nearest-Neighbor classifier. + Input image. + Segmented classes. + Distance of the pixel's nearest neighbor. + Handle of the k-NN classifier. + Threshold for the rejection of the classification. Default: 0.5 + + + Add training samples from an image to the training data of a k-Nearest-Neighbor classifier. + Training image. + Regions of the classes to be trained. + Handle of the k-NN classifier. + + + Classify an image with a Gaussian Mixture Model. + Input image. + Segmented classes. + GMM handle. + Threshold for the rejection of the classification. Default: 0.5 + + + Add training samples from an image to the training data of a Gaussian Mixture Model. + Training image. + Regions of the classes to be trained. + GMM handle. + Standard deviation of the Gaussian noise added to the training data. Default: 0.0 + + + Classify an image with a support vector machine. + Input image. + Segmented classes. + SVM handle. + + + Add training samples from an image to the training data of a support vector machine. + Training image. + Regions of the classes to be trained. + SVM handle. + + + Classify an image with a multilayer perceptron. + Input image. + Segmented classes. + MLP handle. + Threshold for the rejection of the classification. Default: 0.5 + + + Add training samples from an image to the training data of a multilayer perceptron. + Training image. + Regions of the classes to be trained. + MLP handle. + + + Construct classes for class_ndim_norm. + Foreground pixels to be trained. + Background pixels to be trained (rejection class). + Multi-channel training image. + Metric to be used. Default: "euclid" + Maximum cluster radius. Default: 10.0 + The ratio of the number of pixels in a cluster to the total number of pixels (in percent) must be larger than MinNumberPercent (otherwise the cluster is not output). Default: 0.01 + Cluster radii or half edge lengths. + Coordinates of all cluster centers. + Overlap of the rejection class with the classified objects (1: no overlap). + + + Train a classificator using a multi-channel image. + Foreground pixels to be trained. + Background pixels to be trained (rejection class). + Multi-channel training image. + Handle of the classifier. + + + Classify pixels using hyper-cuboids. + Multi channel input image. + Classification result. + Handle of the classifier. + + + Classify pixels using hyper-spheres or hyper-cubes. + Multi channel input image. + Classification result. + Metric to be used. Default: "euclid" + Return one region or one region for each cluster. Default: "single" + Cluster radii or half edge lengths (returned by learn_ndim_norm). + Coordinates of the cluster centers (returned by learn_ndim_norm). + + + Segment an image using two-dimensional pixel classification. + Input image (first channel). + Input image (second channel). + Region defining the feature space. + Classified regions. + + + Segment two images by clustering. + First input image. + Second input image. + Classification result. + Threshold (maximum distance to the cluster's center). Default: 15 + Number of classes (cluster centers). Default: 5 + + + Compare two images pixel by pixel. + Input image. + Comparison image. + Points in which the two images are similar/different. + Mode: return similar or different pixels. Default: "diff_outside" + Lower bound of the tolerated gray value difference. Default: -5 + Upper bound of the tolerated gray value difference. Default: 5 + Offset gray value subtracted from the input image. Default: 0 + Row coordinate by which the comparison image is translated. Default: 0 + Column coordinate by which the comparison image is translated. Default: 0 + + + Perform a threshold segmentation for extracting characters. + Input image. + Region in which the histogram is computed. + Dark regions (characters). + Sigma for the Gaussian smoothing of the histogram. Default: 2.0 + Percentage for the gray value difference. Default: 95 + Calculated threshold. + + + Extract regions with equal gray values from an image. + Label image. + Regions having a constant gray value. + + + Suppress non-maximum points on an edge. + Amplitude (gradient magnitude) image. + Image with thinned edge regions. + Select horizontal/vertical or undirected NMS. Default: "hvnms" + + + Suppress non-maximum points on an edge using a direction image. + Amplitude (gradient magnitude) image. + Direction image. + Image with thinned edge regions. + Select non-maximum-suppression or interpolating NMS. Default: "nms" + + + Perform a hysteresis threshold operation on an image. + Input image. + Segmented region. + Lower threshold for the gray values. Default: 30 + Upper threshold for the gray values. Default: 60 + Maximum length of a path of "potential" points to reach a "secure" point. Default: 10 + + + Segment an image using binary thresholding. + Input Image. + Segmented output region. + Segmentation method. Default: "max_separability" + Extract foreground or background? Default: "dark" + Used threshold. + + + Segment an image using local thresholding. + Input Image. + Segmented output region. + Segmentation method. Default: "adapted_std_deviation" + Extract foreground or background? Default: "dark" + List of generic parameter names. Default: [] + List of generic parameter values. Default: [] + + + Threshold an image by local mean and standard deviation analysis. + Input image. + Segmented regions. + Mask width for mean and deviation calculation. Default: 15 + Mask height for mean and deviation calculation. Default: 15 + Factor for the standard deviation of the gray values. Default: 0.2 + Minimum gray value difference from the mean. Default: 2 + Threshold type. Default: "dark" + + + Segment an image using a local threshold. + Input image. + Image containing the local thresholds. + Segmented regions. + Offset applied to ThresholdImage. Default: 5.0 + Extract light, dark or similar areas? Default: "light" + + + Segment an image using global threshold. + Input image. + Segmented region. + Lower threshold for the gray values. Default: 128.0 + Upper threshold for the gray values. Default: 255.0 + + + Extract level crossings from an image with subpixel accuracy. + Input image. + Extracted level crossings. + Threshold for the level crossings. Default: 128 + + + Segment an image using regiongrowing for multi-channel images. + Input image. + Segmented regions. + Metric for the distance of the feature vectors. Default: "2-norm" + Lower threshold for the features' distance. Default: 0.0 + Upper threshold for the features' distance. Default: 20.0 + Minimum size of the output regions. Default: 30 + + + Segment an image using regiongrowing. + Input image. + Segmented regions. + Vertical distance between tested pixels (height of the raster). Default: 3 + Horizontal distance between tested pixels (height of the raster). Default: 3 + Points with a gray value difference less then or equal to tolerance are accumulated into the same object. Default: 6.0 + Minimum size of the output regions. Default: 100 + + + Perform a regiongrowing using mean gray values. + Input image. + Segmented regions. + Row coordinates of the starting points. Default: [] + Column coordinates of the starting points. Default: [] + Maximum deviation from the mean. Default: 5.0 + Minimum size of a region. Default: 100 + + + Segment an image by "pouring water" over it. + Input image. + Segmented regions. + Mode of operation. Default: "all" + All gray values smaller than this threshold are disregarded. Default: 0 + All gray values larger than this threshold are disregarded. Default: 255 + + + Extract watershed basins from an image using a threshold. + Image to be segmented. + Segments found (dark basins). + Threshold for the watersheds. Default: 10 + + + Extract watersheds and basins from an image. + Input image. + Segmented basins. + Watersheds between the basins. + + + Extract zero crossings from an image. + Input image. + Zero crossings. + + + Extract zero crossings from an image with subpixel accuracy. + Input image. + Extracted zero crossings. + + + Threshold operator for signed images. + Input image. + Positive and negative regions. + Regions smaller than MinSize are suppressed. Default: 20 + Regions whose maximum absolute gray value is smaller than MinGray are suppressed. Default: 5.0 + Regions that have a gray value smaller than Threshold (or larger than -Threshold) are suppressed. Default: 2.0 + + + Expand a region starting at a given line. + Input image. + Extracted segments. + Row or column coordinate. Default: 256 + Stopping criterion. Default: "gradient" + Segmentation mode (row or column). Default: "row" + Threshold for the expansion. Default: 3.0 + + + Detect all local minima in an image. + Image to be processed. + Extracted local minima as regions. + + + Detect all gray value lowlands. + Image to be processed. + Extracted lowlands as regions (one region for each lowland). + + + Detect the centers of all gray value lowlands. + Image to be processed. + Centers of gravity of the extracted lowlands as regions (one region for each lowland). + + + Detect all local maxima in an image. + Input image. + Extracted local maxima as a region. + + + Detect all gray value plateaus. + Input image. + Extracted plateaus as regions (one region for each plateau). + + + Detect the centers of all gray value plateaus. + Input image. + Centers of gravity of the extracted plateaus as regions (one region for each plateau). + + + Determine gray value thresholds from a histogram. + Gray value histogram. + Sigma for the Gaussian smoothing of the histogram. Default: 2.0 + Minimum thresholds. + Maximum thresholds. + + + Segment an image using thresholds determined from its histogram. + Input image. + Regions with gray values within the automatically determined intervals. + Sigma for the Gaussian smoothing of the histogram. Default: 2.0 + + + Segment an image using an automatically determined threshold. + Input image. + Dark regions of the image. + + + Fast thresholding of images using global thresholds. + Input image. + Segmented regions. + Lower threshold for the gray values. Default: 128 + Upper threshold for the gray values. Default: 255.0 + Minimum size of objects to be extracted. Default: 20 + + + Transform a region in polar coordinates back to cartesian coordinates. + Input region. + Output region. + Row coordinate of the center of the arc. Default: 256 + Column coordinate of the center of the arc. Default: 256 + Angle of the ray to map the column coordinate 0 of PolarRegion to. Default: 0.0 + Angle of the ray to map the column coordinate $WidthIn-1$ of PolarRegion to. Default: 6.2831853 + Radius of the circle to map the row coordinate 0 of PolarRegion to. Default: 0 + Radius of the circle to map the row coordinate $HeightIn-1$ of PolarRegion to. Default: 100 + Width of the virtual input image. Default: 512 + Height of the virtual input image. Default: 512 + Width of the virtual output image. Default: 512 + Height of the virtual output image. Default: 512 + Interpolation method for the transformation. Default: "nearest_neighbor" + + + Transform a region within an annular arc to polar coordinates. + Input region. + Output region. + Row coordinate of the center of the arc. Default: 256 + Column coordinate of the center of the arc. Default: 256 + Angle of the ray to be mapped to column coordinate 0 of PolarTransRegion. Default: 0.0 + Angle of the ray to be mapped to column coordinate $Width-1$ of PolarTransRegion. Default: 6.2831853 + Radius of the circle to be mapped to row coordinate 0 of PolarTransRegion. Default: 0 + Radius of the circle to be mapped to row coordinate $Height-1$ of PolarTransRegion. Default: 100 + Width of the virtual output image. Default: 512 + Height of the virtual output image. Default: 512 + Interpolation method for the transformation. Default: "nearest_neighbor" + + + Merge regions from line scan images. + Current input regions. + Merged regions from the previous iteration. + Current regions, merged with old ones where applicable. + Regions from the previous iteration which could not be merged with the current ones. + Height of the line scan images. Default: 512 + Image line of the current image, which touches the previous image. Default: "top" + Maximum number of images for a single region. Default: 3 + + + Partition a region into rectangles of approximately equal size. + Region to be partitioned. + Partitioned region. + Width of the individual rectangles. + Height of the individual rectangles. + + + Partition a region horizontally at positions of small vertical extent. + Region to be partitioned. + Partitioned region. + Approximate width of the resulting region parts. + Maximum percental shift of the split position. Default: 20 + + + Convert regions to a label image. + Regions to be converted. + Result image of dimension Width * Height containing the converted regions. + Pixel type of the result image. Default: "int2" + Width of the image to be generated. Default: 512 + Height of the image to be generated. Default: 512 + + + Convert a region into a binary byte-image. + Regions to be converted. + Result image of dimension Width * Height containing the converted regions. + Gray value in which the regions are displayed. Default: 255 + Gray value in which the background is displayed. Default: 0 + Width of the image to be generated. Default: 512 + Height of the image to be generated. Default: 512 + + + Return the union of two regions. + Region for which the union with all regions in Region2 is to be computed. + Regions which should be added to Region1. + Resulting regions. + + + Return the union of all input regions. + Regions of which the union is to be computed. + Union of all input regions. + + + Compute the closest-point transformation of a region. + Region for which the distance to the border is computed. + Image containing the distance information. + Image containing the coordinates of the closest points. + Type of metric to be used for the closest-point transformation. Default: "city-block" + Compute the distance for pixels inside (true) or outside (false) the input region. Default: "true" + Mode in which the coordinates of the closest points are returned. Default: "absolute" + Width of the output images. Default: 640 + Height of the output images. Default: 480 + + + Compute the distance transformation of a region. + Region for which the distance to the border is computed. + Image containing the distance information. + Type of metric to be used for the distance transformation. Default: "city-block" + Compute the distance for pixels inside (true) or outside (false) the input region. Default: "true" + Width of the output image. Default: 640 + Height of the output image. Default: 480 + + + Compute the skeleton of a region. + Region to be thinned. + Resulting skeleton. + + + Apply a projective transformation to a region. + Input regions. + Output regions. + Homogeneous projective transformation matrix. + Interpolation method for the transformation. Default: "bilinear" + + + Apply an arbitrary affine 2D transformation to regions. + Region(s) to be rotated and scaled. + Transformed output region(s). + Input transformation matrix. + Should the transformation be done using interpolation? Default: "nearest_neighbor" + + + Reflect a region about an axis. + Region(s) to be reflected. + Reflected region(s). + Axis of symmetry. Default: "row" + Twice the coordinate of the axis of symmetry. Default: 512 + + + Zoom a region. + Region(s) to be zoomed. + Zoomed region(s). + Scale factor in x-direction. Default: 2.0 + Scale factor in y-direction. Default: 2.0 + + + Translate a region. + Region(s) to be moved. + Translated region(s). + Row coordinate of the vector by which the region is to be moved. Default: 30 + Row coordinate of the vector by which the region is to be moved. Default: 30 + + + Find junctions and end points in a skeleton. + Input skeletons. + Extracted end points. + Extracted junctions. + + + Calculate the intersection of two regions. + Regions to be intersected with all regions in Region2. + Regions with which Region1 is intersected. + Result of the intersection. + + + Partition the image plane using given regions. + Regions for which the separating lines are to be determined. + Output region containing the separating lines. + Mode of operation. Default: "mixed" + + + Fill up holes in regions. + Input regions containing holes. + Regions without holes. + + + Fill up holes in regions having given shape features. + Input region(s). + Output region(s) with filled holes. + Shape feature used. Default: "area" + Minimum value for Feature. Default: 1.0 + Maximum value for Feature. Default: 100.0 + + + Fill gaps between regions or split overlapping regions. + Regions for which the gaps are to be closed, or which are to be separated. + Regions in which no expansion takes place. + Expanded or separated regions. + Number of iterations. Default: "maximal" + Expansion mode. Default: "image" + + + Clip a region relative to its smallest surrounding rectangle. + Regions to be clipped. + Clipped regions. + Number of rows clipped at the top. Default: 1 + Number of rows clipped at the bottom. Default: 1 + Number of columns clipped at the left. Default: 1 + Number of columns clipped at the right. Default: 1 + + + Clip a region to a rectangle. + Region to be clipped. + Clipped regions. + Row coordinate of the upper left corner of the rectangle. Default: 0 + Column coordinate of the upper left corner of the rectangle. Default: 0 + Row coordinate of the lower right corner of the rectangle. Default: 256 + Column coordinate of the lower right corner of the rectangle. Default: 256 + + + Rank operator for regions. + Region(s) to be transformed. + Resulting region(s). + Width of the filter mask. Default: 15 + Height of the filter mask. Default: 15 + Minimum number of points lying within the filter mask. Default: 70 + + + Compute connected components of a region. + Input region. + Connected components. + + + Calculate the symmetric difference of two regions. + Input region 1. + Input region 2. + Resulting region. + + + Calculate the difference of two regions. + Regions to be processed. + The union of these regions is subtracted from Region. + Resulting region. + + + Return the complement of a region. + Input region(s). + Complemented regions. + + + Determine the connected components of the background of given regions. + Input regions. + Connected components of the background. + + + Generate a region having a given Hamming distance. + Region to be modified. + Regions having the required Hamming distance. + Width of the region to be changed. Default: 100 + Height of the region to be changed. Default: 100 + Hamming distance between the old and new regions. Default: 1000 + + + Remove noise from a region. + Regions to be modified. + Less noisy regions. + Mode of noise removal. Default: "n_4" + + + Transform the shape of a region. + Regions to be transformed. + Transformed regions. + Type of transformation. Default: "convex" + + + Fill gaps between regions (depending on gray value or color) or split overlapping regions. + Regions for which the gaps are to be closed, or which are to be separated. + Image (possibly multi-channel) for gray value or color comparison. + Regions in which no expansion takes place. + Expanded or separated regions. + Number of iterations. Default: "maximal" + Expansion mode. Default: "image" + Maximum difference between the gray value or color at the region's border and a candidate for expansion. Default: 32 + + + Fill gaps between regions (depending on gray value or color) or split overlapping regions. + Regions for which the gaps are to be closed, or which are to be separated. + Image (possibly multi-channel) for gray value or color comparison. + Regions in which no expansion takes place. + Expanded or separated regions. + Number of iterations. Default: "maximal" + Expansion mode. Default: "image" + Reference gray value or color for comparison. Default: 128 + Maximum difference between the reference gray value or color and a candidate for expansion. Default: 32 + + + Split lines represented by one pixel wide, non-branching lines. + Input lines (represented by 1 pixel wide, non-branching regions). + Maximum distance of the line points to the line segment connecting both end points. Default: 3 + Row coordinates of the start points of the output lines. + Column coordinates of the start points of the output lines. + Row coordinates of the end points of the output lines. + Column coordinates of the end points of the output lines. + + + Split lines represented by one pixel wide, non-branching regions. + Input lines (represented by 1 pixel wide, non-branching regions). + Split lines. + Maximum distance of the line points to the line segment connecting both end points. Default: 3 + + + Convert a histogram into a region. + Region containing the histogram. + Input histogram. + Row coordinate of the center of the histogram. Default: 255 + Column coordinate of the center of the histogram. Default: 255 + Scale factor for the histogram. Default: 1 + + + Eliminate runs of a given length. + Region to be clipped. + Clipped regions. + All runs which are shorter are eliminated. Default: 3 + All runs which are longer are eliminated. Default: 1000 + + + Calculate the 3D surface normals of a 3D object model. + Handle of the 3D object model containing 3D point data. + Normals calculation method. Default: "mls" + Names of generic smoothing parameters. Default: [] + Values of generic smoothing parameters. Default: [] + Handle of the 3D object model with calculated 3D normals. + + + Smooth the 3D points of a 3D object model. + Handle of the 3D object model containing 3D point data. + Smoothing method. Default: "mls" + Names of generic smoothing parameters. Default: [] + Values of generic smoothing parameters. Default: [] + Handle of the 3D object model with the smoothed 3D point data. + + + Create a surface triangulation for a 3D object model. + Handle of the 3D object model containing 3D point data. + Triangulation method. Default: "greedy" + Names of the generic triangulation parameters. Default: [] + Values of the generic triangulation parameters. Default: [] + Handle of the 3D object model with the triangulated surface. + Additional information about the triangulation process. + + + This operator is inoperable. It had the following function: Free the memory of all stereo models. + + + Free the memory of a stereo model. + Handle of the stereo model. + + + Reconstruct 3D points from calibrated multi-view stereo images. + Handle of the stereo model. + Row coordinates of the detected points. + Column coordinates of the detected points. + Covariance matrices of the detected points. Default: [] + Indices of the observing cameras. + Indices of the observed world points. + X coordinates of the reconstructed 3D points. + Y coordinates of the reconstructed 3D points. + Z coordinates of the reconstructed 3D points. + Covariance matrices of the reconstructed 3D points. + Indices of the reconstructed 3D points. + + + Reconstruct surface from calibrated multi-view stereo images. + An image array acquired by the camera setup associated with the stereo model. + Handle of the stereo model. + Handle to the resulting surface. + + + Get intermediate iconic results of a stereo reconstruction. + Iconic result. + Handle of the stereo model. + Camera indices of the pair ([From, To]). + Name of the iconic result to be returned. + + + Return the list of image pairs set in a stereo model. + Handle of the stereo model. + Camera indices for the from cameras in the image pairs. + Camera indices for the to cameras in the image pairs. + + + Specify image pairs to be used for surface stereo reconstruction. + Handle of the stereo model. + Camera indices for the from cameras in the image pairs. + Camera indices for the to cameras in the image pairs. + + + Get stereo model parameters. + Handle of the stereo model. + Names of the parameters to be set. + Values of the parameters to be set. + + + Set stereo model parameters. + Handle of the stereo model. + Names of the parameters to be set. + Values of the parameters to be set. + + + Create a HALCON stereo model. + Handle to the camera setup model. + Reconstruction method. Default: "surface_pairwise" + Name of the model parameter to be set. Default: [] + Value of the model parameter to be set. Default: [] + Handle of the stereo model. + + + Query message queue parameters or information about the queue. + Message queue handle. + Names of the queue parameters or info queries. Default: "max_message_num" + Values of the queue parameters or info queries. + + + Set message queue parameters or invoke commands on the queue. + Message queue handle. + Names of the queue parameters or action commands. Default: "max_message_num" + Values of the queue parameters or action commands. Default: 1 + + + Receive one or more messages from the message queue. + Message queue handle. + Names of optional generic parameters Default: "timeout" + Values of optional generic parameters Default: "infinite" + Handle(s) of the dequeued message(s). + + + Enqueue one or more messages to the message queue. + Message queue handle. + Handle(s) of message(s) to be enqueued. + Names of optional generic parameters. + Values of optional generic parameters. + + + Close a message queue handle and release all associated resources. + Message queue handle(s) to be closed. + + + Create a new empty message queue. + Handle of the newly created message queue. + + + Query message parameters or information about the message. + Message handle. + Names of the message parameters or info queries. Default: "message_keys" + Message keys the parameter/query should be applied to. + Values of the message parameters or info queries. + + + Set message parameter or invoke commands on the message. + Message handle. + Names of the message parameters or action commands. Default: "remove_key" + Message keys the parameter/command should be applied to. + Values of the message parameters or action commands. + + + Retrieve an object associated with the key from the message. + Tuple value retrieved from the message. + Message handle. + Key string or integer. + + + Add a key/object pair to the message. + Object to be associated with the key. + Message handle. + Key string or integer. + + + Retrieve a tuple associated with the key from the message. + Message handle. + Key string or integer. + Tuple value retrieved from the message. + + + Add a key/tuple pair to the message. + Message handle. + Key string or integer. + Tuple value to be associated with the key. + + + Close a message handle and release all associated resources. + Message handle(s) to be closed. + + + Create a new empty message. + Handle of the newly created message. + + + This operator is inoperable. It had the following function: Destroy all condition synchronization objects. + + + Destroy a condition synchronization object. + Condition synchronization object. + + + Signal a condition synchronization object. + Condition synchronization object. + + + Signal a condition synchronization object. + Condition synchronization object. + + + Bounded wait on the signal of a condition synchronization object. + Condition synchronization object. + Mutex synchronization object. + Timeout in micro seconds. + + + wait on the signal of a condition synchronization object. + Condition synchronization object. + Mutex synchronization object. + + + Create a condition variable synchronization object. + Mutex attribute. Default: [] + Mutex attribute value. Default: [] + Condition synchronization object. + + + This operator is inoperable. It had the following function: Destroy all barrier synchronization objects. + + + Destroy a barrier synchronization object. + Barrier synchronization object. + + + Wait on the release of a barrier synchronization object. + Barrier synchronization object. + + + Create a barrier synchronization object. + Barrier attribute. Default: [] + Barrier attribute value. Default: [] + Barrier team size. Default: 1 + Barrier synchronization object. + + + This operator is inoperable. It had the following function: Clear all event synchronization objects. + + + Clear the event synchronization object. + Event synchronization object. + + + Unlock an event synchronization object. + Event synchronization object. + + + Lock an event synchronization object only if it is unlocked. + Event synchronization object. + Object already locked? + + + Lock an event synchronization object. + Event synchronization object. + + + Create an event synchronization object. + Mutex attribute. Default: [] + Mutex attribute value. Default: [] + Event synchronization object. + + + This operator is inoperable. It had the following function: Clear all mutex synchronization objects. + + + Clear the mutex synchronization object. + Mutex synchronization object. + + + Unlock a mutex synchronization object. + Mutex synchronization object. + + + Lock a mutex synchronization object. + Mutex synchronization object. + Mutex already locked? + + + Lock a mutex synchronization object. + Mutex synchronization object. + + + Create a mutual exclusion synchronization object. + Mutex attribute class. Default: [] + Mutex attribute kind. Default: [] + Mutex synchronization object. + + + Query the attributes of a threading / synchronization object. + Threading object. + Class name of threading object. + Name of an attribute. + Value of the attribute. + + + Set AOP information for operators. + Operator to set information to Default: "" + Further specific index Default: "" + Further specific address Default: "" + Scope of information Default: "max_threads" + AOP information value + + + Return AOP information for operators. + Operator to get information for + Further index stages Default: ["iconic_type","parameter:0"] + Further index values Default: ["byte",""] + Scope of information Default: "max_threads" + Value of information + + + Query indexing structure of AOP information for operators. + Operator to get information for Default: "" + Further specific index Default: "" + Further specific address Default: "" + Name of next index stage + Values of next index stage + + + Check hardware regarding its potential for automatic operator parallelization. + Operators to check Default: "" + Iconic object types to check Default: "" + Knowledge file name Default: "" + Parameter name Default: "none" + Parameter value Default: "none" + + + Write knowledge about hardware dependent behavior of automatic operator parallelization to file. + Name of knowledge file Default: "" + Parameter name Default: "none" + Parameter value Default: "none" + + + Load knowledge about hardware dependent behavior of automatic operator parallelization. + Name of knowledge file Default: "" + Parameter name Default: "none" + Parameter value Default: "none" + Knowledge attributes + Updated Operators + + + + + + + + + + + Calculate the difference of two object tuples. + Object tuple 1. + Object tuple 2. + Objects from Objects that are not part of ObjectsSub. + + + Set single gray values in an image. + Image to be modified. + Row coordinates of the pixels to be modified. Default: 0 + Column coordinates of the pixels to be modified. Default: 0 + Gray values to be used. Default: 255.0 + + + Paint XLD objects into an image. + XLD objects to be painted into the input image. + Image in which the xld objects are to be painted. + Image containing the result. + Desired gray value of the xld object. Default: 255.0 + + + Paint regions into an image. + Regions to be painted into the input image. + Image in which the regions are to be painted. + Image containing the result. + Desired gray values of the regions. Default: 255.0 + Paint regions filled or as boundaries. Default: "fill" + + + Overpaint regions in an image. + Image in which the regions are to be painted. + Regions to be painted into the input image. + Desired gray values of the regions. Default: 255.0 + Paint regions filled or as boundaries. Default: "fill" + + + Create an image with a specified constant gray value. + Input image. + Image with constant gray value. + Gray value to be used for the output image. Default: 0 + + + Paint the gray values of an image into another image. + Input image containing the desired gray values. + Input image to be painted over. + Result image. + + + Overpaint the gray values of an image. + Input image to be painted over. + Input image containing the desired gray values. + + + Convert an "integer number" into an iconic object. + Created objects. + Tuple of object surrogates. + + + Convert an iconic object into an "integer number." + Objects for which the surrogates are to be returned. + Starting index of the surrogates to be returned. Default: 1 + Number of surrogates to be returned. Default: -1 + Tuple containing the surrogates. + + + Copy an iconic object in the HALCON database. + Objects to be copied. + Copied objects. + Starting index of the objects to be copied. Default: 1 + Number of objects to be copied or -1. Default: 1 + + + Concatenate two iconic object tuples. + Object tuple 1. + Object tuple 2. + Concatenated objects. + + + Delete an iconic object from the HALCON database. + Objects to be deleted. + + + Copy an image and allocate new memory for it. + Image to be copied. + Copied image. + + + Select objects from an object tuple. + Input objects. + Selected objects. + Indices of the objects to be selected. Default: 1 + + + Compare iconic objects regarding equality. + Reference objects. + Test objects. + Maximum allowed difference between two gray values or coordinates etc. Default: 0.0 + Boolean result value. + + + Test whether a region is contained in another region. + Test region. + Region for comparison. + Is Region1 contained in Region2? + + + Test whether the regions of two objects are identical. + Test regions. + Comparative regions. + boolean result value. + + + Compare image objects regarding equality. + Test objects. + Comparative objects. + boolean result value. + + + Number of objects in a tuple. + Objects to be examined. + Number of objects in the tuple Objects. + + + Informations about the components of an image object. + Image object to be examined. + Required information about object components. Default: "creator" + Components to be examined (0 for region/XLD). Default: 0 + Requested information. + + + Name of the class of an image object. + Image objects to be examined. + Name of class. + + + Create a three-channel image from a pointer to the interleaved pixels. + Created image with new image matrix. + Pointer to interleaved pixels. + Format of the input pixels. Default: "rgb" + Width of input image. Default: 512 + Height of input image. Default: 512 + Reserved. + Pixel type of output image. Default: "byte" + Width of output image. Default: 0 + Height of output image. Default: 0 + Line number of upper left corner of desired image part. Default: 0 + Column number of upper left corner of desired image part. Default: 0 + Number of used bits per pixel and channel of the output image (-1: All bits are used). Default: -1 + Number of bits that the color values of the input pixels are shifted to the right (only uint2 images). Default: 0 + + + Create a region from an XLD polygon. + Input polygon(s). + Created region(s). + Fill mode of the region(s). Default: "filled" + + + Create a region from an XLD contour. + Input contour(s). + Created region(s). + Fill mode of the region(s). Default: "filled" + + + Store a polygon as a "filled" region. + Created region. + Line indices of the base points of the region contour. Default: 100 + Column indices of the base points of the region contour. Default: 100 + + + Store a polygon as a region. + Created region. + Line indices of the base points of the region contour. Default: 100 + Colum indices of the base points of the region contour. Default: 100 + + + Store individual pixels as image region. + Created region. + Lines of the pixels in the region. Default: 100 + Columns of the pixels in the region. Default: 100 + + + Create a region from a runlength coding. + Created region. + Lines of the runs. Default: 100 + Columns of the starting points of the runs. Default: 50 + Columns of the ending points of the runs. Default: 200 + + + Create a rectangle of any orientation. + Created rectangle. + Line index of the center. Default: 300.0 + Column index of the center. Default: 200.0 + Angle of the first edge to the horizontal (in radians). Default: 0.0 + Half width. Default: 100.0 + Half height. Default: 20.0 + + + Create a rectangle parallel to the coordinate axes. + Created rectangle. + Line of upper left corner point. Default: 30.0 + Column of upper left corner point. Default: 20.0 + Line of lower right corner point. Default: 100.0 + Column of lower right corner point. Default: 200.0 + + + Create a random region. + Created random region with expansion Width x Height. + Maximum horizontal expansion of random region. Default: 128 + Maximum vertical expansion of random region. Default: 128 + + + Create an image from three pointers to the pixels (red/green/blue). + Created image with new image matrix. + Pixel type. Default: "byte" + Width of image. Default: 512 + Height of image. Default: 512 + Pointer to first red value (channel 1). + Pointer to first green value (channel 2). + Pointer to first blue value (channel 3). + + + Create an image from a pointer to the pixels. + Created image with new image matrix. + Pixel type. Default: "byte" + Width of image. Default: 512 + Height of image. Default: 512 + Pointer to first gray value. + + + Create an image with constant gray value. + Created image with new image matrix. + Pixel type. Default: "byte" + Width of image. Default: 512 + Height of image. Default: 512 + + + Create an ellipse sector. + Created ellipse(s). + Line index of center. Default: 200.0 + Column index of center. Default: 200.0 + Orientation of the longer radius (Radius1). Default: 0.0 + Longer radius. Default: 100.0 + Shorter radius. Default: 60.0 + Start angle of the sector. Default: 0.0 + End angle of the sector. Default: 3.14159 + + + Create an ellipse. + Created ellipse(s). + Line index of center. Default: 200.0 + Column index of center. Default: 200.0 + Orientation of the longer radius (Radius1). Default: 0.0 + Longer radius. Default: 100.0 + Shorter radius. Default: 60.0 + + + Create a circle sector. + Generated circle sector. + Line index of center. Default: 200.0 + Column index of center. Default: 200.0 + Radius of circle. Default: 100.5 + Start angle of the circle sector. Default: 0.0 + End angle of the circle sector. Default: 3.14159 + + + Create a circle. + Generated circle. + Line index of center. Default: 200.0 + Column index of center. Default: 200.0 + Radius of circle. Default: 100.5 + + + Create a checkered region. + Created checkerboard region. + Largest occurring $x$ value of the region. Default: 511 + Largest occurring $y$ value of the region. Default: 511 + Width of a field of the checkerboard. Default: 64 + Height of a field of the checkerboard. Default: 64 + + + Create a region from lines or pixels. + Created lines/pixel region. + Step width in line direction or zero. Default: 10 + Step width in column direction or zero. Default: 10 + Type of created pattern. Default: "lines" + Maximum width of pattern. Default: 512 + Maximum height of pattern. Default: 512 + + + Create random regions like circles, rectangles and ellipses. + Created regions. + Type of regions to be created. Default: "circle" + Minimum width of the region. Default: 10.0 + Maximum width of the region. Default: 20.0 + Minimum height of the region. Default: 10.0 + Maximum height of the region. Default: 30.0 + Minimum rotation angle of the region. Default: -0.7854 + Maximum rotation angle of the region. Default: 0.7854 + Number of regions. Default: 100 + Maximum horizontal expansion. Default: 512 + Maximum vertical expansion. Default: 512 + + + Store input lines described in Hesse normal form as regions. + Created regions (one for every line), clipped to maximum image format. + Orientation of the normal vector in radians. Default: 0.0 + Distance from the line to the coordinate origin (0.0). Default: 200 + + + Store input lines as regions. + Created regions. + Line coordinates of the starting points of the input lines. Default: 100 + Column coordinates of the starting points of the input lines. Default: 50 + Line coordinates of the ending points of the input lines. Default: 150 + Column coordinates of the ending points of the input lines. Default: 250 + + + Create an empty object tuple. + No objects. + + + Create an empty region. + Empty region (no pixels). + + + Create a gray value ramp. + Created image with new image matrix. + Gradient in line direction. Default: 1.0 + Gradient in column direction. Default: 1.0 + Mean gray value. Default: 128 + Line index of reference point. Default: 256 + Column index of reference point. Default: 256 + Width of image. Default: 512 + Height of image. Default: 512 + + + Create a three-channel image from three pointers on the pixels with storage management. + Created HALCON image. + Pixel type. Default: "byte" + Width of image. Default: 512 + Height of image. Default: 512 + Pointer to the first gray value of the first channel. + Pointer to the first gray value of the second channel. + Pointer to the first gray value of the third channel. + Pointer to the procedure re-releasing the memory of the image when deleting the object. Default: 0 + + + Create an image from a pointer on the pixels with storage management. + Created HALCON image. + Pixel type. Default: "byte" + Width of image. Default: 512 + Height of image. Default: 512 + Pointer to the first gray value. + Pointer to the procedure re-releasing the memory of the image when deleting the object. Default: 0 + + + Create an image with a rectangular domain from a pointer on the pixels (with storage management). + Created HALCON image. + Pointer to the first pixel. + Width of the image. Default: 512 + Height of the image. Default: 512 + Distance (in bytes) between pixel m in row n and pixel m in row n+1 of the 'input image'. + Distance between two neighboring pixels in bits . Default: 8 + Number of used bits per pixel. Default: 8 + Copy image data. Default: "false" + Pointer to the procedure releasing the memory of the image when deleting the object. Default: 0 + + + Access to the image data pointer and the image data inside the smallest rectangle of the domain of the input image. + Input image (Himage). + Pointer to the image data. + Width of the output image. + Height of the output image. + Width(input image)*(HorizontalBitPitch/8). + Distance between two neighboring pixels in bits . + Number of used bits per pixel. + + + Access the pointers of a colored image. + Input image. + Pointer to the pixels of the first channel. + Pointer to the pixels of the second channel. + Pointer to the pixels of the third channel. + Type of image. + Width of image. + Height of image. + + + Access the pointer of a channel. + Input image. + Pointer to the image data in the HALCON database. + Type of image. + Width of image. + Height of image. + + + Return the type of an image. + Input image. + Type of image. + + + Return the size of an image. + Input image. + Width of image. + Height of image. + + + Request time at which the image was created. + Input image. + Milliseconds (0..999). + Seconds (0..59). + Minutes (0..59). + Hours (0..23). + Day of the month (1..31). + Day of the year (1..366). + Month (1..12). + Year (xxxx). + + + Return gray values of an image at the positions given by tuples of rows and columns. + Image whose gray values are to be accessed. + Row coordinates of positions. Default: 0 + Column coordinates of positions. Default: 0 + Interpolation method. Default: "bilinear" + Gray values of the selected image coordinates. + + + Access the gray values of an image object. + Image whose gray value is to be accessed. + Row coordinates of pixels to be viewed. Default: 0 + Column coordinates of pixels to be viewed. Default: 0 + Gray values of indicated pixels. + + + Access the thickness of a region along the main axis. + Region to be analysed. + Thickness of the region along its main axis. + Histogram of the thickness of the region along its main axis. + + + Polygon approximation of a region. + Region to be approximated. + Maximum distance between the polygon and the edge of the region. Default: 5.0 + Line numbers of the base points of the contour. + Column numbers of the base points of the contour. + + + Access the pixels of a region. + This region is accessed. + Line numbers of the pixels in the region + Column numbers of the pixels in the region. + + + Access the contour of an object. + Output region. + Line numbers of the contour pixels. + Column numbers of the contour pixels. + + + Access the runlength coding of a region. + Output region. + Line numbers of the chords. + Column numbers of the starting points of the chords. + Column numbers of the ending points of the chords. + + + Contour of an object as chain code. + Region to be transformed. + Line of starting point. + Column of starting point. + Direction code of the contour (from starting point). + + + Access convex hull as contour. + Output region. + Line numbers of contour pixels. + Column numbers of the contour pixels. + + + Verification of a pattern using an OCV tool. + Characters to be verified. + Handle of the OCV tool. + Name of the character. Default: "a" + Adaption to vertical and horizontal translation. Default: "true" + Adaption to vertical and horizontal scaling of the size. Default: "true" + Adaption to changes of the orientation (not implemented). Default: "false" + Adaption to additive and scaling gray value changes. Default: "true" + Minimum difference between objects. Default: 10 + Evaluation of the character. + + + Training of an OCV tool. + Pattern to be trained. + Handle of the OCV tool to be trained. + Name(s) of the object(s) to analyse. Default: "a" + Mode for training (only one mode implemented). Default: "single" + + + Deserialize a serialized OCV tool. + Handle of the serialized item. + Handle of the OCV tool. + + + Serialize an OCV tool. + Handle of the OCV tool. + Handle of the serialized item. + + + Reading an OCV tool from file. + Name of the file which has to be read. Default: "test_ocv" + Handle of read OCV tool. + + + Saving an OCV tool to file. + Handle of the OCV tool to be written. + Name of the file where the tool has to be saved. Default: "test_ocv" + + + This operator is inoperable. It had the following function: Clear all OCV tools. + + + Clear an OCV tool. + Handle of the OCV tool which has to be freed. + + + Create a new OCV tool based on gray value projections. + List of names for patterns to be trained. Default: "a" + Handle of the created OCV tool. + + + Classify a related group of characters with an OCR classifier. + Characters to be recognized. + Gray values of the characters. + Handle of the OCR classifier. + Expression describing the allowed word structure. + Number of classes per character considered for the internal word correction. Default: 3 + Maximum number of corrected characters. Default: 2 + Result of classifying the characters with the k-NN. + Confidence of the class of the characters. + Word text after classification and correction. + Measure of similarity between corrected word and uncorrected classification results. + + + Deserialize a serialized k-NN-based OCR classifier. + Handle of the serialized item. + Handle of the OCR classifier. + + + Serialize a k-NN-based OCR classifier. + Handle of the OCR classifier. + Handle of the serialized item. + + + Read an OCR classifier from a file. + File name. + Handle of the OCR classifier. + + + Write a k-NN classifier for an OCR task to a file. + Handle of the k-NN classifier for an OCR task. + File name. + + + This operator is inoperable. It had the following function: Clear all OCR classifiers. + + + Clear an OCR classifier. + Handle of the OCR classifier. + + + Create an OCR classifier using a k-Nearest Neighbor (k-NN) classifier. + Width of the rectangle to which the gray values of the segmented character are zoomed. Default: 8 + Height of the rectangle to which the gray values of the segmented character are zoomed. Default: 10 + Interpolation mode for the zooming of the characters. Default: "constant" + Features to be used for classification. Default: "default" + All characters of the character set to be read. Default: ["0","1","2","3","4","5","6","7","8","9"] + This parameter is not yet supported. Default: [] + This parameter is not yet supported. Default: [] + Handle of the k-NN classifier. + + + Trains an k-NN classifier for an OCR task. + Handle of the k-NN classifier. + Names of the training files. Default: "ocr.trf" + Names of the generic parameters that can be adjusted for the k-NN classifier creation. Default: [] + Values of the generic parameters that can be adjusted for the k-NN classifier creation. Default: [] + + + Compute the features of a character. + Input character. + Handle of the k-NN classifier. + Should the feature vector be transformed with the preprocessing? Default: "true" + Feature vector of the character. + + + Return the parameters of an OCR classifier. + Handle of the OCR classifier. + Width of the rectangle to which the gray values of the segmented character are zoomed. + Height of the rectangle to which the gray values of the segmented character are zoomed. + Interpolation mode for the zooming of the characters. + Features to be used for classification. + Characters of the character set to be read. + Type of preprocessing used to transform the feature vectors. + Number of different trees used during the classifcation. + + + Classify multiple characters with an k-NN classifier. + Characters to be recognized. + Gray values of the characters. + Handle of the k-NN classifier. + Result of classifying the characters with the k-NN. + Confidence of the class of the characters. + + + Classify a single character with an OCR classifier. + Character to be recognized. + Gray values of the character. + Handle of the k-NN classifier. + Number of maximal classes to determine. Default: 1 + Number of neighbors to consider. Default: 1 + Results of classifying the character with the k-NN. + Confidence(s) of the class(es) of the character. + + + Select an optimal combination of features to classify OCR data. + Names of the training files. Default: "" + List of features that should be considered for selection. Default: ["zoom_factor","ratio","width","height","foreground","foreground_grid_9","foreground_grid_16","anisometry","compactness","convexity","moments_region_2nd_invar","moments_region_2nd_rel_invar","moments_region_3rd_invar","moments_central","phi","num_connect","num_holes","projection_horizontal","projection_vertical","projection_horizontal_invar","projection_vertical_invar","chord_histo","num_runs","pixel","pixel_invar","pixel_binary","gradient_8dir","cooc","moments_gray_plane"] + Method to perform the selection. Default: "greedy" + Width of the rectangle to which the gray values of the segmented character are zoomed. Default: 15 + Height of the rectangle to which the gray values of the segmented character are zoomed. Default: 16 + Names of generic parameters to configure the selection process and the classifier. Default: [] + Values of generic parameters to configure the selection process and the classifier. Default: [] + Trained OCR-k-NN classifier. + Selected feature set, contains only entries from FeatureList. + Achieved score using tow-fold cross-validation. + + + Select an optimal combination of features to classify OCR data from a (protected) training file. + Names of the training files. Default: "" + Passwords for protected training files. + List of features that should be considered for selection. Default: ["zoom_factor","ratio","width","height","foreground","foreground_grid_9","foreground_grid_16","anisometry","compactness","convexity","moments_region_2nd_invar","moments_region_2nd_rel_invar","moments_region_3rd_invar","moments_central","phi","num_connect","num_holes","projection_horizontal","projection_vertical","projection_horizontal_invar","projection_vertical_invar","chord_histo","num_runs","pixel","pixel_invar","pixel_binary","gradient_8dir","cooc","moments_gray_plane"] + Method to perform the selection. Default: "greedy" + Width of the rectangle to which the gray values of the segmented character are zoomed. Default: 15 + Height of the rectangle to which the gray values of the segmented character are zoomed. Default: 16 + Names of generic parameters to configure the selection process and the classifier. Default: [] + Values of generic parameters to configure the selection process and the classifier. Default: [] + Trained OCR-MLP classifier. + Selected feature set, contains only entries from FeatureList. + Achieved score using tow-fold cross-validation. + + + Selects an optimal combination of features to classify OCR data. + Names of the training files. Default: "" + List of features that should be considered for selection. Default: ["zoom_factor","ratio","width","height","foreground","foreground_grid_9","foreground_grid_16","anisometry","compactness","convexity","moments_region_2nd_invar","moments_region_2nd_rel_invar","moments_region_3rd_invar","moments_central","phi","num_connect","num_holes","projection_horizontal","projection_vertical","projection_horizontal_invar","projection_vertical_invar","chord_histo","num_runs","pixel","pixel_invar","pixel_binary","gradient_8dir","cooc","moments_gray_plane"] + Method to perform the selection. Default: "greedy" + Width of the rectangle to which the gray values of the segmented character are zoomed. Default: 15 + Height of the rectangle to which the gray values of the segmented character are zoomed. Default: 16 + Names of generic parameters to configure the selection process and the classifier. Default: [] + Values of generic parameters to configure the selection process and the classifier. Default: [] + Trained OCR-MLP classifier. + Selected feature set, contains only entries from FeatureList. + Achieved score using tow-fold cross-validation. + + + Select an optimal combination of features to classify OCR data from a (protected) training file. + Names of the training files. Default: "" + Passwords for protected training files. + List of features that should be considered for selection. Default: ["zoom_factor","ratio","width","height","foreground","foreground_grid_9","foreground_grid_16","anisometry","compactness","convexity","moments_region_2nd_invar","moments_region_2nd_rel_invar","moments_region_3rd_invar","moments_central","phi","num_connect","num_holes","projection_horizontal","projection_vertical","projection_horizontal_invar","projection_vertical_invar","chord_histo","num_runs","pixel","pixel_invar","pixel_binary","gradient_8dir","cooc","moments_gray_plane"] + Method to perform the selection. Default: "greedy" + Width of the rectangle to which the gray values of the segmented character are zoomed. Default: 15 + Height of the rectangle to which the gray values of the segmented character are zoomed. Default: 16 + Names of generic parameters to configure the selection process and the classifier. Default: [] + Values of generic parameters to configure the selection process and the classifier. Default: [] + Trained OCR-SVM Classifier. + Selected feature set, contains only entries from FeatureList. + Achieved score using tow-fold cross-validation. + + + Selects an optimal combination of features to classify OCR data. + Names of the training files. Default: "" + List of features that should be considered for selection. Default: ["zoom_factor","ratio","width","height","foreground","foreground_grid_9","foreground_grid_16","anisometry","compactness","convexity","moments_region_2nd_invar","moments_region_2nd_rel_invar","moments_region_3rd_invar","moments_central","phi","num_connect","num_holes","projection_horizontal","projection_vertical","projection_horizontal_invar","projection_vertical_invar","chord_histo","num_runs","pixel","pixel_invar","pixel_binary","gradient_8dir","cooc","moments_gray_plane"] + Method to perform the selection. Default: "greedy" + Width of the rectangle to which the gray values of the segmented character are zoomed. Default: 15 + Height of the rectangle to which the gray values of the segmented character are zoomed. Default: 16 + Names of generic parameters to configure the selection process and the classifier. Default: [] + Values of generic parameters to configure the selection process and the classifier. Default: [] + Trained OCR-SVM Classifier. + Selected feature set, contains only entries from FeatureList. + Achieved score using tow-fold cross-validation. + + + This operator is inoperable. It had the following function: Clear all lexica. + + + Clear a lexicon. + Handle of the lexicon. + + + Find a similar word in a lexicon. + Handle of the lexicon. + Word to be looked up. Default: "word" + Most similar word found in the lexicon. + Difference between the words in edit operations. + + + Check if a word is contained in a lexicon. + Handle of the lexicon. + Word to be looked up. Default: "word" + Result of the search. + + + Query all words from a lexicon. + Handle of the lexicon. + List of all words. + + + Create a lexicon from a text file. + Unique name for the new lexicon. Default: "lex1" + Name of a text file containing words for the new lexicon. Default: "words.txt" + Handle of the lexicon. + + + Create a lexicon from a tuple of words. + Unique name for the new lexicon. Default: "lex1" + Word list for the new lexicon. Default: ["word1","word2","word3"] + Handle of the lexicon. + + + This operator is inoperable. It had the following function: Clear all SVM based OCR classifiers. + + + Clear an SVM-based OCR classifier. + Handle of the OCR classifier. + + + Deserialize a serialized SVM-based OCR classifier. + Handle of the serialized item. + Handle of the OCR classifier. + + + Serialize a SVM-based OCR classifier + Handle of the OCR classifier. + Handle of the serialized item. + + + Read a SVM-based OCR classifier from a file. + File name. + Handle of the OCR classifier. + + + Write an OCR classifier to a file. + Handle of the OCR classifier. + File name. + + + Compute the features of a character. + Input character. + Handle of the OCR classifier. + Should the feature vector be transformed with the preprocessing? Default: "true" + Feature vector of the character. + + + Classify a related group of characters with an OCR classifier. + Characters to be recognized. + Gray values of the characters. + Handle of the OCR classifier. + Expression describing the allowed word structure. + Number of classes per character considered for the internal word correction. Default: 3 + Maximum number of corrected characters. Default: 2 + Result of classifying the characters with the SVM. + Word text after classification and correction. + Measure of similarity between corrected word and uncorrected classification results. + + + Classify multiple characters with an SVM-based OCR classifier. + Characters to be recognized. + Gray values of the characters. + Handle of the OCR classifier. + Result of classifying the characters with the SVM. + + + Classify a single character with an SVM-based OCR classifier. + Character to be recognized. + Gray values of the character. + Handle of the OCR classifier. + Number of best classes to determine. Default: 1 + Result of classifying the character with the SVM. + + + Approximate a trained SVM-based OCR classifier by a reduced SVM. + Original handle of SVM-based OCR-classifier. + Type of postprocessing to reduce number of SVs. Default: "bottom_up" + Minimum number of remaining SVs. Default: 2 + Maximum allowed error of reduction. Default: 0.001 + SVMHandle of reduced OCR classifier. + + + Train an OCR classifier with data from a (protected) training file. + Handle of the OCR classifier. + Names of the training files. Default: "ocr.trf" + Passwords for protected training files. + Stop parameter for training. Default: 0.001 + Mode of training. Default: "default" + + + Train an OCR classifier. + Handle of the OCR classifier. + Names of the training files. Default: "ocr.trf" + Stop parameter for training. Default: 0.001 + Mode of training. Default: "default" + + + Compute the information content of the preprocessed feature vectors of an SVM-based OCR classifier. + Handle of the OCR classifier. + Names of the training files. Default: "ocr.trf" + Type of preprocessing used to transform the feature vectors. Default: "principal_components" + Relative information content of the transformed feature vectors. + Cumulative information content of the transformed feature vectors. + + + Return the number of support vectors of an OCR classifier. + OCR handle. + Total number of support vectors. + Number of SV of each sub-SVM. + + + Return the index of a support vector from a trained OCR classifier that is based on support vector machines. + OCR handle. + Number of stored support vectors. + Index of the support vector in the training set. + + + Return the parameters of an OCR classifier. + Handle of the OCR classifier. + Width of the rectangle to which the gray values of the segmented character are zoomed. + Height of the rectangle to which the gray values of the segmented character are zoomed. + Interpolation mode for the zooming of the characters. + Features to be used for classification. + Characters of the character set to be read. + The kernel type. + Additional parameters for the kernel function. + Regularization constant of the SVM. + The mode of the SVM. + Type of preprocessing used to transform the feature vectors. + Preprocessing parameter: Number of transformed features (ignored for Preprocessing $=$ 'none' and Preprocessing $=$ 'normalization'). + + + Create an OCR classifier using a support vector machine. + Width of the rectangle to which the gray values of the segmented character are zoomed. Default: 8 + Height of the rectangle to which the gray values of the segmented character are zoomed. Default: 10 + Interpolation mode for the zooming of the characters. Default: "constant" + Features to be used for classification. Default: "default" + All characters of the character set to be read. Default: ["0","1","2","3","4","5","6","7","8","9"] + The kernel type. Default: "rbf" + Additional parameter for the kernel function. Default: 0.02 + Regularization constant of the SVM. Default: 0.05 + The mode of the SVM. Default: "one-versus-one" + Type of preprocessing used to transform the feature vectors. Default: "normalization" + Preprocessing parameter: Number of transformed features (ignored for Preprocessing $=$ 'none' and Preprocessing $=$ 'normalization'). Default: 10 + Handle of the OCR classifier. + + + This operator is inoperable. It had the following function: Clear all OCR classifiers. + + + Clear an OCR classifier. + Handle of the OCR classifier. + + + Deserialize a serialized MLP-based OCR classifier. + Handle of the serialized item. + Handle of the OCR classifier. + + + Serialize a MLP-based OCR classifier. + Handle of the OCR classifier. + Handle of the serialized item. + + + Read an OCR classifier from a file. + File name. + Handle of the OCR classifier. + + + Write an OCR classifier to a file. + Handle of the OCR classifier. + File name. + + + Compute the features of a character. + Input character. + Handle of the OCR classifier. + Should the feature vector be transformed with the preprocessing? Default: "true" + Feature vector of the character. + + + Classify a related group of characters with an OCR classifier. + Characters to be recognized. + Gray values of the characters. + Handle of the OCR classifier. + Expression describing the allowed word structure. + Number of classes per character considered for the internal word correction. Default: 3 + Maximum number of corrected characters. Default: 2 + Result of classifying the characters with the MLP. + Confidence of the class of the characters. + Word text after classification and correction. + Measure of similarity between corrected word and uncorrected classification results. + + + Classify multiple characters with an OCR classifier. + Characters to be recognized. + Gray values of the characters. + Handle of the OCR classifier. + Result of classifying the characters with the MLP. + Confidence of the class of the characters. + + + Classify a single character with an OCR classifier. + Character to be recognized. + Gray values of the character. + Handle of the OCR classifier. + Number of best classes to determine. Default: 1 + Result of classifying the character with the MLP. + Confidence(s) of the class(es) of the character. + + + Train an OCR classifier with data from a (protected) training file. + Handle of the OCR classifier. + Names of the training files. Default: "ocr.trf" + Passwords for protected training files. + Maximum number of iterations of the optimization algorithm. Default: 200 + Threshold for the difference of the weights of the MLP between two iterations of the optimization algorithm. Default: 1.0 + Threshold for the difference of the mean error of the MLP on the training data between two iterations of the optimization algorithm. Default: 0.01 + Mean error of the MLP on the training data. + Mean error of the MLP on the training data as a function of the number of iterations of the optimization algorithm. + + + Train an OCR classifier. + Handle of the OCR classifier. + Names of the training files. Default: "ocr.trf" + Maximum number of iterations of the optimization algorithm. Default: 200 + Threshold for the difference of the weights of the MLP between two iterations of the optimization algorithm. Default: 1.0 + Threshold for the difference of the mean error of the MLP on the training data between two iterations of the optimization algorithm. Default: 0.01 + Mean error of the MLP on the training data. + Mean error of the MLP on the training data as a function of the number of iterations of the optimization algorithm. + + + Compute the information content of the preprocessed feature vectors of an OCR classifier. + Handle of the OCR classifier. + Names of the training files. Default: "ocr.trf" + Type of preprocessing used to transform the feature vectors. Default: "principal_components" + Relative information content of the transformed feature vectors. + Cumulative information content of the transformed feature vectors. + + + Return the rejection class parameters of an OCR classifier. + Handle of the OCR classifier. + Name of the general parameter. Default: "sampling_strategy" + Value of the general parameter. + + + Set the rejection class parameters of an OCR classifier. + Handle of the OCR classifier. + Name of the general parameter. Default: "sampling_strategy" + Value of the general parameter. Default: "hyperbox_around_all_classes" + + + Return the regularization parameters of an OCR classifier. + Handle of the OCR classifier. + Name of the regularization parameter to return. Default: "weight_prior" + Value of the regularization parameter. + + + Set the regularization parameters of an OCR classifier. + Handle of the OCR classifier. + Name of the regularization parameter to return. Default: "weight_prior" + Value of the regularization parameter. Default: 1.0 + + + Return the parameters of an OCR classifier. + Handle of the OCR classifier. + Width of the rectangle to which the gray values of the segmented character are zoomed. + Height of the rectangle to which the gray values of the segmented character are zoomed. + Interpolation mode for the zooming of the characters. + Features to be used for classification. + Characters of the character set to be read. + Number of hidden units of the MLP. + Type of preprocessing used to transform the feature vectors. + Preprocessing parameter: Number of transformed features. + + + Create an OCR classifier using a multilayer perceptron. + Width of the rectangle to which the gray values of the segmented character are zoomed. Default: 8 + Height of the rectangle to which the gray values of the segmented character are zoomed. Default: 10 + Interpolation mode for the zooming of the characters. Default: "constant" + Features to be used for classification. Default: "default" + All characters of the character set to be read. Default: ["0","1","2","3","4","5","6","7","8","9"] + Number of hidden units of the MLP. Default: 80 + Type of preprocessing used to transform the feature vectors. Default: "none" + Preprocessing parameter: Number of transformed features (ignored for Preprocessing $=$ 'none' and Preprocessing $=$ 'normalization'). Default: 10 + Seed value of the random number generator that is used to initialize the MLP with random values. Default: 42 + Handle of the OCR classifier. + + + Serialize an OCR classifier. + ID of the OCR classifier. + Handle of the serialized item. + + + Deserialize a serialized OCR classifier. + Handle of the serialized item. + ID of the OCR classifier. + + + Writing an OCR classifier into a file. + ID of the OCR classifier. + Name of the file for the OCR classifier (without extension). Default: "my_ocr" + + + Read an OCR classifier from a file. + Name of the OCR classifier file. Default: "testnet" + ID of the read OCR classifier. + + + Classify one character. + Character to be recognized. + Gray values of the characters. + ID of the OCR classifier. + Classes (names) of the characters. + Confidence values of the characters. + + + Classify characters. + Characters to be recognized. + Gray values for the characters. + ID of the OCR classifier. + Class (name) of the characters. + Confidence values of the characters. + + + Get information about an OCR classifier. + ID of the OCR classifier. + Width of the scaled characters. + Height of the scaled characters. + Interpolation mode for scaling the characters. + Width of the largest trained character. + Height of the largest trained character. + Used features. + All characters of the set. + + + Create a new OCR-classifier. + Width of the input layer of the network. Default: 8 + Height of the input layer of the network. Default: 10 + Interpolation mode concerning scaling of characters. Default: 1 + Additional features. Default: "default" + All characters of a set. Default: ["a","b","c"] + ID of the created OCR classifier. + + + Train an OCR classifier by the input of regions. + Characters to be trained. + Gray values for the characters. + ID of the desired OCR-classifier. + Class (name) of the characters. Default: "a" + Average confidence during a re-classification of the trained characters. + + + Train an OCR classifier with the help of a training file. + ID of the desired OCR-network. + Names of the training files. Default: "train_ocr" + Average confidence during a re-classification of the trained characters. + + + Protection of training data. + Names of the training files. Default: "" + Passwords for protecting the training files. + Names of the protected training files. + + + Storing of training characters into a file. + Characters to be trained. + Gray values of the characters. + Class (name) of the characters. + Name of the training file. Default: "train_ocr" + + + Define a new conversion table for the characters. + ID of the OCR-network to be changed. + New assign of characters. Default: ["a","b","c"] + + + Deallocation of the memory of an OCR classifier. + ID of the OCR classifier to be deleted. + + + Sorting of regions with respect to their relative position. + Regions to be sorted. + Sorted regions. + Kind of sorting. Default: "first_point" + Increasing or decreasing sorting order. Default: "true" + Sorting first with respect to row, then to column. Default: "row" + + + This operator is inoperable. It had the following function: Destroy all OCR classifiers. + + + Test an OCR classifier. + Characters to be tested. + Gray values for the characters. + ID of the desired OCR-classifier. + Class (name) of the characters. Default: "a" + Confidence for the character to belong to the class. + + + Cut out an image area relative to the domain. + Input image. + Image area. + Number of rows clipped at the top. Default: -1 + Number of columns clipped at the left. Default: -1 + Number of rows clipped at the bottom. Default: -1 + Number of columns clipped at the right. Default: -1 + + + Access the features which correspond to a character. + Characters to be trained. + ID of the desired OCR-classifier. + Feature vector. + + + Concat training files. + Names of the single training files. Default: "" + Name of the composed training file. Default: "all_characters" + + + Write characters into a training file. + Characters to be trained. + Class (name) of the characters. + Name of the training file. Default: "train_ocr" + + + Add characters to a training file. + Characters to be trained. + Gray values of the characters. + Class (name) of the characters. + Name of the training file. Default: "train_ocr" + + + Query which characters are stored in a (protected) training file. + Names of the training files. Default: "" + Passwords for protected training files. + Names of the read characters. + Number of characters. + + + Query which characters are stored in a training file. + Names of the training files. Default: "" + Names of the read characters. + Number of characters. + + + Read training specific characters from files and convert to images. + Images read from file. + Names of the training files. Default: "" + Names of the characters to be extracted. Default: "0" + Names of the read characters. + + + Read training characters from files and convert to images. + Images read from file. + Names of the training files. Default: "" + Names of the read characters. + + + Prune the branches of a region. + Regions to be processed. + Result of the pruning operation. + Length of the branches to be removed. Default: 2 + + + Reduce a region to its boundary. + Regions for which the boundary is to be computed. + Resulting boundaries. + Boundary type. Default: "inner" + + + Perform a closing after an opening with multiple structuring elements. + Regions to be processed. + Structuring elements. + Fitted regions. + + + Generate standard structuring elements. + Generated structuring elements. + Type of structuring element to generate. Default: "noise" + Row coordinate of the reference point. Default: 1 + Column coordinate of the reference point. Default: 1 + + + Reflect a region about a point. + Region to be reflected. + Transposed region. + Row coordinate of the reference point. Default: 0 + Column coordinate of the reference point. Default: 0 + + + Remove the result of a hit-or-miss operation from a region (sequential). + Regions to be processed. + Result of the thinning operator. + Structuring element from the Golay alphabet. Default: "l" + Number of iterations. For 'f', 'f2', 'h' and 'i' the only useful value is 1. Default: 20 + + + Remove the result of a hit-or-miss operation from a region (using a Golay structuring element). + Regions to be processed. + Result of the thinning operator. + Structuring element from the Golay alphabet. Default: "h" + Rotation of the Golay element. Depending on the element, not all rotations are valid. Default: 0 + + + Remove the result of a hit-or-miss operation from a region. + Regions to be processed. + Structuring element for the foreground. + Structuring element for the background. + Result of the thinning operator. + Row coordinate of the reference point. Default: 0 + Column coordinate of the reference point. Default: 0 + Number of iterations. Default: 1 + + + Add the result of a hit-or-miss operation to a region (sequential). + Regions to be processed. + Result of the thickening operator. + Structuring element from the Golay alphabet. Default: "h" + Number of iterations. Default: 1 + + + Add the result of a hit-or-miss operation to a region (using a Golay structuring element). + Regions to be processed. + Result of the thickening operator. + Structuring element from the Golay alphabet. Default: "h" + Rotation of the Golay element. Depending on the element, not all rotations are valid. Default: 0 + + + Add the result of a hit-or-miss operation to a region. + Regions to be processed. + Structuring element for the foreground. + Structuring element for the background. + Result of the thickening operator. + Row coordinate of the reference point. Default: 16 + Column coordinate of the reference point. Default: 16 + Number of iterations. Default: 1 + + + Hit-or-miss operation for regions using the Golay alphabet (sequential). + Regions to be processed. + Result of the hit-or-miss operation. + Structuring element from the Golay alphabet. Default: "h" + + + Hit-or-miss operation for regions using the Golay alphabet. + Regions to be processed. + Result of the hit-or-miss operation. + Structuring element from the Golay alphabet. Default: "h" + Rotation of the Golay element. Depending on the element, not all rotations are valid. Default: 0 + + + Hit-or-miss operation for regions. + Regions to be processed. + Erosion mask for the input regions. + Erosion mask for the complements of the input regions. + Result of the hit-or-miss operation. + Row coordinate of the reference point. Default: 16 + Column coordinate of the reference point. Default: 16 + + + Generate the structuring elements of the Golay alphabet. + Structuring element for the foreground. + Structuring element for the background. + Name of the structuring element. Default: "l" + Rotation of the Golay element. Depending on the element, not all rotations are valid. Default: 0 + Row coordinate of the reference point. Default: 16 + Column coordinate of the reference point. Default: 16 + + + Thinning of a region. + Regions to be thinned. + Result of the skiz operator. + Number of iterations for the sequential thinning with the element 'l' of the Golay alphabet. Default: 100 + Number of iterations for the sequential thinning with the element 'e' of the Golay alphabet. Default: 1 + + + Compute the morphological skeleton of a region. + Regions to be processed. + Resulting morphological skeleton. + + + Compute the union of bottom_hat and top_hat. + Regions to be processed. + Structuring element (position-invariant). + Union of top hat and bottom hat. + + + Compute the bottom hat of regions. + Regions to be processed. + Structuring element (position independent). + Result of the bottom hat operator. + + + Compute the top hat of regions. + Regions to be processed. + Structuring element (position independent). + Result of the top hat operator. + + + Erode a region (using a reference point). + Regions to be eroded. + Structuring element. + Eroded regions. + Row coordinate of the reference point. Default: 0 + Column coordinate of the reference point. Default: 0 + Number of iterations. Default: 1 + + + Erode a region. + Regions to be eroded. + Structuring element. + Eroded regions. + Number of iterations. Default: 1 + + + Dilate a region (using a reference point). + Regions to be dilated. + Structuring element. + Dilated regions. + Row coordinate of the reference point. + Column coordinate of the reference point. + Number of iterations. Default: 1 + + + Perform a Minkowski addition on a region. + Regions to be dilated. + Structuring element. + Dilated regions. + Number of iterations. Default: 1 + + + Close a region with a rectangular structuring element. + Regions to be closed. + Closed regions. + Width of the structuring rectangle. Default: 10 + Height of the structuring rectangle. Default: 10 + + + Close a region with an element from the Golay alphabet. + Regions to be closed. + Closed regions. + Structuring element from the Golay alphabet. Default: "h" + Rotation of the Golay element. Depending on the element, not all rotations are valid. Default: 0 + + + Close a region with a circular structuring element. + Regions to be closed. + Closed regions. + Radius of the circular structuring element. Default: 3.5 + + + Close a region. + Regions to be closed. + Structuring element (position-invariant). + Closed regions. + + + Separate overlapping regions. + Regions to be opened. + Structuring element (position-invariant). + Opened regions. + + + Open a region with an element from the Golay alphabet. + Regions to be opened. + Opened regions. + Structuring element from the Golay alphabet. Default: "h" + Rotation of the Golay element. Depending on the element, not all rotations are valid. Default: 0 + + + Open a region with a rectangular structuring element. + Regions to be opened. + Opened regions. + Width of the structuring rectangle. Default: 10 + Height of the structuring rectangle. Default: 10 + + + Open a region with a circular structuring element. + Regions to be opened. + Opened regions. + Radius of the circular structuring element. Default: 3.5 + + + Open a region. + Regions to be opened. + Structuring element (position-invariant). + Opened regions. + + + Erode a region sequentially. + Regions to be eroded. + Eroded regions. + Structuring element from the Golay alphabet. Default: "h" + Number of iterations. Default: 1 + + + Erode a region with an element from the Golay alphabet. + Regions to be eroded. + Eroded regions. + Structuring element from the Golay alphabet. Default: "h" + Number of iterations. Default: 1 + Rotation of the Golay element. Depending on the element, not all rotations are valid. Default: 0 + + + Erode a region with a rectangular structuring element. + Regions to be eroded. + Eroded regions. + Width of the structuring rectangle. Default: 11 + Height of the structuring rectangle. Default: 11 + + + Erode a region with a circular structuring element. + Regions to be eroded. + Eroded regions. + Radius of the circular structuring element. Default: 3.5 + + + Erode a region (using a reference point). + Regions to be eroded. + Structuring element. + Eroded regions. + Row coordinate of the reference point. Default: 0 + Column coordinate of the reference point. Default: 0 + Number of iterations. Default: 1 + + + Erode a region. + Regions to be eroded. + Structuring element. + Eroded regions. + Number of iterations. Default: 1 + + + Dilate a region sequentially. + Regions to be dilated. + Dilated regions. + Structuring element from the Golay alphabet. Default: "h" + Number of iterations. Default: 1 + + + Dilate a region with an element from the Golay alphabet. + Regions to be dilated. + Dilated regions. + Structuring element from the Golay alphabet. Default: "h" + Number of iterations. Default: 1 + Rotation of the Golay element. Depending on the element, not all rotations are valid. Default: 0 + + + Dilate a region with a rectangular structuring element. + Regions to be dilated. + Dilated regions. + Width of the structuring rectangle. Default: 11 + Height of the structuring rectangle. Default: 11 + + + Dilate a region with a circular structuring element. + Regions to be dilated. + Dilated regions. + Radius of the circular structuring element. Default: 3.5 + + + Dilate a region (using a reference point). + Regions to be dilated. + Structuring element. + Dilated regions. + Row coordinate of the reference point. Default: 0 + Column coordinate of the reference point. Default: 0 + Number of iterations. Default: 1 + + + Dilate a region. + Regions to be dilated. + Structuring element. + Dilated regions. + Number of iterations. Default: 1 + + + Perform a gray value bottom hat transformation on an image. + Input image. + Structuring element. + Bottom hat image. + + + Perform a gray value top hat transformation on an image. + Input image. + Structuring element. + Top hat image. + + + Perform a gray value closing on an image. + Input image. + Structuring element. + Gray-closed image. + + + Perform a gray value opening on an image. + Input image. + Structuring element. + Gray-opened image. + + + Perform a gray value dilation on an image. + Input image. + Structuring element. + Gray-dilated image. + + + Perform a gray value erosion on an image. + Input image. + Structuring element. + Gray-eroded image. + + + Load a structuring element for gray morphology. + Generated structuring element. + Name of the file containing the structuring element. + + + Generate ellipsoidal structuring elements for gray morphology. + Generated structuring element. + Pixel type. Default: "byte" + Width of the structuring element. Default: 5 + Height of the structuring element. Default: 5 + Maximum gray value of the structuring element. Default: 0 + + + Query the model contour of a metrology object in image coordinates. + Model contour. + Handle of the metrology model. + Index of the metrology object. Default: 0 + Distance between neighboring contour points. Default: 1.5 + + + Query the result contour of a metrology object. + Result contour for the given metrology object. + Handle of the metrology model. + Index of the metrology object. Default: 0 + Instance of the metrology object. Default: "all" + Distance between neighboring contour points. Default: 1.5 + + + Alignment of a metrology model. + Handle of the metrology model. + Row coordinate of the alignment. Default: 0 + Column coordinate of the alignment. Default: 0 + Rotation angle of the alignment. Default: 0 + + + Add a metrology object to a metrology model. + Handle of the metrology model. + Type of the metrology object to be added. Default: "circle" + Parameters of the metrology object to be added. + Half length of the measure regions perpendicular to the boundary. Default: 20.0 + Half length of the measure regions tangetial to the boundary. Default: 5.0 + Sigma of the Gaussian function for the smoothing. Default: 1.0 + Minimum edge amplitude. Default: 30.0 + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Index of the created metrology object. + + + Get parameters that are valid for the entire metrology model. + Handle of the metrology model. + Name of the generic parameter. Default: "camera_param" + Value of the generic parameter. + + + Set parameters that are valid for the entire metrology model. + Handle of the metrology model. + Name of the generic parameter. Default: "camera_param" + Value of the generic parameter. Default: [] + + + Deserialize a serialized metrology model. + Handle of the serialized item. + Handle of the metrology model. + + + Serialize a metrology model. + Handle of the metrology model. + Handle of the serialized item. + + + Transform metrology objects of a metrology model, e.g. for alignment. + Handle of the metrology model. + Index of the metrology objects. Default: "all" + Translation in row direction. + Translation in column direction. + Rotation angle. + Mode of the transformation. Default: "absolute" + + + Write a metrology model to a file. + Handle of the metrology model. + File name. + + + Read a metrology model from a file. + File name. + Handle of the metrology model. + + + Copy a metrology model. + Handle of the metrology model. + Index of the metrology objects. Default: "all" + Handle of the copied metrology model. + + + Copy metrology metrology objects of a metrology model. + Handle of the metrology model. + Index of the metrology objects. Default: "all" + Indices of the copied metrology objects. + + + Get the number of instances of the metrology objects of a metrology model. + Handle of the metrology model. + Index of the metrology objects. Default: 0 + Number of Instances of the metrology objects. + + + Get the results of the measurement of a metrology model. + Handle of the metrology model. + Index of the metrology object. Default: 0 + Instance of the metrology object. Default: "all" + Name of the generic parameter. Default: "result_type" + Value of the generic parameter. Default: "all_param" + Result values. + + + Get the measure regions and the results of the edge location for the metrology objects of a metrology model. + Rectangular XLD Contours of measure regions. + Handle of the metrology model. + Index of the metrology objects. Default: "all" + Select light/dark or dark/light edges. Default: "all" + Row coordinates of the measured edges. + Column coordinates of the measured edges. + + + Measure and fit the geometric shapes of all metrology objects of a metrology model. + Input image. + Handle of the metrology model. + + + Get the indices of the metrology objects of a metrology model. + Handle of the metrology model. + Indices of the metrology objects. + + + Reset all fuzzy parameters and fuzzy functions of a metrology model. + Handle of the metrology model. + Index of the metrology objects. Default: "all" + + + Reset all parameters of a metrology model. + Handle of the metrology model. + Index of the metrology objects. Default: "all" + + + Get a fuzzy parameter of a metroloy model. + Handle of the metrology model. + Index of the metrology objects. Default: "all" + Names of the generic parameters. Default: "fuzzy_thresh" + Values of the generic parameters. + + + Get one or several parameters of a metroloy model. + Handle of the metrology model. + Index of the metrology objects. Default: "all" + Names of the generic parameters. Default: "num_measures" + Values of the generic parameters. + + + Set fuzzy parameters or fuzzy functions for a metrology model. + Handle of the metrology model. + Index of the metrology objects. Default: "all" + Names of the generic parameters. Default: "fuzzy_thresh" + Values of the generic parameters. Default: 0.5 + + + Set parameters for the metrology objects of a metrology model. + Handle of the metrology model. + Index of the metrology objects. Default: "all" + Names of the generic parameters. Default: "num_instances" + Values of the generic parameters. Default: 1 + + + Add a rectangle to a metrology model. + Handle of the metrology model. + Row (or Y) coordinate of the center of the rectangle. + Column (or X) coordinate of the center of the rectangle. + Orientation of the main axis [rad]. + Length of the larger half edge of the rectangle. + Length of the smaller half edge of the rectangle. + Half length of the measure regions perpendicular to the boundary. Default: 20.0 + Half length of the measure regions tangetial to the boundary. Default: 5.0 + Sigma of the Gaussian function for the smoothing. Default: 1.0 + Minimum edge amplitude. Default: 30.0 + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Index of the created metrology object. + + + Add a line to a metrology model. + Handle of the metrology model. + Row (or Y) coordinate of the start of the line. + Column (or X) coordinate of the start of the line. + Row (or Y) coordinate of the end of the line. + Column (or X) coordinate of the end of the line. + Half length of the measure regions perpendicular to the boundary. Default: 20.0 + Half length of the measure regions tangetial to the boundary. Default: 5.0 + Sigma of the Gaussian function for the smoothing. Default: 1.0 + Minimum edge amplitude. Default: 30.0 + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Index of the created metrology object. + + + Add an ellipse or an elliptic arc to a metrology model. + Handle of the metrology model. + Row (or Y) coordinate of the center of the ellipse. + Column (or X) coordinate of the center of the ellipse. + Orientation of the main axis [rad]. + Length of the larger half axis. + Length of the smaller half axis. + Half length of the measure regions perpendicular to the boundary. Default: 20.0 + Half length of the measure regions tangetial to the boundary. Default: 5.0 + Sigma of the Gaussian function for the smoothing. Default: 1.0 + Minimum edge amplitude. Default: 30.0 + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Index of the created metrology object. + + + Add a circle or a circular arc to a metrology model. + Handle of the metrology model. + Row coordinate (or Y) of the center of the circle or circular arc. + Column (or X) coordinate of the center of the circle or circular arc. + Radius of the circle or circular arc. + Half length of the measure regions perpendicular to the boundary. Default: 20.0 + Half length of the measure regions tangetial to the boundary. Default: 5.0 + Sigma of the Gaussian function for the smoothing. Default: 1.0 + Minimum edge amplitude. Default: 30.0 + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Index of the created metrology object. + + + This operator is inoperable. It had the following function: Delete all metrology models and free the allocated memory. + + + Delete a metrology model and free the allocated memory. + Handle of the metrology model. + + + Delete metrology objects and free the allocated memory. + Handle of the metrology model. + Index of the metrology objects. Default: "all" + + + Set the size of the image of metrology objects. + Handle of the metrology model. + Width of the image to be processed. Default: 640 + Height of the image to be processed. Default: 480 + + + Create the data structure that is needed to measure geometric shapes. + Handle of the metrology model. + + + Serialize a measure object. + Measure object handle. + Handle of the serialized item. + + + Deserialize a serialized measure object. + Handle of the serialized item. + Measure object handle. + + + Write a measure object to a file. + Measure object handle. + File name. + + + Read a measure object from a file. + File name. + Measure object handle. + + + Extracting points with a particular gray value along a rectangle or an annular arc. + Input image. + Measure object handle. + Sigma of gaussian smoothing. Default: 1.0 + Threshold. Default: 128.0 + Selection of points. Default: "all" + Row coordinates of points with threshold value. + Column coordinates of points with threshold value. + Distance between consecutive points. + + + This operator is inoperable. It had the following function: Delete all measure objects. + + + Delete a measure object. + Measure object handle. + + + Extract a gray value profile perpendicular to a rectangle or annular arc. + Input image. + Measure object handle. + Gray value profile. + + + Reset a fuzzy function. + Measure object handle. + Selection of the fuzzy set. Default: "contrast" + + + Specify a normalized fuzzy function for edge pairs. + Measure object handle. + Favored width of edge pairs. Default: 10.0 + Selection of the fuzzy set. Default: "size_abs_diff" + Fuzzy function. + + + Specify a fuzzy function. + Measure object handle. + Selection of the fuzzy set. Default: "contrast" + Fuzzy function. + + + Extract straight edge pairs perpendicular to a rectangle or an annular arc. + Input image. + Measure object handle. + Sigma of Gaussian smoothing. Default: 1.0 + Minimum edge amplitude. Default: 30.0 + Minimum fuzzy value. Default: 0.5 + Select the first gray value transition of the edge pairs. Default: "all" + Constraint of pairing. Default: "no_restriction" + Number of edge pairs. Default: 10 + Row coordinate of the first edge. + Column coordinate of the first edge. + Edge amplitude of the first edge (with sign). + Row coordinate of the second edge. + Column coordinate of the second edge. + Edge amplitude of the second edge (with sign). + Row coordinate of the center of the edge pair. + Column coordinate of the center of the edge pair. + Fuzzy evaluation of the edge pair. + Distance between the edges of the edge pair. + + + Extract straight edge pairs perpendicular to a rectangle or an annular arc. + Input image. + Measure object handle. + Sigma of Gaussian smoothing. Default: 1.0 + Minimum edge amplitude. Default: 30.0 + Minimum fuzzy value. Default: 0.5 + Select the first gray value transition of the edge pairs. Default: "all" + Row coordinate of the first edge point. + Column coordinate of the first edge point. + Edge amplitude of the first edge (with sign). + Row coordinate of the second edge point. + Column coordinate of the second edge point. + Edge amplitude of the second edge (with sign). + Row coordinate of the center of the edge pair. + Column coordinate of the center of the edge pair. + Fuzzy evaluation of the edge pair. + Distance between edges of an edge pair. + Distance between consecutive edge pairs. + + + Extract straight edges perpendicular to a rectangle or an annular arc. + Input image. + Measure object handle. + Sigma of Gaussian smoothing. Default: 1.0 + Minimum edge amplitude. Default: 30.0 + Minimum fuzzy value. Default: 0.5 + Select light/dark or dark/light edges. Default: "all" + Row coordinate of the edge point. + Column coordinate of the edge point. + Edge amplitude of the edge (with sign). + Fuzzy evaluation of the edges. + Distance between consecutive edges. + + + Extract straight edge pairs perpendicular to a rectangle or annular arc. + Input image. + Measure object handle. + Sigma of gaussian smoothing. Default: 1.0 + Minimum edge amplitude. Default: 30.0 + Type of gray value transition that determines how edges are grouped to edge pairs. Default: "all" + Selection of edge pairs. Default: "all" + Row coordinate of the center of the first edge. + Column coordinate of the center of the first edge. + Edge amplitude of the first edge (with sign). + Row coordinate of the center of the second edge. + Column coordinate of the center of the second edge. + Edge amplitude of the second edge (with sign). + Distance between edges of an edge pair. + Distance between consecutive edge pairs. + + + Extract straight edges perpendicular to a rectangle or annular arc. + Input image. + Measure object handle. + Sigma of gaussian smoothing. Default: 1.0 + Minimum edge amplitude. Default: 30.0 + Light/dark or dark/light edge. Default: "all" + Selection of end points. Default: "all" + Row coordinate of the center of the edge. + Column coordinate of the center of the edge. + Edge amplitude of the edge (with sign). + Distance between consecutive edges. + + + Translate a measure object. + Measure object handle. + Row coordinate of the new reference point. Default: 50.0 + Column coordinate of the new reference point. Default: 100.0 + + + Prepare the extraction of straight edges perpendicular to an annular arc. + Row coordinate of the center of the arc. Default: 100.0 + Column coordinate of the center of the arc. Default: 100.0 + Radius of the arc. Default: 50.0 + Start angle of the arc in radians. Default: 0.0 + Angular extent of the arc in radians. Default: 6.28318 + Radius (half width) of the annulus. Default: 10.0 + Width of the image to be processed subsequently. Default: 512 + Height of the image to be processed subsequently. Default: 512 + Type of interpolation to be used. Default: "nearest_neighbor" + Measure object handle. + + + Prepare the extraction of straight edges perpendicular to a rectangle. + Row coordinate of the center of the rectangle. Default: 300.0 + Column coordinate of the center of the rectangle. Default: 200.0 + Angle of longitudinal axis of the rectangle to horizontal (radians). Default: 0.0 + Half width of the rectangle. Default: 100.0 + Half height of the rectangle. Default: 20.0 + Width of the image to be processed subsequently. Default: 512 + Height of the image to be processed subsequently. Default: 512 + Type of interpolation to be used. Default: "nearest_neighbor" + Measure object handle. + + + Deserialize a serialized matrix. + Handle of the serialized item. + Matrix handle. + + + Serialize a matrix. + Matrix handle. + Handle of the serialized item. + + + Read a matrix from a file. + File name. + Matrix handle. + + + Write a matrix to a file. + Matrix handle of the input matrix. + Format of the file. Default: "binary" + File name. + + + Perform an orthogonal decomposition of a matrix. + Matrix handle of the input matrix. + Method of decomposition. Default: "qr" + Type of output matrices. Default: "full" + Computation of the orthogonal matrix. Default: "true" + Matrix handle with the orthogonal part of the decomposed input matrix. + Matrix handle with the triangular part of the decomposed input matrix. + + + Decompose a matrix. + Matrix handle of the input matrix. + Type of the input matrix. Default: "general" + Matrix handle with the output matrix 1. + Matrix handle with the output matrix 2. + + + Compute the singular value decomposition of a matrix. + Matrix handle of the input matrix. + Type of computation. Default: "full" + Computation of singular values. Default: "both" + Matrix handle with the left singular vectors. + Matrix handle with singular values. + Matrix handle with the right singular vectors. + + + Compute the generalized eigenvalues and optionally the generalized eigenvectors of general matrices. + Matrix handle of the input matrix A. + Matrix handle of the input matrix B. + Computation of the eigenvectors. Default: "none" + Matrix handle with the real parts of the eigenvalues. + Matrix handle with the imaginary parts of the eigenvalues. + Matrix handle with the real parts of the eigenvectors. + Matrix handle with the imaginary parts of the eigenvectors. + + + Compute the generalized eigenvalues and optionally generalized eigenvectors of symmetric input matrices. + Matrix handle of the symmetric input matrix A. + Matrix handle of the symmetric positive definite input matrix B. + Computation of the eigenvectors. Default: "false" + Matrix handle with the eigenvalues. + Matrix handle with the eigenvectors. + + + Compute the eigenvalues and optionally the eigenvectors of a general matrix. + Matrix handle of the input matrix. + Computation of the eigenvectors. Default: "none" + Matrix handle with the real parts of the eigenvalues. + Matrix handle with the imaginary parts of the eigenvalues. + Matrix handle with the real parts of the eigenvectors. + Matrix handle with the imaginary parts of the eigenvectors. + + + Compute the eigenvalues and optionally eigenvectors of a symmetric matrix. + Matrix handle of the input matrix. + Computation of the eigenvectors. Default: "false" + Matrix handle with the eigenvalues. + Matrix handle with the eigenvectors. + + + Compute the solution of a system of equations. + Matrix handle of the input matrix of the left hand side. + The type of the input matrix of the left hand side. Default: "general" + Type of solving and limitation to set singular values to be 0. Default: 0.0 + Matrix handle of the input matrix of right hand side. + New matrix handle with the solution. + + + Compute the determinant of a matrix. + Matrix handle of the input matrix. + The type of the input matrix. Default: "general" + Determinant of the input matrix. + + + Invert a matrix. + Matrix handle of the input matrix. + The type of the input matrix. Default: "general" + Type of inversion. Default: 0.0 + + + Invert a matrix. + Matrix handle of the input matrix. + The type of the input matrix. Default: "general" + Type of inversion. Default: 0.0 + Matrix handle with the inverse matrix. + + + Transpose a matrix. + Matrix handle of the input matrix. + + + Transpose a matrix. + Matrix handle of the input matrix. + Matrix handle with the transpose of the input matrix. + + + Returns the elementwise maximum of a matrix. + Matrix handle of the input matrix. + Type of maximum determination. Default: "columns" + Matrix handle with the maximum values of the input matrix. + + + Returns the elementwise minimum of a matrix. + Matrix handle of the input matrix. + Type of minimum determination. Default: "columns" + Matrix handle with the minimum values of the input matrix. + + + Compute the power functions of a matrix. + Matrix handle of the input matrix. + The type of the input matrix. Default: "general" + The power. Default: 2.0 + + + Compute the power functions of a matrix. + Matrix handle of the input matrix. + The type of the input matrix. Default: "general" + The power. Default: 2.0 + Matrix handle with the raised powered matrix. + + + Compute the power functions of the elements of a matrix. + Matrix handle of the input matrix of the base. + Matrix handle of the input matrix with exponents. + + + Compute the power functions of the elements of a matrix. + Matrix handle of the input matrix of the base. + Matrix handle of the input matrix with exponents. + Matrix handle with the raised power of the input matrix. + + + Compute the power functions of the elements of a matrix. + Matrix handle of the input matrix. + The power. Default: 2.0 + + + Compute the power functions of the elements of a matrix. + Matrix handle of the input matrix. + The power. Default: 2.0 + Matrix handle with the raised power of the input matrix. + + + Compute the square root values of the elements of a matrix. + Matrix handle of the input matrix. + + + Compute the square root values of the elements of a matrix. + Matrix handle of the input matrix. + Matrix handle with the square root values of the input matrix. + + + Compute the absolute values of the elements of a matrix. + Matrix handle of the input matrix. + + + Compute the absolute values of the elements of a matrix. + Matrix handle of the input matrix. + Matrix handle with the absolute values of the input matrix. + + + Norm of a matrix. + Matrix handle of the input matrix. + Type of norm. Default: "2-norm" + Norm of the input matrix. + + + Returns the elementwise mean of a matrix. + Matrix handle of the input matrix. + Type of mean determination. Default: "columns" + Matrix handle with the mean values of the input matrix. + + + Returns the elementwise sum of a matrix. + Matrix handle of the input matrix. + Type of summation. Default: "columns" + Matrix handle with the sum of the input matrix. + + + Divide matrices element-by-element. + Matrix handle of the input matrix A. + Matrix handle of the input matrix B. + + + Divide matrices element-by-element. + Matrix handle of the input matrix A. + Matrix handle of the input matrix B. + Matrix handle with the divided values of input matrices. + + + Multiply matrices element-by-element. + Matrix handle of the input matrix A. + Matrix handle of the input matrix B. + + + Multiply matrices element-by-element. + Matrix handle of the input matrix A. + Matrix handle of the input matrix B. + Matrix handle with the multiplied values of the input matrices. + + + Scale a matrix. + Matrix handle of the input matrix. + Scale factor. Default: 2.0 + + + Scale a matrix. + Matrix handle of the input matrix. + Scale factor. Default: 2.0 + Matrix handle with the scaled elements. + + + Subtract two matrices. + Matrix handle of the input matrix A. + Matrix handle of the input matrix B. + + + Subtract two matrices. + Matrix handle of the input matrix A. + Matrix handle of the input matrix B. + Matrix handle with the difference of the input matrices. + + + Add two matrices. + Matrix handle of the input matrix A. + Matrix handle of the input matrix B. + + + Add two matrices. + Matrix handle of the input matrix A. + Matrix handle of the input matrix B. + Matrix handle with the sum of the input matrices. + + + Multiply two matrices. + Matrix handle of the input matrix A. + Matrix handle of the input matrix B. + Type of the input matrices. Default: "AB" + + + Multiply two matrices. + Matrix handle of the input matrix A. + Matrix handle of the input matrix B. + Type of the input matrices. Default: "AB" + Matrix handle of the multiplied matrices. + + + Get the size of a matrix. + Matrix handle of the input matrix. + Number of rows of the matrix. + Number of columns of the matrix. + + + Repeat a matrix. + Matrix handle of the input matrix. + Number of copies of input matrix in row direction. Default: 2 + Number of copies of input matrix in column direction. Default: 2 + Matrix handle of the repeated copied matrix. + + + Copy a matrix. + Matrix handle of the input matrix. + Matrix handle of the copied matrix. + + + Set the diagonal elements of a matrix. + Matrix handle of the input matrix. + Matrix handle containing the diagonal elements to be set. + Position of the diagonal. Default: 0 + + + Get the diagonal elements of a matrix. + Matrix handle of the input matrix. + Number of the desired diagonal. Default: 0 + Matrix handle containing the diagonal elements. + + + Set a sub-matrix of a matrix. + Matrix handle of the input matrix. + Matrix handle of the input sub-matrix. + Upper row position of the sub-matrix in the matrix. Default: 0 + Left column position of the sub-matrix in the matrix. Default: 0 + + + Get a sub-matrix of a matrix. + Matrix handle of the input matrix. + Upper row position of the sub-matrix in the input matrix. Default: 0 + Left column position of the sub-matrix in the input matrix. Default: 0 + Number of rows of the sub-matrix. Default: 1 + Number of columns of the sub-matrix. Default: 1 + Matrix handle of the sub-matrix. + + + Set all values of a matrix. + Matrix handle of the input matrix. + Values to be set. + + + Return all values of a matrix. + Matrix handle of the input matrix. + Values of the matrix elements. + + + Set one or more elements of a matrix. + Matrix handle of the input matrix. + Row numbers of the matrix elements to be modified. Default: 0 + Column numbers of the matrix elements to be modified. Default: 0 + Values to be set in the indicated matrix elements. Default: 0 + + + Return one ore more elements of a matrix. + Matrix handle of the input matrix. + Row numbers of matrix elements to be returned. Default: 0 + Column numbers of matrix elements to be returned. Default: 0 + Values of indicated matrix elements. + + + This operator is inoperable. It had the following function: Clear all matrices from memory. + + + Free the memory of a matrix. + Matrix handle. + + + Create a matrix. + Number of rows of the matrix. Default: 3 + Number of columns of the matrix. Default: 3 + Values for initializing the elements of the matrix. Default: 0 + Matrix handle. + + + This operator is inoperable. It had the following function: Free the memory of all sample identifiers. + + + Free the memory of a sample identifier. + Handle of the sample identifier. + + + Deserialize a serialized sample identifier. + Handle of the serialized item. + Handle of the sample identifier. + + + Read a sample identifier from a file. + File name. + Handle of the sample identifier. + + + Serialize a sample identifier. + Handle of the sample identifier. + Handle of the serialized item. + + + Write a sample identifier to a file. + Handle of the sample identifier. + File name. + + + Identify objects with a sample identifier. + Image showing the object to be identified. + Handle of the sample identifier. + Number of suggested object indices. Default: 1 + Rating threshold. Default: 0.0 + Generic parameter name. Default: [] + Generic parameter value. Default: [] + Index of the identified object. + Rating value of the identified object. + + + Get selected parameters of a sample identifier. + Handle of the sample identifier. + Parameter name. Default: "rating_method" + Parameter value. + + + Set selected parameters of a sample identifier. + Handle of the sample identifier. + Parameter name. Default: "rating_method" + Parameter value. Default: "score_single" + + + Retrieve information about an object of a sample identifier. + Handle of the sample identifier. + Index of the object for which information is retrieved. + Define, for which kind of object information is retrieved. Default: "num_training_objects" + Information about the object. + + + Define a name or a description for an object of a sample identifier. + Handle of the sample identifier. + Index of the object for which information is set. + Define, for which kind of object information is set. Default: "training_object_name" + Information about the object. + + + Remove training data from a sample identifier. + Handle of the sample identifier. + Index of the training object, from which samples should be removed. + Index of the training sample that should be removed. + + + Remove preparation data from a sample identifier. + Handle of the sample identifier. + Index of the preparation object, of which samples should be removed. + Index of the preparation sample that should be removed. + + + Train a sample identifier. + Handle of the sample identifier. + Parameter name. Default: [] + Parameter value. Default: [] + + + Add training data to an existing sample identifier. + Image that shows an object. + Handle of the sample identifier. + Index of the object visible in the SampleImage. + Generic parameter name. Default: [] + Generic parameter value. Default: [] + Index of the object sample. + + + Adapt the internal data structure of a sample identifier to the objects to be identified. + Handle of the sample identifier. + Indicates if the preparation data should be removed. Default: "true" + Generic parameter name. Default: [] + Generic parameter value. Default: [] + + + Add preparation data to an existing sample identifier. + Image that shows an object. + Handle of the sample identifier. + Index of the object visible in the SampleImage. Default: "unknown" + Generic parameter name. Default: [] + Generic parameter value. Default: [] + Index of the object sample. + + + Create a new sample identifier. + Parameter name. Default: [] + Parameter value. Default: [] + Handle of the sample identifier. + + + Deserialize a serialized shape model. + Handle of the serialized item. + Handle of the model. + + + Read a shape model from a file. + File name. + Handle of the model. + + + Serialize a shape model. + Handle of the model. + Handle of the serialized item. + + + Write a shape model to a file. + Handle of the model. + File name. + + + This operator is inoperable. It had the following function: Free the memory of all shape models. + + + Free the memory of a shape model. + Handle of the model. + + + Return the contour representation of a shape model. + Contour representation of the shape model. + Handle of the model. + Pyramid level for which the contour representation should be returned. Default: 1 + + + Determine the parameters of a shape model. + Input image whose domain will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the model. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Minimum scale of the model. Default: 0.9 + Maximum scale of the model. Default: 1.1 + Kind of optimization. Default: "auto" + Match metric. Default: "use_polarity" + Threshold or hysteresis thresholds for the contrast of the object in the template image and optionally minimum size of the object parts. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + Parameters to be determined automatically. Default: "all" + Name of the automatically determined parameter. + Value of the automatically determined parameter. + + + Return the parameters of a shape model. + Handle of the model. + Number of pyramid levels. + Smallest rotation of the pattern. + Extent of the rotation angles. + Step length of the angles (resolution). + Minimum scale of the pattern. + Maximum scale of the pattern. + Scale step length (resolution). + Match metric. + Minimum contrast of the objects in the search images. + + + Return the origin (reference point) of a shape model. + Handle of the model. + Row coordinate of the origin of the shape model. + Column coordinate of the origin of the shape model. + + + Set the origin (reference point) of a shape model. + Handle of the model. + Row coordinate of the origin of the shape model. + Column coordinate of the origin of the shape model. + + + Find the best matches of multiple anisotropically scaled shape models. + Input image in which the models should be found. + Handle of the models. + Smallest rotation of the models. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Minimum scale of the models in the row direction. Default: 0.9 + Maximum scale of the models in the row direction. Default: 1.1 + Minimum scale of the models in the column direction. Default: 0.9 + Maximum scale of the models in the column direction. Default: 1.1 + Minimum score of the instances of the models to be found. Default: 0.5 + Number of instances of the models to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the models to be found. Default: 0.5 + Subpixel accuracy if not equal to 'none'. Default: "least_squares" + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + Row coordinate of the found instances of the models. + Column coordinate of the found instances of the models. + Rotation angle of the found instances of the models. + Scale of the found instances of the models in the row direction. + Scale of the found instances of the models in the column direction. + Score of the found instances of the models. + Index of the found instances of the models. + + + Find the best matches of multiple isotropically scaled shape models. + Input image in which the models should be found. + Handle of the models. + Smallest rotation of the models. Default: -0.39 + Extent of the rotation angles. Default: 0.78 + Minimum scale of the models. Default: 0.9 + Maximum scale of the models. Default: 1.1 + Minimum score of the instances of the models to be found. Default: 0.5 + Number of instances of the models to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the models to be found. Default: 0.5 + Subpixel accuracy if not equal to 'none'. Default: "least_squares" + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + Row coordinate of the found instances of the models. + Column coordinate of the found instances of the models. + Rotation angle of the found instances of the models. + Scale of the found instances of the models. + Score of the found instances of the models. + Index of the found instances of the models. + + + Find the best matches of multiple shape models. + Input image in which the models should be found. + Handle of the models. + Smallest rotation of the models. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Minimum score of the instances of the models to be found. Default: 0.5 + Number of instances of the models to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the models to be found. Default: 0.5 + Subpixel accuracy if not equal to 'none'. Default: "least_squares" + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + Row coordinate of the found instances of the models. + Column coordinate of the found instances of the models. + Rotation angle of the found instances of the models. + Score of the found instances of the models. + Index of the found instances of the models. + + + Find the best matches of an anisotropically scaled shape model in an image. + Input image in which the model should be found. + Handle of the model. + Smallest rotation of the model. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Minimum scale of the model in the row direction. Default: 0.9 + Maximum scale of the model in the row direction. Default: 1.1 + Minimum scale of the model in the column direction. Default: 0.9 + Maximum scale of the model in the column direction. Default: 1.1 + Minimum score of the instances of the model to be found. Default: 0.5 + Number of instances of the model to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the model to be found. Default: 0.5 + Subpixel accuracy if not equal to 'none'. Default: "least_squares" + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + Row coordinate of the found instances of the model. + Column coordinate of the found instances of the model. + Rotation angle of the found instances of the model. + Scale of the found instances of the model in the row direction. + Scale of the found instances of the model in the column direction. + Score of the found instances of the model. + + + Find the best matches of an isotropically scaled shape model in an image. + Input image in which the model should be found. + Handle of the model. + Smallest rotation of the model. Default: -0.39 + Extent of the rotation angles. Default: 0.78 + Minimum scale of the model. Default: 0.9 + Maximum scale of the model. Default: 1.1 + Minimum score of the instances of the model to be found. Default: 0.5 + Number of instances of the model to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the model to be found. Default: 0.5 + Subpixel accuracy if not equal to 'none'. Default: "least_squares" + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + Row coordinate of the found instances of the model. + Column coordinate of the found instances of the model. + Rotation angle of the found instances of the model. + Scale of the found instances of the model. + Score of the found instances of the model. + + + Find the best matches of a shape model in an image. + Input image in which the model should be found. + Handle of the model. + Smallest rotation of the model. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Minimum score of the instances of the model to be found. Default: 0.5 + Number of instances of the model to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the model to be found. Default: 0.5 + Subpixel accuracy if not equal to 'none'. Default: "least_squares" + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + Row coordinate of the found instances of the model. + Column coordinate of the found instances of the model. + Rotation angle of the found instances of the model. + Score of the found instances of the model. + + + Set the metric of a shape model that was created from XLD contours. + Input image used for the determination of the polarity. + Handle of the model. + Transformation matrix. + Match metric. Default: "use_polarity" + + + Set selected parameters of the shape model. + Handle of the model. + Parameter names. + Parameter values. + + + Prepare an anisotropically scaled shape model for matching from XLD contours. + Input contours that will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in the row direction. Default: 0.9 + Maximum scale of the pattern in the row direction. Default: 1.1 + Scale step length (resolution) in the row direction. Default: "auto" + Minimum scale of the pattern in the column direction. Default: 0.9 + Maximum scale of the pattern in the column direction. Default: 1.1 + Scale step length (resolution) in the column direction. Default: "auto" + Kind of optimization and optionally method used for generating the model. Default: "auto" + Match metric. Default: "ignore_local_polarity" + Minimum contrast of the objects in the search images. Default: 5 + Handle of the model. + + + Prepare an isotropically scaled shape model for matching from XLD contours. + Input contours that will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern. Default: 0.9 + Maximum scale of the pattern. Default: 1.1 + Scale step length (resolution). Default: "auto" + Kind of optimization and optionally method used for generating the model. Default: "auto" + Match metric. Default: "ignore_local_polarity" + Minimum contrast of the objects in the search images. Default: 5 + Handle of the model. + + + Prepare a shape model for matching from XLD contours. + Input contours that will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Kind of optimization and optionally method used for generating the model. Default: "auto" + Match metric. Default: "ignore_local_polarity" + Minimum contrast of the objects in the search images. Default: 5 + Handle of the model. + + + Prepare an anisotropically scaled shape model for matching. + Input image whose domain will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in the row direction. Default: 0.9 + Maximum scale of the pattern in the row direction. Default: 1.1 + Scale step length (resolution) in the row direction. Default: "auto" + Minimum scale of the pattern in the column direction. Default: 0.9 + Maximum scale of the pattern in the column direction. Default: 1.1 + Scale step length (resolution) in the column direction. Default: "auto" + Kind of optimization and optionally method used for generating the model. Default: "auto" + Match metric. Default: "use_polarity" + Threshold or hysteresis thresholds for the contrast of the object in the template image and optionally minimum size of the object parts. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + Handle of the model. + + + Prepare an isotropically scaled shape model for matching. + Input image whose domain will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern. Default: 0.9 + Maximum scale of the pattern. Default: 1.1 + Scale step length (resolution). Default: "auto" + Kind of optimization and optionally method used for generating the model. Default: "auto" + Match metric. Default: "use_polarity" + Threshold or hysteresis thresholds for the contrast of the object in the template image and optionally minimum size of the object parts. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + Handle of the model. + + + Prepare a shape model for matching. + Input image whose domain will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Kind of optimization and optionally method used for generating the model. Default: "auto" + Match metric. Default: "use_polarity" + Threshold or hysteresis thresholds for the contrast of the object in the template image and optionally minimum size of the object parts. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + Handle of the model. + + + Create the representation of a shape model. + Input image. + Image pyramid of the input image + Model region pyramid + Number of pyramid levels. Default: 4 + Threshold or hysteresis thresholds for the contrast of the object in the image and optionally minimum size of the object parts. Default: 30 + + + This operator is inoperable. It had the following function: Free the memory of all descriptor models in RAM. + + + Free the memory of a descriptor model. + Handle of the descriptor model. + + + Deserialize a descriptor model. + Handle of the serialized item. + Handle of the model. + + + Serialize a descriptor model. + Handle of a model to be saved. + Handle of the serialized item. + + + Read a descriptor model from a file. + File name. + Handle of the model. + + + Write a descriptor model to a file. + Handle of a model to be saved. + The path and filename of the model to be saved. + + + Find the best matches of a calibrated descriptor model in an image and return their 3D pose. + Input image where the model should be found. + The handle to the descriptor model. + The detector's parameter names. Default: [] + Values of the detector's parameters. Default: [] + The descriptor's parameter names. Default: [] + Values of the descriptor's parameters. Default: [] + Minimum score of the instances of the models to be found. Default: 0.2 + Maximal number of found instances. Default: 1 + Camera parameter (inner orientation) obtained from camera calibration. + Score type to be evaluated in Score. Default: "num_points" + 3D pose of the object. + Score of the found instances according to the ScoreType input. + + + Find the best matches of a descriptor model in an image. + Input image where the model should be found. + The handle to the descriptor model. + The detector's parameter names. Default: [] + Values of the detector's parameters. Default: [] + The descriptor's parameter names. Default: [] + Values of the descriptor's parameters. Default: [] + Minimum score of the instances of the models to be found. Default: 0.2 + Maximal number of found instances. Default: 1 + Score type to be evaluated in Score. Default: "num_points" + Homography between model and found instance. + Score of the found instances according to the ScoreType input. + + + Query the interest points of the descriptor model or the last processed search image. + The handle to the descriptor model. + Set of interest points. Default: "model" + Subset of interest points. Default: "all" + Row coordinates of interest points. + Column coordinates of interest points. + + + Return the parameters of a descriptor model. + The object handle to the descriptor model. + The type of the detector. + The detectors parameter names. + Values of the detectors parameters. + The descriptors parameter names. + Values of the descriptors parameters. + + + Create a descriptor model for calibrated perspective matching. + Input image whose domain will be used to create the model. + The parameters of the internal orientation of the camera. + The reference pose of the object in the reference image. + The type of the detector. Default: "lepetit" + The detector's parameter names. Default: [] + Values of the detector's parameters. Default: [] + The descriptor's parameter names. Default: [] + Values of the descriptor's parameters. Default: [] + The seed for the random number generator. Default: 42 + The handle to the descriptor model. + + + Prepare a descriptor model for interest point matching. + Input image whose domain will be used to create the model. + The type of the detector. Default: "lepetit" + The detector's parameter names. Default: [] + Values of the detector's parameters. Default: [] + The descriptor's parameter names. Default: [] + Values of the descriptor's parameters. Default: [] + The seed for the random number generator. Default: 42 + The handle to the descriptor model. + + + Query alphanumerical results that were accumulated during descriptor-based matching. + Handle of a descriptor model. + Handle of the object for which the results are queried. Default: "all" + Name of the results to be queried. Default: "num_points" + Returned results. + + + Return the origin of a descriptor model. + Handle of a descriptor model. + Position of origin in row direction. + Position of origin in column direction. + + + Sets the origin of a descriptor model. + Handle of a descriptor model. + Translation of origin in row direction. Default: 0 + Translation of origin in column direction. Default: 0 + + + Return the origin (reference point) of a deformable model. + Handle of the model. + Row coordinate of the origin of the deformable model. + Column coordinate of the origin of the deformable model. + + + Set the origin (reference point) of a deformable model. + Handle of the model. + Row coordinate of the origin of the deformable model. + Column coordinate of the origin of the deformable model. + + + Set selected parameters of the deformable model. + Handle of the model. + Parameter names. + Parameter values. + + + Return the parameters of a deformable model. + Handle of the model. + Names of the generic parameters that are to be queried for the deformable model. Default: "angle_start" + Values of the generic parameters. + + + Return the contour representation of a deformable model. + Contour representation of the deformable model. + Handle of the model. + Pyramid level for which the contour representation should be returned. Default: 1 + + + Determine the parameters of a deformable model. + Input image whose domain will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the model. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Minimum scale of the model. Default: 0.9 + Maximum scale of the model. Default: 1.1 + Kind of optimization. Default: "auto" + Match metric. Default: "use_polarity" + Threshold or hysteresis thresholds for the contrast of the object in the template image and optionally minimum size of the object parts. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + The general parameter names. Default: [] + Values of the general parameter. Default: [] + Parameters to be determined automatically. Default: "all" + Name of the automatically determined parameter. + Value of the automatically determined parameter. + + + Deserialize a deformable model. + Handle of the serialized item. + Handle of the model. + + + Serialize a deformable model. + Handle of a model to be saved. + Handle of the serialized item. + + + Read a deformable model from a file. + File name. + Handle of the model. + + + Write a deformable model to a file. + Handle of a model to be saved. + The path and filename of the model to be saved. + + + This operator is inoperable. It had the following function: Free the memory of all deformable models. + + + Free the memory of a deformable model. + Handle of the model. + + + Find the best matches of a local deformable model in an image. + Input image in which the model should be found. + Rectified image of the found model. + Vector field of the rectification transformation. + Contours of the found instances of the model. + Handle of the model. + Smallest rotation of the model. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Minimum scale of the model in row direction. Default: 1.0 + Maximum scale of the model in row direction. Default: 1.0 + Minimum scale of the model in column direction. Default: 1.0 + Maximum scale of the model in column direction. Default: 1.0 + Minumum score of the instances of the model to be found. Default: 0.5 + Number of instances of the model to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the model to be found. Default: 1.0 + Number of pyramid levels used in the matching. Default: 0 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + Switch for requested iconic result. Default: [] + The general parameter names. Default: [] + Values of the general parameters. Default: [] + Scores of the found instances of the model. + Row coordinates of the found instances of the model. + Column coordinates of the found instances of the model. + + + Find the best matches of a calibrated deformable model in an image and return their 3D pose. + Input image in which the model should be found. + Handle of the model. + Smallest rotation of the model. Default: -0.39 + Extent of the rotation angles. Default: 0.78 + Minimum scale of the model in row direction. Default: 1.0 + Maximum scale of the model in row direction. Default: 1.0 + Minimum scale of the model in column direction. Default: 1.0 + Maximum scale of the model in column direction. Default: 1.0 + Minimum score of the instances of the model to be found. Default: 0.5 + Number of instances of the model to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the model to be found. Default: 1.0 + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + The general parameter names. Default: [] + Values of the general parameters. Default: [] + Pose of the object. + 6 standard deviations or 36 covariances of the pose parameters. + Score of the found instances of the model. + + + Find the best matches of a planar projective invariant deformable model in an image. + Input image in which the model should be found. + Handle of the model. + Smallest rotation of the model. Default: -0.39 + Extent of the rotation angles. Default: 0.78 + Minimum scale of the model in row direction. Default: 1.0 + Maximum scale of the model in row direction. Default: 1.0 + Minimum scale of the model in column direction. Default: 1.0 + Maximum scale of the model in column direction. Default: 1.0 + Minimum score of the instances of the model to be found. Default: 0.5 + Number of instances of the model to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the model to be found. Default: 1.0 + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + The general parameter names. Default: [] + Values of the general parameters. Default: [] + Homographies between model and found instances. + Score of the found instances of the model. + + + Set the metric of a local deformable model that was created from XLD contours. + Input image used for the determination of the polarity. + Vector field of the local deformation. + Handle of the model. + Match metric. Default: "use_polarity" + + + Set the metric of a planar calibrated deformable model that was created from XLD contours. + Input image used for the determination of the polarity. + Handle of the model. + Pose of the model in the image. + Match metric. Default: "use_polarity" + + + Set the metric of a planar uncalibrated deformable model that was created from XLD contours. + Input image used for the determination of the polarity. + Handle of the model. + Transformation matrix. + Match metric. Default: "use_polarity" + + + Prepare a deformable model for local deformable matching from XLD contours. + Input contours that will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "auto" + Match metric. Default: "ignore_local_polarity" + Minimum contrast of the objects in the search images. Default: 5 + The generic parameter names. Default: [] + Values of the generic parameters. Default: [] + Handle of the model. + + + Prepare a deformable model for planar calibrated matching from XLD contours. + Input contours that will be used to create the model. + The parameters of the internal orientation of the camera. + The reference pose of the object. + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in the column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "auto" + Match metric. Default: "ignore_local_polarity" + Minimum contrast of the objects in the search images. Default: 5 + The generic parameter names. Default: [] + Values of the generic parameter. Default: [] + Handle of the model. + + + Prepare a deformable model for planar uncalibrated matching from XLD contours. + Input contours that will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in the column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "auto" + Match metric. Default: "ignore_local_polarity" + Minimum contrast of the objects in the search images. Default: 5 + The generic parameter names. Default: [] + Values of the generic parameters. Default: [] + Handle of the model. + + + Creates a deformable model for local, deformable matching. + Input image whose domain will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "none" + Match metric. Default: "use_polarity" + Thresholds or hysteresis thresholds for the contrast of the object in the template image. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + The generic parameter names. Default: [] + Values of the generic parameters. Default: [] + Handle of the model. + + + Create a deformable model for calibrated perspective matching. + Input image whose domain will be used to create the model. + The parameters of the internal orientation of the camera. + The reference pose of the object in the reference image. + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in the column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "none" + Match metric. Default: "use_polarity" + Thresholds or hysteresis thresholds for the contrast of the object in the template image. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + The parameter names. Default: [] + Values of the parameters. Default: [] + Handle of the model. + + + Creates a deformable model for uncalibrated, perspective matching. + Input image whose domain will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "none" + Match metric. Default: "use_polarity" + Thresholds or hysteresis thresholds for the contrast of the object in the template image. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + The generic parameter names. Default: [] + Values of the generic parameter. Default: [] + Handle of the model. + + + This operator is inoperable. It had the following function: Free the memory of all NCC models. + + + Free the memory of an NCC model. + Handle of the model. + + + Deserialize an NCC model. + Handle of the serialized item. + Handle of the model. + + + Serialize an NCC model. + Handle of the model. + Handle of the serialized item. + + + Read an NCC model from a file. + File name. + Handle of the model. + + + Write an NCC model to a file. + Handle of the model. + File name. + + + Determine the parameters of an NCC model. + Input image whose domain will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the model. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Match metric. Default: "use_polarity" + Parameters to be determined automatically. Default: "all" + Name of the automatically determined parameter. + Value of the automatically determined parameter. + + + Return the parameters of an NCC model. + Handle of the model. + Number of pyramid levels. + Smallest rotation of the pattern. + Extent of the rotation angles. + Step length of the angles (resolution). + Match metric. + + + Return the origin (reference point) of an NCC model. + Handle of the model. + Row coordinate of the origin of the NCC model. + Column coordinate of the origin of the NCC model. + + + Set the origin (reference point) of an NCC model. + Handle of the model. + Row coordinate of the origin of the NCC model. + Column coordinate of the origin of the NCC model. + + + Find the best matches of an NCC model in an image. + Input image in which the model should be found. + Handle of the model. + Smallest rotation of the model. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Minimum score of the instances of the model to be found. Default: 0.8 + Number of instances of the model to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the model to be found. Default: 0.5 + Subpixel accuracy. Default: "true" + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + Row coordinate of the found instances of the model. + Column coordinate of the found instances of the model. + Rotation angle of the found instances of the model. + Score of the found instances of the model. + + + Set selected parameters of the NCC model. + Handle of the model. + Parameter names. + Parameter values. + + + Prepare an NCC model for matching. + Input image whose domain will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Match metric. Default: "use_polarity" + Handle of the model. + + + Return the components of a found instance of a component model. + Found components of the selected component model instance. + Handle of the component model. + Start index of each found instance of the component model in the tuples describing the component matches. + End index of each found instance of the component model to the tuples describing the component matches. + Row coordinate of the found component matches. + Column coordinate of the found component matches. + Rotation angle of the found component matches. + Score of the found component matches. + Index of the found components. + Index of the found instance of the component model to be returned. + Mark the orientation of the components. Default: "false" + Row coordinate of all components of the selected model instance. + Column coordinate of all components of the selected model instance. + Rotation angle of all components of the selected model instance. + Score of all components of the selected model instance. + + + Find the best matches of a component model in an image. + Input image in which the component model should be found. + Handle of the component model. + Index of the root component. + Smallest rotation of the root component Default: -0.39 + Extent of the rotation of the root component. Default: 0.79 + Minimum score of the instances of the component model to be found. Default: 0.5 + Number of instances of the component model to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the component models to be found. Default: 0.5 + Behavior if the root component is missing. Default: "stop_search" + Behavior if a component is missing. Default: "prune_branch" + Pose prediction of components that are not found. Default: "none" + Minimum score of the instances of the components to be found. Default: 0.5 + Subpixel accuracy of the component poses if not equal to 'none'. Default: "least_squares" + Number of pyramid levels for the components used in the matching (and lowest pyramid level to use if $|NumLevelsComp| = 2n$). Default: 0 + "Greediness" of the search heuristic for the components (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + Start index of each found instance of the component model in the tuples describing the component matches. + End index of each found instance of the component model in the tuples describing the component matches. + Score of the found instances of the component model. + Row coordinate of the found component matches. + Column coordinate of the found component matches. + Rotation angle of the found component matches. + Score of the found component matches. + Index of the found components. + + + This operator is inoperable. It had the following function: Free the memory of all component models. + + + Free the memory of a component model. + Handle of the component model. + + + Return the search tree of a component model. + Search tree. + Relations of components that are connected in the search tree. + Handle of the component model. + Index of the root component. + Image for which the tree is to be returned. Default: "model_image" + Component index of the start node of an arc in the search tree. + Component index of the end node of an arc in the search tree. + Row coordinate of the center of the rectangle representing the relation. + Column index of the center of the rectangle representing the relation. + Orientation of the rectangle representing the relation (radians). + First radius (half length) of the rectangle representing the relation. + Second radius (half width) of the rectangle representing the relation. + Smallest relative orientation angle. + Extent of the relative orientation angle. + + + Return the parameters of a component model. + Handle of the component model. + Minimum score of the instances of the components to be found. + Ranking of the model components expressing their suitability to act as root component. + Handles of the shape models of the individual model components. + + + Deserialize a serialized component model. + Handle of the serialized item. + Handle of the component model. + + + Serialize a component model. + Handle of the component model. + Handle of the serialized item. + + + Read a component model from a file. + File name. + Handle of the component model. + + + Write a component model to a file. + Handle of the component model. + File name. + + + Prepare a component model for matching based on explicitly specified components and relations. + Input image from which the shape models of the model components should be created. + Input regions from which the shape models of the model components should be created. + Variation of the model components in row direction. + Variation of the model components in column direction. + Angle variation of the model components. + Smallest rotation of the component model. Default: -0.39 + Extent of the rotation of the component model. Default: 0.79 + Lower hysteresis threshold for the contrast of the components in the model image. Default: "auto" + Upper hysteresis threshold for the contrast of the components in the model image. Default: "auto" + Minimum size of the contour regions in the model. Default: "auto" + Minimum contrast of the components in the search images. Default: "auto" + Minimum score of the instances of the components to be found. Default: 0.5 + Maximum number of pyramid levels for the components. Default: "auto" + Step length of the angles (resolution) for the components. Default: "auto" + Kind of optimization for the components. Default: "auto" + Match metric used for the components. Default: "use_polarity" + Complete pregeneration of the shape models for the components if equal to 'true'. Default: "false" + Handle of the component model. + Ranking of the model components expressing the suitability to act as the root component. + + + Prepare a component model for matching based on trained components. + Handle of the training result. + Smallest rotation of the component model. Default: -0.39 + Extent of the rotation of the component model. Default: 0.79 + Minimum contrast of the components in the search images. Default: "auto" + Minimum score of the instances of the components to be found. Default: 0.5 + Maximum number of pyramid levels for the components. Default: "auto" + Step length of the angles (resolution) for the components. Default: "auto" + Kind of optimization for the components. Default: "auto" + Match metric used for the components. Default: "use_polarity" + Complete pregeneration of the shape models for the components if equal to 'true'. Default: "false" + Handle of the component model. + Ranking of the model components expressing the suitability to act as the root component. + + + This operator is inoperable. It had the following function: Free the memory of all component training results. + + + Free the memory of a component training result. + Handle of the training result. + + + Return the relations between the model components that are contained in a training result. + Region representation of the relations. + Handle of the training result. + Index of reference component. + Image for which the component relations are to be returned. Default: "model_image" + Row coordinate of the center of the rectangle representing the relation. + Column index of the center of the rectangle representing the relation. + Orientation of the rectangle representing the relation (radians). + First radius (half length) of the rectangle representing the relation. + Second radius (half width) of the rectangle representing the relation. + Smallest relative orientation angle. + Extent of the relative orientation angles. + + + Return the initial or model components in a certain image. + Contour regions of the initial components or of the model components. + Handle of the training result. + Type of returned components or index of an initial component. Default: "model_components" + Image for which the components are to be returned. Default: "model_image" + Mark the orientation of the components. Default: "false" + Row coordinate of the found instances of all initial components or model components. + Column coordinate of the found instances of all initial components or model components. + Rotation angle of the found instances of all components. + Score of the found instances of all components. + + + Modify the relations within a training result. + Handle of the training result. + Model component(s) relative to which the movement(s) should be modified. Default: "all" + Model component(s) of which the relative movement(s) should be modified. Default: "all" + Change of the position relation in pixels. + Change of the orientation relation in radians. + + + Deserialize a component training result. + Handle of the serialized item. + Handle of the training result. + + + Serialize a component training result. + Handle of the training result. + Handle of the serialized item. + + + Read a component training result from a file. + File name. + Handle of the training result. + + + Write a component training result to a file. + Handle of the training result. + File name. + + + Adopt new parameters that are used to create the model components into the training result. + Training images that were used for training the model components. + Contour regions of rigid model components. + Handle of the training result. + Criterion for solving the ambiguities. Default: "rigidity" + Maximum contour overlap of the found initial components. Default: 0.2 + Threshold for clustering the initial components. Default: 0.5 + + + Inspect the rigid model components obtained from the training. + Contour regions of rigid model components. + Handle of the training result. + Criterion for solving the ambiguities. Default: "rigidity" + Maximum contour overlap of the found initial components. Default: 0.2 + Threshold for clustering the initial components. Default: 0.5 + + + Train components and relations for the component-based matching. + Input image from which the shape models of the initial components should be created. + Contour regions or enclosing regions of the initial components. + Training images that are used for training the model components. + Contour regions of rigid model components. + Lower hysteresis threshold for the contrast of the initial components in the image. Default: "auto" + Upper hysteresis threshold for the contrast of the initial components in the image. Default: "auto" + Minimum size of connected contour regions. Default: "auto" + Minimum score of the instances of the initial components to be found. Default: 0.5 + Search tolerance in row direction. Default: -1 + Search tolerance in column direction. Default: -1 + Angle search tolerance. Default: -1 + Decision whether the training emphasis should lie on a fast computation or on a high robustness. Default: "speed" + Criterion for solving ambiguous matches of the initial components in the training images. Default: "rigidity" + Maximum contour overlap of the found initial components in a training image. Default: 0.2 + Threshold for clustering the initial components. Default: 0.5 + Handle of the training result. + + + Extract the initial components of a component model. + Input image from which the initial components should be extracted. + Contour regions of initial components. + Lower hysteresis threshold for the contrast of the initial components in the image. Default: "auto" + Upper hysteresis threshold for the contrast of the initial components in the image. Default: "auto" + Minimum size of the initial components. Default: "auto" + Type of automatic segmentation. Default: "connection" + Names of optional control parameters. Default: [] + Values of optional control parameters. Default: [] + + + Get details of a result from deformable surface based matching. + Handle of the deformable surface matching result. + Name of the result property. Default: "sampled_scene" + Index of the result property. Default: 0 + Value of the result property. + + + Free the memory of a deformable surface matching result. + Handle of the deformable surface matching result. + + + Free the memory of a deformable surface model. + Handle of the deformable surface model. + + + Deserialize a deformable surface model. + Handle of the serialized item. + Handle of the deformable surface model. + + + Serialize a deformable surface_model. + Handle of the deformable surface model. + Handle of the serialized item. + + + Read a deformable surface model from a file. + Name of the file to read. + Handle of the read deformable surface model. + + + Write a deformable surface model to a file. + Handle of the deformable surface model to write. + File name to write to. + + + Refine the position and deformation of a deformable surface model in a 3D scene. + Handle of the deformable surface model. + Handle of the 3D object model containing the scene. + Relative sampling distance of the scene. Default: 0.05 + Initial deformation of the 3D object model + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Score of the refined model. + Handle of the matching result. + + + Find the best match of a deformable surface model in a 3D scene. + Handle of the deformable surface model. + Handle of the 3D object model containing the scene. + Scene sampling distance relative to the diameter of the surface model. Default: 0.05 + Minimum score of the returned match. Default: 0 + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Score of the found instances of the surface model. + Handle of the matching result. + + + Return the parameters and properties of a deformable surface model. + Handle of the deformable surface model. + Name of the parameter. Default: "sampled_model" + Value of the parameter. + + + Add a reference point to a deformable surface model. + Handle of the deformable surface model. + x-coordinates of a reference point. + x-coordinates of a reference point. + x-coordinates of a reference point. + Index of the new reference point. + + + Add a sample deformation to a deformable surface model + Handle of the deformable surface model. + Handle of the deformed 3D object model. + + + Create the data structure needed to perform deformable surface-based matching. + Handle of the 3D object model. + Sampling distance relative to the object's diameter Default: 0.05 + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Handle of the deformable surface model. + + + Get details of a result from surface based matching. + Handle of the surface matching result. + Name of the result property. Default: "pose" + Index of the matching result, starting with 0. Default: 0 + Value of the result property. + + + This operator is inoperable. It had the following function: Free the memory of all surface matching results. + + + Free the memory of a surface matching result. + Handle of the surface matching result. + + + This operator is inoperable. It had the following function: Free the memory of all surface models. + + + Free the memory of a surface model. + Handle of the surface model. + + + Deserialize a surface model. + Handle of the serialized item. + Handle of the surface model. + + + Serialize a surface_model. + Handle of the surface model. + Handle of the serialized item. + + + Read a surface model from a file. + Name of the SFM file. + Handle of the read surface model. + + + Write a surface model to a file. + Handle of the surface model. + File name. + + + Refine the pose of a surface model in a 3D scene. + Handle of the surface model. + Handle of the 3D object model containing the scene. + Initial pose of the surface model in the scene. + Minimum score of the returned poses. Default: 0 + Enable returning a result handle in SurfaceMatchingResultID. Default: "false" + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + 3D pose of the surface model in the scene. + Score of the found instances of the model. + Handle of the matching result, if enabled in ReturnResultHandle. + + + Find the best matches of a surface model in a 3D scene. + Handle of the surface model. + Handle of the 3D object model containing the scene. + Scene sampling distance relative to the diameter of the surface model. Default: 0.05 + Fraction of sampled scene points used as key points. Default: 0.2 + Minimum score of the returned poses. Default: 0 + Enable returning a result handle in SurfaceMatchingResultID. Default: "false" + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + 3D pose of the surface model in the scene. + Score of the found instances of the surface model. + Handle of the matching result, if enabled in ReturnResultHandle. + + + Return the parameters and properties of a surface model. + Handle of the surface model. + Name of the parameter. Default: "diameter" + Value of the parameter. + + + Create the data structure needed to perform surface-based matching. + Handle of the 3D object model. + Sampling distance relative to the object's diameter Default: 0.03 + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Handle of the surface model. + + + Create a 3D camera pose from camera center and viewing direction. + X coordinate of the optical center of the camera. + Y coordinate of the optical center of the camera. + Z coordinate of the optical center of the camera. + X coordinate of the 3D point to which the camera is directed. + Y coordinate of the 3D point to which the camera is directed. + Z coordinate of the 3D point to which the camera is directed. + Normal vector of the reference plane (points up). Default: "-y" + Camera roll angle. Default: 0 + 3D camera pose. + + + Convert spherical coordinates of a 3D point to Cartesian coordinates. + Longitude of the 3D point. + Latitude of the 3D point. + Radius of the 3D point. + Normal vector of the equatorial plane (points to the north pole). Default: "-y" + Coordinate axis in the equatorial plane that points to the zero meridian. Default: "-z" + X coordinate of the 3D point. + Y coordinate of the 3D point. + Z coordinate of the 3D point. + + + Convert Cartesian coordinates of a 3D point to spherical coordinates. + X coordinate of the 3D point. + Y coordinate of the 3D point. + Z coordinate of the 3D point. + Normal vector of the equatorial plane (points to the north pole). Default: "-y" + Coordinate axis in the equatorial plane that points to the zero meridian. Default: "-z" + Longitude of the 3D point. + Latitude of the 3D point. + Radius of the 3D point. + + + This operator is inoperable. It had the following function: Free the memory of all 3D shape models. + + + Free the memory of a 3D shape model. + Handle of the 3D shape model. + + + Deserialize a serialized 3D shape model. + Handle of the serialized item. + Handle of the 3D shape model. + + + Serialize a 3D shape model. + Handle of the 3D shape model. + Handle of the serialized item. + + + Read a 3D shape model from a file. + File name. + Handle of the 3D shape model. + + + Write a 3D shape model to a file. + Handle of the 3D shape model. + File name. + + + Transform a pose that refers to the coordinate system of a 3D object model to a pose that refers to the reference coordinate system of a 3D shape model and vice versa. + Handle of the 3D shape model. + Pose to be transformed in the source system. + Direction of the transformation. Default: "ref_to_model" + Transformed 3D pose in the target system. + + + Project the edges of a 3D shape model into image coordinates. + Contour representation of the model view. + Handle of the 3D shape model. + Internal camera parameters. + 3D pose of the 3D shape model in the world coordinate system. + Remove hidden surfaces? Default: "true" + Smallest face angle for which the edge is displayed Default: 0.523599 + + + Return the contour representation of a 3D shape model view. + Contour representation of the model view. + Handle of the 3D shape model. + Pyramid level for which the contour representation should be returned. Default: 1 + View for which the contour representation should be returned. Default: 1 + 3D pose of the 3D shape model at the current view. + + + Return the parameters of a 3D shape model. + Handle of the 3D shape model. + Names of the generic parameters that are to be queried for the 3D shape model. Default: "num_levels_max" + Values of the generic parameters. + + + Find the best matches of a 3D shape model in an image. + Input image in which the model should be found. + Handle of the 3D shape model. + Minimum score of the instances of the model to be found. Default: 0.7 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + Names of (optional) parameters for controlling the behavior of the operator. Default: [] + Values of the optional generic parameters. Default: [] + 3D pose of the 3D shape model. + 6 standard deviations or 36 covariances of the pose parameters. + Score of the found instances of the 3D shape model. + + + Prepare a 3D object model for matching. + Handle of the 3D object model. + Internal camera parameters. + Reference orientation: Rotation around x-axis or x component of the Rodriguez vector (in radians or without unit). Default: 0 + Reference orientation: Rotation around y-axis or y component of the Rodriguez vector (in radians or without unit). Default: 0 + Reference orientation: Rotation around z-axis or z component of the Rodriguez vector (in radians or without unit). Default: 0 + Meaning of the rotation values of the reference orientation. Default: "gba" + Minimum longitude of the model views. Default: -0.35 + Maximum longitude of the model views. Default: 0.35 + Minimum latitude of the model views. Default: -0.35 + Maximum latitude of the model views. Default: 0.35 + Minimum camera roll angle of the model views. Default: -3.1416 + Maximum camera roll angle of the model views. Default: 3.1416 + Minimum camera-object-distance of the model views. Default: 0.3 + Maximum camera-object-distance of the model views. Default: 0.4 + Minimum contrast of the objects in the search images. Default: 10 + Names of (optional) parameters for controlling the behavior of the operator. Default: [] + Values of the optional generic parameters. Default: [] + Handle of the 3D shape model. + + + Simplify a triangulated 3D object model. + Handle of the 3D object model that should be simplified. + Method that should be used for simplification. Default: "preserve_point_coordinates" + Degree of simplification (default: percentage of remaining model points). + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Handle of the simplified 3D object model. + + + Compute the distances of the points of one 3D object model to another 3D object model. + Handle of the source 3D object model. + Handle of the target 3D object model. + Pose of the source 3D object model in the target 3D object model. Default: [] + Maximum distance of interest. Default: 0 + Names of the generic input parameters. Default: [] + Values of the generic input parameters. Default: [] + + + Combine several 3D object models to a new 3D object model. + Handle of input 3D object models. + Method used for the union. Default: "points_surface" + Handle of the resulting 3D object model. + + + Set attributes of a 3D object model. + Handle of the 3D object model. + Name of the attributes. + Defines where extended attributes are attached to. Default: [] + Attribute values. + + + Set attributes of a 3D object model. + Handle of the input 3D object model. + Name of the attributes. + Defines where extended attributes are attached to. Default: [] + Attribute values. + Handle of the resulting 3D object model. + + + Create an empty 3D object model. + Handle of the new 3D object model. + + + Sample a 3D object model. + Handle of the 3D object model to be sampled. + Selects between the different subsampling methods. Default: "fast" + Sampling distance. Default: 0.05 + Names of the generic parameters that can be adjusted. Default: [] + Values of the generic parameters that can be adjusted. Default: [] + Handle of the 3D object model that contains the sampled points. + + + Improve the relative transformations between 3D object models based on their overlaps. + Handles of several 3D object models. + Approximate relative transformations between the 3D object models. + Type of interpretation for the transformations. Default: "global" + Target indices of the transformations if From specifies the source indices, otherwise the parameter must be empty. Default: [] + Names of the generic parameters that can be adjusted for the global 3D object model registration. Default: [] + Values of the generic parameters that can be adjusted for the global 3D object model registration. Default: [] + Resulting Transformations. + Number of overlapping neighbors for each 3D object model. + + + Search for a transformation between two 3D object models. + Handle of the first 3D object model. + Handle of the second 3D object model. + Method for the registration. Default: "matching" + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Pose to transform ObjectModel3D1 in the reference frame of ObjectModel3D2. + Overlapping of the two 3D object models. + + + Create a 3D object model that represents a point cloud from a set of 3D points. + The x-coordinates of the points in the 3D point cloud. + The y-coordinates of the points in the 3D point cloud. + The z-coordinates of the points in the 3D point cloud. + Handle of the resulting 3D object model. + + + Create a 3D object model that represents a box. + The pose that describes the position and orientation of the box. The pose has its origin in the center of the box. + The length of the box along the x-axis. + The length of the box along the y-axis. + The length of the box along the z-axis. + Handle of the resulting 3D object model. + + + Create a 3D object model that represents a plane. + The center and the rotation of the plane. + x coordinates specifying the extent of the plane. + y coordinates specifying the extent of the plane. + Handle of the resulting 3D object model. + + + Create a 3D object model that represents a sphere from x,y,z coordinates. + The x-coordinate of the center point of the sphere. + The y-coordinate of the center point of the sphere. + The z-coordinate of the center point of the sphere. + The radius of the sphere. + Handle of the resulting 3D object model. + + + Create a 3D object model that represents a sphere. + The pose that describes the position of the sphere. + The radius of the sphere. + Handle of the resulting 3D object model. + + + Create a 3D object model that represents a cylinder. + The pose that describes the position and orientation of the cylinder. + The radius of the cylinder. + Lowest z-coordinate of the cylinder in the direction of the rotation axis. + Highest z-coordinate of the cylinder in the direction of the rotation axis. + Handle of the resulting 3D object model. + + + Calculate the smallest bounding box around the points of a 3D object model. + Handle of the 3D object model. + The method that is used to estimate the smallest box. Default: "oriented" + The pose that describes the position and orientation of the box that is generated. The pose has its origin in the center of the box and is oriented such that the x-axis is aligned with the longest side of the box. + The length of the longest side of the box. + The length of the second longest side of the box. + The length of the third longest side of the box. + + + Calculate the smallest sphere around the points of a 3D object model. + Handle of the 3D object model. + x-, y-, and z-coordinates describing the center point of the sphere. + The estimated radius of the sphere. + + + Intersect a 3D object model with a plane. + Handle of the 3D object model. + Pose of the plane. Default: [0,0,0,0,0,0,0] + Handle of the 3D object model that describes the intersection as a set of lines. + + + Calculate the convex hull of a 3D object model. + Handle of the 3D object model. + Handle of the 3D object model that describes the convex hull. + + + Select 3D object models from an array of 3D object models according to global features. + Handles of the available 3D object models to select. + List of features a test is performed on. Default: "has_triangles" + Logical operation to combine the features given in Feature. Default: "and" + Minimum value for the given feature. Default: 1 + Maximum value for the given feature. Default: 1 + A subset of ObjectModel3D fulfilling the given conditions. + + + Calculate the area of all faces of a 3D object model. + Handle of the 3D object model. + Calculated area. + + + Calculate the maximal diameter of a 3D object model. + Handle of the 3D object model. + Calculated diameter. + + + Calculates the mean or the central moment of second order for a 3D object model. + Handle of the 3D object model. + Moment to calculate. Default: "mean_points" + Calculated moment. + + + Calculate the volume of a 3D object model. + Handle of the 3D object model. + Pose of the plane. Default: [0,0,0,0,0,0,0] + Method to combine volumes laying above and below the reference plane. Default: "signed" + Decides whether the orientation of a face should affect the resulting sign of the underlying volume. Default: "true" + Absolute value of the calculated volume. + + + Remove points from a 3D object model by projecting it to a virtual view and removing all points outside of a given region. + Region in the image plane. + Handle of the 3D object model. + Internal camera parameters. + 3D pose of the world coordinate system in camera coordinates. + Handle of the reduced 3D object model. + + + Determine the connected components of the 3D object model. + Handle of the 3D object model. + Attribute used to calculate the connected components. Default: "distance_3d" + Maximum value for the distance between two connected components. Default: 1.0 + Handle of the 3D object models that represent the connected components. + + + Apply a threshold to an attribute of 3D object models. + Handle of the 3D object models. + Attributes the threshold is applied to. Default: "point_coord_z" + Minimum value for the attributes specified by Attrib. Default: 0.5 + Maximum value for the attributes specified by Attrib. Default: 1.0 + Handle of the reduced 3D object models. + + + Get the depth or the index of a displayed 3D object model. + Window handle. + Row coordinates. + Column coordinates. + Information. Default: "depth" + Indices or the depth of the objects at (Row,Column). + + + Render 3D object models to get an image. + Rendered scene. + Handles of the 3D object models. + Camera parameters of the scene. + 3D poses of the objects. + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + + + Display 3D object models. + Window handle. + Handles of the 3D object models. + Camera parameters of the scene. Default: [] + 3D poses of the objects. Default: [] + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + + + Copy a 3D object model. + Handle of the input 3D object model. + Attributes to be copied. Default: "all" + Handle of the copied 3D object model. + + + Prepare a 3D object model for a certain operation. + Handle of the 3D object model. + Purpose of the 3D object model. Default: "shape_based_matching_3d" + Specify if already existing data should be overwritten. Default: "true" + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + + + Transform 3D points from a 3D object model to images. + Image with the X-Coordinates of the 3D points. + Image with the Y-Coordinates of the 3D points. + Image with the Z-Coordinates of the 3D points. + Handle of the 3D object model. + Type of the conversion. Default: "cartesian" + Camera parameters. + Pose of the 3D object model. + + + Transform 3D points from images to a 3D object model. + Image with the X-Coordinates and the ROI of the 3D points. + Image with the Y-Coordinates of the 3D points. + Image with the Z-Coordinates of the 3D points. + Handle of the 3D object model. + + + Return attributes of 3D object models. + Handle of the 3D object model. + Names of the generic attributes that are queried for the 3D object model. Default: "num_points" + Values of the generic parameters. + + + Project a 3D object model into image coordinates. + Projected model contours. + Handle of the 3D object model. + Internal camera parameters. + 3D pose of the world coordinate system in camera coordinates. + Name of the generic parameter. Default: [] + Value of the generic parameter. Default: [] + + + Apply a rigid 3D transformation to 3D object models. + Handles of the 3D object models. + Poses. + Handles of the transformed 3D object models. + + + Apply an arbitrary projective 3D transformation to 3D object models. + Handles of the 3D object models. + Homogeneous projective transformation matrix. + Handles of the transformed 3D object models. + + + Apply an arbitrary affine 3D transformation to 3D object models. + Handles of the 3D object models. + Transformation matrices. + Handles of the transformed 3D object models. + + + This operator is inoperable. It had the following function: Free the memory of all 3D object models. + + + Free the memory of a 3D object model. + Handle of the 3D object model. + + + Serialize a 3D object model. + Handle of the 3D object model. + Handle of the serialized item. + + + Deserialize a serialized 3D object model. + Handle of the serialized item. + Handle of the 3D object model. + + + Writes a 3D object model to a file. + Handle of the 3D object model. + Type of the file that is written. Default: "om3" + Name of the file that is written. + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + + + Read a 3D object model from a file. + Filename of the file to be read. Default: "mvtec_bunny_normals" + Scale of the data in the file. Default: "m" + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Handle of the 3D object model. + Status information. + + + Read the description file of a Kalman filter. + Description file for a Kalman filter. Default: "kalman.init" + The dimensions of the state vector, the measurement vector and the controller vector. + The lined up matrices A, C, Q, possibly G and u, and if necessary L stored in row-major order. + The matrix R stored in row-major order. + The matrix P0@f$P_{0}$ (error covariance matrix of the initial state estimate) stored in row-major order and the initial state estimate x0@f$x_{0}$ lined up. + + + Read an update file of a Kalman filter. + Update file for a Kalman filter. Default: "kalman.updt" + The dimensions of the state vector, measurement vector and controller vector. Default: [3,1,0] + The lined up matrices A,C,Q, possibly G and u, and if necessary L which all have been stored in row-major order. Default: [1.0,1.0,0.5,0.0,1.0,1.0,0.0,0.0,1.0,1.0,0.0,0.0,54.3,37.9,48.0,37.9,34.3,42.5,48.0,42.5,43.7] + The matrix R stored in row-major order. Default: [1,2] + The dimensions of the state vector, measurement vector and controller vector. + The lined up matrices A,C,Q, possibly G and u, and if necessary L which all have been stored in row-major order. + The matrix R stored in row-major order. + + + Estimate the current state of a system with the help of the Kalman filtering. + The dimensions of the state vector, the measurement and the controller vector. Default: [3,1,0] + The lined up matrices A,C,Q, possibly G and u, and if necessary L which have been stored in row-major order. Default: [1.0,1.0,0.5,0.0,1.0,1.0,0.0,0.0,1.0,1.0,0.0,0.0,54.3,37.9,48.0,37.9,34.3,42.5,48.0,42.5,43.7] + The matrix R stored in row-major order and the measurement vector y lined up. Default: [1.2,1.0] + The matrix P*@f$P$ (the extrapolation-error covariances) stored in row-major order and the extrapolation vector x*@f$x$ lined up. Default: [0.0,0.0,0.0,0.0,180.5,0.0,0.0,0.0,100.0,0.0,100.0,0.0] + The matrix P* (the extrapolation-error covariances)stored in row-major order and the extrapolation vector x*@f$x$ lined up. + The matrix P~@f$P$ (the estimation-error covariances) stored in row-major order and the estimated state x~@f$x$ lined up. + + + Query slots concerning information with relation to the operator get_operator_info. + Slotnames of the operator get_operator_info. + + + Query slots of the online-information concerning the operator get_param_info. + Slotnames for the operator get_param_info. + + + Get operators with the given string as a substring of their name. + Substring of the seeked names (empty $ less than = greater than $ all names). Default: "info" + Detected operator names. + + + Get default data type for the control parameters of a HALCON-operator. + Name of the operator. Default: "get_param_types" + Default type of the input control parameters. + Default type of the output control parameters. + + + Get number of the different parameter classes of a HALCON-operator. + Name of the operator. Default: "get_param_num" + Name of the called C-function. + Number of the input object parameters. + Number of the output object parameters. + Number of the input control parameters. + Number of the output control parameters. + System operator or user procedure. + + + Get the names of the parameters of a HALCON-operator. + Name of the operator. Default: "get_param_names" + Names of the input objects. + Names of the output objects. + Names of the input control parameters. + Names of the output control parameters. + + + Get information concerning a HALCON-operator. + Name of the operator on which more information is needed. Default: "get_operator_info" + Desired information. Default: "abstract" + Information (empty if no information is available) + + + Get information concerning the operator parameters. + Name of the operator on whose parameter more information is needed. Default: "get_param_info" + Name of the parameter on which more information is needed. Default: "Slot" + Desired information. Default: "description" + Information (empty in case there is no information available). + + + Search names of all operators assigned to one keyword. + Keyword for which corresponding operators are searched. Default: "Information" + Operators whose slot 'keyword' contains the keyword. + + + Get keywords which are assigned to operators. + Substring in the names of those operators for which keywords are needed. Default: "get_keywords" + Keywords for the operators. + + + Get information concerning the chapters on operators. + Operator class or subclass of interest. Default: "" + Operator classes (Chapter = ") or operator subclasses respectively operators. + + + Convert one-channel images into a multi-channel image + One-channel images to be combined into a one-channel image. + Multi-channel image. + + + Convert a multi-channel image into One-channel images + Multi-channel image to be decomposed. + Generated one-channel images. + + + Convert 7 images into a seven-channel image. + Input image 1. + Input image 2. + Input image 3. + Input image 4. + Input image 5. + Input image 6. + Input image 7. + Multi-channel image. + + + Convert 6 images into a six-channel image. + Input image 1. + Input image 2. + Input image 3. + Input image 4. + Input image 5. + Input image 6. + Multi-channel image. + + + Convert 5 images into a five-channel image. + Input image 1. + Input image 2. + Input image 3. + Input image 4. + Input image 5. + Multi-channel image. + + + Convert 4 images into a four-channel image. + Input image 1. + Input image 2. + Input image 3. + Input image 4. + Multi-channel image. + + + Convert 3 images into a three-channel image. + Input image 1. + Input image 2. + Input image 3. + Multi-channel image. + + + Convert two images into a two-channel image. + Input image 1. + Input image 2. + Multi-channel image. + + + Convert a seven-channel image into seven images. + Multi-channel image. + Output image 1. + Output image 2. + Output image 3. + Output image 4. + Output image 5. + Output image 6. + Output image 7. + + + Convert a six-channel image into six images. + Multi-channel image. + Output image 1. + Output image 2. + Output image 3. + Output image 4. + Output image 5. + Output image 6. + + + Convert a five-channel image into five images. + Multi-channel image. + Output image 1. + Output image 2. + Output image 3. + Output image 4. + Output image 5. + + + Convert a four-channel image into four images. + Multi-channel image. + Output image 1. + Output image 2. + Output image 3. + Output image 4. + + + Convert a three-channel image into three images. + Multi-channel image. + Output image 1. + Output image 2. + Output image 3. + + + Convert a two-channel image into two images. + Multi-channel image. + Output image 1. + Output image 2. + + + Count channels of image. + One- or multi-channel image. + Number of channels. + + + Append additional matrices (channels) to the image. + Multi-channel image. + Image to be appended. + Image appended by Image. + + + Access a channel of a multi-channel image. + Multi-channel image. + One channel of MultiChannelImage. + Index of channel to be accessed. Default: 1 + + + Tile multiple image objects into a large image with explicit positioning information. + Input images. + Tiled output image. + Row coordinate of the upper left corner of the input images in the output image. Default: 0 + Column coordinate of the upper left corner of the input images in the output image. Default: 0 + Row coordinate of the upper left corner of the copied part of the respective input image. Default: -1 + Column coordinate of the upper left corner of the copied part of the respective input image. Default: -1 + Row coordinate of the lower right corner of the copied part of the respective input image. Default: -1 + Column coordinate of the lower right corner of the copied part of the respective input image. Default: -1 + Width of the output image. Default: 512 + Height of the output image. Default: 512 + + + Tile multiple image objects into a large image. + Input images. + Tiled output image. + Number of columns to use for the output image. Default: 1 + Order of the input images in the output image. Default: "vertical" + + + Tile multiple images into a large image. + Input image. + Tiled output image. + Number of columns to use for the output image. Default: 1 + Order of the input images in the output image. Default: "vertical" + + + Cut out of defined gray values. + Input image. + Image area. + + + Cut out one or more rectangular image areas. + Input image. + Image area. + Line index of upper left corner of image area. Default: 100 + Column index of upper left corner of image area. Default: 100 + Line index of lower right corner of image area. Default: 200 + Column index of lower right corner of image area. Default: 200 + + + Cut out one or more rectangular image areas. + Input image. + Image area. + Line index of upper left corner of image area. Default: 100 + Column index of upper left corner of image area. Default: 100 + Width of new image. Default: 128 + Height of new image. Default: 128 + + + Change image size. + Input image. + Image with new format. + Width of new image. Default: 512 + Height of new image. Default: 512 + + + Change definition domain of an image. + Input image. + New definition domain. + Image with new definition domain. + + + Add gray values to regions. + Input regions (without pixel values). + Input image with pixel values for regions. + Output image(s) with regions and pixel values (one image per input region). + + + Reduce the domain of an image to a rectangle. + Input image. + Image with reduced definition domain. + Line index of upper left corner of image area. Default: 100 + Column index of upper left corner of image area. Default: 100 + Line index of lower right corner of image area. Default: 200 + Column index of lower right corner of image area. Default: 200 + + + Reduce the domain of an image. + Input image. + New definition domain. + Image with reduced definition domain. + + + Expand the domain of an image to maximum. + Input image. + Image with maximum definition domain. + + + Get the domain of an image. + Input images. + Definition domains of input images. + + + Centres of circles for a specific radius. + Binary edge image in which the circles are to be detected. + Centres of those circles which are included in the edge image by Percent percent. + Radius of the circle to be searched in the image. Default: 12 + Indicates the percentage (approximately) of the (ideal) circle which must be present in the edge image RegionIn. Default: 60 + The modus defines the position of the circle in question: 0 - the radius is equivalent to the outer border of the set pixels. 1 - the radius is equivalent to the centres of the circle lines' pixels. 2 - both 0 and 1 (a little more fuzzy, but more reliable in contrast to circles set slightly differently, necessitates 50 + + + Return the Hough-Transform for circles with a given radius. + Binary edge image in which the circles are to be detected. + Hough transform for circles with a given radius. + Radius of the circle to be searched in the image. Default: 12 + + + Detect lines in edge images with the help of the Hough transform using local gradient direction and return them in normal form. + Image containing the edge direction. The edges are described by the image domain. + Hough transform. + Regions of the input image that contributed to the local maxima. + Uncertainty of edge direction (in degrees). Default: 2 + Resolution in the angle area (in 1/degrees). Default: 4 + Smoothing filter for hough image. Default: "mean" + Required smoothing filter size. Default: 5 + Threshold value in the Hough image. Default: 100 + Minimum distance of two maxima in the Hough image (direction: angle). Default: 5 + Minimum distance of two maxima in the Hough image (direction: distance). Default: 5 + Create line regions if 'true'. Default: "true" + Angles (in radians) of the detected lines' normal vectors. + Distance of the detected lines from the origin. + + + Compute the Hough transform for lines using local gradient direction. + Image containing the edge direction. The edges must be described by the image domain. + Hough transform. + Uncertainty of the edge direction (in degrees). Default: 2 + Resolution in the angle area (in 1/degrees). Default: 4 + + + Detect lines in edge images with the help of the Hough transform and returns it in HNF. + Binary edge image in which the lines are to be detected. + Adjusting the resolution in the angle area. Default: 4 + Threshold value in the Hough image. Default: 100 + Minimal distance of two maxima in the Hough image (direction: angle). Default: 5 + Minimal distance of two maxima in the Hough image (direction: distance). Default: 5 + Angles (in radians) of the detected lines' normal vectors. + Distance of the detected lines from the origin. + + + Produce the Hough transform for lines within regions. + Binary edge image in which lines are to be detected. + Hough transform for lines. + Adjusting the resolution in the angle area. Default: 4 + + + Select those lines from a set of lines (in HNF) which fit best into a region. + Region in which the lines are to be matched. + Region array containing the matched lines. + Angles (in radians) of the normal vectors of the input lines. + Distances of the input lines form the origin. + Widths of the lines. Default: 7 + Threshold value for the number of line points in the region. Default: 100 + Angles (in radians) of the normal vectors of the selected lines. + Distances of the selected lines from the origin. + + + Segment the rectification grid region in the image. + Input image. + Output region containing the rectification grid. + Minimum contrast. Default: 8.0 + Radius of the circular structuring element. Default: 7.5 + + + Generate a PostScript file, which describes the rectification grid. + Width of the checkered pattern in meters (without the two frames). Default: 0.17 + Number of squares per row and column. Default: 17 + File name of the PostScript file. Default: "rectification_grid.ps" + + + Establish connections between the grid points of the rectification grid. + Input image. + Output contours. + Row coordinates of the grid points. + Column coordinates of the grid points. + Size of the applied Gaussians. Default: 0.9 + Maximum distance of the connecting lines from the grid points. Default: 5.5 + + + Compute the mapping between the distorted image and the rectified image based upon the points of a regular grid. + Input image. + Input contours. + Image containing the mapping data. + Output contours. + Distance of the grid points in the rectified image. + Rotation to be applied to the point grid. Default: "auto" + Row coordinates of the grid points. + Column coordinates of the grid points. + Type of mapping. Default: "bilinear" + + + Generate a projection map that describes the mapping between an arbitrarily distorted image and the rectified image. + Image containing the mapping data. + Distance of the grid points in the rectified image. + Row coordinates of the grid points in the distorted image. + Column coordinates of the grid points in the distorted image. + Width of the point grid (number of grid points). + Width of the images to be rectified. + Height of the images to be rectified. + Type of mapping. Default: "bilinear" + + + Gets a copy of the background image of the HALCON window. + Copy of the background image. + Window handle. + + + Add a callback function to a drawing object. + Handle of the drawing object. + Events to be captured. + Callback functions. + + + Detach the background image from a HALCON window. + Window handle. + + + Attach a background image to a HALCON window. + Background image. + Window handle. + + + Detach an existing drawing object from a HALCON window. + Window Handle. + Handle of the drawing object. + + + Attach an existing drawing object to a HALCON window. + Window handle. + Handle of the drawing object. + + + Modify the pose of a 3D plot. + Window handle. + Row coordinate of the first point. + Column coordinate of the first point. + Row coordinate of the second point. + Column coordinate of the second point. + Navigation mode. Default: "rotate" + + + Calculates image coordinates for a point in a 3D plot window. + Displayed image. + Window handle. + Row coordinate in the window. + Column coordinate in the window. + Row coordinate in the image. + Column coordinate in the image. + Height value. + + + Get the operating system window handle. + Window handle. + Operating system window handle. + Operating system display handle (under Unix-like systems only). + + + Set the device context of a virtual graphics window (Windows NT). + Window handle. + device context of WINHWnd. + + + Create a virtual graphics window under Windows. + Windows window handle of a previously created window. + Row coordinate of upper left corner. Default: 0 + Column coordinate of upper left corner. Default: 0 + Width of the window. Default: 512 + Height of the window. Default: 512 + Window handle. + + + Interactive output from two window buffers. + Source window handle of the "`upper window"'. + Source window handle of the "`lower window"'. + Output window handle. + + + Specify a window type. + Name of the window type which has to be set. Default: "X-Window" + + + Modify position and size of a window. + Window handle. + Row index of upper left corner in target position. Default: 0 + Column index of upper left corner in target position. Default: 0 + Width of the window. Default: 512 + Height of the window. Default: 512 + + + Get window characteristics. + Name of the attribute that should be returned. + Attribute value. + + + Set window characteristics. + Name of the attribute that should be modified. + Value of the attribute that should be set. + + + Query all available window types. + Names of available window types. + + + Open a graphics window. + Row index of upper left corner. Default: 0 + Column index of upper left corner. Default: 0 + Width of the window. Default: 256 + Height of the window. Default: 256 + Logical number of the father window. To specify the display as father you may enter 'root' or 0. Default: 0 + Window mode. Default: "visible" + Name of the computer on which you want to open the window. Otherwise the empty string. Default: "" + Window handle. + + + Open a textual window. + Row index of upper left corner. Default: 0 + Column index of upper left corner. Default: 0 + Window's width. Default: 256 + Window's height. Default: 256 + Window border's width. Default: 2 + Window border's color. Default: "white" + Background color. Default: "black" + Logical number of the father window. For the display as father you may specify 'root' or 0. Default: 0 + Window mode. Default: "visible" + Computer name, where the window has to be opened or empty string. Default: "" + Window handle. + + + Copy inside an output window. + Window handle. + Row index of upper left corner of the source rectangle. Default: 0 + Column index of upper left corner of the source rectangle. Default: 0 + Row index of lower right corner of the source rectangle. Default: 64 + Column index of lower right corner of the source rectangle. Default: 64 + Row index of upper left corner of the target position. Default: 64 + Column index of upper left corner of the target position. Default: 64 + + + Get the window type. + Window handle. + Window type + + + Access to a window's pixel data. + Window handle. + Pointer on red channel of pixel data. + Pointer on green channel of pixel data. + Pointer on blue channel of pixel data. + Length of an image line. + Number of image lines. + + + Information about a window's size and position. + Window handle. + Row index of upper left corner of the window. + Column index of upper left corner of the window. + Window width. + Window height. + + + Write the window content in an image object. + Saved image. + Window handle. + + + Write the window content to a file. + Window handle. + Name of the target device or of the graphic format. Default: "postscript" + File name (without extension). Default: "halcon_dump" + + + Copy all pixels within rectangles between output windows. + Source window handle. + Destination window handle. + Row index of upper left corner in the source window. Default: 0 + Column index of upper left corner in the source window. Default: 0 + Row index of lower right corner in the source window. Default: 128 + Column index of lower right corner in the source window. Default: 128 + Row index of upper left corner in the target window. Default: 0 + Column index of upper left corner in the target window. Default: 0 + + + Close an output window. + Window handle. + + + Delete the contents of an output window. + Window handle. + + + Delete a rectangle on the output window. + Window handle. + Line index of upper left corner. Default: 10 + Column index of upper left corner. Default: 10 + Row index of lower right corner. Default: 118 + Column index of lower right corner. Default: 118 + + + Print text in a window. + Window handle. + Tuple of output values (all types). Default: "hello" + + + Set the shape of the text cursor. + Window handle. + Name of cursor shape. Default: "invisible" + + + Set the position of the text cursor. + Window handle. + Row index of text cursor position. Default: 24 + Column index of text cursor position. Default: 12 + + + Read a string in a text window. + Window handle. + Default string (visible before input). Default: "" + Maximum number of characters. Default: 32 + Read string. + + + Read a character from a text window. + Window handle. + Input character (if it is not a control character). + Code for input character. + + + Set the position of the text cursor to the beginning of the next line. + Window handle. + + + Get the shape of the text cursor. + Window handle. + Name of the current text cursor. + + + Get cursor position. + Window handle. + Row index of text cursor position. + Column index of text cursor position. + + + Get the maximum size of all characters of a font. + Window handle. + Maximum height above baseline. + Maximum extension below baseline. + Maximum character width. + Maximum character height. + + + Get the spatial size of a string. + Window handle. + Values to consider. Default: "test_string" + Maximum height above baseline. + Maximum extension below baseline. + Text width. + Text height. + + + Query the available fonts. + Window handle. + Tuple with available font names. + + + Query all shapes available for text cursors. + Window handle. + Names of the available text cursors. + + + Set the font used for text output. + Window handle. + Name of new font. + + + Get the current font. + Window handle. + Name of the current font. + + + Get the depth or the index of instances in a displayed 3D scene. + Window handle. + Handle of the 3D scene. + Row coordinates. + Column coordinates. + Information. Default: "depth" + Indices or the depth of the objects at (Row,Column). + + + Set the pose of a 3D scene. + Handle of the 3D scene. + New pose of the 3D scene. + + + Set parameters of a 3D scene. + Handle of the 3D scene. + Names of the generic parameters. Default: "quality" + Values of the generic parameters. Default: "high" + + + Set parameters of a light in a 3D scene. + Handle of the 3D scene. + Index of the light source. + Names of the generic parameters. Default: "ambient" + Values of the generic parameters. Default: [0.2,0.2,0.2] + + + Set the pose of an instance in a 3D scene. + Handle of the 3D scene. + Index of the instance. + New pose of the instance. + + + Set parameters of an instance in a 3D scene. + Handle of the 3D scene. + Index of the instance. + Names of the generic parameters. Default: "color" + Values of the generic parameters. Default: "green" + + + Set the pose of a camera in a 3D scene. + Handle of the 3D scene. + Index of the camera. + New pose of the camera. + + + Render an image of a 3D scene. + Rendered 3D scene. + Handle of the 3D scene. + Index of the camera used to display the scene. + + + Remove a light from a 3D scene. + Handle of the 3D scene. + Light to remove. + + + Remove an object instance from a 3D scene. + Handle of the 3D scene. + Index of the instance to remove. + + + Remove a camera from a 3D scene. + Handle of the 3D scene. + Index of the camera to remove. + + + Display a 3D scene. + Window handle. + Handle of the 3D scene. + Index of the camera used to display the scene. + + + Add a light source to a 3D scene. + Handle of the 3D scene. + Position of the new light source. Default: [-100.0,-100.0,0.0] + Type of the new light source. Default: "point_light" + Index of the new light source in the 3D scene. + + + Add an instance of a 3D object model to a 3D scene. + Handle of the 3D scene. + Handle of the 3D object model. + Pose of the 3D object model. + Index of the new instance in the 3D scene. + + + Add a camera to a 3D scene. + Handle of the 3D scene. + Parameters of the new camera. + Index of the new camera in the 3D scene. + + + Delete a 3D scene and free all allocated memory. + Handle of the 3D scene. + + + Create the data structure that is needed to visualize collections of 3D objects. + Handle of the 3D scene. + + + Get window parameters. + Window handle. + Name of the parameter. Default: "flush" + Value of the parameter. + + + Set window parameters. + Window handle. + Name of the parameter. Default: "flush" + Value to be set. Default: "false" + + + Define the region output shape. + Window handle. + Region output mode. Default: "original" + + + Set the color definition via RGB values. + Window handle. + Red component of the color. Default: 255 + Green component of the color. Default: 0 + Blue component of the color. Default: 0 + + + Define a color lookup table index. + Window handle. + Color lookup table index. Default: 128 + + + Define an interpolation method for gray value output. + Window handle. + Interpolation method for image output: 0 (fast, low quality) to 2 (slow, high quality). Default: 0 + + + Modify the displayed image part. + Window handle. + Row of the upper left corner of the chosen image part. Default: 0 + Column of the upper left corner of the chosen image part. Default: 0 + Row of the lower right corner of the chosen image part. Default: -1 + Column of the lower right corner of the chosen image part. Default: -1 + + + Define the gray value output mode. + Window handle. + Output mode. Additional parameters possible. Default: "default" + + + Define the line width for region contour output. + Window handle. + Line width for region output in contour mode. Default: 1.0 + + + Define a contour output pattern. + Window handle. + Contour pattern. Default: [] + + + Define the approximation error for contour display. + Window handle. + Maximum deviation from the original contour. Default: 0 + + + Define the pixel output function. + Window handle. + Name of the display function. Default: "copy" + + + Define output colors (HSI-coded). + Window handle. + Hue for region output. Default: 30 + Saturation for region output. Default: 255 + Intensity for region output. Default: 84 + + + Define gray values for region output. + Window handle. + Gray values for region output. Default: 255 + + + Define the region fill mode. + Window handle. + Fill mode for region output. Default: "fill" + + + Define the image matrix output clipping. + Window handle. + Clipping mode for gray value output. Default: "object" + + + Set multiple output colors. + Window handle. + Number of output colors. Default: 12 + + + Set output color. + Window handle. + Output color names. Default: "white" + + + Get the current region output shape. + Window handle. + Current region output shape. + + + Get the current color in RGB-coding. + Window handle. + The current color's red value. + The current color's green value. + The current color's blue value. + + + Get the current color lookup table index. + Window handle. + Index of the current color look-up table. + + + Get the current interpolation mode for gray value display. + Window handle. + Interpolation mode for image display: 0 (fast, low quality) to 2 (slow, high quality). + + + Get the image part. + Window handle. + Row index of the image part's upper left corner. + Column index of the image part's upper left corner. + Row index of the image part's lower right corner. + Column index of the image part's lower right corner. + + + Get the current display mode for gray values. + Window handle. + Name and parameter values of the current display mode. + + + Get the current line width for contour display. + Window handle. + Current line width for contour display. + + + Get the current graphic mode for contours. + Window handle. + Template for contour display. + + + Get the current approximation error for contour display. + Window handle. + Current approximation error for contour display. + + + Get the current display mode. + Window handle. + Display mode. + + + Get the HSI coding of the current color. + Window handle. + Hue (color value) of the current color. + Saturation of the current color. + Intensity of the current color. + + + Get the current region fill mode. + Window handle. + Current region fill mode. + + + Get the output treatment of an image matrix. + Window handle. + Display mode for images. + + + Query the region display modes. + region display mode names. + + + Query the gray value display modes. + Window handle. + Gray value display mode names. + + + Query the possible line widths. + Displayable minimum width. + Displayable maximum width. + + + Query the possible graphic modes. + Window handle. + Display function name. + + + Query the displayable gray values. + Window handle. + Tuple of all displayable gray values. + + + Query the number of colors for color output. + Tuple of the possible numbers of colors. + + + Query all color names. + Window handle. + Color names. + + + Query all color names displayable in the window. + Window handle. + Color names. + + + Query the icon for region output + Icon for the regions center of gravity. + Window handle. + + + Icon definition for region output. + Icon for center of gravity. + Window handle. + + + Displays regions in a window. + Regions to display. + Window handle. + + + Displays arbitrarily oriented rectangles. + Window handle. + Row index of the center. Default: 48 + Column index of the center. Default: 64 + Orientation of rectangle in radians. Default: 0.0 + Half of the length of the longer side. Default: 48 + Half of the length of the shorter side. Default: 32 + + + Display of rectangles aligned to the coordinate axes. + Window handle. + Row index of the upper left corner. Default: 16 + Column index of the upper left corner. Default: 16 + Row index of the lower right corner. Default: 48 + Column index of the lower right corner. Default: 80 + + + Displays a polyline. + Window handle. + Row index Default: [16,80,80] + Column index Default: [48,16,80] + + + Draws lines in a window. + Window handle. + Row index of the start. Default: 32.0 + Column index of the start. Default: 32.0 + Row index of end. Default: 64.0 + Column index of end. Default: 64.0 + + + Displays crosses in a window. + Window handle. + Row coordinate of the center. Default: 32.0 + Column coordinate of the center. Default: 32.0 + Length of the bars. Default: 6.0 + Orientation. Default: 0.0 + + + Displays gray value images. + Gray value image to display. + Window handle. + + + Displays images with several channels. + Multichannel images to be displayed. + Window handle. + Number of channel or the numbers of the RGB-channels Default: 1 + + + Displays a color (RGB) image + Color image to display. + Window handle. + + + Displays ellipses. + Window handle. + Row index of center. Default: 64 + Column index of center. Default: 64 + Orientation of the ellipse in radians Default: 0.0 + Radius of major axis. Default: 24.0 + Radius of minor axis. Default: 14.0 + + + Displays a noise distribution. + Window handle. + Gray value distribution (513 values). + Row index of center. Default: 256 + Column index of center. Default: 256 + Size of display. Default: 1 + + + Displays circles in a window. + Window handle. + Row index of the center. Default: 64 + Column index of the center. Default: 64 + Radius of the circle. Default: 64 + + + Displays arrows in a window. + Window handle. + Row index of the start. Default: 10.0 + Column index of the start. Default: 10.0 + Row index of the end. Default: 118.0 + Column index of the end. Default: 118.0 + Size of the arrowhead. Default: 1.0 + + + Displays circular arcs in a window. + Window handle. + Row coordinate of center point. Default: 64 + Column coordinate of center point. Default: 64 + Angle between start and end of the arc (in radians). Default: 3.1415926 + Row coordinate of the start of the arc. Default: 32 + Column coordinate of the start of the arc. Default: 32 + + + Displays image objects (image, region, XLD). + Image object to be displayed. + Window handle. + + + Set the current mouse pointer shape. + Window handle. + Mouse pointer name. Default: "arrow" + + + Query the current mouse pointer shape. + Window handle. + Mouse pointer name. + + + Query all available mouse pointer shapes. + Window handle. + Available mouse pointer names. + + + Query the subpixel mouse position. + Window handle. + Row coordinate of the mouse cursor in the image coordinate system. + Column coordinate of the mouse cursor in the image coordinate system. + Mouse button(s) pressed or 0. + + + Query the mouse position. + Window handle. + Row coordinate of the mouse cursor in the image coordinate system. + Column coordinate of the mouse cursor in the image coordinate system. + Mouse button(s) pressed or 0. + + + Wait until a mouse button is pressed and get the subpixel mouse position. + Window handle. + Row coordinate of the mouse cursor in the image coordinate system. + Column coordinate of the mouse cursor in the image coordinate system. + Mouse button(s) pressed. + + + Wait until a mouse button is pressed. + Window handle. + Row coordinate of the mouse cursor in the image coordinate system. + Column coordinate of the mouse cursor in the image coordinate system. + Mouse button(s) pressed. + + + Write look-up-table (lut) as file. + Window handle. + File name (of file containing the look-up-table). Default: "/tmp/lut" + + + Graphical view of the look-up-table (lut). + Window handle. + Row of centre of the graphic. Default: 128 + Column of centre of the graphic. Default: 128 + Scaling of the graphic. Default: 1 + + + Query all available look-up-tables (lut). + Window handle. + Names of look-up-tables. + + + Get modification parameters of look-up-table (lut). + Window handle. + Modification of color value. + Modification of saturation. + Modification of intensity. + + + Changing the look-up-table (lut). + Window handle. + Modification of color value. Default: 0.0 + Modification of saturation. Default: 1.5 + Modification of intensity. Default: 1.5 + + + Get current look-up-table (lut). + Window handle. + Name of look-up-table or tuple of RGB-values. + + + Set "`look-up-table"' (lut). + Window handle. + Name of look-up-table, values of look-up-table (RGB) or file name. Default: "default" + + + Get mode of fixing of current look-up-table (lut). + Window handle. + Current Mode of fixing. + + + Set fixing of "`look-up-table"' (lut) + Window handle. + Mode of fixing. Default: "true" + + + Get fixing of "`look-up-table"' (lut) for "`real color images"' + Window handle. + Mode of fixing. + + + Fix "`look-up-table"' (lut) for "`real color images"'. + Window handle. + Mode of fixing. Default: "true" + + + Plot a function using gnuplot. + Identifier for the gnuplot output stream. + Function to be plotted. + + + Plot control values using gnuplot. + Identifier for the gnuplot output stream. + Control values to be plotted (y-values). + + + Visualize images using gnuplot. + Image to be plotted. + Identifier for the gnuplot output stream. + Number of samples in the x-direction. Default: 64 + Number of samples in the y-direction. Default: 64 + Rotation of the plot about the x-axis. Default: 60 + Rotation of the plot about the z-axis. Default: 30 + Plot the image with hidden surfaces removed. Default: "hidden3d" + + + Close all open gnuplot files or terminate an active gnuplot sub-process. + Identifier for the gnuplot output stream. + + + Open a gnuplot file for visualization of images and control values. + Base name for control and data files. + Identifier for the gnuplot output stream. + + + Open a pipe to a gnuplot process for visualization of images and control values. + Identifier for the gnuplot output stream. + + + Create a text object which can be moved interactively. + Row coordinate of the text position. Default: 12 + Column coordinate of the text position. Default: 12 + Character string to be displayed. Default: "Text" + Handle of the drawing object. + + + Return the iconic object of a drawing object. + Copy of the iconic object represented by the drawing object. + Handle of the drawing object. + + + Delete drawing object. + Handle of the drawing object. + + + Set the parameters of a drawing object. + Handle of the drawing object. + Parameter names of the drawing object. + Parameter values. + + + Get the parameters of a drawing object. + Handle of the drawing object. + Parameter names of the drawing object. + Parameter values. + + + Set the contour of an interactive draw XLD. + XLD contour. + Handle of the drawing object. + + + Create a XLD contour which can be modified interactively. + Row coordinates of the polygon. Default: [100,200,200,100] + Column coordinates of the polygon. Default: [100,100,200,200] + Handle of the drawing object. + + + Create a circle sector which can be modified interactively. + Row coordinate of the center. Default: 100 + Column coordinate of the center. Default: 100 + Radius of the circle. Default: 80 + Start angle of the arc. Default: 0 + End angle of the arc. Default: 3.14159 + Handle of the drawing object. + + + Create an elliptic sector which can be modified interactively. + Row index of the center. Default: 200 + Column index of the center. Default: 200 + Orientation of the first half axis in radians. Default: 0 + First half axis. Default: 100 + Second half axis. Default: 60 + Start angle of the arc. Default: 0 + End angle of the arc. Default: 3.14159 + Handle of the drawing object. + + + Create a line which can be modified interactively. + Row index of the first line point. Default: 100 + Column index of the first line point. Default: 100 + Row index of the second line point. Default: 200 + Column index of the second line point. Default: 200 + Handle of the drawing object. + + + Create a circle which can be modified interactively. + Row coordinate of the center. Default: 100 + Column coordinate of the center. Default: 100 + Radius of the circle. Default: 80 + Handle of the drawing object. + + + Create an ellipse which can be modified interactively. + Row index of the center. Default: 200 + Column index of the center. Default: 200 + Orientation of the first half axis in radians. Default: 0 + First half axis. Default: 100 + Second half axis. Default: 60 + Handle of the drawing object. + + + Create a rectangle of any orientation which can be modified interactively. + Row coordinate of the center. Default: 150 + Column coordinate of the center. Default: 150 + Orientation of the first half axis in radians. Default: 0 + First half axis. Default: 100 + Second half axis. Default: 100 + Handle of the drawing object. + + + Create a rectangle parallel to the coordinate axis which can be modified interactively. + Row coordinate of the upper left corner. Default: 100 + Column coordinate of the upper left corner. Default: 100 + Row coordinate of the lower right corner. Default: 200 + Column coordinate of the lower right corner. Default: 200 + Handle of the drawing object. + + + Interactive movement of a region with restriction of positions. + Regions to move. + Points on which it is allowed for a region to move. + Moved regions. + Window handle. + Row index of the reference point. Default: 100 + Column index of the reference point. Default: 100 + + + Interactive movement of a region with fixpoint specification. + Regions to move. + Moved regions. + Window handle. + Row index of the reference point. Default: 100 + Column index of the reference point. Default: 100 + + + Interactive moving of a region. + Regions to move. + Moved Regions. + Window handle. + + + Interactive modification of a NURBS curve using interpolation. + Contour of the modified curve. + Window handle. + Enable rotation? Default: "true" + Enable moving? Default: "true" + Enable scaling? Default: "true" + Keep ratio while scaling? Default: "true" + Enable editing? Default: "true" + The degree $p$ of the NURBS curve. Reasonable values are 3 to 5. Default: 3 + Row coordinates of the input interpolation points. + Column coordinates of the input interpolation points. + Input tangents. + Row coordinates of the control polygon. + Column coordinates of the control polygon. + Knot vector. + Row coordinates of the points specified by the user. + Column coordinates of the points specified by the user. + Tangents specified by the user. + + + Interactive drawing of a NURBS curve using interpolation. + Contour of the curve. + Window handle. + Enable rotation? Default: "true" + Enable moving? Default: "true" + Enable scaling? Default: "true" + Keep ratio while scaling? Default: "true" + The degree $p$ of the NURBS curve. Reasonable values are 3 to 5. Default: 3 + Row coordinates of the control polygon. + Column coordinates of the control polygon. + Knot vector. + Row coordinates of the points specified by the user. + Column coordinates of the points specified by the user. + Tangents specified by the user. + + + Interactive modification of a NURBS curve. + Contour of the modified curve. + Window handle. + Enable rotation? Default: "true" + Enable moving? Default: "true" + Enable scaling? Default: "true" + Keep ratio while scaling? Default: "true" + Enable editing? Default: "true" + The degree $p$ of the NURBS curve. Reasonable values are 3 to 25. Default: 3 + Row coordinates of the input control polygon. + Column coordinates of the input control polygon. + Input weight vector. + Row coordinates of the control polygon. + Columns coordinates of the control polygon. + Weight vector. + + + Interactive drawing of a NURBS curve. + Contour approximating the NURBS curve. + Window handle. + Enable rotation? Default: "true" + Enable moving? Default: "true" + Enable scaling? Default: "true" + Keep ratio while scaling? Default: "true" + The degree $p$ of the NURBS curve. Reasonable values are 3 to 25. Default: 3 + Row coordinates of the control polygon. + Columns coordinates of the control polygon. + Weight vector. + + + Interactive modification of a contour. + Input contour. + Modified contour. + Window handle. + Enable rotation? Default: "true" + Enable moving? Default: "true" + Enable scaling? Default: "true" + Keep ratio while scaling? Default: "true" + Enable editing? Default: "true" + + + Interactive drawing of a contour. + Modified contour. + Window handle. + Enable rotation? Default: "true" + Enable moving? Default: "true" + Enable scaling? Default: "true" + Keep ratio while scaling? Default: "true" + + + Interactive drawing of any orientated rectangle. + Window handle. + Row index of the center. + Column index of the center. + Orientation of the bigger half axis in radians. + Bigger half axis. + Smaller half axis. + Row index of the center. + Column index of the center. + Orientation of the bigger half axis in radians. + Bigger half axis. + Smaller half axis. + + + Interactive drawing of any orientated rectangle. + Window handle. + Row index of the center. + Column index of the center. + Orientation of the bigger half axis in radians. + Bigger half axis. + Smaller half axis. + + + Draw a rectangle parallel to the coordinate axis. + Window handle. + Row index of the left upper corner. + Column index of the left upper corner. + Row index of the right lower corner. + Column index of the right lower corner. + Row index of the left upper corner. + Column index of the left upper corner. + Row index of the right lower corner. + Column index of the right lower corner. + + + Draw a rectangle parallel to the coordinate axis. + Window handle. + Row index of the left upper corner. + Column index of the left upper corner. + Row index of the right lower corner. + Column index of the right lower corner. + + + Draw a point. + Window handle. + Row index of the point. + Column index of the point. + Row index of the point. + Column index of the point. + + + Draw a point. + Window handle. + Row index of the point. + Column index of the point. + + + Draw a line. + Window handle. + Row index of the first point of the line. + Column index of the first point of the line. + Row index of the second point of the line. + Column index of the second point of the line. + Row index of the first point of the line. + Column index of the first point of the line. + Row index of the second point of the line. + Column index of the second point of the line. + + + Draw a line. + Window handle. + Row index of the first point of the line. + Column index of the first point of the line. + Row index of the second point of the line. + Column index of the second point of the line. + + + Interactive drawing of an ellipse. + Window handle. + Row index of the center. + Column index of the center. + Orientation of the bigger half axis in radians. + Bigger half axis. + Smaller half axis. + Row index of the center. + Column index of the center. + Orientation of the first half axis in radians. + First half axis. + Second half axis. + + + Interactive drawing of an ellipse. + Window handle. + Row index of the center. + Column index of the center. + Orientation of the first half axis in radians. + First half axis. + Second half axis. + + + Interactive drawing of a circle. + Window handle. + Row index of the center. + Column index of the center. + Radius of the circle. + Row index of the center. + Column index of the center. + Circle's radius. + + + Interactive drawing of a circle. + Window handle. + Barycenter's row index. + Barycenter's column index. + Circle's radius. + + + Interactive drawing of a closed region. + Interactive created region. + Window handle. + + + Interactive drawing of a polygon row. + Region, which encompasses all painted points. + Window handle. + + + Calculate the projection of a point onto a line. + Row coordinate of the point. + Column coordinate of the point. + Row coordinate of the first point on the line. + Column coordinate of the first point on the line. + Row coordinate of the second point on the line. + Column coordinate of the second point on the line. + Row coordinate of the projected point. + Column coordinate of the projected point + + + Calculate a point of an ellipse corresponding to a specific angle. + Angle corresponding to the resulting point [rad]. Default: 0 + Row coordinate of the center of the ellipse. + Column coordinate of the center of the ellipse. + Orientation of the main axis [rad]. + Length of the larger half axis. + Length of the smaller half axis. + Row coordinate of the point on the ellipse. + Column coordinates of the point on the ellipse. + + + Calculate the intersection point of two lines. + Row coordinate of the first point of the first line. + Column coordinate of the first point of the first line. + Row coordinate of the second point of the first line. + Column coordinate of the second point of the first line. + Row coordinate of the first point of the second line. + Column coordinate of the first point of the second line. + Row coordinate of the second point of the second line. + Column coordinate of the second point of the second line. + Row coordinate of the intersection point. + Column coordinate of the intersection point. + Are the two lines parallel? + + + Calculate the intersection points of two XLD contours + First XLD contour. + Second XLD contour. + Intersection points to be returned. Default: "all" + Row coordinates of the intersection points. + Column coordinates of the intersection points. + Does a part of a contour lies above another contour part? + + + Calculate the intersection points of a circle or circular arc and an XLD contour + XLD contour. + Row coordinate of the center of the circle or circular arc. + Column coordinate of the center of the circle or circular arc. + Radius of the circle or circular arc. + Angle of the start point of the circle or circular arc [rad]. Default: 0.0 + Angle of the end point of the circle or circular arc [rad]. Default: 6.28318 + Point order along the circle or circular arc. Default: "positive" + Row coordinates of the intersection points. + Column coordinates of the intersection points. + + + Calculate the intersection points of two circles or circular arcs + Row coordinate of the center of the first circle or circular arc. + Column coordinate of the center of the first circle or circular arc. + Radius of the first circle or circular arc. + Angle of the start point of the first circle or circular arc [rad]. Default: 0.0 + Angle of the end point of the first circle or circular arc [rad]. Default: 6.28318 + Point order along the first circle or circular arc. Default: "positive" + Row coordinate of the center of the second circle or circular arc. + Column coordinate of the center of the second circle or circular arc. + Radius of the second circle or circular arc. + Angle of the start point of the second circle or circular arc [rad]. Default: 0.0 + Angle of the end point of the second circle or circular arc [rad]. Default: 6.28318 + Point order along the second circle or circular arc. Default: "positive" + Row coordinates of the intersection points. + Column coordinates of the intersection points. + Do both circles or circular arcs have a part in common? + + + Calculate the intersection points of a line and an XLD contour + XLD contour. + Row coordinate of the first point of the line. + Column coordinate of the first point of the line. + Row coordinate of the second point of the line. + Column coordinate of the second point of the line. + Row coordinates of the intersection points. + Column coordinates of the intersection points. + Does a part of the XLD contour lies on the line? + + + Calculate the intersection points of a line and a circle or circular arc + Row coordinate of the first point of the line. + Column coordinate of the first point of the line. + Row coordinate of the second point of the line. + Column coordinate of the second point of the line. + Row coordinate of the center of the circle or circular arc. + Column coordinate of the center of the circle or circular arc. + Radius of the circle or circular arc. + Angle of the start point of the circle or circular arc [rad]. Default: 0.0 + Angle of the end point of the circle or circular arc [rad]. Default: 6.28318 + Point order along the circle or circular arc. Default: "positive" + Row coordinates of the intersection points. + Column coordinates of the intersection points. + + + Calculate the intersection point of two lines + Row coordinate of the first point of the first line. + Column coordinate of the first point of the first line. + Row coordinate of the second point of the first line. + Column coordinate of the second point of the first line. + Row coordinate of the first point of the second line. + Column coordinate of the first point of the second line. + Row coordinate of the second point of the second line. + Column coordinate of the second point of the second line. + Row coordinate of the intersection point. + Column coordinate of the intersection point. + Are both lines identical? + + + Calculate the intersection points of a segment and an XLD contour + XLD contour. + Row coordinate of the first point of the segment. + Column coordinate of the first point of the segment. + Row coordinate of the second point of the segment. + Column coordinate of the second point of the segment. + Row coordinates of the intersection points. + Column coordinates of the intersection points. + Do the segment and the XLD contour have a part in common? + + + Calculate the intersection points of a segment and a circle or circular arc + Row coordinate of the first point of the segment. + Column coordinate of the first point of the segment. + Row coordinate of the second point of the segment. + Column coordinate of the second point of the segment. + Row coordinate of the center of the circle or circular arc. + Column coordinate of the center of the circle or circular arc. + Radius of the circle or circular arc. + Angle of the start point of the circle or circular arc [rad]. Default: 0.0 + Angle of the end point of the circle or circular arc [rad]. Default: 6.28318 + Point order along the circle or circular arc. Default: "positive" + Row coordinates of the intersection points. + Column coordinates of the intersection points. + + + Calculate the intersection point of a segment and a line + Row coordinate of the first point of the segment. + Column coordinate of the first point of the segment. + Row coordinate of the second point of the segment. + Column coordinate of the second point of the segment. + Row coordinate of the first point of the line. + Column coordinate of the first point of the line. + Row coordinate of the second point of the line. + Column coordinate of the second point of the line. + Row coordinate of the intersection point. + Column coordinate of the intersection point. + Do the segment and the line have a part in common? + + + Calculate the intersection point of two line segments + Row coordinate of the first point of the first segment. + Column coordinate of the first point of the first segment. + Row coordinate of the second point of the first segment. + Column coordinate of the second point of the first segment. + Row coordinate of the first point of the second segment. + Column coordinate of the first point of the second segment. + Row coordinate of the second point of the second segment. + Column coordinate of the second point of the second segment. + Row coordinate of the intersection point. + Column coordinate of the intersection point. + Do both segments have a part in common? + + + Clear a XLD distance transform. + Handle of the XLD distance transform. + + + Determine the pointwise distance of two contours using an XLD distance transform. + Contour(s) for whose points the distances are calculated. + Copy of Contour containing the distances as an attribute. + Handle of the XLD distance transform of the reference contour. + + + Read an XLD distance transform from a file. + Name of the file. + Handle of the XLD distance transform. + + + Deserialize an XLD distance transform. + Handle of the serialized XLD distance transform. + Handle of the deserialized XLD distance transform. + + + Serialize an XLD distance transform. + Handle of the XLD distance transform. + Handle of the serialized XLD distance transform. + + + Write an XLD distance transform into a file. + Handle of the XLD distance transform. + Name of the file. + + + Set new parameters for an XLD distance transform. + Handle of the XLD distance transform. + Names of the generic parameters. Default: "mode" + Values of the generic parameters. Default: "point_to_point" + + + Get the parameters used to build an XLD distance transform. + Handle of the XLD distance transform. + Names of the generic parameters. Default: "mode" + Values of the generic parameters. + + + Get the reference contour used to build the XLD distance transform. + Reference contour. + Handle of the XLD distance transform. + + + Create the XLD distance transform. + Reference contour(s). + Compute the distance to points ('point_to_point') or entire segments ('point_to_segment'). Default: "point_to_point" + Maximum distance of interest. Default: 20.0 + Handle of the XLD distance transform. + + + Calculate the pointwise distance from one contour to another. + Contours for whose points the distances are calculated. + Contours to which the distances are calculated to. + Copy of ContourFrom containing the distances as an attribute. + Compute the distance to points ('point_to_point') or to entire segments ('point_to_segment'). Default: "point_to_point" + + + Calculate the minimum distance between two contours. + First input contour. + Second input contour. + Distance calculation mode. Default: "fast_point_to_segment" + Minimum distance between the two contours. + + + Calculate the distance between two contours. + First input contour. + Second input contour. + Distance calculation mode. Default: "point_to_point" + Minimum distance between both contours. + Maximum distance between both contours. + + + Calculate the distance between a line segment and one contour. + Input contour. + Row coordinate of the first point of the line segment. + Column coordinate of the first point of the line segment. + Row coordinate of the second point of the line segment. + Column coordinate of the second point of the line segment. + Minimum distance between the line segment and the contour. + Maximum distance between the line segment and the contour. + + + Calculate the distance between a line and one contour. + Input contour. + Row coordinate of the first point of the line. + Column coordinate of the first point of the line. + Row coordinate of the second point of the line. + Column coordinate of the second point of the line. + Minimum distance between the line and the contour. + Maximum distance between the line and the contour. + + + Calculate the distance between a point and one contour. + Input contour. + Row coordinate of the point. + Column coordinate of the point. + Minimum distance between the point and the contour. + Maximum distance between the point and the contour. + + + Calculate the distance between a line segment and one region. + Input region. + Row coordinate of the first point of the line segment. + Column coordinate of the first point of the line segment. + Row coordinate of the second point of the line segment. + Column coordinate of the second point of the line segment. + Minimum distance between the line segment and the region. + Maximum distance between the line segment and the region. + + + Calculate the distance between a line and a region. + Input region. + Row coordinate of the first point of the line. + Column coordinate of the first point of the line. + Row coordinate of the second point of the line. + Column coordinate of the second point of the line. + Minimum distance between the line and the region + Maximum distance between the line and the region + + + Calculate the distance between a point and a region. + Input region. + Row coordinate of the point. + Column coordinate of the point. + Minimum distance between the point and the region. + Maximum distance between the point and the region. + + + Calculate the angle between one line and the horizontal axis. + Row coordinate the first point of the line. + Column coordinate of the first point of the line. + Row coordinate of the second point of the line. + Column coordinate of the second point of the line. + Angle between the line and the horizontal axis [rad]. + + + Calculate the angle between two lines. + Row coordinate of the first point of the first line. + Column coordinate of the first point of the first line. + Row coordinate of the second point of the first line. + Column coordinate of the second point of the first line. + Row coordinate of the first point of the second line. + Column coordinate of the first point of the second line. + Row coordinate of the second point of the second line. + Column coordinate of the second point of the second line. + Angle between the lines [rad]. + + + Calculate the distances between a line segment and a line. + Row coordinate of the first point of the line segment. + Column coordinate of the first point of the line segment. + Row coordinate of the second point of the line segment. + Column coordinate of the second point of the line segment. + Row coordinate of the first point of the line. + Column coordinate of the first point of the line. + Row coordinate of the second point of the line. + Column coordinate of the second point of the line. + Minimum distance between the line segment and the line. + Maximum distance between the line segment and the line. + + + Calculate the distances between two line segments. + Row coordinate of the first point of the line segment. + Column coordinate of the first point of the line segment. + Row coordinate of the second point of the line segment. + Column coordinate of the second point of the line segment. + Row coordinate of the first point of the line. + Column of the first point of the line. + Row coordinate of the second point of the line. + Column coordinate of the second point of the line. + Minimum distance between the line segments. + Maximum distance between the line segments. + + + Calculate the distances between a point and a line segment. + Row coordinate of the first point. + Column coordinate of the first point. + Row coordinate of the first point of the line segment. + Column coordinate of the first point of the line segment. + Row coordinate of the second point of the line segment. + Column coordinate of the second point of the line segment. + Minimum distance between the point and the line segment. + Maximum distance between the point and the line segment. + + + Calculate the distance between one point and one line. + Row coordinate of the point. + Column of the point. + Row coordinate of the first point of the line. + Column coordinate of the first point of the line. + Row coordinate of the second point of the line. + Column coordinate of the second point of the line. + Distance between the points. + + + Calculate the distance between two points. + Row coordinate of the first point. + Column coordinate of the first point. + Row coordinate of the second point. + Column coordinate of the second point. + Distance between the points. + + + Compose two functions. + Input function 1. + Input function 2. + Border treatment for the input functions. Default: "constant" + Composed function. + + + Calculate the inverse of a function. + Input function. + Inverse of the input function. + + + Calculate the derivatives of a function. + Input function + Type of derivative Default: "first" + Derivative of the input function + + + Calculate the local minimum and maximum points of a function. + Input function + Handling of plateaus Default: "strict_min_max" + Interpolation of the input function Default: "true" + Minimum points of the input function + Maximum points of the input function + + + Calculate the zero crossings of a function. + Input function + Zero crossings of the input function + + + Multiplication and addition of the y values. + Input function. + Factor for scaling of the y values. Default: 2.0 + Constant which is added to the y values. Default: 0.0 + Transformed function. + + + Negation of the y values. + Input function. + Function with the negated y values. + + + Absolute value of the y values. + Input function. + Function with the absolute values of the y values. + + + Return the value of a function at an arbitrary position. + Input function. + X coordinate at which the function should be evaluated. + Border treatment for the input function. Default: "constant" + Y value at the given x value. + + + Access a function value using the index of the control points. + Input function. + Index of the control points. + X value at the given control points. + Y value at the given control points. + + + Number of control points of the function. + Input function. + Number of control points. + + + Smallest and largest y value of the function. + Input function. + Smallest y value. + Largest y value. + + + Smallest and largest x value of the function. + Input function. + Smallest x value. + Largest x value. + + + Access to the x/y values of a function. + Input function. + X values of the function. + Y values of the function. + + + Sample a function equidistantly in an interval. + Input function. + Minimum x value of the output function. + Maximum x value of the output function. + Distance of the samples. + Border treatment for the input function. Default: "constant" + Sampled function. + + + Transform a function using given transformation parameters. + Input function. + Transformation parameters between the functions. + Transformed function. + + + Calculate transformation parameters between two functions. + Function 1. + Function 2. + Border treatment for function 2. Default: "constant" + Values of the parameters to remain constant. Default: [1.0,0.0,1.0,0.0] + Should a parameter be adapted for it? Default: ["true","true","true","true"] + Transformation parameters between the functions. + Quadratic error of the output function. + Covariance Matrix of the transformation parameters. + + + Compute the distance of two functions. + Input function 1. + Input function 2. + Modes of invariants. Default: "length" + Variance of the optional smoothing with a Gaussian filter. Default: 0.0 + Distance of the functions. + + + Smooth an equidistant 1D function with a Gaussian function. + Function to be smoothed. + Sigma of the Gaussian function for the smoothing. Default: 2.0 + Smoothed function. + + + Compute the positive and negative areas of a function. + Input function. + Area under the positive part of the function. + Area under the negative part of the function. + + + Read a function from a file. + Name of the file to be read. + Function from the file. + + + Write a function to a file. + Function to be written. + Name of the file to be written. + + + Create a function from a sequence of y-values. + X value for function points. + Created function. + + + Create a function from a set of (x,y) pairs. + X value for function points. + Y-value for function points. + Created function. + + + Smooth an equidistant 1D function by averaging its values. + 1D function. + Size of the averaging mask. Default: 9 + Number of iterations for the smoothing. Default: 3 + Smoothed function. + + + Filter an image using a Laws texture filter. + Images to which the texture transformation is to be applied. + Texture images. + Desired filter. Default: "el" + Shift to reduce the gray value dynamics. Default: 2 + Size of the filter kernel. Default: 5 + + + Calculate the standard deviation of gray values within rectangular windows. + Image for which the standard deviation is to be calculated. + Image containing the standard deviation. + Width of the mask in which the standard deviation is calculated. Default: 11 + Height of the mask in which the standard deviation is calculated. Default: 11 + + + Calculate the entropy of gray values within a rectangular window. + Image for which the entropy is to be calculated. + Entropy image. + Width of the mask in which the entropy is calculated. Default: 9 + Height of the mask in which the entropy is calculated. Default: 9 + + + Perform an isotropic diffusion of an image. + Input image. + Output image. + Standard deviation of the Gauss distribution. Default: 1.0 + Number of iterations. Default: 10 + + + Perform an anisotropic diffusion of an image. + Input image. + Output image. + Diffusion coefficient as a function of the edge amplitude. Default: "weickert" + Contrast parameter. Default: 5.0 + Time step. Default: 1.0 + Number of iterations. Default: 10 + + + Smooth an image using various filters. + Image to be smoothed. + Smoothed image. + Filter. Default: "deriche2" + Filterparameter: small values cause strong smoothing (vice versa by using bei 'gauss'). Default: 0.5 + + + Non-linear smoothing with the sigma filter. + Image to be smoothed. + Smoothed image. + Height of the mask (number of lines). Default: 5 + Width of the mask (number of columns). Default: 5 + Max. deviation to the average. Default: 3 + + + Calculate the average of maximum and minimum inside any mask. + Image to be filtered. + Filter mask. + Filtered image. + Border treatment. Default: "mirrored" + + + Smooth an image with an arbitrary rank mask. + Image to be filtered. + Image whose region serves as filter mask. + Filtered output image. + Number of averaged pixels. Typical value: Surface(Mask) / 2. Default: 5 + Border treatment. Default: "mirrored" + + + Separated median filtering with rectangle masks. + Image to be filtered. + Median filtered image. + Width of rank mask. Default: 25 + Height of rank mask. Default: 25 + Border treatment. Default: "mirrored" + + + Compute a median filter with rectangular masks. + Image to be filtered. + Filtered image. + Width of the filter mask. Default: 15 + Height of the filter mask. Default: 15 + + + Compute a median filter with various masks. + Image to be filtered. + Filtered image. + Filter mask type. Default: "circle" + Radius of the filter mask. Default: 1 + Border treatment. Default: "mirrored" + + + Weighted median filtering with different rank masks. + Image to be filtered. + Median filtered image. + Type of median mask. Default: "inner" + mask size. Default: 3 + + + Compute a rank filter with rectangular masks. + Image to be filtered. + Filtered image. + Width of the filter mask. Default: 15 + Height of the filter mask. Default: 15 + Rank of the output gray value. Default: 5 + + + Compute a rank filter with arbitrary masks. + Image to be filtered. + Filter mask. + Filtered image. + Rank of the output gray value. Default: 5 + Border treatment. Default: "mirrored" + + + Opening, Median and Closing with circle or rectangle mask. + Image to be filtered. + Filtered Image. + Shape of the mask. Default: "circle" + Radius of the filter mask. Default: 1 + Filter Mode: 0 corresponds to a gray value opening , 50 corresponds to a median and 100 to a gray values closing. Default: 10 + Border treatment. Default: "mirrored" + + + Smooth by averaging. + Image to be smoothed. + Smoothed image. + Width of filter mask. Default: 9 + Height of filter mask. Default: 9 + + + Information on smoothing filter smooth_image. + Name of required filter. Default: "deriche2" + Filter parameter: small values effect strong smoothing (reversed in case of 'gauss'). Default: 0.5 + Width of filter is approx. size x size pixels. + In case of gauss filter: coefficients of the "positive" half of the 1D impulse answer. + + + Smooth an image using the binomial filter. + Input image. + Smoothed image. + Filter width. Default: 5 + Filter height. Default: 5 + + + Smooth an image using discrete Gaussian functions. + Image to be smoothed. + Filtered image. + Required filter size. Default: 5 + + + Smooth using discrete gauss functions. + Image to be smoothed. + Filtered image. + Required filter size. Default: 5 + + + Smooth an image in the spatial domain to suppress noise. + Image to smooth. + Smoothed image. + Width of filter mask. Default: 3 + Height of filter mask. Default: 3 + Gap between local maximum/minimum and all other gray values of the neighborhood. Default: 1.0 + Replacement rule (1 = next minimum/maximum, 2 = average, 3 =median). Default: 3 + + + Interpolate 2 video half images. + Gray image consisting of two half images. + Full image with interpolated/removed lines. + Instruction whether even or odd lines should be replaced/removed. Default: "odd" + + + Return gray values with given rank from multiple channels. + Multichannel gray image. + Result of the rank function. + Rank of the gray value images to return. Default: 2 + + + Average gray values over several channels. + Multichannel gray image. + Result of averaging. + + + Replace values outside of thresholds with average value. + Input image. + Smoothed image. + Width of filter mask. Default: 3 + Height of filter mask. Default: 3 + Minimum gray value. Default: 1 + Maximum gray value. Default: 254 + + + Suppress salt and pepper noise. + Input image. + Smoothed image. + Width of filter mask. Default: 3 + Height of filter mask. Default: 3 + Minimum gray value. Default: 1 + Maximum gray value. Default: 254 + + + Find corners using the Sojka operator. + Input image. + Required filter size. Default: 9 + Sigma of the weight function according to the distance to the corner candidate. Default: 2.5 + Sigma of the weight function for the distance to the ideal gray value edge. Default: 0.75 + Threshold for the magnitude of the gradient. Default: 30.0 + Threshold for Apparentness. Default: 90.0 + Threshold for the direction change in a corner point (radians). Default: 0.5 + Subpixel precise calculation of the corner points. Default: "false" + Row coordinates of the detected corner points. + Column coordinates of the detected corner points. + + + Enhance circular dots in an image. + Input image. + Output image. + Diameter of the dots to be enhanced. Default: 5 + Enhance dark, light, or all dots. Default: "light" + Shift of the filter response. Default: 0 + + + Subpixel precise detection of local minima in an image. + Input image. + Method for the calculation of the partial derivatives. Default: "facet" + Sigma of the Gaussian. If Filter is 'facet', Sigma may be 0.0 to avoid the smoothing of the input image. + Minimum absolute value of the eigenvalues of the Hessian matrix. Default: 5.0 + Row coordinates of the detected minima. + Column coordinates of the detected minima. + + + Subpixel precise detection of local maxima in an image. + Input image. + Method for the calculation of the partial derivatives. Default: "facet" + Sigma of the Gaussian. If Filter is 'facet', Sigma may be 0.0 to avoid the smoothing of the input image. + Minimum absolute value of the eigenvalues of the Hessian matrix. Default: 5.0 + Row coordinates of the detected maxima. + Column coordinates of the detected maxima. + + + Subpixel precise detection of saddle points in an image. + Input image. + Method for the calculation of the partial derivatives. Default: "facet" + Sigma of the Gaussian. If Filter is 'facet', Sigma may be 0.0 to avoid the smoothing of the input image. + Minimum absolute value of the eigenvalues of the Hessian matrix. Default: 5.0 + Row coordinates of the detected saddle points. + Column coordinates of the detected saddle points. + + + Subpixel precise detection of critical points in an image. + Input image. + Method for the calculation of the partial derivatives. Default: "facet" + Sigma of the Gaussian. If Filter is 'facet', Sigma may be 0.0 to avoid the smoothing of the input image. + Minimum absolute value of the eigenvalues of the Hessian matrix. Default: 5.0 + Row coordinates of the detected minima. + Column coordinates of the detected minima. + Row coordinates of the detected maxima. + Column coordinates of the detected maxima. + Row coordinates of the detected saddle points. + Column coordinates of the detected saddle points. + + + Detect points of interest using the Harris operator. + Input image. + Amount of smoothing used for the calculation of the gradient. Default: 0.7 + Amount of smoothing used for the integration of the gradients. Default: 2.0 + Weight of the squared trace of the squared gradient matrix. Default: 0.08 + Minimum filter response for the points. Default: 1000.0 + Row coordinates of the detected points. + Column coordinates of the detected points. + + + Detect points of interest using the binomial approximation of the Harris operator. + Input image. + Amount of binomial smoothing used for the calculation of the gradient. Default: 5 + Amount of smoothing used for the integration of the gradients. Default: 15 + Weight of the squared trace of the squared gradient matrix. Default: 0.08 + Minimum filter response for the points. Default: 1000.0 + Turn on or off subpixel refinement. Default: "on" + Row coordinates of the detected points. + Column coordinates of the detected points. + + + Detect points of interest using the Lepetit operator. + Input image. + Radius of the circle. Default: 3 + Number of checked neighbors on the circle. Default: 1 + Threshold of grayvalue difference to each circle point. Default: 15 + Threshold of grayvalue difference to all circle points. Default: 30 + Subpixel accuracy of point coordinates. Default: "interpolation" + Row-coordinates of the detected points. + Column-coordinates of the detected points. + + + Detect points of interest using the Foerstner operator. + Input image. + Amount of smoothing used for the calculation of the gradient. If Smoothing is 'mean', SigmaGrad is ignored. Default: 1.0 + Amount of smoothing used for the integration of the gradients. Default: 2.0 + Amount of smoothing used in the optimization functions. Default: 3.0 + Threshold for the segmentation of inhomogeneous image areas. Default: 200 + Threshold for the segmentation of point areas. Default: 0.3 + Used smoothing method. Default: "gauss" + Elimination of multiply detected points. Default: "false" + Row coordinates of the detected junction points. + Column coordinates of the detected junction points. + Row part of the covariance matrix of the detected junction points. + Mixed part of the covariance matrix of the detected junction points. + Column part of the covariance matrix of the detected junction points. + Row coordinates of the detected area points. + Column coordinates of the detected area points. + Row part of the covariance matrix of the detected area points. + Mixed part of the covariance matrix of the detected area points. + Column part of the covariance matrix of the detected area points. + + + Estimate the image noise from a single image. + Input image. + Method to estimate the image noise. Default: "foerstner" + Percentage of used image points. Default: 20 + Standard deviation of the image noise. + + + Determine the noise distribution of an image. + Region from which the noise distribution is to be estimated. + Corresponding image. + Size of the mean filter. Default: 21 + Noise distribution of all input regions. + + + Add noise to an image. + Input image. + Noisy image. + Maximum noise amplitude. Default: 60.0 + + + Add noise to an image. + Input image. + Noisy image. + Noise distribution. + + + Generate a Gaussian noise distribution. + Standard deviation of the Gaussian noise distribution. Default: 2.0 + Resulting Gaussian noise distribution. + + + Generate a salt-and-pepper noise distribution. + Percentage of salt (white noise pixels). Default: 5.0 + Percentage of pepper (black noise pixels). Default: 5.0 + Resulting noise distribution. + + + Calculate standard deviation over several channels. + Multichannel gray image. + Result of calculation. + + + Perform an inpainting by texture propagation. + Input image. + Inpainting region. + Output image. + Size of the inpainting blocks. Default: 9 + Size of the search window. Default: 30 + Influence of the edge amplitude on the inpainting order. Default: 1.0 + Post-iteration for artifact reduction. Default: "none" + Gray value tolerance for post-iteration. Default: 1.0 + + + Perform an inpainting by coherence transport. + Input image. + Inpainting region. + Output image. + Radius of the pixel neighborhood. Default: 5.0 + Sharpness parameter in percent. Default: 25.0 + Pre-smoothing parameter. Default: 1.41 + Smoothing parameter for the direction estimation. Default: 4.0 + Channel weights. Default: 1 + + + Perform an inpainting by smoothing of level lines. + Input image. + Inpainting region. + Output image. + Smoothing for derivative operator. Default: 0.5 + Time step. Default: 0.5 + Number of iterations. Default: 10 + + + Perform an inpainting by coherence enhancing diffusion. + Input image. + Inpainting region. + Output image. + Smoothing for derivative operator. Default: 0.5 + Smoothing for diffusion coefficients. Default: 3.0 + Time step. Default: 0.5 + Number of iterations. Default: 10 + + + Perform an inpainting by anisotropic diffusion. + Input image. + Inpainting region. + Output image. + Type of edge sharpening algorithm. Default: "weickert" + Contrast parameter. Default: 5.0 + Step size. Default: 0.5 + Number of iterations. Default: 10 + Smoothing coefficient for edge information. Default: 3.0 + + + Perform a harmonic interpolation on an image region. + Input image. + Inpainting region. + Output image. + Computational accuracy. Default: 0.001 + + + Expand the domain of an image and set the gray values in the expanded domain. + Input image with domain to be expanded. + Output image with new gray values in the expanded domain. + Radius of the gray value expansion, measured in pixels. Default: 2 + + + Compute the topographic primal sketch of an image. + Image for which the topographic primal sketch is to be computed. + Label image containing the 11 classes. + + + Compute an affine transformation of the color values of a multichannel image. + Multichannel input image. + Multichannel output image. + Transformation matrix for the color values. + + + Compute the transformation matrix of the principal component analysis of multichannel images. + Multichannel input image. + Transformation matrix for the computation of the PCA. + Transformation matrix for the computation of the inverse PCA. + Mean gray value of the channels. + Covariance matrix of the channels. + Information content of the transformed channels. + + + Compute the principal components of multichannel images. + Multichannel input image. + Multichannel output image. + Information content of each output channel. + + + Determine the fuzzy entropy of regions. + Regions for which the fuzzy entropy is to be calculated. + Input image containing the fuzzy membership values. + Start of the fuzzy function. Default: 0 + End of the fuzzy function. Default: 255 + Fuzzy entropy of a region. + + + Calculate the fuzzy perimeter of a region. + Regions for which the fuzzy perimeter is to be calculated. + Input image containing the fuzzy membership values. + Start of the fuzzy function. Default: 0 + End of the fuzzy function. Default: 255 + Fuzzy perimeter of a region. + + + Perform a gray value closing with a selected mask. + Image for which the minimum gray values are to be calculated. + Image containing the minimum gray values. + Height of the filter mask. Default: 11 + Width of the filter mask. Default: 11 + Shape of the mask. Default: "octagon" + + + Perform a gray value opening with a selected mask. + Image for which the minimum gray values are to be calculated. + Image containing the minimum gray values. + Height of the filter mask. Default: 11 + Width of the filter mask. Default: 11 + Shape of the mask. Default: "octagon" + + + Determine the minimum gray value within a selected mask. + Image for which the minimum gray values are to be calculated. + Image containing the minimum gray values. + Height of the filter mask. Default: 11 + Width of the filter mask. Default: 11 + Shape of the mask. Default: "octagon" + + + Determine the maximum gray value within a selected mask. + Image for which the maximum gray values are to be calculated. + Image containing the maximum gray values. + Height of the filter mask. Default: 11 + Width of the filter mask. Default: 11 + Shape of the mask. Default: "octagon" + + + Determine the gray value range within a rectangle. + Image for which the gray value range is to be calculated. + Image containing the gray value range. + Height of the filter mask. Default: 11 + Width of the filter mask. Default: 11 + + + Perform a gray value closing with a rectangular mask. + Input image. + Gray-closed image. + Height of the filter mask. Default: 11 + Width of the filter mask. Default: 11 + + + Perform a gray value opening with a rectangular mask. + Input image. + Gray-opened image. + Height of the filter mask. Default: 11 + Width of the filter mask. Default: 11 + + + Determine the minimum gray value within a rectangle. + Image for which the minimum gray values are to be calculated. + Image containing the minimum gray values. + Height of the filter mask. Default: 11 + Width of the filter mask. Default: 11 + + + Determine the maximum gray value within a rectangle. + Image for which the maximum gray values are to be calculated. + Image containing the maximum gray values. + Height of the filter mask. Default: 11 + Width of the filter mask. Default: 11 + + + Thinning of gray value images. + Image to be thinned. + Thinned image. + + + Transform an image with a gray-value look-up-table + Image whose gray values are to be transformed. + Transformed image. + Table containing the transformation. + + + Calculate the correlation between an image and an arbitrary filter mask + Images for which the correlation will be calculated. + Result of the correlation. + Filter mask as file name or tuple. Default: "sobel" + Border treatment. Default: "mirrored" + + + Convert the type of an image. + Image whose image type is to be changed. + Converted image. + Desired image type (i.e., type of the gray values). Default: "byte" + + + Convert two real-valued images into a vector field image. + Vector component in the row direction. + Vector component in the column direction. + Displacement vector field. + Semantic kind of the vector field. Default: "vector_field_relative" + + + Convert a vector field image into two real-valued images. + Vector field. + Vector component in the row direction. + Vector component in the column direction. + + + Convert two real images into a complex image. + Real part. + Imaginary part. + Complex image. + + + Convert a complex image into two real images. + Complex image. + Real part. + Imaginary part. + + + Paint regions with their average gray value. + Input regions. + original gray-value image. + Result image with painted regions. + + + Calculate the lowest possible gray value on an arbitrary path to the image border for each point in the image. + Image being processed. + Result image. + + + Symmetry of gray values along a row. + Input image. + Symmetry image. + Extension of search area. Default: 40 + Angle of test direction. Default: 0.0 + Exponent for weighting. Default: 0.5 + + + Selection of gray values of a multi-channel image using an index image. + Multi-channel gray value image. + Image, where pixel values are interpreted as channel index. + Resulting image. + + + Extract depth using multiple focus levels. + Multichannel gray image consisting of multiple focus levels. + Depth image. + Confidence of depth estimation. + Filter used to find sharp pixels. Default: "highpass" + Method used to find sharp pixels. Default: "next_maximum" + + + Compute the calibrated scene flow between two stereo image pairs. + Input image 1 at time @f$t_{1}$t_1. + Input image 2 at time @f$t_{1}$t_1. + Input image 1 at time @f$t_{2}$t_2. + Input image 2 at time @f$t_{2}$t_2. + Disparity between input images 1 and 2 at time @f$t_{1}$t_1. + Weight of the regularization term relative to the data term (derivatives of the optical flow). Default: 40.0 + Weight of the regularization term relative to the data term (derivatives of the disparity change). Default: 40.0 + Parameter name(s) for the algorithm. Default: "default_parameters" + Parameter value(s) for the algorithm. Default: "accurate" + Internal camera parameters of the rectified camera 1. + Internal camera parameters of the rectified camera 2. + Pose of the rectified camera 2 in relation to the rectified camera 1. + Handle of the 3D object model. + + + Compute the uncalibrated scene flow between two stereo image pairs. + Input image 1 at time @f$t_{1}$t_1. + Input image 2 at time @f$t_{1}$t_1. + Input image 1 at time @f$t_{2}$t_2. + Input image 2 at time @f$t_{2}$t_2. + Disparity between input images 1 and 2 at time @f$t_{1}$t_1. + Estimated optical flow. + Estimated change in disparity. + Weight of the regularization term relative to the data term (derivatives of the optical flow). Default: 40.0 + Weight of the regularization term relative to the data term (derivatives of the disparity change). Default: 40.0 + Parameter name(s) for the algorithm. Default: "default_parameters" + Parameter value(s) for the algorithm. Default: "accurate" + + + Unwarp an image using a vector field. + Input image. + Input vector field. + Unwarped image. + + + Convolve a vector field with derivatives of the Gaussian. + Input vector field. + Filtered result images. + Sigma of the Gaussian. Default: 1.0 + Component to be calculated. Default: "mean_curvature" + + + Compute the length of the vectors of a vector field. + Input vector field + Length of the vectors of the vector field. + Mode for computing the length of the vectors. Default: "length" + + + Compute the optical flow between two images. + Input image 1. + Input image 2. + Optical flow. + Algorithm for computing the optical flow. Default: "fdrig" + Standard deviation for initial Gaussian smoothing. Default: 0.8 + Standard deviation of the integration filter. Default: 1.0 + Weight of the smoothing term relative to the data term. Default: 20.0 + Weight of the gradient constancy relative to the gray value constancy. Default: 5.0 + Parameter name(s) for the multigrid algorithm. Default: "default_parameters" + Parameter value(s) for the multigrid algorithm. Default: "accurate" + + + Matching a template and an image in a resolution pyramid. + Input image. + The domain of this image will be matched with Image. + Result image and result region: values of the matching criterion within the determined "region of interest". + Desired matching criterion. Default: "dfd" + Startlevel in the resolution pyramid (highest resolution: Level 0). Default: 1 + Threshold to determine the "region of interest". Default: 30 + + + Preparing a pattern for template matching with rotation. + Input image whose domain will be processed for the pattern matching. + Maximal number of pyramid levels. Default: 4 + Smallest Rotation of the pattern. Default: -0.39 + Maximum positive Extension of AngleStart. Default: 0.79 + Step rate (angle precision) of matching. Default: 0.0982 + Kind of optimizing. Default: "sort" + Kind of grayvalues. Default: "original" + Template number. + + + Preparing a pattern for template matching. + Input image whose domain will be processed for the pattern matching. + Not yet in use. Default: 255 + Maximal number of pyramid levels. Default: 4 + Kind of optimizing. Default: "sort" + Kind of grayvalues. Default: "original" + Template number. + + + Serialize a template. + Handle of the template. + Handle of the serialized item. + + + Deserialize a serialized template. + Handle of the serialized item. + Template number. + + + Writing a template to file. + Template number. + file name. + + + Reading a template from file. + file name. + Template number. + + + This operator is inoperable. It had the following function: Deallocation of the memory of all templates. + + + Deallocation of the memory of a template. + Template number. + + + Gray value offset for template. + Template number. + Offset of gray values. Default: 0 + + + Define reference position for a matching template. + Template number. + Reference position of template (row). + Reference position of template (column). + + + Adapting a template to the size of an image. + Image which determines the size of the later matching. + Template number. + + + Searching all good gray value matches in a pyramid. + Input image inside of which the pattern has to be found. + All points which have an error below a certain threshold. + Template number. + Maximal average difference of the grayvalues. Default: 30.0 + Number of levels in the pyramid. Default: 3 + + + Searching the best gray value matches in a pre generated pyramid. + Image pyramid inside of which the pattern has to be found. + Template number. + Maximal average difference of the grayvalues. Default: 30.0 + Exactness in subpixels in case of 'true'. Default: "false" + Number of the used resolution levels. Default: 3 + Resolution level up to which the method "best match" is used. Default: "original" + Row position of the best match. + Column position of the best match. + Average divergence of the grayvalues in the best match. + + + Searching the best gray value matches in a pyramid. + Input image inside of which the pattern has to be found. + Template number. + Maximal average difference of the grayvalues. Default: 30.0 + Exactness in subpixels in case of 'true'. Default: "false" + Number of the used resolution levels. Default: 4 + Resolution level up to which the method "best match" is used. Default: 2 + Row position of the best match. + Column position of the best match. + Average divergence of the grayvalues in the best match. + + + Searching all good matches of a template and an image. + Input image inside of which the pattern has to be found. + All points whose error lies below a certain threshold. + Template number. + Maximal average difference of the grayvalues. Default: 20.0 + + + Searching the best matching of a template and a pyramid with rotation. + Input image inside of which the pattern has to be found. + Template number. + Smallest Rotation of the pattern. Default: -0.39 + Maximum positive Extension of AngleStart. Default: 0.79 + Maximum average difference of the grayvalues. Default: 40.0 + Subpixel accuracy in case of 'true'. Default: "false" + Number of the used resolution levels. Default: 3 + Row position of the best match. + Column position of the best match. + Rotation angle of pattern. + Average divergence of the grayvalues of the best match. + + + Searching the best matching of a template and an image with rotation. + Input image inside of which the pattern has to be found. + Template number. + Smallest Rotation of the pattern. Default: -0.39 + Maximum positive Extension of AngleStart. Default: 0.79 + Maximum average difference of the grayvalues. Default: 30.0 + Subpixel accuracy in case of 'true'. Default: "false" + Row position of the best match. + Column position of the best match. + Rotation angle of pattern. + Average divergence of the grayvalues of the best match. + + + Searching the best matching of a template and an image. + Input image inside of which the pattern has to be found. + Template number. + Maximum average difference of the grayvalues. Default: 20.0 + Subpixel accuracy in case of 'true'. Default: "false" + Row position of the best match. + Column position of the best match. + Average divergence of the grayvalues of the best match. + + + Matching of a template and an image. + Input image. + Area to be searched in the input image. + This area will be "matched" by Image within the RegionOfInterest. + Result image: values of the matching criterion. + Desired matching criterion. Default: "dfd" + + + Searching corners in images. + Input image. + Result of the filtering. + Desired filtersize of the graymask. Default: 3 + Weighting. Default: 0.04 + + + Calculating a Gauss pyramid. + Input image. + Output images. + Kind of filtermask. Default: "weighted" + Factor for scaling down. Default: 0.5 + + + Calculating the monotony operation. + Input image. + Result of the monotony operator. + + + Edge extraction using bandpass filters. + Input images. + Bandpass-filtered images. + Filter type: currently only 'lines' is supported. Default: "lines" + + + Detect color lines and their width. + Input image. + Extracted lines. + Amount of Gaussian smoothing to be applied. Default: 1.5 + Lower threshold for the hysteresis threshold operation. Default: 3 + Upper threshold for the hysteresis threshold operation. Default: 8 + Should the line width be extracted? Default: "true" + Should junctions be added where they cannot be extracted? Default: "true" + + + Detect lines and their width. + Input image. + Extracted lines. + Amount of Gaussian smoothing to be applied. Default: 1.5 + Lower threshold for the hysteresis threshold operation. Default: 3 + Upper threshold for the hysteresis threshold operation. Default: 8 + Extract bright or dark lines. Default: "light" + Should the line width be extracted? Default: "true" + Line model used to correct the line position and width. Default: "bar-shaped" + Should junctions be added where they cannot be extracted? Default: "true" + + + Detection of lines using the facet model. + Input image. + Extracted lines. + Size of the facet model mask. Default: 5 + Lower threshold for the hysteresis threshold operation. Default: 3 + Upper threshold for the hysteresis threshold operation. Default: 8 + Extract bright or dark lines. Default: "light" + + + Store a filter mask in the spatial domain as a real-image. + Filter in the spatial domain. + Filter mask as file name or tuple. Default: "gauss" + Scaling factor. Default: 1.0 + Width of the image (filter). Default: 512 + Height of the image (filter). Default: 512 + + + Generate a mean filter in the frequency domain. + Mean filter as image in the frequency domain. + Shape of the filter mask in the spatial domain. Default: "ellipse" + Diameter of the mean filter in the principal direction of the filter in the spatial domain. Default: 11.0 + Diameter of the mean filter perpendicular to the principal direction of the filter in the spatial domain. Default: 11.0 + Principal direction of the filter in the spatial domain. Default: 0.0 + Normalizing factor of the filter. Default: "none" + Location of the DC term in the frequency domain. Default: "dc_center" + Width of the image (filter). Default: 512 + Height of the image (filter). Default: 512 + + + Generate a Gaussian filter in the frequency domain. + Gaussian filter as image in the frequency domain. + Standard deviation of the Gaussian in the principal direction of the filter in the spatial domain. Default: 1.0 + Standard deviation of the Gaussian perpendicular to the principal direction of the filter in the spatial domain. Default: 1.0 + Principal direction of the filter in the spatial domain. Default: 0.0 + Normalizing factor of the filter. Default: "none" + Location of the DC term in the frequency domain. Default: "dc_center" + Width of the image (filter). Default: 512 + Height of the image (filter). Default: 512 + + + Generate a derivative filter in the frequency domain. + Derivative filter as image in the frequency domain. + Derivative to be computed. Default: "x" + Exponent used in the reverse transform. Default: 1 + Normalizing factor of the filter. Default: "none" + Location of the DC term in the frequency domain. Default: "dc_center" + Width of the image (filter). Default: 512 + Height of the image (filter). Default: 512 + + + Generate a bandpass filter with Gaussian or sinusoidal shape. + Bandpass filter as image in the frequency domain. + Distance of the filter's maximum from the DC term. Default: 0.1 + Bandwidth of the filter (standard deviation). Default: 0.01 + Filter type. Default: "sin" + Normalizing factor of the filter. Default: "none" + Location of the DC term in the frequency domain. Default: "dc_center" + Width of the image (filter). Default: 512 + Height of the image (filter). Default: 512 + + + Generate a bandpass filter with sinusoidal shape. + Bandpass filter as image in the frequency domain. + Distance of the filter's maximum from the DC term. Default: 0.1 + Normalizing factor of the filter. Default: "none" + Location of the DC term in the frequency domain. Default: "dc_center" + Width of the image (filter). Default: 512 + Height of the image (filter). Default: 512 + + + Generate an ideal band filter. + Band filter in the frequency domain. + Minimum frequency. Default: 0.1 + Maximum frequency. Default: 0.2 + Normalizing factor of the filter. Default: "none" + Location of the DC term in the frequency domain. Default: "dc_center" + Width of the image (filter). Default: 512 + Height of the image (filter). Default: 512 + + + Generate an ideal bandpass filter. + Bandpass filter in the frequency domain. + Minimum frequency. Default: 0.1 + Maximum frequency. Default: 0.2 + Normalizing factor of the filter. Default: "none" + Location of the DC term in the frequency domain. Default: "dc_center" + Width of the image (filter). Default: 512 + Height of the image (filter). Default: 512 + + + Generate an ideal lowpass filter. + Lowpass filter in the frequency domain. + Cutoff frequency. Default: 0.1 + Normalizing factor of the filter. Default: "none" + Location of the DC term in the frequency domain. Default: "dc_center" + Width of the image (filter). Default: 512 + Height of the image (filter). Default: 512 + + + Generate an ideal highpass filter. + Highpass filter in the frequency domain. + Cutoff frequency. Default: 0.1 + Normalizing factor of the filter. Default: "none" + Location of the DC term in the frequency domain. Default: "dc_center" + Width of the image (filter). Default: 512 + Height of the image (filter). Default: 512 + + + Return the power spectrum of a complex image. + Input image in frequency domain. + Power spectrum of the input image. + + + Return the power spectrum of a complex image. + Input image in frequency domain. + Power spectrum of the input image. + + + Return the power spectrum of a complex image. + Input image in frequency domain. + Power spectrum of the input image. + + + Return the phase of a complex image in degrees. + Input image in frequency domain. + Phase of the image in degrees. + + + Return the phase of a complex image in radians. + Input image in frequency domain. + Phase of the image in radians. + + + Calculate the energy of a two-channel image. + 1st channel of input image (usually: Gabor image). + 2nd channel of input image (usually: Hilbert image). + Image containing the local energy. + + + Convolve an image with a Gabor filter in the frequency domain. + Input image. + Gabor/Hilbert-Filter. + Result of the Gabor filter. + Result of the Hilbert filter. + + + Generate a Gabor filter. + Gabor and Hilbert filter. + Angle range, inversely proportional to the range of orientations. Default: 1.4 + Distance of the center of the filter to the DC term. Default: 0.4 + Bandwidth range, inversely proportional to the range of frequencies being passed. Default: 1.0 + Angle of the principal orientation. Default: 1.5 + Normalizing factor of the filter. Default: "none" + Location of the DC term in the frequency domain. Default: "dc_center" + Width of the image (filter). Default: 512 + Height of the image (filter). Default: 512 + + + Compute the phase correlation of two images in the frequency domain. + Fourier-transformed input image 1. + Fourier-transformed input image 2. + Phase correlation of the input images in the frequency domain. + + + Compute the correlation of two images in the frequency domain. + Fourier-transformed input image 1. + Fourier-transformed input image 2. + Correlation of the input images in the frequency domain. + + + Convolve an image with a filter in the frequency domain. + Complex input image. + Filter in frequency domain. + Result of applying the filter. + + + Deserialize FFT speed optimization data. + Handle of the serialized item. + + + Serialize FFT speed optimization data. + Handle of the serialized item. + + + Load FFT speed optimization data from a file. + File name of the optimization data. Default: "fft_opt.dat" + + + Store FFT speed optimization data in a file. + File name of the optimization data. Default: "fft_opt.dat" + + + Optimize the runtime of the real-valued FFT. + Width of the image for which the runtime should be optimized. Default: 512 + Height of the image for which the runtime should be optimized. Default: 512 + Thoroughness of the search for the optimum runtime. Default: "standard" + + + Optimize the runtime of the FFT. + Width of the image for which the runtime should be optimized. Default: 512 + Height of the image for which the runtime should be optimized. Default: 512 + Thoroughness of the search for the optimum runtime. Default: "standard" + + + Compute the real-valued fast Fourier transform of an image. + Input image. + Fourier-transformed image. + Calculate forward or reverse transform. Default: "to_freq" + Normalizing factor of the transform. Default: "sqrt" + Image type of the output image. Default: "complex" + Width of the image for which the runtime should be optimized. Default: 512 + + + Compute the inverse fast Fourier transform of an image. + Input image. + Inverse-Fourier-transformed image. + + + Compute the fast Fourier transform of an image. + Input image. + Fourier-transformed image. + + + Compute the fast Fourier transform of an image. + Input image. + Fourier-transformed image. + Calculate forward or reverse transform. Default: "to_freq" + Sign of the exponent. Default: -1 + Normalizing factor of the transform. Default: "sqrt" + Location of the DC term in the frequency domain. Default: "dc_center" + Image type of the output image. Default: "complex" + + + Apply a shock filter to an image. + Input image. + Output image. + Time step. Default: 0.5 + Number of iterations. Default: 10 + Type of edge detector. Default: "canny" + Smoothing of edge detector. Default: 1.0 + + + Apply the mean curvature flow to an image. + Input image. + Output image. + Smoothing parameter for derivative operator. Default: 0.5 + Time step. Default: 0.5 + Number of iterations. Default: 10 + + + Perform a coherence enhancing diffusion of an image. + Input image. + Output image. + Smoothing for derivative operator. Default: 0.5 + Smoothing for diffusion coefficients. Default: 3.0 + Time step. Default: 0.5 + Number of iterations. Default: 10 + + + Histogram linearization of images + Image to be enhanced. + Image with linearized gray values. + + + Illuminate image. + Image to be enhanced. + "`Illuminated"' image. + Width of low pass mask. Default: 101 + Height of low pass mask. Default: 101 + Scales the "`correction gray value"' added to the original gray values. Default: 0.7 + + + Enhance contrast of the image. + Image to be enhanced. + contrast enhanced image. + Width of low pass mask. Default: 7 + Height of the low pass mask. Default: 7 + Intensity of contrast emphasis. Default: 1.0 + + + Maximum gray value spreading in the value range 0 to 255. + Image to be scaled. + contrast enhanced image. + + + Detect edges (amplitude and direction) using the Robinson operator. + Input image. + Edge amplitude (gradient magnitude) image. + Edge direction image. + + + Detect edges (amplitude) using the Robinson operator. + Input image. + Edge amplitude (gradient magnitude) image. + + + Detect edges (amplitude and direction) using the Kirsch operator. + Input image. + Edge amplitude (gradient magnitude) image. + Edge direction image. + + + Detect edges (amplitude) using the Kirsch operator. + Input image. + Edge amplitude (gradient magnitude) image. + + + Detect edges (amplitude and direction) using the Frei-Chen operator. + Input image. + Edge amplitude (gradient magnitude) image. + Edge direction image. + + + Detect edges (amplitude) using the Frei-Chen operator. + Input image. + Edge amplitude (gradient magnitude) image. + + + Detect edges (amplitude and direction) using the Prewitt operator. + Input image. + Edge amplitude (gradient magnitude) image. + Edge direction image. + + + Detect edges (amplitude) using the Prewitt operator. + Input image. + Edge amplitude (gradient magnitude) image. + + + Detect edges (amplitude) using the Sobel operator. + Input image. + Edge amplitude (gradient magnitude) image. + Filter type. Default: "sum_abs" + Size of filter mask. Default: 3 + + + Detect edges (amplitude and direction) using the Sobel operator. + Input image. + Edge amplitude (gradient magnitude) image. + Edge direction image. + Filter type. Default: "sum_abs" + Size of filter mask. Default: 3 + + + Detect edges using the Roberts filter. + Input image. + Roberts-filtered result images. + Filter type. Default: "gradient_sum" + + + Calculate the Laplace operator by using finite differences. + Input image. + Laplace-filtered result image. + Type of the result image, whereas for byte and uint2 the absolute value is used. Default: "absolute" + Size of filter mask. Default: 3 + Filter mask used in the Laplace operator Default: "n_4" + + + Extract high frequency components from an image. + Input image. + High-pass-filtered result image. + Width of the filter mask. Default: 9 + Height of the filter mask. Default: 9 + + + Return the filter coefficients of a filter in edges_image. + Name of the edge operator. Default: "lanser2" + 1D edge filter ('edge') or 1D smoothing filter ('smooth'). Default: "edge" + Filter parameter: small values result in strong smoothing, and thus less detail (opposite for 'canny'). Default: 0.5 + Filter width in pixels. + For Canny filters: Coefficients of the "positive" half of the 1D impulse response. All others: Coefficients of a corresponding non-recursive filter. + + + Extract subpixel precise color edges using Deriche, Shen, or Canny filters. + Input image. + Extracted edges. + Edge operator to be applied. Default: "canny" + Filter parameter: small values result in strong smoothing, and thus less detail (opposite for 'canny'). Default: 1.0 + Lower threshold for the hysteresis threshold operation. Default: 20 + Upper threshold for the hysteresis threshold operation. Default: 40 + + + Extract color edges using Canny, Deriche, or Shen filters. + Input image. + Edge amplitude (gradient magnitude) image. + Edge direction image. + Edge operator to be applied. Default: "canny" + Filter parameter: small values result in strong smoothing, and thus less detail (opposite for 'canny'). Default: 1.0 + Non-maximum suppression ('none', if not desired). Default: "nms" + Lower threshold for the hysteresis threshold operation (negative if no thresholding is desired). Default: 20 + Upper threshold for the hysteresis threshold operation (negative if no thresholding is desired). Default: 40 + + + Extract sub-pixel precise edges using Deriche, Lanser, Shen, or Canny filters. + Input image. + Extracted edges. + Edge operator to be applied. Default: "canny" + Filter parameter: small values result in strong smoothing, and thus less detail (opposite for 'canny'). Default: 1.0 + Lower threshold for the hysteresis threshold operation. Default: 20 + Upper threshold for the hysteresis threshold operation. Default: 40 + + + Extract edges using Deriche, Lanser, Shen, or Canny filters. + Input image. + Edge amplitude (gradient magnitude) image. + Edge direction image. + Edge operator to be applied. Default: "canny" + Filter parameter: small values result in strong smoothing, and thus less detail (opposite for 'canny'). Default: 1.0 + Non-maximum suppression ('none', if not desired). Default: "nms" + Lower threshold for the hysteresis threshold operation (negative, if no thresholding is desired). Default: 20 + Upper threshold for the hysteresis threshold operation (negative, if no thresholding is desired). Default: 40 + + + Convolve an image with derivatives of the Gaussian. + Input images. + Filtered result images. + Sigma of the Gaussian. Default: 1.0 + Derivative or feature to be calculated. Default: "x" + + + LoG-Operator (Laplace of Gaussian). + Input image. + Laplace filtered image. + Smoothing parameter of the Gaussian. Default: 2.0 + + + Approximate the LoG operator (Laplace of Gaussian). + Input image + LoG image. + Smoothing parameter of the Laplace operator to approximate. Default: 3.0 + Ratio of the standard deviations used (Marr recommends 1.6). Default: 1.6 + + + Close edge gaps using the edge amplitude image. + Region containing one pixel thick edges. + Edge amplitude (gradient) image. + Region containing closed edges. + Minimum edge amplitude. Default: 16 + Maximal number of points by which edges are extended. Default: 3 + + + Close edge gaps using the edge amplitude image. + Region containing one pixel thick edges. + Edge amplitude (gradient) image. + Region containing closed edges. + Minimum edge amplitude. Default: 16 + + + Detect straight edge segments. + Input image. + Mask size of the Sobel operator. Default: 5 + Minimum edge strength. Default: 32 + Maximum distance of the approximating line to its original edge. Default: 3 + Minimum length of to resulting line segments. Default: 10 + Row coordinate of the line segments' start points. + Column coordinate of the line segments' start points. + Row coordinate of the line segments' end points. + Column coordinate of the line segments' end points. + + + This operator is inoperable. It had the following function: Delete all look-up-tables of the color space transformation. + + + Release the look-up-table needed for color space transformation. + Handle of the look-up-table handle for the color space transformation. + + + Color space transformation using pre-generated look-up-table. + Input image (channel 1). + Input image (channel 2). + Input image (channel 3). + Color-transformed output image (channel 1). + Color-transformed output image (channel 2). + Color-transformed output image (channel 3). + Handle of the look-up-table for the color space transformation. + + + Creates the look-up-table for transformation of an image from the RGB color space to an arbitrary color space. + Color space of the output image. Default: "hsv" + Direction of color space transformation. Default: "from_rgb" + Number of bits of the input image. Default: 8 + Handle of the look-up-table for color space transformation. + + + Convert a single-channel color filter array image into an RGB image. + Input image. + Output image. + Color filter array type. Default: "bayer_gb" + Interpolation type. Default: "bilinear" + + + Transform an RGB image into a gray scale image. + Three-channel RBG image. + Gray scale image. + + + Transform an RGB image to a gray scale image. + Input image (red channel). + Input image (green channel). + Input image (blue channel). + Gray scale image. + + + Transform an image from the RGB color space to an arbitrary color space. + Input image (red channel). + Input image (green channel). + Input image (blue channel). + Color-transformed output image (channel 1). + Color-transformed output image (channel 1). + Color-transformed output image (channel 1). + Color space of the output image. Default: "hsv" + + + Transform an image from an arbitrary color space to the RGB color space. + Input image (channel 1). + Input image (channel 2). + Input image (channel 3). + Red channel. + Green channel. + Blue channel. + Color space of the input image. Default: "hsv" + + + Logical "AND" of each pixel using a bit mask. + Input image(s). + Result image(s) by combination with mask. + Bit field Default: 128 + + + Extract a bit from the pixels. + Input image(s). + Result image(s) by extraction. + Bit to be selected. Default: 8 + + + Right shift of all pixels of the image. + Input image(s). + Result image(s) by shift operation. + shift value Default: 3 + + + Left shift of all pixels of the image. + Input image(s). + Result image(s) by shift operation. + Shift value. Default: 3 + + + Complement all bits of the pixels. + Input image(s). + Result image(s) by complement operation. + + + Bit-by-bit XOR of all pixels of the input images. + Input image(s) 1. + Input image(s) 2. + Result image(s) by XOR-operation. + + + Bit-by-bit OR of all pixels of the input images. + Input image(s) 1. + Input image(s) 2. + Result image(s) by OR-operation. + + + Bit-by-bit AND of all pixels of the input images. + Input image(s) 1. + Input image(s) 2. + Result image(s) by AND-operation. + + + Perform a gamma encoding or decoding of an image. + Input image. + Output image. + Gamma coefficient of the exponential part of the transformation. Default: 0.416666666667 + Offset of the exponential part of the transformation. Default: 0.055 + Gray value for which the transformation switches from linear to exponential. Default: 0.0031308 + Maximum gray value of the input image type. Default: 255.0 + If 'true', perform a gamma encoding, otherwise a gamma decoding. Default: "true" + + + Raise an image to a power. + Input image. + Output image. + Power to which the gray values are raised. Default: 2 + + + Calculate the exponentiation of an image. + Input image. + Output image. + Base of the exponentiation. Default: "e" + + + Calculate the logarithm of an image. + Input image. + Output image. + Base of the logarithm. Default: "e" + + + Calculate the arctangent of two images. + Input image 1. + Input image 2. + Output image. + + + Calculate the arctangent of an image. + Input image. + Output image. + + + Calculate the arccosine of an image. + Input image. + Output image. + + + Calculate the arcsine of an image. + Input image. + Output image. + + + Calculate the tangent of an image. + Input image. + Output image. + + + Calculate the cosine of an image. + Input image. + Output image. + + + Calculate the sine of an image. + Input image. + Output image. + + + Calculate the absolute difference of two images. + Input image 1. + Input image 2. + Absolute value of the difference of the input images. + Scale factor. Default: 1.0 + + + Calculate the square root of an image. + Input image + Output image + + + Subtract two images. + Minuend(s). + Subtrahend(s). + Result image(s) by the subtraction. + Correction factor. Default: 1.0 + Correction value. Default: 128.0 + + + Scale the gray values of an image. + Image(s) whose gray values are to be scaled. + Result image(s) by the scale. + Scale factor. Default: 0.01 + Offset. Default: 0 + + + Divide two images. + Image(s) 1. + Image(s) 2. + Result image(s) by the division. + Factor for gray range adaption. Default: 255 + Value for gray range adaption. Default: 0 + + + Multiply two images. + Image(s) 1. + Image(s) 2. + Result image(s) by the product. + Factor for gray range adaption. Default: 0.005 + Value for gray range adaption. Default: 0 + + + Add two images. + Image(s) 1. + Image(s) 2. + Result image(s) by the addition. + Factor for gray value adaption. Default: 0.5 + Value for gray value range adaption. Default: 0 + + + Calculate the absolute value (modulus) of an image. + Image(s) for which the absolute gray values are to be calculated. + Result image(s). + + + Calculate the minimum of two images pixel by pixel. + Image(s) 1. + Image(s) 2. + Result image(s) by the minimization. + + + Calculate the maximum of two images pixel by pixel. + Image(s) 1. + Image(s) 2. + Result image(s) by the maximization. + + + Invert an image. + Input image(s). + Image(s) with inverted gray values. + + + Apply an automatic color correction to panorama images. + Input images. + Output images. + List of source images. + List of destination images. + Reference image. + Projective matrices. + Estimation algorithm for the correction. Default: "standard" + Parameters to be estimated. Default: ["mult_gray"] + Model of OECF to be used. Default: ["laguerre"] + + + Create 6 cube map images of a spherical mosaic. + Input images. + Front cube map. + Rear cube map. + Left cube map. + Right cube map. + Top cube map. + Bottom cube map. + (Array of) 3x3 projective camera matrices that determine the internal camera parameters. + Array of 3x3 transformation matrices that determine rotation of the camera in the respective image. + Width and height of the resulting cube maps. Default: 1000 + Mode of adding the images to the mosaic image. Default: "voronoi" + Mode of image interpolation. Default: "bilinear" + + + Create a spherical mosaic image. + Input images. + Output image. + (Array of) 3x3 projective camera matrices that determine the internal camera parameters. + Array of 3x3 transformation matrices that determine rotation of the camera in the respective image. + Minimum latitude of points in the spherical mosaic image. Default: -90 + Maximum latitude of points in the spherical mosaic image. Default: 90 + Minimum longitude of points in the spherical mosaic image. Default: -180 + Maximum longitude of points in the spherical mosaic image. Default: 180 + Latitude and longitude angle step width. Default: 0.1 + Mode of adding the images to the mosaic image. Default: "voronoi" + Mode of interpolation when creating the mosaic image. Default: "bilinear" + + + Combine multiple images into a mosaic image. + Input images. + Output image. + Array of 3x3 projective transformation matrices. + Stacking order of the images in the mosaic. Default: "default" + Should the domains of the input images also be transformed? Default: "false" + 3x3 projective transformation matrix that describes the translation that was necessary to transform all images completely into the output image. + + + Combine multiple images into a mosaic image. + Input images. + Output image. + Index of the central input image. + Indices of the source images of the transformations. + Indices of the target images of the transformations. + Array of 3x3 projective transformation matrices. + Stacking order of the images in the mosaic. Default: "default" + Should the domains of the input images also be transformed? Default: "false" + Array of 3x3 projective transformation matrices that determine the position of the images in the mosaic. + + + Apply a projective transformation to an image and specify the output image size. + Input image. + Output image. + Homogeneous projective transformation matrix. + Interpolation method for the transformation. Default: "bilinear" + Output image width. + Output image height. + Should the domain of the input image also be transformed? Default: "false" + + + Apply a projective transformation to an image. + Input image. + Output image. + Homogeneous projective transformation matrix. + Interpolation method for the transformation. Default: "bilinear" + Adapt the size of the output image automatically? Default: "false" + Should the domain of the input image also be transformed? Default: "false" + + + Apply an arbitrary affine 2D transformation to an image and specify the output image size. + Input image. + Transformed image. + Input transformation matrix. + Type of interpolation. Default: "constant" + Width of the output image. Default: 640 + Height of the output image. Default: 480 + + + Apply an arbitrary affine 2D transformation to images. + Input image. + Transformed image. + Input transformation matrix. + Type of interpolation. Default: "constant" + Adaption of size of result image. Default: "false" + + + Zoom an image by a given factor. + Input image. + Scaled image. + Scale factor for the width of the image. Default: 0.5 + Scale factor for the height of the image. Default: 0.5 + Type of interpolation. Default: "constant" + + + Zoom an image to a given size. + Input image. + Scaled image. + Width of the resulting image. Default: 512 + Height of the resulting image. Default: 512 + Type of interpolation. Default: "constant" + + + Mirror an image. + Input image. + Reflected image. + Axis of reflection. Default: "row" + + + Rotate an image about its center. + Input image. + Rotated image. + Rotation angle. Default: 90 + Type of interpolation. Default: "constant" + + + Transform an image in polar coordinates back to cartesian coordinates + Input image. + Output image. + Row coordinate of the center of the arc. Default: 256 + Column coordinate of the center of the arc. Default: 256 + Angle of the ray to map the first column of the input image to. Default: 0.0 + Angle of the ray to map the last column of the input image to. Default: 6.2831853 + Radius of the circle to map the first row of the input image to. Default: 0 + Radius of the circle to map the last row of the input image to. Default: 100 + Width of the output image. Default: 512 + Height of the output image. Default: 512 + Interpolation method for the transformation. Default: "nearest_neighbor" + + + Transform an annular arc in an image to polar coordinates. + Input image. + Output image. + Row coordinate of the center of the arc. Default: 256 + Column coordinate of the center of the arc. Default: 256 + Angle of the ray to be mapped to the first column of the output image. Default: 0.0 + Angle of the ray to be mapped to the last column of the output image. Default: 6.2831853 + Radius of the circle to be mapped to the first row of the output image. Default: 0 + Radius of the circle to be mapped to the last row of the output image. Default: 100 + Width of the output image. Default: 512 + Height of the output image. Default: 512 + Interpolation method for the transformation. Default: "nearest_neighbor" + + + Transform an image to polar coordinates + Input image in cartesian coordinates. + Result image in polar coordinates. + Row coordinate of the center of the coordinate system. Default: 100 + Column coordinate of the center of the coordinate system. Default: 100 + Width of the result image. Default: 314 + Height of the result image. Default: 200 + + + Approximate an affine map from a displacement vector field. + Input image. + Output transformation matrix. + + + Deserialize a serialized XLD object. + XLD object. + Handle of the serialized item. + + + Serialize an XLD object. + XLD object. + Handle of the serialized item. + + + Read XLD polygons from a DXF file. + Read XLD polygons. + Name of the DXF file. + Names of the generic parameters that can be adjusted for the DXF input. Default: [] + Values of the generic parameters that can be adjusted for the DXF input. Default: [] + Status information. + + + Write XLD polygons to a file in DXF format. + XLD polygons to be written. + Name of the DXF file. + + + Read XLD contours from a DXF file. + Read XLD contours. + Name of the DXF file. + Names of the generic parameters that can be adjusted for the DXF input. Default: [] + Values of the generic parameters that can be adjusted for the DXF input. Default: [] + Status information. + + + Write XLD contours to a file in DXF format. + XLD contours to be written. + Name of the DXF file. + + + Copy a file to a new location. + File to be copied. + Target location. + + + Set the current working directory. + Name of current working directory to be set. + + + Get the current working directory. + Name of current working directory. + + + Delete an empty directory. + Name of directory to be deleted. + + + Make a directory. + Name of directory to be created. + + + List all files in a directory. + Name of directory to be listed. + Processing options. Default: "files" + Found files (and directories). + + + Delete a file. + File to be deleted. + + + Check whether file exists. + Name of file to be checked. Default: "/bin/cc" + boolean number. + + + Read an iconic object. + Iconic object. + Name of file. + + + Write an iconic object. + Iconic object. + Name of file. + + + Deserialize a serialized iconic object. + Iconic object. + Handle of the serialized item. + + + Serialize an iconic object. + Iconic object. + Handle of the serialized item. + + + Deserialize a serialized image object. + Image object. + Handle of the serialized item. + + + Serialize an image object. + Image object. + Handle of the serialized item. + + + Deserialize a serialized region. + Region. + Handle of the serialized item. + + + Serialize a region. + Region. + Handle of the serialized item. + + + Write regions to a file. + Region of the images which are returned. + Name of region file. Default: "region.hobj" + + + Write images in graphic formats. + Input images. + Graphic format. Default: "tiff" + Fill gray value for pixels not belonging to the image domain (region). Default: 0 + Name of image file. + + + Read images. + Image read. + Number of bytes for file header. Default: 0 + Number of image columns of the filed image. Default: 512 + Number of image lines of the filed image. Default: 512 + Starting point of image area (line). Default: 0 + Starting point of image area (column). Default: 0 + Number of image columns of output image. Default: 512 + Number of image lines of output image. Default: 512 + Type of pixel values. Default: "byte" + Sequence of bits within one byte. Default: "MSBFirst" + Sequence of bytes within one 'short' unit. Default: "MSBFirst" + Data units within one image line (alignment). Default: "byte" + Number of images in the file. Default: 1 + Name of input file. + + + Read binary images or HALCON regions. + Read region. + Name of the region to be read. + + + Read an image with different file formats. + Read image. + Name of the image to be read. Default: "printer_chip/printer_chip_01" + + + Open a file in text or binary format. + Name of file to be opened. Default: "standard" + Type of file access and optional the string encoding. Default: "output" + File handle. + + + Write strings and numbers into a text file. + File handle. + Values to be written into the file. Default: "hallo" + + + Read a character line from a text file. + File handle. + Read line. + Reached end of file before any character was read. + + + Read a string from a text file. + File handle. + Read character sequence. + Reached end of file before any character was added to the output string. + + + Read one character from a text file. + File handle. + Read character, which can be multi-byte or the control string 'eof'. + + + Write a line break and clear the output buffer. + File handle. + + + Closing a text file. + File handle. + + + This operator is inoperable. It had the following function: Close all open files. + + + Test whether contours or polygons are closed. + Contours or polygons to be tested. + Tuple with boolean numbers. + + + Return gray values of an image at the positions of an XLD contour. + Image whose gray values are to be accessed. + Input XLD contour with the coordinates of the positions. + Interpolation method. Default: "nearest_neighbor" + Gray values of the selected image coordinates. + + + Arbitrary geometric moments of contours or polygons treated as point clouds. + Contours or polygons to be examined. + Computation mode. Default: "unnormalized" + Area enclosed by the contour or polygon. + Row coordinate of the centroid. + Column coordinate of the centroid. + First index of the desired moments M[P,Q]@f$M_{p,q}$. Default: 1 + Second index of the desired moments M[P,Q]@f$M_{p,q}$. Default: 1 + The computed moments. + + + Anisometry of contours or polygons treated as point clouds. + Contours or polygons to be examined. + Anisometry of the contours or polygons. + + + Parameters of the equivalent ellipse of contours or polygons treated as point clouds. + Contours or polygons to be examined. + Major radius. + Minor radius. + Angle between the major axis and the column axis (radians). + + + Orientation of contours or polygons treated as point clouds. + Contours or polygons to be examined. + Orientation of the contours or polygons (radians). + + + Geometric moments M20@f$M_{20}$, M02@f$M_{02}$, and M11@f$M_{11}$ of contours or polygons treated as point clouds. + Contours or polygons to be examined. + Mixed second order moment. + Second order moment along the row axis. + Second order moment along the column axis. + + + Area and center of gravity (centroid) of contours and polygons treated as point clouds. + Point clouds to be examined in form of contours or polygons. + Area of the point cloud. + Row coordinate of the centroid. + Column coordinate of the centroid. + + + Test XLD contours or polygons for self intersection. + Input contours or polygons. + Should the input contours or polygons be closed first? Default: "true" + 1 for contours or polygons with self intersection and 0 otherwise. + + + Choose all contours or polygons containing a given point. + Contours or polygons to be examined. + All contours or polygons containing the test point. + Line coordinate of the test point. Default: 100.0 + Column coordinate of the test point. Default: 100.0 + + + Test whether one or more contours or polygons enclose the given point(s). + Contours or polygons to be tested. + Row coordinates of the points to be tested. + Column coordinates of the points to be tested. + Tuple with boolean numbers. + + + Select contours or polygons using shape features. + Contours or polygons to be examined. + Contours or polygons fulfilling the condition(s). + Shape features to be checked. Default: "area" + Operation type between the individual features. Default: "and" + Lower limits of the features or 'min'. Default: 150.0 + Upper limits of the features or 'max'. Default: 99999.0 + + + Orientation of contours or polygons. + Contours or polygons to be examined. + Orientation of the contours or polygons (radians). + + + Shape features derived from the ellipse parameters of contours or polygons. + Contours or polygons to be examined. + Anisometry of the contours or polygons. + Bulkiness of the contours or polygons. + Structure factor of the contours or polygons. + + + Shape factor for the compactness of contours or polygons. + Contours or polygons to be examined. + Compactness of the input contours or polygons. + + + Maximum distance between two contour or polygon points. + Contours or polygons to be examined. + Row coordinate of the first extreme point of the contours or polygons. + Column coordinate of the first extreme point of the contours or polygons. + Row coordinate of the second extreme point of the contour or polygons. + Column coordinate of the second extreme point of the contours or polygons. + Distance of the two extreme points of the contours or polygons. + + + Shape factor for the convexity of contours or polygons. + Contours or polygons to be examined. + Convexity of the input contours or polygons. + + + Shape factor for the circularity (similarity to a circle) of contours or polygons. + Contours or polygons to be examined. + Roundness of the input contours or polygons. + + + Parameters of the equivalent ellipse of contours or polygons. + Contours or polygons to be examined. + Major radius. + Minor radius. + Angle between the major axis and the x axis (radians). + + + Smallest enclosing rectangle with arbitrary orientation of contours or polygons. + Contours or polygons to be examined. + Row coordinate of the center point of the enclosing rectangle. + Column coordinate of the center point of the enclosing rectangle. + Orientation of the enclosing rectangle (arc measure) + First radius (half length) of the enclosing rectangle. + Second radius (half width) of the enclosing rectangle. + + + Enclosing rectangle parallel to the coordinate axes of contours or polygons. + Contours or polygons to be examined. + Row coordinate of upper left corner point of the enclosing rectangle. + Column coordinate of upper left corner point of the enclosing rectangle. + Row coordinate of lower right corner point of the enclosing rectangle. + Column coordinate of lower right corner point of the enclosing rectangle. + + + Smallest enclosing circle of contours or polygons. + Contours or polygons to be examined. + Row coordinate of the center of the enclosing circle. + Column coordinate of the center of the enclosing circle. + Radius of the enclosing circle. + + + Transform the shape of contours or polygons. + Contours or polygons to be transformed. + Transformed contours respectively polygons. + Type of transformation. Default: "convex" + + + Length of contours or polygons. + Contours or polygons to be examined. + Length of the contour or polygon. + + + Arbitrary geometric moments of contours or polygons. + Contours or polygons to be examined. + Computation mode. Default: "unnormalized" + Point order along the boundary. Default: "positive" + Area enclosed by the contour or polygon. + Row coordinate of the centroid. + Column coordinate of the centroid. + First index of the desired moments M[P,Q]@f$M_{p,q}$. Default: 1 + Second index of the desired moments M[P,Q]@f$M_{p,q}$. Default: 1 + The computed moments. + + + Geometric moments M20@f$M_{20}$, M02@f$M_{02}$, and M11@f$M_{11}$ of contours or polygons. + Contours or polygons to be examined. + Mixed second order moment. + Second order moment along the row axis. + Second order moment along the column axis. + + + Area and center of gravity (centroid) of contours and polygons. + Contours or polygons to be examined. + Area enclosed by the contour or polygon. + Row coordinate of the centroid. + Column coordinate of the centroid. + point order along the boundary ('positive'/'negative'). + + + Geometric moments of regions. + Regions to be examined. + Moment of 2nd order. + Moment of 2nd order. + Moment of 2nd order. + Moment of 2nd order. + + + Geometric moments of regions. + Regions to be examined. + Moment of 2nd order. + Moment of 2nd order. + Moment of 2nd order. + Moment of 3rd order. + + + Geometric moments of regions. + Regions to be examined. + Moment of 3rd order (line-dependent). + Moment of 3rd order (column-dependent). + Moment of 3rd order (column-dependent). + Moment of 3rd order (line-dependent). + + + Geometric moments of regions. + Regions to be examined. + Moment of 3rd order (line-dependent). + Moment of 3rd order (column-dependent). + Moment of 3rd order (column-dependent). + Moment of 3rd order (line-dependent). + + + Smallest surrounding rectangle with any orientation. + Regions to be examined. + Line index of the center. + Column index of the center. + Orientation of the surrounding rectangle (arc measure) + First radius (half length) of the surrounding rectangle. + Second radius (half width) of the surrounding rectangle. + + + Surrounding rectangle parallel to the coordinate axes. + Regions to be examined. + Line index of upper left corner point. + Column index of upper left corner point. + Line index of lower right corner point. + Column index of lower right corner point. + + + Smallest surrounding circle of a region. + Regions to be examined. + Line index of the center. + Column index of the center. + Radius of the surrounding circle. + + + Choose regions having a certain relation to each other. + Regions to be examined. + Region compared to Regions. + Regions fulfilling the condition. + Shape features to be checked. Default: "covers" + Lower border of feature. Default: 50.0 + Upper border of the feature. Default: 100.0 + + + Calculate shape features of regions. + Regions to be examined. + Shape features to be calculated. Default: "area" + The calculated features. + + + Choose regions with the aid of shape features. + Regions to be examined. + Regions fulfilling the condition. + Shape features to be checked. Default: "area" + Linkage type of the individual features. Default: "and" + Lower limits of the features or 'min'. Default: 150.0 + Upper limits of the features or 'max'. Default: 99999.0 + + + Characteristic values for runlength coding of regions. + Regions to be examined. + Number of runs. + Storing factor in relation to a square. + Mean number of runs per line. + Mean length of runs. + Number of bytes necessary for coding the region. + + + Search direct neighbors. + Starting regions. + Comparative regions. + Maximal distance of regions. Default: 1 + Indices of the found regions from Regions1. + Indices of the found regions from Regions2. + + + Geometric moments of regions. + Regions to be examined. + Moment of 2nd order. + Moment of 2nd order. + + + Geometric moments of regions. + Regions to be examined. + Product of inertia of the axes through the center parallel to the coordinate axes. + Moment of 2nd order (line-dependent). + Moment of 2nd order (column-dependent). + + + Calculate the geometric moments of regions. + Input regions. + Product of inertia of the axes through the center parallel to the coordinate axes. + Moment of 2nd order (row-dependent). + Moment of 2nd order (column-dependent). + Length of the major axis of the input region. + Length of the minor axis of the input region. + + + Minimum distance between the contour pixels of two regions each. + Regions to be examined. + Regions to be examined. + Minimum distance between contours of the regions. + Line index on contour in Regions1. + Column index on contour in Regions1. + Line index on contour in Regions2. + Column index on contour in Regions2. + + + Minimum distance between two regions with the help of dilation. + Regions to be examined. + Regions to be examined. + Minimum distances of the regions. + + + Maximal distance between two boundary points of a region. + Regions to be examined. + Row index of the first extreme point. + Column index of the first extreme point. + Row index of the second extreme point. + Column index of the second extreme point. + Distance of the two extreme points. + + + Test if the region contains a given point. + Region(s) to be examined. + Row index of the test pixel(s). Default: 100 + Column index of the test pixel(s). Default: 100 + Boolean result value. + + + Index of all regions containing a given pixel. + Regions to be examined. + Line index of the test pixel. Default: 100 + Column index of the test pixel. Default: 100 + Index of the regions containing the test pixel. + + + Choose all regions containing a given pixel. + Regions to be examined. + All regions containing the test pixel. + Line index of the test pixel. Default: 100 + Column index of the test pixel. Default: 100 + + + Select regions of a given shape. + Input regions to be selected. + Regions with desired shape. + Shape features to be checked. Default: "max_area" + Similarity measure. Default: 70.0 + + + Hamming distance between two regions using normalization. + Regions to be examined. + Comparative regions. + Type of normalization. Default: "center" + Hamming distance of two regions. + Similarity of two regions. + + + Hamming distance between two regions. + Regions to be examined. + Comparative regions. + Hamming distance of two regions. + Similarity of two regions. + + + Shape features derived from the ellipse parameters. + Region(s) to be examined. + Shape feature (in case of a circle = 1.0). + Calculated shape feature. + Calculated shape feature. + + + Calculate the Euler number. + Region(s) to be examined. + Calculated Euler number. + + + Orientation of a region. + Region(s) to be examined. + Orientation of region (arc measure). + + + Calculate the parameters of the equivalent ellipse. + Input regions. + Main radius (normalized to the area). + Secondary radius (normalized to the area). + Angle between main radius and x-axis in radians. + + + Pose relation of regions. + Starting regions + Comparative regions + Desired neighboring relation. Default: "left" + Indices in the input tuples (Regions1 or ParRef{Regions2}), respectively. + Indices in the input tuples (Regions1 or ParRef{Regions2}), respectively. + + + Pose relation of regions with regard to + Starting regions. + Comparative regions. + Percentage of the area of the comparative region which must be located left/right or Default: 50 + Indices of the regions in the tuple of the input regions which fulfill the pose relation. + Indices of the regions in the tuple of the input regions which fulfill the pose relation. + Horizontal pose relation in which RegionIndex2[n] stands with RegionIndex1[n]. + Vertical pose relation in which RegionIndex2[n] stands with RegionIndex1[n]. + + + Shape factor for the convexity of a region. + Region(s) to be examined. + Convexity of the input region(s). + + + Contour length of a region. + Region(s) to be examined. + Contour length of the input region(s). + + + Number of connection components and holes + Region(s) to be examined. + Number of connection components of a region. + Number of holes of a region. + + + Shape factor for the rectangularity of a region. + Region(s) to be examined. + Rectangularity of the input region(s). + + + Shape factor for the compactness of a region. + Region(s) to be examined. + Compactness of the input region(s). + + + Shape factor for the circularity (similarity to a circle) of a region. + Region(s) to be examined. + Circularity of the input region(s). + + + Compute the area of holes of regions. + Region(s) to be examined. + Area(s) of holes of the region(s). + + + Area and center of regions. + Region(s) to be examined. + Area of the region. + Line index of the center. + Column index of the center. + + + Distribution of runs needed for runlength encoding of a region. + Region to be examined. + Length distribution of the region (foreground). + Length distribution of the background. + + + Shape factors from contour. + Region(s) to be examined. + Mean distance from the center. + Standard deviation of Distance. + Shape factor for roundness. + Number of polygon sides. + + + Largest inner rectangle of a region. + Region to be examined. + Row coordinate of the upper left corner point. + Column coordinate of the upper left corner point. + Row coordinate of the lower right corner point. + Column coordinate of the lower right corner point. + + + Largest inner circle of a region. + Regions to be examined. + Line index of the center. + Column index of the center. + Radius of the inner circle. + + + Select the longest input lines. + Row coordinates of the starting points of the input lines. + Column coordinates of the starting points of the input lines. + Row coordinates of the ending points of the input lines. + Column coordinates of the ending points of the input lines. + (Maximum) desired number of output lines. Default: 10 + Row coordinates of the starting points of the output lines. + Column coordinates of the starting points of the output lines. + Row coordinates of the ending points of the output lines. + Column coordinates of the ending points of the output lines. + + + Partition lines according to various criteria. + Row coordinates of the starting points of the input lines. + Column coordinates of the starting points of the input lines. + Row coordinates of the ending points of the input lines. + Column coordinates of the ending points of the input lines. + Features to be used for selection. + Desired combination of the features. + Lower limits of the features or 'min'. Default: "min" + Upper limits of the features or 'max'. Default: "max" + Row coordinates of the starting points of the lines fulfilling the conditions. + Column coordinates of the starting points of the lines fulfilling the conditions. + Row coordinates of the ending points of the lines fulfilling the conditions. + Column coordinates of the ending points of the lines fulfilling the conditions. + Row coordinates of the starting points of the lines not fulfilling the conditions. + Column coordinates of the starting points of the lines not fulfilling the conditions. + Row coordinates of the ending points of the lines not fulfilling the conditions. + Column coordinates of the ending points of the lines not fulfilling the conditions. + + + Select lines according to various criteria. + Row coordinates of the starting points of the input lines. + Column coordinates of the starting points of the input lines. + Row coordinates of the ending points of the input lines. + Column coordinates of the ending points of the input lines. + Features to be used for selection. Default: "length" + Desired combination of the features. Default: "and" + Lower limits of the features or 'min'. Default: "min" + Upper limits of the features or 'max'. Default: "max" + Row coordinates of the starting points of the output lines. + Column coordinates of the starting points of the output lines. + Row coordinates of the ending points of the output lines. + Column coordinates of the ending points of the output lines. + + + Calculate the center of gravity, length, and orientation of a line. + Row coordinates of the starting points of the input lines. + Column coordinates of the starting points of the input lines. + Row coordinates of the ending points of the input lines. + Column coordinates of the ending points of the input lines. + Row coordinates of the centers of gravity of the input lines. + Column coordinates of the centers of gravity of the input lines. + Euclidean length of the input lines. + Orientation of the input lines. + + + Calculate the orientation of lines. + Row coordinates of the starting points of the input lines. + Column coordinates of the starting points of the input lines. + Row coordinates of the ending points of the input lines. + Column coordinates of the ending points of the input lines. + Orientation of the input lines. + + + Approximate a contour by arcs and lines. + Row of the contour. Default: 32 + Column of the contour. Default: 32 + Row of the center of an arc. + Column of the center of an arc. + Angle of an arc. + Row of the starting point of an arc. + Column of the starting point of an arc. + Row of the starting point of a line segment. + Column of the starting point of a line segment. + Row of the ending point of a line segment. + Column of the ending point of a line segment. + Sequence of line (value 0) and arc segments (value 1). + + + Approximate a contour by arcs and lines. + Row of the contour. Default: 32 + Column of the contour. Default: 32 + Minimum width of Gauss operator for coordinate smoothing ($ greater than $ 0.4). Default: 0.5 + Maximum width of Gauss operator for coordinate smoothing ($ greater than $ 0.4). Default: 2.4 + Minimum threshold value of the curvature for accepting a corner (relative to the largest curvature present). Default: 0.3 + Maximum threshold value of the curvature for accepting a corner (relative to the largest curvature present). Default: 0.9 + Step width for threshold increase. Default: 0.2 + Minimum width of Gauss operator for smoothing the curvature function ($ greater than $ 0.4). Default: 0.5 + Maximum width of Gauss operator for smoothing the curvature function. Default: 2.4 + Minimum width of curve area for curvature determination ($ greater than $ 0.4). Default: 2 + Maximum width of curve area for curvature determination. Default: 12 + Weighting factor for approximation precision. Default: 1.0 + Weighting factor for large segments. Default: 1.0 + Weighting factor for small segments. Default: 1.0 + Row of the center of an arc. + Column of the center of an arc. + Angle of an arc. + Row of the starting point of an arc. + Column of the starting point of an arc. + Row of the starting point of a line segment. + Column of the starting point of a line segment. + Row of the ending point of a line segment. + Column of the ending point of a line segment. + Sequence of line (value 0) and arc segments (value 1). + + + Calculate gray value moments and approximation by a first order surface (plane). + Regions to be checked. + Corresponding gray values. + Algorithm for the fitting. Default: "regression" + Maximum number of iterations (unused for 'regression'). Default: 5 + Clipping factor for the elimination of outliers. Default: 2.0 + Parameter Alpha of the approximating surface. + Parameter Beta of the approximating surface. + Parameter Gamma of the approximating surface. + + + Calculate gray value moments and approximation by a second order surface. + Regions to be checked. + Corresponding gray values. + Algorithm for the fitting. Default: "regression" + Maximum number of iterations (unused for 'regression'). Default: 5 + Clipping factor for the elimination of outliers. Default: 2.0 + Parameter Alpha of the approximating surface. + Parameter Beta of the approximating surface. + Parameter Gamma of the approximating surface. + Parameter Delta of the approximating surface. + Parameter Epsilon of the approximating surface. + Parameter Zeta of the approximating surface. + + + Create a curved gray surface with second order polynomial. + Created image with new image matrix. + Pixel type. Default: "byte" + Second order coefficient in vertical direction. Default: 1.0 + Second order coefficient in horizontal direction. Default: 1.0 + Mixed second order coefficient. Default: 1.0 + First order coefficient in vertical direction. Default: 1.0 + First order coefficient in horizontal direction. Default: 1.0 + Zero order coefficient. Default: 1.0 + Row coordinate of the reference point of the surface. Default: 256.0 + Column coordinate of the reference point of the surface. Default: 256.0 + Width of image. Default: 512 + Height of image. Default: 512 + + + Create a tilted gray surface with first order polynomial. + Created image with new image matrix. + Pixel type. Default: "byte" + First order coefficient in vertical direction. Default: 1.0 + First order coefficient in horizontal direction. Default: 1.0 + Zero order coefficient. Default: 1.0 + Row coordinate of the reference point of the surface. Default: 256.0 + Column coordinate of the reference point of the surface. Default: 256.0 + Width of image. Default: 512 + Height of image. Default: 512 + + + Determine a histogram of features along all threshold values. + Region in which the features are to be examined. + Gray value image. + Feature to be examined. Default: "convexity" + Row of the pixel which the region must contain. Default: 256 + Column of the pixel which the region must contain. Default: 256 + Absolute distribution of the feature. + Relative distribution of the feature. + + + Determine a histogram of features along all threshold values. + Region in which the features are to be examined. + Gray value image. + Feature to be examined. Default: "connected_components" + Absolute distribution of the feature. + Relative distribution of the feature. + + + Calculates gray value features for a set of regions. + Regions to be examined. + Gray value image. + Names of the features. Default: "mean" + Value sof the features. + + + Select regions based on gray value features. + Regions to be examined. + Gray value image. + Regions having features within the limits. + Names of the features. Default: "mean" + Logical connection of features. Default: "and" + Lower limit(s) of features. Default: 128.0 + Upper limit(s) of features. Default: 255.0 + + + Determine the minimum and maximum gray values within regions. + Regions, the features of which are to be calculated. + Gray value image. + Percentage below (above) the absolute maximum (minimum). Default: 0 + "Minimum" gray value. + "Maximum" gray value. + Difference between Max and Min. + + + Calculate the mean and deviation of gray values. + Regions in which the features are calculated. + Gray value image. + Mean gray value of a region. + Deviation of gray values within a region. + + + Calculate the gray value distribution of a single channel image within a certain gray value range. + Region in which the histogram is to be calculated. + Input image. + Minimum gray value. Default: 0 + Maximum gray value. Default: 255 + Number of bins. Default: 256 + Histogram to be calculated. + Bin size. + + + Calculate the histogram of two-channel gray value images. + Region in which the histogram is to be calculated. + Channel 1. + Channel 2. + Histogram to be calculated. + + + Calculate the gray value distribution. + Region in which the histogram is to be calculated. + Image the gray value distribution of which is to be calculated. + Quantization of the gray values. Default: 1.0 + Absolute frequencies of the gray values. + + + Calculate the gray value distribution. + Region in which the histogram is to be calculated. + Image the gray value distribution of which is to be calculated. + Absolute frequencies of the gray values. + Frequencies, normalized to the area of the region. + + + Determine the entropy and anisotropy of images. + Regions where the features are to be determined. + Gray value image. + Information content (entropy) of the gray values. + Measure of the symmetry of gray value distribution. + + + Calculate gray value features from a co-occurrence matrix. + Co-occurrence matrix. + Homogeneity of the gray values. + Correlation of gray values. + Local homogeneity of gray values. + Gray value contrast. + + + Calculate a co-occurrence matrix and derive gray value features thereof. + Region to be examined. + Corresponding gray values. + Number of gray values to be distinguished (2^LdGray@f$2^{LdGray}$). Default: 6 + Direction in which the matrix is to be calculated. Default: 0 + Gray value energy. + Correlation of gray values. + Local homogeneity of gray values. + Gray value contrast. + + + Calculate the co-occurrence matrix of a region in an image. + Region to be checked. + Image providing the gray values. + Co-occurrence matrix (matrices). + Number of gray values to be distinguished (2^LdGray@f$2^{LdGray}$). Default: 6 + Direction of neighbor relation. Default: 0 + + + Calculate gray value moments and approximation by a plane. + Regions to be checked. + Corresponding gray values. + Mixed moments along a line. + Mixed moments along a column. + Parameter Alpha of the approximating plane. + Parameter Beta of the approximating plane. + Mean gray value. + + + Calculate the deviation of the gray values from the approximating image plane. + Regions, of which the plane deviation is to be calculated. + Gray value image. + Deviation of the gray values within a region. + + + Compute the orientation and major axes of a region in a gray value image. + Region(s) to be examined. + Gray value image. + Major axis of the region. + Minor axis of the region. + Angle enclosed by the major axis and the x-axis. + + + Compute the area and center of gravity of a region in a gray value image. + Region(s) to be examined. + Gray value image. + Gray value volume of the region. + Row coordinate of the gray value center of gravity. + Column coordinate of the gray value center of gravity. + + + Calculate horizontal and vertical gray-value projections. + Region to be processed. + Grayvalues for projections. + Method to compute the projections. Default: "simple" + Horizontal projection. + Vertical projection. + + + Access iconic objects that were created during the search for 2D data code symbols. + Objects that are created as intermediate results during the detection or evaluation of 2D data codes. + Handle of the 2D data code model. + Handle of the 2D data code candidate. Either an integer (usually the ResultHandle of find_data_code_2d) or a string representing a group of candidates. Default: "all_candidates" + Name of the iconic object to return. Default: "candidate_xld" + + + Get the alphanumerical results that were accumulated during the search for 2D data code symbols. + Handle of the 2D data code model. + Handle of the 2D data code candidate. Either an integer (usually the ResultHandle of find_data_code_2d) or a string representing a group of candidates. Default: "all_candidates" + Names of the results of the 2D data code to return. Default: "status" + List with the results. + + + Detect and read 2D data code symbols in an image or train the 2D data code model. + Input image. If the image has a reduced domain, the data code search is reduced to that domain. This usually reduces the runtime of the operator. However, if the datacode is not fully inside the domain, the datacode might not be found correctly. In rare cases, data codes may be found outside the domain. If these results are undesirable, they have to be subsequently eliminated. + XLD contours that surround the successfully decoded data code symbols. The order of the contour points reflects the orientation of the detected symbols. The contours begin in the top left corner (see 'orientation' at get_data_code_2d_results) and continue clockwise. Alignment{left} Figure[1][1][60]{get_data_code_2d_results-xld_qrcode} Order of points of SymbolXLDs Figure Alignment @f$ + Handle of the 2D data code model. + Names of (optional) parameters for controlling the behavior of the operator. Default: [] + Values of the optional generic parameters. Default: [] + Handles of all successfully decoded 2D data code symbols. + Decoded data strings of all detected 2D data code symbols in the image. + + + Set selected parameters of the 2D data code model. + Handle of the 2D data code model. + Names of the generic parameters that shall be adjusted for the 2D data code. Default: "polarity" + Values of the generic parameters that are adjusted for the 2D data code. Default: "light_on_dark" + + + Get one or several parameters that describe the 2D data code model. + Handle of the 2D data code model. + Names of the generic parameters that are to be queried for the 2D data code model. Default: "polarity" + Values of the generic parameters. + + + Get for a given 2D data code model the names of the generic parameters or objects that can be used in the other 2D data code operators. + Handle of the 2D data code model. + Name of the parameter group. Default: "get_result_params" + List containing the names of the supported generic parameters. + + + Deserialize a serialized 2D data code model. + Handle of the serialized item. + Handle of the 2D data code model. + + + Serialize a 2D data code model. + Handle of the 2D data code model. + Handle of the serialized item. + + + Read a 2D data code model from a file and create a new model. + Name of the 2D data code model file. Default: "data_code_model.dcm" + Handle of the created 2D data code model. + + + Writes a 2D data code model into a file. + Handle of the 2D data code model. + Name of the 2D data code model file. Default: "data_code_model.dcm" + + + This operator is inoperable. It had the following function: Delete all 2D data code models and free the allocated memory. + + + Delete a 2D data code model and free the allocated memory. + Handle of the 2D data code model. + + + Create a model of a 2D data code class. + Type of the 2D data code. Default: "Data Matrix ECC 200" + Names of the generic parameters that can be adjusted for the 2D data code model. Default: [] + Values of the generic parameters that can be adjusted for the 2D data code model. Default: [] + Handle for using and accessing the 2D data code model. + + + Deserialize serialized training data for classifiers. + Handle of the serialized item. + Handle of the training data. + + + Serialize training data for classifiers. + Handle of the training data. + Handle of the serialized item. + + + Read the training data for classifiers from a file. + File name of the training data. + Handle of the training data. + + + Save the training data for classifiers in a file. + Handle of the training data. + Name of the file in which the training data will be written. + + + Select certain features from training data to create training data containing less features. + Handle of the training data. + Indices or names to select the subfeatures or columns. + Handle of the reduced training data. + + + Define subfeatures in training data. + Handle of the training data that should be partitioned into subfeatures. + Length of the subfeatures. + Names of the subfeatures. + + + Get the training data of a Gaussian Mixture Model (GMM). + Handle of a GMM that contains training data. + Handle of the training data of the classifier. + + + Add training data to a Gaussian Mixture Model (GMM). + Handle of a GMM which receives the training data. + Handle of training data for a classifier. + + + Get the training data of a multilayer perceptron (MLP). + Handle of a MLP that contains training data. + Handle of the training data of the classifier. + + + Add training data to a multilayer perceptron (MLP). + MLP handle which receives the training data. + Training data for a classifier. + + + Get the training data of a k-nearest neighbors (k-NN) classifier. + Handle of the k-NN classifier that contains training data. + Handle of the training data of the classifier. + + + Add training data to a k-nearest neighbors (k-NN) classifier. + Handle of a k-NN which receives the training data. + Training data for a classifier. + + + Get the training data of a support vector machine (SVM). + Handle of a SVM that contains training data. + Handle of the training data of the classifier. + + + Add training data to a support vector machine (SVM). + Handle of a SVM which receives the training data. + Training data for a classifier. + + + Return the number of training samples stored in the training data. + Handle of training data. + Number of stored training samples. + + + Return a training sample from training data. + Handle of training data for a classifier. + Number of stored training sample. + Feature vector of the training sample. + Class of the training sample. + + + This operator is inoperable. It had the following function: Clear all training data for classifiers. + + + Clears training data for classifiers. + Handle of training data for a classifier. + + + Add a training sample to training data. + Handle of the training data. + The order of the feature vector. Default: "row" + Feature vector of the training sample. + Class of the training sample. + + + Create a handle for training data for classifiers. + Number of dimensions of the feature vector. Default: 10 + Handle of the training data. + + + Selects an optimal combination of features to classify the provided data. + Handle of the training data. + Method to perform the selection. Default: "greedy" + Names of generic parameters to configure the selection process and the classifier. Default: [] + Values of generic parameters to configure the selection process and the classifier. Default: [] + A trained MLP classifier using only the selected features. + The selected feature set, contains indices referring. + The achieved score using two-fold cross-validation. + + + Selects an optimal combination of features to classify the provided data. + Handle of the training data. + Method to perform the selection. Default: "greedy" + Names of generic parameters to configure the selection process and the classifier. Default: [] + Values of generic parameters to configure the selection process and the classifier. Default: [] + A trained SVM classifier using only the selected features. + The selected feature set, contains indices. + The achieved score using two-fold cross-validation. + + + Selects an optimal combination from a set of features to classify the provided data. + Handle of the training data. + Method to perform the selection. Default: "greedy" + Names of generic parameters to configure the classifier. Default: [] + Values of generic parameters to configure the classifier. Default: [] + A trained GMM classifier using only the selected features. + The selected feature set, contains indices or names. + The achieved score using two-fold cross-validation. + + + Selects an optimal subset from a set of features to solve a certain classification problem. + Handle of the training data. + Method to perform the selection. Default: "greedy" + Names of generic parameters to configure the selection process and the classifier. Default: [] + Values of generic parameters to configure the selection process and the classifier. Default: [] + A trained k-NN classifier using only the selected features. + The selected feature set, contains indices or names. + The achieved score using two-fold cross-validation. + + + This operator is inoperable. It had the following function: Clear all k-NN classifiers. + + + Clear a k-NN classifier. + Handle of the k-NN classifier. + + + Return the number of training samples stored in the training data of a k-nearest neighbors (k-NN) classifier. + Handle of the k-NN classifier. + Number of stored training samples. + + + Return a training sample from the training data of a k-nearest neighbors (k-NN) classifier. + Handle of the k-NN classifier. + Index of the training sample. + Feature vector of the training sample. + Class of the training sample. + + + Deserialize a serialized k-NN classifier. + Handle of the serialized item. + Handle of the k-NN classifier. + + + Serialize a k-NN classifier. + Handle of the k-NN classifier. + Handle of the serialized item. + + + Read the k-NN classifier from a file. + File name of the classifier. + Handle of the k-NN classifier. + + + Save the k-NN classifier in a file. + Handle of the k-NN classifier. + Name of the file in which the classifier will be written. + + + Get parameters of a k-NN classification. + Handle of the k-NN classifier. + Names of the parameters that can be read from the k-NN classifier. Default: ["method","k"] + Values of the selected parameters. + + + Set parameters for k-NN classification. + Handle of the k-NN classifier. + Names of the generic parameters that can be adjusted for the k-NN classifier. Default: ["method","k","max_num_classes"] + Values of the generic parameters that can be adjusted for the k-NN classifier. Default: ["classes_distance",5,1] + + + Search for the next neighbors for a given feature vector. + Handle of the k-NN classifier. + Features that should be classified. + The classification result, either class IDs or sample indices. + A rating for the results. This value contains either a distance, a frequency or a weighted frequency. + + + Creates the search trees for a k-NN classifier. + Handle of the k-NN classifier. + Names of the generic parameters that can be adjusted for the k-NN classifier creation. Default: [] + Values of the generic parameters that can be adjusted for the k-NN classifier creation. Default: [] + + + Add a sample to a k-nearest neighbors (k-NN) classifier. + Handle of the k-NN classifier. + List of features to add. + Class IDs of the features. + + + Create a k-nearest neighbors (k-NN) classifier. + Number of dimensions of the feature. Default: 10 + Handle of the k-NN classifier. + + + This operator is inoperable. It had the following function: Clear all look-up table classifiers. + + + Clear a look-up table classifier. + Handle of the LUT classifier. + + + Create a look-up table using a k-nearest neighbors classifier (k-NN) to classify byte images. + Handle of the k-NN classifier. + Names of the generic parameters that can be adjusted for the LUT classifier creation. Default: [] + Values of the generic parameters that can be adjusted for the LUT classifier creation. Default: [] + Handle of the LUT classifier. + + + Create a look-up table using a gaussian mixture model to classify byte images. + GMM handle. + Names of the generic parameters that can be adjusted for the LUT classifier creation. Default: [] + Values of the generic parameters that can be adjusted for the LUT classifier creation. Default: [] + Handle of the LUT classifier. + + + Create a look-up table using a Support-Vector-Machine to classify byte images. + SVM handle. + Names of the generic parameters that can be adjusted for the LUT classifier creation. Default: [] + Values of the generic parameters that can be adjusted for the LUT classifier creation. Default: [] + Handle of the LUT classifier. + + + Create a look-up table using a multi-layer perceptron to classify byte images. + MLP handle. + Names of the generic parameters that can be adjusted for the LUT classifier creation. Default: [] + Values of the generic parameters that can be adjusted for the LUT classifier creation. Default: [] + Handle of the LUT classifier. + + + This operator is inoperable. It had the following function: Clear all Gaussian Mixture Models. + + + Clear a Gaussian Mixture Model. + GMM handle. + + + Clear the training data of a Gaussian Mixture Model. + GMM handle. + + + Deserialize a serialized Gaussian Mixture Model. + Handle of the serialized item. + GMM handle. + + + Serialize a Gaussian Mixture Model (GMM). + GMM handle. + Handle of the serialized item. + + + Read a Gaussian Mixture Model from a file. + File name. + GMM handle. + + + Write a Gaussian Mixture Model to a file. + GMM handle. + File name. + + + Read the training data of a Gaussian Mixture Model from a file. + GMM handle. + File name. + + + Write the training data of a Gaussian Mixture Model to a file. + GMM handle. + File name. + + + Calculate the class of a feature vector by a Gaussian Mixture Model. + GMM handle. + Feature vector. + Number of best classes to determine. Default: 1 + Result of classifying the feature vector with the GMM. + A-posteriori probability of the classes. + Probability density of the feature vector. + Normalized k-sigma-probability for the feature vector. + + + Evaluate a feature vector by a Gaussian Mixture Model. + GMM handle. + Feature vector. + A-posteriori probability of the classes. + Probability density of the feature vector. + Normalized k-sigma-probability for the feature vector. + + + Train a Gaussian Mixture Model. + GMM handle. + Maximum number of iterations of the expectation maximization algorithm Default: 100 + Threshold for relative change of the error for the expectation maximization algorithm to terminate. Default: 0.001 + Mode to determine the a-priori probabilities of the classes Default: "training" + Regularization value for preventing covariance matrix singularity. Default: 0.0001 + Number of found centers per class + Number of executed iterations per class + + + Compute the information content of the preprocessed feature vectors of a GMM. + GMM handle. + Type of preprocessing used to transform the feature vectors. Default: "principal_components" + Relative information content of the transformed feature vectors. + Cumulative information content of the transformed feature vectors. + + + Return the number of training samples stored in the training data of a Gaussian Mixture Model (GMM). + GMM handle. + Number of stored training samples. + + + Return a training sample from the training data of a Gaussian Mixture Models (GMM). + GMM handle. + Index of the stored training sample. + Feature vector of the training sample. + Class of the training sample. + + + Add a training sample to the training data of a Gaussian Mixture Model. + GMM handle. + Feature vector of the training sample to be stored. + Class of the training sample to be stored. + Standard deviation of the Gaussian noise added to the training data. Default: 0.0 + + + Return the parameters of a Gaussian Mixture Model. + GMM handle. + Number of dimensions of the feature space. + Number of classes of the GMM. + Minimum number of centers per GMM class. + Maximum number of centers per GMM class. + Type of the covariance matrices. + + + Create a Gaussian Mixture Model for classification + Number of dimensions of the feature space. Default: 3 + Number of classes of the GMM. Default: 5 + Number of centers per class. Default: 1 + Type of the covariance matrices. Default: "spherical" + Type of preprocessing used to transform the feature vectors. Default: "normalization" + Preprocessing parameter: Number of transformed features (ignored for Preprocessing $=$ 'none' and Preprocessing $=$ 'normalization'). Default: 10 + Seed value of the random number generator that is used to initialize the GMM with random values. Default: 42 + GMM handle. + + + This operator is inoperable. It had the following function: Clear all support vector machines. + + + Clear a support vector machine. + SVM handle. + + + Clear the training data of a support vector machine. + SVM handle. + + + Deserialize a serialized support vector machine (SVM). + Handle of the serialized item. + SVM handle. + + + Serialize a support vector machine (SVM). + SVM handle. + Handle of the serialized item. + + + Read a support vector machine from a file. + File name. + SVM handle. + + + Write a support vector machine to a file. + SVM handle. + File name. + + + Read the training data of a support vector machine from a file. + SVM handle. + File name. + + + Write the training data of a support vector machine to a file. + SVM handle. + File name. + + + Evaluate a feature vector by a support vector machine. + SVM handle. + Feature vector. + Result of evaluating the feature vector with the SVM. + + + Classify a feature vector by a support vector machine. + SVM handle. + Feature vector. + Number of best classes to determine. Default: 1 + Result of classifying the feature vector with the SVM. + + + Approximate a trained support vector machine by a reduced support vector machine for faster classification. + Original SVM handle. + Type of postprocessing to reduce number of SV. Default: "bottom_up" + Minimum number of remaining SVs. Default: 2 + Maximum allowed error of reduction. Default: 0.001 + SVMHandle of reduced SVM. + + + Train a support vector machine. + SVM handle. + Stop parameter for training. Default: 0.001 + Mode of training. For normal operation: 'default'. If SVs already included in the SVM should be used for training: 'add_sv_to_train_set'. For alpha seeding: the respective SVM handle. Default: "default" + + + Compute the information content of the preprocessed feature vectors of a support vector machine + SVM handle. + Type of preprocessing used to transform the feature vectors. Default: "principal_components" + Relative information content of the transformed feature vectors. + Cumulative information content of the transformed feature vectors. + + + Return the number of support vectors of a support vector machine. + SVM handle. + Total number of support vectors. + Number of SV of each sub-SVM. + + + Return the index of a support vector from a trained support vector machine. + SVM handle. + Index of the stored support vector. + Index of the support vector in the training set. + + + Return the number of training samples stored in the training data of a support vector machine. + SVM handle. + Number of stored training samples. + + + Return a training sample from the training data of a support vector machine. + SVM handle. + Number of the stored training sample. + Feature vector of the training sample. + Target vector of the training sample. + + + Add a training sample to the training data of a support vector machine. + SVM handle. + Feature vector of the training sample to be stored. + Class of the training sample to be stored. + + + Return the parameters of a support vector machine. + SVM handle. + Number of input variables (features) of the SVM. + The kernel type. + Additional parameter for the kernel. + Regularization constant of the SVM. + Number of classes of the test data. + The mode of the SVM. + Type of preprocessing used to transform the feature vectors. + Preprocessing parameter: Number of transformed features (ignored for Preprocessing $=$ 'none' and Preprocessing $=$ 'normalization'). + + + Create a support vector machine for pattern classification. + Number of input variables (features) of the SVM. Default: 10 + The kernel type. Default: "rbf" + Additional parameter for the kernel function. In case of RBF kernel the value for gamma@f$ Default: 0.02 + Regularisation constant of the SVM. Default: 0.05 + Number of classes. Default: 5 + The mode of the SVM. Default: "one-versus-one" + Type of preprocessing used to transform the feature vectors. Default: "normalization" + Preprocessing parameter: Number of transformed features (ignored for Preprocessing $=$ 'none' and Preprocessing $=$ 'normalization'). Default: 10 + SVM handle. + + + This operator is inoperable. It had the following function: Clear all multilayer perceptrons. + + + Clear a multilayer perceptron. + MLP handle. + + + Clear the training data of a multilayer perceptron. + MLP handle. + + + Deserialize a serialized multilayer perceptron. + Handle of the serialized item. + MLP handle. + + + Serialize a multilayer perceptron (MLP). + MLP handle. + Handle of the serialized item. + + + Read a multilayer perceptron from a file. + File name. + MLP handle. + + + Write a multilayer perceptron to a file. + MLP handle. + File name. + + + Read the training data of a multilayer perceptron from a file. + MLP handle. + File name. + + + Write the training data of a multilayer perceptron to a file. + MLP handle. + File name. + + + Calculate the class of a feature vector by a multilayer perceptron. + MLP handle. + Feature vector. + Number of best classes to determine. Default: 1 + Result of classifying the feature vector with the MLP. + Confidence(s) of the class(es) of the feature vector. + + + Calculate the evaluation of a feature vector by a multilayer perceptron. + MLP handle. + Feature vector. + Result of evaluating the feature vector with the MLP. + + + Train a multilayer perceptron. + MLP handle. + Maximum number of iterations of the optimization algorithm. Default: 200 + Threshold for the difference of the weights of the MLP between two iterations of the optimization algorithm. Default: 1.0 + Threshold for the difference of the mean error of the MLP on the training data between two iterations of the optimization algorithm. Default: 0.01 + Mean error of the MLP on the training data. + Mean error of the MLP on the training data as a function of the number of iterations of the optimization algorithm. + + + Compute the information content of the preprocessed feature vectors of a multilayer perceptron. + MLP handle. + Type of preprocessing used to transform the feature vectors. Default: "principal_components" + Relative information content of the transformed feature vectors. + Cumulative information content of the transformed feature vectors. + + + Return the number of training samples stored in the training data of a multilayer perceptron. + MLP handle. + Number of stored training samples. + + + Return a training sample from the training data of a multilayer perceptron. + MLP handle. + Number of stored training sample. + Feature vector of the training sample. + Target vector of the training sample. + + + Get the parameters of a rejection class. + MLP handle. + Names of the generic parameters to return. Default: "sampling_strategy" + Values of the generic parameters. + + + Set the parameters of a rejection class. + MLP handle. + Names of the generic parameters. Default: "sampling_strategy" + Values of the generic parameters. Default: "hyperbox_around_all_classes" + + + Add a training sample to the training data of a multilayer perceptron. + MLP handle. + Feature vector of the training sample to be stored. + Class or target vector of the training sample to be stored. + + + Return the regularization parameters of a multilayer perceptron. + MLP handle. + Name of the regularization parameter to return. Default: "weight_prior" + Value of the regularization parameter. + + + Set the regularization parameters of a multilayer perceptron. + MLP handle. + Name of the regularization parameter to set. Default: "weight_prior" + Value of the regularization parameter. Default: 1.0 + + + Return the parameters of a multilayer perceptron. + MLP handle. + Number of input variables (features) of the MLP. + Number of hidden units of the MLP. + Number of output variables (classes) of the MLP. + Type of the activation function in the output layer of the MLP. + Type of preprocessing used to transform the feature vectors. + Preprocessing parameter: Number of transformed features. + + + Create a multilayer perceptron for classification or regression. + Number of input variables (features) of the MLP. Default: 20 + Number of hidden units of the MLP. Default: 10 + Number of output variables (classes) of the MLP. Default: 5 + Type of the activation function in the output layer of the MLP. Default: "softmax" + Type of preprocessing used to transform the feature vectors. Default: "normalization" + Preprocessing parameter: Number of transformed features (ignored for Preprocessing $=$ 'none' and Preprocessing $=$ 'normalization'). Default: 10 + Seed value of the random number generator that is used to initialize the MLP with random values. Default: 42 + MLP handle. + + + Deserialize a serialized classifier. + Handle of the classifier. + Handle of the serialized item. + + + Serialize a classifier. + Handle of the classifier. + Handle of the serialized item. + + + Save a classifier in a file. + Handle of the classifier. + Name of the file which contains the written data. + + + Set system parameters for classification. + Handle of the classifier. + Name of the wanted parameter. Default: "split_error" + Value of the parameter. Default: 0.1 + + + Read a training data set from a file. + Filename of the data set to train. Default: "sampset1" + Identification of the data set to train. + + + Read a classifier from a file. + Handle of the classifier. + Filename of the classifier. + + + Train the classifier with one data set. + Handle of the classifier. + Number of the data set to train. + Name of the protocol file. Default: "training_prot" + Number of arrays of attributes to learn. Default: 500 + Classification error for termination. Default: 0.05 + Error during the assignment. Default: 100 + + + Train the classifier. + Handle of the classifier. + Array of attributes to learn. Default: [1.0,1.5,2.0] + Class to which the array has to be assigned. Default: 1 + + + Get information about the current parameter. + Handle of the classifier. + Name of the system parameter. Default: "split_error" + Value of the system parameter. + + + Free memory of a data set. + Number of the data set. + + + Destroy the classifier. + Handle of the classifier. + + + Create a new classifier. + Handle of the classifier. + + + Describe the classes of a box classifier. + Handle of the classifier. + Highest dimension for output. Default: 3 + Indices of the classes. + Indices of the boxes. + Lower bounds of the boxes (for each dimension). + Higher bounds of the boxes (for each dimension). + Number of training samples that were used to define this box (for each dimension). + Number of training samples that were assigned incorrectly to the box. + + + Classify a set of arrays. + Handle of the classifier. + Key of the test data. + Error during the assignment. + + + Classify a tuple of attributes with rejection class. + Handle of the classifier. + Array of attributes which has to be classified. Default: 1.0 + Number of the class, to which the array of attributes had been assigned or -1 for the rejection class. + + + Classify a tuple of attributes. + Handle of the classifier. + Array of attributes which has to be classified. Default: 1.0 + Number of the class to which the array of attributes had been assigned. + + + This operator is inoperable. It had the following function: Destroy all classifiers. + + + Convert image maps into other map types. + Input map. + Converted map. + Type of MapConverted. Default: "coord_map_sub_pix" + Width of images to be mapped. Default: "map_width" + + + Compute an absolute pose out of point correspondences between world and image coordinates. + X-Component of world coordinates. + Y-Component of world coordinates. + Z-Component of world coordinates. + Row-Component of image coordinates. + Column-Component of image coordinates. + The inner camera parameters from camera calibration. + Kind of algorithm Default: "iterative" + Type of pose quality to be returned in Quality. Default: "error" + Pose. + Pose quality. + + + Compute a pose out of a homography describing the relation between world and image coordinates. + The homography from world- to image coordinates. + The camera calibration matrix K. + Type of pose computation. Default: "decomposition" + Pose of the 2D object. + + + Calibrate the radial distortion. + Contours that are available for the calibration. + Contours that were used for the calibration + Width of the images from which the contours were extracted. Default: 640 + Height of the images from which the contours were extracted. Default: 480 + Threshold for the classification of outliers. Default: 0.05 + Seed value for the random number generator. Default: 42 + Determines the distortion model. Default: "division" + Determines how the distortion center will be estimated. Default: "variable" + Controls the deviation of the distortion center from the image center; larger values allow larger deviations from the image center; 0 switches the penalty term off. Default: 0.0 + Internal camera parameters. + + + Compute a camera matrix from internal camera parameters. + Internal camera parameters. + 3x3 projective camera matrix that corresponds to CameraParam. + Width of the images that correspond to CameraMatrix. + Height of the images that correspond to CameraMatrix. + + + Compute the internal camera parameters from a camera matrix. + 3x3 projective camera matrix that determines the internal camera parameters. + Kappa. + Width of the images that correspond to CameraMatrix. + Height of the images that correspond to CameraMatrix. + Internal camera parameters. + + + Perform a self-calibration of a stationary projective camera. + Number of different images that are used for the calibration. + Width of the images from which the points were extracted. + Height of the images from which the points were extracted. + Index of the reference image. + Indices of the source images of the transformations. + Indices of the target images of the transformations. + Array of 3x3 projective transformation matrices. + Row coordinates of corresponding points in the respective source images. + Column coordinates of corresponding points in the respective source images. + Row coordinates of corresponding points in the respective destination images. + Column coordinates of corresponding points in the respective destination images. + Number of point correspondences in the respective image pair. + Estimation algorithm for the calibration. Default: "gold_standard" + Camera model to be used. Default: ["focus","principal_point"] + Are the camera parameters identical for all images? Default: "true" + (Array of) 3x3 projective camera matrices that determine the internal camera parameters. + Radial distortion of the camera. + Array of 3x3 transformation matrices that determine rotation of the camera in the respective image. + X-Component of the direction vector of each point if EstimationMethod $=$ 'gold_standard' is used. + Y-Component of the direction vector of each point if EstimationMethod $=$ 'gold_standard' is used. + Z-Component of the direction vector of each point if EstimationMethod $=$ 'gold_standard' is used. + Average error per reconstructed point if EstimationMethod $=$ 'gold_standard' is used. + + + Determine the 3D pose of a rectangle from its perspective 2D projection + Contour(s) to be examined. + Internal camera parameters. + Width of the rectangle in meters. + Height of the rectangle in meters. + Weighting mode for the optimization phase. Default: "nonweighted" + Clipping factor for the elimination of outliers (typical: 1.0 for 'huber' and 3.0 for 'tukey'). Default: 2.0 + 3D pose of the rectangle. + Covariances of the pose values. + Root-mean-square value of the final residual error. + + + Determine the 3D pose of a circle from its perspective 2D projection. + Contours to be examined. + Internal camera parameters. + Radius of the circle in object space. + Type of output parameters. Default: "pose" + 3D pose of the first circle. + 3D pose of the second circle. + + + Perform a radiometric self-calibration of a camera. + Input images. + Ratio of the exposure energies of successive image pairs. Default: 0.5 + Features that are used to compute the inverse response function of the camera. Default: "2d_histogram" + Type of the inverse response function of the camera. Default: "discrete" + Smoothness of the inverse response function of the camera. Default: 1.0 + Degree of the polynomial if FunctionType = 'polynomial'. Default: 5 + Inverse response function of the camera. + + + Apply a general transformation to an image. + Image to be mapped. + Image containing the mapping data. + Mapped image. + + + Generate a projection map that describes the mapping of images corresponding to a changing radial distortion. + Image containing the mapping data. + Old camera parameters. + New camera parameters. + Type of the mapping. Default: "bilinear" + + + Generate a projection map that describes the mapping between the image plane and a the plane z=0 of a world coordinate system. + Image containing the mapping data. + Internal camera parameters. + 3D pose of the world coordinate system in camera coordinates. + Width of the images to be transformed. + Height of the images to be transformed. + Width of the resulting mapped images in pixels. + Height of the resulting mapped images in pixels. + Scale or unit. Default: "m" + Type of the mapping. Default: "bilinear" + + + Rectify an image by transforming it into the plane z=0 of a world coordinate system. + Input image. + Transformed image. + Internal camera parameters. + 3D pose of the world coordinate system in camera coordinates. + Width of the resulting image in pixels. + Height of the resulting image in pixels. + Scale or unit Default: "m" + Type of interpolation. Default: "bilinear" + + + Transform an XLD contour into the plane z=0 of a world coordinate system. + Input XLD contours to be transformed in image coordinates. + Transformed XLD contours in world coordinates. + Internal camera parameters. + 3D pose of the world coordinate system in camera coordinates. + Scale or dimension Default: "m" + + + Transform image points into the plane z=0 of a world coordinate system. + Internal camera parameters. + 3D pose of the world coordinate system in camera coordinates. + Row coordinates of the points to be transformed. Default: 100.0 + Column coordinates of the points to be transformed. Default: 100.0 + Scale or dimension Default: "m" + X coordinates of the points in the world coordinate system. + Y coordinates of the points in the world coordinate system. + + + Translate the origin of a 3D pose. + original 3D pose. + translation of the origin in x-direction. Default: 0 + translation of the origin in y-direction. Default: 0 + translation of the origin in z-direction. Default: 0 + new 3D pose after applying the translation. + + + Perform a hand-eye calibration. + Linear list containing all the x coordinates of the calibration points (in the order of the images). + Linear list containing all the y coordinates of the calibration points (in the order of the images). + Linear list containing all the z coordinates of the calibration points (in the order of the images). + Linear list containing all row coordinates of the calibration points (in the order of the images). + Linear list containing all the column coordinates of the calibration points (in the order of the images). + Number of the calibration points for each image. + Known 3D pose of the robot for each image (moving camera: robot base in robot tool coordinates; stationary camera: robot tool in robot base coordinates). + Internal camera parameters. + Method of hand-eye calibration. Default: "nonlinear" + Type of quality assessment. Default: "error_pose" + Computed relative camera pose: 3D pose of the robot tool (moving camera) or robot base (stationary camera), respectively, in camera coordinates. + Computed 3D pose of the calibration points in robot base coordinates (moving camera) or in robot tool coordinates (stationary camera), respectively. + Quality assessment of the result. + + + Get the representation type of a 3D pose. + 3D pose. + Order of rotation and translation. + Meaning of the rotation values. + View of transformation. + + + Change the representation type of a 3D pose. + Original 3D pose. + Order of rotation and translation. Default: "Rp+T" + Meaning of the rotation values. Default: "gba" + View of transformation. Default: "point" + 3D transformation. + + + Create a 3D pose. + Translation along the x-axis (in [m]). Default: 0.1 + Translation along the y-axis (in [m]). Default: 0.1 + Translation along the z-axis (in [m]). Default: 0.1 + Rotation around x-axis or x component of the Rodriguez vector (in [ deg] or without unit). Default: 90.0 + Rotation around y-axis or y component of the Rodriguez vector (in [ deg] or without unit). Default: 90.0 + Rotation around z-axis or z component of the Rodriguez vector (in [ deg] or without unit). Default: 90.0 + Order of rotation and translation. Default: "Rp+T" + Meaning of the rotation values. Default: "gba" + View of transformation. Default: "point" + 3D pose. + + + Change the radial distortion of contours. + Original contours. + Resulting contours with modified radial distortion. + Internal camera parameter for Contours. + Internal camera parameter for ContoursRectified. + + + Change the radial distortion of pixel coordinates. + Original row component of pixel coordinates. + Original column component of pixel coordinates. + The inner camera parameters of the camera used to create the input pixel coordinates. + The inner camera parameters of a camera. + Row component of pixel coordinates after changing the radial distortion. + Column component of pixel coordinates after changing the radial distortion. + + + Change the radial distortion of an image. + Original image. + Region of interest in ImageRectified. + Resulting image with modified radial distortion. + Internal camera parameter for Image. + Internal camera parameter for Image. + + + Determine new camera parameters in accordance to the specified radial distortion. + Mode Default: "adaptive" + Internal camera parameters (original). + Desired radial distortions. Default: 0.0 + Internal camera parameters (modified). + + + Generate a calibration plate description file and a corresponding PostScript file for a calibration plate with rectangularly arranged marks. + Number of marks in x direction. Default: 7 + Number of marks in y direction. Default: 7 + Distance of the marks in meters. Default: 0.0125 + Ratio of the mark diameter to the mark distance. Default: 0.5 + File name of the calibration plate description. Default: "caltab.descr" + File name of the PostScript file. Default: "caltab.ps" + + + Generate a calibration plate description file and a corresponding PostScript file for a calibration plate with hexagonally arranged marks. + Number of rows. Default: 27 + Number of marks per row. Default: 31 + Diameter of the marks. Default: 0.00258065 + Row indices of the finder patterns. Default: [13,6,6,20,20] + Column indices of the finder patterns. Default: [15,6,24,6,24] + Polarity of the marks Default: "light_on_dark" + File name of the calibration plate description. Default: "calplate.cpd" + File name of the PostScript file. Default: "calplate.ps" + + + Read the mark center points from the calibration plate description file. + File name of the calibration plate description. Default: "calplate_320mm.cpd" + X coordinates of the mark center points in the coordinate system of the calibration plate. + Y coordinates of the mark center points in the coordinate system of the calibration plate. + Z coordinates of the mark center points in the coordinate system of the calibration plate. + + + Compute the line of sight corresponding to a point in the image. + Row coordinate of the pixel. + Column coordinate of the pixel. + Internal camera parameters. + X coordinate of the first point on the line of sight in the camera coordinate system + Y coordinate of the first point on the line of sight in the camera coordinate system + Z coordinate of the first point on the line of sight in the camera coordinate system + X coordinate of the second point on the line of sight in the camera coordinate system + Y coordinate of the second point on the line of sight in the camera coordinate system + Z coordinate of the second point on the line of sight in the camera coordinate system + + + Project a homogeneous 3D point using a 3x4 projection matrix. + 3x4 projection matrix. + Input point (x coordinate). + Input point (y coordinate). + Input point (z coordinate). + Input point (w coordinate). + Output point (x coordinate). + Output point (y coordinate). + Output point (w coordinate). + + + Project a 3D point using a 3x4 projection matrix. + 3x4 projection matrix. + Input point (x coordinate). + Input point (y coordinate). + Input point (z coordinate). + Output point (x coordinate). + Output point (y coordinate). + + + Project 3D points into (sub-)pixel image coordinates. + X coordinates of the 3D points to be projected in the camera coordinate system. + Y coordinates of the 3D points to be projected in the camera coordinate system. + Z coordinates of the 3D points to be projected in the camera coordinate system. + Internal camera parameters. + Row coordinates of the projected points (in pixels). + Column coordinates of the projected points (in pixels). + + + Convert internal camera parameters and a 3D pose into a 3x4 projection matrix. + Internal camera parameters. + 3D pose. + 3x4 projection matrix. + + + Convert a homogeneous transformation matrix into a 3D pose. + Homogeneous transformation matrix. + Equivalent 3D pose. + + + Convert a 3D pose into a homogeneous transformation matrix. + 3D pose. + Equivalent homogeneous transformation matrix. + + + Deserialize the serialized internal camera parameters. + Handle of the serialized item. + Internal camera parameters. + + + Serialize the internal camera parameters. + Internal camera parameters. + Handle of the serialized item. + + + Deserialize a serialized pose. + Handle of the serialized item. + 3D pose. + + + Serialize a pose. + 3D pose. + Handle of the serialized item. + + + Read a 3D pose from a text file. + File name of the external camera parameters. Default: "campose.dat" + 3D pose. + + + Write a 3D pose to a text file. + 3D pose. + File name of the external camera parameters. Default: "campose.dat" + + + Read internal camera parameters from a file. + File name of internal camera parameters. Default: "campar.dat" + Internal camera parameters. + + + Write internal camera parameters into a file. + Internal camera parameters. + File name of internal camera parameters. Default: "campar.dat" + + + Simulate an image with calibration plate. + Simulated calibration image. + File name of the calibration plate description. Default: "calplate_320mm.cpd" + Internal camera parameters. + External camera parameters (3D pose of the calibration plate in camera coordinates). + Gray value of image background. Default: 128 + Gray value of calibration plate. Default: 80 + Gray value of calibration marks. Default: 224 + Scaling factor to reduce oversampling. Default: 1.0 + + + Project and visualize the 3D model of the calibration plate in the image. + Window in which the calibration plate should be visualized. + File name of the calibration plate description. Default: "calplate_320.cpd" + Internal camera parameters. + External camera parameters (3D pose of the calibration plate in camera coordinates). + Scaling factor for the visualization. Default: 1.0 + + + Determine all camera parameters by a simultaneous minimization process. + Ordered tuple with all x coordinates of the calibration marks (in meters). + Ordered tuple with all y coordinates of the calibration marks (in meters). + Ordered tuple with all z coordinates of the calibration marks (in meters). + Ordered tuple with all row coordinates of the extracted calibration marks (in pixels). + Ordered tuple with all column coordinates of the extracted calibration marks (in pixels). + Initial values for the internal camera parameters. + Ordered tuple with all initial values for the external camera parameters. + Camera parameters to be estimated. Default: "all" + Internal camera parameters. + Ordered tuple with all external camera parameters. + Average error distance in pixels. + + + Extract rectangularly arranged 2D calibration marks from the image and calculate initial values for the external camera parameters. + Input image. + Region of the calibration plate. + File name of the calibration plate description. Default: "caltab_100.descr" + Initial values for the internal camera parameters. + Initial threshold value for contour detection. Default: 128 + Loop value for successive reduction of StartThresh. Default: 10 + Minimum threshold for contour detection. Default: 18 + Filter parameter for contour detection, see edges_image. Default: 0.9 + Minimum length of the contours of the marks. Default: 15.0 + Maximum expected diameter of the marks. Default: 100.0 + Tuple with row coordinates of the detected marks. + Tuple with column coordinates of the detected marks. + Estimation for the external camera parameters. + + + Segment the region of a standard calibration plate with rectangularly arranged marks in the image. + Input image. + Output region. + File name of the calibration plate description. Default: "caltab_100.descr" + Filter size of the Gaussian. Default: 3 + Threshold value for mark extraction. Default: 112 + Expected minimal diameter of the marks on the calibration plate. Default: 5 + + + Free the memory of all camera setup models. + + + Free the memory of a calibration setup model. + Handle of the camera setup model. + + + Serialize a camera setup model. + Handle to the camera setup model. + Handle of the serialized item. + + + Deserialize a serialized camera setup model. + Handle of the serialized item. + Handle to the camera setup model. + + + Store a camera setup model into a file. + Handle to the camera setup model. + The file name of the model to be saved. + + + Restore a camera setup model from a file. + The path and file name of the model file. + Handle to the camera setup model. + + + Get generic camera setup model parameters. + Handle to the camera setup model. + Index of the camera in the setup. Default: 0 + Names of the generic parameters to be queried. + Values of the generic parameters to be queried. + + + Set generic camera setup model parameters. + Handle to the camera setup model. + Unique index of the camera in the setup. Default: 0 + Names of the generic parameters to be set. + Values of the generic parameters to be set. + + + Define type, parameters, and relative pose of a camera in a camera setup model. + Handle to the camera setup model. + Index of the camera in the setup. + Type of the camera. Default: [] + Internal camera parameters. + Pose of the camera relative to the setup's coordinate system. + + + Create a model for a setup of calibrated cameras. + Number of cameras in the setup. Default: 2 + Handle to the camera setup model. + + + Free the memory of all calibration data models. + + + Free the memory of a calibration data model. + Handle of a calibration data model. + + + Deserialize a serialized calibration data model. + Handle of the serialized item. + Handle of a calibration data model. + + + Serialize a calibration data model. + Handle of a calibration data model. + Handle of the serialized item. + + + Restore a calibration data model from a file. + The path and file name of the model file. + Handle of a calibration data model. + + + Store a calibration data model into a file. + Handle of a calibration data model. + The file name of the model to be saved. + + + Perform a hand-eye calibration. + Handle of a calibration data model. + Average residual error of the optimization. + + + Determine all camera parameters by a simultaneous minimization process. + Handle of a calibration data model. + Back projection root mean square error (RMSE) of the optimization. + + + Remove a data set from a calibration data model. + Handle of a calibration data model. + Type of the calibration data item. Default: "tool" + Index of the affected item. Default: 0 + + + Set data in a calibration data model. + Handle of a calibration data model. + Type of calibration data item. Default: "model" + Index of the affected item (depending on the selected ItemType). Default: "general" + Parameter(s) to set. Default: "reference_camera" + New value(s). Default: 0 + + + Find the HALCON calibration plate and set the extracted points and contours in a calibration data model. + Input image. + Handle of a calibration data model. + Index of the observing camera. Default: 0 + Index of the calibration object. Default: 0 + Index of the observed calibration object. Default: 0 + Names of the generic parameters to be set. Default: [] + Values of the generic parameters to be set. Default: [] + + + Remove observation data from a calibration data model. + Handle of a calibration data model. + Index of the observing camera. Default: 0 + Index of the observed calibration object. Default: 0 + Index of the observed calibration object pose. Default: 0 + + + Get contour-based observation data from a calibration data model. + Contour-based result(s). + Handle of a calibration data model. + Name of contour objects to be returned. Default: "marks" + Index of the observing camera. Default: 0 + Index of the observed calibration object. Default: 0 + Index of the observed calibration object pose. Default: 0 + + + Get observed calibration object poses from a calibration data model. + Handle of a calibration data model. + Index of the observing camera. Default: 0 + Index of the observed calibration object. Default: 0 + Index of the observed calibration object pose. Default: 0 + Stored observed calibration object pose relative to the observing camera. + + + Set observed calibration object poses in a calibration data model. + Handle of a calibration data model. + Index of the observing camera. Default: 0 + Index of the calibration object. Default: 0 + Index of the observed calibration object. Default: 0 + Pose of the observed calibration object relative to the observing camera. + + + Get point-based observation data from a calibration data model. + Handle of a calibration data model. + Index of the observing camera. Default: 0 + Index of the observed calibration object. Default: 0 + Index of the observed calibration object pose. Default: 0 + Row coordinates of the detected points. + Column coordinates of the detected points. + Correspondence of the detected points to the points of the observed calibration object. + Roughly estimated pose of the observed calibration object relative to the observing camera. + + + Set point-based observation data in a calibration data model. + Handle of a calibration data model. + Index of the observing camera. Default: 0 + Index of the calibration object. Default: 0 + Index of the observed calibration object. Default: 0 + Row coordinates of the extracted points. + Column coordinates of the extracted points. + Correspondence of the extracted points to the calibration marks of the observed calibration object. Default: "all" + Roughly estimated pose of the observed calibration object relative to the observing camera. + + + Query information about the relations between cameras, calibration objects, and calibration object poses. + Handle of a calibration data model. + Kind of referred object. Default: "camera" + Camera index or calibration object index (depending on the selected ItemType). Default: 0 + List of calibration object indices or list of camera indices (depending on ItemType). + Calibration object numbers. + + + Query data stored or computed in a calibration data model. + Handle of a calibration data model. + Type of calibration data item. Default: "camera" + Index of the affected item (depending on the selected ItemType). Default: 0 + The name of the inspected data. Default: "params" + Requested data. + + + Define a calibration object in a calibration model. + Handle of a calibration data model. + Calibration object index. Default: 0 + 3D point coordinates or a description file name. + + + Set type and initial parameters of a camera in a calibration data model. + Handle of a calibration data model. + Camera index. Default: 0 + Type of the camera. Default: [] + Initial camera internal parameters. + + + Create a HALCON calibration data model. + Type of the calibration setup. Default: "calibration_object" + Number of cameras in the calibration setup. Default: 1 + Number of calibration objects. Default: 1 + Handle of the created calibration data model. + + + Get the value of a parameter in a specific bead inspection model. + Handle of the bead inspection model. + Name of the model parameter that is queried. Default: "target_thickness" + Value of the queried model parameter. + + + Set parameters of the bead inspection model. + Handle of the bead inspection model. + Name of the model parameter that shall be adjusted for the specified bead inspection model. Default: "target_thickness" + Value of the model parameter that shall be adjusted for the specified bead inspection model. Default: 40 + + + Inspect beads in an image, as defined by the bead inspection model. + Image to apply bead inspection on. + The detected left contour of the beads. + The detected right contour of the beads. + Detected error segments + Handle of the bead inspection model to be used. + Types of detected errors. + + + Delete the bead inspection model and free the allocated memory. + Handle of the bead inspection model. + + + Create a model to inspect beads or adhesive in images. + XLD contour specifying the expected bead's shape and position. + Optimal bead thickness. Default: 50 + Tolerance of bead's thickness with respect to TargetThickness. Default: 15 + Tolerance of the bead's center position. Default: 15 + The bead's polarity. Default: "light" + Names of the generic parameters that can be adjusted for the bead inspection model. Default: [] + Values of the generic parameters that can be adjusted for the bead inspection model. Default: [] + Handle for using and accessing the bead inspection model. + + + Deserialize a bar code model. + Handle of the serialized item. + Handle of the bar code model. + + + Serialize a bar code model. + Handle of the bar code model. + Handle of the serialized item. + + + Read a bar code model from a file and create a new model. + Name of the bar code model file. Default: "bar_code_model.bcm" + Handle of the bar code model. + + + Write a bar code model to a file. + Handle of the bar code model. + Name of the bar code model file. Default: "bar_code_model.bcm" + + + Access iconic objects that were created during the search or decoding of bar code symbols. + Objects that are created as intermediate results during the detection or evaluation of bar codes. + Handle of the bar code model. + Indicating the bar code results respectively candidates for which the data is required. Default: "all" + Name of the iconic object to return. Default: "candidate_regions" + + + Get the alphanumerical results that were accumulated during the decoding of bar code symbols. + Handle of the bar code model. + Indicating the bar code results respectively candidates for which the data is required. Default: "all" + Names of the resulting data to return. Default: "decoded_types" + List with the results. + + + Decode bar code symbols within a rectangle. + Input image. + Handle of the bar code model. + Type of the searched bar code. Default: "EAN-13" + Row index of the center. Default: 50.0 + Column index of the center. Default: 100.0 + Orientation of rectangle in radians. Default: 0.0 + Half of the length of the rectangle along the reading direction of the bar code. Default: 200.0 + Half of the length of the rectangle perpendicular to the reading direction of the bar code. Default: 100.0 + Data strings of all successfully decoded bar codes. + + + Detect and read bar code symbols in an image. + Input image. If the image has a reduced domain, the barcode search is reduced to that domain. This usually reduces the runtime of the operator. However, if the barcode is not fully inside the domain, the barcode cannot be decoded correctly. + Regions of the successfully decoded bar code symbols. + Handle of the bar code model. + Type of the searched bar code. Default: "auto" + Data strings of all successfully decoded bar codes. + + + Get the names of the parameters that can be used in set_bar_code* and get_bar_code* operators for a given bar code model + Handle of the bar code model. + Properties of the parameters. Default: "trained_general" + Names of the generic parameters. + + + Get parameters that are used by the bar code reader when processing a specific bar code type. + Handle of the bar code model. + Names of the bar code types for which parameters should be queried. Default: "EAN-13" + Names of the generic parameters that are to be queried for the bar code model. Default: "check_char" + Values of the generic parameters. + + + Get one or several parameters that describe the bar code model. + Handle of the bar code model. + Names of the generic parameters that are to be queried for the bar code model. Default: "element_size_min" + Values of the generic parameters. + + + Set selected parameters of the bar code model for selected bar code types + Handle of the bar code model. + Names of the bar code types for which parameters should be set. Default: "EAN-13" + Names of the generic parameters that shall be adjusted for finding and decoding bar codes. Default: "check_char" + Values of the generic parameters that are adjusted for finding and decoding bar codes. Default: "absent" + + + Set selected parameters of the bar code model. + Handle of the bar code model. + Names of the generic parameters that shall be adjusted for finding and decoding bar codes. Default: "element_size_min" + Values of the generic parameters that are adjusted for finding and decoding bar codes. Default: 8 + + + This operator is inoperable. It had the following function: Delete all bar code models and free the allocated memory + + + Delete a bar code model and free the allocated memory + Handle of the bar code model. + + + Create a model of a bar code reader. + Names of the generic parameters that can be adjusted for the bar code model. Default: [] + Values of the generic parameters that can be adjusted for the bar code model. Default: [] + Handle for using and accessing the bar code model. + + + Delete the background estimation data set. + ID of the BgEsti data set. + + + Return the estimated background image. + Estimated background image of the current data set. + ID of the BgEsti data set. + + + Change the estimated background image. + Current image. + Region describing areas to change. + ID of the BgEsti data set. + + + Estimate the background and return the foreground region. + Current image. + Region of the detected foreground. + ID of the BgEsti data set. + + + Return the parameters of the data set. + ID of the BgEsti data set. + 1. system matrix parameter. + 2. system matrix parameter. + Gain type. + Kalman gain / foreground adaptation time. + Kalman gain / background adaptation time. + Threshold adaptation. + Foreground / background threshold. + Number of statistic data sets. + Confidence constant. + Constant for decay time. + + + Change the parameters of the data set. + ID of the BgEsti data set. + 1. system matrix parameter. Default: 0.7 + 2. system matrix parameter. Default: 0.7 + Gain type. Default: "fixed" + Kalman gain / foreground adaptation time. Default: 0.002 + Kalman gain / background adaptation time. Default: 0.02 + Threshold adaptation. Default: "on" + Foreground/background threshold. Default: 7.0 + Number of statistic data sets. Default: 10 + Confidence constant. Default: 3.25 + Constant for decay time. Default: 15.0 + + + Generate and initialize a data set for the background estimation. + initialization image. + 1. system matrix parameter. Default: 0.7 + 2. system matrix parameter. Default: 0.7 + Gain type. Default: "fixed" + Kalman gain / foreground adaptation time. Default: 0.002 + Kalman gain / background adaptation time. Default: 0.02 + Threshold adaptation. Default: "on" + Foreground/background threshold. Default: 7.0 + Number of statistic data sets. Default: 10 + Confidence constant. Default: 3.25 + Constant for decay time. Default: 15.0 + ID of the BgEsti data set. + + + This operator is inoperable. It had the following function: Delete all background estimation data sets. + + + Perform an action on I/O channels. + Handles of the opened I/O channels. + Name of the action to perform. + List of arguments for the action. Default: [] + List of values returned by the action. + + + Write a value to the specified I/O channels. + Handles of the opened I/O channels. + Write values. + Status of written values. + + + Read a value from the specified I/O channels. + Handles of the opened I/O channels. + Read value. + Status of read value. + + + Set specific parameters of I/O channels. + Handles of the opened I/O channels. + Parameter names. Default: [] + Parameter values to set. Default: [] + + + Query specific parameters of I/O channels. + Handles of the opened I/O channels. + Parameter names. Default: "param_name" + Parameter values. + + + Close I/O channels. + Handles of the opened I/O channels. + + + Open and configure I/O channels. + Handle of the opened I/O device. + HALCON I/O channel names of the specified device. + Parameter names. Default: [] + Parameter values. Default: [] + Handles of the opened I/O channel. + + + Query information about channels of the specified I/O device. + Handle of the opened I/O device. + Channel names to query. + Name of the query. Default: "param_name" + List of values (according to Query). + + + Perform an action on the I/O device. + Handle of the opened I/O device. + Name of the action to perform. + List of arguments for the action. Default: [] + List of result values returned by the action. + + + Configure a specific I/O device instance. + Handle of the opened I/O device. + Parameter names. Default: [] + Parameter values to set. Default: [] + + + Query settings of an I/O device instance. + Handle of the opened I/O device. + Parameter names. Default: "param_name" + Parameter values. + + + Close the specified I/O device. + Handle of the opened I/O device. + + + Open and configure an I/O device. + HALCON I/O interface name. Default: [] + I/O device name. Default: [] + Dynamic parameter names. Default: [] + Dynamic parameter values. Default: [] + Handle of the opened I/O device. + + + Perform an action on the I/O interface. + HALCON I/O interface name. Default: [] + Name of the action to perform. + List of arguments for the action. Default: [] + List of results returned by the action. + + + Query information about the specified I/O device interface. + HALCON I/O interface name. Default: [] + Parameter name of the query. Default: "io_device_names" + List of result values (according to Query). + + + Query specific parameters of an image acquisition device. + Handle of the acquisition device to be used. + Parameter of interest. Default: "revision" + Parameter value. + + + Set specific parameters of an image acquistion device. + Handle of the acquisition device to be used. + Parameter name. + Parameter value to be set. + + + Query callback function of an image acquisition device. + Handle of the acquisition device to be used. + Callback type. Default: "transfer_end" + Pointer to the callback function. + Pointer to user-specific context data. + + + Register a callback function for an image acquisition device. + Handle of the acquisition device to be used. + Callback type. Default: "transfer_end" + Pointer to the callback function to be set. + Pointer to user-specific context data. + + + Asynchronous grab of images and preprocessed image data from the specified image acquisition device. + Grabbed image data. + Pre-processed image regions. + Pre-processed XLD contours. + Handle of the acquisition device to be used. + Maximum tolerated delay between the start of the asynchronous grab and the delivery of the image [ms]. Default: -1.0 + Pre-processed control data. + + + Synchronous grab of images and preprocessed image data from the specified image acquisition device. + Grabbed image data. + Preprocessed image regions. + Preprocessed XLD contours. + Handle of the acquisition device to be used. + Preprocessed control data. + + + Asynchronous grab of an image from the specified image acquisition device. + Grabbed image. + Handle of the acquisition device to be used. + Maximum tolerated delay between the start of the asynchronous grab and the delivery of the image [ms]. Default: -1.0 + + + Start an asynchronous grab from the specified image acquisition device. + Handle of the acquisition device to be used. + This parameter is obsolete and has no effect. Default: -1.0 + + + Synchronous grab of an image from the specified image acquisition device. + Grabbed image. + Handle of the acquisition device to be used. + + + Query information about the specified image acquisition interface. + HALCON image acquisition interface name, i.e., name of the corresponding DLL (Windows) or shared library (Linux/macOS). Default: "File" + Name of the chosen query. Default: "info_boards" + Textual information (according to Query). + List of values (according to Query). + + + This operator is inoperable. It had the following function: Close all image acquisition devices. + + + Close specified image acquisition device. + Handle of the image acquisition device to be closed. + + + Open and configure an image acquisition device. + HALCON image acquisition interface name, i.e., name of the corresponding DLL (Windows) or shared library (Linux/macOS). Default: "File" + Desired horizontal resolution of image acquisition interface (absolute value or 1 for full resolution, 2 for half resolution, or 4 for quarter resolution). Default: 1 + Desired vertical resolution of image acquisition interface (absolute value or 1 for full resolution, 2 for half resolution, or 4 for quarter resolution). Default: 1 + Width of desired image part (absolute value or 0 for HorizontalResolution - 2*StartColumn). Default: 0 + Height of desired image part (absolute value or 0 for VerticalResolution - 2*StartRow). Default: 0 + Line number of upper left corner of desired image part (or border height if ImageHeight = 0). Default: 0 + Column number of upper left corner of desired image part (or border width if ImageWidth = 0). Default: 0 + Desired half image or full image. Default: "default" + Number of transferred bits per pixel and image channel (-1: device-specific default value). Default: -1 + Output color format of the grabbed images, typically 'gray' or 'raw' for single-channel or 'rgb' or 'yuv' for three-channel images ('default': device-specific default value). Default: "default" + Generic parameter with device-specific meaning. Default: -1 + External triggering. Default: "default" + Type of used camera ('default': device-specific default value). Default: "default" + Device the image acquisition device is connected to ('default': device-specific default value). Default: "default" + Port the image acquisition device is connected to (-1: device-specific default value). Default: -1 + Camera input line of multiplexer (-1: device-specific default value). Default: -1 + Handle of the opened image acquisition device. + + + Query look-up table of the image acquisition device. + Handle of the acquisition device to be used. + Red level of the LUT entries. + Green level of the LUT entries. + Blue level of the LUT entries. + + + Set look-up table of the image acquisition device. + Handle of the acquisition device to be used. + Red level of the LUT entries. + Green level of the LUT entries. + Blue level of the LUT entries. + + + Add a text label to a 3D scene. + Handle of the 3D scene. + Text of the label. Default: "label" + Point of reference of the label. + Position of the label. Default: "top" + Indicates fixed or relative positioning. Default: "point" + Index of the new label in the 3D scene. + + + Remove a text label from a 3D scene. + Handle of the 3D scene. + Index of the text label to remove. + + + Set parameters of a text label in a 3D scene. + Handle of the 3D scene. + Index of the text label. + Names of the generic parameters. Default: "color" + Values of the generic parameters. Default: "red" + + + Add training images to the texture inspection model. + Image of flawless texture. + Handle of the texture inspection model. + Indices of the images that have been added to the texture inspection model. + + + Inspection of the texture within an image. + Image of the texture to be inspected. + Novelty regions. + Handle of the texture inspection model. + Handle of the inspection results. + + + bilateral filtering of an image. + Image to be filtered. + Joint image. + Filtered output image. + Size of the Gaussian of the closeness function. Default: 3.0 + Size of the Gaussian of the similarity function. Default: 20.0 + Generic parameter name. Default: [] + Generic parameter value. Default: [] + + + Clear an CNN-based OCR classifier. + Handle of the OCR classifier. + + + Clear a texture inspection model and free the allocated memory. + Handle of the texture inspection model. + + + Clear a texture inspection result handle and free the allocated memory. + Handle of the texture inspection results. + + + Convert image coordinates to window coordinates + Window handle + Row in image coordinates. + Column in image coordinates. + Row (Y) in window coordinates. + Column (X) in window coordinates. + + + Convert window coordinates to image coordinates + Window handle. + Row (Y) in window coordinates. + Column (X) in window coordinates. + Row in image coordinates. + Column in image coordinates. + + + Create a texture inspection model. + The type of the created texture inspection model. Default: "basic" + Handle for using and accessing the texture inspection model. + + + Deserialize a serialized dual quaternion. + Handle of the serialized item. + Dual quaternion. + + + Deserialize a serialized CNN-based OCR classifier. + Handle of the serialized item. + Handle of the OCR classifier. + + + Deserialize a serialized texture inspection model. + Handle of the serialized item. + Handle of the texture inspection model. + + + Display text in a window. + Window handle. + A tuple of strings containing the text message to be displayed. Each value of the tuple will be displayed in a single line. Default: "hello" + If set to 'window', the text position is given with respect to the window coordinate system. If set to 'image', image coordinates are used (this may be useful in zoomed images). Default: "window" + The vertical text alignment or the row coordinate of the desired text position. Default: 12 + The horizontal text alignment or the column coordinate of the desired text position. Default: 12 + A tuple of strings defining the colors of the texts. Default: "black" + Generic parameter names. Default: [] + Generic parameter values. Default: [] + + + Classify multiple characters with an CNN-based OCR classifier. + Characters to be recognized. + Gray values of the characters. + Handle of the OCR classifier. + Result of classifying the characters with the CNN. + Confidence of the class of the characters. + + + Classify a single character with an CNN-based OCR classifier. + Character to be recognized. + Gray values of the character. + Handle of the OCR classifier. + Number of best classes to determine. Default: 1 + Result of classifying the character with the CNN. + Confidence(s) of the class(es) of the character. + + + Classify a related group of characters with an CNN-based OCR classifier. + Characters to be recognized. + Gray values of the characters. + Handle of the OCR classifier. + Expression describing the allowed word structure. + Number of classes per character considered for the internal word correction. Default: 3 + Maximum number of corrected characters. Default: 2 + Result of classifying the characters with the CNN. + Confidence of the class of the characters. + Word text after classification and correction. + Measure of similarity between corrected word and uncorrected classification results. + + + Multiply two dual quaternions. + Left dual quaternion. + Right dual quaternion. + Product of the dual quaternions. + + + Conjugate a dual quaternion. + Dual quaternion. + Conjugate of the dual quaternion. + + + Interpolate two dual quaternions. + Dual quaternion as the start point of the interpolation. + Dual quaternion as the end point of the interpolation. + Interpolation parameter. Default: 0.5 + Interpolated dual quaternion. + + + Normalize a dual quaternion. + Unit dual quaternion. + Normalized dual quaternion. + + + Convert a unit dual quaternion into a homogeneous transformation matrix. + Unit dual quaternion. + Transformation matrix. + + + Convert a dual quaternion to a 3D pose. + Unit dual quaternion. + 3D pose. + + + Convert a unit dual quaternion into a screw. + Unit dual quaternion. + Format of the screw parameters. Default: "moment" + X component of the direction vector of the screw axis. + Y component of the direction vector of the screw axis. + Z component of the direction vector of the screw axis. + X component of the moment vector or a point on the screw axis. + Y component of the moment vector or a point on the screw axis. + Z component of the moment vector or a point on the screw axis. + Rotation angle in radians. + Translation. + + + Transform a 3D line with a unit dual quaternion. + Unit dual quaternion representing the transformation. + Format of the line parameters. Default: "moment" + X component of the direction vector of the line. + Y component of the direction vector of the line. + Z component of the direction vector of the line. + X component of the moment vector or a point on the line. + Y component of the moment vector or a point on the line. + Z component of the moment vector or a point on the line. + X component of the direction vector of the transformed line. + Y component of the direction vector of the transformed line. + Z component of the direction vector of the transformed line. + X component of the moment vector or a point on the transformed line. + Y component of the moment vector or a point on the transformed line. + Z component of the moment vector or a point on the transformed line. + + + Find edges in a 3D object model. + Handle of the 3D object model whose edges should be computed. + Edge threshold. + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + 3D object model containing the edges. + + + Find the best matches of multiple NCC models. + Input image in which the model should be found. + Handle of the models. + Smallest rotation of the models. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Minimum score of the instances of the models to be found. Default: 0.8 + Number of instances of the models to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the models to be found. Default: 0.5 + Subpixel accuracy if not equal to 'none'. Default: "true" + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + Row coordinate of the found instances of the models. + Column coordinate of the found instances of the models. + Rotation angle of the found instances of the models. + Score of the found instances of the models. + Index of the found instances of the models. + + + Find the best matches of a surface model in a 3D scene and images. + Images of the scene. + Handle of the surface model. + Handle of the 3D object model containing the scene. + Scene sampling distance relative to the diameter of the surface model. Default: 0.05 + Fraction of sampled scene points used as key points. Default: 0.2 + Minimum score of the returned poses. Default: 0 + Enable returning a result handle in SurfaceMatchingResultID. Default: "false" + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + 3D pose of the surface model in the scene. + Score of the found instances of the surface model. + Handle of the matching result, if enabled in ReturnResultHandle. + + + Flush the contents of a window. + Window handle. + + + Return the region used to create an NCC model. + Model region of the NCC model. + Handle of the model. + + + Return the parameters of a CNN-based OCR classifier. + Handle of the OCR classifier. + A tuple of generic parameter names. Default: "characters" + A tuple of generic parameter values. + + + Get the current color in RGBA-coding. + Window handle. + The current color's red value. + The current color's green value. + The current color's blue value. + The current color's alpha value. + + + Get intermediate 3D object model of a stereo reconstruction + Handle des Stereomodells. + Namen der Modellparameter. + Werte der Modellparameter. + + + Get the training images contained in a texture inspection model. + Training images contained in the texture inspection model. + Handle of the texture inspection model. + + + Query parameters of a texture inspection model. + Handle of the texture inspection model. + Name of the queried model parameter. Default: "novelty_threshold" + Value of the queried model parameter. + + + Query iconic results of a texture inspection. + Returned iconic object. + Handle of the texture inspection result. + Name of the iconic object to be returned. Default: "novelty_region" + + + Guided filtering of an image. + Input image. + Guidance image. + Output image. + Radius of the filtering operation. Default: 3 + Controls the influence of edges on the smoothing. Default: 20.0 + + + Create an interleaved image from a multichannel image. + Input multichannel image. + Output interleaved image. + Target format for InterleavedImage. Default: "rgba" + Number of bytes in a row of the output image. Default: "match" + Alpha value for three channel input images. Default: 255 + + + Convert a 3D pose to a unit dual quaternion. + 3D pose. + Unit dual quaternion. + + + Get the names of the parameters that can be used in get_params_ocr_class_cnn for a given CNN-based OCR classifier. + Handle of OCR classifier. + Names of the generic parameters. + + + Read an CNN-based OCR classifier from a file. + File name. Default: "Universal_Rej.occ" + Handle of the OCR classifier. + + + Read a texture inspection model from a file. + File name. + Handle of the texture inspection model. + + + Refine the pose of a surface model in a 3D scene and in images. + Images of the scene. + Handle of the surface model. + Handle of the 3D object model containing the scene. + Initial pose of the surface model in the scene. + Minimum score of the returned poses. Default: 0 + Enable returning a result handle in SurfaceMatchingResultID. Default: "false" + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + 3D pose of the surface model in the scene. + Score of the found instances of the model. + Handle of the matching result, if enabled in ReturnResultHandle. + + + Clear all or a user-defined subset of the images of a texture inspection model. + Handle of the texture inspection model. + Indices of the images to be deleted from the texture inspection model. + Indices of the images that remain in the texture inspection model. + + + Convert a screw into a dual quaternion. + Format of the screw parameters. Default: "moment" + X component of the direction vector of the screw axis. + Y component of the direction vector of the screw axis. + Z component of the direction vector of the screw axis. + X component of the moment vector or a point on the screw axis. + Y component of the moment vector or a point on the screw axis. + Z component of the moment vector or a point on the screw axis. + Rotation angle in radians. + Translation. + Dual quaternion. + + + Segment image using Maximally Stable Extremal Regions (MSER). + Input image. + Segmented dark MSERs. + Segmented light MSERs. + The polarity of the returned MSERs. Default: "both" + Minimal size of an MSER. Default: 10 + Maximal size of an MSER. Default: [] + Amount of thresholds for which a region needs to be stable. Default: 15 + List of generic parameter names. Default: [] + List of generic parameter values. Default: [] + + + Send an event to a buffer window signaling a mouse double click event. + Window handle of the buffer window. + Row coordinate of the mouse cursor in the image coordinate system. + Column coordinate of the mouse cursor in the image coordinate system. + Mouse button(s) pressed. + 'true', if HALCON processed the event. + + + Send an event to a window buffer signaling a mouse down event. + Window handle of the buffer window. + Row coordinate of the mouse cursor in the image coordinate system. + Column coordinate of the mouse cursor in the image coordinate system. + Mouse button(s) pressed. + 'true', if HALCON processed the event. + + + Send an event to a buffer window signaling a mouse drag event. + Window handle of the buffer window. + Row coordinate of the mouse cursor in the image coordinate system. + Column coordinate of the mouse cursor in the image coordinate system. + Mouse button(s) pressed. + 'true', if HALCON processed the event. + + + Send an event to a buffer window signaling a mouse up event. + Window handle of the buffer window. + Row coordinate of the mouse cursor in the image coordinate system. + Column coordinate of the mouse cursor in the image coordinate system. + Mouse button(s) pressed. + 'true', if HALCON processed the event. + + + Serialize a dual quaternion. + Dual quaternion. + Handle of the serialized item. + + + Serialize a CNN-based OCR classifier + Handle of the OCR classifier. + Handle of the serialized item. + + + Serialize a texture inspection model. + Handle of the texture inspection model. + Handle of the serialized item. + + + Sets the callback for content updates in buffer window. + Window handle. + Callback for content updates. + Parameter to CallbackFunction. + + + Set the color definition via RGBA values. + Window handle. + Red component of the color. Default: 255 + Green component of the color. Default: 0 + Blue component of the color. Default: 0 + Alpha component of the color. Default: 255 + + + Set parameters and properties of a surface model. + Handle of the surface model. + Name of the parameter. Default: "camera_parameter" + Value of the parameter. + + + Set parameters of a texture inspection model. + Handle of the texture inspection model. + Name of the model parameter to be adjusted. Default: "gen_result_handle" + New value of the model parameter. Default: "true" + + + Train a texture inspection model. + Handle of the texture inspection model. + + + Write a texture inspection model to a file. + Handle of the texture inspection model. + File name. + + + Reconstruct a surface from several, differently illuminated images. + The Images. + The NormalField. + The Gradient. + The Albedo. + The Result type. Default: "all" + + + Infer the class affiliations for a set of images using a deep-learning-based classifier. + Tuple of input images. + Handle of the deep-learning-based classifier. + Handle of the deep learning classification results. + + + Clear a deep-learning-based classifier. + Handle of the deep-learning-based classifier. + + + Clear a handle containing the results of the deep-learning-based classification. + Handle of the deep learning classification results. + + + Clear the handle of a deep-learning-based classifier training result. + Handle of the training results from the deep-learning-based classifier. + + + Clear a structured light model and free the allocated memory. + Handle of the structured light model. + + + Create a structured light model. + The type of the created structured light model. Default: "deflectometry" + Handle for using and accessing the structured light model. + + + Decode the camera images acquired with a structured light setup. + Acquired camera images. + Handle of the structured light model. + + + Deserialize a deep-learning-based classifier. + Handle of the serialized item. + Handle of the deep-learning-based classifier. + + + Deserialize a structured light model. + Handle of the serialized item. + Handle of the structured light model. + + + Calculate the minimum distance between two contours and the points used for the calculation. + First input contour. + Second input contour. + Distance calculation mode. Default: "fast_point_to_segment" + Minimum distance between the two contours. + Row coordinate of the point on Contour1. + Column coordinate of the point on Contour1. + Row coordinate of the point on Contour2. + Column coordinate of the point on Contour2. + + + Fuse 3D object models into a surface. + Handles of the 3D object models. + The two opposite bound box corners. + Used resolution within the bounding box. Default: 1.0 + Distance of expected noise to surface. Default: 1.0 + Minimum thickness of the object in direction of the surface normal. Default: 1.0 + Weight factor for data fidelity. Default: 1.0 + Direction of normals of the input models. Default: "inwards" + Name of the generic parameter. Default: [] + Value of the generic parameter. Default: [] + Handle of the fused 3D object model. + + + Generate the pattern images to be displayed in a structured light setup. + Generated pattern images. + Handle of the structured light model. + + + Return the parameters of a deep-learning-based classifier. + Handle of the deep-learning-based classifier. + Name of the generic parameter. Default: "gpu" + Value of the generic parameter. + + + Retrieve classification results inferred by a deep-learning-based classifier. + Handle of the deep learning classification results. + Index of the image in the batch. Default: "all" + Name of the generic parameter. Default: "predicted_classes" + Value of the generic parameter, either the confidence values, the class names or class indices. + + + Return the results for the single training step of a deep-learning-based classifier. + Handle of the training results from the deep-learning-based classifier. + Name of the generic parameter. Default: "loss" + Value of the generic parameter. + + + Query parameters of a structured light model. + Handle of the structured light model. + Name of the queried model parameter. Default: "min_stripe_width" + Value of the queried model parameter. + + + Get (intermediate) iconic results of a structured light model. + Iconic result. + Handle of the structured light model. + Name of the iconic result to be returned. Default: "correspondence_image" + + + Compute the width, height, and aspect ratio of the surrounding rectangle parallel to the coordinate axes. + Regions to be examined. + Height of the surrounding rectangle of the region. + Width of the surrounding rectangle of the region. + Aspect ratio of the surrounding rectangle of the region. + + + Compute the width, height, and aspect ratio of the enclosing rectangle parallel to the coordinate axes of contours or polygons. + Contours or polygons to be examined. + Height of the enclosing rectangle. + Width of the enclosing rectangle. + Aspect ratio of the enclosing rectangle. + + + Insert objects into an iconic object tuple. + Input object tuple. + Object tuple to insert. + Extended object tuple. + Index to insert objects. + + + Read a deep-learning-based classifier from a file. + File name. Default: "pretrained_dl_classifier_compact.hdl" + Handle of the deep learning classifier. + + + Read a structured light model from a file. + File name. + Handle of the structured light model. + + + Remove objects from an iconic object tuple. + Input object tuple. + Remaining object tuple. + Indices of the objects to be removed. + + + Replaces one or more elements of an iconic object tuple. + Iconic Input Object. + Element(s) to replace. + Tuple with replaced elements. + Index/Indices of elements to be replaced. + + + Serialize a deep-learning-based classifier. + Handle of the deep-learning-based classifier. + Handle of the serialized item. + + + Serialize a structured light model. + Handle of the structured light model. + Handle of the serialized item. + + + Set the parameters of a deep-learning-based classifier. + Handle of the deep-learning-based classifier. + Name of the generic parameter. Default: "classes" + Value of the generic parameter. Default: ["class_1","class_2","class_3"] + + + Set a timeout for an operator. + Operator for which the timeout shall be set. + Timeout in seconds. Default: 1 + Timeout mode to be set. Default: "cancel" + + + Set parameters of a structured light model. + Handle of the structured light model. + Name of the model parameter to be adjusted. Default: "min_stripe_width" + New value of the model parameter. Default: 32 + + + Perform a training step of a deep-learning-based classifier on a batch of images. + Images comprising the batch. + Handle of the deep-learning-based classifier. + Corresponding labels for each of the images. Default: [] + Handle of the training results from the deep-learning-based classifier. + + + Write a deep-learning-based classifier in a file. + Handle of the deep-learning-based classifier. + File name. + + + Write a structured light model to a file. + Handle of the structured light model. + File name. + + + Clear the content of a handle. + Handle to clear. + + + Deserialize a serialized item. + Handle containing the serialized item to be deserialized. + Handle containing the deserialized item. + + + Convert a handle into an integer. + The handle to be casted. + The handle casted to an integer value. + + + Convert an integer into a handle. + The handle as integer. + The handle as handle. + + + Serialize the content of a handle. + Handle that should be serialized. + Handle containing the serialized item. + + + Test if the internal representation of a tuple is of type handle. + Input tuple. + Boolean value indicating if the input tuple is of type handle. + + + Test whether the elements of a tuple are of type handle. + Input tuple. + Boolean values indicating if the elements of the input tuple are of type handle. + + + Test if a tuple is serializable. + Tuple to check for serializability. + Boolean value indicating if the input can be serialized. + + + Test if the elements of a tuple are serializable. + Tuple to check for serializability. + Boolean value indicating if the input elements can be serialized. + + + Check if a handle is valid. + The handle to check for validity. + The validity of the handle, 1 or 0. + + + Return the semantic type of a tuple. + Input tuple. + Semantic type of the input tuple as a string. + + + Return the semantic type of the elements of a tuple. + Input tuple. + Semantic types of the elements of the input tuple as strings. + + + Apply a deep-learning-based network on a set of images for inference. + Handle of the deep learning model. + Input data. + Requested outputs. Default: [] + Handle containing result data. + + + Clear a deep learning model. + Handle of the deep learning model. + + + Copy a dictionary. + Dictionary handle. + Name of the generic parameter. Default: [] + Value of the generic parameter. Default: [] + Copied dictionary handle. + + + Create a new empty dictionary. + Handle of the newly created dictionary. + + + Create a deep learning network for object detection. + Deep learning classifier, used as backbone network. Default: "pretrained_dl_classifier_compact.hdl" + Number of classes. Default: 3 + Parameters for the object detection model. Default: [] + Deep learning model for object detection. + + + Deserialize a deep learning model. + Handle of the serialized item. + Handle of the deep learning model. + + + Return the HALCON thread ID of the current thread. + ID representing the current thread. + + + Retrieve an object associated with the key from the dictionary. + Object value retrieved from the dictionary. + Dictionary handle. + Key string. + + + Query dictionary parameters or information about a dictionary. + Dictionary handle. + Names of the dictionary parameters or info queries. Default: "keys" + Dictionary keys the parameter/query should be applied to (empty for GenParamName = 'keys'). + Values of the dictionary parameters or info queries. + + + Retrieve a tuple associated with the key from the dictionary. + Dictionary handle. + Key string. + Tuple value retrieved from the dictionary. + + + Return the parameters of a deep learning model. + Handle of the deep learning model. + Name of the generic parameter. Default: "batch_size" + Value of the generic parameter. + + + Retrieve an object associated with a key from a handle. + Iconic value of the key. + Handle of which to get the key. + Key to get. + + + Return information about a handle. + Handle of which to get the parameter. + Parameter to get. Default: "keys" + Optional key. Default: [] + Returned value. + + + Retrieve a tuple associated with a key from a handle. + Handle of which to get the key. + Key to get. + Control value of the key. + + + Get current value of system information without requiring a license. + Desired system parameter. Default: "available_parameters" + Current value of the system parameter. + + + Attempt to interrupt an operator running in a different thread. + Thread that runs the operator to interrupt. + Interruption mode. Default: "cancel" + + + Read a dictionary from a file. + File name. + Name of the generic parameter. Default: [] + Value of the generic parameter. Default: [] + Dictionary handle. + + + Read a deep learning model from a file. + Filename Default: "pretrained_dl_segmentation_compact.hdl" + Handle of the deep learning model. + + + Read a message from a file. + File name. + Name of the generic parameter. Default: [] + Value of the generic parameter. Default: [] + Message handle. + + + Remove keys from a dictionary. + Dictionary handle. + Key to remove. + + + + + + + + + + + + + + + Serialize a deep learning model. + Handle of the deep learning model. + Handle of the serialized item. + + + Add a key/object pair to the dictionary. + Object to be associated with the key. + Dictionary handle. + Key string. + + + Add a key/tuple pair to the dictionary. + Dictionary handle. + Key string. + Tuple value to be associated with the key. + + + Set the parameters of a deep learning model. + Handle of the deep learning model. + Name of the generic parameter. Default: "learning_rate" + Value of the generic parameter. Default: 0.001 + + + Train a deep learning model. + Deep learning model handle. + Tuple of Dictionaries with input images and corresponding information. + Dictionary with the train result data. + + + Write a dictionary to a file. + Dictionary handle. + File name. + Name of the generic parameter. Default: [] + Value of the generic parameter. Default: [] + + + Write a deep learning model in a file. + Handle of the deep learning model. + Filename + + + Write a message to a file. + Message handle. + File name. + Name of the generic parameter. Default: [] + Value of the generic parameter. Default: [] + + + Calculate the intersection area of oriented rectangles. + Center row coordinate of the first rectangle. + Center column coordinate of the first rectangle. + Angle between the positive horizontal axis and the first edge of the first rectangle (in radians). + Half length of the first edge of the first rectangle. + Half length of the second edge of the first rectangle. + Center row coordinate of the second rectangle. + Center column coordinate of the second rectangle. + Angle between the positive horizontal axis and the first edge of the second rectangle (in radians). + Half length of the first edge of the second rectangle. + Half length of the second edge of the second rectangle. + Intersection area of the first rectangle with the second rectangle. + + + Get the current contour display fill style. + Window handle. + Current contour fill style. + + + Get the clutter parameters of a shape model. + Region where no clutter should occur. + Handle of the model. + Parameter names. Default: "use_clutter" + Parameter values. + Transformation matrix. + Minimum contrast of clutter in the search images. + + + Define the contour display fill style. + Window handle. + Fill style of contour displays. Default: "stroke" + + + Set the clutter parameters of a shape model. + Region where no clutter should occur. + Handle of the model. + Transformation matrix. + Minimum contrast of clutter in the search images. Default: 128 + Parameter names. + Parameter values. + + + Represents a rigid 3D transformation with 7 parameters (3 for the rotation, 3 for the translation, 1 for the representation type). + + + Create an uninitialized instance. + + + + Create a 3D pose. + Modified instance represents: 3D pose. + + Translation along the x-axis (in [m]). Default: 0.1 + Translation along the y-axis (in [m]). Default: 0.1 + Translation along the z-axis (in [m]). Default: 0.1 + Rotation around x-axis or x component of the Rodriguez vector (in [ deg] or without unit). Default: 90.0 + Rotation around y-axis or y component of the Rodriguez vector (in [ deg] or without unit). Default: 90.0 + Rotation around z-axis or z component of the Rodriguez vector (in [ deg] or without unit). Default: 90.0 + Order of rotation and translation. Default: "Rp+T" + Meaning of the rotation values. Default: "gba" + View of transformation. Default: "point" + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + Convert to matrix + + + Compute the average of a set of poses. + Set of poses of which the average if computed. + Empty tuple, or one weight per pose. Default: [] + Averaging mode. Default: "iterative" + Weight of the translation. Default: "auto" + Weight of the rotation. Default: "auto" + Deviation of the mean from the input poses. + Weighted mean of the poses. + + + Compute the average of a set of poses. + Set of poses of which the average if computed. + Empty tuple, or one weight per pose. Default: [] + Averaging mode. Default: "iterative" + Weight of the translation. Default: "auto" + Weight of the rotation. Default: "auto" + Deviation of the mean from the input poses. + Weighted mean of the poses. + + + Invert each pose in a tuple of 3D poses. + Tuple of 3D poses. + Tuple of inverted 3D poses. + + + + Invert each pose in a tuple of 3D poses. + Instance represents: Tuple of 3D poses. + + Tuple of inverted 3D poses. + + + Combine 3D poses given in two tuples. + Tuple containing the left poses. + Tuple containing the right poses. + Tuple containing the returned poses. + + + + Combine 3D poses given in two tuples. + Instance represents: Tuple containing the left poses. + + Tuple containing the right poses. + Tuple containing the returned poses. + + + + Compute the distance values for a rectified stereo image pair using multi-scanline optimization. + Instance represents: Point transformation from the rectified camera 2 to the rectified camera 1. + + Rectified image of camera 1. + Rectified image of camera 2. + Score of the calculated disparity. + Internal camera parameters of the rectified camera 1. + Internal camera parameters of the rectified camera 2. + Minimum of the expected disparities. Default: -30 + Maximum of the expected disparities. Default: 30 + Smoothing of surfaces. Default: 50 + Smoothing of edges. Default: 50 + Parameter name(s) for the multi-scanline algorithm. Default: [] + Parameter value(s) for the multi-scanline algorithm. Default: [] + Distance image. + + + + Compute the distance values for a rectified stereo image pair using multi-scanline optimization. + Instance represents: Point transformation from the rectified camera 2 to the rectified camera 1. + + Rectified image of camera 1. + Rectified image of camera 2. + Score of the calculated disparity. + Internal camera parameters of the rectified camera 1. + Internal camera parameters of the rectified camera 2. + Minimum of the expected disparities. Default: -30 + Maximum of the expected disparities. Default: 30 + Smoothing of surfaces. Default: 50 + Smoothing of edges. Default: 50 + Parameter name(s) for the multi-scanline algorithm. Default: [] + Parameter value(s) for the multi-scanline algorithm. Default: [] + Distance image. + + + + Compute the distance values for a rectified stereo image pair using multigrid methods. + Instance represents: Point transformation from the rectified camera 2 to the rectified camera 1. + + Rectified image of camera 1. + Rectified image of camera 2. + Score of the calculated disparity if CalculateScore is set to 'true'. + Internal camera parameters of the rectified camera 1. + Internal camera parameters of the rectified camera 2. + Weight of the gray value constancy in the data term. Default: 1.0 + Weight of the gradient constancy in the data term. Default: 30.0 + Weight of the smoothness term in relation to the data term. Default: 5.0 + Initial guess of the disparity. Default: 0.0 + Should the quality measure be returned in Score? Default: "false" + Parameter name(s) for the multigrid algorithm. Default: "default_parameters" + Parameter value(s) for the multigrid algorithm. Default: "fast_accurate" + Distance image. + + + + Compute the distance values for a rectified stereo image pair using multigrid methods. + Instance represents: Point transformation from the rectified camera 2 to the rectified camera 1. + + Rectified image of camera 1. + Rectified image of camera 2. + Score of the calculated disparity if CalculateScore is set to 'true'. + Internal camera parameters of the rectified camera 1. + Internal camera parameters of the rectified camera 2. + Weight of the gray value constancy in the data term. Default: 1.0 + Weight of the gradient constancy in the data term. Default: 30.0 + Weight of the smoothness term in relation to the data term. Default: 5.0 + Initial guess of the disparity. Default: 0.0 + Should the quality measure be returned in Score? Default: "false" + Parameter name(s) for the multigrid algorithm. Default: "default_parameters" + Parameter value(s) for the multigrid algorithm. Default: "fast_accurate" + Distance image. + + + + Compute the fundamental matrix from the relative orientation of two cameras. + Instance represents: Relative orientation of the cameras (3D pose). + + 6x6 covariance matrix of relative pose. Default: [] + Parameters of the 1. camera. + Parameters of the 2. camera. + 9x9 covariance matrix of the fundamental matrix. + Computed fundamental matrix. + + + + Compute the relative orientation between two cameras given image point correspondences and known camera parameters and reconstruct 3D space points. + Modified instance represents: Computed relative orientation of the cameras (3D pose). + + Input points in image 1 (row coordinate). + Input points in image 1 (column coordinate). + Input points in image 2 (row coordinate). + Input points in image 2 (column coordinate). + Row coordinate variance of the points in image 1. Default: [] + Covariance of the points in image 1. Default: [] + Column coordinate variance of the points in image 1. Default: [] + Row coordinate variance of the points in image 2. Default: [] + Covariance of the points in image 2. Default: [] + Column coordinate variance of the points in image 2. Default: [] + Camera parameters of the 1st camera. + Camera parameters of the 2nd camera. + Algorithm for the computation of the relative pose and for special pose types. Default: "normalized_dlt" + Root-Mean-Square of the epipolar distance error. + X coordinates of the reconstructed 3D points. + Y coordinates of the reconstructed 3D points. + Z coordinates of the reconstructed 3D points. + Covariance matrices of the reconstructed 3D points. + 6x6 covariance matrix of the relative camera orientation. + + + + Compute the relative orientation between two cameras given image point correspondences and known camera parameters and reconstruct 3D space points. + Modified instance represents: Computed relative orientation of the cameras (3D pose). + + Input points in image 1 (row coordinate). + Input points in image 1 (column coordinate). + Input points in image 2 (row coordinate). + Input points in image 2 (column coordinate). + Row coordinate variance of the points in image 1. Default: [] + Covariance of the points in image 1. Default: [] + Column coordinate variance of the points in image 1. Default: [] + Row coordinate variance of the points in image 2. Default: [] + Covariance of the points in image 2. Default: [] + Column coordinate variance of the points in image 2. Default: [] + Camera parameters of the 1st camera. + Camera parameters of the 2nd camera. + Algorithm for the computation of the relative pose and for special pose types. Default: "normalized_dlt" + Root-Mean-Square of the epipolar distance error. + X coordinates of the reconstructed 3D points. + Y coordinates of the reconstructed 3D points. + Z coordinates of the reconstructed 3D points. + Covariance matrices of the reconstructed 3D points. + 6x6 covariance matrix of the relative camera orientation. + + + + Compute the relative orientation between two cameras by automatically finding correspondences between image points. + Modified instance represents: Computed relative orientation of the cameras (3D pose). + + Input image 1. + Input image 2. + Row coordinates of characteristic points in image 1. + Column coordinates of characteristic points in image 1. + Row coordinates of characteristic points in image 2. + Column coordinates of characteristic points in image 2. + Parameters of the 1st camera. + Parameters of the 2nd camera. + Gray value comparison metric. Default: "ssd" + Size of gray value masks. Default: 10 + Average row coordinate shift of corresponding points. Default: 0 + Average column coordinate shift of corresponding points. Default: 0 + Half height of matching search window. Default: 200 + Half width of matching search window. Default: 200 + Estimate of the relative orientation of the right image with respect to the left image. Default: 0.0 + Threshold for gray value matching. Default: 10 + Algorithm for the computation of the relative pose and for special pose types. Default: "normalized_dlt" + Maximal deviation of a point from its epipolar line. Default: 1 + Seed for the random number generator. Default: 0 + Root-Mean-Square of the epipolar distance error. + Indices of matched input points in image 1. + Indices of matched input points in image 2. + 6x6 covariance matrix of the relative orientation. + + + + Compute the relative orientation between two cameras by automatically finding correspondences between image points. + Modified instance represents: Computed relative orientation of the cameras (3D pose). + + Input image 1. + Input image 2. + Row coordinates of characteristic points in image 1. + Column coordinates of characteristic points in image 1. + Row coordinates of characteristic points in image 2. + Column coordinates of characteristic points in image 2. + Parameters of the 1st camera. + Parameters of the 2nd camera. + Gray value comparison metric. Default: "ssd" + Size of gray value masks. Default: 10 + Average row coordinate shift of corresponding points. Default: 0 + Average column coordinate shift of corresponding points. Default: 0 + Half height of matching search window. Default: 200 + Half width of matching search window. Default: 200 + Estimate of the relative orientation of the right image with respect to the left image. Default: 0.0 + Threshold for gray value matching. Default: 10 + Algorithm for the computation of the relative pose and for special pose types. Default: "normalized_dlt" + Maximal deviation of a point from its epipolar line. Default: 1 + Seed for the random number generator. Default: 0 + Root-Mean-Square of the epipolar distance error. + Indices of matched input points in image 1. + Indices of matched input points in image 2. + 6x6 covariance matrix of the relative orientation. + + + + Compute the distance values for a rectified stereo image pair using correlation techniques. + Instance represents: Point transformation from the rectified camera 2 to the rectified camera 1. + + Rectified image of camera 1. + Rectified image of camera 2. + Evaluation of a distance value. + Internal camera parameters of the rectified camera 1. + Internal camera parameters of the rectified camera 2. + Matching function. Default: "ncc" + Width of the correlation window. Default: 11 + Height of the correlation window. Default: 11 + Variance threshold of textured image regions. Default: 0.0 + Minimum of the expected disparities. Default: 0 + Maximum of the expected disparities. Default: 30 + Number of pyramid levels. Default: 1 + Threshold of the correlation function. Default: 0.0 + Downstream filters. Default: "none" + Distance interpolation. Default: "none" + Distance image. + + + + Compute the distance values for a rectified stereo image pair using correlation techniques. + Instance represents: Point transformation from the rectified camera 2 to the rectified camera 1. + + Rectified image of camera 1. + Rectified image of camera 2. + Evaluation of a distance value. + Internal camera parameters of the rectified camera 1. + Internal camera parameters of the rectified camera 2. + Matching function. Default: "ncc" + Width of the correlation window. Default: 11 + Height of the correlation window. Default: 11 + Variance threshold of textured image regions. Default: 0.0 + Minimum of the expected disparities. Default: 0 + Maximum of the expected disparities. Default: 30 + Number of pyramid levels. Default: 1 + Threshold of the correlation function. Default: 0.0 + Downstream filters. Default: "none" + Distance interpolation. Default: "none" + Distance image. + + + + Get a 3D point from the intersection of two lines of sight within a binocular camera system. + Instance represents: Point transformation from camera 2 to camera 1. + + Internal parameters of the projective camera 1. + Internal parameters of the projective camera 2. + Row coordinate of a point in image 1. + Column coordinate of a point in image 1. + Row coordinate of the corresponding point in image 2. + Column coordinate of the corresponding point in image 2. + X coordinate of the 3D point. + Y coordinate of the 3D point. + Z coordinate of the 3D point. + Distance of the 3D point to the lines of sight. + + + + Get a 3D point from the intersection of two lines of sight within a binocular camera system. + Instance represents: Point transformation from camera 2 to camera 1. + + Internal parameters of the projective camera 1. + Internal parameters of the projective camera 2. + Row coordinate of a point in image 1. + Column coordinate of a point in image 1. + Row coordinate of the corresponding point in image 2. + Column coordinate of the corresponding point in image 2. + X coordinate of the 3D point. + Y coordinate of the 3D point. + Z coordinate of the 3D point. + Distance of the 3D point to the lines of sight. + + + + Transform a disparity image into 3D points in a rectified stereo system. + Instance represents: Pose of the rectified camera 2 in relation to the rectified camera 1. + + Disparity image. + Y coordinates of the points in the rectified camera system 1. + Z coordinates of the points in the rectified camera system 1. + Internal camera parameters of the rectified camera 1. + Internal camera parameters of the rectified camera 2. + X coordinates of the points in the rectified camera system 1. + + + + Transform an image point and its disparity into a 3D point in a rectified stereo system. + Instance represents: Pose of the rectified camera 2 in relation to the rectified camera 1. + + Rectified internal camera parameters of camera 1. + Rectified internal camera parameters of camera 2. + Row coordinate of a point in the rectified image 1. + Column coordinate of a point in the rectified image 1. + Disparity of the images of the world point. + X coordinate of the 3D point. + Y coordinate of the 3D point. + Z coordinate of the 3D point. + + + + Transform an image point and its disparity into a 3D point in a rectified stereo system. + Instance represents: Pose of the rectified camera 2 in relation to the rectified camera 1. + + Rectified internal camera parameters of camera 1. + Rectified internal camera parameters of camera 2. + Row coordinate of a point in the rectified image 1. + Column coordinate of a point in the rectified image 1. + Disparity of the images of the world point. + X coordinate of the 3D point. + Y coordinate of the 3D point. + Z coordinate of the 3D point. + + + + Transform a disparity value into a distance value in a rectified binocular stereo system. + Instance represents: Point transformation from the rectified camera 2 to the rectified camera 1. + + Rectified internal camera parameters of camera 1. + Rectified internal camera parameters of camera 2. + Disparity between the images of the world point. + Distance of a world point to the rectified camera system. + + + + Transform a disparity value into a distance value in a rectified binocular stereo system. + Instance represents: Point transformation from the rectified camera 2 to the rectified camera 1. + + Rectified internal camera parameters of camera 1. + Rectified internal camera parameters of camera 2. + Disparity between the images of the world point. + Distance of a world point to the rectified camera system. + + + + Transfrom a distance value into a disparity in a rectified stereo system. + Instance represents: Point transformation from the rectified camera 2 to the rectified camera 1. + + Rectified internal camera parameters of camera 1. + Rectified internal camera parameters of camera 2. + Distance of a world point to camera 1. + Disparity between the images of the point. + + + + Transfrom a distance value into a disparity in a rectified stereo system. + Instance represents: Point transformation from the rectified camera 2 to the rectified camera 1. + + Rectified internal camera parameters of camera 1. + Rectified internal camera parameters of camera 2. + Distance of a world point to camera 1. + Disparity between the images of the point. + + + + Generate transformation maps that describe the mapping of the images of a binocular camera pair to a common rectified image plane. + Instance represents: Point transformation from camera 2 to camera 1. + + Image containing the mapping data of camera 2. + Internal parameters of camera 1. + Internal parameters of camera 2. + Subsampling factor. Default: 1.0 + Type of rectification. Default: "viewing_direction" + Type of mapping. Default: "bilinear" + Rectified internal parameters of camera 1. + Rectified internal parameters of camera 2. + Point transformation from the rectified camera 1 to the original camera 1. + Point transformation from the rectified camera 1 to the original camera 1. + Point transformation from the rectified camera 2 to the rectified camera 1. + Image containing the mapping data of camera 1. + + + Determine all camera parameters of a binocular stereo system. + Ordered Tuple with all X-coordinates of the calibration marks (in meters). + Ordered Tuple with all Y-coordinates of the calibration marks (in meters). + Ordered Tuple with all Z-coordinates of the calibration marks (in meters). + Ordered Tuple with all row-coordinates of the extracted calibration marks of camera 1 (in pixels). + Ordered Tuple with all column-coordinates of the extracted calibration marks of camera 1 (in pixels). + Ordered Tuple with all row-coordinates of the extracted calibration marks of camera 2 (in pixels). + Ordered Tuple with all column-coordinates of the extracted calibration marks of camera 2 (in pixels). + Initial values for the internal parameters of camera 1. + Initial values for the internal parameters of camera 2. + Ordered tuple with all initial values for the poses of the calibration model in relation to camera 1. + Ordered tuple with all initial values for the poses of the calibration model in relation to camera 2. + Camera parameters to be estimated. Default: "all" + Internal parameters of camera 2. + Ordered tuple with all poses of the calibration model in relation to camera 1. + Ordered tuple with all poses of the calibration model in relation to camera 2. + Pose of camera 2 in relation to camera 1. + Average error distances in pixels. + Internal parameters of camera 1. + + + + Determine all camera parameters of a binocular stereo system. + Instance represents: Ordered tuple with all initial values for the poses of the calibration model in relation to camera 1. + + Ordered Tuple with all X-coordinates of the calibration marks (in meters). + Ordered Tuple with all Y-coordinates of the calibration marks (in meters). + Ordered Tuple with all Z-coordinates of the calibration marks (in meters). + Ordered Tuple with all row-coordinates of the extracted calibration marks of camera 1 (in pixels). + Ordered Tuple with all column-coordinates of the extracted calibration marks of camera 1 (in pixels). + Ordered Tuple with all row-coordinates of the extracted calibration marks of camera 2 (in pixels). + Ordered Tuple with all column-coordinates of the extracted calibration marks of camera 2 (in pixels). + Initial values for the internal parameters of camera 1. + Initial values for the internal parameters of camera 2. + Ordered tuple with all initial values for the poses of the calibration model in relation to camera 2. + Camera parameters to be estimated. Default: "all" + Internal parameters of camera 2. + Ordered tuple with all poses of the calibration model in relation to camera 1. + Ordered tuple with all poses of the calibration model in relation to camera 2. + Pose of camera 2 in relation to camera 1. + Average error distances in pixels. + Internal parameters of camera 1. + + + Find the best matches of a calibrated descriptor model in an image and return their 3D pose. + Input image where the model should be found. + The handle to the descriptor model. + The detector's parameter names. Default: [] + Values of the detector's parameters. Default: [] + The descriptor's parameter names. Default: [] + Values of the descriptor's parameters. Default: [] + Minimum score of the instances of the models to be found. Default: 0.2 + Maximal number of found instances. Default: 1 + Camera parameter (inner orientation) obtained from camera calibration. + Score type to be evaluated in Score. Default: "num_points" + 3D pose of the object. + Score of the found instances according to the ScoreType input. + + + + Find the best matches of a calibrated descriptor model in an image and return their 3D pose. + Modified instance represents: 3D pose of the object. + + Input image where the model should be found. + The handle to the descriptor model. + The detector's parameter names. Default: [] + Values of the detector's parameters. Default: [] + The descriptor's parameter names. Default: [] + Values of the descriptor's parameters. Default: [] + Minimum score of the instances of the models to be found. Default: 0.2 + Maximal number of found instances. Default: 1 + Camera parameter (inner orientation) obtained from camera calibration. + Score type to be evaluated in Score. Default: "num_points" + Score of the found instances according to the ScoreType input. + + + + Create a descriptor model for calibrated perspective matching. + Instance represents: The reference pose of the object in the reference image. + + Input image whose domain will be used to create the model. + The parameters of the internal orientation of the camera. + The type of the detector. Default: "lepetit" + The detector's parameter names. Default: [] + Values of the detector's parameters. Default: [] + The descriptor's parameter names. Default: [] + Values of the descriptor's parameters. Default: [] + The seed for the random number generator. Default: 42 + The handle to the descriptor model. + + + + Prepare a deformable model for planar calibrated matching from XLD contours. + Instance represents: The reference pose of the object. + + Input contours that will be used to create the model. + The parameters of the internal orientation of the camera. + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in the column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "auto" + Match metric. Default: "ignore_local_polarity" + Minimum contrast of the objects in the search images. Default: 5 + The generic parameter names. Default: [] + Values of the generic parameter. Default: [] + Handle of the model. + + + + Prepare a deformable model for planar calibrated matching from XLD contours. + Instance represents: The reference pose of the object. + + Input contours that will be used to create the model. + The parameters of the internal orientation of the camera. + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in the column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "auto" + Match metric. Default: "ignore_local_polarity" + Minimum contrast of the objects in the search images. Default: 5 + The generic parameter names. Default: [] + Values of the generic parameter. Default: [] + Handle of the model. + + + + Create a deformable model for calibrated perspective matching. + Instance represents: The reference pose of the object in the reference image. + + Input image whose domain will be used to create the model. + The parameters of the internal orientation of the camera. + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in the column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "none" + Match metric. Default: "use_polarity" + Thresholds or hysteresis thresholds for the contrast of the object in the template image. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + The parameter names. Default: [] + Values of the parameters. Default: [] + Handle of the model. + + + + Create a deformable model for calibrated perspective matching. + Instance represents: The reference pose of the object in the reference image. + + Input image whose domain will be used to create the model. + The parameters of the internal orientation of the camera. + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in the column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "none" + Match metric. Default: "use_polarity" + Thresholds or hysteresis thresholds for the contrast of the object in the template image. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + The parameter names. Default: [] + Values of the parameters. Default: [] + Handle of the model. + + + Create a 3D camera pose from camera center and viewing direction. + X coordinate of the optical center of the camera. + Y coordinate of the optical center of the camera. + Z coordinate of the optical center of the camera. + X coordinate of the 3D point to which the camera is directed. + Y coordinate of the 3D point to which the camera is directed. + Z coordinate of the 3D point to which the camera is directed. + Normal vector of the reference plane (points up). Default: "-y" + Camera roll angle. Default: 0 + 3D camera pose. + + + + Create a 3D camera pose from camera center and viewing direction. + Modified instance represents: 3D camera pose. + + X coordinate of the optical center of the camera. + Y coordinate of the optical center of the camera. + Z coordinate of the optical center of the camera. + X coordinate of the 3D point to which the camera is directed. + Y coordinate of the 3D point to which the camera is directed. + Z coordinate of the 3D point to which the camera is directed. + Normal vector of the reference plane (points up). Default: "-y" + Camera roll angle. Default: 0 + + + + Transform a pose that refers to the coordinate system of a 3D object model to a pose that refers to the reference coordinate system of a 3D shape model and vice versa. + Instance represents: Pose to be transformed in the source system. + + Handle of the 3D shape model. + Direction of the transformation. Default: "ref_to_model" + Transformed 3D pose in the target system. + + + + Project the edges of a 3D shape model into image coordinates. + Instance represents: 3D pose of the 3D shape model in the world coordinate system. + + Handle of the 3D shape model. + Internal camera parameters. + Remove hidden surfaces? Default: "true" + Smallest face angle for which the edge is displayed Default: 0.523599 + Contour representation of the model view. + + + + Project the edges of a 3D shape model into image coordinates. + Instance represents: 3D pose of the 3D shape model in the world coordinate system. + + Handle of the 3D shape model. + Internal camera parameters. + Remove hidden surfaces? Default: "true" + Smallest face angle for which the edge is displayed Default: 0.523599 + Contour representation of the model view. + + + Remove points from a 3D object model by projecting it to a virtual view and removing all points outside of a given region. + Region in the image plane. + Handle of the 3D object model. + Internal camera parameters. + 3D pose of the world coordinate system in camera coordinates. + Handle of the reduced 3D object model. + + + + Remove points from a 3D object model by projecting it to a virtual view and removing all points outside of a given region. + Instance represents: 3D pose of the world coordinate system in camera coordinates. + + Region in the image plane. + Handle of the 3D object model. + Internal camera parameters. + Handle of the reduced 3D object model. + + + Render 3D object models to get an image. + Handles of the 3D object models. + Camera parameters of the scene. + 3D poses of the objects. + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Rendered scene. + + + + Render 3D object models to get an image. + Instance represents: 3D poses of the objects. + + Handles of the 3D object models. + Camera parameters of the scene. + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Rendered scene. + + + Display 3D object models. + Window handle. + Handles of the 3D object models. + Camera parameters of the scene. Default: [] + 3D poses of the objects. Default: [] + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + + + + Display 3D object models. + Instance represents: 3D poses of the objects. + + Window handle. + Handles of the 3D object models. + Camera parameters of the scene. Default: [] + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + + + + Project a 3D object model into image coordinates. + Instance represents: 3D pose of the world coordinate system in camera coordinates. + + Handle of the 3D object model. + Internal camera parameters. + Name of the generic parameter. Default: [] + Value of the generic parameter. Default: [] + Projected model contours. + + + + Project a 3D object model into image coordinates. + Instance represents: 3D pose of the world coordinate system in camera coordinates. + + Handle of the 3D object model. + Internal camera parameters. + Name of the generic parameter. Default: [] + Value of the generic parameter. Default: [] + Projected model contours. + + + + Compute the calibrated scene flow between two stereo image pairs. + Instance represents: Pose of the rectified camera 2 in relation to the rectified camera 1. + + Input image 1 at time @f$t_{1}$t_1. + Input image 2 at time @f$t_{1}$t_1. + Input image 1 at time @f$t_{2}$t_2. + Input image 2 at time @f$t_{2}$t_2. + Disparity between input images 1 and 2 at time @f$t_{1}$t_1. + Weight of the regularization term relative to the data term (derivatives of the optical flow). Default: 40.0 + Weight of the regularization term relative to the data term (derivatives of the disparity change). Default: 40.0 + Parameter name(s) for the algorithm. Default: "default_parameters" + Parameter value(s) for the algorithm. Default: "accurate" + Internal camera parameters of the rectified camera 1. + Internal camera parameters of the rectified camera 2. + Handle of the 3D object model. + + + + Compute the calibrated scene flow between two stereo image pairs. + Instance represents: Pose of the rectified camera 2 in relation to the rectified camera 1. + + Input image 1 at time @f$t_{1}$t_1. + Input image 2 at time @f$t_{1}$t_1. + Input image 1 at time @f$t_{2}$t_2. + Input image 2 at time @f$t_{2}$t_2. + Disparity between input images 1 and 2 at time @f$t_{1}$t_1. + Weight of the regularization term relative to the data term (derivatives of the optical flow). Default: 40.0 + Weight of the regularization term relative to the data term (derivatives of the disparity change). Default: 40.0 + Parameter name(s) for the algorithm. Default: "default_parameters" + Parameter value(s) for the algorithm. Default: "accurate" + Internal camera parameters of the rectified camera 1. + Internal camera parameters of the rectified camera 2. + Handle of the 3D object model. + + + + Compute an absolute pose out of point correspondences between world and image coordinates. + Modified instance represents: Pose. + + X-Component of world coordinates. + Y-Component of world coordinates. + Z-Component of world coordinates. + Row-Component of image coordinates. + Column-Component of image coordinates. + The inner camera parameters from camera calibration. + Kind of algorithm Default: "iterative" + Type of pose quality to be returned in Quality. Default: "error" + Pose quality. + + + + Compute an absolute pose out of point correspondences between world and image coordinates. + Modified instance represents: Pose. + + X-Component of world coordinates. + Y-Component of world coordinates. + Z-Component of world coordinates. + Row-Component of image coordinates. + Column-Component of image coordinates. + The inner camera parameters from camera calibration. + Kind of algorithm Default: "iterative" + Type of pose quality to be returned in Quality. Default: "error" + Pose quality. + + + + Generate a projection map that describes the mapping between the image plane and a the plane z=0 of a world coordinate system. + Instance represents: 3D pose of the world coordinate system in camera coordinates. + + Internal camera parameters. + Width of the images to be transformed. + Height of the images to be transformed. + Width of the resulting mapped images in pixels. + Height of the resulting mapped images in pixels. + Scale or unit. Default: "m" + Type of the mapping. Default: "bilinear" + Image containing the mapping data. + + + + Generate a projection map that describes the mapping between the image plane and a the plane z=0 of a world coordinate system. + Instance represents: 3D pose of the world coordinate system in camera coordinates. + + Internal camera parameters. + Width of the images to be transformed. + Height of the images to be transformed. + Width of the resulting mapped images in pixels. + Height of the resulting mapped images in pixels. + Scale or unit. Default: "m" + Type of the mapping. Default: "bilinear" + Image containing the mapping data. + + + + Rectify an image by transforming it into the plane z=0 of a world coordinate system. + Instance represents: 3D pose of the world coordinate system in camera coordinates. + + Input image. + Internal camera parameters. + Width of the resulting image in pixels. + Height of the resulting image in pixels. + Scale or unit Default: "m" + Type of interpolation. Default: "bilinear" + Transformed image. + + + + Rectify an image by transforming it into the plane z=0 of a world coordinate system. + Instance represents: 3D pose of the world coordinate system in camera coordinates. + + Input image. + Internal camera parameters. + Width of the resulting image in pixels. + Height of the resulting image in pixels. + Scale or unit Default: "m" + Type of interpolation. Default: "bilinear" + Transformed image. + + + + Transform an XLD contour into the plane z=0 of a world coordinate system. + Instance represents: 3D pose of the world coordinate system in camera coordinates. + + Input XLD contours to be transformed in image coordinates. + Internal camera parameters. + Scale or dimension Default: "m" + Transformed XLD contours in world coordinates. + + + + Transform an XLD contour into the plane z=0 of a world coordinate system. + Instance represents: 3D pose of the world coordinate system in camera coordinates. + + Input XLD contours to be transformed in image coordinates. + Internal camera parameters. + Scale or dimension Default: "m" + Transformed XLD contours in world coordinates. + + + + Translate the origin of a 3D pose. + Instance represents: original 3D pose. + + translation of the origin in x-direction. Default: 0 + translation of the origin in y-direction. Default: 0 + translation of the origin in z-direction. Default: 0 + new 3D pose after applying the translation. + + + Perform a hand-eye calibration. + Linear list containing all the x coordinates of the calibration points (in the order of the images). + Linear list containing all the y coordinates of the calibration points (in the order of the images). + Linear list containing all the z coordinates of the calibration points (in the order of the images). + Linear list containing all row coordinates of the calibration points (in the order of the images). + Linear list containing all the column coordinates of the calibration points (in the order of the images). + Number of the calibration points for each image. + Known 3D pose of the robot for each image (moving camera: robot base in robot tool coordinates; stationary camera: robot tool in robot base coordinates). + Internal camera parameters. + Method of hand-eye calibration. Default: "nonlinear" + Type of quality assessment. Default: "error_pose" + Computed 3D pose of the calibration points in robot base coordinates (moving camera) or in robot tool coordinates (stationary camera), respectively. + Quality assessment of the result. + Computed relative camera pose: 3D pose of the robot tool (moving camera) or robot base (stationary camera), respectively, in camera coordinates. + + + Perform a hand-eye calibration. + Linear list containing all the x coordinates of the calibration points (in the order of the images). + Linear list containing all the y coordinates of the calibration points (in the order of the images). + Linear list containing all the z coordinates of the calibration points (in the order of the images). + Linear list containing all row coordinates of the calibration points (in the order of the images). + Linear list containing all the column coordinates of the calibration points (in the order of the images). + Number of the calibration points for each image. + Known 3D pose of the robot for each image (moving camera: robot base in robot tool coordinates; stationary camera: robot tool in robot base coordinates). + Internal camera parameters. + Method of hand-eye calibration. Default: "nonlinear" + Type of quality assessment. Default: "error_pose" + Computed 3D pose of the calibration points in robot base coordinates (moving camera) or in robot tool coordinates (stationary camera), respectively. + Quality assessment of the result. + Computed relative camera pose: 3D pose of the robot tool (moving camera) or robot base (stationary camera), respectively, in camera coordinates. + + + + Get the representation type of a 3D pose. + Instance represents: 3D pose. + + Meaning of the rotation values. + View of transformation. + Order of rotation and translation. + + + + Change the representation type of a 3D pose. + Instance represents: Original 3D pose. + + Order of rotation and translation. Default: "Rp+T" + Meaning of the rotation values. Default: "gba" + View of transformation. Default: "point" + 3D transformation. + + + + Create a 3D pose. + Modified instance represents: 3D pose. + + Translation along the x-axis (in [m]). Default: 0.1 + Translation along the y-axis (in [m]). Default: 0.1 + Translation along the z-axis (in [m]). Default: 0.1 + Rotation around x-axis or x component of the Rodriguez vector (in [ deg] or without unit). Default: 90.0 + Rotation around y-axis or y component of the Rodriguez vector (in [ deg] or without unit). Default: 90.0 + Rotation around z-axis or z component of the Rodriguez vector (in [ deg] or without unit). Default: 90.0 + Order of rotation and translation. Default: "Rp+T" + Meaning of the rotation values. Default: "gba" + View of transformation. Default: "point" + + + + Convert internal camera parameters and a 3D pose into a 3x4 projection matrix. + Instance represents: 3D pose. + + Internal camera parameters. + 3x4 projection matrix. + + + + Convert a 3D pose into a homogeneous transformation matrix. + Instance represents: 3D pose. + + Equivalent homogeneous transformation matrix. + + + + Deserialize a serialized pose. + Modified instance represents: 3D pose. + + Handle of the serialized item. + + + + Serialize a pose. + Instance represents: 3D pose. + + Handle of the serialized item. + + + + Read a 3D pose from a text file. + Modified instance represents: 3D pose. + + File name of the external camera parameters. Default: "campose.dat" + + + + Write a 3D pose to a text file. + Instance represents: 3D pose. + + File name of the external camera parameters. Default: "campose.dat" + + + + Simulate an image with calibration plate. + Instance represents: External camera parameters (3D pose of the calibration plate in camera coordinates). + + File name of the calibration plate description. Default: "calplate_320mm.cpd" + Internal camera parameters. + Gray value of image background. Default: 128 + Gray value of calibration plate. Default: 80 + Gray value of calibration marks. Default: 224 + Scaling factor to reduce oversampling. Default: 1.0 + Simulated calibration image. + + + Determine all camera parameters by a simultaneous minimization process. + Ordered tuple with all x coordinates of the calibration marks (in meters). + Ordered tuple with all y coordinates of the calibration marks (in meters). + Ordered tuple with all z coordinates of the calibration marks (in meters). + Ordered tuple with all row coordinates of the extracted calibration marks (in pixels). + Ordered tuple with all column coordinates of the extracted calibration marks (in pixels). + Initial values for the internal camera parameters. + Ordered tuple with all initial values for the external camera parameters. + Camera parameters to be estimated. Default: "all" + Ordered tuple with all external camera parameters. + Average error distance in pixels. + Internal camera parameters. + + + + Determine all camera parameters by a simultaneous minimization process. + Instance represents: Ordered tuple with all initial values for the external camera parameters. + + Ordered tuple with all x coordinates of the calibration marks (in meters). + Ordered tuple with all y coordinates of the calibration marks (in meters). + Ordered tuple with all z coordinates of the calibration marks (in meters). + Ordered tuple with all row coordinates of the extracted calibration marks (in pixels). + Ordered tuple with all column coordinates of the extracted calibration marks (in pixels). + Initial values for the internal camera parameters. + Camera parameters to be estimated. Default: "all" + Ordered tuple with all external camera parameters. + Average error distance in pixels. + Internal camera parameters. + + + + Extract rectangularly arranged 2D calibration marks from the image and calculate initial values for the external camera parameters. + Modified instance represents: Estimation for the external camera parameters. + + Input image. + Region of the calibration plate. + File name of the calibration plate description. Default: "caltab_100.descr" + Initial values for the internal camera parameters. + Initial threshold value for contour detection. Default: 128 + Loop value for successive reduction of StartThresh. Default: 10 + Minimum threshold for contour detection. Default: 18 + Filter parameter for contour detection, see edges_image. Default: 0.9 + Minimum length of the contours of the marks. Default: 15.0 + Maximum expected diameter of the marks. Default: 100.0 + Tuple with column coordinates of the detected marks. + Tuple with row coordinates of the detected marks. + + + Define type, parameters, and relative pose of a camera in a camera setup model. + Handle to the camera setup model. + Index of the camera in the setup. + Type of the camera. Default: [] + Internal camera parameters. + Pose of the camera relative to the setup's coordinate system. + + + Define type, parameters, and relative pose of a camera in a camera setup model. + Handle to the camera setup model. + Index of the camera in the setup. + Type of the camera. Default: [] + Internal camera parameters. + Pose of the camera relative to the setup's coordinate system. + + + Represents a quaternion. + + + Create an uninitialized instance. + + + + Create a rotation quaternion. + Modified instance represents: Rotation quaternion. + + X component of the rotation axis. + Y component of the rotation axis. + Z component of the rotation axis. + Rotation angle in radians. + + + + Create a rotation quaternion. + Modified instance represents: Rotation quaternion. + + X component of the rotation axis. + Y component of the rotation axis. + Z component of the rotation axis. + Rotation angle in radians. + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + Composes two quaternions + + + Convert to pose + + + Convert to matrix + + + Conjugate a quaternion + + + + Perform a rotation by a unit quaternion. + Instance represents: Rotation quaternion. + + X coordinate of the point to be rotated. + Y coordinate of the point to be rotated. + Z coordinate of the point to be rotated. + Y coordinate of the rotated point. + Z coordinate of the rotated point. + X coordinate of the rotated point. + + + + Generate the conjugation of a quaternion. + Instance represents: Input quaternion. + + Conjugated quaternion. + + + + Normalize a quaternion. + Instance represents: Input quaternion. + + Normalized quaternion. + + + + Create a rotation quaternion. + Modified instance represents: Rotation quaternion. + + X component of the rotation axis. + Y component of the rotation axis. + Z component of the rotation axis. + Rotation angle in radians. + + + + Create a rotation quaternion. + Modified instance represents: Rotation quaternion. + + X component of the rotation axis. + Y component of the rotation axis. + Z component of the rotation axis. + Rotation angle in radians. + + + + Convert a quaternion into the corresponding 3D pose. + Instance represents: Rotation quaternion. + + 3D Pose. + + + + Convert a quaternion into the corresponding rotation matrix. + Instance represents: Rotation quaternion. + + Rotation matrix. + + + Convert the rotational part of a 3D pose to a quaternion. + 3D Pose. + Rotation quaternion. + + + + Convert the rotational part of a 3D pose to a quaternion. + Modified instance represents: Rotation quaternion. + + 3D Pose. + + + + Interpolation of two quaternions. + Instance represents: Start quaternion. + + End quaternion. + Interpolation parameter. Default: 0.5 + Interpolated quaternion. + + + + Multiply two quaternions. + Instance represents: Left quaternion. + + Right quaternion. + Product of the input quaternions. + + + + Deserialize a serialized quaternion. + Modified instance represents: Quaternion. + + Handle of the serialized item. + + + + Serialize a quaternion. + Instance represents: Quaternion. + + Handle of the serialized item. + + + Represents an instance of a region object(-array). + + + Create an uninitialized iconic object + + + + Create a rectangle parallel to the coordinate axes. + Modified instance represents: Created rectangle. + + Line of upper left corner point. Default: 30.0 + Column of upper left corner point. Default: 20.0 + Line of lower right corner point. Default: 100.0 + Column of lower right corner point. Default: 200.0 + + + + Create a rectangle parallel to the coordinate axes. + Modified instance represents: Created rectangle. + + Line of upper left corner point. Default: 30.0 + Column of upper left corner point. Default: 20.0 + Line of lower right corner point. Default: 100.0 + Column of lower right corner point. Default: 200.0 + + + + Create an ellipse sector. + Modified instance represents: Created ellipse(s). + + Line index of center. Default: 200.0 + Column index of center. Default: 200.0 + Orientation of the longer radius (Radius1). Default: 0.0 + Longer radius. Default: 100.0 + Shorter radius. Default: 60.0 + Start angle of the sector. Default: 0.0 + End angle of the sector. Default: 3.14159 + + + + Create an ellipse sector. + Modified instance represents: Created ellipse(s). + + Line index of center. Default: 200.0 + Column index of center. Default: 200.0 + Orientation of the longer radius (Radius1). Default: 0.0 + Longer radius. Default: 100.0 + Shorter radius. Default: 60.0 + Start angle of the sector. Default: 0.0 + End angle of the sector. Default: 3.14159 + + + + Create a circle sector. + Modified instance represents: Generated circle sector. + + Line index of center. Default: 200.0 + Column index of center. Default: 200.0 + Radius of circle. Default: 100.5 + Start angle of the circle sector. Default: 0.0 + End angle of the circle sector. Default: 3.14159 + + + + Create a circle sector. + Modified instance represents: Generated circle sector. + + Line index of center. Default: 200.0 + Column index of center. Default: 200.0 + Radius of circle. Default: 100.5 + Start angle of the circle sector. Default: 0.0 + End angle of the circle sector. Default: 3.14159 + + + + Create a circle. + Modified instance represents: Generated circle. + + Line index of center. Default: 200.0 + Column index of center. Default: 200.0 + Radius of circle. Default: 100.5 + + + + Create a circle. + Modified instance represents: Generated circle. + + Line index of center. Default: 200.0 + Column index of center. Default: 200.0 + Radius of circle. Default: 100.5 + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + Returns the intersection of regions + + + Returns the union of regions + + + Returns the difference of regions + + + + Returns the recomplement of the region. Note that the result + is not necessarily finite, so you might wish to intersect the + result with the image domain you are interested in. + + + + + Returns the intersection of the region and the image domain. + In particular, the result will not exceed the image bounds. + + + + Test if one region is a subset of the other + + + Test if one region is a subset of the other + + + Returns the Minkowski addition of regions + + + Returns the Minkowski subtraction of regions + + + Dilates the region by the specified radius + + + Dilates the region by the specified radius + + + Erodes the region by the specified radius + + + Translates the region + + + Zooms the region + + + Zooms the region + + + Transposes the region + + + Converts an XLD contour to a filled region + + + Converts an XLD polygon to a filled region + + + Returns an XLD contour representing the region border + + + + Generate XLD contours from regions. + Instance represents: Input regions. + + Mode of contour generation. Default: "border" + Resulting contours. + + + + Convert a skeleton into XLD contours. + Instance represents: Skeleton of which the contours are to be determined. + + Minimum number of points a contour has to have. Default: 1 + Contour filter mode. Default: "filter" + Resulting contours. + + + + Receive regions over a socket connection. + Modified instance represents: Received regions. + + Socket number. + + + + Send regions over a socket connection. + Instance represents: Regions to be sent. + + Socket number. + + + + Create a model to perform 3D-measurements using the sheet-of-light technique. + Instance represents: Region of the images containing the profiles to be processed. If the provided region is not rectangular, its smallest enclosing rectangle will be used. + + Names of the generic parameters that can be adjusted for the sheet-of-light model. Default: "min_gray" + Values of the generic parameters that can be adjusted for the sheet-of-light model. Default: 50 + Handle for using and accessing the sheet-of-light model. + + + + Create a model to perform 3D-measurements using the sheet-of-light technique. + Instance represents: Region of the images containing the profiles to be processed. If the provided region is not rectangular, its smallest enclosing rectangle will be used. + + Names of the generic parameters that can be adjusted for the sheet-of-light model. Default: "min_gray" + Values of the generic parameters that can be adjusted for the sheet-of-light model. Default: 50 + Handle for using and accessing the sheet-of-light model. + + + + Selects characters from a given region. + Instance represents: Region of text lines in which to select the characters. + + Should dot print characters be detected? Default: "false" + Stroke width of a character. Default: "medium" + Width of a character. Default: 25 + Height of a character. Default: 25 + Add punctuation? Default: "false" + Exist diacritic marks? Default: "false" + Method to partition neighbored characters. Default: "none" + Should lines be partitioned? Default: "false" + Distance of fragments. Default: "medium" + Connect fragments? Default: "false" + Maximum size of clutter. Default: 0 + Stop execution after this step. Default: "completion" + Selected characters. + + + + Segments characters in a given region of an image. + Instance represents: Area in the image where the text lines are located. + + Input image. + Region of characters. + Method to segment the characters. Default: "local_auto_shape" + Eliminate horizontal and vertical lines? Default: "false" + Should dot print characters be detected? Default: "false" + Stroke width of a character. Default: "medium" + Width of a character. Default: 25 + Height of a character. Default: 25 + Value to adjust the segmentation. Default: 0 + Minimum gray value difference between text and background. Default: 10 + Threshold used to segment the characters. + Image used for the segmentation. + + + + Segments characters in a given region of an image. + Instance represents: Area in the image where the text lines are located. + + Input image. + Region of characters. + Method to segment the characters. Default: "local_auto_shape" + Eliminate horizontal and vertical lines? Default: "false" + Should dot print characters be detected? Default: "false" + Stroke width of a character. Default: "medium" + Width of a character. Default: 25 + Height of a character. Default: 25 + Value to adjust the segmentation. Default: 0 + Minimum gray value difference between text and background. Default: 10 + Threshold used to segment the characters. + Image used for the segmentation. + + + + Determines the slant of characters of a text line or paragraph. + Instance represents: Area of text lines. + + Input image. + Height of the text lines. Default: 25 + Minimum slant of the characters Default: -0.523599 + Maximum slant of the characters Default: 0.523599 + Calculated slant of the characters in the region + + + + Determines the orientation of a text line or paragraph. + Instance represents: Area of text lines. + + Input image. + Height of the text lines. Default: 25 + Minimum rotation of the text lines. Default: -0.523599 + Maximum rotation of the text lines. Default: 0.523599 + Calculated rotation angle of the text lines. + + + + Construct classes for class_ndim_norm. + Instance represents: Foreground pixels to be trained. + + Background pixels to be trained (rejection class). + Multi-channel training image. + Metric to be used. Default: "euclid" + Maximum cluster radius. Default: 10.0 + The ratio of the number of pixels in a cluster to the total number of pixels (in percent) must be larger than MinNumberPercent (otherwise the cluster is not output). Default: 0.01 + Coordinates of all cluster centers. + Overlap of the rejection class with the classified objects (1: no overlap). + Cluster radii or half edge lengths. + + + + Construct classes for class_ndim_norm. + Instance represents: Foreground pixels to be trained. + + Background pixels to be trained (rejection class). + Multi-channel training image. + Metric to be used. Default: "euclid" + Maximum cluster radius. Default: 10.0 + The ratio of the number of pixels in a cluster to the total number of pixels (in percent) must be larger than MinNumberPercent (otherwise the cluster is not output). Default: 0.01 + Coordinates of all cluster centers. + Overlap of the rejection class with the classified objects (1: no overlap). + Cluster radii or half edge lengths. + + + + Train a classificator using a multi-channel image. + Instance represents: Foreground pixels to be trained. + + Background pixels to be trained (rejection class). + Multi-channel training image. + Handle of the classifier. + + + + Transform a region in polar coordinates back to cartesian coordinates. + Instance represents: Input region. + + Row coordinate of the center of the arc. Default: 256 + Column coordinate of the center of the arc. Default: 256 + Angle of the ray to map the column coordinate 0 of PolarRegion to. Default: 0.0 + Angle of the ray to map the column coordinate $WidthIn-1$ of PolarRegion to. Default: 6.2831853 + Radius of the circle to map the row coordinate 0 of PolarRegion to. Default: 0 + Radius of the circle to map the row coordinate $HeightIn-1$ of PolarRegion to. Default: 100 + Width of the virtual input image. Default: 512 + Height of the virtual input image. Default: 512 + Width of the virtual output image. Default: 512 + Height of the virtual output image. Default: 512 + Interpolation method for the transformation. Default: "nearest_neighbor" + Output region. + + + + Transform a region in polar coordinates back to cartesian coordinates. + Instance represents: Input region. + + Row coordinate of the center of the arc. Default: 256 + Column coordinate of the center of the arc. Default: 256 + Angle of the ray to map the column coordinate 0 of PolarRegion to. Default: 0.0 + Angle of the ray to map the column coordinate $WidthIn-1$ of PolarRegion to. Default: 6.2831853 + Radius of the circle to map the row coordinate 0 of PolarRegion to. Default: 0 + Radius of the circle to map the row coordinate $HeightIn-1$ of PolarRegion to. Default: 100 + Width of the virtual input image. Default: 512 + Height of the virtual input image. Default: 512 + Width of the virtual output image. Default: 512 + Height of the virtual output image. Default: 512 + Interpolation method for the transformation. Default: "nearest_neighbor" + Output region. + + + + Transform a region within an annular arc to polar coordinates. + Instance represents: Input region. + + Row coordinate of the center of the arc. Default: 256 + Column coordinate of the center of the arc. Default: 256 + Angle of the ray to be mapped to column coordinate 0 of PolarTransRegion. Default: 0.0 + Angle of the ray to be mapped to column coordinate $Width-1$ of PolarTransRegion. Default: 6.2831853 + Radius of the circle to be mapped to row coordinate 0 of PolarTransRegion. Default: 0 + Radius of the circle to be mapped to row coordinate $Height-1$ of PolarTransRegion. Default: 100 + Width of the virtual output image. Default: 512 + Height of the virtual output image. Default: 512 + Interpolation method for the transformation. Default: "nearest_neighbor" + Output region. + + + + Transform a region within an annular arc to polar coordinates. + Instance represents: Input region. + + Row coordinate of the center of the arc. Default: 256 + Column coordinate of the center of the arc. Default: 256 + Angle of the ray to be mapped to column coordinate 0 of PolarTransRegion. Default: 0.0 + Angle of the ray to be mapped to column coordinate $Width-1$ of PolarTransRegion. Default: 6.2831853 + Radius of the circle to be mapped to row coordinate 0 of PolarTransRegion. Default: 0 + Radius of the circle to be mapped to row coordinate $Height-1$ of PolarTransRegion. Default: 100 + Width of the virtual output image. Default: 512 + Height of the virtual output image. Default: 512 + Interpolation method for the transformation. Default: "nearest_neighbor" + Output region. + + + + Merge regions from line scan images. + Instance represents: Current input regions. + + Merged regions from the previous iteration. + Regions from the previous iteration which could not be merged with the current ones. + Height of the line scan images. Default: 512 + Image line of the current image, which touches the previous image. Default: "top" + Maximum number of images for a single region. Default: 3 + Current regions, merged with old ones where applicable. + + + + Partition a region into rectangles of approximately equal size. + Instance represents: Region to be partitioned. + + Width of the individual rectangles. + Height of the individual rectangles. + Partitioned region. + + + + Partition a region horizontally at positions of small vertical extent. + Instance represents: Region to be partitioned. + + Approximate width of the resulting region parts. + Maximum percental shift of the split position. Default: 20 + Partitioned region. + + + + Convert regions to a label image. + Instance represents: Regions to be converted. + + Pixel type of the result image. Default: "int2" + Width of the image to be generated. Default: 512 + Height of the image to be generated. Default: 512 + Result image of dimension Width * Height containing the converted regions. + + + + Convert a region into a binary byte-image. + Instance represents: Regions to be converted. + + Gray value in which the regions are displayed. Default: 255 + Gray value in which the background is displayed. Default: 0 + Width of the image to be generated. Default: 512 + Height of the image to be generated. Default: 512 + Result image of dimension Width * Height containing the converted regions. + + + + Return the union of two regions. + Instance represents: Region for which the union with all regions in Region2 is to be computed. + + Regions which should be added to Region1. + Resulting regions. + + + + Return the union of all input regions. + Instance represents: Regions of which the union is to be computed. + + Union of all input regions. + + + + Compute the closest-point transformation of a region. + Instance represents: Region for which the distance to the border is computed. + + Image containing the coordinates of the closest points. + Type of metric to be used for the closest-point transformation. Default: "city-block" + Compute the distance for pixels inside (true) or outside (false) the input region. Default: "true" + Mode in which the coordinates of the closest points are returned. Default: "absolute" + Width of the output images. Default: 640 + Height of the output images. Default: 480 + Image containing the distance information. + + + + Compute the distance transformation of a region. + Instance represents: Region for which the distance to the border is computed. + + Type of metric to be used for the distance transformation. Default: "city-block" + Compute the distance for pixels inside (true) or outside (false) the input region. Default: "true" + Width of the output image. Default: 640 + Height of the output image. Default: 480 + Image containing the distance information. + + + + Compute the skeleton of a region. + Instance represents: Region to be thinned. + + Resulting skeleton. + + + + Apply a projective transformation to a region. + Instance represents: Input regions. + + Homogeneous projective transformation matrix. + Interpolation method for the transformation. Default: "bilinear" + Output regions. + + + + Apply an arbitrary affine 2D transformation to regions. + Instance represents: Region(s) to be rotated and scaled. + + Input transformation matrix. + Should the transformation be done using interpolation? Default: "nearest_neighbor" + Transformed output region(s). + + + + Reflect a region about an axis. + Instance represents: Region(s) to be reflected. + + Axis of symmetry. Default: "row" + Twice the coordinate of the axis of symmetry. Default: 512 + Reflected region(s). + + + + Zoom a region. + Instance represents: Region(s) to be zoomed. + + Scale factor in x-direction. Default: 2.0 + Scale factor in y-direction. Default: 2.0 + Zoomed region(s). + + + + Translate a region. + Instance represents: Region(s) to be moved. + + Row coordinate of the vector by which the region is to be moved. Default: 30 + Row coordinate of the vector by which the region is to be moved. Default: 30 + Translated region(s). + + + + Find junctions and end points in a skeleton. + Instance represents: Input skeletons. + + Extracted junctions. + Extracted end points. + + + + Calculate the intersection of two regions. + Instance represents: Regions to be intersected with all regions in Region2. + + Regions with which Region1 is intersected. + Result of the intersection. + + + + Partition the image plane using given regions. + Instance represents: Regions for which the separating lines are to be determined. + + Mode of operation. Default: "mixed" + Output region containing the separating lines. + + + + Fill up holes in regions. + Instance represents: Input regions containing holes. + + Regions without holes. + + + + Fill up holes in regions having given shape features. + Instance represents: Input region(s). + + Shape feature used. Default: "area" + Minimum value for Feature. Default: 1.0 + Maximum value for Feature. Default: 100.0 + Output region(s) with filled holes. + + + + Fill up holes in regions having given shape features. + Instance represents: Input region(s). + + Shape feature used. Default: "area" + Minimum value for Feature. Default: 1.0 + Maximum value for Feature. Default: 100.0 + Output region(s) with filled holes. + + + + Fill gaps between regions or split overlapping regions. + Instance represents: Regions for which the gaps are to be closed, or which are to be separated. + + Regions in which no expansion takes place. + Number of iterations. Default: "maximal" + Expansion mode. Default: "image" + Expanded or separated regions. + + + + Fill gaps between regions or split overlapping regions. + Instance represents: Regions for which the gaps are to be closed, or which are to be separated. + + Regions in which no expansion takes place. + Number of iterations. Default: "maximal" + Expansion mode. Default: "image" + Expanded or separated regions. + + + + Clip a region relative to its smallest surrounding rectangle. + Instance represents: Regions to be clipped. + + Number of rows clipped at the top. Default: 1 + Number of rows clipped at the bottom. Default: 1 + Number of columns clipped at the left. Default: 1 + Number of columns clipped at the right. Default: 1 + Clipped regions. + + + + Clip a region to a rectangle. + Instance represents: Region to be clipped. + + Row coordinate of the upper left corner of the rectangle. Default: 0 + Column coordinate of the upper left corner of the rectangle. Default: 0 + Row coordinate of the lower right corner of the rectangle. Default: 256 + Column coordinate of the lower right corner of the rectangle. Default: 256 + Clipped regions. + + + + Rank operator for regions. + Instance represents: Region(s) to be transformed. + + Width of the filter mask. Default: 15 + Height of the filter mask. Default: 15 + Minimum number of points lying within the filter mask. Default: 70 + Resulting region(s). + + + + Compute connected components of a region. + Instance represents: Input region. + + Connected components. + + + + Calculate the symmetric difference of two regions. + Instance represents: Input region 1. + + Input region 2. + Resulting region. + + + + Calculate the difference of two regions. + Instance represents: Regions to be processed. + + The union of these regions is subtracted from Region. + Resulting region. + + + + Return the complement of a region. + Instance represents: Input region(s). + + Complemented regions. + + + + Determine the connected components of the background of given regions. + Instance represents: Input regions. + + Connected components of the background. + + + + Generate a region having a given Hamming distance. + Instance represents: Region to be modified. + + Width of the region to be changed. Default: 100 + Height of the region to be changed. Default: 100 + Hamming distance between the old and new regions. Default: 1000 + Regions having the required Hamming distance. + + + + Remove noise from a region. + Instance represents: Regions to be modified. + + Mode of noise removal. Default: "n_4" + Less noisy regions. + + + + Transform the shape of a region. + Instance represents: Regions to be transformed. + + Type of transformation. Default: "convex" + Transformed regions. + + + + Fill gaps between regions (depending on gray value or color) or split overlapping regions. + Instance represents: Regions for which the gaps are to be closed, or which are to be separated. + + Image (possibly multi-channel) for gray value or color comparison. + Regions in which no expansion takes place. + Number of iterations. Default: "maximal" + Expansion mode. Default: "image" + Maximum difference between the gray value or color at the region's border and a candidate for expansion. Default: 32 + Expanded or separated regions. + + + + Fill gaps between regions (depending on gray value or color) or split overlapping regions. + Instance represents: Regions for which the gaps are to be closed, or which are to be separated. + + Image (possibly multi-channel) for gray value or color comparison. + Regions in which no expansion takes place. + Number of iterations. Default: "maximal" + Expansion mode. Default: "image" + Maximum difference between the gray value or color at the region's border and a candidate for expansion. Default: 32 + Expanded or separated regions. + + + + Fill gaps between regions (depending on gray value or color) or split overlapping regions. + Instance represents: Regions for which the gaps are to be closed, or which are to be separated. + + Image (possibly multi-channel) for gray value or color comparison. + Regions in which no expansion takes place. + Number of iterations. Default: "maximal" + Expansion mode. Default: "image" + Reference gray value or color for comparison. Default: 128 + Maximum difference between the reference gray value or color and a candidate for expansion. Default: 32 + Expanded or separated regions. + + + + Fill gaps between regions (depending on gray value or color) or split overlapping regions. + Instance represents: Regions for which the gaps are to be closed, or which are to be separated. + + Image (possibly multi-channel) for gray value or color comparison. + Regions in which no expansion takes place. + Number of iterations. Default: "maximal" + Expansion mode. Default: "image" + Reference gray value or color for comparison. Default: 128 + Maximum difference between the reference gray value or color and a candidate for expansion. Default: 32 + Expanded or separated regions. + + + + Split lines represented by one pixel wide, non-branching lines. + Instance represents: Input lines (represented by 1 pixel wide, non-branching regions). + + Maximum distance of the line points to the line segment connecting both end points. Default: 3 + Row coordinates of the start points of the output lines. + Column coordinates of the start points of the output lines. + Row coordinates of the end points of the output lines. + Column coordinates of the end points of the output lines. + + + + Split lines represented by one pixel wide, non-branching regions. + Instance represents: Input lines (represented by 1 pixel wide, non-branching regions). + + Maximum distance of the line points to the line segment connecting both end points. Default: 3 + Split lines. + + + + Convert a histogram into a region. + Modified instance represents: Region containing the histogram. + + Input histogram. + Row coordinate of the center of the histogram. Default: 255 + Column coordinate of the center of the histogram. Default: 255 + Scale factor for the histogram. Default: 1 + + + + Eliminate runs of a given length. + Instance represents: Region to be clipped. + + All runs which are shorter are eliminated. Default: 3 + All runs which are longer are eliminated. Default: 1000 + Clipped regions. + + + + Calculate the difference of two object tuples. + Instance represents: Object tuple 1. + + Object tuple 2. + Objects from Objects that are not part of ObjectsSub. + + + + Paint regions into an image. + Instance represents: Regions to be painted into the input image. + + Image in which the regions are to be painted. + Desired gray values of the regions. Default: 255.0 + Paint regions filled or as boundaries. Default: "fill" + Image containing the result. + + + + Paint regions into an image. + Instance represents: Regions to be painted into the input image. + + Image in which the regions are to be painted. + Desired gray values of the regions. Default: 255.0 + Paint regions filled or as boundaries. Default: "fill" + Image containing the result. + + + + Overpaint regions in an image. + Instance represents: Regions to be painted into the input image. + + Image in which the regions are to be painted. + Desired gray values of the regions. Default: 255.0 + Paint regions filled or as boundaries. Default: "fill" + + + + Overpaint regions in an image. + Instance represents: Regions to be painted into the input image. + + Image in which the regions are to be painted. + Desired gray values of the regions. Default: 255.0 + Paint regions filled or as boundaries. Default: "fill" + + + + Copy an iconic object in the HALCON database. + Instance represents: Objects to be copied. + + Starting index of the objects to be copied. Default: 1 + Number of objects to be copied or -1. Default: 1 + Copied objects. + + + + Concatenate two iconic object tuples. + Instance represents: Object tuple 1. + + Object tuple 2. + Concatenated objects. + + + + Select objects from an object tuple. + Instance represents: Input objects. + + Indices of the objects to be selected. Default: 1 + Selected objects. + + + + Select objects from an object tuple. + Instance represents: Input objects. + + Indices of the objects to be selected. Default: 1 + Selected objects. + + + + Compare iconic objects regarding equality. + Instance represents: Reference objects. + + Test objects. + Maximum allowed difference between two gray values or coordinates etc. Default: 0.0 + Boolean result value. + + + + Compare iconic objects regarding equality. + Instance represents: Reference objects. + + Test objects. + Maximum allowed difference between two gray values or coordinates etc. Default: 0.0 + Boolean result value. + + + + Test whether a region is contained in another region. + Instance represents: Test region. + + Region for comparison. + Is Region1 contained in Region2? + + + + Test whether the regions of two objects are identical. + Instance represents: Test regions. + + Comparative regions. + boolean result value. + + + + Compare image objects regarding equality. + Instance represents: Test objects. + + Comparative objects. + boolean result value. + + + + Store a polygon as a "filled" region. + Modified instance represents: Created region. + + Line indices of the base points of the region contour. Default: 100 + Column indices of the base points of the region contour. Default: 100 + + + + Store a polygon as a region. + Modified instance represents: Created region. + + Line indices of the base points of the region contour. Default: 100 + Colum indices of the base points of the region contour. Default: 100 + + + + Store individual pixels as image region. + Modified instance represents: Created region. + + Lines of the pixels in the region. Default: 100 + Columns of the pixels in the region. Default: 100 + + + + Store individual pixels as image region. + Modified instance represents: Created region. + + Lines of the pixels in the region. Default: 100 + Columns of the pixels in the region. Default: 100 + + + + Create a region from a runlength coding. + Modified instance represents: Created region. + + Lines of the runs. Default: 100 + Columns of the starting points of the runs. Default: 50 + Columns of the ending points of the runs. Default: 200 + + + + Create a region from a runlength coding. + Modified instance represents: Created region. + + Lines of the runs. Default: 100 + Columns of the starting points of the runs. Default: 50 + Columns of the ending points of the runs. Default: 200 + + + + Create a rectangle of any orientation. + Modified instance represents: Created rectangle. + + Line index of the center. Default: 300.0 + Column index of the center. Default: 200.0 + Angle of the first edge to the horizontal (in radians). Default: 0.0 + Half width. Default: 100.0 + Half height. Default: 20.0 + + + + Create a rectangle of any orientation. + Modified instance represents: Created rectangle. + + Line index of the center. Default: 300.0 + Column index of the center. Default: 200.0 + Angle of the first edge to the horizontal (in radians). Default: 0.0 + Half width. Default: 100.0 + Half height. Default: 20.0 + + + + Create a rectangle parallel to the coordinate axes. + Modified instance represents: Created rectangle. + + Line of upper left corner point. Default: 30.0 + Column of upper left corner point. Default: 20.0 + Line of lower right corner point. Default: 100.0 + Column of lower right corner point. Default: 200.0 + + + + Create a rectangle parallel to the coordinate axes. + Modified instance represents: Created rectangle. + + Line of upper left corner point. Default: 30.0 + Column of upper left corner point. Default: 20.0 + Line of lower right corner point. Default: 100.0 + Column of lower right corner point. Default: 200.0 + + + + Create a random region. + Modified instance represents: Created random region with expansion Width x Height. + + Maximum horizontal expansion of random region. Default: 128 + Maximum vertical expansion of random region. Default: 128 + + + + Create an ellipse sector. + Modified instance represents: Created ellipse(s). + + Line index of center. Default: 200.0 + Column index of center. Default: 200.0 + Orientation of the longer radius (Radius1). Default: 0.0 + Longer radius. Default: 100.0 + Shorter radius. Default: 60.0 + Start angle of the sector. Default: 0.0 + End angle of the sector. Default: 3.14159 + + + + Create an ellipse sector. + Modified instance represents: Created ellipse(s). + + Line index of center. Default: 200.0 + Column index of center. Default: 200.0 + Orientation of the longer radius (Radius1). Default: 0.0 + Longer radius. Default: 100.0 + Shorter radius. Default: 60.0 + Start angle of the sector. Default: 0.0 + End angle of the sector. Default: 3.14159 + + + + Create an ellipse. + Modified instance represents: Created ellipse(s). + + Line index of center. Default: 200.0 + Column index of center. Default: 200.0 + Orientation of the longer radius (Radius1). Default: 0.0 + Longer radius. Default: 100.0 + Shorter radius. Default: 60.0 + + + + Create an ellipse. + Modified instance represents: Created ellipse(s). + + Line index of center. Default: 200.0 + Column index of center. Default: 200.0 + Orientation of the longer radius (Radius1). Default: 0.0 + Longer radius. Default: 100.0 + Shorter radius. Default: 60.0 + + + + Create a circle sector. + Modified instance represents: Generated circle sector. + + Line index of center. Default: 200.0 + Column index of center. Default: 200.0 + Radius of circle. Default: 100.5 + Start angle of the circle sector. Default: 0.0 + End angle of the circle sector. Default: 3.14159 + + + + Create a circle sector. + Modified instance represents: Generated circle sector. + + Line index of center. Default: 200.0 + Column index of center. Default: 200.0 + Radius of circle. Default: 100.5 + Start angle of the circle sector. Default: 0.0 + End angle of the circle sector. Default: 3.14159 + + + + Create a circle. + Modified instance represents: Generated circle. + + Line index of center. Default: 200.0 + Column index of center. Default: 200.0 + Radius of circle. Default: 100.5 + + + + Create a circle. + Modified instance represents: Generated circle. + + Line index of center. Default: 200.0 + Column index of center. Default: 200.0 + Radius of circle. Default: 100.5 + + + + Create a checkered region. + Modified instance represents: Created checkerboard region. + + Largest occurring $x$ value of the region. Default: 511 + Largest occurring $y$ value of the region. Default: 511 + Width of a field of the checkerboard. Default: 64 + Height of a field of the checkerboard. Default: 64 + + + + Create a region from lines or pixels. + Modified instance represents: Created lines/pixel region. + + Step width in line direction or zero. Default: 10 + Step width in column direction or zero. Default: 10 + Type of created pattern. Default: "lines" + Maximum width of pattern. Default: 512 + Maximum height of pattern. Default: 512 + + + + Create a region from lines or pixels. + Modified instance represents: Created lines/pixel region. + + Step width in line direction or zero. Default: 10 + Step width in column direction or zero. Default: 10 + Type of created pattern. Default: "lines" + Maximum width of pattern. Default: 512 + Maximum height of pattern. Default: 512 + + + + Create random regions like circles, rectangles and ellipses. + Modified instance represents: Created regions. + + Type of regions to be created. Default: "circle" + Minimum width of the region. Default: 10.0 + Maximum width of the region. Default: 20.0 + Minimum height of the region. Default: 10.0 + Maximum height of the region. Default: 30.0 + Minimum rotation angle of the region. Default: -0.7854 + Maximum rotation angle of the region. Default: 0.7854 + Number of regions. Default: 100 + Maximum horizontal expansion. Default: 512 + Maximum vertical expansion. Default: 512 + + + + Create random regions like circles, rectangles and ellipses. + Modified instance represents: Created regions. + + Type of regions to be created. Default: "circle" + Minimum width of the region. Default: 10.0 + Maximum width of the region. Default: 20.0 + Minimum height of the region. Default: 10.0 + Maximum height of the region. Default: 30.0 + Minimum rotation angle of the region. Default: -0.7854 + Maximum rotation angle of the region. Default: 0.7854 + Number of regions. Default: 100 + Maximum horizontal expansion. Default: 512 + Maximum vertical expansion. Default: 512 + + + + Store input lines described in Hesse normal form as regions. + Modified instance represents: Created regions (one for every line), clipped to maximum image format. + + Orientation of the normal vector in radians. Default: 0.0 + Distance from the line to the coordinate origin (0.0). Default: 200 + + + + Store input lines described in Hesse normal form as regions. + Modified instance represents: Created regions (one for every line), clipped to maximum image format. + + Orientation of the normal vector in radians. Default: 0.0 + Distance from the line to the coordinate origin (0.0). Default: 200 + + + + Store input lines as regions. + Modified instance represents: Created regions. + + Line coordinates of the starting points of the input lines. Default: 100 + Column coordinates of the starting points of the input lines. Default: 50 + Line coordinates of the ending points of the input lines. Default: 150 + Column coordinates of the ending points of the input lines. Default: 250 + + + + Store input lines as regions. + Modified instance represents: Created regions. + + Line coordinates of the starting points of the input lines. Default: 100 + Column coordinates of the starting points of the input lines. Default: 50 + Line coordinates of the ending points of the input lines. Default: 150 + Column coordinates of the ending points of the input lines. Default: 250 + + + + Create an empty region. + Modified instance represents: Empty region (no pixels). + + + + + Access the thickness of a region along the main axis. + Instance represents: Region to be analysed. + + Histogram of the thickness of the region along its main axis. + Thickness of the region along its main axis. + + + + Polygon approximation of a region. + Instance represents: Region to be approximated. + + Maximum distance between the polygon and the edge of the region. Default: 5.0 + Line numbers of the base points of the contour. + Column numbers of the base points of the contour. + + + + Polygon approximation of a region. + Instance represents: Region to be approximated. + + Maximum distance between the polygon and the edge of the region. Default: 5.0 + Line numbers of the base points of the contour. + Column numbers of the base points of the contour. + + + + Access the pixels of a region. + Instance represents: This region is accessed. + + Line numbers of the pixels in the region + Column numbers of the pixels in the region. + + + + Access the contour of an object. + Instance represents: Output region. + + Line numbers of the contour pixels. + Column numbers of the contour pixels. + + + + Access the runlength coding of a region. + Instance represents: Output region. + + Line numbers of the chords. + Column numbers of the starting points of the chords. + Column numbers of the ending points of the chords. + + + + Contour of an object as chain code. + Instance represents: Region to be transformed. + + Line of starting point. + Column of starting point. + Direction code of the contour (from starting point). + + + + Access convex hull as contour. + Instance represents: Output region. + + Line numbers of contour pixels. + Column numbers of the contour pixels. + + + + Classify a related group of characters with an OCR classifier. + Instance represents: Characters to be recognized. + + Gray values of the characters. + Handle of the OCR classifier. + Expression describing the allowed word structure. + Number of classes per character considered for the internal word correction. Default: 3 + Maximum number of corrected characters. Default: 2 + Confidence of the class of the characters. + Word text after classification and correction. + Measure of similarity between corrected word and uncorrected classification results. + Result of classifying the characters with the k-NN. + + + + Classify a related group of characters with an OCR classifier. + Instance represents: Characters to be recognized. + + Gray values of the characters. + Handle of the OCR classifier. + Expression describing the allowed word structure. + Number of classes per character considered for the internal word correction. Default: 3 + Maximum number of corrected characters. Default: 2 + Confidence of the class of the characters. + Word text after classification and correction. + Measure of similarity between corrected word and uncorrected classification results. + Result of classifying the characters with the k-NN. + + + + Classify multiple characters with an k-NN classifier. + Instance represents: Characters to be recognized. + + Gray values of the characters. + Handle of the k-NN classifier. + Confidence of the class of the characters. + Result of classifying the characters with the k-NN. + + + + Classify multiple characters with an k-NN classifier. + Instance represents: Characters to be recognized. + + Gray values of the characters. + Handle of the k-NN classifier. + Confidence of the class of the characters. + Result of classifying the characters with the k-NN. + + + + Classify a single character with an OCR classifier. + Instance represents: Character to be recognized. + + Gray values of the character. + Handle of the k-NN classifier. + Number of maximal classes to determine. Default: 1 + Number of neighbors to consider. Default: 1 + Confidence(s) of the class(es) of the character. + Results of classifying the character with the k-NN. + + + + Classify a single character with an OCR classifier. + Instance represents: Character to be recognized. + + Gray values of the character. + Handle of the k-NN classifier. + Number of maximal classes to determine. Default: 1 + Number of neighbors to consider. Default: 1 + Confidence(s) of the class(es) of the character. + Results of classifying the character with the k-NN. + + + + Classify a related group of characters with an OCR classifier. + Instance represents: Characters to be recognized. + + Gray values of the characters. + Handle of the OCR classifier. + Expression describing the allowed word structure. + Number of classes per character considered for the internal word correction. Default: 3 + Maximum number of corrected characters. Default: 2 + Word text after classification and correction. + Measure of similarity between corrected word and uncorrected classification results. + Result of classifying the characters with the SVM. + + + + Classify multiple characters with an SVM-based OCR classifier. + Instance represents: Characters to be recognized. + + Gray values of the characters. + Handle of the OCR classifier. + Result of classifying the characters with the SVM. + + + + Classify a single character with an SVM-based OCR classifier. + Instance represents: Character to be recognized. + + Gray values of the character. + Handle of the OCR classifier. + Number of best classes to determine. Default: 1 + Result of classifying the character with the SVM. + + + + Classify a related group of characters with an OCR classifier. + Instance represents: Characters to be recognized. + + Gray values of the characters. + Handle of the OCR classifier. + Expression describing the allowed word structure. + Number of classes per character considered for the internal word correction. Default: 3 + Maximum number of corrected characters. Default: 2 + Confidence of the class of the characters. + Word text after classification and correction. + Measure of similarity between corrected word and uncorrected classification results. + Result of classifying the characters with the MLP. + + + + Classify a related group of characters with an OCR classifier. + Instance represents: Characters to be recognized. + + Gray values of the characters. + Handle of the OCR classifier. + Expression describing the allowed word structure. + Number of classes per character considered for the internal word correction. Default: 3 + Maximum number of corrected characters. Default: 2 + Confidence of the class of the characters. + Word text after classification and correction. + Measure of similarity between corrected word and uncorrected classification results. + Result of classifying the characters with the MLP. + + + + Classify multiple characters with an OCR classifier. + Instance represents: Characters to be recognized. + + Gray values of the characters. + Handle of the OCR classifier. + Confidence of the class of the characters. + Result of classifying the characters with the MLP. + + + + Classify multiple characters with an OCR classifier. + Instance represents: Characters to be recognized. + + Gray values of the characters. + Handle of the OCR classifier. + Confidence of the class of the characters. + Result of classifying the characters with the MLP. + + + + Classify a single character with an OCR classifier. + Instance represents: Character to be recognized. + + Gray values of the character. + Handle of the OCR classifier. + Number of best classes to determine. Default: 1 + Confidence(s) of the class(es) of the character. + Result of classifying the character with the MLP. + + + + Classify a single character with an OCR classifier. + Instance represents: Character to be recognized. + + Gray values of the character. + Handle of the OCR classifier. + Number of best classes to determine. Default: 1 + Confidence(s) of the class(es) of the character. + Result of classifying the character with the MLP. + + + + Classify one character. + Instance represents: Character to be recognized. + + Gray values of the characters. + ID of the OCR classifier. + Confidence values of the characters. + Classes (names) of the characters. + + + + Classify characters. + Instance represents: Characters to be recognized. + + Gray values for the characters. + ID of the OCR classifier. + Confidence values of the characters. + Class (name) of the characters. + + + + Classify characters. + Instance represents: Characters to be recognized. + + Gray values for the characters. + ID of the OCR classifier. + Confidence values of the characters. + Class (name) of the characters. + + + + Train an OCR classifier by the input of regions. + Instance represents: Characters to be trained. + + Gray values for the characters. + ID of the desired OCR-classifier. + Class (name) of the characters. Default: "a" + Average confidence during a re-classification of the trained characters. + + + + Train an OCR classifier by the input of regions. + Instance represents: Characters to be trained. + + Gray values for the characters. + ID of the desired OCR-classifier. + Class (name) of the characters. Default: "a" + Average confidence during a re-classification of the trained characters. + + + Protection of training data. + Names of the training files. Default: "" + Passwords for protecting the training files. + Names of the protected training files. + + + Protection of training data. + Names of the training files. Default: "" + Passwords for protecting the training files. + Names of the protected training files. + + + + Storing of training characters into a file. + Instance represents: Characters to be trained. + + Gray values of the characters. + Class (name) of the characters. + Name of the training file. Default: "train_ocr" + + + + Storing of training characters into a file. + Instance represents: Characters to be trained. + + Gray values of the characters. + Class (name) of the characters. + Name of the training file. Default: "train_ocr" + + + + Sorting of regions with respect to their relative position. + Instance represents: Regions to be sorted. + + Kind of sorting. Default: "first_point" + Increasing or decreasing sorting order. Default: "true" + Sorting first with respect to row, then to column. Default: "row" + Sorted regions. + + + + Test an OCR classifier. + Instance represents: Characters to be tested. + + Gray values for the characters. + ID of the desired OCR-classifier. + Class (name) of the characters. Default: "a" + Confidence for the character to belong to the class. + + + + Test an OCR classifier. + Instance represents: Characters to be tested. + + Gray values for the characters. + ID of the desired OCR-classifier. + Class (name) of the characters. Default: "a" + Confidence for the character to belong to the class. + + + + Add characters to a training file. + Instance represents: Characters to be trained. + + Gray values of the characters. + Class (name) of the characters. + Name of the training file. Default: "train_ocr" + + + + Add characters to a training file. + Instance represents: Characters to be trained. + + Gray values of the characters. + Class (name) of the characters. + Name of the training file. Default: "train_ocr" + + + + Prune the branches of a region. + Instance represents: Regions to be processed. + + Length of the branches to be removed. Default: 2 + Result of the pruning operation. + + + + Reduce a region to its boundary. + Instance represents: Regions for which the boundary is to be computed. + + Boundary type. Default: "inner" + Resulting boundaries. + + + + Perform a closing after an opening with multiple structuring elements. + Instance represents: Regions to be processed. + + Structuring elements. + Fitted regions. + + + + Generate standard structuring elements. + Modified instance represents: Generated structuring elements. + + Type of structuring element to generate. Default: "noise" + Row coordinate of the reference point. Default: 1 + Column coordinate of the reference point. Default: 1 + + + + Reflect a region about a point. + Instance represents: Region to be reflected. + + Row coordinate of the reference point. Default: 0 + Column coordinate of the reference point. Default: 0 + Transposed region. + + + + Remove the result of a hit-or-miss operation from a region (sequential). + Instance represents: Regions to be processed. + + Structuring element from the Golay alphabet. Default: "l" + Number of iterations. For 'f', 'f2', 'h' and 'i' the only useful value is 1. Default: 20 + Result of the thinning operator. + + + + Remove the result of a hit-or-miss operation from a region (sequential). + Instance represents: Regions to be processed. + + Structuring element from the Golay alphabet. Default: "l" + Number of iterations. For 'f', 'f2', 'h' and 'i' the only useful value is 1. Default: 20 + Result of the thinning operator. + + + + Remove the result of a hit-or-miss operation from a region (using a Golay structuring element). + Instance represents: Regions to be processed. + + Structuring element from the Golay alphabet. Default: "h" + Rotation of the Golay element. Depending on the element, not all rotations are valid. Default: 0 + Result of the thinning operator. + + + + Remove the result of a hit-or-miss operation from a region. + Instance represents: Regions to be processed. + + Structuring element for the foreground. + Structuring element for the background. + Row coordinate of the reference point. Default: 0 + Column coordinate of the reference point. Default: 0 + Number of iterations. Default: 1 + Result of the thinning operator. + + + + Add the result of a hit-or-miss operation to a region (sequential). + Instance represents: Regions to be processed. + + Structuring element from the Golay alphabet. Default: "h" + Number of iterations. Default: 1 + Result of the thickening operator. + + + + Add the result of a hit-or-miss operation to a region (using a Golay structuring element). + Instance represents: Regions to be processed. + + Structuring element from the Golay alphabet. Default: "h" + Rotation of the Golay element. Depending on the element, not all rotations are valid. Default: 0 + Result of the thickening operator. + + + + Add the result of a hit-or-miss operation to a region. + Instance represents: Regions to be processed. + + Structuring element for the foreground. + Structuring element for the background. + Row coordinate of the reference point. Default: 16 + Column coordinate of the reference point. Default: 16 + Number of iterations. Default: 1 + Result of the thickening operator. + + + + Hit-or-miss operation for regions using the Golay alphabet (sequential). + Instance represents: Regions to be processed. + + Structuring element from the Golay alphabet. Default: "h" + Result of the hit-or-miss operation. + + + + Hit-or-miss operation for regions using the Golay alphabet. + Instance represents: Regions to be processed. + + Structuring element from the Golay alphabet. Default: "h" + Rotation of the Golay element. Depending on the element, not all rotations are valid. Default: 0 + Result of the hit-or-miss operation. + + + + Hit-or-miss operation for regions. + Instance represents: Regions to be processed. + + Erosion mask for the input regions. + Erosion mask for the complements of the input regions. + Row coordinate of the reference point. Default: 16 + Column coordinate of the reference point. Default: 16 + Result of the hit-or-miss operation. + + + + Generate the structuring elements of the Golay alphabet. + Modified instance represents: Structuring element for the foreground. + + Name of the structuring element. Default: "l" + Rotation of the Golay element. Depending on the element, not all rotations are valid. Default: 0 + Row coordinate of the reference point. Default: 16 + Column coordinate of the reference point. Default: 16 + Structuring element for the background. + + + + Thinning of a region. + Instance represents: Regions to be thinned. + + Number of iterations for the sequential thinning with the element 'l' of the Golay alphabet. Default: 100 + Number of iterations for the sequential thinning with the element 'e' of the Golay alphabet. Default: 1 + Result of the skiz operator. + + + + Thinning of a region. + Instance represents: Regions to be thinned. + + Number of iterations for the sequential thinning with the element 'l' of the Golay alphabet. Default: 100 + Number of iterations for the sequential thinning with the element 'e' of the Golay alphabet. Default: 1 + Result of the skiz operator. + + + + Compute the morphological skeleton of a region. + Instance represents: Regions to be processed. + + Resulting morphological skeleton. + + + + Compute the union of bottom_hat and top_hat. + Instance represents: Regions to be processed. + + Structuring element (position-invariant). + Union of top hat and bottom hat. + + + + Compute the bottom hat of regions. + Instance represents: Regions to be processed. + + Structuring element (position independent). + Result of the bottom hat operator. + + + + Compute the top hat of regions. + Instance represents: Regions to be processed. + + Structuring element (position independent). + Result of the top hat operator. + + + + Erode a region (using a reference point). + Instance represents: Regions to be eroded. + + Structuring element. + Row coordinate of the reference point. Default: 0 + Column coordinate of the reference point. Default: 0 + Number of iterations. Default: 1 + Eroded regions. + + + + Erode a region. + Instance represents: Regions to be eroded. + + Structuring element. + Number of iterations. Default: 1 + Eroded regions. + + + + Dilate a region (using a reference point). + Instance represents: Regions to be dilated. + + Structuring element. + Row coordinate of the reference point. + Column coordinate of the reference point. + Number of iterations. Default: 1 + Dilated regions. + + + + Perform a Minkowski addition on a region. + Instance represents: Regions to be dilated. + + Structuring element. + Number of iterations. Default: 1 + Dilated regions. + + + + Close a region with a rectangular structuring element. + Instance represents: Regions to be closed. + + Width of the structuring rectangle. Default: 10 + Height of the structuring rectangle. Default: 10 + Closed regions. + + + + Close a region with an element from the Golay alphabet. + Instance represents: Regions to be closed. + + Structuring element from the Golay alphabet. Default: "h" + Rotation of the Golay element. Depending on the element, not all rotations are valid. Default: 0 + Closed regions. + + + + Close a region with a circular structuring element. + Instance represents: Regions to be closed. + + Radius of the circular structuring element. Default: 3.5 + Closed regions. + + + + Close a region with a circular structuring element. + Instance represents: Regions to be closed. + + Radius of the circular structuring element. Default: 3.5 + Closed regions. + + + + Close a region. + Instance represents: Regions to be closed. + + Structuring element (position-invariant). + Closed regions. + + + + Separate overlapping regions. + Instance represents: Regions to be opened. + + Structuring element (position-invariant). + Opened regions. + + + + Open a region with an element from the Golay alphabet. + Instance represents: Regions to be opened. + + Structuring element from the Golay alphabet. Default: "h" + Rotation of the Golay element. Depending on the element, not all rotations are valid. Default: 0 + Opened regions. + + + + Open a region with a rectangular structuring element. + Instance represents: Regions to be opened. + + Width of the structuring rectangle. Default: 10 + Height of the structuring rectangle. Default: 10 + Opened regions. + + + + Open a region with a circular structuring element. + Instance represents: Regions to be opened. + + Radius of the circular structuring element. Default: 3.5 + Opened regions. + + + + Open a region with a circular structuring element. + Instance represents: Regions to be opened. + + Radius of the circular structuring element. Default: 3.5 + Opened regions. + + + + Open a region. + Instance represents: Regions to be opened. + + Structuring element (position-invariant). + Opened regions. + + + + Erode a region sequentially. + Instance represents: Regions to be eroded. + + Structuring element from the Golay alphabet. Default: "h" + Number of iterations. Default: 1 + Eroded regions. + + + + Erode a region with an element from the Golay alphabet. + Instance represents: Regions to be eroded. + + Structuring element from the Golay alphabet. Default: "h" + Number of iterations. Default: 1 + Rotation of the Golay element. Depending on the element, not all rotations are valid. Default: 0 + Eroded regions. + + + + Erode a region with a rectangular structuring element. + Instance represents: Regions to be eroded. + + Width of the structuring rectangle. Default: 11 + Height of the structuring rectangle. Default: 11 + Eroded regions. + + + + Erode a region with a circular structuring element. + Instance represents: Regions to be eroded. + + Radius of the circular structuring element. Default: 3.5 + Eroded regions. + + + + Erode a region with a circular structuring element. + Instance represents: Regions to be eroded. + + Radius of the circular structuring element. Default: 3.5 + Eroded regions. + + + + Erode a region (using a reference point). + Instance represents: Regions to be eroded. + + Structuring element. + Row coordinate of the reference point. Default: 0 + Column coordinate of the reference point. Default: 0 + Number of iterations. Default: 1 + Eroded regions. + + + + Erode a region. + Instance represents: Regions to be eroded. + + Structuring element. + Number of iterations. Default: 1 + Eroded regions. + + + + Dilate a region sequentially. + Instance represents: Regions to be dilated. + + Structuring element from the Golay alphabet. Default: "h" + Number of iterations. Default: 1 + Dilated regions. + + + + Dilate a region with an element from the Golay alphabet. + Instance represents: Regions to be dilated. + + Structuring element from the Golay alphabet. Default: "h" + Number of iterations. Default: 1 + Rotation of the Golay element. Depending on the element, not all rotations are valid. Default: 0 + Dilated regions. + + + + Dilate a region with a rectangular structuring element. + Instance represents: Regions to be dilated. + + Width of the structuring rectangle. Default: 11 + Height of the structuring rectangle. Default: 11 + Dilated regions. + + + + Dilate a region with a circular structuring element. + Instance represents: Regions to be dilated. + + Radius of the circular structuring element. Default: 3.5 + Dilated regions. + + + + Dilate a region with a circular structuring element. + Instance represents: Regions to be dilated. + + Radius of the circular structuring element. Default: 3.5 + Dilated regions. + + + + Dilate a region (using a reference point). + Instance represents: Regions to be dilated. + + Structuring element. + Row coordinate of the reference point. Default: 0 + Column coordinate of the reference point. Default: 0 + Number of iterations. Default: 1 + Dilated regions. + + + + Dilate a region. + Instance represents: Regions to be dilated. + + Structuring element. + Number of iterations. Default: 1 + Dilated regions. + + + + Add gray values to regions. + Instance represents: Input regions (without pixel values). + + Input image with pixel values for regions. + Output image(s) with regions and pixel values (one image per input region). + + + + Centres of circles for a specific radius. + Instance represents: Binary edge image in which the circles are to be detected. + + Radius of the circle to be searched in the image. Default: 12 + Indicates the percentage (approximately) of the (ideal) circle which must be present in the edge image RegionIn. Default: 60 + The modus defines the position of the circle in question: 0 - the radius is equivalent to the outer border of the set pixels. 1 - the radius is equivalent to the centres of the circle lines' pixels. 2 - both 0 and 1 (a little more fuzzy, but more reliable in contrast to circles set slightly differently, necessitates 50 + Centres of those circles which are included in the edge image by Percent percent. + + + + Centres of circles for a specific radius. + Instance represents: Binary edge image in which the circles are to be detected. + + Radius of the circle to be searched in the image. Default: 12 + Indicates the percentage (approximately) of the (ideal) circle which must be present in the edge image RegionIn. Default: 60 + The modus defines the position of the circle in question: 0 - the radius is equivalent to the outer border of the set pixels. 1 - the radius is equivalent to the centres of the circle lines' pixels. 2 - both 0 and 1 (a little more fuzzy, but more reliable in contrast to circles set slightly differently, necessitates 50 + Centres of those circles which are included in the edge image by Percent percent. + + + + Return the Hough-Transform for circles with a given radius. + Instance represents: Binary edge image in which the circles are to be detected. + + Radius of the circle to be searched in the image. Default: 12 + Hough transform for circles with a given radius. + + + + Return the Hough-Transform for circles with a given radius. + Instance represents: Binary edge image in which the circles are to be detected. + + Radius of the circle to be searched in the image. Default: 12 + Hough transform for circles with a given radius. + + + + Detect lines in edge images with the help of the Hough transform and returns it in HNF. + Instance represents: Binary edge image in which the lines are to be detected. + + Adjusting the resolution in the angle area. Default: 4 + Threshold value in the Hough image. Default: 100 + Minimal distance of two maxima in the Hough image (direction: angle). Default: 5 + Minimal distance of two maxima in the Hough image (direction: distance). Default: 5 + Distance of the detected lines from the origin. + Angles (in radians) of the detected lines' normal vectors. + + + + Produce the Hough transform for lines within regions. + Instance represents: Binary edge image in which lines are to be detected. + + Adjusting the resolution in the angle area. Default: 4 + Hough transform for lines. + + + + Select those lines from a set of lines (in HNF) which fit best into a region. + Instance represents: Region in which the lines are to be matched. + + Angles (in radians) of the normal vectors of the input lines. + Distances of the input lines form the origin. + Widths of the lines. Default: 7 + Threshold value for the number of line points in the region. Default: 100 + Angles (in radians) of the normal vectors of the selected lines. + Distances of the selected lines from the origin. + Region array containing the matched lines. + + + + Select those lines from a set of lines (in HNF) which fit best into a region. + Instance represents: Region in which the lines are to be matched. + + Angles (in radians) of the normal vectors of the input lines. + Distances of the input lines form the origin. + Widths of the lines. Default: 7 + Threshold value for the number of line points in the region. Default: 100 + Angles (in radians) of the normal vectors of the selected lines. + Distances of the selected lines from the origin. + Region array containing the matched lines. + + + + Query the icon for region output + Modified instance represents: Icon for the regions center of gravity. + + Window handle. + + + + Icon definition for region output. + Instance represents: Icon for center of gravity. + + Window handle. + + + + Displays regions in a window. + Instance represents: Regions to display. + + Window handle. + + + + Interactive movement of a region with restriction of positions. + Instance represents: Regions to move. + + Points on which it is allowed for a region to move. + Window handle. + Row index of the reference point. Default: 100 + Column index of the reference point. Default: 100 + Moved regions. + + + + Interactive movement of a region with fixpoint specification. + Instance represents: Regions to move. + + Window handle. + Row index of the reference point. Default: 100 + Column index of the reference point. Default: 100 + Moved regions. + + + + Interactive moving of a region. + Instance represents: Regions to move. + + Window handle. + Moved Regions. + + + + Interactive drawing of a closed region. + Modified instance represents: Interactive created region. + + Window handle. + + + + Interactive drawing of a polygon row. + Modified instance represents: Region, which encompasses all painted points. + + Window handle. + + + + Calculate the distance between a line segment and one region. + Instance represents: Input region. + + Row coordinate of the first point of the line segment. + Column coordinate of the first point of the line segment. + Row coordinate of the second point of the line segment. + Column coordinate of the second point of the line segment. + Minimum distance between the line segment and the region. + Maximum distance between the line segment and the region. + + + + Calculate the distance between a line segment and one region. + Instance represents: Input region. + + Row coordinate of the first point of the line segment. + Column coordinate of the first point of the line segment. + Row coordinate of the second point of the line segment. + Column coordinate of the second point of the line segment. + Minimum distance between the line segment and the region. + Maximum distance between the line segment and the region. + + + + Calculate the distance between a line and a region. + Instance represents: Input region. + + Row coordinate of the first point of the line. + Column coordinate of the first point of the line. + Row coordinate of the second point of the line. + Column coordinate of the second point of the line. + Minimum distance between the line and the region + Maximum distance between the line and the region + + + + Calculate the distance between a line and a region. + Instance represents: Input region. + + Row coordinate of the first point of the line. + Column coordinate of the first point of the line. + Row coordinate of the second point of the line. + Column coordinate of the second point of the line. + Minimum distance between the line and the region + Maximum distance between the line and the region + + + + Calculate the distance between a point and a region. + Instance represents: Input region. + + Row coordinate of the point. + Column coordinate of the point. + Minimum distance between the point and the region. + Maximum distance between the point and the region. + + + + Calculate the distance between a point and a region. + Instance represents: Input region. + + Row coordinate of the point. + Column coordinate of the point. + Minimum distance between the point and the region. + Maximum distance between the point and the region. + + + + Determine the noise distribution of an image. + Instance represents: Region from which the noise distribution is to be estimated. + + Corresponding image. + Size of the mean filter. Default: 21 + Noise distribution of all input regions. + + + + Determine the fuzzy entropy of regions. + Instance represents: Regions for which the fuzzy entropy is to be calculated. + + Input image containing the fuzzy membership values. + Start of the fuzzy function. Default: 0 + End of the fuzzy function. Default: 255 + Fuzzy entropy of a region. + + + + Calculate the fuzzy perimeter of a region. + Instance represents: Regions for which the fuzzy perimeter is to be calculated. + + Input image containing the fuzzy membership values. + Start of the fuzzy function. Default: 0 + End of the fuzzy function. Default: 255 + Fuzzy perimeter of a region. + + + + Paint regions with their average gray value. + Instance represents: Input regions. + + original gray-value image. + Result image with painted regions. + + + + Close edge gaps using the edge amplitude image. + Instance represents: Region containing one pixel thick edges. + + Edge amplitude (gradient) image. + Minimum edge amplitude. Default: 16 + Maximal number of points by which edges are extended. Default: 3 + Region containing closed edges. + + + + Close edge gaps using the edge amplitude image. + Instance represents: Region containing one pixel thick edges. + + Edge amplitude (gradient) image. + Minimum edge amplitude. Default: 16 + Region containing closed edges. + + + + Deserialize a serialized region. + Modified instance represents: Region. + + Handle of the serialized item. + + + + Serialize a region. + Instance represents: Region. + + Handle of the serialized item. + + + + Write regions to a file. + Instance represents: Region of the images which are returned. + + Name of region file. Default: "region.hobj" + + + + Read binary images or HALCON regions. + Modified instance represents: Read region. + + Name of the region to be read. + + + + Geometric moments of regions. + Instance represents: Regions to be examined. + + Moment of 2nd order. + Moment of 2nd order. + Moment of 2nd order. + Moment of 2nd order. + + + + Geometric moments of regions. + Instance represents: Regions to be examined. + + Moment of 2nd order. + Moment of 2nd order. + Moment of 2nd order. + Moment of 2nd order. + + + + Geometric moments of regions. + Instance represents: Regions to be examined. + + Moment of 2nd order. + Moment of 2nd order. + Moment of 3rd order. + Moment of 2nd order. + + + + Geometric moments of regions. + Instance represents: Regions to be examined. + + Moment of 2nd order. + Moment of 2nd order. + Moment of 3rd order. + Moment of 2nd order. + + + + Geometric moments of regions. + Instance represents: Regions to be examined. + + Moment of 3rd order (column-dependent). + Moment of 3rd order (column-dependent). + Moment of 3rd order (line-dependent). + Moment of 3rd order (line-dependent). + + + + Geometric moments of regions. + Instance represents: Regions to be examined. + + Moment of 3rd order (column-dependent). + Moment of 3rd order (column-dependent). + Moment of 3rd order (line-dependent). + Moment of 3rd order (line-dependent). + + + + Geometric moments of regions. + Instance represents: Regions to be examined. + + Moment of 3rd order (column-dependent). + Moment of 3rd order (column-dependent). + Moment of 3rd order (line-dependent). + Moment of 3rd order (line-dependent). + + + + Geometric moments of regions. + Instance represents: Regions to be examined. + + Moment of 3rd order (column-dependent). + Moment of 3rd order (column-dependent). + Moment of 3rd order (line-dependent). + Moment of 3rd order (line-dependent). + + + + Smallest surrounding rectangle with any orientation. + Instance represents: Regions to be examined. + + Line index of the center. + Column index of the center. + Orientation of the surrounding rectangle (arc measure) + First radius (half length) of the surrounding rectangle. + Second radius (half width) of the surrounding rectangle. + + + + Smallest surrounding rectangle with any orientation. + Instance represents: Regions to be examined. + + Line index of the center. + Column index of the center. + Orientation of the surrounding rectangle (arc measure) + First radius (half length) of the surrounding rectangle. + Second radius (half width) of the surrounding rectangle. + + + + Surrounding rectangle parallel to the coordinate axes. + Instance represents: Regions to be examined. + + Line index of upper left corner point. + Column index of upper left corner point. + Line index of lower right corner point. + Column index of lower right corner point. + + + + Surrounding rectangle parallel to the coordinate axes. + Instance represents: Regions to be examined. + + Line index of upper left corner point. + Column index of upper left corner point. + Line index of lower right corner point. + Column index of lower right corner point. + + + + Smallest surrounding circle of a region. + Instance represents: Regions to be examined. + + Line index of the center. + Column index of the center. + Radius of the surrounding circle. + + + + Smallest surrounding circle of a region. + Instance represents: Regions to be examined. + + Line index of the center. + Column index of the center. + Radius of the surrounding circle. + + + + Choose regions having a certain relation to each other. + Instance represents: Regions to be examined. + + Region compared to Regions. + Shape features to be checked. Default: "covers" + Lower border of feature. Default: 50.0 + Upper border of the feature. Default: 100.0 + Regions fulfilling the condition. + + + + Choose regions having a certain relation to each other. + Instance represents: Regions to be examined. + + Region compared to Regions. + Shape features to be checked. Default: "covers" + Lower border of feature. Default: 50.0 + Upper border of the feature. Default: 100.0 + Regions fulfilling the condition. + + + + Calculate shape features of regions. + Instance represents: Regions to be examined. + + Shape features to be calculated. Default: "area" + The calculated features. + + + + Calculate shape features of regions. + Instance represents: Regions to be examined. + + Shape features to be calculated. Default: "area" + The calculated features. + + + + Choose regions with the aid of shape features. + Instance represents: Regions to be examined. + + Shape features to be checked. Default: "area" + Linkage type of the individual features. Default: "and" + Lower limits of the features or 'min'. Default: 150.0 + Upper limits of the features or 'max'. Default: 99999.0 + Regions fulfilling the condition. + + + + Choose regions with the aid of shape features. + Instance represents: Regions to be examined. + + Shape features to be checked. Default: "area" + Linkage type of the individual features. Default: "and" + Lower limits of the features or 'min'. Default: 150.0 + Upper limits of the features or 'max'. Default: 99999.0 + Regions fulfilling the condition. + + + + Characteristic values for runlength coding of regions. + Instance represents: Regions to be examined. + + Storing factor in relation to a square. + Mean number of runs per line. + Mean length of runs. + Number of bytes necessary for coding the region. + Number of runs. + + + + Characteristic values for runlength coding of regions. + Instance represents: Regions to be examined. + + Storing factor in relation to a square. + Mean number of runs per line. + Mean length of runs. + Number of bytes necessary for coding the region. + Number of runs. + + + + Search direct neighbors. + Instance represents: Starting regions. + + Comparative regions. + Maximal distance of regions. Default: 1 + Indices of the found regions from Regions2. + Indices of the found regions from Regions1. + + + + Geometric moments of regions. + Instance represents: Regions to be examined. + + Moment of 2nd order. + Moment of 2nd order. + + + + Geometric moments of regions. + Instance represents: Regions to be examined. + + Moment of 2nd order. + Moment of 2nd order. + + + + Geometric moments of regions. + Instance represents: Regions to be examined. + + Moment of 2nd order (line-dependent). + Moment of 2nd order (column-dependent). + Product of inertia of the axes through the center parallel to the coordinate axes. + + + + Geometric moments of regions. + Instance represents: Regions to be examined. + + Moment of 2nd order (line-dependent). + Moment of 2nd order (column-dependent). + Product of inertia of the axes through the center parallel to the coordinate axes. + + + + Calculate the geometric moments of regions. + Instance represents: Input regions. + + Moment of 2nd order (row-dependent). + Moment of 2nd order (column-dependent). + Length of the major axis of the input region. + Length of the minor axis of the input region. + Product of inertia of the axes through the center parallel to the coordinate axes. + + + + Calculate the geometric moments of regions. + Instance represents: Input regions. + + Moment of 2nd order (row-dependent). + Moment of 2nd order (column-dependent). + Length of the major axis of the input region. + Length of the minor axis of the input region. + Product of inertia of the axes through the center parallel to the coordinate axes. + + + + Minimum distance between the contour pixels of two regions each. + Instance represents: Regions to be examined. + + Regions to be examined. + Line index on contour in Regions1. + Column index on contour in Regions1. + Line index on contour in Regions2. + Column index on contour in Regions2. + Minimum distance between contours of the regions. + + + + Minimum distance between the contour pixels of two regions each. + Instance represents: Regions to be examined. + + Regions to be examined. + Line index on contour in Regions1. + Column index on contour in Regions1. + Line index on contour in Regions2. + Column index on contour in Regions2. + Minimum distance between contours of the regions. + + + + Minimum distance between two regions with the help of dilation. + Instance represents: Regions to be examined. + + Regions to be examined. + Minimum distances of the regions. + + + + Maximal distance between two boundary points of a region. + Instance represents: Regions to be examined. + + Row index of the first extreme point. + Column index of the first extreme point. + Row index of the second extreme point. + Column index of the second extreme point. + Distance of the two extreme points. + + + + Maximal distance between two boundary points of a region. + Instance represents: Regions to be examined. + + Row index of the first extreme point. + Column index of the first extreme point. + Row index of the second extreme point. + Column index of the second extreme point. + Distance of the two extreme points. + + + + Test if the region contains a given point. + Instance represents: Region(s) to be examined. + + Row index of the test pixel(s). Default: 100 + Column index of the test pixel(s). Default: 100 + Boolean result value. + + + + Test if the region contains a given point. + Instance represents: Region(s) to be examined. + + Row index of the test pixel(s). Default: 100 + Column index of the test pixel(s). Default: 100 + Boolean result value. + + + + Index of all regions containing a given pixel. + Instance represents: Regions to be examined. + + Line index of the test pixel. Default: 100 + Column index of the test pixel. Default: 100 + Index of the regions containing the test pixel. + + + + Choose all regions containing a given pixel. + Instance represents: Regions to be examined. + + Line index of the test pixel. Default: 100 + Column index of the test pixel. Default: 100 + All regions containing the test pixel. + + + + Select regions of a given shape. + Instance represents: Input regions to be selected. + + Shape features to be checked. Default: "max_area" + Similarity measure. Default: 70.0 + Regions with desired shape. + + + + Hamming distance between two regions using normalization. + Instance represents: Regions to be examined. + + Comparative regions. + Type of normalization. Default: "center" + Similarity of two regions. + Hamming distance of two regions. + + + + Hamming distance between two regions using normalization. + Instance represents: Regions to be examined. + + Comparative regions. + Type of normalization. Default: "center" + Similarity of two regions. + Hamming distance of two regions. + + + + Hamming distance between two regions. + Instance represents: Regions to be examined. + + Comparative regions. + Similarity of two regions. + Hamming distance of two regions. + + + + Hamming distance between two regions. + Instance represents: Regions to be examined. + + Comparative regions. + Similarity of two regions. + Hamming distance of two regions. + + + + Shape features derived from the ellipse parameters. + Instance represents: Region(s) to be examined. + + Calculated shape feature. + Calculated shape feature. + Shape feature (in case of a circle = 1.0). + + + + Shape features derived from the ellipse parameters. + Instance represents: Region(s) to be examined. + + Calculated shape feature. + Calculated shape feature. + Shape feature (in case of a circle = 1.0). + + + + Calculate the Euler number. + Instance represents: Region(s) to be examined. + + Calculated Euler number. + + + + Orientation of a region. + Instance represents: Region(s) to be examined. + + Orientation of region (arc measure). + + + + Calculate the parameters of the equivalent ellipse. + Instance represents: Input regions. + + Secondary radius (normalized to the area). + Angle between main radius and x-axis in radians. + Main radius (normalized to the area). + + + + Calculate the parameters of the equivalent ellipse. + Instance represents: Input regions. + + Secondary radius (normalized to the area). + Angle between main radius and x-axis in radians. + Main radius (normalized to the area). + + + + Pose relation of regions. + Instance represents: Starting regions + + Comparative regions + Desired neighboring relation. Default: "left" + Indices in the input tuples (Regions1 or ParRef{Regions2}), respectively. + Indices in the input tuples (Regions1 or ParRef{Regions2}), respectively. + + + + Pose relation of regions with regard to + Instance represents: Starting regions. + + Comparative regions. + Percentage of the area of the comparative region which must be located left/right or Default: 50 + Indices of the regions in the tuple of the input regions which fulfill the pose relation. + Horizontal pose relation in which RegionIndex2[n] stands with RegionIndex1[n]. + Vertical pose relation in which RegionIndex2[n] stands with RegionIndex1[n]. + Indices of the regions in the tuple of the input regions which fulfill the pose relation. + + + + Shape factor for the convexity of a region. + Instance represents: Region(s) to be examined. + + Convexity of the input region(s). + + + + Contour length of a region. + Instance represents: Region(s) to be examined. + + Contour length of the input region(s). + + + + Number of connection components and holes + Instance represents: Region(s) to be examined. + + Number of holes of a region. + Number of connection components of a region. + + + + Number of connection components and holes + Instance represents: Region(s) to be examined. + + Number of holes of a region. + Number of connection components of a region. + + + + Shape factor for the rectangularity of a region. + Instance represents: Region(s) to be examined. + + Rectangularity of the input region(s). + + + + Shape factor for the compactness of a region. + Instance represents: Region(s) to be examined. + + Compactness of the input region(s). + + + + Shape factor for the circularity (similarity to a circle) of a region. + Instance represents: Region(s) to be examined. + + Circularity of the input region(s). + + + + Compute the area of holes of regions. + Instance represents: Region(s) to be examined. + + Area(s) of holes of the region(s). + + + + Area and center of regions. + Instance represents: Region(s) to be examined. + + Line index of the center. + Column index of the center. + Area of the region. + + + + Area and center of regions. + Instance represents: Region(s) to be examined. + + Line index of the center. + Column index of the center. + Area of the region. + + + + Distribution of runs needed for runlength encoding of a region. + Instance represents: Region to be examined. + + Length distribution of the background. + Length distribution of the region (foreground). + + + + Shape factors from contour. + Instance represents: Region(s) to be examined. + + Standard deviation of Distance. + Shape factor for roundness. + Number of polygon sides. + Mean distance from the center. + + + + Shape factors from contour. + Instance represents: Region(s) to be examined. + + Standard deviation of Distance. + Shape factor for roundness. + Number of polygon sides. + Mean distance from the center. + + + + Largest inner rectangle of a region. + Instance represents: Region to be examined. + + Row coordinate of the upper left corner point. + Column coordinate of the upper left corner point. + Row coordinate of the lower right corner point. + Column coordinate of the lower right corner point. + + + + Largest inner rectangle of a region. + Instance represents: Region to be examined. + + Row coordinate of the upper left corner point. + Column coordinate of the upper left corner point. + Row coordinate of the lower right corner point. + Column coordinate of the lower right corner point. + + + + Largest inner circle of a region. + Instance represents: Regions to be examined. + + Line index of the center. + Column index of the center. + Radius of the inner circle. + + + + Largest inner circle of a region. + Instance represents: Regions to be examined. + + Line index of the center. + Column index of the center. + Radius of the inner circle. + + + + Calculate gray value moments and approximation by a first order surface (plane). + Instance represents: Regions to be checked. + + Corresponding gray values. + Algorithm for the fitting. Default: "regression" + Maximum number of iterations (unused for 'regression'). Default: 5 + Clipping factor for the elimination of outliers. Default: 2.0 + Parameter Beta of the approximating surface. + Parameter Gamma of the approximating surface. + Parameter Alpha of the approximating surface. + + + + Calculate gray value moments and approximation by a first order surface (plane). + Instance represents: Regions to be checked. + + Corresponding gray values. + Algorithm for the fitting. Default: "regression" + Maximum number of iterations (unused for 'regression'). Default: 5 + Clipping factor for the elimination of outliers. Default: 2.0 + Parameter Beta of the approximating surface. + Parameter Gamma of the approximating surface. + Parameter Alpha of the approximating surface. + + + + Calculate gray value moments and approximation by a second order surface. + Instance represents: Regions to be checked. + + Corresponding gray values. + Algorithm for the fitting. Default: "regression" + Maximum number of iterations (unused for 'regression'). Default: 5 + Clipping factor for the elimination of outliers. Default: 2.0 + Parameter Beta of the approximating surface. + Parameter Gamma of the approximating surface. + Parameter Delta of the approximating surface. + Parameter Epsilon of the approximating surface. + Parameter Zeta of the approximating surface. + Parameter Alpha of the approximating surface. + + + + Calculate gray value moments and approximation by a second order surface. + Instance represents: Regions to be checked. + + Corresponding gray values. + Algorithm for the fitting. Default: "regression" + Maximum number of iterations (unused for 'regression'). Default: 5 + Clipping factor for the elimination of outliers. Default: 2.0 + Parameter Beta of the approximating surface. + Parameter Gamma of the approximating surface. + Parameter Delta of the approximating surface. + Parameter Epsilon of the approximating surface. + Parameter Zeta of the approximating surface. + Parameter Alpha of the approximating surface. + + + + Determine a histogram of features along all threshold values. + Instance represents: Region in which the features are to be examined. + + Gray value image. + Feature to be examined. Default: "convexity" + Row of the pixel which the region must contain. Default: 256 + Column of the pixel which the region must contain. Default: 256 + Relative distribution of the feature. + Absolute distribution of the feature. + + + + Determine a histogram of features along all threshold values. + Instance represents: Region in which the features are to be examined. + + Gray value image. + Feature to be examined. Default: "connected_components" + Relative distribution of the feature. + Absolute distribution of the feature. + + + + Calculates gray value features for a set of regions. + Instance represents: Regions to be examined. + + Gray value image. + Names of the features. Default: "mean" + Value sof the features. + + + + Calculates gray value features for a set of regions. + Instance represents: Regions to be examined. + + Gray value image. + Names of the features. Default: "mean" + Value sof the features. + + + + Select regions based on gray value features. + Instance represents: Regions to be examined. + + Gray value image. + Names of the features. Default: "mean" + Logical connection of features. Default: "and" + Lower limit(s) of features. Default: 128.0 + Upper limit(s) of features. Default: 255.0 + Regions having features within the limits. + + + + Select regions based on gray value features. + Instance represents: Regions to be examined. + + Gray value image. + Names of the features. Default: "mean" + Logical connection of features. Default: "and" + Lower limit(s) of features. Default: 128.0 + Upper limit(s) of features. Default: 255.0 + Regions having features within the limits. + + + + Determine the minimum and maximum gray values within regions. + Instance represents: Regions, the features of which are to be calculated. + + Gray value image. + Percentage below (above) the absolute maximum (minimum). Default: 0 + "Minimum" gray value. + "Maximum" gray value. + Difference between Max and Min. + + + + Determine the minimum and maximum gray values within regions. + Instance represents: Regions, the features of which are to be calculated. + + Gray value image. + Percentage below (above) the absolute maximum (minimum). Default: 0 + "Minimum" gray value. + "Maximum" gray value. + Difference between Max and Min. + + + + Calculate the mean and deviation of gray values. + Instance represents: Regions in which the features are calculated. + + Gray value image. + Deviation of gray values within a region. + Mean gray value of a region. + + + + Calculate the mean and deviation of gray values. + Instance represents: Regions in which the features are calculated. + + Gray value image. + Deviation of gray values within a region. + Mean gray value of a region. + + + + Calculate the gray value distribution of a single channel image within a certain gray value range. + Instance represents: Region in which the histogram is to be calculated. + + Input image. + Minimum gray value. Default: 0 + Maximum gray value. Default: 255 + Number of bins. Default: 256 + Bin size. + Histogram to be calculated. + + + + Calculate the gray value distribution of a single channel image within a certain gray value range. + Instance represents: Region in which the histogram is to be calculated. + + Input image. + Minimum gray value. Default: 0 + Maximum gray value. Default: 255 + Number of bins. Default: 256 + Bin size. + Histogram to be calculated. + + + + Calculate the histogram of two-channel gray value images. + Instance represents: Region in which the histogram is to be calculated. + + Channel 1. + Channel 2. + Histogram to be calculated. + + + + Calculate the gray value distribution. + Instance represents: Region in which the histogram is to be calculated. + + Image the gray value distribution of which is to be calculated. + Quantization of the gray values. Default: 1.0 + Absolute frequencies of the gray values. + + + + Calculate the gray value distribution. + Instance represents: Region in which the histogram is to be calculated. + + Image the gray value distribution of which is to be calculated. + Quantization of the gray values. Default: 1.0 + Absolute frequencies of the gray values. + + + + Calculate the gray value distribution. + Instance represents: Region in which the histogram is to be calculated. + + Image the gray value distribution of which is to be calculated. + Frequencies, normalized to the area of the region. + Absolute frequencies of the gray values. + + + + Determine the entropy and anisotropy of images. + Instance represents: Regions where the features are to be determined. + + Gray value image. + Measure of the symmetry of gray value distribution. + Information content (entropy) of the gray values. + + + + Determine the entropy and anisotropy of images. + Instance represents: Regions where the features are to be determined. + + Gray value image. + Measure of the symmetry of gray value distribution. + Information content (entropy) of the gray values. + + + + Calculate a co-occurrence matrix and derive gray value features thereof. + Instance represents: Region to be examined. + + Corresponding gray values. + Number of gray values to be distinguished (2^LdGray@f$2^{LdGray}$). Default: 6 + Direction in which the matrix is to be calculated. Default: 0 + Correlation of gray values. + Local homogeneity of gray values. + Gray value contrast. + Gray value energy. + + + + Calculate a co-occurrence matrix and derive gray value features thereof. + Instance represents: Region to be examined. + + Corresponding gray values. + Number of gray values to be distinguished (2^LdGray@f$2^{LdGray}$). Default: 6 + Direction in which the matrix is to be calculated. Default: 0 + Correlation of gray values. + Local homogeneity of gray values. + Gray value contrast. + Gray value energy. + + + + Calculate the co-occurrence matrix of a region in an image. + Instance represents: Region to be checked. + + Image providing the gray values. + Number of gray values to be distinguished (2^LdGray@f$2^{LdGray}$). Default: 6 + Direction of neighbor relation. Default: 0 + Co-occurrence matrix (matrices). + + + + Calculate gray value moments and approximation by a plane. + Instance represents: Regions to be checked. + + Corresponding gray values. + Mixed moments along a line. + Mixed moments along a column. + Parameter Alpha of the approximating plane. + Parameter Beta of the approximating plane. + Mean gray value. + + + + Calculate gray value moments and approximation by a plane. + Instance represents: Regions to be checked. + + Corresponding gray values. + Mixed moments along a line. + Mixed moments along a column. + Parameter Alpha of the approximating plane. + Parameter Beta of the approximating plane. + Mean gray value. + + + + Calculate the deviation of the gray values from the approximating image plane. + Instance represents: Regions, of which the plane deviation is to be calculated. + + Gray value image. + Deviation of the gray values within a region. + + + + Compute the orientation and major axes of a region in a gray value image. + Instance represents: Region(s) to be examined. + + Gray value image. + Minor axis of the region. + Angle enclosed by the major axis and the x-axis. + Major axis of the region. + + + + Compute the orientation and major axes of a region in a gray value image. + Instance represents: Region(s) to be examined. + + Gray value image. + Minor axis of the region. + Angle enclosed by the major axis and the x-axis. + Major axis of the region. + + + + Compute the area and center of gravity of a region in a gray value image. + Instance represents: Region(s) to be examined. + + Gray value image. + Row coordinate of the gray value center of gravity. + Column coordinate of the gray value center of gravity. + Gray value volume of the region. + + + + Compute the area and center of gravity of a region in a gray value image. + Instance represents: Region(s) to be examined. + + Gray value image. + Row coordinate of the gray value center of gravity. + Column coordinate of the gray value center of gravity. + Gray value volume of the region. + + + + Calculate horizontal and vertical gray-value projections. + Instance represents: Region to be processed. + + Grayvalues for projections. + Method to compute the projections. Default: "simple" + Vertical projection. + Horizontal projection. + + + + Asynchronous grab of images and preprocessed image data from the specified image acquisition device. + Modified instance represents: Pre-processed image regions. + + Pre-processed XLD contours. + Handle of the acquisition device to be used. + Maximum tolerated delay between the start of the asynchronous grab and the delivery of the image [ms]. Default: -1.0 + Pre-processed control data. + Grabbed image data. + + + + Asynchronous grab of images and preprocessed image data from the specified image acquisition device. + Modified instance represents: Pre-processed image regions. + + Pre-processed XLD contours. + Handle of the acquisition device to be used. + Maximum tolerated delay between the start of the asynchronous grab and the delivery of the image [ms]. Default: -1.0 + Pre-processed control data. + Grabbed image data. + + + + Synchronous grab of images and preprocessed image data from the specified image acquisition device. + Modified instance represents: Preprocessed image regions. + + Preprocessed XLD contours. + Handle of the acquisition device to be used. + Preprocessed control data. + Grabbed image data. + + + + Synchronous grab of images and preprocessed image data from the specified image acquisition device. + Modified instance represents: Preprocessed image regions. + + Preprocessed XLD contours. + Handle of the acquisition device to be used. + Preprocessed control data. + Grabbed image data. + + + + Classify multiple characters with an CNN-based OCR classifier. + Instance represents: Characters to be recognized. + + Gray values of the characters. + Handle of the OCR classifier. + Confidence of the class of the characters. + Result of classifying the characters with the CNN. + + + + Classify multiple characters with an CNN-based OCR classifier. + Instance represents: Characters to be recognized. + + Gray values of the characters. + Handle of the OCR classifier. + Confidence of the class of the characters. + Result of classifying the characters with the CNN. + + + + Classify a single character with an CNN-based OCR classifier. + Instance represents: Character to be recognized. + + Gray values of the character. + Handle of the OCR classifier. + Number of best classes to determine. Default: 1 + Confidence(s) of the class(es) of the character. + Result of classifying the character with the CNN. + + + + Classify a single character with an CNN-based OCR classifier. + Instance represents: Character to be recognized. + + Gray values of the character. + Handle of the OCR classifier. + Number of best classes to determine. Default: 1 + Confidence(s) of the class(es) of the character. + Result of classifying the character with the CNN. + + + + Classify a related group of characters with an CNN-based OCR classifier. + Instance represents: Characters to be recognized. + + Gray values of the characters. + Handle of the OCR classifier. + Expression describing the allowed word structure. + Number of classes per character considered for the internal word correction. Default: 3 + Maximum number of corrected characters. Default: 2 + Confidence of the class of the characters. + Word text after classification and correction. + Measure of similarity between corrected word and uncorrected classification results. + Result of classifying the characters with the CNN. + + + + Classify a related group of characters with an CNN-based OCR classifier. + Instance represents: Characters to be recognized. + + Gray values of the characters. + Handle of the OCR classifier. + Expression describing the allowed word structure. + Number of classes per character considered for the internal word correction. Default: 3 + Maximum number of corrected characters. Default: 2 + Confidence of the class of the characters. + Word text after classification and correction. + Measure of similarity between corrected word and uncorrected classification results. + Result of classifying the characters with the CNN. + + + + Compute the width, height, and aspect ratio of the surrounding rectangle parallel to the coordinate axes. + Instance represents: Regions to be examined. + + Width of the surrounding rectangle of the region. + Aspect ratio of the surrounding rectangle of the region. + Height of the surrounding rectangle of the region. + + + + Compute the width, height, and aspect ratio of the surrounding rectangle parallel to the coordinate axes. + Instance represents: Regions to be examined. + + Width of the surrounding rectangle of the region. + Aspect ratio of the surrounding rectangle of the region. + Height of the surrounding rectangle of the region. + + + + Insert objects into an iconic object tuple. + Instance represents: Input object tuple. + + Object tuple to insert. + Index to insert objects. + Extended object tuple. + + + + Remove objects from an iconic object tuple. + Instance represents: Input object tuple. + + Indices of the objects to be removed. + Remaining object tuple. + + + + Remove objects from an iconic object tuple. + Instance represents: Input object tuple. + + Indices of the objects to be removed. + Remaining object tuple. + + + + Replaces one or more elements of an iconic object tuple. + Instance represents: Iconic Input Object. + + Element(s) to replace. + Index/Indices of elements to be replaced. + Tuple with replaced elements. + + + + Replaces one or more elements of an iconic object tuple. + Instance represents: Iconic Input Object. + + Element(s) to replace. + Index/Indices of elements to be replaced. + Tuple with replaced elements. + + + Returns the iconic object(s) at the specified index + + + The area of the region + + + The center row of the region + + + The center column of the region + + + Represents an instance of a sample identifier. + + + + Read a sample identifier from a file. + Modified instance represents: Handle of the sample identifier. + + File name. + + + + Create a new sample identifier. + Modified instance represents: Handle of the sample identifier. + + Parameter name. Default: [] + Parameter value. Default: [] + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + + Free the memory of a sample identifier. + Instance represents: Handle of the sample identifier. + + + + + Deserialize a serialized sample identifier. + Modified instance represents: Handle of the sample identifier. + + Handle of the serialized item. + + + + Read a sample identifier from a file. + Modified instance represents: Handle of the sample identifier. + + File name. + + + + Serialize a sample identifier. + Instance represents: Handle of the sample identifier. + + Handle of the serialized item. + + + + Write a sample identifier to a file. + Instance represents: Handle of the sample identifier. + + File name. + + + + Identify objects with a sample identifier. + Instance represents: Handle of the sample identifier. + + Image showing the object to be identified. + Number of suggested object indices. Default: 1 + Rating threshold. Default: 0.0 + Generic parameter name. Default: [] + Generic parameter value. Default: [] + Rating value of the identified object. + Index of the identified object. + + + + Identify objects with a sample identifier. + Instance represents: Handle of the sample identifier. + + Image showing the object to be identified. + Number of suggested object indices. Default: 1 + Rating threshold. Default: 0.0 + Generic parameter name. Default: [] + Generic parameter value. Default: [] + Rating value of the identified object. + Index of the identified object. + + + + Get selected parameters of a sample identifier. + Instance represents: Handle of the sample identifier. + + Parameter name. Default: "rating_method" + Parameter value. + + + + Set selected parameters of a sample identifier. + Instance represents: Handle of the sample identifier. + + Parameter name. Default: "rating_method" + Parameter value. Default: "score_single" + + + + Set selected parameters of a sample identifier. + Instance represents: Handle of the sample identifier. + + Parameter name. Default: "rating_method" + Parameter value. Default: "score_single" + + + + Retrieve information about an object of a sample identifier. + Instance represents: Handle of the sample identifier. + + Index of the object for which information is retrieved. + Define, for which kind of object information is retrieved. Default: "num_training_objects" + Information about the object. + + + + Retrieve information about an object of a sample identifier. + Instance represents: Handle of the sample identifier. + + Index of the object for which information is retrieved. + Define, for which kind of object information is retrieved. Default: "num_training_objects" + Information about the object. + + + + Define a name or a description for an object of a sample identifier. + Instance represents: Handle of the sample identifier. + + Index of the object for which information is set. + Define, for which kind of object information is set. Default: "training_object_name" + Information about the object. + + + + Define a name or a description for an object of a sample identifier. + Instance represents: Handle of the sample identifier. + + Index of the object for which information is set. + Define, for which kind of object information is set. Default: "training_object_name" + Information about the object. + + + + Remove training data from a sample identifier. + Instance represents: Handle of the sample identifier. + + Index of the training object, from which samples should be removed. + Index of the training sample that should be removed. + + + + Remove training data from a sample identifier. + Instance represents: Handle of the sample identifier. + + Index of the training object, from which samples should be removed. + Index of the training sample that should be removed. + + + + Remove preparation data from a sample identifier. + Instance represents: Handle of the sample identifier. + + Index of the preparation object, of which samples should be removed. + Index of the preparation sample that should be removed. + + + + Remove preparation data from a sample identifier. + Instance represents: Handle of the sample identifier. + + Index of the preparation object, of which samples should be removed. + Index of the preparation sample that should be removed. + + + + Train a sample identifier. + Instance represents: Handle of the sample identifier. + + Parameter name. Default: [] + Parameter value. Default: [] + + + + Add training data to an existing sample identifier. + Instance represents: Handle of the sample identifier. + + Image that shows an object. + Index of the object visible in the SampleImage. + Generic parameter name. Default: [] + Generic parameter value. Default: [] + Index of the object sample. + + + + Add training data to an existing sample identifier. + Instance represents: Handle of the sample identifier. + + Image that shows an object. + Index of the object visible in the SampleImage. + Generic parameter name. Default: [] + Generic parameter value. Default: [] + Index of the object sample. + + + + Adapt the internal data structure of a sample identifier to the objects to be identified. + Instance represents: Handle of the sample identifier. + + Indicates if the preparation data should be removed. Default: "true" + Generic parameter name. Default: [] + Generic parameter value. Default: [] + + + + Add preparation data to an existing sample identifier. + Instance represents: Handle of the sample identifier. + + Image that shows an object. + Index of the object visible in the SampleImage. Default: "unknown" + Generic parameter name. Default: [] + Generic parameter value. Default: [] + Index of the object sample. + + + + Add preparation data to an existing sample identifier. + Instance represents: Handle of the sample identifier. + + Image that shows an object. + Index of the object visible in the SampleImage. Default: "unknown" + Generic parameter name. Default: [] + Generic parameter value. Default: [] + Index of the object sample. + + + + Create a new sample identifier. + Modified instance represents: Handle of the sample identifier. + + Parameter name. Default: [] + Parameter value. Default: [] + + + Represents an instance of a scattered data interpolator. + + + + Creates an interpolator for the interpolation of scattered data. + Modified instance represents: Handle of the scattered data interpolator + + Method for the interpolation Default: "thin_plate_splines" + Row coordinates of the points used for the interpolation + Column coordinates of the points used for the interpolation + Values of the points used for the interpolation + Names of the generic parameters that can be adjusted Default: [] + Values of the generic parameters that can be adjusted Default: [] + + + Clear a scattered data interpolator. + Handle of the scattered data interpolator + + + + Clear a scattered data interpolator. + Instance represents: Handle of the scattered data interpolator + + + + + Interpolation of scattered data using a scattered data interpolator. + Instance represents: Handle of the scattered data interpolator + + Row coordinates of points to be interpolated + Column coordinates of points to be interpolated + Values of interpolated points + + + + Interpolation of scattered data using a scattered data interpolator. + Instance represents: Handle of the scattered data interpolator + + Row coordinates of points to be interpolated + Column coordinates of points to be interpolated + Values of interpolated points + + + + Creates an interpolator for the interpolation of scattered data. + Modified instance represents: Handle of the scattered data interpolator + + Method for the interpolation Default: "thin_plate_splines" + Row coordinates of the points used for the interpolation + Column coordinates of the points used for the interpolation + Values of the points used for the interpolation + Names of the generic parameters that can be adjusted Default: [] + Values of the generic parameters that can be adjusted Default: [] + + + Represents an instance of a 3D graphic scene. + + + + Create the data structure that is needed to visualize collections of 3D objects. + Modified instance represents: Handle of the 3D scene. + + + + + Get the depth or the index of instances in a displayed 3D scene. + Instance represents: Handle of the 3D scene. + + Window handle. + Row coordinates. + Column coordinates. + Information. Default: "depth" + Indices or the depth of the objects at (Row,Column). + + + + Get the depth or the index of instances in a displayed 3D scene. + Instance represents: Handle of the 3D scene. + + Window handle. + Row coordinates. + Column coordinates. + Information. Default: "depth" + Indices or the depth of the objects at (Row,Column). + + + + Set the pose of a 3D scene. + Instance represents: Handle of the 3D scene. + + New pose of the 3D scene. + + + + Set parameters of a 3D scene. + Instance represents: Handle of the 3D scene. + + Names of the generic parameters. Default: "quality" + Values of the generic parameters. Default: "high" + + + + Set parameters of a 3D scene. + Instance represents: Handle of the 3D scene. + + Names of the generic parameters. Default: "quality" + Values of the generic parameters. Default: "high" + + + + Set parameters of a light in a 3D scene. + Instance represents: Handle of the 3D scene. + + Index of the light source. + Names of the generic parameters. Default: "ambient" + Values of the generic parameters. Default: [0.2,0.2,0.2] + + + + Set parameters of a light in a 3D scene. + Instance represents: Handle of the 3D scene. + + Index of the light source. + Names of the generic parameters. Default: "ambient" + Values of the generic parameters. Default: [0.2,0.2,0.2] + + + + Set the pose of an instance in a 3D scene. + Instance represents: Handle of the 3D scene. + + Index of the instance. + New pose of the instance. + + + + Set the pose of an instance in a 3D scene. + Instance represents: Handle of the 3D scene. + + Index of the instance. + New pose of the instance. + + + + Set parameters of an instance in a 3D scene. + Instance represents: Handle of the 3D scene. + + Index of the instance. + Names of the generic parameters. Default: "color" + Values of the generic parameters. Default: "green" + + + + Set parameters of an instance in a 3D scene. + Instance represents: Handle of the 3D scene. + + Index of the instance. + Names of the generic parameters. Default: "color" + Values of the generic parameters. Default: "green" + + + + Set the pose of a camera in a 3D scene. + Instance represents: Handle of the 3D scene. + + Index of the camera. + New pose of the camera. + + + + Render an image of a 3D scene. + Instance represents: Handle of the 3D scene. + + Index of the camera used to display the scene. + Rendered 3D scene. + + + + Remove a light from a 3D scene. + Instance represents: Handle of the 3D scene. + + Light to remove. + + + + Remove an object instance from a 3D scene. + Instance represents: Handle of the 3D scene. + + Index of the instance to remove. + + + + Remove an object instance from a 3D scene. + Instance represents: Handle of the 3D scene. + + Index of the instance to remove. + + + + Remove a camera from a 3D scene. + Instance represents: Handle of the 3D scene. + + Index of the camera to remove. + + + + Display a 3D scene. + Instance represents: Handle of the 3D scene. + + Window handle. + Index of the camera used to display the scene. + + + + Display a 3D scene. + Instance represents: Handle of the 3D scene. + + Window handle. + Index of the camera used to display the scene. + + + + Add a light source to a 3D scene. + Instance represents: Handle of the 3D scene. + + Position of the new light source. Default: [-100.0,-100.0,0.0] + Type of the new light source. Default: "point_light" + Index of the new light source in the 3D scene. + + + + Add an instance of a 3D object model to a 3D scene. + Instance represents: Handle of the 3D scene. + + Handle of the 3D object model. + Pose of the 3D object model. + Index of the new instance in the 3D scene. + + + + Add an instance of a 3D object model to a 3D scene. + Instance represents: Handle of the 3D scene. + + Handle of the 3D object model. + Pose of the 3D object model. + Index of the new instance in the 3D scene. + + + + Add a camera to a 3D scene. + Instance represents: Handle of the 3D scene. + + Parameters of the new camera. + Index of the new camera in the 3D scene. + + + Delete a 3D scene and free all allocated memory. + Handle of the 3D scene. + + + + Delete a 3D scene and free all allocated memory. + Instance represents: Handle of the 3D scene. + + + + + Create the data structure that is needed to visualize collections of 3D objects. + Modified instance represents: Handle of the 3D scene. + + + + + Add a text label to a 3D scene. + Instance represents: Handle of the 3D scene. + + Text of the label. Default: "label" + Point of reference of the label. + Position of the label. Default: "top" + Indicates fixed or relative positioning. Default: "point" + Index of the new label in the 3D scene. + + + + Add a text label to a 3D scene. + Instance represents: Handle of the 3D scene. + + Text of the label. Default: "label" + Point of reference of the label. + Position of the label. Default: "top" + Indicates fixed or relative positioning. Default: "point" + Index of the new label in the 3D scene. + + + + Remove a text label from a 3D scene. + Instance represents: Handle of the 3D scene. + + Index of the text label to remove. + + + + Remove a text label from a 3D scene. + Instance represents: Handle of the 3D scene. + + Index of the text label to remove. + + + + Set parameters of a text label in a 3D scene. + Instance represents: Handle of the 3D scene. + + Index of the text label. + Names of the generic parameters. Default: "color" + Values of the generic parameters. Default: "red" + + + + Set parameters of a text label in a 3D scene. + Instance represents: Handle of the 3D scene. + + Index of the text label. + Names of the generic parameters. Default: "color" + Values of the generic parameters. Default: "red" + + + Represents an instance of a connection via a serial port. + + + + Open a serial device. + Modified instance represents: Serial interface handle. + + Name of the serial port. Default: "COM1" + + + + Clear the buffer of a serial connection. + Instance represents: Serial interface handle. + + Buffer to be cleared. Default: "input" + + + + Write to a serial connection. + Instance represents: Serial interface handle. + + Characters to write (as tuple of integers). + + + + Write to a serial connection. + Instance represents: Serial interface handle. + + Characters to write (as tuple of integers). + + + + Read from a serial device. + Instance represents: Serial interface handle. + + Number of characters to read. Default: 1 + Read characters (as tuple of integers). + + + + Get the parameters of a serial device. + Instance represents: Serial interface handle. + + Number of data bits of the serial interface. + Type of flow control of the serial interface. + Parity of the serial interface. + Number of stop bits of the serial interface. + Total timeout of the serial interface in ms. + Inter-character timeout of the serial interface in ms. + Speed of the serial interface. + + + + Set the parameters of a serial device. + Instance represents: Serial interface handle. + + Speed of the serial interface. Default: "unchanged" + Number of data bits of the serial interface. Default: "unchanged" + Type of flow control of the serial interface. Default: "unchanged" + Parity of the serial interface. Default: "unchanged" + Number of stop bits of the serial interface. Default: "unchanged" + Total timeout of the serial interface in ms. Default: "unchanged" + Inter-character timeout of the serial interface in ms. Default: "unchanged" + + + + Set the parameters of a serial device. + Instance represents: Serial interface handle. + + Speed of the serial interface. Default: "unchanged" + Number of data bits of the serial interface. Default: "unchanged" + Type of flow control of the serial interface. Default: "unchanged" + Parity of the serial interface. Default: "unchanged" + Number of stop bits of the serial interface. Default: "unchanged" + Total timeout of the serial interface in ms. Default: "unchanged" + Inter-character timeout of the serial interface in ms. Default: "unchanged" + + + + Close a serial device. + Instance represents: Serial interface handle. + + + + + Open a serial device. + Modified instance represents: Serial interface handle. + + Name of the serial port. Default: "COM1" + + + Represents an instance of a serializied item. + + + + Create a serialized item. + Modified instance represents: Handle of the serialized item. + + Data pointer of the serialized item. + Size of the serialized item. + Copy mode of the serialized item. Default: "true" + + + Creates a new serialized item with data given in byte array + The array needs to be kept alive until block is disposed! + + + Copies a serialized item into a new byte array + + + + Receive a serialized item over a socket connection. + Modified instance represents: Handle of the serialized item. + + Socket number. + + + + Send a serialized item over a socket connection. + Instance represents: Handle of the serialized item. + + Socket number. + + + + Write a serialized item to a file. + Instance represents: Handle of the serialized item. + + File handle. + + + + Read a serialized item from a file. + Modified instance represents: Handle of the serialized item. + + File handle. + + + Delete a serialized item. + Handle of the serialized item. + + + + Delete a serialized item. + Instance represents: Handle of the serialized item. + + + + + Access the data pointer of a serialized item. + Instance represents: Handle of the serialized item. + + Size of the serialized item. + Data pointer of the serialized item. + + + + Create a serialized item. + Modified instance represents: Handle of the serialized item. + + Data pointer of the serialized item. + Size of the serialized item. + Copy mode of the serialized item. Default: "true" + + + Represents an instance of a shape model for matching. + + + + Read a shape model from a file. + Modified instance represents: Handle of the model. + + File name. + + + + Prepare an anisotropically scaled shape model for matching from XLD contours. + Modified instance represents: Handle of the model. + + Input contours that will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in the row direction. Default: 0.9 + Maximum scale of the pattern in the row direction. Default: 1.1 + Scale step length (resolution) in the row direction. Default: "auto" + Minimum scale of the pattern in the column direction. Default: 0.9 + Maximum scale of the pattern in the column direction. Default: 1.1 + Scale step length (resolution) in the column direction. Default: "auto" + Kind of optimization and optionally method used for generating the model. Default: "auto" + Match metric. Default: "ignore_local_polarity" + Minimum contrast of the objects in the search images. Default: 5 + + + + Prepare an anisotropically scaled shape model for matching from XLD contours. + Modified instance represents: Handle of the model. + + Input contours that will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in the row direction. Default: 0.9 + Maximum scale of the pattern in the row direction. Default: 1.1 + Scale step length (resolution) in the row direction. Default: "auto" + Minimum scale of the pattern in the column direction. Default: 0.9 + Maximum scale of the pattern in the column direction. Default: 1.1 + Scale step length (resolution) in the column direction. Default: "auto" + Kind of optimization and optionally method used for generating the model. Default: "auto" + Match metric. Default: "ignore_local_polarity" + Minimum contrast of the objects in the search images. Default: 5 + + + + Prepare an isotropically scaled shape model for matching from XLD contours. + Modified instance represents: Handle of the model. + + Input contours that will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern. Default: 0.9 + Maximum scale of the pattern. Default: 1.1 + Scale step length (resolution). Default: "auto" + Kind of optimization and optionally method used for generating the model. Default: "auto" + Match metric. Default: "ignore_local_polarity" + Minimum contrast of the objects in the search images. Default: 5 + + + + Prepare an isotropically scaled shape model for matching from XLD contours. + Modified instance represents: Handle of the model. + + Input contours that will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern. Default: 0.9 + Maximum scale of the pattern. Default: 1.1 + Scale step length (resolution). Default: "auto" + Kind of optimization and optionally method used for generating the model. Default: "auto" + Match metric. Default: "ignore_local_polarity" + Minimum contrast of the objects in the search images. Default: 5 + + + + Prepare a shape model for matching from XLD contours. + Modified instance represents: Handle of the model. + + Input contours that will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Kind of optimization and optionally method used for generating the model. Default: "auto" + Match metric. Default: "ignore_local_polarity" + Minimum contrast of the objects in the search images. Default: 5 + + + + Prepare a shape model for matching from XLD contours. + Modified instance represents: Handle of the model. + + Input contours that will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Kind of optimization and optionally method used for generating the model. Default: "auto" + Match metric. Default: "ignore_local_polarity" + Minimum contrast of the objects in the search images. Default: 5 + + + + Prepare an anisotropically scaled shape model for matching. + Modified instance represents: Handle of the model. + + Input image whose domain will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in the row direction. Default: 0.9 + Maximum scale of the pattern in the row direction. Default: 1.1 + Scale step length (resolution) in the row direction. Default: "auto" + Minimum scale of the pattern in the column direction. Default: 0.9 + Maximum scale of the pattern in the column direction. Default: 1.1 + Scale step length (resolution) in the column direction. Default: "auto" + Kind of optimization and optionally method used for generating the model. Default: "auto" + Match metric. Default: "use_polarity" + Threshold or hysteresis thresholds for the contrast of the object in the template image and optionally minimum size of the object parts. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + + + + Prepare an anisotropically scaled shape model for matching. + Modified instance represents: Handle of the model. + + Input image whose domain will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in the row direction. Default: 0.9 + Maximum scale of the pattern in the row direction. Default: 1.1 + Scale step length (resolution) in the row direction. Default: "auto" + Minimum scale of the pattern in the column direction. Default: 0.9 + Maximum scale of the pattern in the column direction. Default: 1.1 + Scale step length (resolution) in the column direction. Default: "auto" + Kind of optimization and optionally method used for generating the model. Default: "auto" + Match metric. Default: "use_polarity" + Threshold or hysteresis thresholds for the contrast of the object in the template image and optionally minimum size of the object parts. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + + + + Prepare an isotropically scaled shape model for matching. + Modified instance represents: Handle of the model. + + Input image whose domain will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern. Default: 0.9 + Maximum scale of the pattern. Default: 1.1 + Scale step length (resolution). Default: "auto" + Kind of optimization and optionally method used for generating the model. Default: "auto" + Match metric. Default: "use_polarity" + Threshold or hysteresis thresholds for the contrast of the object in the template image and optionally minimum size of the object parts. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + + + + Prepare an isotropically scaled shape model for matching. + Modified instance represents: Handle of the model. + + Input image whose domain will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern. Default: 0.9 + Maximum scale of the pattern. Default: 1.1 + Scale step length (resolution). Default: "auto" + Kind of optimization and optionally method used for generating the model. Default: "auto" + Match metric. Default: "use_polarity" + Threshold or hysteresis thresholds for the contrast of the object in the template image and optionally minimum size of the object parts. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + + + + Prepare a shape model for matching. + Modified instance represents: Handle of the model. + + Input image whose domain will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Kind of optimization and optionally method used for generating the model. Default: "auto" + Match metric. Default: "use_polarity" + Threshold or hysteresis thresholds for the contrast of the object in the template image and optionally minimum size of the object parts. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + + + + Prepare a shape model for matching. + Modified instance represents: Handle of the model. + + Input image whose domain will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Kind of optimization and optionally method used for generating the model. Default: "auto" + Match metric. Default: "use_polarity" + Threshold or hysteresis thresholds for the contrast of the object in the template image and optionally minimum size of the object parts. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + + Deserialize a serialized shape model. + Modified instance represents: Handle of the model. + + Handle of the serialized item. + + + + Read a shape model from a file. + Modified instance represents: Handle of the model. + + File name. + + + + Serialize a shape model. + Instance represents: Handle of the model. + + Handle of the serialized item. + + + + Write a shape model to a file. + Instance represents: Handle of the model. + + File name. + + + + Free the memory of a shape model. + Instance represents: Handle of the model. + + + + + Return the contour representation of a shape model. + Instance represents: Handle of the model. + + Pyramid level for which the contour representation should be returned. Default: 1 + Contour representation of the shape model. + + + + Return the parameters of a shape model. + Instance represents: Handle of the model. + + Smallest rotation of the pattern. + Extent of the rotation angles. + Step length of the angles (resolution). + Minimum scale of the pattern. + Maximum scale of the pattern. + Scale step length (resolution). + Match metric. + Minimum contrast of the objects in the search images. + Number of pyramid levels. + + + + Return the parameters of a shape model. + Instance represents: Handle of the model. + + Smallest rotation of the pattern. + Extent of the rotation angles. + Step length of the angles (resolution). + Minimum scale of the pattern. + Maximum scale of the pattern. + Scale step length (resolution). + Match metric. + Minimum contrast of the objects in the search images. + Number of pyramid levels. + + + + Return the origin (reference point) of a shape model. + Instance represents: Handle of the model. + + Row coordinate of the origin of the shape model. + Column coordinate of the origin of the shape model. + + + + Set the origin (reference point) of a shape model. + Instance represents: Handle of the model. + + Row coordinate of the origin of the shape model. + Column coordinate of the origin of the shape model. + + + Find the best matches of multiple anisotropically scaled shape models. + Input image in which the models should be found. + Handle of the models. + Smallest rotation of the models. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Minimum scale of the models in the row direction. Default: 0.9 + Maximum scale of the models in the row direction. Default: 1.1 + Minimum scale of the models in the column direction. Default: 0.9 + Maximum scale of the models in the column direction. Default: 1.1 + Minimum score of the instances of the models to be found. Default: 0.5 + Number of instances of the models to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the models to be found. Default: 0.5 + Subpixel accuracy if not equal to 'none'. Default: "least_squares" + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + Row coordinate of the found instances of the models. + Column coordinate of the found instances of the models. + Rotation angle of the found instances of the models. + Scale of the found instances of the models in the row direction. + Scale of the found instances of the models in the column direction. + Score of the found instances of the models. + Index of the found instances of the models. + + + + Find the best matches of multiple anisotropically scaled shape models. + Instance represents: Handle of the models. + + Input image in which the models should be found. + Smallest rotation of the models. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Minimum scale of the models in the row direction. Default: 0.9 + Maximum scale of the models in the row direction. Default: 1.1 + Minimum scale of the models in the column direction. Default: 0.9 + Maximum scale of the models in the column direction. Default: 1.1 + Minimum score of the instances of the models to be found. Default: 0.5 + Number of instances of the models to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the models to be found. Default: 0.5 + Subpixel accuracy if not equal to 'none'. Default: "least_squares" + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + Row coordinate of the found instances of the models. + Column coordinate of the found instances of the models. + Rotation angle of the found instances of the models. + Scale of the found instances of the models in the row direction. + Scale of the found instances of the models in the column direction. + Score of the found instances of the models. + Index of the found instances of the models. + + + Find the best matches of multiple isotropically scaled shape models. + Input image in which the models should be found. + Handle of the models. + Smallest rotation of the models. Default: -0.39 + Extent of the rotation angles. Default: 0.78 + Minimum scale of the models. Default: 0.9 + Maximum scale of the models. Default: 1.1 + Minimum score of the instances of the models to be found. Default: 0.5 + Number of instances of the models to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the models to be found. Default: 0.5 + Subpixel accuracy if not equal to 'none'. Default: "least_squares" + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + Row coordinate of the found instances of the models. + Column coordinate of the found instances of the models. + Rotation angle of the found instances of the models. + Scale of the found instances of the models. + Score of the found instances of the models. + Index of the found instances of the models. + + + + Find the best matches of multiple isotropically scaled shape models. + Instance represents: Handle of the models. + + Input image in which the models should be found. + Smallest rotation of the models. Default: -0.39 + Extent of the rotation angles. Default: 0.78 + Minimum scale of the models. Default: 0.9 + Maximum scale of the models. Default: 1.1 + Minimum score of the instances of the models to be found. Default: 0.5 + Number of instances of the models to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the models to be found. Default: 0.5 + Subpixel accuracy if not equal to 'none'. Default: "least_squares" + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + Row coordinate of the found instances of the models. + Column coordinate of the found instances of the models. + Rotation angle of the found instances of the models. + Scale of the found instances of the models. + Score of the found instances of the models. + Index of the found instances of the models. + + + Find the best matches of multiple shape models. + Input image in which the models should be found. + Handle of the models. + Smallest rotation of the models. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Minimum score of the instances of the models to be found. Default: 0.5 + Number of instances of the models to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the models to be found. Default: 0.5 + Subpixel accuracy if not equal to 'none'. Default: "least_squares" + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + Row coordinate of the found instances of the models. + Column coordinate of the found instances of the models. + Rotation angle of the found instances of the models. + Score of the found instances of the models. + Index of the found instances of the models. + + + + Find the best matches of multiple shape models. + Instance represents: Handle of the models. + + Input image in which the models should be found. + Smallest rotation of the models. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Minimum score of the instances of the models to be found. Default: 0.5 + Number of instances of the models to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the models to be found. Default: 0.5 + Subpixel accuracy if not equal to 'none'. Default: "least_squares" + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + Row coordinate of the found instances of the models. + Column coordinate of the found instances of the models. + Rotation angle of the found instances of the models. + Score of the found instances of the models. + Index of the found instances of the models. + + + + Find the best matches of an anisotropically scaled shape model in an image. + Instance represents: Handle of the model. + + Input image in which the model should be found. + Smallest rotation of the model. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Minimum scale of the model in the row direction. Default: 0.9 + Maximum scale of the model in the row direction. Default: 1.1 + Minimum scale of the model in the column direction. Default: 0.9 + Maximum scale of the model in the column direction. Default: 1.1 + Minimum score of the instances of the model to be found. Default: 0.5 + Number of instances of the model to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the model to be found. Default: 0.5 + Subpixel accuracy if not equal to 'none'. Default: "least_squares" + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + Row coordinate of the found instances of the model. + Column coordinate of the found instances of the model. + Rotation angle of the found instances of the model. + Scale of the found instances of the model in the row direction. + Scale of the found instances of the model in the column direction. + Score of the found instances of the model. + + + + Find the best matches of an anisotropically scaled shape model in an image. + Instance represents: Handle of the model. + + Input image in which the model should be found. + Smallest rotation of the model. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Minimum scale of the model in the row direction. Default: 0.9 + Maximum scale of the model in the row direction. Default: 1.1 + Minimum scale of the model in the column direction. Default: 0.9 + Maximum scale of the model in the column direction. Default: 1.1 + Minimum score of the instances of the model to be found. Default: 0.5 + Number of instances of the model to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the model to be found. Default: 0.5 + Subpixel accuracy if not equal to 'none'. Default: "least_squares" + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + Row coordinate of the found instances of the model. + Column coordinate of the found instances of the model. + Rotation angle of the found instances of the model. + Scale of the found instances of the model in the row direction. + Scale of the found instances of the model in the column direction. + Score of the found instances of the model. + + + + Find the best matches of an isotropically scaled shape model in an image. + Instance represents: Handle of the model. + + Input image in which the model should be found. + Smallest rotation of the model. Default: -0.39 + Extent of the rotation angles. Default: 0.78 + Minimum scale of the model. Default: 0.9 + Maximum scale of the model. Default: 1.1 + Minimum score of the instances of the model to be found. Default: 0.5 + Number of instances of the model to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the model to be found. Default: 0.5 + Subpixel accuracy if not equal to 'none'. Default: "least_squares" + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + Row coordinate of the found instances of the model. + Column coordinate of the found instances of the model. + Rotation angle of the found instances of the model. + Scale of the found instances of the model. + Score of the found instances of the model. + + + + Find the best matches of an isotropically scaled shape model in an image. + Instance represents: Handle of the model. + + Input image in which the model should be found. + Smallest rotation of the model. Default: -0.39 + Extent of the rotation angles. Default: 0.78 + Minimum scale of the model. Default: 0.9 + Maximum scale of the model. Default: 1.1 + Minimum score of the instances of the model to be found. Default: 0.5 + Number of instances of the model to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the model to be found. Default: 0.5 + Subpixel accuracy if not equal to 'none'. Default: "least_squares" + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + Row coordinate of the found instances of the model. + Column coordinate of the found instances of the model. + Rotation angle of the found instances of the model. + Scale of the found instances of the model. + Score of the found instances of the model. + + + + Find the best matches of a shape model in an image. + Instance represents: Handle of the model. + + Input image in which the model should be found. + Smallest rotation of the model. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Minimum score of the instances of the model to be found. Default: 0.5 + Number of instances of the model to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the model to be found. Default: 0.5 + Subpixel accuracy if not equal to 'none'. Default: "least_squares" + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + Row coordinate of the found instances of the model. + Column coordinate of the found instances of the model. + Rotation angle of the found instances of the model. + Score of the found instances of the model. + + + + Find the best matches of a shape model in an image. + Instance represents: Handle of the model. + + Input image in which the model should be found. + Smallest rotation of the model. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Minimum score of the instances of the model to be found. Default: 0.5 + Number of instances of the model to be found (or 0 for all matches). Default: 1 + Maximum overlap of the instances of the model to be found. Default: 0.5 + Subpixel accuracy if not equal to 'none'. Default: "least_squares" + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + Row coordinate of the found instances of the model. + Column coordinate of the found instances of the model. + Rotation angle of the found instances of the model. + Score of the found instances of the model. + + + + Set the metric of a shape model that was created from XLD contours. + Instance represents: Handle of the model. + + Input image used for the determination of the polarity. + Transformation matrix. + Match metric. Default: "use_polarity" + + + + Set selected parameters of the shape model. + Instance represents: Handle of the model. + + Parameter names. + Parameter values. + + + + Prepare an anisotropically scaled shape model for matching from XLD contours. + Modified instance represents: Handle of the model. + + Input contours that will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in the row direction. Default: 0.9 + Maximum scale of the pattern in the row direction. Default: 1.1 + Scale step length (resolution) in the row direction. Default: "auto" + Minimum scale of the pattern in the column direction. Default: 0.9 + Maximum scale of the pattern in the column direction. Default: 1.1 + Scale step length (resolution) in the column direction. Default: "auto" + Kind of optimization and optionally method used for generating the model. Default: "auto" + Match metric. Default: "ignore_local_polarity" + Minimum contrast of the objects in the search images. Default: 5 + + + + Prepare an anisotropically scaled shape model for matching from XLD contours. + Modified instance represents: Handle of the model. + + Input contours that will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in the row direction. Default: 0.9 + Maximum scale of the pattern in the row direction. Default: 1.1 + Scale step length (resolution) in the row direction. Default: "auto" + Minimum scale of the pattern in the column direction. Default: 0.9 + Maximum scale of the pattern in the column direction. Default: 1.1 + Scale step length (resolution) in the column direction. Default: "auto" + Kind of optimization and optionally method used for generating the model. Default: "auto" + Match metric. Default: "ignore_local_polarity" + Minimum contrast of the objects in the search images. Default: 5 + + + + Prepare an isotropically scaled shape model for matching from XLD contours. + Modified instance represents: Handle of the model. + + Input contours that will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern. Default: 0.9 + Maximum scale of the pattern. Default: 1.1 + Scale step length (resolution). Default: "auto" + Kind of optimization and optionally method used for generating the model. Default: "auto" + Match metric. Default: "ignore_local_polarity" + Minimum contrast of the objects in the search images. Default: 5 + + + + Prepare an isotropically scaled shape model for matching from XLD contours. + Modified instance represents: Handle of the model. + + Input contours that will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern. Default: 0.9 + Maximum scale of the pattern. Default: 1.1 + Scale step length (resolution). Default: "auto" + Kind of optimization and optionally method used for generating the model. Default: "auto" + Match metric. Default: "ignore_local_polarity" + Minimum contrast of the objects in the search images. Default: 5 + + + + Prepare a shape model for matching from XLD contours. + Modified instance represents: Handle of the model. + + Input contours that will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Kind of optimization and optionally method used for generating the model. Default: "auto" + Match metric. Default: "ignore_local_polarity" + Minimum contrast of the objects in the search images. Default: 5 + + + + Prepare a shape model for matching from XLD contours. + Modified instance represents: Handle of the model. + + Input contours that will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Kind of optimization and optionally method used for generating the model. Default: "auto" + Match metric. Default: "ignore_local_polarity" + Minimum contrast of the objects in the search images. Default: 5 + + + + Prepare an anisotropically scaled shape model for matching. + Modified instance represents: Handle of the model. + + Input image whose domain will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in the row direction. Default: 0.9 + Maximum scale of the pattern in the row direction. Default: 1.1 + Scale step length (resolution) in the row direction. Default: "auto" + Minimum scale of the pattern in the column direction. Default: 0.9 + Maximum scale of the pattern in the column direction. Default: 1.1 + Scale step length (resolution) in the column direction. Default: "auto" + Kind of optimization and optionally method used for generating the model. Default: "auto" + Match metric. Default: "use_polarity" + Threshold or hysteresis thresholds for the contrast of the object in the template image and optionally minimum size of the object parts. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + + + + Prepare an anisotropically scaled shape model for matching. + Modified instance represents: Handle of the model. + + Input image whose domain will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in the row direction. Default: 0.9 + Maximum scale of the pattern in the row direction. Default: 1.1 + Scale step length (resolution) in the row direction. Default: "auto" + Minimum scale of the pattern in the column direction. Default: 0.9 + Maximum scale of the pattern in the column direction. Default: 1.1 + Scale step length (resolution) in the column direction. Default: "auto" + Kind of optimization and optionally method used for generating the model. Default: "auto" + Match metric. Default: "use_polarity" + Threshold or hysteresis thresholds for the contrast of the object in the template image and optionally minimum size of the object parts. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + + + + Prepare an isotropically scaled shape model for matching. + Modified instance represents: Handle of the model. + + Input image whose domain will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern. Default: 0.9 + Maximum scale of the pattern. Default: 1.1 + Scale step length (resolution). Default: "auto" + Kind of optimization and optionally method used for generating the model. Default: "auto" + Match metric. Default: "use_polarity" + Threshold or hysteresis thresholds for the contrast of the object in the template image and optionally minimum size of the object parts. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + + + + Prepare an isotropically scaled shape model for matching. + Modified instance represents: Handle of the model. + + Input image whose domain will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern. Default: 0.9 + Maximum scale of the pattern. Default: 1.1 + Scale step length (resolution). Default: "auto" + Kind of optimization and optionally method used for generating the model. Default: "auto" + Match metric. Default: "use_polarity" + Threshold or hysteresis thresholds for the contrast of the object in the template image and optionally minimum size of the object parts. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + + + + Prepare a shape model for matching. + Modified instance represents: Handle of the model. + + Input image whose domain will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Kind of optimization and optionally method used for generating the model. Default: "auto" + Match metric. Default: "use_polarity" + Threshold or hysteresis thresholds for the contrast of the object in the template image and optionally minimum size of the object parts. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + + + + Prepare a shape model for matching. + Modified instance represents: Handle of the model. + + Input image whose domain will be used to create the model. + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Kind of optimization and optionally method used for generating the model. Default: "auto" + Match metric. Default: "use_polarity" + Threshold or hysteresis thresholds for the contrast of the object in the template image and optionally minimum size of the object parts. Default: "auto" + Minimum contrast of the objects in the search images. Default: "auto" + + + + Get the clutter parameters of a shape model. + Instance represents: Handle of the model. + + Parameter names. Default: "use_clutter" + Parameter values. + Transformation matrix. + Minimum contrast of clutter in the search images. + Region where no clutter should occur. + + + + Get the clutter parameters of a shape model. + Instance represents: Handle of the model. + + Parameter names. Default: "use_clutter" + Parameter values. + Transformation matrix. + Minimum contrast of clutter in the search images. + Region where no clutter should occur. + + + + Set the clutter parameters of a shape model. + Instance represents: Handle of the model. + + Region where no clutter should occur. + Transformation matrix. + Minimum contrast of clutter in the search images. Default: 128 + Parameter names. + Parameter values. + + + + Set the clutter parameters of a shape model. + Instance represents: Handle of the model. + + Region where no clutter should occur. + Transformation matrix. + Minimum contrast of clutter in the search images. Default: 128 + Parameter names. + Parameter values. + + + Represents an instance of a 3D shape model for 3D matching. + + + + Read a 3D shape model from a file. + Modified instance represents: Handle of the 3D shape model. + + File name. + + + + Prepare a 3D object model for matching. + Modified instance represents: Handle of the 3D shape model. + + Handle of the 3D object model. + Internal camera parameters. + Reference orientation: Rotation around x-axis or x component of the Rodriguez vector (in radians or without unit). Default: 0 + Reference orientation: Rotation around y-axis or y component of the Rodriguez vector (in radians or without unit). Default: 0 + Reference orientation: Rotation around z-axis or z component of the Rodriguez vector (in radians or without unit). Default: 0 + Meaning of the rotation values of the reference orientation. Default: "gba" + Minimum longitude of the model views. Default: -0.35 + Maximum longitude of the model views. Default: 0.35 + Minimum latitude of the model views. Default: -0.35 + Maximum latitude of the model views. Default: 0.35 + Minimum camera roll angle of the model views. Default: -3.1416 + Maximum camera roll angle of the model views. Default: 3.1416 + Minimum camera-object-distance of the model views. Default: 0.3 + Maximum camera-object-distance of the model views. Default: 0.4 + Minimum contrast of the objects in the search images. Default: 10 + Names of (optional) parameters for controlling the behavior of the operator. Default: [] + Values of the optional generic parameters. Default: [] + + + + Prepare a 3D object model for matching. + Modified instance represents: Handle of the 3D shape model. + + Handle of the 3D object model. + Internal camera parameters. + Reference orientation: Rotation around x-axis or x component of the Rodriguez vector (in radians or without unit). Default: 0 + Reference orientation: Rotation around y-axis or y component of the Rodriguez vector (in radians or without unit). Default: 0 + Reference orientation: Rotation around z-axis or z component of the Rodriguez vector (in radians or without unit). Default: 0 + Meaning of the rotation values of the reference orientation. Default: "gba" + Minimum longitude of the model views. Default: -0.35 + Maximum longitude of the model views. Default: 0.35 + Minimum latitude of the model views. Default: -0.35 + Maximum latitude of the model views. Default: 0.35 + Minimum camera roll angle of the model views. Default: -3.1416 + Maximum camera roll angle of the model views. Default: 3.1416 + Minimum camera-object-distance of the model views. Default: 0.3 + Maximum camera-object-distance of the model views. Default: 0.4 + Minimum contrast of the objects in the search images. Default: 10 + Names of (optional) parameters for controlling the behavior of the operator. Default: [] + Values of the optional generic parameters. Default: [] + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + Free the memory of a 3D shape model. + Handle of the 3D shape model. + + + + Free the memory of a 3D shape model. + Instance represents: Handle of the 3D shape model. + + + + + Deserialize a serialized 3D shape model. + Modified instance represents: Handle of the 3D shape model. + + Handle of the serialized item. + + + + Serialize a 3D shape model. + Instance represents: Handle of the 3D shape model. + + Handle of the serialized item. + + + + Read a 3D shape model from a file. + Modified instance represents: Handle of the 3D shape model. + + File name. + + + + Write a 3D shape model to a file. + Instance represents: Handle of the 3D shape model. + + File name. + + + + Transform a pose that refers to the coordinate system of a 3D object model to a pose that refers to the reference coordinate system of a 3D shape model and vice versa. + Instance represents: Handle of the 3D shape model. + + Pose to be transformed in the source system. + Direction of the transformation. Default: "ref_to_model" + Transformed 3D pose in the target system. + + + + Project the edges of a 3D shape model into image coordinates. + Instance represents: Handle of the 3D shape model. + + Internal camera parameters. + 3D pose of the 3D shape model in the world coordinate system. + Remove hidden surfaces? Default: "true" + Smallest face angle for which the edge is displayed Default: 0.523599 + Contour representation of the model view. + + + + Project the edges of a 3D shape model into image coordinates. + Instance represents: Handle of the 3D shape model. + + Internal camera parameters. + 3D pose of the 3D shape model in the world coordinate system. + Remove hidden surfaces? Default: "true" + Smallest face angle for which the edge is displayed Default: 0.523599 + Contour representation of the model view. + + + + Return the contour representation of a 3D shape model view. + Instance represents: Handle of the 3D shape model. + + Pyramid level for which the contour representation should be returned. Default: 1 + View for which the contour representation should be returned. Default: 1 + 3D pose of the 3D shape model at the current view. + Contour representation of the model view. + + + + Return the parameters of a 3D shape model. + Instance represents: Handle of the 3D shape model. + + Names of the generic parameters that are to be queried for the 3D shape model. Default: "num_levels_max" + Values of the generic parameters. + + + + Return the parameters of a 3D shape model. + Instance represents: Handle of the 3D shape model. + + Names of the generic parameters that are to be queried for the 3D shape model. Default: "num_levels_max" + Values of the generic parameters. + + + + Find the best matches of a 3D shape model in an image. + Instance represents: Handle of the 3D shape model. + + Input image in which the model should be found. + Minimum score of the instances of the model to be found. Default: 0.7 + "Greediness" of the search heuristic (0: safe but slow; 1: fast but matches may be missed). Default: 0.9 + Number of pyramid levels used in the matching (and lowest pyramid level to use if $|NumLevels| = 2$). Default: 0 + Names of (optional) parameters for controlling the behavior of the operator. Default: [] + Values of the optional generic parameters. Default: [] + 6 standard deviations or 36 covariances of the pose parameters. + Score of the found instances of the 3D shape model. + 3D pose of the 3D shape model. + + + + Prepare a 3D object model for matching. + Modified instance represents: Handle of the 3D shape model. + + Handle of the 3D object model. + Internal camera parameters. + Reference orientation: Rotation around x-axis or x component of the Rodriguez vector (in radians or without unit). Default: 0 + Reference orientation: Rotation around y-axis or y component of the Rodriguez vector (in radians or without unit). Default: 0 + Reference orientation: Rotation around z-axis or z component of the Rodriguez vector (in radians or without unit). Default: 0 + Meaning of the rotation values of the reference orientation. Default: "gba" + Minimum longitude of the model views. Default: -0.35 + Maximum longitude of the model views. Default: 0.35 + Minimum latitude of the model views. Default: -0.35 + Maximum latitude of the model views. Default: 0.35 + Minimum camera roll angle of the model views. Default: -3.1416 + Maximum camera roll angle of the model views. Default: 3.1416 + Minimum camera-object-distance of the model views. Default: 0.3 + Maximum camera-object-distance of the model views. Default: 0.4 + Minimum contrast of the objects in the search images. Default: 10 + Names of (optional) parameters for controlling the behavior of the operator. Default: [] + Values of the optional generic parameters. Default: [] + + + + Prepare a 3D object model for matching. + Modified instance represents: Handle of the 3D shape model. + + Handle of the 3D object model. + Internal camera parameters. + Reference orientation: Rotation around x-axis or x component of the Rodriguez vector (in radians or without unit). Default: 0 + Reference orientation: Rotation around y-axis or y component of the Rodriguez vector (in radians or without unit). Default: 0 + Reference orientation: Rotation around z-axis or z component of the Rodriguez vector (in radians or without unit). Default: 0 + Meaning of the rotation values of the reference orientation. Default: "gba" + Minimum longitude of the model views. Default: -0.35 + Maximum longitude of the model views. Default: 0.35 + Minimum latitude of the model views. Default: -0.35 + Maximum latitude of the model views. Default: 0.35 + Minimum camera roll angle of the model views. Default: -3.1416 + Maximum camera roll angle of the model views. Default: 3.1416 + Minimum camera-object-distance of the model views. Default: 0.3 + Maximum camera-object-distance of the model views. Default: 0.4 + Minimum contrast of the objects in the search images. Default: 10 + Names of (optional) parameters for controlling the behavior of the operator. Default: [] + Values of the optional generic parameters. Default: [] + + + Represents an instance of the data structure required to perform 3D measurements with the sheet-of-light technique. + + + + Read a sheet-of-light model from a file and create a new model. + Modified instance represents: Handle of the sheet-of-light model. + + Name of the sheet-of-light model file. Default: "sheet_of_light_model.solm" + + + + Create a model to perform 3D-measurements using the sheet-of-light technique. + Modified instance represents: Handle for using and accessing the sheet-of-light model. + + Region of the images containing the profiles to be processed. If the provided region is not rectangular, its smallest enclosing rectangle will be used. + Names of the generic parameters that can be adjusted for the sheet-of-light model. Default: "min_gray" + Values of the generic parameters that can be adjusted for the sheet-of-light model. Default: 50 + + + + Create a model to perform 3D-measurements using the sheet-of-light technique. + Modified instance represents: Handle for using and accessing the sheet-of-light model. + + Region of the images containing the profiles to be processed. If the provided region is not rectangular, its smallest enclosing rectangle will be used. + Names of the generic parameters that can be adjusted for the sheet-of-light model. Default: "min_gray" + Values of the generic parameters that can be adjusted for the sheet-of-light model. Default: 50 + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + + Read a sheet-of-light model from a file and create a new model. + Modified instance represents: Handle of the sheet-of-light model. + + Name of the sheet-of-light model file. Default: "sheet_of_light_model.solm" + + + + Write a sheet-of-light model to a file. + Instance represents: Handle of the sheet-of-light model. + + Name of the sheet-of-light model file. Default: "sheet_of_light_model.solm" + + + + Deserialize a sheet-of-light model. + Modified instance represents: Handle of the sheet-of-light model. + + Handle of the serialized item. + + + + Serialize a sheet-of-light model. + Instance represents: Handle of the sheet-of-light model. + + Handle of the serialized item. + + + + Calibrate a sheet-of-light setup with a 3D calibration object. + Instance represents: Handle of the sheet-of-light model. + + Average back projection error of the optimization. + + + + Get the result of a calibrated measurement performed with the sheet-of-light technique as a 3D object model. + Instance represents: Handle for accessing the sheet-of-light model. + + Handle of the resulting 3D object model. + + + + Get the iconic results of a measurement performed with the sheet-of light technique. + Instance represents: Handle of the sheet-of-light model to be used. + + Specify which result of the measurement shall be provided. Default: "disparity" + Desired measurement result. + + + + Get the iconic results of a measurement performed with the sheet-of light technique. + Instance represents: Handle of the sheet-of-light model to be used. + + Specify which result of the measurement shall be provided. Default: "disparity" + Desired measurement result. + + + + Apply the calibration transformations to the input disparity image. + Instance represents: Handle of the sheet-of-light model. + + Height or range image to be calibrated. + + + + Set sheet of light profiles by measured disparities. + Instance represents: Handle of the sheet-of-light model. + + Disparity image that contains several profiles. + Poses describing the movement of the scene under measurement between the previously processed profile image and the current profile image. + + + + Process the profile image provided as input and store the resulting disparity to the sheet-of-light model. + Instance represents: Handle of the sheet-of-light model. + + Input image. + Pose describing the movement of the scene under measurement between the previously processed profile image and the current profile image. + + + + Set selected parameters of the sheet-of-light model. + Instance represents: Handle of the sheet-of-light model. + + Name of the model parameter that shall be adjusted for the sheet-of-light model. Default: "method" + Value of the model parameter that shall be adjusted for the sheet-of-light model. Default: "center_of_gravity" + + + + Set selected parameters of the sheet-of-light model. + Instance represents: Handle of the sheet-of-light model. + + Name of the model parameter that shall be adjusted for the sheet-of-light model. Default: "method" + Value of the model parameter that shall be adjusted for the sheet-of-light model. Default: "center_of_gravity" + + + + Get the value of a parameter, which has been set in a sheet-of-light model. + Instance represents: Handle of the sheet-of-light model. + + Name of the generic parameter that shall be queried. Default: "method" + Value of the model parameter that shall be queried. + + + + For a given sheet-of-light model get the names of the generic iconic or control parameters that can be used in the different sheet-of-light operators. + Instance represents: Handle of the sheet-of-light model. + + Name of the parameter group. Default: "create_model_params" + List containing the names of the supported generic parameters. + + + + Reset a sheet-of-light model. + Instance represents: Handle of the sheet-of-light model. + + + + + Delete a sheet-of-light model and free the allocated memory. + Instance represents: Handle of the sheet-of-light model. + + + + + Create a model to perform 3D-measurements using the sheet-of-light technique. + Modified instance represents: Handle for using and accessing the sheet-of-light model. + + Region of the images containing the profiles to be processed. If the provided region is not rectangular, its smallest enclosing rectangle will be used. + Names of the generic parameters that can be adjusted for the sheet-of-light model. Default: "min_gray" + Values of the generic parameters that can be adjusted for the sheet-of-light model. Default: 50 + + + + Create a model to perform 3D-measurements using the sheet-of-light technique. + Modified instance represents: Handle for using and accessing the sheet-of-light model. + + Region of the images containing the profiles to be processed. If the provided region is not rectangular, its smallest enclosing rectangle will be used. + Names of the generic parameters that can be adjusted for the sheet-of-light model. Default: "min_gray" + Values of the generic parameters that can be adjusted for the sheet-of-light model. Default: 50 + + + Represents an instance of a socket connection. + + + + Open a socket and connect it to an accepting socket. + Modified instance represents: Socket number. + + Hostname of the computer to connect to. Default: "localhost" + Port number. + Names of the generic parameters that can be adjusted for the socket. Default: [] + Values of the generic parameters that can be adjusted for the socket. Default: [] + + + + Open a socket and connect it to an accepting socket. + Modified instance represents: Socket number. + + Hostname of the computer to connect to. Default: "localhost" + Port number. + Names of the generic parameters that can be adjusted for the socket. Default: [] + Values of the generic parameters that can be adjusted for the socket. Default: [] + + + + Open a socket that accepts connection requests. + Modified instance represents: Socket number. + + Port number. Default: 3000 + Names of the generic parameters that can be adjusted for the socket. Default: [] + Values of the generic parameters that can be adjusted for the socket. Default: [] + + + + Open a socket that accepts connection requests. + Modified instance represents: Socket number. + + Port number. Default: 3000 + Names of the generic parameters that can be adjusted for the socket. Default: [] + Values of the generic parameters that can be adjusted for the socket. Default: [] + + + + Receive an image over a socket connection. + Instance represents: Socket number. + + Received image. + + + + Send an image over a socket connection. + Instance represents: Socket number. + + Image to be sent. + + + + Receive regions over a socket connection. + Instance represents: Socket number. + + Received regions. + + + + Send regions over a socket connection. + Instance represents: Socket number. + + Regions to be sent. + + + + Receive an XLD object over a socket connection. + Instance represents: Socket number. + + Received XLD object. + + + + Send an XLD object over a socket connection. + Instance represents: Socket number. + + XLD object to be sent. + + + + Receive a tuple over a socket connection. + Instance represents: Socket number. + + Received tuple. + + + + Send a tuple over a socket connection. + Instance represents: Socket number. + + Tuple to be sent. + + + + Send a tuple over a socket connection. + Instance represents: Socket number. + + Tuple to be sent. + + + + Receive arbitrary data from external devices or applications using a generic socket connection. + Instance represents: Socket number. + + Specification how to convert the data to tuples. Default: "z" + IP address or hostname and network port of the communication partner. + Value (or tuple of values) holding the received and converted data. + + + + Receive arbitrary data from external devices or applications using a generic socket connection. + Instance represents: Socket number. + + Specification how to convert the data to tuples. Default: "z" + IP address or hostname and network port of the communication partner. + Value (or tuple of values) holding the received and converted data. + + + + Send arbitrary data to external devices or applications using a generic socket communication. + Instance represents: Socket number. + + Specification how to convert the data. Default: "z" + Value (or tuple of values) holding the data to send. + IP address or hostname and network port of the communication partner. Default: [] + + + + Send arbitrary data to external devices or applications using a generic socket communication. + Instance represents: Socket number. + + Specification how to convert the data. Default: "z" + Value (or tuple of values) holding the data to send. + IP address or hostname and network port of the communication partner. Default: [] + + + + Get the value of a socket parameter. + Instance represents: Socket number. + + Name of the socket parameter. + Value of the socket parameter. + + + + Get the value of a socket parameter. + Instance represents: Socket number. + + Name of the socket parameter. + Value of the socket parameter. + + + + Set a socket parameter. + Instance represents: Socket number. + + Name of the socket parameter. + Value of the socket parameter. Default: "on" + + + + Set a socket parameter. + Instance represents: Socket number. + + Name of the socket parameter. + Value of the socket parameter. Default: "on" + + + + Determine the HALCON data type of the next socket data. + Instance represents: Socket number. + + Data type of next HALCON data. + + + + Get the socket descriptor of a socket used by the operating system. + Instance represents: Socket number. + + Socket descriptor used by the operating system. + + + This operator is inoperable. It had the following function: Close all opened sockets. + + + + Close a socket. + Instance represents: Socket number. + + + + + Accept a connection request on a listening socket of the protocol type 'HALCON' or 'TCP'/'TCP4'/'TCP6'. + Instance represents: Socket number of the accepting socket. + + Should the operator wait until a connection request arrives? Default: "auto" + Socket number. + + + + Open a socket and connect it to an accepting socket. + Modified instance represents: Socket number. + + Hostname of the computer to connect to. Default: "localhost" + Port number. + Names of the generic parameters that can be adjusted for the socket. Default: [] + Values of the generic parameters that can be adjusted for the socket. Default: [] + + + + Open a socket and connect it to an accepting socket. + Modified instance represents: Socket number. + + Hostname of the computer to connect to. Default: "localhost" + Port number. + Names of the generic parameters that can be adjusted for the socket. Default: [] + Values of the generic parameters that can be adjusted for the socket. Default: [] + + + + Open a socket that accepts connection requests. + Modified instance represents: Socket number. + + Port number. Default: 3000 + Names of the generic parameters that can be adjusted for the socket. Default: [] + Values of the generic parameters that can be adjusted for the socket. Default: [] + + + + Open a socket that accepts connection requests. + Modified instance represents: Socket number. + + Port number. Default: 3000 + Names of the generic parameters that can be adjusted for the socket. Default: [] + Values of the generic parameters that can be adjusted for the socket. Default: [] + + + + Receive a serialized item over a socket connection. + Instance represents: Socket number. + + Handle of the serialized item. + + + + Send a serialized item over a socket connection. + Instance represents: Socket number. + + Handle of the serialized item. + + + Represents an instance of a stereo model. + + + + Create a HALCON stereo model. + Modified instance represents: Handle of the stereo model. + + Handle to the camera setup model. + Reconstruction method. Default: "surface_pairwise" + Name of the model parameter to be set. Default: [] + Value of the model parameter to be set. Default: [] + + + + Create a HALCON stereo model. + Modified instance represents: Handle of the stereo model. + + Handle to the camera setup model. + Reconstruction method. Default: "surface_pairwise" + Name of the model parameter to be set. Default: [] + Value of the model parameter to be set. Default: [] + + + + Free the memory of a stereo model. + Instance represents: Handle of the stereo model. + + + + + Reconstruct 3D points from calibrated multi-view stereo images. + Instance represents: Handle of the stereo model. + + Row coordinates of the detected points. + Column coordinates of the detected points. + Covariance matrices of the detected points. Default: [] + Indices of the observing cameras. + Indices of the observed world points. + X coordinates of the reconstructed 3D points. + Y coordinates of the reconstructed 3D points. + Z coordinates of the reconstructed 3D points. + Covariance matrices of the reconstructed 3D points. + Indices of the reconstructed 3D points. + + + + Reconstruct 3D points from calibrated multi-view stereo images. + Instance represents: Handle of the stereo model. + + Row coordinates of the detected points. + Column coordinates of the detected points. + Covariance matrices of the detected points. Default: [] + Indices of the observing cameras. + Indices of the observed world points. + X coordinates of the reconstructed 3D points. + Y coordinates of the reconstructed 3D points. + Z coordinates of the reconstructed 3D points. + Covariance matrices of the reconstructed 3D points. + Indices of the reconstructed 3D points. + + + + Reconstruct surface from calibrated multi-view stereo images. + Instance represents: Handle of the stereo model. + + An image array acquired by the camera setup associated with the stereo model. + Handle to the resulting surface. + + + + Get intermediate iconic results of a stereo reconstruction. + Instance represents: Handle of the stereo model. + + Camera indices of the pair ([From, To]). + Name of the iconic result to be returned. + Iconic result. + + + + Get intermediate iconic results of a stereo reconstruction. + Instance represents: Handle of the stereo model. + + Camera indices of the pair ([From, To]). + Name of the iconic result to be returned. + Iconic result. + + + + Return the list of image pairs set in a stereo model. + Instance represents: Handle of the stereo model. + + Camera indices for the to cameras in the image pairs. + Camera indices for the from cameras in the image pairs. + + + + Specify image pairs to be used for surface stereo reconstruction. + Instance represents: Handle of the stereo model. + + Camera indices for the from cameras in the image pairs. + Camera indices for the to cameras in the image pairs. + + + + Get stereo model parameters. + Instance represents: Handle of the stereo model. + + Names of the parameters to be set. + Values of the parameters to be set. + + + + Get stereo model parameters. + Instance represents: Handle of the stereo model. + + Names of the parameters to be set. + Values of the parameters to be set. + + + + Set stereo model parameters. + Instance represents: Handle of the stereo model. + + Names of the parameters to be set. + Values of the parameters to be set. + + + + Set stereo model parameters. + Instance represents: Handle of the stereo model. + + Names of the parameters to be set. + Values of the parameters to be set. + + + + Create a HALCON stereo model. + Modified instance represents: Handle of the stereo model. + + Handle to the camera setup model. + Reconstruction method. Default: "surface_pairwise" + Name of the model parameter to be set. Default: [] + Value of the model parameter to be set. Default: [] + + + + Create a HALCON stereo model. + Modified instance represents: Handle of the stereo model. + + Handle to the camera setup model. + Reconstruction method. Default: "surface_pairwise" + Name of the model parameter to be set. Default: [] + Value of the model parameter to be set. Default: [] + + + + Get intermediate 3D object model of a stereo reconstruction + Instance represents: Handle des Stereomodells. + + Namen der Modellparameter. + Werte der Modellparameter. + + + + Get intermediate 3D object model of a stereo reconstruction + Instance represents: Handle des Stereomodells. + + Namen der Modellparameter. + Werte der Modellparameter. + + + Represents an instance of a structured light model. + + + + Create a structured light model. + Modified instance represents: Handle for using and accessing the structured light model. + + The type of the created structured light model. Default: "deflectometry" + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + Clear a structured light model and free the allocated memory. + Handle of the structured light model. + + + + Clear a structured light model and free the allocated memory. + Instance represents: Handle of the structured light model. + + + + + Create a structured light model. + Modified instance represents: Handle for using and accessing the structured light model. + + The type of the created structured light model. Default: "deflectometry" + + + + Decode the camera images acquired with a structured light setup. + Instance represents: Handle of the structured light model. + + Acquired camera images. + + + + Deserialize a structured light model. + Modified instance represents: Handle of the structured light model. + + Handle of the serialized item. + + + + Generate the pattern images to be displayed in a structured light setup. + Instance represents: Handle of the structured light model. + + Generated pattern images. + + + + Query parameters of a structured light model. + Instance represents: Handle of the structured light model. + + Name of the queried model parameter. Default: "min_stripe_width" + Value of the queried model parameter. + + + + Query parameters of a structured light model. + Instance represents: Handle of the structured light model. + + Name of the queried model parameter. Default: "min_stripe_width" + Value of the queried model parameter. + + + + Get (intermediate) iconic results of a structured light model. + Instance represents: Handle of the structured light model. + + Name of the iconic result to be returned. Default: "correspondence_image" + Iconic result. + + + + Get (intermediate) iconic results of a structured light model. + Instance represents: Handle of the structured light model. + + Name of the iconic result to be returned. Default: "correspondence_image" + Iconic result. + + + + Read a structured light model from a file. + Modified instance represents: Handle of the structured light model. + + File name. + + + + Serialize a structured light model. + Instance represents: Handle of the structured light model. + + Handle of the serialized item. + + + + Set parameters of a structured light model. + Instance represents: Handle of the structured light model. + + Name of the model parameter to be adjusted. Default: "min_stripe_width" + New value of the model parameter. Default: 32 + + + + Set parameters of a structured light model. + Instance represents: Handle of the structured light model. + + Name of the model parameter to be adjusted. Default: "min_stripe_width" + New value of the model parameter. Default: 32 + + + + Write a structured light model to a file. + Instance represents: Handle of the structured light model. + + File name. + + + Represents an instance of a surface matching result. + + + + Get details of a result from surface based matching. + Instance represents: Handle of the surface matching result. + + Name of the result property. Default: "pose" + Index of the matching result, starting with 0. Default: 0 + Value of the result property. + + + + Get details of a result from surface based matching. + Instance represents: Handle of the surface matching result. + + Name of the result property. Default: "pose" + Index of the matching result, starting with 0. Default: 0 + Value of the result property. + + + Free the memory of a surface matching result. + Handle of the surface matching result. + + + + Free the memory of a surface matching result. + Instance represents: Handle of the surface matching result. + + + + Refine the pose of a surface model in a 3D scene. + Handle of the surface model. + Handle of the 3D object model containing the scene. + Initial pose of the surface model in the scene. + Minimum score of the returned poses. Default: 0 + Enable returning a result handle in SurfaceMatchingResultID. Default: "false" + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Score of the found instances of the model. + Handle of the matching result, if enabled in ReturnResultHandle. + 3D pose of the surface model in the scene. + + + + Refine the pose of a surface model in a 3D scene. + Modified instance represents: Handle of the matching result, if enabled in ReturnResultHandle. + + Handle of the surface model. + Handle of the 3D object model containing the scene. + Initial pose of the surface model in the scene. + Minimum score of the returned poses. Default: 0 + Enable returning a result handle in SurfaceMatchingResultID. Default: "false" + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Score of the found instances of the model. + 3D pose of the surface model in the scene. + + + Find the best matches of a surface model in a 3D scene. + Handle of the surface model. + Handle of the 3D object model containing the scene. + Scene sampling distance relative to the diameter of the surface model. Default: 0.05 + Fraction of sampled scene points used as key points. Default: 0.2 + Minimum score of the returned poses. Default: 0 + Enable returning a result handle in SurfaceMatchingResultID. Default: "false" + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Score of the found instances of the surface model. + Handle of the matching result, if enabled in ReturnResultHandle. + 3D pose of the surface model in the scene. + + + + Find the best matches of a surface model in a 3D scene. + Modified instance represents: Handle of the matching result, if enabled in ReturnResultHandle. + + Handle of the surface model. + Handle of the 3D object model containing the scene. + Scene sampling distance relative to the diameter of the surface model. Default: 0.05 + Fraction of sampled scene points used as key points. Default: 0.2 + Minimum score of the returned poses. Default: 0 + Enable returning a result handle in SurfaceMatchingResultID. Default: "false" + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Score of the found instances of the surface model. + 3D pose of the surface model in the scene. + + + Find the best matches of a surface model in a 3D scene and images. + Images of the scene. + Handle of the surface model. + Handle of the 3D object model containing the scene. + Scene sampling distance relative to the diameter of the surface model. Default: 0.05 + Fraction of sampled scene points used as key points. Default: 0.2 + Minimum score of the returned poses. Default: 0 + Enable returning a result handle in SurfaceMatchingResultID. Default: "false" + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Score of the found instances of the surface model. + Handle of the matching result, if enabled in ReturnResultHandle. + 3D pose of the surface model in the scene. + + + + Find the best matches of a surface model in a 3D scene and images. + Modified instance represents: Handle of the matching result, if enabled in ReturnResultHandle. + + Images of the scene. + Handle of the surface model. + Handle of the 3D object model containing the scene. + Scene sampling distance relative to the diameter of the surface model. Default: 0.05 + Fraction of sampled scene points used as key points. Default: 0.2 + Minimum score of the returned poses. Default: 0 + Enable returning a result handle in SurfaceMatchingResultID. Default: "false" + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Score of the found instances of the surface model. + 3D pose of the surface model in the scene. + + + Refine the pose of a surface model in a 3D scene and in images. + Images of the scene. + Handle of the surface model. + Handle of the 3D object model containing the scene. + Initial pose of the surface model in the scene. + Minimum score of the returned poses. Default: 0 + Enable returning a result handle in SurfaceMatchingResultID. Default: "false" + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Score of the found instances of the model. + Handle of the matching result, if enabled in ReturnResultHandle. + 3D pose of the surface model in the scene. + + + + Refine the pose of a surface model in a 3D scene and in images. + Modified instance represents: Handle of the matching result, if enabled in ReturnResultHandle. + + Images of the scene. + Handle of the surface model. + Handle of the 3D object model containing the scene. + Initial pose of the surface model in the scene. + Minimum score of the returned poses. Default: 0 + Enable returning a result handle in SurfaceMatchingResultID. Default: "false" + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Score of the found instances of the model. + 3D pose of the surface model in the scene. + + + Represents an instance of a surface model. + + + + Read a surface model from a file. + Modified instance represents: Handle of the read surface model. + + Name of the SFM file. + + + + Create the data structure needed to perform surface-based matching. + Modified instance represents: Handle of the surface model. + + Handle of the 3D object model. + Sampling distance relative to the object's diameter Default: 0.03 + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + + + + Create the data structure needed to perform surface-based matching. + Modified instance represents: Handle of the surface model. + + Handle of the 3D object model. + Sampling distance relative to the object's diameter Default: 0.03 + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + Free the memory of a surface model. + Handle of the surface model. + + + + Free the memory of a surface model. + Instance represents: Handle of the surface model. + + + + + Deserialize a surface model. + Modified instance represents: Handle of the surface model. + + Handle of the serialized item. + + + + Serialize a surface_model. + Instance represents: Handle of the surface model. + + Handle of the serialized item. + + + + Read a surface model from a file. + Modified instance represents: Handle of the read surface model. + + Name of the SFM file. + + + + Write a surface model to a file. + Instance represents: Handle of the surface model. + + File name. + + + + Refine the pose of a surface model in a 3D scene. + Instance represents: Handle of the surface model. + + Handle of the 3D object model containing the scene. + Initial pose of the surface model in the scene. + Minimum score of the returned poses. Default: 0 + Enable returning a result handle in SurfaceMatchingResultID. Default: "false" + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Score of the found instances of the model. + Handle of the matching result, if enabled in ReturnResultHandle. + 3D pose of the surface model in the scene. + + + + Refine the pose of a surface model in a 3D scene. + Instance represents: Handle of the surface model. + + Handle of the 3D object model containing the scene. + Initial pose of the surface model in the scene. + Minimum score of the returned poses. Default: 0 + Enable returning a result handle in SurfaceMatchingResultID. Default: "false" + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Score of the found instances of the model. + Handle of the matching result, if enabled in ReturnResultHandle. + 3D pose of the surface model in the scene. + + + + Find the best matches of a surface model in a 3D scene. + Instance represents: Handle of the surface model. + + Handle of the 3D object model containing the scene. + Scene sampling distance relative to the diameter of the surface model. Default: 0.05 + Fraction of sampled scene points used as key points. Default: 0.2 + Minimum score of the returned poses. Default: 0 + Enable returning a result handle in SurfaceMatchingResultID. Default: "false" + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Score of the found instances of the surface model. + Handle of the matching result, if enabled in ReturnResultHandle. + 3D pose of the surface model in the scene. + + + + Find the best matches of a surface model in a 3D scene. + Instance represents: Handle of the surface model. + + Handle of the 3D object model containing the scene. + Scene sampling distance relative to the diameter of the surface model. Default: 0.05 + Fraction of sampled scene points used as key points. Default: 0.2 + Minimum score of the returned poses. Default: 0 + Enable returning a result handle in SurfaceMatchingResultID. Default: "false" + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Score of the found instances of the surface model. + Handle of the matching result, if enabled in ReturnResultHandle. + 3D pose of the surface model in the scene. + + + + Return the parameters and properties of a surface model. + Instance represents: Handle of the surface model. + + Name of the parameter. Default: "diameter" + Value of the parameter. + + + + Return the parameters and properties of a surface model. + Instance represents: Handle of the surface model. + + Name of the parameter. Default: "diameter" + Value of the parameter. + + + + Create the data structure needed to perform surface-based matching. + Modified instance represents: Handle of the surface model. + + Handle of the 3D object model. + Sampling distance relative to the object's diameter Default: 0.03 + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + + + + Create the data structure needed to perform surface-based matching. + Modified instance represents: Handle of the surface model. + + Handle of the 3D object model. + Sampling distance relative to the object's diameter Default: 0.03 + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + + + + Find the best matches of a surface model in a 3D scene and images. + Instance represents: Handle of the surface model. + + Images of the scene. + Handle of the 3D object model containing the scene. + Scene sampling distance relative to the diameter of the surface model. Default: 0.05 + Fraction of sampled scene points used as key points. Default: 0.2 + Minimum score of the returned poses. Default: 0 + Enable returning a result handle in SurfaceMatchingResultID. Default: "false" + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Score of the found instances of the surface model. + Handle of the matching result, if enabled in ReturnResultHandle. + 3D pose of the surface model in the scene. + + + + Find the best matches of a surface model in a 3D scene and images. + Instance represents: Handle of the surface model. + + Images of the scene. + Handle of the 3D object model containing the scene. + Scene sampling distance relative to the diameter of the surface model. Default: 0.05 + Fraction of sampled scene points used as key points. Default: 0.2 + Minimum score of the returned poses. Default: 0 + Enable returning a result handle in SurfaceMatchingResultID. Default: "false" + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Score of the found instances of the surface model. + Handle of the matching result, if enabled in ReturnResultHandle. + 3D pose of the surface model in the scene. + + + + Refine the pose of a surface model in a 3D scene and in images. + Instance represents: Handle of the surface model. + + Images of the scene. + Handle of the 3D object model containing the scene. + Initial pose of the surface model in the scene. + Minimum score of the returned poses. Default: 0 + Enable returning a result handle in SurfaceMatchingResultID. Default: "false" + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Score of the found instances of the model. + Handle of the matching result, if enabled in ReturnResultHandle. + 3D pose of the surface model in the scene. + + + + Refine the pose of a surface model in a 3D scene and in images. + Instance represents: Handle of the surface model. + + Images of the scene. + Handle of the 3D object model containing the scene. + Initial pose of the surface model in the scene. + Minimum score of the returned poses. Default: 0 + Enable returning a result handle in SurfaceMatchingResultID. Default: "false" + Names of the generic parameters. Default: [] + Values of the generic parameters. Default: [] + Score of the found instances of the model. + Handle of the matching result, if enabled in ReturnResultHandle. + 3D pose of the surface model in the scene. + + + + Set parameters and properties of a surface model. + Instance represents: Handle of the surface model. + + Name of the parameter. Default: "camera_parameter" + Value of the parameter. + + + + Set parameters and properties of a surface model. + Instance represents: Handle of the surface model. + + Name of the parameter. Default: "camera_parameter" + Value of the parameter. + + + Class grouping system information and manipulation related functionality. + + + Delaying the execution of the program. + Number of seconds by which the execution of the program will be delayed. Default: 10 + + + Execute a system command. + Command to be called by the system. Default: "ls" + + + Set HALCON system parameters. + Name of the system parameter to be changed. Default: "init_new_image" + New value of the system parameter. Default: "true" + + + Set HALCON system parameters. + Name of the system parameter to be changed. Default: "init_new_image" + New value of the system parameter. Default: "true" + + + Activating and deactivating of HALCON control modes. + Desired control mode. Default: "default" + + + Activating and deactivating of HALCON control modes. + Desired control mode. Default: "default" + + + Initialization of the HALCON system. + Default image width (in pixels). Default: 128 + Default image height (in pixels). Default: 128 + Usual number of channels. Default: 0 + + + Get current value of HALCON system parameters. + Desired system parameter. Default: "init_new_image" + Current value of the system parameter. + + + Get current value of HALCON system parameters. + Desired system parameter. Default: "init_new_image" + Current value of the system parameter. + + + State of the HALCON control modes. + Tuplet of the currently activated control modes. + + + Inquiry after the error text of a HALCON error number. + HALCON error code. + Corresponding error message. + + + Passed Time. + Processtime since the program start. + + + Number of entries in the HALCON database. + Relation of interest of the HALCON database. Default: "object" + Number of tuples in the relation. + + + Returns the extended error information for the calling thread's last HALCON error. + Extended error code. + Extended error message. + Operator that set the error code. + + + Query of used modules and the module key. + Key for license manager. + Names of used modules. + + + Inquiring for possible settings of the HALCON debugging tool. + Corresponding state of the control modes. + Available control modes (see also set_spy). + + + Control of the HALCON Debugging Tools. + Control mode Default: "mode" + State of the control mode to be set. Default: "on" + + + Control of the HALCON Debugging Tools. + Control mode Default: "mode" + State of the control mode to be set. Default: "on" + + + Current configuration of the HALCON debugging-tool. + Control mode Default: "mode" + State of the control mode. + + + Set AOP information for operators. + Operator to set information to Default: "" + Further specific index Default: "" + Further specific address Default: "" + Scope of information Default: "max_threads" + AOP information value + + + Set AOP information for operators. + Operator to set information to Default: "" + Further specific index Default: "" + Further specific address Default: "" + Scope of information Default: "max_threads" + AOP information value + + + Return AOP information for operators. + Operator to get information for + Further index stages Default: ["iconic_type","parameter:0"] + Further index values Default: ["byte",""] + Scope of information Default: "max_threads" + Value of information + + + Return AOP information for operators. + Operator to get information for + Further index stages Default: ["iconic_type","parameter:0"] + Further index values Default: ["byte",""] + Scope of information Default: "max_threads" + Value of information + + + Query indexing structure of AOP information for operators. + Operator to get information for Default: "" + Further specific index Default: "" + Further specific address Default: "" + Values of next index stage + Name of next index stage + + + Query indexing structure of AOP information for operators. + Operator to get information for Default: "" + Further specific index Default: "" + Further specific address Default: "" + Values of next index stage + Name of next index stage + + + Check hardware regarding its potential for automatic operator parallelization. + Operators to check Default: "" + Iconic object types to check Default: "" + Knowledge file name Default: "" + Parameter name Default: "none" + Parameter value Default: "none" + + + Check hardware regarding its potential for automatic operator parallelization. + Operators to check Default: "" + Iconic object types to check Default: "" + Knowledge file name Default: "" + Parameter name Default: "none" + Parameter value Default: "none" + + + Write knowledge about hardware dependent behavior of automatic operator parallelization to file. + Name of knowledge file Default: "" + Parameter name Default: "none" + Parameter value Default: "none" + + + Write knowledge about hardware dependent behavior of automatic operator parallelization to file. + Name of knowledge file Default: "" + Parameter name Default: "none" + Parameter value Default: "none" + + + Load knowledge about hardware dependent behavior of automatic operator parallelization. + Name of knowledge file Default: "" + Parameter name Default: "none" + Parameter value Default: "none" + Updated Operators + Knowledge attributes + + + Load knowledge about hardware dependent behavior of automatic operator parallelization. + Name of knowledge file Default: "" + Parameter name Default: "none" + Parameter value Default: "none" + Updated Operators + Knowledge attributes + + + Specify a window type. + Name of the window type which has to be set. Default: "X-Window" + + + Get window characteristics. + Name of the attribute that should be returned. + Attribute value. + + + Set window characteristics. + Name of the attribute that should be modified. + Value of the attribute that should be set. + + + Set window characteristics. + Name of the attribute that should be modified. + Value of the attribute that should be set. + + + Query all available window types. + Names of available window types. + + + Return the HALCON thread ID of the current thread. + ID representing the current thread. + + + Get current value of system information without requiring a license. + Desired system parameter. Default: "available_parameters" + Current value of the system parameter. + + + Get current value of system information without requiring a license. + Desired system parameter. Default: "available_parameters" + Current value of the system parameter. + + + Attempt to interrupt an operator running in a different thread. + Thread that runs the operator to interrupt. + Interruption mode. Default: "cancel" + + + Represents an instance of a template for gray value matching. + + + + Preparing a pattern for template matching with rotation. + Modified instance represents: Template number. + + Input image whose domain will be processed for the pattern matching. + Maximal number of pyramid levels. Default: 4 + Smallest Rotation of the pattern. Default: -0.39 + Maximum positive Extension of AngleStart. Default: 0.79 + Step rate (angle precision) of matching. Default: 0.0982 + Kind of optimizing. Default: "sort" + Kind of grayvalues. Default: "original" + + + + Preparing a pattern for template matching. + Modified instance represents: Template number. + + Input image whose domain will be processed for the pattern matching. + Not yet in use. Default: 255 + Maximal number of pyramid levels. Default: 4 + Kind of optimizing. Default: "sort" + Kind of grayvalues. Default: "original" + + + + Reading a template from file. + Modified instance represents: Template number. + + file name. + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + + Preparing a pattern for template matching with rotation. + Modified instance represents: Template number. + + Input image whose domain will be processed for the pattern matching. + Maximal number of pyramid levels. Default: 4 + Smallest Rotation of the pattern. Default: -0.39 + Maximum positive Extension of AngleStart. Default: 0.79 + Step rate (angle precision) of matching. Default: 0.0982 + Kind of optimizing. Default: "sort" + Kind of grayvalues. Default: "original" + + + + Preparing a pattern for template matching. + Modified instance represents: Template number. + + Input image whose domain will be processed for the pattern matching. + Not yet in use. Default: 255 + Maximal number of pyramid levels. Default: 4 + Kind of optimizing. Default: "sort" + Kind of grayvalues. Default: "original" + + + + Serialize a template. + Instance represents: Handle of the template. + + Handle of the serialized item. + + + + Deserialize a serialized template. + Modified instance represents: Template number. + + Handle of the serialized item. + + + + Writing a template to file. + Instance represents: Template number. + + file name. + + + + Reading a template from file. + Modified instance represents: Template number. + + file name. + + + + Deallocation of the memory of a template. + Instance represents: Template number. + + + + + Gray value offset for template. + Instance represents: Template number. + + Offset of gray values. Default: 0 + + + + Define reference position for a matching template. + Instance represents: Template number. + + Reference position of template (row). + Reference position of template (column). + + + + Adapting a template to the size of an image. + Instance represents: Template number. + + Image which determines the size of the later matching. + + + + Searching all good gray value matches in a pyramid. + Instance represents: Template number. + + Input image inside of which the pattern has to be found. + Maximal average difference of the grayvalues. Default: 30.0 + Number of levels in the pyramid. Default: 3 + All points which have an error below a certain threshold. + + + + Searching all good gray value matches in a pyramid. + Instance represents: Template number. + + Input image inside of which the pattern has to be found. + Maximal average difference of the grayvalues. Default: 30.0 + Number of levels in the pyramid. Default: 3 + All points which have an error below a certain threshold. + + + + Searching the best gray value matches in a pre generated pyramid. + Instance represents: Template number. + + Image pyramid inside of which the pattern has to be found. + Maximal average difference of the grayvalues. Default: 30.0 + Exactness in subpixels in case of 'true'. Default: "false" + Number of the used resolution levels. Default: 3 + Resolution level up to which the method "best match" is used. Default: "original" + Row position of the best match. + Column position of the best match. + Average divergence of the grayvalues in the best match. + + + + Searching the best gray value matches in a pre generated pyramid. + Instance represents: Template number. + + Image pyramid inside of which the pattern has to be found. + Maximal average difference of the grayvalues. Default: 30.0 + Exactness in subpixels in case of 'true'. Default: "false" + Number of the used resolution levels. Default: 3 + Resolution level up to which the method "best match" is used. Default: "original" + Row position of the best match. + Column position of the best match. + Average divergence of the grayvalues in the best match. + + + + Searching the best gray value matches in a pyramid. + Instance represents: Template number. + + Input image inside of which the pattern has to be found. + Maximal average difference of the grayvalues. Default: 30.0 + Exactness in subpixels in case of 'true'. Default: "false" + Number of the used resolution levels. Default: 4 + Resolution level up to which the method "best match" is used. Default: 2 + Row position of the best match. + Column position of the best match. + Average divergence of the grayvalues in the best match. + + + + Searching the best gray value matches in a pyramid. + Instance represents: Template number. + + Input image inside of which the pattern has to be found. + Maximal average difference of the grayvalues. Default: 30.0 + Exactness in subpixels in case of 'true'. Default: "false" + Number of the used resolution levels. Default: 4 + Resolution level up to which the method "best match" is used. Default: 2 + Row position of the best match. + Column position of the best match. + Average divergence of the grayvalues in the best match. + + + + Searching all good matches of a template and an image. + Instance represents: Template number. + + Input image inside of which the pattern has to be found. + Maximal average difference of the grayvalues. Default: 20.0 + All points whose error lies below a certain threshold. + + + + Searching the best matching of a template and a pyramid with rotation. + Instance represents: Template number. + + Input image inside of which the pattern has to be found. + Smallest Rotation of the pattern. Default: -0.39 + Maximum positive Extension of AngleStart. Default: 0.79 + Maximum average difference of the grayvalues. Default: 40.0 + Subpixel accuracy in case of 'true'. Default: "false" + Number of the used resolution levels. Default: 3 + Row position of the best match. + Column position of the best match. + Rotation angle of pattern. + Average divergence of the grayvalues of the best match. + + + + Searching the best matching of a template and a pyramid with rotation. + Instance represents: Template number. + + Input image inside of which the pattern has to be found. + Smallest Rotation of the pattern. Default: -0.39 + Maximum positive Extension of AngleStart. Default: 0.79 + Maximum average difference of the grayvalues. Default: 40.0 + Subpixel accuracy in case of 'true'. Default: "false" + Number of the used resolution levels. Default: 3 + Row position of the best match. + Column position of the best match. + Rotation angle of pattern. + Average divergence of the grayvalues of the best match. + + + + Searching the best matching of a template and an image with rotation. + Instance represents: Template number. + + Input image inside of which the pattern has to be found. + Smallest Rotation of the pattern. Default: -0.39 + Maximum positive Extension of AngleStart. Default: 0.79 + Maximum average difference of the grayvalues. Default: 30.0 + Subpixel accuracy in case of 'true'. Default: "false" + Row position of the best match. + Column position of the best match. + Rotation angle of pattern. + Average divergence of the grayvalues of the best match. + + + + Searching the best matching of a template and an image with rotation. + Instance represents: Template number. + + Input image inside of which the pattern has to be found. + Smallest Rotation of the pattern. Default: -0.39 + Maximum positive Extension of AngleStart. Default: 0.79 + Maximum average difference of the grayvalues. Default: 30.0 + Subpixel accuracy in case of 'true'. Default: "false" + Row position of the best match. + Column position of the best match. + Rotation angle of pattern. + Average divergence of the grayvalues of the best match. + + + + Searching the best matching of a template and an image. + Instance represents: Template number. + + Input image inside of which the pattern has to be found. + Maximum average difference of the grayvalues. Default: 20.0 + Subpixel accuracy in case of 'true'. Default: "false" + Row position of the best match. + Column position of the best match. + Average divergence of the grayvalues of the best match. + + + + Searching the best matching of a template and an image. + Instance represents: Template number. + + Input image inside of which the pattern has to be found. + Maximum average difference of the grayvalues. Default: 20.0 + Subpixel accuracy in case of 'true'. Default: "false" + Row position of the best match. + Column position of the best match. + Average divergence of the grayvalues of the best match. + + + Represents an instance of a text model for text segmentations. + + + + Create a text model. + Modified instance represents: New text model. + + The Mode of the text model. Default: "auto" + OCR Classifier. Default: "Universal_Rej.occ" + + + + Create a text model. + Modified instance represents: New text model. + + The Mode of the text model. Default: "auto" + OCR Classifier. Default: "Universal_Rej.occ" + + + + Create a text model. + Modified instance represents: New text model. + + + + + Find text in an image. + Instance represents: Text model specifying the text to be segmented. + + Input image. + Result of the segmentation. + + + + Query parameters of a text model. + Instance represents: Text model. + + Parameters to be queried. Default: "min_contrast" + Values of Parameters. + + + + Set parameters of a text model. + Instance represents: Text model. + + Names of the parameters to be set. Default: "min_contrast" + Values of the parameters to be set. Default: 10 + + + + Set parameters of a text model. + Instance represents: Text model. + + Names of the parameters to be set. Default: "min_contrast" + Values of the parameters to be set. Default: 10 + + + Clear a text model. + Text model to be cleared. + + + + Clear a text model. + Instance represents: Text model to be cleared. + + + + + Create a text model. + Modified instance represents: New text model. + + The Mode of the text model. Default: "auto" + OCR Classifier. Default: "Universal_Rej.occ" + + + + Create a text model. + Modified instance represents: New text model. + + The Mode of the text model. Default: "auto" + OCR Classifier. Default: "Universal_Rej.occ" + + + + Create a text model. + Modified instance represents: New text model. + + + + Represents an instance of a text segmentations result. + + + + Find text in an image. + Modified instance represents: Result of the segmentation. + + Input image. + Text model specifying the text to be segmented. + + + Clear a text result. + Text result to be cleared. + + + + Clear a text result. + Instance represents: Text result to be cleared. + + + + + Query an iconic value of a text segmentation result. + Instance represents: Text result. + + Name of the result to be returned. Default: "all_lines" + Returned result. + + + + Query an iconic value of a text segmentation result. + Instance represents: Text result. + + Name of the result to be returned. Default: "all_lines" + Returned result. + + + + Query a control value of a text segmentation result. + Instance represents: Text result. + + Name of the result to be returned. Default: "class" + Value of ResultName. + + + + Query a control value of a text segmentation result. + Instance represents: Text result. + + Name of the result to be returned. Default: "class" + Value of ResultName. + + + + Find text in an image. + Modified instance represents: Result of the segmentation. + + Input image. + Text model specifying the text to be segmented. + + + Represents an instance of a texture model for texture inspection. + + + + Create a texture inspection model. + Modified instance represents: Handle for using and accessing the texture inspection model. + + The type of the created texture inspection model. Default: "basic" + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + + Add training images to the texture inspection model. + Instance represents: Handle of the texture inspection model. + + Image of flawless texture. + Indices of the images that have been added to the texture inspection model. + + + + Inspection of the texture within an image. + Instance represents: Handle of the texture inspection model. + + Image of the texture to be inspected. + Handle of the inspection results. + Novelty regions. + + + Clear a texture inspection model and free the allocated memory. + Handle of the texture inspection model. + + + + Clear a texture inspection model and free the allocated memory. + Instance represents: Handle of the texture inspection model. + + + + + Create a texture inspection model. + Modified instance represents: Handle for using and accessing the texture inspection model. + + The type of the created texture inspection model. Default: "basic" + + + + Deserialize a serialized texture inspection model. + Modified instance represents: Handle of the texture inspection model. + + Handle of the serialized item. + + + + Get the training images contained in a texture inspection model. + Instance represents: Handle of the texture inspection model. + + Training images contained in the texture inspection model. + + + + Query parameters of a texture inspection model. + Instance represents: Handle of the texture inspection model. + + Name of the queried model parameter. Default: "novelty_threshold" + Value of the queried model parameter. + + + + Query parameters of a texture inspection model. + Instance represents: Handle of the texture inspection model. + + Name of the queried model parameter. Default: "novelty_threshold" + Value of the queried model parameter. + + + + Read a texture inspection model from a file. + Modified instance represents: Handle of the texture inspection model. + + File name. + + + Clear all or a user-defined subset of the images of a texture inspection model. + Handle of the texture inspection model. + Indices of the images to be deleted from the texture inspection model. + Indices of the images that remain in the texture inspection model. + + + + Clear all or a user-defined subset of the images of a texture inspection model. + Instance represents: Handle of the texture inspection model. + + Indices of the images to be deleted from the texture inspection model. + Indices of the images that remain in the texture inspection model. + + + + Serialize a texture inspection model. + Instance represents: Handle of the texture inspection model. + + Handle of the serialized item. + + + + Set parameters of a texture inspection model. + Instance represents: Handle of the texture inspection model. + + Name of the model parameter to be adjusted. Default: "gen_result_handle" + New value of the model parameter. Default: "true" + + + + Set parameters of a texture inspection model. + Instance represents: Handle of the texture inspection model. + + Name of the model parameter to be adjusted. Default: "gen_result_handle" + New value of the model parameter. Default: "true" + + + + Train a texture inspection model. + Instance represents: Handle of the texture inspection model. + + + + + Write a texture inspection model to a file. + Instance represents: Handle of the texture inspection model. + + File name. + + + Represents an instance of a texture inspection result. + + + + Inspection of the texture within an image. + Modified instance represents: Handle of the inspection results. + + Image of the texture to be inspected. + Novelty regions. + Handle of the texture inspection model. + + + Add training images to the texture inspection model. + Image of flawless texture. + Handle of the texture inspection model. + Indices of the images that have been added to the texture inspection model. + + + + Inspection of the texture within an image. + Modified instance represents: Handle of the inspection results. + + Image of the texture to be inspected. + Handle of the texture inspection model. + Novelty regions. + + + Clear a texture inspection result handle and free the allocated memory. + Handle of the texture inspection results. + + + + Clear a texture inspection result handle and free the allocated memory. + Instance represents: Handle of the texture inspection results. + + + + Get the training images contained in a texture inspection model. + Handle of the texture inspection model. + Training images contained in the texture inspection model. + + + + Query iconic results of a texture inspection. + Instance represents: Handle of the texture inspection result. + + Name of the iconic object to be returned. Default: "novelty_region" + Returned iconic object. + + + + Query iconic results of a texture inspection. + Instance represents: Handle of the texture inspection result. + + Name of the iconic object to be returned. Default: "novelty_region" + Returned iconic object. + + + Train a texture inspection model. + Handle of the texture inspection model. + + + Represents an instance of a variation model. + + + + Read a variation model from a file. + Modified instance represents: ID of the variation model. + + File name. + + + + Create a variation model for image comparison. + Modified instance represents: ID of the variation model. + + Width of the images to be compared. Default: 640 + Height of the images to be compared. Default: 480 + Type of the images to be compared. Default: "byte" + Method used for computing the variation model. Default: "standard" + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + + Deserialize a variation model. + Modified instance represents: ID of the variation model. + + Handle of the serialized item. + + + + Serialize a variation model. + Instance represents: ID of the variation model. + + Handle of the serialized item. + + + + Read a variation model from a file. + Modified instance represents: ID of the variation model. + + File name. + + + + Write a variation model to a file. + Instance represents: ID of the variation model. + + File name. + + + + Return the threshold images used for image comparison by a variation model. + Instance represents: ID of the variation model. + + Threshold image for the upper threshold. + Threshold image for the lower threshold. + + + + Return the images used for image comparison by a variation model. + Instance represents: ID of the variation model. + + Variation image of the trained object. + Image of the trained object. + + + + Compare an image to a variation model. + Instance represents: ID of the variation model. + + Image of the object to be compared. + Method used for comparing the variation model. Default: "absolute" + Region containing the points that differ substantially from the model. + + + + Compare an image to a variation model. + Instance represents: ID of the variation model. + + Image of the object to be compared. + Region containing the points that differ substantially from the model. + + + + Prepare a variation model for comparison with an image. + Instance represents: ID of the variation model. + + Reference image of the object. + Variation image of the object. + Absolute minimum threshold for the differences between the image and the variation model. Default: 10 + Threshold for the differences based on the variation of the variation model. Default: 2 + + + + Prepare a variation model for comparison with an image. + Instance represents: ID of the variation model. + + Reference image of the object. + Variation image of the object. + Absolute minimum threshold for the differences between the image and the variation model. Default: 10 + Threshold for the differences based on the variation of the variation model. Default: 2 + + + + Prepare a variation model for comparison with an image. + Instance represents: ID of the variation model. + + Absolute minimum threshold for the differences between the image and the variation model. Default: 10 + Threshold for the differences based on the variation of the variation model. Default: 2 + + + + Prepare a variation model for comparison with an image. + Instance represents: ID of the variation model. + + Absolute minimum threshold for the differences between the image and the variation model. Default: 10 + Threshold for the differences based on the variation of the variation model. Default: 2 + + + + Train a variation model. + Instance represents: ID of the variation model. + + Images of the object to be trained. + + + + Free the memory of a variation model. + Instance represents: ID of the variation model. + + + + + Free the memory of the training data of a variation model. + Instance represents: ID of the variation model. + + + + + Create a variation model for image comparison. + Modified instance represents: ID of the variation model. + + Width of the images to be compared. Default: 640 + Height of the images to be compared. Default: 480 + Type of the images to be compared. Default: "byte" + Method used for computing the variation model. Default: "standard" + + + Provides tuple functionality. + + The class HTuple represents HALCON tuples (control parameter values) + + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + + Compute the union set of two input tuples. + Instance represents: Input tuple. + + Input tuple. + The union set of two input tuples. + + + + Compute the intersection set of two input tuples. + Instance represents: Input tuple. + + Input tuple. + The intersection set of two input tuples. + + + + Compute the difference set of two input tuples. + Instance represents: Input tuple. + + Input tuple. + The difference set of two input tuples. + + + + Compute the symmetric difference set of two input tuples. + Instance represents: Input tuple. + + Input tuple. + The symmetric difference set of two input tuples. + + + + Test whether the types of the elements of a tuple are of type string. + Instance represents: Input tuple. + + Are the elements of the input tuple of type string? + + + + Test whether the types of the elements of a tuple are of type real. + Instance represents: Input tuple. + + Are the elements of the input tuple of type real? + + + + Test whether the types of the elements of a tuple are of type integer. + Instance represents: Input tuple. + + Are the elements of the input tuple of type integer? + + + + Return the types of the elements of a tuple. + Instance represents: Input tuple. + + Types of the elements of the input tuple as integer values. + + + + Test whether a tuple is of type mixed. + Instance represents: Input tuple. + + Is the input tuple of type mixed? + + + + Test if the internal representation of a tuple is of type string. + Instance represents: Input tuple. + + Is the input tuple of type string? + + + + Test if the internal representation of a tuple is of type real. + Instance represents: Input tuple. + + Is the input tuple of type real? + + + + Test if the internal representation of a tuple is of type integer. + Instance represents: Input tuple. + + Is the input tuple of type integer? + + + + Return the type of a tuple. + Instance represents: Input tuple. + + Type of the input tuple as an integer number. + + + + Calculate the value distribution of a tuple within a certain value range. + Instance represents: Input tuple. + + Minimum value. + Maximum value. + Number of bins. + Bin size. + Histogram to be calculated. + + + + Select tuple elements matching a regular expression. + Instance represents: Input strings to match. + + Regular expression. Default: ".*" + Matching strings + + + + Test if a string matches a regular expression. + Instance represents: Input strings to match. + + Regular expression. Default: ".*" + Number of matching strings + + + + Replace a substring using regular expressions. + Instance represents: Input strings to process. + + Regular expression. Default: ".*" + Replacement expression. + Processed strings. + + + + Extract substrings using regular expressions. + Instance represents: Input strings to match. + + Regular expression. Default: ".*" + Found matches. + + + Return a tuple of random numbers between 0 and 1. + Length of tuple to generate. + Tuple of random numbers. + + + + Return the number of elements of a tuple. + Instance represents: Input tuple. + + Number of elements of input tuple. + + + + Calculate the sign of a tuple. + Instance represents: Input tuple. + + Signs of the input tuple as integer numbers. + + + + Calculate the elementwise maximum of two tuples. + Instance represents: Input tuple 1. + + Input tuple 2. + Elementwise maximum of the input tuples. + + + + Calculate the elementwise minimum of two tuples. + Instance represents: Input tuple 1. + + Input tuple 2. + Elementwise minimum of the input tuples. + + + + Return the maximal element of a tuple. + Instance represents: Input tuple. + + Maximal element of the input tuple elements. + + + + Return the minimal element of a tuple. + Instance represents: Input tuple. + + Minimal element of the input tuple elements. + + + + Calculate the cumulative sums of a tuple. + Instance represents: Input tuple. + + Cumulative sum of the corresponding tuple elements. + + + + Select the element of rank n of a tuple. + Instance represents: Input tuple. + + Rank of the element to select. + Selected tuple element. + + + + Return the median of the elements of a tuple. + Instance represents: Input tuple. + + Median of the tuple elements. + + + + Return the sum of all elements of a tuple. + Instance represents: Input tuple. + + Sum of tuple elements. + + + + Return the mean value of a tuple of numbers. + Instance represents: Input tuple. + + Mean value of tuple elements. + + + + Return the standard deviation of the elements of a tuple. + Instance represents: Input tuple. + + Standard deviation of tuple elements. + + + + Discard all but one of successive identical elements of a tuple. + Instance represents: Input tuple. + + Tuple without successive identical elements. + + + + Return the index of the last occurrence of a tuple within another tuple. + Instance represents: Input tuple to examine. + + Input tuple with values to find. + Index of the last occurrence of the values to find. + + + + Return the index of the first occurrence of a tuple within another tuple. + Instance represents: Input tuple to examine. + + Input tuple with values to find. + Index of the first occurrence of the values to find. + + + + Return the indices of all occurrences of a tuple within another tuple. + Instance represents: Input tuple to examine. + + Input tuple with values to find. + Indices of the occurrences of the values to find in the tuple to examine. + + + + Sort the elements of a tuple and return the indices of the sorted tuple. + Instance represents: Input tuple. + + Sorted tuple. + + + + Sort the elements of a tuple in ascending order. + Instance represents: Input tuple. + + Sorted tuple. + + + + Invert a tuple. + Instance represents: Input tuple. + + Inverted input tuple. + + + + Concatenate two tuples to a new one. + Instance represents: Input tuple 1. + + Input tuple 2. + Concatenation of input tuples. + + + + Select several elements of a tuple. + Instance represents: Input tuple. + + Index of first element to select. + Index of last element to select. + Selected tuple elements. + + + + Select all elements from index "n" to the end of a tuple. + Instance represents: Input tuple. + + Index of the first element to select. + Selected tuple elements. + + + + Select the first elements of a tuple up to the index "n". + Instance represents: Input tuple. + + Index of the last element to select. + Selected tuple elements. + + + + Inserts one or more elements into a tuple at index. + Instance represents: Input tuple. + + Start index of elements to be inserted. + Element(s) to insert at index. + Tuple with inserted elements. + + + + Replaces one or more elements of a tuple. + Instance represents: Input tuple. + + Index/Indices of elements to be replaced. + Element(s) to replace. + Tuple with replaced elements. + + + + Remove elements from a tuple. + Instance represents: Input tuple. + + Indices of the elements to remove. + Reduced tuple. + + + + Select in mask specified elements of a tuple. + Instance represents: Input tuple. + + greater than 0 specifies the elements to select. + Selected tuple elements. + + + + Select single elements of a tuple. + Instance represents: Input tuple. + + Indices of the elements to select. + Selected tuple element. + + + + Select single character or bit from a tuple. + Instance represents: Input tuple. + + Position of character or bit to select. + Tuple containing the selected characters and bits. + + + Generate a tuple with a sequence of equidistant values. + Start value of the tuple. + Maximum value for the last entry. + Increment value. + The resulting sequence. + + + Generate a tuple of a specific length and initialize its elements. + Length of tuple to generate. + Constant for initializing the tuple elements. + New Tuple. + + + + Read one or more environment variables. + Instance represents: Tuple containing name(s) of the environment variable(s). + + Content of the environment variable(s). + + + + Split strings into substrings using predefined separator symbol(s). + Instance represents: Input tuple with string(s) to split. + + Input tuple with separator symbol(s). + Substrings after splitting the input strings. + + + + Cut characters from position "n1" through "n2" out of a string tuple. + Instance represents: Input tuple with string(s) to examine. + + Input tuple with start position(s) "n1". + Input tuple with end position(s) "n2". + Characters of the string(s) from position "n1" to "n2". + + + + Cut all characters starting at position "n" out of a string tuple. + Instance represents: Input tuple with string(s) to examine. + + Input tuple with position(s) "n". + The last characters of the string(s) starting at position "n". + + + + Cut the first characters up to position "n" out of a string tuple. + Instance represents: Input tuple with string(s) to examine. + + Input tuple with position(s) "n". + The first characters of the string(s) up to position "n". + + + + Backward search for characters within a string tuple. + Instance represents: Input tuple with string(s) to examine. + + Input tuple with character(s) to search. + Position of searched character(s) within the string(s). + + + + Forward search for characters within a string tuple. + Instance represents: Input tuple with string(s) to examine. + + Input tuple with character(s) to search. + Position of searched character(s) within the string(s). + + + + Backward search for strings within a string tuple. + Instance represents: Input tuple with string(s) to examine. + + Input tuple with string(s) to search. + Position of searched string(s) within the examined string(s). + + + + Forward search for strings within a string tuple. + Instance represents: Input tuple with string(s) to examine. + + Input tuple with string(s) to search. + Position of searched string(s) within the examined string(s). + + + + Determine the length of every string within a tuple of strings. + Instance represents: Input tuple. + + Lengths of the single strings of the input tuple. + + + + Test, whether a tuple is elementwise less or equal to another tuple. + Instance represents: Input tuple 1. + + Input tuple 2. + Result of the comparison of the input tuples. + + + + Test, whether a tuple is elementwise less than another tuple. + Instance represents: Input tuple 1. + + Input tuple 2. + Result of the comparison of the input tuples. + + + + Test, whether a tuple is elementwise greater or equal to another tuple. + Instance represents: Input tuple 1. + + Input tuple 2. + Result of the comparison of the input tuples. + + + + Test, whether a tuple is elementwise greater than another tuple. + Instance represents: Input tuple 1. + + Input tuple 2. + Result of the comparison of the input tuples. + + + + Test, whether two tuples are elementwise not equal. + Instance represents: Input tuple 1. + + Input tuple 2. + Result of the comparison of the input tuples. + + + + Test, whether two tuples are elementwise equal. + Instance represents: Input tuple 1. + + Input tuple 2. + Result of the comparison of the input tuples. + + + + Test whether a tuple is less or equal to another tuple. + Instance represents: Input tuple 1. + + Input tuple 2. + Result of the comparison of the input tuples. + + + + Test whether a tuple is less than another tuple. + Instance represents: Input tuple 1. + + Input tuple 2. + Result of the comparison of the input tuples. + + + + Test whether a tuple is greater or equal to another tuple. + Instance represents: Input tuple 1. + + Input tuple 2. + Result of the comparison of the input tuples. + + + + Test whether a tuple is greater than another tuple. + Instance represents: Input tuple 1. + + Input tuple 2. + Result of the comparison of the input tuples. + + + + Test whether two tuples are not equal. + Instance represents: Input tuple 1. + + Input tuple 2. + Result of the comparison of the input tuples. + + + + Test whether two tuples are equal. + Instance represents: Input tuple 1. + + Input tuple 2. + Result of the comparison of the input tuples. + + + + Compute the logical not of a tuple. + Instance represents: Input tuple. + + Binary not of the input tuple. + + + + Compute the logical exclusive or of two tuples. + Instance represents: Input tuple 1. + + Input tuple 2. + Binary exclusive or of the input tuples. + + + + Compute the logical or of two tuples. + Instance represents: Input tuple 1. + + Input tuple 2. + Logical or of the input tuples. + + + + Compute the logical and of two tuples. + Instance represents: Input tuple 1. + + Input tuple 2. + Logical and of the input tuples. + + + + Compute the bitwise not of a tuple. + Instance represents: Input tuple. + + Binary not of the input tuple. + + + + Compute the bitwise exclusive or of two tuples. + Instance represents: Input tuple 1. + + Input tuple 2. + Binary exclusive or of the input tuples. + + + + Compute the bitwise or of two tuples. + Instance represents: Input tuple 1. + + Input tuple 2. + Binary or of the input tuples. + + + + Compute the bitwise and of two tuples. + Instance represents: Input tuple 1. + + Input tuple 2. + Binary and of the input tuples. + + + + Shift a tuple bitwise to the right. + Instance represents: Input tuple. + + Number of places to shift the input tuple. + Shifted input tuple. + + + + Shift a tuple bitwise to the left. + Instance represents: Input tuple. + + Number of places to shift the input tuple. + Shifted input tuple. + + + + Convert a tuple of integer numbers into strings. + Instance represents: Input tuple with integer numbers. + + Output tuple with strings that are separated by the number 0. + + + + Convert a tuple of strings into a tuple of integer numbers. + Instance represents: Input tuple with strings. + + Output tuple with the Unicode character codes or ANSI codes of the input string. + + + + Convert a tuple of integer numbers into strings. + Instance represents: Input tuple with Unicode character codes or ANSI codes. + + Output tuple with strings built from the character codes in the input tuple. + + + + Convert a tuple of strings of length 1 into a tuple of integer numbers. + Instance represents: Input tuple with strings of length 1. + + Output tuple with Unicode character codes or ANSI codes of the characters passed in the input tuple. + + + + Convert a tuple into a tuple of strings. + Instance represents: Input tuple. + + Format string. + Input tuple converted to strings. + + + + Check a tuple (of strings) whether it represents numbers. + Instance represents: Input tuple. + + Tuple with boolean numbers. + + + + Convert a tuple (of strings) into a tuple of numbers. + Instance represents: Input tuple. + + Input tuple as numbers. + + + + Convert a tuple into a tuple of integer numbers. + Instance represents: Input tuple. + + Result of the rounding. + + + + Convert a tuple into a tuple of integer numbers. + Instance represents: Input tuple. + + Result of the conversion into integer numbers. + + + + Convert a tuple into a tuple of floating point numbers. + Instance represents: Input tuple. + + Input tuple as floating point numbers. + + + + Calculate the ldexp function of two tuples. + Instance represents: Input tuple 1. + + Input tuple 2. + Ldexp function of the input tuples. + + + + Calculate the remainder of the floating point division of two tuples. + Instance represents: Input tuple 1. + + Input tuple 2. + Remainder of the division of the input tuples. + + + + Calculate the remainder of the integer division of two tuples. + Instance represents: Input tuple 1. + + Input tuple 2. + Remainder of the division of the input tuples. + + + + Compute the ceiling function of a tuple. + Instance represents: Input tuple. + + Ceiling function of the input tuple. + + + + Compute the floor function of a tuple. + Instance represents: Input tuple. + + Floor function of the input tuple. + + + + Calculate the power function of two tuples. + Instance represents: Input tuple 1. + + Input tuple 2. + Power function of the input tuples. + + + + Compute the base 10 logarithm of a tuple. + Instance represents: Input tuple. + + Base 10 logarithm of the input tuple. + + + + Compute the natural logarithm of a tuple. + Instance represents: Input tuple. + + Natural logarithm of the input tuple. + + + + Compute the exponential of a tuple. + Instance represents: Input tuple. + + Exponential of the input tuple. + + + + Compute the hyperbolic tangent of a tuple. + Instance represents: Input tuple. + + Hyperbolic tangent of the input tuple. + + + + Compute the hyperbolic cosine of a tuple. + Instance represents: Input tuple. + + Hyperbolic cosine of the input tuple. + + + + Compute the hyperbolic sine of a tuple. + Instance represents: Input tuple. + + Hyperbolic sine of the input tuple. + + + + Convert a tuple from degrees to radians. + Instance represents: Input tuple. + + Input tuple in radians. + + + + Convert a tuple from radians to degrees. + Instance represents: Input tuple. + + Input tuple in degrees. + + + + Compute the arctangent of a tuple for all four quadrants. + Instance represents: Input tuple of the y-values. + + Input tuple of the x-values. + Arctangent of the input tuple. + + + + Compute the arctangent of a tuple. + Instance represents: Input tuple. + + Arctangent of the input tuple. + + + + Compute the arccosine of a tuple. + Instance represents: Input tuple. + + Arccosine of the input tuple. + + + + Compute the arcsine of a tuple. + Instance represents: Input tuple. + + Arcsine of the input tuple. + + + + Compute the tangent of a tuple. + Instance represents: Input tuple. + + Tangent of the input tuple. + + + + Compute the cosine of a tuple. + Instance represents: Input tuple. + + Cosine of the input tuple. + + + + Compute the sine of a tuple. + Instance represents: Input tuple. + + Sine of the input tuple. + + + + Compute the absolute value of a tuple (as floating point numbers). + Instance represents: Input tuple. + + Absolute value of the input tuple. + + + + Compute the square root of a tuple. + Instance represents: Input tuple. + + Square root of the input tuple. + + + + Compute the absolute value of a tuple. + Instance represents: Input tuple. + + Absolute value of the input tuple. + + + + Negate a tuple. + Instance represents: Input tuple. + + Negation of the input tuple. + + + + Divide two tuples. + Instance represents: Input tuple 1. + + Input tuple 2. + Quotient of the input tuples. + + + + Multiply two tuples. + Instance represents: Input tuple 1. + + Input tuple 2. + Product of the input tuples. + + + + Subtract two tuples. + Instance represents: Input tuple 1. + + Input tuple 2. + Difference of the input tuples. + + + + Add two tuples. + Instance represents: Input tuple 1. + + Input tuple 2. + Sum of the input tuples. + + + Deserialize a serialized tuple. + Handle of the serialized item. + Tuple. + + + + Serialize a tuple. + Instance represents: Tuple. + + Handle of the serialized item. + + + + Write a tuple to a file. + Instance represents: Tuple with any kind of data. + + Name of the file to be written. + + + Read a tuple from a file. + Name of the file to be read. + Tuple with any kind of data. + + + + Clear the content of a handle. + Instance represents: Handle to clear. + + + + + Test if the internal representation of a tuple is of type handle. + Instance represents: Input tuple. + + Boolean value indicating if the input tuple is of type handle. + + + + Test whether the elements of a tuple are of type handle. + Instance represents: Input tuple. + + Boolean values indicating if the elements of the input tuple are of type handle. + + + + Test if a tuple is serializable. + Instance represents: Tuple to check for serializability. + + Boolean value indicating if the input can be serialized. + + + + Test if the elements of a tuple are serializable. + Instance represents: Tuple to check for serializability. + + Boolean value indicating if the input elements can be serialized. + + + + Check if a handle is valid. + Instance represents: The handle to check for validity. + + The validity of the handle, 1 or 0. + + + + Return the semantic type of a tuple. + Instance represents: Input tuple. + + Semantic type of the input tuple as a string. + + + + Return the semantic type of the elements of a tuple. + Instance represents: Input tuple. + + Semantic types of the elements of the input tuple as strings. + + + Create an empty tuple + + + Create tuple containing integer value 0 (false) or 1 (true) + + + Create a tuple containing a single 32-bit integer value + + + Create a tuple containing 32-bit integer values + + + Create a tuple containing a single 64-bit integer value + + + Create a tuple containing 64-bit integer values + + + + Create an integer tuple representing a pointer value. + The used integer size depends on the executing platform. + + + + + Create an integer tuple representing pointer values. + The used integer size depends on the executing platform. + + + + Create a tuple containing a single double value + + + Create a tuple containing double values + + + Create a tuple containing a single double value + + + Create a tuple containing double values + + + Create a tuple containing a single string value + + + Create a tuple containing string values + + + Create a tuple containing a single handle value + + + Create a tuple containing handle values + + + + Create a tuple containing mixed values. + Only integer, double and string values are valid. + + + + Create a copy of an existing tuple + + + Create a concatenation of existing tuples + + + + Dispose all handles that are stored in the tuple. For tuples + without handles calling this method has no effect. + Used and overwritte by HTupleMixed and HTupleHandle + + + + + Unpins the tuple's data. Notice that PinTuple happens in Store(..). + + + + + Get the data of this tuple as a 32-bit integer array. + The tuple may only contain integer data (32-bit or 64-bit). + + + + + Get the data of this tuple as a 64-bit integer array. + The tuple may only contain integer data (32-bit or 64-bit). + + + + + Get the data of this tuple as a double array. + The tuple may only contain numeric data. + + + + + Get the data of this tuple as a string array. + The tuple may only contain string values. + + + + + Get the data of this tuple as a handle array. + The tuple may only contain handle values. The + array contains copies of handles that need to + be disposed. + + + + + Get the data of this tuple as an object array. + The tuple may contain arbitrary values. + + + + + Get the data of this tuple as a float array. + The tuple may only contain numeric data. + + + + + Get the data of this tuple as an IntPtr array. + The tuple may only contain integer data matching IntPtr.Size. + + + + Convert first element of a tuple to bool + + + Convert first element of a tuple to int + + + Convert first element of a tuple to long + + + Convert first element of a tuple to double + + + Convert first element of a tuple to string + + + Convert first element of a tuple to IntPtr + + + Convert all elements of a tuple to int[] + + + Convert all elements of a tuple to long[] + + + Convert all elements of a tuple to double[] + + + Convert all elements of a tuple to string[] + + + Convert all elements of a tuple to HHandle[] + + + Convert all elements of a tuple to IntPtr[] + + + + Provides a simple string representation of the tuple, + which is mainly useful for debug outputs. + + + Casting a HTuple to a string does *not* invoke ToString(), as the + former represents an implicit access to tuple.S == tuple[0].S, which + is only legal if the first tuple element is a string. + + + + + Append tuple to this tuple + + Data to append. + + + + Returns the number of elements of a tuple. + Instance represents: Input tuple. + + Number of elements of input tuple. + + + + Add two tuples. + Instance represents: Input tuple 1. + + Input tuple 2. + Sum of the input tuples. + + + + Subtract two tuples. + Instance represents: Input tuple 1. + + Input tuple 2. + Difference of the input tuples. + + + + Multiply two tuples. + Instance represents: Input tuple 1. + + Input tuple 2. + Product of the input tuples. + + + + Concatenate multiple tuples to a new one. + Instance represents: Input tuple 1. + + Further input tuples. + Concatenation of input tuples. + + + + Concatenate two tuple to a new one. + Instance represents: Input tuple 1. + + Input tuple 2. + Concatentaion of input tuples. + + + Get the data type of this tuple + + + Get the length of this tuple + + + + Provides access to tuple elements at the specified indices + + + + + Provides access to the tuple element at the specified index + + + + + Provides access to the tuple element at the specified index + + + + + Exposes the internal array representation to allow most efficient + (but not safest) access. Tuple type must be HTupleType.INTEGER. + The array length may be greater than the used tuple length. + + + + + Exposes the internal array representation to allow most efficient + (but not safest) access. Tuple type must be HTupleType.LONG. + The array length may be greater than the used tuple length. + + + + + Exposes the internal array representation to allow most efficient + (but not safest) access. Tuple type must be HTupleType.DOUBLE. + The array length may be greater than the used tuple length. + + + + + Exposes the internal array representation to allow most efficient + (but not safest) access. Tuple type must be HTupleType.STRING. + The array length may be greater than the used tuple length. + + + + + Exposes the internal array representation to allow most efficient + (but not safest) access. Tuple type must be HTupleType.HANDLE. + The array length may be greater than the used tuple length. + + + + + Exposes the internal array representation to allow most efficient + (but not safest) access. Tuple type must be HTupleType.MIXED. It is + not recommended to modify the array. If you do make sure to only + store supported element types int, long, double, string and HHandle. + The array length may be greater than the used tuple length. + + + + Convenience accessor for tuple[0].I + + + Convenience accessor for tuple[0].L + + + Convenience accessor for tuple[0].D + + + Convenience accessor for tuple[0].S + + + Convenience accessor for tuple[0].H + + + Convenience accessor for tuple[0].H + + + Convenience accessor for tuple[0].IP + + + Represents an instance of a HALCON window. + + + + Open a graphics window. + Modified instance represents: Window handle. + + Row index of upper left corner. Default: 0 + Column index of upper left corner. Default: 0 + Width of the window. Default: 256 + Height of the window. Default: 256 + Logical number of the father window. To specify the display as father you may enter 'root' or 0. Default: 0 + Window mode. Default: "visible" + Name of the computer on which you want to open the window. Otherwise the empty string. Default: "" + + + + Open a graphics window. + Modified instance represents: Window handle. + + Row index of upper left corner. Default: 0 + Column index of upper left corner. Default: 0 + Width of the window. Default: 256 + Height of the window. Default: 256 + Logical number of the father window. To specify the display as father you may enter 'root' or 0. Default: 0 + Window mode. Default: "visible" + Name of the computer on which you want to open the window. Otherwise the empty string. Default: "" + + + + Display an XLD object. + Instance represents: Window handle. + + XLD object to display. + + + + Gets a copy of the background image of the HALCON window. + Instance represents: Window handle. + + Copy of the background image. + + + + Detach the background image from a HALCON window. + Instance represents: Window handle. + + + + + Attach a background image to a HALCON window. + Instance represents: Window handle. + + Background image. + + + + Detach an existing drawing object from a HALCON window. + Instance represents: Window Handle. + + Handle of the drawing object. + + + + Attach an existing drawing object to a HALCON window. + Instance represents: Window handle. + + Handle of the drawing object. + + + + Modify the pose of a 3D plot. + Instance represents: Window handle. + + Row coordinate of the first point. + Column coordinate of the first point. + Row coordinate of the second point. + Column coordinate of the second point. + Navigation mode. Default: "rotate" + + + + Modify the pose of a 3D plot. + Instance represents: Window handle. + + Row coordinate of the first point. + Column coordinate of the first point. + Row coordinate of the second point. + Column coordinate of the second point. + Navigation mode. Default: "rotate" + + + + Calculates image coordinates for a point in a 3D plot window. + Instance represents: Window handle. + + Displayed image. + Row coordinate in the window. + Column coordinate in the window. + Row coordinate in the image. + Column coordinate in the image. + Height value. + + + + Calculates image coordinates for a point in a 3D plot window. + Instance represents: Window handle. + + Displayed image. + Row coordinate in the window. + Column coordinate in the window. + Row coordinate in the image. + Column coordinate in the image. + Height value. + + + + Get the operating system window handle. + Instance represents: Window handle. + + Operating system display handle (under Unix-like systems only). + Operating system window handle. + + + + Set the device context of a virtual graphics window (Windows NT). + Instance represents: Window handle. + + device context of WINHWnd. + + + + Create a virtual graphics window under Windows. + Modified instance represents: Window handle. + + Windows window handle of a previously created window. + Row coordinate of upper left corner. Default: 0 + Column coordinate of upper left corner. Default: 0 + Width of the window. Default: 512 + Height of the window. Default: 512 + + + + Interactive output from two window buffers. + Instance represents: Source window handle of the "`upper window"'. + + Source window handle of the "`lower window"'. + Output window handle. + + + + Modify position and size of a window. + Instance represents: Window handle. + + Row index of upper left corner in target position. Default: 0 + Column index of upper left corner in target position. Default: 0 + Width of the window. Default: 512 + Height of the window. Default: 512 + + + + Open a graphics window. + Modified instance represents: Window handle. + + Row index of upper left corner. Default: 0 + Column index of upper left corner. Default: 0 + Width of the window. Default: 256 + Height of the window. Default: 256 + Logical number of the father window. To specify the display as father you may enter 'root' or 0. Default: 0 + Window mode. Default: "visible" + Name of the computer on which you want to open the window. Otherwise the empty string. Default: "" + + + + Open a graphics window. + Modified instance represents: Window handle. + + Row index of upper left corner. Default: 0 + Column index of upper left corner. Default: 0 + Width of the window. Default: 256 + Height of the window. Default: 256 + Logical number of the father window. To specify the display as father you may enter 'root' or 0. Default: 0 + Window mode. Default: "visible" + Name of the computer on which you want to open the window. Otherwise the empty string. Default: "" + + + + Open a textual window. + Modified instance represents: Window handle. + + Row index of upper left corner. Default: 0 + Column index of upper left corner. Default: 0 + Window's width. Default: 256 + Window's height. Default: 256 + Window border's width. Default: 2 + Window border's color. Default: "white" + Background color. Default: "black" + Logical number of the father window. For the display as father you may specify 'root' or 0. Default: 0 + Window mode. Default: "visible" + Computer name, where the window has to be opened or empty string. Default: "" + + + + Open a textual window. + Modified instance represents: Window handle. + + Row index of upper left corner. Default: 0 + Column index of upper left corner. Default: 0 + Window's width. Default: 256 + Window's height. Default: 256 + Window border's width. Default: 2 + Window border's color. Default: "white" + Background color. Default: "black" + Logical number of the father window. For the display as father you may specify 'root' or 0. Default: 0 + Window mode. Default: "visible" + Computer name, where the window has to be opened or empty string. Default: "" + + + + Copy inside an output window. + Instance represents: Window handle. + + Row index of upper left corner of the source rectangle. Default: 0 + Column index of upper left corner of the source rectangle. Default: 0 + Row index of lower right corner of the source rectangle. Default: 64 + Column index of lower right corner of the source rectangle. Default: 64 + Row index of upper left corner of the target position. Default: 64 + Column index of upper left corner of the target position. Default: 64 + + + + Copy inside an output window. + Instance represents: Window handle. + + Row index of upper left corner of the source rectangle. Default: 0 + Column index of upper left corner of the source rectangle. Default: 0 + Row index of lower right corner of the source rectangle. Default: 64 + Column index of lower right corner of the source rectangle. Default: 64 + Row index of upper left corner of the target position. Default: 64 + Column index of upper left corner of the target position. Default: 64 + + + + Get the window type. + Instance represents: Window handle. + + Window type + + + + Access to a window's pixel data. + Instance represents: Window handle. + + Pointer on red channel of pixel data. + Pointer on green channel of pixel data. + Pointer on blue channel of pixel data. + Length of an image line. + Number of image lines. + + + + Information about a window's size and position. + Instance represents: Window handle. + + Row index of upper left corner of the window. + Column index of upper left corner of the window. + Window width. + Window height. + + + + Write the window content in an image object. + Instance represents: Window handle. + + Saved image. + + + + Write the window content to a file. + Instance represents: Window handle. + + Name of the target device or of the graphic format. Default: "postscript" + File name (without extension). Default: "halcon_dump" + + + + Write the window content to a file. + Instance represents: Window handle. + + Name of the target device or of the graphic format. Default: "postscript" + File name (without extension). Default: "halcon_dump" + + + + Copy all pixels within rectangles between output windows. + Instance represents: Source window handle. + + Destination window handle. + Row index of upper left corner in the source window. Default: 0 + Column index of upper left corner in the source window. Default: 0 + Row index of lower right corner in the source window. Default: 128 + Column index of lower right corner in the source window. Default: 128 + Row index of upper left corner in the target window. Default: 0 + Column index of upper left corner in the target window. Default: 0 + + + + Copy all pixels within rectangles between output windows. + Instance represents: Source window handle. + + Destination window handle. + Row index of upper left corner in the source window. Default: 0 + Column index of upper left corner in the source window. Default: 0 + Row index of lower right corner in the source window. Default: 128 + Column index of lower right corner in the source window. Default: 128 + Row index of upper left corner in the target window. Default: 0 + Column index of upper left corner in the target window. Default: 0 + + + Close an output window. + Window handle. + + + + Close an output window. + Instance represents: Window handle. + + + + + Delete the contents of an output window. + Instance represents: Window handle. + + + + + Delete a rectangle on the output window. + Instance represents: Window handle. + + Line index of upper left corner. Default: 10 + Column index of upper left corner. Default: 10 + Row index of lower right corner. Default: 118 + Column index of lower right corner. Default: 118 + + + + Delete a rectangle on the output window. + Instance represents: Window handle. + + Line index of upper left corner. Default: 10 + Column index of upper left corner. Default: 10 + Row index of lower right corner. Default: 118 + Column index of lower right corner. Default: 118 + + + + Print text in a window. + Instance represents: Window handle. + + Tuple of output values (all types). Default: "hello" + + + + Print text in a window. + Instance represents: Window handle. + + Tuple of output values (all types). Default: "hello" + + + + Set the shape of the text cursor. + Instance represents: Window handle. + + Name of cursor shape. Default: "invisible" + + + + Set the position of the text cursor. + Instance represents: Window handle. + + Row index of text cursor position. Default: 24 + Column index of text cursor position. Default: 12 + + + + Read a string in a text window. + Instance represents: Window handle. + + Default string (visible before input). Default: "" + Maximum number of characters. Default: 32 + Read string. + + + + Read a character from a text window. + Instance represents: Window handle. + + Code for input character. + Input character (if it is not a control character). + + + + Set the position of the text cursor to the beginning of the next line. + Instance represents: Window handle. + + + + + Get the shape of the text cursor. + Instance represents: Window handle. + + Name of the current text cursor. + + + + Get cursor position. + Instance represents: Window handle. + + Row index of text cursor position. + Column index of text cursor position. + + + + Get the maximum size of all characters of a font. + Instance represents: Window handle. + + Maximum extension below baseline. + Maximum character width. + Maximum character height. + Maximum height above baseline. + + + + Get the maximum size of all characters of a font. + Instance represents: Window handle. + + Maximum extension below baseline. + Maximum character width. + Maximum character height. + Maximum height above baseline. + + + + Get the spatial size of a string. + Instance represents: Window handle. + + Values to consider. Default: "test_string" + Maximum extension below baseline. + Text width. + Text height. + Maximum height above baseline. + + + + Get the spatial size of a string. + Instance represents: Window handle. + + Values to consider. Default: "test_string" + Maximum extension below baseline. + Text width. + Text height. + Maximum height above baseline. + + + + Query the available fonts. + Instance represents: Window handle. + + Tuple with available font names. + + + + Query all shapes available for text cursors. + Instance represents: Window handle. + + Names of the available text cursors. + + + + Set the font used for text output. + Instance represents: Window handle. + + Name of new font. + + + + Get the current font. + Instance represents: Window handle. + + Name of the current font. + + + + Get window parameters. + Instance represents: Window handle. + + Name of the parameter. Default: "flush" + Value of the parameter. + + + + Set window parameters. + Instance represents: Window handle. + + Name of the parameter. Default: "flush" + Value to be set. Default: "false" + + + + Set window parameters. + Instance represents: Window handle. + + Name of the parameter. Default: "flush" + Value to be set. Default: "false" + + + + Define the region output shape. + Instance represents: Window handle. + + Region output mode. Default: "original" + + + + Set the color definition via RGB values. + Instance represents: Window handle. + + Red component of the color. Default: 255 + Green component of the color. Default: 0 + Blue component of the color. Default: 0 + + + + Set the color definition via RGB values. + Instance represents: Window handle. + + Red component of the color. Default: 255 + Green component of the color. Default: 0 + Blue component of the color. Default: 0 + + + + Define a color lookup table index. + Instance represents: Window handle. + + Color lookup table index. Default: 128 + + + + Define a color lookup table index. + Instance represents: Window handle. + + Color lookup table index. Default: 128 + + + + Define an interpolation method for gray value output. + Instance represents: Window handle. + + Interpolation method for image output: 0 (fast, low quality) to 2 (slow, high quality). Default: 0 + + + + Modify the displayed image part. + Instance represents: Window handle. + + Row of the upper left corner of the chosen image part. Default: 0 + Column of the upper left corner of the chosen image part. Default: 0 + Row of the lower right corner of the chosen image part. Default: -1 + Column of the lower right corner of the chosen image part. Default: -1 + + + + Modify the displayed image part. + Instance represents: Window handle. + + Row of the upper left corner of the chosen image part. Default: 0 + Column of the upper left corner of the chosen image part. Default: 0 + Row of the lower right corner of the chosen image part. Default: -1 + Column of the lower right corner of the chosen image part. Default: -1 + + + + Define the gray value output mode. + Instance represents: Window handle. + + Output mode. Additional parameters possible. Default: "default" + + + + Define the line width for region contour output. + Instance represents: Window handle. + + Line width for region output in contour mode. Default: 1.0 + + + + Define a contour output pattern. + Instance represents: Window handle. + + Contour pattern. Default: [] + + + + Define the approximation error for contour display. + Instance represents: Window handle. + + Maximum deviation from the original contour. Default: 0 + + + + Define the pixel output function. + Instance represents: Window handle. + + Name of the display function. Default: "copy" + + + + Define output colors (HSI-coded). + Instance represents: Window handle. + + Hue for region output. Default: 30 + Saturation for region output. Default: 255 + Intensity for region output. Default: 84 + + + + Define output colors (HSI-coded). + Instance represents: Window handle. + + Hue for region output. Default: 30 + Saturation for region output. Default: 255 + Intensity for region output. Default: 84 + + + + Define gray values for region output. + Instance represents: Window handle. + + Gray values for region output. Default: 255 + + + + Define gray values for region output. + Instance represents: Window handle. + + Gray values for region output. Default: 255 + + + + Define the region fill mode. + Instance represents: Window handle. + + Fill mode for region output. Default: "fill" + + + + Define the image matrix output clipping. + Instance represents: Window handle. + + Clipping mode for gray value output. Default: "object" + + + + Set multiple output colors. + Instance represents: Window handle. + + Number of output colors. Default: 12 + + + + Set output color. + Instance represents: Window handle. + + Output color names. Default: "white" + + + + Set output color. + Instance represents: Window handle. + + Output color names. Default: "white" + + + + Get the current region output shape. + Instance represents: Window handle. + + Current region output shape. + + + + Get the current color in RGB-coding. + Instance represents: Window handle. + + The current color's red value. + The current color's green value. + The current color's blue value. + + + + Get the current color lookup table index. + Instance represents: Window handle. + + Index of the current color look-up table. + + + + Get the current interpolation mode for gray value display. + Instance represents: Window handle. + + Interpolation mode for image display: 0 (fast, low quality) to 2 (slow, high quality). + + + + Get the image part. + Instance represents: Window handle. + + Row index of the image part's upper left corner. + Column index of the image part's upper left corner. + Row index of the image part's lower right corner. + Column index of the image part's lower right corner. + + + + Get the image part. + Instance represents: Window handle. + + Row index of the image part's upper left corner. + Column index of the image part's upper left corner. + Row index of the image part's lower right corner. + Column index of the image part's lower right corner. + + + + Get the current display mode for gray values. + Instance represents: Window handle. + + Name and parameter values of the current display mode. + + + + Get the current line width for contour display. + Instance represents: Window handle. + + Current line width for contour display. + + + + Get the current graphic mode for contours. + Instance represents: Window handle. + + Template for contour display. + + + + Get the current approximation error for contour display. + Instance represents: Window handle. + + Current approximation error for contour display. + + + + Get the current display mode. + Instance represents: Window handle. + + Display mode. + + + + Get the HSI coding of the current color. + Instance represents: Window handle. + + Saturation of the current color. + Intensity of the current color. + Hue (color value) of the current color. + + + + Get the current region fill mode. + Instance represents: Window handle. + + Current region fill mode. + + + + Query the gray value display modes. + Instance represents: Window handle. + + Gray value display mode names. + + + + Query the possible graphic modes. + Instance represents: Window handle. + + Display function name. + + + + Query the displayable gray values. + Instance represents: Window handle. + + Tuple of all displayable gray values. + + + + Query all color names. + Instance represents: Window handle. + + Color names. + + + + Query all color names displayable in the window. + Instance represents: Window handle. + + Color names. + + + + Query the icon for region output + Instance represents: Window handle. + + Icon for the regions center of gravity. + + + + Icon definition for region output. + Instance represents: Window handle. + + Icon for center of gravity. + + + + Displays regions in a window. + Instance represents: Window handle. + + Regions to display. + + + + Displays arbitrarily oriented rectangles. + Instance represents: Window handle. + + Row index of the center. Default: 48 + Column index of the center. Default: 64 + Orientation of rectangle in radians. Default: 0.0 + Half of the length of the longer side. Default: 48 + Half of the length of the shorter side. Default: 32 + + + + Displays arbitrarily oriented rectangles. + Instance represents: Window handle. + + Row index of the center. Default: 48 + Column index of the center. Default: 64 + Orientation of rectangle in radians. Default: 0.0 + Half of the length of the longer side. Default: 48 + Half of the length of the shorter side. Default: 32 + + + + Display of rectangles aligned to the coordinate axes. + Instance represents: Window handle. + + Row index of the upper left corner. Default: 16 + Column index of the upper left corner. Default: 16 + Row index of the lower right corner. Default: 48 + Column index of the lower right corner. Default: 80 + + + + Display of rectangles aligned to the coordinate axes. + Instance represents: Window handle. + + Row index of the upper left corner. Default: 16 + Column index of the upper left corner. Default: 16 + Row index of the lower right corner. Default: 48 + Column index of the lower right corner. Default: 80 + + + + Displays a polyline. + Instance represents: Window handle. + + Row index Default: [16,80,80] + Column index Default: [48,16,80] + + + + Draws lines in a window. + Instance represents: Window handle. + + Row index of the start. Default: 32.0 + Column index of the start. Default: 32.0 + Row index of end. Default: 64.0 + Column index of end. Default: 64.0 + + + + Draws lines in a window. + Instance represents: Window handle. + + Row index of the start. Default: 32.0 + Column index of the start. Default: 32.0 + Row index of end. Default: 64.0 + Column index of end. Default: 64.0 + + + + Displays crosses in a window. + Instance represents: Window handle. + + Row coordinate of the center. Default: 32.0 + Column coordinate of the center. Default: 32.0 + Length of the bars. Default: 6.0 + Orientation. Default: 0.0 + + + + Displays crosses in a window. + Instance represents: Window handle. + + Row coordinate of the center. Default: 32.0 + Column coordinate of the center. Default: 32.0 + Length of the bars. Default: 6.0 + Orientation. Default: 0.0 + + + + Displays gray value images. + Instance represents: Window handle. + + Gray value image to display. + + + + Displays images with several channels. + Instance represents: Window handle. + + Multichannel images to be displayed. + Number of channel or the numbers of the RGB-channels Default: 1 + + + + Displays images with several channels. + Instance represents: Window handle. + + Multichannel images to be displayed. + Number of channel or the numbers of the RGB-channels Default: 1 + + + + Displays a color (RGB) image + Instance represents: Window handle. + + Color image to display. + + + + Displays ellipses. + Instance represents: Window handle. + + Row index of center. Default: 64 + Column index of center. Default: 64 + Orientation of the ellipse in radians Default: 0.0 + Radius of major axis. Default: 24.0 + Radius of minor axis. Default: 14.0 + + + + Displays ellipses. + Instance represents: Window handle. + + Row index of center. Default: 64 + Column index of center. Default: 64 + Orientation of the ellipse in radians Default: 0.0 + Radius of major axis. Default: 24.0 + Radius of minor axis. Default: 14.0 + + + + Displays a noise distribution. + Instance represents: Window handle. + + Gray value distribution (513 values). + Row index of center. Default: 256 + Column index of center. Default: 256 + Size of display. Default: 1 + + + + Displays circles in a window. + Instance represents: Window handle. + + Row index of the center. Default: 64 + Column index of the center. Default: 64 + Radius of the circle. Default: 64 + + + + Displays circles in a window. + Instance represents: Window handle. + + Row index of the center. Default: 64 + Column index of the center. Default: 64 + Radius of the circle. Default: 64 + + + + Displays arrows in a window. + Instance represents: Window handle. + + Row index of the start. Default: 10.0 + Column index of the start. Default: 10.0 + Row index of the end. Default: 118.0 + Column index of the end. Default: 118.0 + Size of the arrowhead. Default: 1.0 + + + + Displays arrows in a window. + Instance represents: Window handle. + + Row index of the start. Default: 10.0 + Column index of the start. Default: 10.0 + Row index of the end. Default: 118.0 + Column index of the end. Default: 118.0 + Size of the arrowhead. Default: 1.0 + + + + Displays circular arcs in a window. + Instance represents: Window handle. + + Row coordinate of center point. Default: 64 + Column coordinate of center point. Default: 64 + Angle between start and end of the arc (in radians). Default: 3.1415926 + Row coordinate of the start of the arc. Default: 32 + Column coordinate of the start of the arc. Default: 32 + + + + Displays circular arcs in a window. + Instance represents: Window handle. + + Row coordinate of center point. Default: 64 + Column coordinate of center point. Default: 64 + Angle between start and end of the arc (in radians). Default: 3.1415926 + Row coordinate of the start of the arc. Default: 32 + Column coordinate of the start of the arc. Default: 32 + + + + Displays image objects (image, region, XLD). + Instance represents: Window handle. + + Image object to be displayed. + + + + Set the current mouse pointer shape. + Instance represents: Window handle. + + Mouse pointer name. Default: "arrow" + + + + Query the current mouse pointer shape. + Instance represents: Window handle. + + Mouse pointer name. + + + + Query all available mouse pointer shapes. + Instance represents: Window handle. + + Available mouse pointer names. + + + + Query the subpixel mouse position. + Instance represents: Window handle. + + Row coordinate of the mouse cursor in the image coordinate system. + Column coordinate of the mouse cursor in the image coordinate system. + Mouse button(s) pressed or 0. + + + + Query the mouse position. + Instance represents: Window handle. + + Row coordinate of the mouse cursor in the image coordinate system. + Column coordinate of the mouse cursor in the image coordinate system. + Mouse button(s) pressed or 0. + + + + Wait until a mouse button is pressed and get the subpixel mouse position. + Instance represents: Window handle. + + Row coordinate of the mouse cursor in the image coordinate system. + Column coordinate of the mouse cursor in the image coordinate system. + Mouse button(s) pressed. + + + + Wait until a mouse button is pressed. + Instance represents: Window handle. + + Row coordinate of the mouse cursor in the image coordinate system. + Column coordinate of the mouse cursor in the image coordinate system. + Mouse button(s) pressed. + + + + Write look-up-table (lut) as file. + Instance represents: Window handle. + + File name (of file containing the look-up-table). Default: "/tmp/lut" + + + + Graphical view of the look-up-table (lut). + Instance represents: Window handle. + + Row of centre of the graphic. Default: 128 + Column of centre of the graphic. Default: 128 + Scaling of the graphic. Default: 1 + + + + Query all available look-up-tables (lut). + Instance represents: Window handle. + + Names of look-up-tables. + + + + Get modification parameters of look-up-table (lut). + Instance represents: Window handle. + + Modification of saturation. + Modification of intensity. + Modification of color value. + + + + Changing the look-up-table (lut). + Instance represents: Window handle. + + Modification of color value. Default: 0.0 + Modification of saturation. Default: 1.5 + Modification of intensity. Default: 1.5 + + + + Get current look-up-table (lut). + Instance represents: Window handle. + + Name of look-up-table or tuple of RGB-values. + + + + Set "`look-up-table"' (lut). + Instance represents: Window handle. + + Name of look-up-table, values of look-up-table (RGB) or file name. Default: "default" + + + + Set "`look-up-table"' (lut). + Instance represents: Window handle. + + Name of look-up-table, values of look-up-table (RGB) or file name. Default: "default" + + + + Get mode of fixing of current look-up-table (lut). + Instance represents: Window handle. + + Current Mode of fixing. + + + + Set fixing of "`look-up-table"' (lut) + Instance represents: Window handle. + + Mode of fixing. Default: "true" + + + + Get fixing of "`look-up-table"' (lut) for "`real color images"' + Instance represents: Window handle. + + Mode of fixing. + + + + Fix "`look-up-table"' (lut) for "`real color images"'. + Instance represents: Window handle. + + Mode of fixing. Default: "true" + + + + Interactive movement of a region with restriction of positions. + Instance represents: Window handle. + + Regions to move. + Points on which it is allowed for a region to move. + Row index of the reference point. Default: 100 + Column index of the reference point. Default: 100 + Moved regions. + + + + Interactive movement of a region with fixpoint specification. + Instance represents: Window handle. + + Regions to move. + Row index of the reference point. Default: 100 + Column index of the reference point. Default: 100 + Moved regions. + + + + Interactive moving of a region. + Instance represents: Window handle. + + Regions to move. + Moved Regions. + + + + Interactive modification of a NURBS curve using interpolation. + Instance represents: Window handle. + + Enable rotation? Default: "true" + Enable moving? Default: "true" + Enable scaling? Default: "true" + Keep ratio while scaling? Default: "true" + Enable editing? Default: "true" + The degree $p$ of the NURBS curve. Reasonable values are 3 to 5. Default: 3 + Row coordinates of the input interpolation points. + Column coordinates of the input interpolation points. + Input tangents. + Row coordinates of the control polygon. + Column coordinates of the control polygon. + Knot vector. + Row coordinates of the points specified by the user. + Column coordinates of the points specified by the user. + Tangents specified by the user. + Contour of the modified curve. + + + + Interactive drawing of a NURBS curve using interpolation. + Instance represents: Window handle. + + Enable rotation? Default: "true" + Enable moving? Default: "true" + Enable scaling? Default: "true" + Keep ratio while scaling? Default: "true" + The degree $p$ of the NURBS curve. Reasonable values are 3 to 5. Default: 3 + Row coordinates of the control polygon. + Column coordinates of the control polygon. + Knot vector. + Row coordinates of the points specified by the user. + Column coordinates of the points specified by the user. + Tangents specified by the user. + Contour of the curve. + + + + Interactive modification of a NURBS curve. + Instance represents: Window handle. + + Enable rotation? Default: "true" + Enable moving? Default: "true" + Enable scaling? Default: "true" + Keep ratio while scaling? Default: "true" + Enable editing? Default: "true" + The degree $p$ of the NURBS curve. Reasonable values are 3 to 25. Default: 3 + Row coordinates of the input control polygon. + Column coordinates of the input control polygon. + Input weight vector. + Row coordinates of the control polygon. + Columns coordinates of the control polygon. + Weight vector. + Contour of the modified curve. + + + + Interactive drawing of a NURBS curve. + Instance represents: Window handle. + + Enable rotation? Default: "true" + Enable moving? Default: "true" + Enable scaling? Default: "true" + Keep ratio while scaling? Default: "true" + The degree $p$ of the NURBS curve. Reasonable values are 3 to 25. Default: 3 + Row coordinates of the control polygon. + Columns coordinates of the control polygon. + Weight vector. + Contour approximating the NURBS curve. + + + + Interactive modification of a contour. + Instance represents: Window handle. + + Input contour. + Enable rotation? Default: "true" + Enable moving? Default: "true" + Enable scaling? Default: "true" + Keep ratio while scaling? Default: "true" + Enable editing? Default: "true" + Modified contour. + + + + Interactive drawing of a contour. + Instance represents: Window handle. + + Enable rotation? Default: "true" + Enable moving? Default: "true" + Enable scaling? Default: "true" + Keep ratio while scaling? Default: "true" + Modified contour. + + + + Interactive drawing of any orientated rectangle. + Instance represents: Window handle. + + Row index of the center. + Column index of the center. + Orientation of the bigger half axis in radians. + Bigger half axis. + Smaller half axis. + Row index of the center. + Column index of the center. + Orientation of the bigger half axis in radians. + Bigger half axis. + Smaller half axis. + + + + Interactive drawing of any orientated rectangle. + Instance represents: Window handle. + + Row index of the center. + Column index of the center. + Orientation of the bigger half axis in radians. + Bigger half axis. + Smaller half axis. + + + + Draw a rectangle parallel to the coordinate axis. + Instance represents: Window handle. + + Row index of the left upper corner. + Column index of the left upper corner. + Row index of the right lower corner. + Column index of the right lower corner. + Row index of the left upper corner. + Column index of the left upper corner. + Row index of the right lower corner. + Column index of the right lower corner. + + + + Draw a rectangle parallel to the coordinate axis. + Instance represents: Window handle. + + Row index of the left upper corner. + Column index of the left upper corner. + Row index of the right lower corner. + Column index of the right lower corner. + + + + Draw a point. + Instance represents: Window handle. + + Row index of the point. + Column index of the point. + Row index of the point. + Column index of the point. + + + + Draw a point. + Instance represents: Window handle. + + Row index of the point. + Column index of the point. + + + + Draw a line. + Instance represents: Window handle. + + Row index of the first point of the line. + Column index of the first point of the line. + Row index of the second point of the line. + Column index of the second point of the line. + Row index of the first point of the line. + Column index of the first point of the line. + Row index of the second point of the line. + Column index of the second point of the line. + + + + Draw a line. + Instance represents: Window handle. + + Row index of the first point of the line. + Column index of the first point of the line. + Row index of the second point of the line. + Column index of the second point of the line. + + + + Interactive drawing of an ellipse. + Instance represents: Window handle. + + Row index of the center. + Column index of the center. + Orientation of the bigger half axis in radians. + Bigger half axis. + Smaller half axis. + Row index of the center. + Column index of the center. + Orientation of the first half axis in radians. + First half axis. + Second half axis. + + + + Interactive drawing of an ellipse. + Instance represents: Window handle. + + Row index of the center. + Column index of the center. + Orientation of the first half axis in radians. + First half axis. + Second half axis. + + + + Interactive drawing of a circle. + Instance represents: Window handle. + + Row index of the center. + Column index of the center. + Radius of the circle. + Row index of the center. + Column index of the center. + Circle's radius. + + + + Interactive drawing of a circle. + Instance represents: Window handle. + + Barycenter's row index. + Barycenter's column index. + Circle's radius. + + + + Interactive drawing of a closed region. + Instance represents: Window handle. + + Interactive created region. + + + + Interactive drawing of a polygon row. + Instance represents: Window handle. + + Region, which encompasses all painted points. + + + + Project and visualize the 3D model of the calibration plate in the image. + Instance represents: Window in which the calibration plate should be visualized. + + File name of the calibration plate description. Default: "calplate_320.cpd" + Internal camera parameters. + External camera parameters (3D pose of the calibration plate in camera coordinates). + Scaling factor for the visualization. Default: 1.0 + + + + Convert image coordinates to window coordinates + Instance represents: Window handle + + Row in image coordinates. + Column in image coordinates. + Row (Y) in window coordinates. + Column (X) in window coordinates. + + + + Convert image coordinates to window coordinates + Instance represents: Window handle + + Row in image coordinates. + Column in image coordinates. + Row (Y) in window coordinates. + Column (X) in window coordinates. + + + + Convert window coordinates to image coordinates + Instance represents: Window handle. + + Row (Y) in window coordinates. + Column (X) in window coordinates. + Row in image coordinates. + Column in image coordinates. + + + + Convert window coordinates to image coordinates + Instance represents: Window handle. + + Row (Y) in window coordinates. + Column (X) in window coordinates. + Row in image coordinates. + Column in image coordinates. + + + + Display text in a window. + Instance represents: Window handle. + + A tuple of strings containing the text message to be displayed. Each value of the tuple will be displayed in a single line. Default: "hello" + If set to 'window', the text position is given with respect to the window coordinate system. If set to 'image', image coordinates are used (this may be useful in zoomed images). Default: "window" + The vertical text alignment or the row coordinate of the desired text position. Default: 12 + The horizontal text alignment or the column coordinate of the desired text position. Default: 12 + A tuple of strings defining the colors of the texts. Default: "black" + Generic parameter names. Default: [] + Generic parameter values. Default: [] + + + + Display text in a window. + Instance represents: Window handle. + + A tuple of strings containing the text message to be displayed. Each value of the tuple will be displayed in a single line. Default: "hello" + If set to 'window', the text position is given with respect to the window coordinate system. If set to 'image', image coordinates are used (this may be useful in zoomed images). Default: "window" + The vertical text alignment or the row coordinate of the desired text position. Default: 12 + The horizontal text alignment or the column coordinate of the desired text position. Default: 12 + A tuple of strings defining the colors of the texts. Default: "black" + Generic parameter names. Default: [] + Generic parameter values. Default: [] + + + + Flush the contents of a window. + Instance represents: Window handle. + + + + + Get the current color in RGBA-coding. + Instance represents: Window handle. + + The current color's red value. + The current color's green value. + The current color's blue value. + The current color's alpha value. + + + + Send an event to a buffer window signaling a mouse double click event. + Instance represents: Window handle of the buffer window. + + Row coordinate of the mouse cursor in the image coordinate system. + Column coordinate of the mouse cursor in the image coordinate system. + Mouse button(s) pressed. + 'true', if HALCON processed the event. + + + + Send an event to a buffer window signaling a mouse double click event. + Instance represents: Window handle of the buffer window. + + Row coordinate of the mouse cursor in the image coordinate system. + Column coordinate of the mouse cursor in the image coordinate system. + Mouse button(s) pressed. + 'true', if HALCON processed the event. + + + + Send an event to a window buffer signaling a mouse down event. + Instance represents: Window handle of the buffer window. + + Row coordinate of the mouse cursor in the image coordinate system. + Column coordinate of the mouse cursor in the image coordinate system. + Mouse button(s) pressed. + 'true', if HALCON processed the event. + + + + Send an event to a window buffer signaling a mouse down event. + Instance represents: Window handle of the buffer window. + + Row coordinate of the mouse cursor in the image coordinate system. + Column coordinate of the mouse cursor in the image coordinate system. + Mouse button(s) pressed. + 'true', if HALCON processed the event. + + + + Send an event to a buffer window signaling a mouse drag event. + Instance represents: Window handle of the buffer window. + + Row coordinate of the mouse cursor in the image coordinate system. + Column coordinate of the mouse cursor in the image coordinate system. + Mouse button(s) pressed. + 'true', if HALCON processed the event. + + + + Send an event to a buffer window signaling a mouse drag event. + Instance represents: Window handle of the buffer window. + + Row coordinate of the mouse cursor in the image coordinate system. + Column coordinate of the mouse cursor in the image coordinate system. + Mouse button(s) pressed. + 'true', if HALCON processed the event. + + + + Send an event to a buffer window signaling a mouse up event. + Instance represents: Window handle of the buffer window. + + Row coordinate of the mouse cursor in the image coordinate system. + Column coordinate of the mouse cursor in the image coordinate system. + Mouse button(s) pressed. + 'true', if HALCON processed the event. + + + + Send an event to a buffer window signaling a mouse up event. + Instance represents: Window handle of the buffer window. + + Row coordinate of the mouse cursor in the image coordinate system. + Column coordinate of the mouse cursor in the image coordinate system. + Mouse button(s) pressed. + 'true', if HALCON processed the event. + + + + Sets the callback for content updates in buffer window. + Instance represents: Window handle. + + Callback for content updates. + Parameter to CallbackFunction. + + + + Sets the callback for content updates in buffer window. + Instance represents: Window handle. + + Callback for content updates. + Parameter to CallbackFunction. + + + + Set the color definition via RGBA values. + Instance represents: Window handle. + + Red component of the color. Default: 255 + Green component of the color. Default: 0 + Blue component of the color. Default: 0 + Alpha component of the color. Default: 255 + + + + Set the color definition via RGBA values. + Instance represents: Window handle. + + Red component of the color. Default: 255 + Green component of the color. Default: 0 + Blue component of the color. Default: 0 + Alpha component of the color. Default: 255 + + + + Get the current contour display fill style. + Instance represents: Window handle. + + Current contour fill style. + + + + Define the contour display fill style. + Instance represents: Window handle. + + Fill style of contour displays. Default: "stroke" + + + Represents an instance of an XLD object-(array). + + + Create an uninitialized iconic object + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + + Return an XLD parallel's data (as lines). + Instance represents: Input XLD parallels. + + Row coordinates of the points on polygon P1. + Column coordinates of the points on polygon P1. + Lengths of the line segments on polygon P1. + Angles of the line segments on polygon P1. + Row coordinates of the points on polygon P2. + Column coordinates of the points on polygon P2. + Lengths of the line segments on polygon P2. + Angles of the line segments on polygon P2. + + + + Display an XLD object. + Instance represents: XLD object to display. + + Window handle. + + + + Receive an XLD object over a socket connection. + Modified instance represents: Received XLD object. + + Socket number. + + + + Send an XLD object over a socket connection. + Instance represents: XLD object to be sent. + + Socket number. + + + + Calculate the difference of two object tuples. + Instance represents: Object tuple 1. + + Object tuple 2. + Objects from Objects that are not part of ObjectsSub. + + + + Paint XLD objects into an image. + Instance represents: XLD objects to be painted into the input image. + + Image in which the xld objects are to be painted. + Desired gray value of the xld object. Default: 255.0 + Image containing the result. + + + + Paint XLD objects into an image. + Instance represents: XLD objects to be painted into the input image. + + Image in which the xld objects are to be painted. + Desired gray value of the xld object. Default: 255.0 + Image containing the result. + + + + Copy an iconic object in the HALCON database. + Instance represents: Objects to be copied. + + Starting index of the objects to be copied. Default: 1 + Number of objects to be copied or -1. Default: 1 + Copied objects. + + + + Concatenate two iconic object tuples. + Instance represents: Object tuple 1. + + Object tuple 2. + Concatenated objects. + + + + Select objects from an object tuple. + Instance represents: Input objects. + + Indices of the objects to be selected. Default: 1 + Selected objects. + + + + Select objects from an object tuple. + Instance represents: Input objects. + + Indices of the objects to be selected. Default: 1 + Selected objects. + + + + Compare iconic objects regarding equality. + Instance represents: Reference objects. + + Test objects. + Maximum allowed difference between two gray values or coordinates etc. Default: 0.0 + Boolean result value. + + + + Compare iconic objects regarding equality. + Instance represents: Reference objects. + + Test objects. + Maximum allowed difference between two gray values or coordinates etc. Default: 0.0 + Boolean result value. + + + + Compare image objects regarding equality. + Instance represents: Test objects. + + Comparative objects. + boolean result value. + + + + Compute the mapping between the distorted image and the rectified image based upon the points of a regular grid. + Instance represents: Input contours. + + Input image. + Output contours. + Distance of the grid points in the rectified image. + Rotation to be applied to the point grid. Default: "auto" + Row coordinates of the grid points. + Column coordinates of the grid points. + Type of mapping. Default: "bilinear" + Image containing the mapping data. + + + + Compute the mapping between the distorted image and the rectified image based upon the points of a regular grid. + Instance represents: Input contours. + + Input image. + Output contours. + Distance of the grid points in the rectified image. + Rotation to be applied to the point grid. Default: "auto" + Row coordinates of the grid points. + Column coordinates of the grid points. + Type of mapping. Default: "bilinear" + Image containing the mapping data. + + + + Deserialize a serialized XLD object. + Modified instance represents: XLD object. + + Handle of the serialized item. + + + + Serialize an XLD object. + Instance represents: XLD object. + + Handle of the serialized item. + + + + Test whether contours or polygons are closed. + Instance represents: Contours or polygons to be tested. + + Tuple with boolean numbers. + + + + Arbitrary geometric moments of contours or polygons treated as point clouds. + Instance represents: Contours or polygons to be examined. + + Computation mode. Default: "unnormalized" + Area enclosed by the contour or polygon. + Row coordinate of the centroid. + Column coordinate of the centroid. + First index of the desired moments M[P,Q]@f$M_{p,q}$. Default: 1 + Second index of the desired moments M[P,Q]@f$M_{p,q}$. Default: 1 + The computed moments. + + + + Arbitrary geometric moments of contours or polygons treated as point clouds. + Instance represents: Contours or polygons to be examined. + + Computation mode. Default: "unnormalized" + Area enclosed by the contour or polygon. + Row coordinate of the centroid. + Column coordinate of the centroid. + First index of the desired moments M[P,Q]@f$M_{p,q}$. Default: 1 + Second index of the desired moments M[P,Q]@f$M_{p,q}$. Default: 1 + The computed moments. + + + + Anisometry of contours or polygons treated as point clouds. + Instance represents: Contours or polygons to be examined. + + Anisometry of the contours or polygons. + + + + Parameters of the equivalent ellipse of contours or polygons treated as point clouds. + Instance represents: Contours or polygons to be examined. + + Minor radius. + Angle between the major axis and the column axis (radians). + Major radius. + + + + Parameters of the equivalent ellipse of contours or polygons treated as point clouds. + Instance represents: Contours or polygons to be examined. + + Minor radius. + Angle between the major axis and the column axis (radians). + Major radius. + + + + Orientation of contours or polygons treated as point clouds. + Instance represents: Contours or polygons to be examined. + + Orientation of the contours or polygons (radians). + + + + Geometric moments M20@f$M_{20}$, M02@f$M_{02}$, and M11@f$M_{11}$ of contours or polygons treated as point clouds. + Instance represents: Contours or polygons to be examined. + + Second order moment along the row axis. + Second order moment along the column axis. + Mixed second order moment. + + + + Geometric moments M20@f$M_{20}$, M02@f$M_{02}$, and M11@f$M_{11}$ of contours or polygons treated as point clouds. + Instance represents: Contours or polygons to be examined. + + Second order moment along the row axis. + Second order moment along the column axis. + Mixed second order moment. + + + + Area and center of gravity (centroid) of contours and polygons treated as point clouds. + Instance represents: Point clouds to be examined in form of contours or polygons. + + Row coordinate of the centroid. + Column coordinate of the centroid. + Area of the point cloud. + + + + Area and center of gravity (centroid) of contours and polygons treated as point clouds. + Instance represents: Point clouds to be examined in form of contours or polygons. + + Row coordinate of the centroid. + Column coordinate of the centroid. + Area of the point cloud. + + + + Test XLD contours or polygons for self intersection. + Instance represents: Input contours or polygons. + + Should the input contours or polygons be closed first? Default: "true" + 1 for contours or polygons with self intersection and 0 otherwise. + + + + Choose all contours or polygons containing a given point. + Instance represents: Contours or polygons to be examined. + + Line coordinate of the test point. Default: 100.0 + Column coordinate of the test point. Default: 100.0 + All contours or polygons containing the test point. + + + + Choose all contours or polygons containing a given point. + Instance represents: Contours or polygons to be examined. + + Line coordinate of the test point. Default: 100.0 + Column coordinate of the test point. Default: 100.0 + All contours or polygons containing the test point. + + + + Test whether one or more contours or polygons enclose the given point(s). + Instance represents: Contours or polygons to be tested. + + Row coordinates of the points to be tested. + Column coordinates of the points to be tested. + Tuple with boolean numbers. + + + + Test whether one or more contours or polygons enclose the given point(s). + Instance represents: Contours or polygons to be tested. + + Row coordinates of the points to be tested. + Column coordinates of the points to be tested. + Tuple with boolean numbers. + + + + Select contours or polygons using shape features. + Instance represents: Contours or polygons to be examined. + + Shape features to be checked. Default: "area" + Operation type between the individual features. Default: "and" + Lower limits of the features or 'min'. Default: 150.0 + Upper limits of the features or 'max'. Default: 99999.0 + Contours or polygons fulfilling the condition(s). + + + + Select contours or polygons using shape features. + Instance represents: Contours or polygons to be examined. + + Shape features to be checked. Default: "area" + Operation type between the individual features. Default: "and" + Lower limits of the features or 'min'. Default: 150.0 + Upper limits of the features or 'max'. Default: 99999.0 + Contours or polygons fulfilling the condition(s). + + + + Orientation of contours or polygons. + Instance represents: Contours or polygons to be examined. + + Orientation of the contours or polygons (radians). + + + + Shape features derived from the ellipse parameters of contours or polygons. + Instance represents: Contours or polygons to be examined. + + Bulkiness of the contours or polygons. + Structure factor of the contours or polygons. + Anisometry of the contours or polygons. + + + + Shape features derived from the ellipse parameters of contours or polygons. + Instance represents: Contours or polygons to be examined. + + Bulkiness of the contours or polygons. + Structure factor of the contours or polygons. + Anisometry of the contours or polygons. + + + + Shape factor for the compactness of contours or polygons. + Instance represents: Contours or polygons to be examined. + + Compactness of the input contours or polygons. + + + + Maximum distance between two contour or polygon points. + Instance represents: Contours or polygons to be examined. + + Row coordinate of the first extreme point of the contours or polygons. + Column coordinate of the first extreme point of the contours or polygons. + Row coordinate of the second extreme point of the contour or polygons. + Column coordinate of the second extreme point of the contours or polygons. + Distance of the two extreme points of the contours or polygons. + + + + Maximum distance between two contour or polygon points. + Instance represents: Contours or polygons to be examined. + + Row coordinate of the first extreme point of the contours or polygons. + Column coordinate of the first extreme point of the contours or polygons. + Row coordinate of the second extreme point of the contour or polygons. + Column coordinate of the second extreme point of the contours or polygons. + Distance of the two extreme points of the contours or polygons. + + + + Shape factor for the convexity of contours or polygons. + Instance represents: Contours or polygons to be examined. + + Convexity of the input contours or polygons. + + + + Shape factor for the circularity (similarity to a circle) of contours or polygons. + Instance represents: Contours or polygons to be examined. + + Roundness of the input contours or polygons. + + + + Parameters of the equivalent ellipse of contours or polygons. + Instance represents: Contours or polygons to be examined. + + Minor radius. + Angle between the major axis and the x axis (radians). + Major radius. + + + + Parameters of the equivalent ellipse of contours or polygons. + Instance represents: Contours or polygons to be examined. + + Minor radius. + Angle between the major axis and the x axis (radians). + Major radius. + + + + Smallest enclosing rectangle with arbitrary orientation of contours or polygons. + Instance represents: Contours or polygons to be examined. + + Row coordinate of the center point of the enclosing rectangle. + Column coordinate of the center point of the enclosing rectangle. + Orientation of the enclosing rectangle (arc measure) + First radius (half length) of the enclosing rectangle. + Second radius (half width) of the enclosing rectangle. + + + + Smallest enclosing rectangle with arbitrary orientation of contours or polygons. + Instance represents: Contours or polygons to be examined. + + Row coordinate of the center point of the enclosing rectangle. + Column coordinate of the center point of the enclosing rectangle. + Orientation of the enclosing rectangle (arc measure) + First radius (half length) of the enclosing rectangle. + Second radius (half width) of the enclosing rectangle. + + + + Enclosing rectangle parallel to the coordinate axes of contours or polygons. + Instance represents: Contours or polygons to be examined. + + Row coordinate of upper left corner point of the enclosing rectangle. + Column coordinate of upper left corner point of the enclosing rectangle. + Row coordinate of lower right corner point of the enclosing rectangle. + Column coordinate of lower right corner point of the enclosing rectangle. + + + + Enclosing rectangle parallel to the coordinate axes of contours or polygons. + Instance represents: Contours or polygons to be examined. + + Row coordinate of upper left corner point of the enclosing rectangle. + Column coordinate of upper left corner point of the enclosing rectangle. + Row coordinate of lower right corner point of the enclosing rectangle. + Column coordinate of lower right corner point of the enclosing rectangle. + + + + Smallest enclosing circle of contours or polygons. + Instance represents: Contours or polygons to be examined. + + Row coordinate of the center of the enclosing circle. + Column coordinate of the center of the enclosing circle. + Radius of the enclosing circle. + + + + Smallest enclosing circle of contours or polygons. + Instance represents: Contours or polygons to be examined. + + Row coordinate of the center of the enclosing circle. + Column coordinate of the center of the enclosing circle. + Radius of the enclosing circle. + + + + Transform the shape of contours or polygons. + Instance represents: Contours or polygons to be transformed. + + Type of transformation. Default: "convex" + Transformed contours respectively polygons. + + + + Length of contours or polygons. + Instance represents: Contours or polygons to be examined. + + Length of the contour or polygon. + + + + Arbitrary geometric moments of contours or polygons. + Instance represents: Contours or polygons to be examined. + + Computation mode. Default: "unnormalized" + Point order along the boundary. Default: "positive" + Area enclosed by the contour or polygon. + Row coordinate of the centroid. + Column coordinate of the centroid. + First index of the desired moments M[P,Q]@f$M_{p,q}$. Default: 1 + Second index of the desired moments M[P,Q]@f$M_{p,q}$. Default: 1 + The computed moments. + + + + Arbitrary geometric moments of contours or polygons. + Instance represents: Contours or polygons to be examined. + + Computation mode. Default: "unnormalized" + Point order along the boundary. Default: "positive" + Area enclosed by the contour or polygon. + Row coordinate of the centroid. + Column coordinate of the centroid. + First index of the desired moments M[P,Q]@f$M_{p,q}$. Default: 1 + Second index of the desired moments M[P,Q]@f$M_{p,q}$. Default: 1 + The computed moments. + + + + Geometric moments M20@f$M_{20}$, M02@f$M_{02}$, and M11@f$M_{11}$ of contours or polygons. + Instance represents: Contours or polygons to be examined. + + Second order moment along the row axis. + Second order moment along the column axis. + Mixed second order moment. + + + + Geometric moments M20@f$M_{20}$, M02@f$M_{02}$, and M11@f$M_{11}$ of contours or polygons. + Instance represents: Contours or polygons to be examined. + + Second order moment along the row axis. + Second order moment along the column axis. + Mixed second order moment. + + + + Area and center of gravity (centroid) of contours and polygons. + Instance represents: Contours or polygons to be examined. + + Row coordinate of the centroid. + Column coordinate of the centroid. + point order along the boundary ('positive'/'negative'). + Area enclosed by the contour or polygon. + + + + Area and center of gravity (centroid) of contours and polygons. + Instance represents: Contours or polygons to be examined. + + Row coordinate of the centroid. + Column coordinate of the centroid. + point order along the boundary ('positive'/'negative'). + Area enclosed by the contour or polygon. + + + + Determine the 3D pose of a rectangle from its perspective 2D projection + Instance represents: Contour(s) to be examined. + + Internal camera parameters. + Width of the rectangle in meters. + Height of the rectangle in meters. + Weighting mode for the optimization phase. Default: "nonweighted" + Clipping factor for the elimination of outliers (typical: 1.0 for 'huber' and 3.0 for 'tukey'). Default: 2.0 + Covariances of the pose values. + Root-mean-square value of the final residual error. + 3D pose of the rectangle. + + + + Determine the 3D pose of a rectangle from its perspective 2D projection + Instance represents: Contour(s) to be examined. + + Internal camera parameters. + Width of the rectangle in meters. + Height of the rectangle in meters. + Weighting mode for the optimization phase. Default: "nonweighted" + Clipping factor for the elimination of outliers (typical: 1.0 for 'huber' and 3.0 for 'tukey'). Default: 2.0 + Covariances of the pose values. + Root-mean-square value of the final residual error. + 3D pose of the rectangle. + + + + Determine the 3D pose of a circle from its perspective 2D projection. + Instance represents: Contours to be examined. + + Internal camera parameters. + Radius of the circle in object space. + Type of output parameters. Default: "pose" + 3D pose of the second circle. + 3D pose of the first circle. + + + + Determine the 3D pose of a circle from its perspective 2D projection. + Instance represents: Contours to be examined. + + Internal camera parameters. + Radius of the circle in object space. + Type of output parameters. Default: "pose" + 3D pose of the second circle. + 3D pose of the first circle. + + + + Compute the width, height, and aspect ratio of the enclosing rectangle parallel to the coordinate axes of contours or polygons. + Instance represents: Contours or polygons to be examined. + + Width of the enclosing rectangle. + Aspect ratio of the enclosing rectangle. + Height of the enclosing rectangle. + + + + Compute the width, height, and aspect ratio of the enclosing rectangle parallel to the coordinate axes of contours or polygons. + Instance represents: Contours or polygons to be examined. + + Width of the enclosing rectangle. + Aspect ratio of the enclosing rectangle. + Height of the enclosing rectangle. + + + + Insert objects into an iconic object tuple. + Instance represents: Input object tuple. + + Object tuple to insert. + Index to insert objects. + Extended object tuple. + + + + Remove objects from an iconic object tuple. + Instance represents: Input object tuple. + + Indices of the objects to be removed. + Remaining object tuple. + + + + Remove objects from an iconic object tuple. + Instance represents: Input object tuple. + + Indices of the objects to be removed. + Remaining object tuple. + + + + Replaces one or more elements of an iconic object tuple. + Instance represents: Iconic Input Object. + + Element(s) to replace. + Index/Indices of elements to be replaced. + Tuple with replaced elements. + + + + Replaces one or more elements of an iconic object tuple. + Instance represents: Iconic Input Object. + + Element(s) to replace. + Index/Indices of elements to be replaced. + Tuple with replaced elements. + + + Returns the iconic object(s) at the specified index + + + Represents an instance of an XLD contour object(-array). + + + Create an uninitialized iconic object + + + + Generate XLD contours from regions. + Modified instance represents: Resulting contours. + + Input regions. + Mode of contour generation. Default: "border" + + + + Generate an XLD contour from a polygon (given as tuples). + Modified instance represents: Resulting contour. + + Row coordinates of the polygon. Default: [0,1,2,2,2] + Column coordinates of the polygon. Default: [0,0,0,1,2] + + + + Compute the union of cotangential contours. + Instance represents: Input XLD contours. + + Length of the part of a contour to skip for the determination of tangents. Default: 0.0 + Length of the part of a contour to use for the determination of tangents. Default: 30.0 + Maximum angle difference between two contours' tangents. Default: 0.78539816 + Maximum distance of the contours' end points. Default: 25.0 + Maximum distance of the contours' end points perpendicular to their tangents. Default: 10.0 + Maximum overlap of two contours. Default: 2.0 + Mode describing the treatment of the contours' attributes. Default: "attr_forget" + Output XLD contours. + + + + Compute the union of cotangential contours. + Instance represents: Input XLD contours. + + Length of the part of a contour to skip for the determination of tangents. Default: 0.0 + Length of the part of a contour to use for the determination of tangents. Default: 30.0 + Maximum angle difference between two contours' tangents. Default: 0.78539816 + Maximum distance of the contours' end points. Default: 25.0 + Maximum distance of the contours' end points perpendicular to their tangents. Default: 10.0 + Maximum overlap of two contours. Default: 2.0 + Mode describing the treatment of the contours' attributes. Default: "attr_forget" + Output XLD contours. + + + + Transform a contour in polar coordinates back to Cartesian coordinates + Instance represents: Input contour. + + Row coordinate of the center of the arc. Default: 256 + Column coordinate of the center of the arc. Default: 256 + Angle of the ray to map the column coordinate 0 of PolarContour to. Default: 0.0 + Angle of the ray to map the column coordinate $WidthIn-1$ of PolarContour to. Default: 6.2831853 + Radius of the circle to map the row coordinate 0 of PolarContour to. Default: 0 + Radius of the circle to map the row coordinate $HeightIn-1$ of PolarContour to. Default: 100 + Width of the virtual input image. Default: 512 + Height of the virtual input image. Default: 512 + Width of the virtual output image. Default: 512 + Height of the virtual output image. Default: 512 + Output contour. + + + + Transform a contour in polar coordinates back to Cartesian coordinates + Instance represents: Input contour. + + Row coordinate of the center of the arc. Default: 256 + Column coordinate of the center of the arc. Default: 256 + Angle of the ray to map the column coordinate 0 of PolarContour to. Default: 0.0 + Angle of the ray to map the column coordinate $WidthIn-1$ of PolarContour to. Default: 6.2831853 + Radius of the circle to map the row coordinate 0 of PolarContour to. Default: 0 + Radius of the circle to map the row coordinate $HeightIn-1$ of PolarContour to. Default: 100 + Width of the virtual input image. Default: 512 + Height of the virtual input image. Default: 512 + Width of the virtual output image. Default: 512 + Height of the virtual output image. Default: 512 + Output contour. + + + + Transform a contour in an annular arc to polar coordinates. + Instance represents: Input contour. + + Row coordinate of the center of the arc. Default: 256 + Column coordinate of the center of the arc. Default: 256 + Angle of the ray to be mapped to the column coordinate 0 of PolarTransContour. Default: 0.0 + Angle of the ray to be mapped to the column coordinate $Width-1$ of PolarTransContour to. Default: 6.2831853 + Radius of the circle to be mapped to the row coordinate 0 of PolarTransContour. Default: 0 + Radius of the circle to be mapped to the row coordinate $Height-1$ of PolarTransContour. Default: 100 + Width of the virtual output image. Default: 512 + Height of the virtual output image. Default: 512 + Output contour. + + + + Transform a contour in an annular arc to polar coordinates. + Instance represents: Input contour. + + Row coordinate of the center of the arc. Default: 256 + Column coordinate of the center of the arc. Default: 256 + Angle of the ray to be mapped to the column coordinate 0 of PolarTransContour. Default: 0.0 + Angle of the ray to be mapped to the column coordinate $Width-1$ of PolarTransContour to. Default: 6.2831853 + Radius of the circle to be mapped to the row coordinate 0 of PolarTransContour. Default: 0 + Radius of the circle to be mapped to the row coordinate $Height-1$ of PolarTransContour. Default: 100 + Width of the virtual output image. Default: 512 + Height of the virtual output image. Default: 512 + Output contour. + + + + Transform a NURBS curve into an XLD contour. + Modified instance represents: The contour that approximates the NURBS curve. + + Row coordinates of the control polygon. + Column coordinates of the control polygon. + The knot vector $u$. Default: "auto" + The weight vector $w$. Default: "auto" + The degree $p$ of the NURBS curve. Default: 3 + Maximum distance between the NURBS curve and its approximation. Default: 1.0 + Maximum distance between two subsequent Contour points. Default: 5.0 + + + + Transform a NURBS curve into an XLD contour. + Modified instance represents: The contour that approximates the NURBS curve. + + Row coordinates of the control polygon. + Column coordinates of the control polygon. + The knot vector $u$. Default: "auto" + The weight vector $w$. Default: "auto" + The degree $p$ of the NURBS curve. Default: 3 + Maximum distance between the NURBS curve and its approximation. Default: 1.0 + Maximum distance between two subsequent Contour points. Default: 5.0 + + + + Compute the union of closed contours. + Instance represents: Contours enclosing the first region. + + Contours enclosing the second region. + Contours enclosing the union. + + + + Compute the symmetric difference of closed contours. + Instance represents: Contours enclosing the first region. + + Contours enclosing the second region. + Contours enclosing the symmetric difference. + + + + Compute the difference of closed contours. + Instance represents: Contours enclosing the region from which the second region is subtracted. + + Contours enclosing the region that is subtracted from the first region. + Contours enclosing the difference. + + + + Intersect closed contours. + Instance represents: Contours enclosing the first region to be intersected. + + Contours enclosing the second region to be intersected. + Contours enclosing the intersection. + + + + Compute the union of contours that belong to the same circle. + Instance represents: Contours to be merged. + + Maximum angular distance of two circular arcs. Default: 0.5 + Maximum overlap of two circular arcs. Default: 0.1 + Maximum angle between the connecting line and the tangents of circular arcs. Default: 0.2 + Maximum length of the gap between two circular arcs in pixels. Default: 30 + Maximum radius difference of the circles fitted to two arcs. Default: 10 + Maximum center distance of the circles fitted to two arcs. Default: 10 + Determine whether small contours without fitted circles should also be merged. Default: "true" + Number of iterations. Default: 1 + Merged contours. + + + + Compute the union of contours that belong to the same circle. + Instance represents: Contours to be merged. + + Maximum angular distance of two circular arcs. Default: 0.5 + Maximum overlap of two circular arcs. Default: 0.1 + Maximum angle between the connecting line and the tangents of circular arcs. Default: 0.2 + Maximum length of the gap between two circular arcs in pixels. Default: 30 + Maximum radius difference of the circles fitted to two arcs. Default: 10 + Maximum center distance of the circles fitted to two arcs. Default: 10 + Determine whether small contours without fitted circles should also be merged. Default: "true" + Number of iterations. Default: 1 + Merged contours. + + + + Crop an XLD contour. + Instance represents: Input contours. + + Upper border of the cropping rectangle. Default: 0 + Left border of the cropping rectangle. Default: 0 + Lower border of the cropping rectangle. Default: 512 + Right border of the cropping rectangle. Default: 512 + Should closed contours produce closed output contours? Default: "true" + Output contours. + + + + Crop an XLD contour. + Instance represents: Input contours. + + Upper border of the cropping rectangle. Default: 0 + Left border of the cropping rectangle. Default: 0 + Lower border of the cropping rectangle. Default: 512 + Right border of the cropping rectangle. Default: 512 + Should closed contours produce closed output contours? Default: "true" + Output contours. + + + + Generate one XLD contour in the shape of a cross for each input point. + Modified instance represents: Generated XLD contours. + + Row coordinates of the input points. + Column coordinates of the input points. + Length of the cross bars. Default: 6.0 + Orientation of the crosses. Default: 0.785398 + + + + Generate one XLD contour in the shape of a cross for each input point. + Modified instance represents: Generated XLD contours. + + Row coordinates of the input points. + Column coordinates of the input points. + Length of the cross bars. Default: 6.0 + Orientation of the crosses. Default: 0.785398 + + + + Sort contours with respect to their relative position. + Instance represents: Contours to be sorted. + + Kind of sorting. Default: "upper_left" + Increasing or decreasing sorting order. Default: "true" + Sorting first with respect to row, then to column. Default: "row" + Sorted contours. + + + + Merge XLD contours from successive line scan images. + Instance represents: Current input contours. + + Merged contours from the previous iteration. + Contours from the previous iteration which could not be merged with the current ones. + Height of the line scan images. Default: 512 + Maximum distance of contours from the image border. Default: 0.0 + Image line of the current image, which touches the previous image. Default: "top" + Maximum number of images covered by one contour. Default: 3 + Current contours, merged with old ones where applicable. + + + + Merge XLD contours from successive line scan images. + Instance represents: Current input contours. + + Merged contours from the previous iteration. + Contours from the previous iteration which could not be merged with the current ones. + Height of the line scan images. Default: 512 + Maximum distance of contours from the image border. Default: 0.0 + Image line of the current image, which touches the previous image. Default: "top" + Maximum number of images covered by one contour. Default: 3 + Current contours, merged with old ones where applicable. + + + + Read XLD contours to a file in ARC/INFO generate format. + Modified instance represents: Read XLD contours. + + Name of the ARC/INFO file. + + + + Write XLD contours to a file in ARC/INFO generate format. + Instance represents: XLD contours to be written. + + Name of the ARC/INFO file. + + + + Compute the parallel contour of an XLD contour. + Instance represents: Contours to be transformed. + + Mode, with which the direction information is computed. Default: "regression_normal" + Distance of the parallel contour. Default: 1 + Parallel contours. + + + + Compute the parallel contour of an XLD contour. + Instance represents: Contours to be transformed. + + Mode, with which the direction information is computed. Default: "regression_normal" + Distance of the parallel contour. Default: 1 + Parallel contours. + + + + Create an XLD contour in the shape of a rectangle. + Modified instance represents: Rectangle contour. + + Row coordinate of the center of the rectangle. Default: 300.0 + Column coordinate of the center of the rectangle. Default: 200.0 + Orientation of the main axis of the rectangle [rad]. Default: 0.0 + First radius (half length) of the rectangle. Default: 100.5 + Second radius (half width) of the rectangle. Default: 20.5 + + + + Create an XLD contour in the shape of a rectangle. + Modified instance represents: Rectangle contour. + + Row coordinate of the center of the rectangle. Default: 300.0 + Column coordinate of the center of the rectangle. Default: 200.0 + Orientation of the main axis of the rectangle [rad]. Default: 0.0 + First radius (half length) of the rectangle. Default: 100.5 + Second radius (half width) of the rectangle. Default: 20.5 + + + + Compute the distances of all contour points to a rectangle. + Instance represents: Input contour. + + Number of points at the beginning and the end of the contours to be ignored for the computation of distances. Default: 0 + Row coordinate of the center of the rectangle. + Column coordinate of the center of the rectangle. + Orientation of the main axis of the rectangle [rad]. + First radius (half length) of the rectangle. + Second radius (half width) of the rectangle. + Distances of the contour points to the rectangle. + + + + Fit rectangles to XLD contours. + Instance represents: Input contours. + + Algorithm for fitting the rectangles. Default: "regression" + Maximum number of contour points used for the computation (-1 for all points). Default: -1 + Maximum distance between the end points of a contour to be considered as closed. Default: 0.0 + Number of points at the beginning and at the end of the contours to be ignored for the fitting. Default: 0 + Maximum number of iterations (not used for 'regression'). Default: 3 + Clipping factor for the elimination of outliers (typical: 1.0 for 'huber' and 2.0 for 'tukey'). Default: 2.0 + Row coordinate of the center of the rectangle. + Column coordinate of the center of the rectangle. + Orientation of the main axis of the rectangle [rad]. + First radius (half length) of the rectangle. + Second radius (half width) of the rectangle. + Point order of the contour. + + + + Fit rectangles to XLD contours. + Instance represents: Input contours. + + Algorithm for fitting the rectangles. Default: "regression" + Maximum number of contour points used for the computation (-1 for all points). Default: -1 + Maximum distance between the end points of a contour to be considered as closed. Default: 0.0 + Number of points at the beginning and at the end of the contours to be ignored for the fitting. Default: 0 + Maximum number of iterations (not used for 'regression'). Default: 3 + Clipping factor for the elimination of outliers (typical: 1.0 for 'huber' and 2.0 for 'tukey'). Default: 2.0 + Row coordinate of the center of the rectangle. + Column coordinate of the center of the rectangle. + Orientation of the main axis of the rectangle [rad]. + First radius (half length) of the rectangle. + Second radius (half width) of the rectangle. + Point order of the contour. + + + + Segment XLD contour parts whose local attributes fulfill given conditions. + Instance represents: Contour to be segmented. + + Contour attributes to be checked. Default: "distance" + Linkage type of the individual attributes. Default: "and" + Lower limits of the attribute values. Default: 150.0 + Upper limits of the attribute values. Default: 99999.0 + Segmented contour parts. + + + + Segment XLD contour parts whose local attributes fulfill given conditions. + Instance represents: Contour to be segmented. + + Contour attributes to be checked. Default: "distance" + Linkage type of the individual attributes. Default: "and" + Lower limits of the attribute values. Default: 150.0 + Upper limits of the attribute values. Default: 99999.0 + Segmented contour parts. + + + + Segment XLD contours into line segments and circular or elliptic arcs. + Instance represents: Contours to be segmented. + + Mode for the segmentation of the contours. Default: "lines_circles" + Number of points used for smoothing the contours. Default: 5 + Maximum distance between a contour and the approximating line (first iteration). Default: 4.0 + Maximum distance between a contour and the approximating line (second iteration). Default: 2.0 + Segmented contours. + + + + Approximate XLD contours by circles. + Instance represents: Input contours. + + Algorithm for the fitting of circles. Default: "algebraic" + Maximum number of contour points used for the computation (-1 for all points). Default: -1 + Maximum distance between the end points of a contour to be considered as 'closed'. Default: 0.0 + Number of points at the beginning and at the end of the contours to be ignored for the fitting. Default: 0 + Maximum number of iterations for the robust weighted fitting. Default: 3 + Clipping factor for the elimination of outliers (typical: 1.0 for Huber and 2.0 for Tukey). Default: 2.0 + Row coordinate of the center of the circle. + Column coordinate of the center of the circle. + Radius of circle. + Angle of the start point [rad]. + Angle of the end point [rad]. + Point order along the boundary. + + + + Approximate XLD contours by circles. + Instance represents: Input contours. + + Algorithm for the fitting of circles. Default: "algebraic" + Maximum number of contour points used for the computation (-1 for all points). Default: -1 + Maximum distance between the end points of a contour to be considered as 'closed'. Default: 0.0 + Number of points at the beginning and at the end of the contours to be ignored for the fitting. Default: 0 + Maximum number of iterations for the robust weighted fitting. Default: 3 + Clipping factor for the elimination of outliers (typical: 1.0 for Huber and 2.0 for Tukey). Default: 2.0 + Row coordinate of the center of the circle. + Column coordinate of the center of the circle. + Radius of circle. + Angle of the start point [rad]. + Angle of the end point [rad]. + Point order along the boundary. + + + + Approximate XLD contours by line segments. + Instance represents: Input contours. + + Algorithm for the fitting of lines. Default: "tukey" + Maximum number of contour points used for the computation (-1 for all points). Default: -1 + Number of points at the beginning and at the end of the contours to be ignored for the fitting. Default: 0 + Maximum number of iterations (unused for 'regression'). Default: 5 + Clipping factor for the elimination of outliers (typical: 1.0 for 'huber' and 'drop' and 2.0 for 'tukey'). Default: 2.0 + Row coordinates of the starting points of the line segments. + Column coordinates of the starting points of the line segments. + Row coordinates of the end points of the line segments. + Column coordinates of the end points of the line segments. + Line parameter: Row coordinate of the normal vector + Line parameter: Column coordinate of the normal vector + Line parameter: Distance of the line from the origin + + + + Approximate XLD contours by line segments. + Instance represents: Input contours. + + Algorithm for the fitting of lines. Default: "tukey" + Maximum number of contour points used for the computation (-1 for all points). Default: -1 + Number of points at the beginning and at the end of the contours to be ignored for the fitting. Default: 0 + Maximum number of iterations (unused for 'regression'). Default: 5 + Clipping factor for the elimination of outliers (typical: 1.0 for 'huber' and 'drop' and 2.0 for 'tukey'). Default: 2.0 + Row coordinates of the starting points of the line segments. + Column coordinates of the starting points of the line segments. + Row coordinates of the end points of the line segments. + Column coordinates of the end points of the line segments. + Line parameter: Row coordinate of the normal vector + Line parameter: Column coordinate of the normal vector + Line parameter: Distance of the line from the origin + + + + Compute the distances of all contour points to an ellipse. + Instance represents: Input contours. + + Mode for unsigned or signed distance values. Default: "unsigned" + Number of points at the beginning and the end of the contours to be ignored for the computation of distances. Default: 0 + Row coordinate of the center of the ellipse. + Column coordinate of the center of the ellipse. + Orientation of the main axis in radian. + Length of the larger half axis. + Length of the smaller half axis. + Distances of the contour points to the ellipse. + + + + Compute the distance of contours to an ellipse. + Instance represents: Input contours. + + Method for the determination of the distances. Default: "geometric" + Maximum number of contour points used for the computation (-1 for all points). Default: -1 + Number of points at the beginning and the end of the contours to be ignored for the computation of distances. Default: 0 + Row coordinate of the center of the ellipse. + Column coordinate of the center of the ellipse. + Orientation of the main axis in radian. + Length of the larger half axis. + Length of the smaller half axis. + Minimum distance. + Maximum distance. + Mean distance. + Standard deviation of the distance. + + + + Compute the distance of contours to an ellipse. + Instance represents: Input contours. + + Method for the determination of the distances. Default: "geometric" + Maximum number of contour points used for the computation (-1 for all points). Default: -1 + Number of points at the beginning and the end of the contours to be ignored for the computation of distances. Default: 0 + Row coordinate of the center of the ellipse. + Column coordinate of the center of the ellipse. + Orientation of the main axis in radian. + Length of the larger half axis. + Length of the smaller half axis. + Minimum distance. + Maximum distance. + Mean distance. + Standard deviation of the distance. + + + + Approximate XLD contours by ellipses or elliptic arcs. + Instance represents: Input contours. + + Algorithm for the fitting of ellipses. Default: "fitzgibbon" + Maximum number of contour points used for the computation (-1 for all points). Default: -1 + Maximum distance between the end points of a contour to be considered as 'closed'. Default: 0.0 + Number of points at the beginning and at the end of the contours to be ignored for the fitting. Default: 0 + Number of circular segments used for the Voss approach. Default: 200 + Maximum number of iterations for the robust weighted fitting. Default: 3 + Clipping factor for the elimination of outliers (typical: 1.0 for '*huber' and 2.0 for '*tukey'). Default: 2.0 + Row coordinate of the center of the ellipse. + Column coordinate of the center of the ellipse. + Orientation of the main axis [rad]. + Length of the larger half axis. + Length of the smaller half axis. + Angle of the start point [rad]. + Angle of the end point [rad]. + point order along the boundary. + + + + Approximate XLD contours by ellipses or elliptic arcs. + Instance represents: Input contours. + + Algorithm for the fitting of ellipses. Default: "fitzgibbon" + Maximum number of contour points used for the computation (-1 for all points). Default: -1 + Maximum distance between the end points of a contour to be considered as 'closed'. Default: 0.0 + Number of points at the beginning and at the end of the contours to be ignored for the fitting. Default: 0 + Number of circular segments used for the Voss approach. Default: 200 + Maximum number of iterations for the robust weighted fitting. Default: 3 + Clipping factor for the elimination of outliers (typical: 1.0 for '*huber' and 2.0 for '*tukey'). Default: 2.0 + Row coordinate of the center of the ellipse. + Column coordinate of the center of the ellipse. + Orientation of the main axis [rad]. + Length of the larger half axis. + Length of the smaller half axis. + Angle of the start point [rad]. + Angle of the end point [rad]. + point order along the boundary. + + + + Create XLD contours corresponding to circles or circular arcs. + Modified instance represents: Resulting contours. + + Row coordinate of the center of the circles or circular arcs. Default: 200.0 + Column coordinate of the center of the circles or circular arcs. Default: 200.0 + Radius of the circles or circular arcs. Default: 100.0 + Angle of the start points of the circles or circular arcs [rad]. Default: 0.0 + Angle of the end points of the circles or circular arcs [rad]. Default: 6.28318 + Point order along the circles or circular arcs. Default: "positive" + Distance between neighboring contour points. Default: 1.0 + + + + Create XLD contours corresponding to circles or circular arcs. + Modified instance represents: Resulting contours. + + Row coordinate of the center of the circles or circular arcs. Default: 200.0 + Column coordinate of the center of the circles or circular arcs. Default: 200.0 + Radius of the circles or circular arcs. Default: 100.0 + Angle of the start points of the circles or circular arcs [rad]. Default: 0.0 + Angle of the end points of the circles or circular arcs [rad]. Default: 6.28318 + Point order along the circles or circular arcs. Default: "positive" + Distance between neighboring contour points. Default: 1.0 + + + + Create an XLD contour that corresponds to an elliptic arc. + Modified instance represents: Resulting contour. + + Row coordinate of the center of the ellipse. Default: 200.0 + Column coordinate of the center of the ellipse. Default: 200.0 + Orientation of the main axis [rad]. Default: 0.0 + Length of the larger half axis. Default: 100.0 + Length of the smaller half axis. Default: 50.0 + Angle of the start point on the smallest surrounding circle [rad]. Default: 0.0 + Angle of the end point on the smallest surrounding circle [rad]. Default: 6.28318 + point order along the boundary. Default: "positive" + Resolution: Maximum distance between neighboring contour points. Default: 1.5 + + + + Create an XLD contour that corresponds to an elliptic arc. + Modified instance represents: Resulting contour. + + Row coordinate of the center of the ellipse. Default: 200.0 + Column coordinate of the center of the ellipse. Default: 200.0 + Orientation of the main axis [rad]. Default: 0.0 + Length of the larger half axis. Default: 100.0 + Length of the smaller half axis. Default: 50.0 + Angle of the start point on the smallest surrounding circle [rad]. Default: 0.0 + Angle of the end point on the smallest surrounding circle [rad]. Default: 6.28318 + point order along the boundary. Default: "positive" + Resolution: Maximum distance between neighboring contour points. Default: 1.5 + + + + Add noise to XLD contours. + Instance represents: Original contours. + + Number of points used to calculate the regression line. Default: 5 + Maximum amplitude of the added noise (equally distributed in [-Amp,Amp]). Default: 1.0 + Noisy contours. + + + + Approximate XLD contours by polygons. + Instance represents: Contours to be approximated. + + Type of approximation. Default: "ramer" + Threshold for the approximation. Default: 2.0 + Approximating polygons. + + + + Approximate XLD contours by polygons. + Instance represents: Contours to be approximated. + + Type of approximation. Default: "ramer" + Threshold for the approximation. Default: 2.0 + Approximating polygons. + + + + Apply a projective transformation to an XLD contour. + Instance represents: Input contours. + + Homogeneous projective transformation matrix. + Output contours. + + + + Apply an arbitrary affine 2D transformation to XLD contours. + Instance represents: Input XLD contours. + + Input transformation matrix. + Transformed XLD contours. + + + + Close an XLD contour. + Instance represents: Contours to be closed. + + Closed contours. + + + + Clip the end points of an XLD contour. + Instance represents: Input contour + + Clipping mode. Default: "num_points" + Clipping length in unit pixels (Mode $=$ 'length') or number (Mode $=$ 'num_points') Default: 3 + Clipped contour + + + + Clip the end points of an XLD contour. + Instance represents: Input contour + + Clipping mode. Default: "num_points" + Clipping length in unit pixels (Mode $=$ 'length') or number (Mode $=$ 'num_points') Default: 3 + Clipped contour + + + + Clip an XLD contour. + Instance represents: Contours to be clipped. + + Row coordinate of the upper left corner of the clip rectangle. Default: 0 + Column coordinate of the upper left corner of the clip rectangle. Default: 0 + Row coordinate of the lower right corner of the clip rectangle. Default: 512 + Column coordinate of the lower right corner of the clip rectangle. Default: 512 + Clipped contours. + + + + Select XLD contours with a local maximum of gray values. + Instance represents: XLD contours to be examined. + + Corresponding gray value image. + Minimum percentage of maximum points. Default: 70 + Minimum amount by which the gray value at the maximum must be larger than in the profile. Default: 15 + Maximum width of profile used to check for maxima. Default: 4 + Selected contours. + + + + Select XLD contours with a local maximum of gray values. + Instance represents: XLD contours to be examined. + + Corresponding gray value image. + Minimum percentage of maximum points. Default: 70 + Minimum amount by which the gray value at the maximum must be larger than in the profile. Default: 15 + Maximum width of profile used to check for maxima. Default: 4 + Selected contours. + + + + Compute the union of neighboring straight contours that have a similar distance from a given line. + Instance represents: Input XLD contours. + + Output XLD contours. + y coordinate of the starting point of the reference line. Default: 0 + x coordinate of the starting point of the reference line. Default: 0 + y coordinate of the endpoint of the reference line. Default: 0 + x coordinate of the endpoint of the reference line. Default: 0 + Maximum distance. Default: 1 + Maximum Width between two minimas. Default: 1 + Size of Smoothfilter Default: 1 + Output Values of Histogram. + Output XLD contours. + + + + Compute the union of neighboring straight contours that have a similar direction. + Instance represents: Input XLD contours. + + Maximum distance of the contours' endpoints. Default: 5.0 + Maximum difference in direction. Default: 0.5 + Weighting factor for the two selection criteria. Default: 50.0 + Should parallel contours be taken into account? Default: "noparallel" + Number of iterations or 'maximum'. Default: "maximum" + Output XLD contours. + + + + Compute the union of neighboring straight contours that have a similar direction. + Instance represents: Input XLD contours. + + Maximum distance of the contours' endpoints. Default: 5.0 + Maximum difference in direction. Default: 0.5 + Weighting factor for the two selection criteria. Default: 50.0 + Should parallel contours be taken into account? Default: "noparallel" + Number of iterations or 'maximum'. Default: "maximum" + Output XLD contours. + + + + Compute the union of collinear contours (operator with extended functionality). + Instance represents: Input XLD contours. + + Maximum distance of the contours' end points in the direction of the reference regression line. Default: 10.0 + Maximum distance of the contours' end points in the direction of the reference regression line in relation to the length of the contour which is to be elongated. Default: 1.0 + Maximum distance of the contour from the reference regression line (i.e., perpendicular to the line). Default: 2.0 + Maximum angle difference between the two contours. Default: 0.1 + Maximum range of the overlap. Default: 0.0 + Maximum regression error of the resulting contours (NOT USED). Default: -1.0 + Threshold for reducing the total costs of unification. Default: 1.0 + Influence of the distance in the line direction on the total costs. Default: 1.0 + Influence of the distance from the regression line on the total costs. Default: 1.0 + Influence of the angle difference on the total costs. Default: 1.0 + Influence of the line disturbance by the linking segment (overlap and angle difference) on the total costs. Default: 1.0 + Influence of the regression error on the total costs (NOT USED). Default: 0.0 + Mode describing the treatment of the contours' attributes Default: "attr_keep" + Output XLD contours. + + + + Unite approximately collinear contours. + Instance represents: Input XLD contours. + + Maximum length of the gap between two contours, measured along the regression line of the reference contour. Default: 10.0 + Maximum length of the gap between two contours, relative to the length of the reference contour, both measured along the regression line of the reference contour. Default: 1.0 + Maximum distance of the second contour from the regression line of the reference contour. Default: 2.0 + Maximum angle between the regression lines of two contours. Default: 0.1 + Mode that defines the treatment of contour attributes, i.e., if the contour attributes are kept or discarded. Default: "attr_keep" + Output XLD contours. + + + + Compute the union of contours whose end points are close together. + Instance represents: Input XLD contours. + + Maximum distance of the contours' end points. Default: 10.0 + Maximum distance of the contours' end points in relation to the length of the longer contour. Default: 1.0 + Mode describing the treatment of the contours' attributes. Default: "attr_keep" + Output XLD contours. + + + + Select XLD contours according to several features. + Instance represents: Input XLD contours. + + Feature to select contours with. Default: "contour_length" + Lower threshold. Default: 0.5 + Upper threshold. Default: 200.0 + Lower threshold. Default: -0.5 + Upper threshold. Default: 0.5 + Output XLD contours. + + + + Return XLD contour parameters. + Instance represents: Input XLD contours. + + X-coordinate of the normal vector of the regression line. + Y-coordinate of the normal vector of the regression line. + Distance of the regression line from the origin. + X-coordinate of the projection of the start point of the contour onto the regression line. + Y-coordinate of the projection of the start point of the contour onto the regression line. + X-coordinate of the projection of the end point of the contour onto the regression line. + Y-coordinate of the projection of the end point of the contour onto the regression line. + Mean distance of the contour points from the regression line. + Standard deviation of the distances from the regression line. + Number of contour points. + + + + Calculate the parameters of a regression line to an XLD contour. + Instance represents: Input XLD contours. + + Type of outlier treatment. Default: "no" + Number of iterations for the outlier treatment. Default: 1 + Resulting XLD contours. + + + + Calculate the direction of an XLD contour for each contour point. + Instance represents: Input contour. + + Return type of the angles. Default: "abs" + Method for computing the angles. Default: "range" + Number of points to take into account. Default: 3 + Direction of the tangent to the contour points. + + + + Smooth an XLD contour. + Instance represents: Contour to be smoothed. + + Number of points used to calculate the regression line. Default: 5 + Smoothed contour. + + + + Return the number of points in an XLD contour. + Instance represents: Input XLD contour. + + Number of contour points. + + + + Return the names of the defined global attributes of an XLD contour. + Instance represents: Input contour. + + List of the defined global contour attributes. + + + + Return global attributes values of an XLD contour. + Instance represents: Input XLD contour. + + Name of the attribute. Default: "regr_norm_row" + Attribute values. + + + + Return global attributes values of an XLD contour. + Instance represents: Input XLD contour. + + Name of the attribute. Default: "regr_norm_row" + Attribute values. + + + + Return the names of the defined attributes of an XLD contour. + Instance represents: Input contour. + + List of the defined contour attributes. + + + + Return point attribute values of an XLD contour. + Instance represents: Input XLD contour. + + Name of the attribute. Default: "angle" + Attribute values. + + + + Return the coordinates of an XLD contour. + Instance represents: Input XLD contour. + + Row coordinate of the contour's points. + Column coordinate of the contour's points. + + + + Generate an XLD contour with rounded corners from a polygon (given as tuples). + Modified instance represents: Resulting contour. + + Row coordinates of the polygon. Default: [20,80,80,20,20] + Column coordinates of the polygon. Default: [20,20,80,80,20] + Radii of the rounded corners. Default: [20,20,20,20,20] + Distance of the samples. Default: 1.0 + + + + Generate an XLD contour with rounded corners from a polygon (given as tuples). + Modified instance represents: Resulting contour. + + Row coordinates of the polygon. Default: [20,80,80,20,20] + Column coordinates of the polygon. Default: [20,20,80,80,20] + Radii of the rounded corners. Default: [20,20,20,20,20] + Distance of the samples. Default: 1.0 + + + + Generate an XLD contour from a polygon (given as tuples). + Modified instance represents: Resulting contour. + + Row coordinates of the polygon. Default: [0,1,2,2,2] + Column coordinates of the polygon. Default: [0,0,0,1,2] + + + + Calculate the difference of two object tuples. + Instance represents: Object tuple 1. + + Object tuple 2. + Objects from Objects that are not part of ObjectsSub. + + + + Copy an iconic object in the HALCON database. + Instance represents: Objects to be copied. + + Starting index of the objects to be copied. Default: 1 + Number of objects to be copied or -1. Default: 1 + Copied objects. + + + + Concatenate two iconic object tuples. + Instance represents: Object tuple 1. + + Object tuple 2. + Concatenated objects. + + + + Select objects from an object tuple. + Instance represents: Input objects. + + Indices of the objects to be selected. Default: 1 + Selected objects. + + + + Select objects from an object tuple. + Instance represents: Input objects. + + Indices of the objects to be selected. Default: 1 + Selected objects. + + + + Compare iconic objects regarding equality. + Instance represents: Reference objects. + + Test objects. + Maximum allowed difference between two gray values or coordinates etc. Default: 0.0 + Boolean result value. + + + + Compare iconic objects regarding equality. + Instance represents: Reference objects. + + Test objects. + Maximum allowed difference between two gray values or coordinates etc. Default: 0.0 + Boolean result value. + + + + Compare image objects regarding equality. + Instance represents: Test objects. + + Comparative objects. + boolean result value. + + + + Create a region from an XLD contour. + Instance represents: Input contour(s). + + Fill mode of the region(s). Default: "filled" + Created region(s). + + + + Prepare an anisotropically scaled shape model for matching from XLD contours. + Instance represents: Input contours that will be used to create the model. + + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in the row direction. Default: 0.9 + Maximum scale of the pattern in the row direction. Default: 1.1 + Scale step length (resolution) in the row direction. Default: "auto" + Minimum scale of the pattern in the column direction. Default: 0.9 + Maximum scale of the pattern in the column direction. Default: 1.1 + Scale step length (resolution) in the column direction. Default: "auto" + Kind of optimization and optionally method used for generating the model. Default: "auto" + Match metric. Default: "ignore_local_polarity" + Minimum contrast of the objects in the search images. Default: 5 + Handle of the model. + + + + Prepare an anisotropically scaled shape model for matching from XLD contours. + Instance represents: Input contours that will be used to create the model. + + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in the row direction. Default: 0.9 + Maximum scale of the pattern in the row direction. Default: 1.1 + Scale step length (resolution) in the row direction. Default: "auto" + Minimum scale of the pattern in the column direction. Default: 0.9 + Maximum scale of the pattern in the column direction. Default: 1.1 + Scale step length (resolution) in the column direction. Default: "auto" + Kind of optimization and optionally method used for generating the model. Default: "auto" + Match metric. Default: "ignore_local_polarity" + Minimum contrast of the objects in the search images. Default: 5 + Handle of the model. + + + + Prepare an isotropically scaled shape model for matching from XLD contours. + Instance represents: Input contours that will be used to create the model. + + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern. Default: 0.9 + Maximum scale of the pattern. Default: 1.1 + Scale step length (resolution). Default: "auto" + Kind of optimization and optionally method used for generating the model. Default: "auto" + Match metric. Default: "ignore_local_polarity" + Minimum contrast of the objects in the search images. Default: 5 + Handle of the model. + + + + Prepare an isotropically scaled shape model for matching from XLD contours. + Instance represents: Input contours that will be used to create the model. + + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern. Default: 0.9 + Maximum scale of the pattern. Default: 1.1 + Scale step length (resolution). Default: "auto" + Kind of optimization and optionally method used for generating the model. Default: "auto" + Match metric. Default: "ignore_local_polarity" + Minimum contrast of the objects in the search images. Default: 5 + Handle of the model. + + + + Prepare a shape model for matching from XLD contours. + Instance represents: Input contours that will be used to create the model. + + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Kind of optimization and optionally method used for generating the model. Default: "auto" + Match metric. Default: "ignore_local_polarity" + Minimum contrast of the objects in the search images. Default: 5 + Handle of the model. + + + + Prepare a shape model for matching from XLD contours. + Instance represents: Input contours that will be used to create the model. + + Maximum number of pyramid levels. Default: "auto" + Smallest rotation of the pattern. Default: -0.39 + Extent of the rotation angles. Default: 0.79 + Step length of the angles (resolution). Default: "auto" + Kind of optimization and optionally method used for generating the model. Default: "auto" + Match metric. Default: "ignore_local_polarity" + Minimum contrast of the objects in the search images. Default: 5 + Handle of the model. + + + + Prepare a deformable model for local deformable matching from XLD contours. + Instance represents: Input contours that will be used to create the model. + + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "auto" + Match metric. Default: "ignore_local_polarity" + Minimum contrast of the objects in the search images. Default: 5 + The generic parameter names. Default: [] + Values of the generic parameters. Default: [] + Handle of the model. + + + + Prepare a deformable model for local deformable matching from XLD contours. + Instance represents: Input contours that will be used to create the model. + + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "auto" + Match metric. Default: "ignore_local_polarity" + Minimum contrast of the objects in the search images. Default: 5 + The generic parameter names. Default: [] + Values of the generic parameters. Default: [] + Handle of the model. + + + + Prepare a deformable model for planar calibrated matching from XLD contours. + Instance represents: Input contours that will be used to create the model. + + The parameters of the internal orientation of the camera. + The reference pose of the object. + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in the column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "auto" + Match metric. Default: "ignore_local_polarity" + Minimum contrast of the objects in the search images. Default: 5 + The generic parameter names. Default: [] + Values of the generic parameter. Default: [] + Handle of the model. + + + + Prepare a deformable model for planar calibrated matching from XLD contours. + Instance represents: Input contours that will be used to create the model. + + The parameters of the internal orientation of the camera. + The reference pose of the object. + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in the column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "auto" + Match metric. Default: "ignore_local_polarity" + Minimum contrast of the objects in the search images. Default: 5 + The generic parameter names. Default: [] + Values of the generic parameter. Default: [] + Handle of the model. + + + + Prepare a deformable model for planar uncalibrated matching from XLD contours. + Instance represents: Input contours that will be used to create the model. + + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in the column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "auto" + Match metric. Default: "ignore_local_polarity" + Minimum contrast of the objects in the search images. Default: 5 + The generic parameter names. Default: [] + Values of the generic parameters. Default: [] + Handle of the model. + + + + Prepare a deformable model for planar uncalibrated matching from XLD contours. + Instance represents: Input contours that will be used to create the model. + + Maximum number of pyramid levels. Default: "auto" + This parameter is not used. Default: [] + This parameter is not used. Default: [] + Step length of the angles (resolution). Default: "auto" + Minimum scale of the pattern in row direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in row direction. Default: "auto" + Minimum scale of the pattern in column direction. Default: 1.0 + This parameter is not used. Default: [] + Scale step length (resolution) in the column direction. Default: "auto" + Kind of optimization used for generating the model. Default: "auto" + Match metric. Default: "ignore_local_polarity" + Minimum contrast of the objects in the search images. Default: 5 + The generic parameter names. Default: [] + Values of the generic parameters. Default: [] + Handle of the model. + + + + Compute the mapping between the distorted image and the rectified image based upon the points of a regular grid. + Instance represents: Input contours. + + Input image. + Output contours. + Distance of the grid points in the rectified image. + Rotation to be applied to the point grid. Default: "auto" + Row coordinates of the grid points. + Column coordinates of the grid points. + Type of mapping. Default: "bilinear" + Image containing the mapping data. + + + + Compute the mapping between the distorted image and the rectified image based upon the points of a regular grid. + Instance represents: Input contours. + + Input image. + Output contours. + Distance of the grid points in the rectified image. + Rotation to be applied to the point grid. Default: "auto" + Row coordinates of the grid points. + Column coordinates of the grid points. + Type of mapping. Default: "bilinear" + Image containing the mapping data. + + + + Interactive modification of a NURBS curve using interpolation. + Modified instance represents: Contour of the modified curve. + + Window handle. + Enable rotation? Default: "true" + Enable moving? Default: "true" + Enable scaling? Default: "true" + Keep ratio while scaling? Default: "true" + Enable editing? Default: "true" + The degree $p$ of the NURBS curve. Reasonable values are 3 to 5. Default: 3 + Row coordinates of the input interpolation points. + Column coordinates of the input interpolation points. + Input tangents. + Row coordinates of the control polygon. + Column coordinates of the control polygon. + Knot vector. + Row coordinates of the points specified by the user. + Column coordinates of the points specified by the user. + Tangents specified by the user. + + + + Interactive drawing of a NURBS curve using interpolation. + Modified instance represents: Contour of the curve. + + Window handle. + Enable rotation? Default: "true" + Enable moving? Default: "true" + Enable scaling? Default: "true" + Keep ratio while scaling? Default: "true" + The degree $p$ of the NURBS curve. Reasonable values are 3 to 5. Default: 3 + Row coordinates of the control polygon. + Column coordinates of the control polygon. + Knot vector. + Row coordinates of the points specified by the user. + Column coordinates of the points specified by the user. + Tangents specified by the user. + + + + Interactive modification of a NURBS curve. + Modified instance represents: Contour of the modified curve. + + Window handle. + Enable rotation? Default: "true" + Enable moving? Default: "true" + Enable scaling? Default: "true" + Keep ratio while scaling? Default: "true" + Enable editing? Default: "true" + The degree $p$ of the NURBS curve. Reasonable values are 3 to 25. Default: 3 + Row coordinates of the input control polygon. + Column coordinates of the input control polygon. + Input weight vector. + Row coordinates of the control polygon. + Columns coordinates of the control polygon. + Weight vector. + + + + Interactive drawing of a NURBS curve. + Modified instance represents: Contour approximating the NURBS curve. + + Window handle. + Enable rotation? Default: "true" + Enable moving? Default: "true" + Enable scaling? Default: "true" + Keep ratio while scaling? Default: "true" + The degree $p$ of the NURBS curve. Reasonable values are 3 to 25. Default: 3 + Row coordinates of the control polygon. + Columns coordinates of the control polygon. + Weight vector. + + + + Interactive modification of a contour. + Instance represents: Input contour. + + Window handle. + Enable rotation? Default: "true" + Enable moving? Default: "true" + Enable scaling? Default: "true" + Keep ratio while scaling? Default: "true" + Enable editing? Default: "true" + Modified contour. + + + + Interactive drawing of a contour. + Modified instance represents: Modified contour. + + Window handle. + Enable rotation? Default: "true" + Enable moving? Default: "true" + Enable scaling? Default: "true" + Keep ratio while scaling? Default: "true" + + + + Calculate the pointwise distance from one contour to another. + Instance represents: Contours for whose points the distances are calculated. + + Contours to which the distances are calculated to. + Compute the distance to points ('point_to_point') or to entire segments ('point_to_segment'). Default: "point_to_point" + Copy of ContourFrom containing the distances as an attribute. + + + + Calculate the minimum distance between two contours. + Instance represents: First input contour. + + Second input contour. + Distance calculation mode. Default: "fast_point_to_segment" + Minimum distance between the two contours. + + + + Calculate the distance between two contours. + Instance represents: First input contour. + + Second input contour. + Distance calculation mode. Default: "point_to_point" + Minimum distance between both contours. + Maximum distance between both contours. + + + + Calculate the distance between two contours. + Instance represents: First input contour. + + Second input contour. + Distance calculation mode. Default: "point_to_point" + Minimum distance between both contours. + Maximum distance between both contours. + + + + Calculate the distance between a line segment and one contour. + Instance represents: Input contour. + + Row coordinate of the first point of the line segment. + Column coordinate of the first point of the line segment. + Row coordinate of the second point of the line segment. + Column coordinate of the second point of the line segment. + Minimum distance between the line segment and the contour. + Maximum distance between the line segment and the contour. + + + + Calculate the distance between a line segment and one contour. + Instance represents: Input contour. + + Row coordinate of the first point of the line segment. + Column coordinate of the first point of the line segment. + Row coordinate of the second point of the line segment. + Column coordinate of the second point of the line segment. + Minimum distance between the line segment and the contour. + Maximum distance between the line segment and the contour. + + + + Calculate the distance between a line and one contour. + Instance represents: Input contour. + + Row coordinate of the first point of the line. + Column coordinate of the first point of the line. + Row coordinate of the second point of the line. + Column coordinate of the second point of the line. + Minimum distance between the line and the contour. + Maximum distance between the line and the contour. + + + + Calculate the distance between a line and one contour. + Instance represents: Input contour. + + Row coordinate of the first point of the line. + Column coordinate of the first point of the line. + Row coordinate of the second point of the line. + Column coordinate of the second point of the line. + Minimum distance between the line and the contour. + Maximum distance between the line and the contour. + + + + Calculate the distance between a point and one contour. + Instance represents: Input contour. + + Row coordinate of the point. + Column coordinate of the point. + Minimum distance between the point and the contour. + Maximum distance between the point and the contour. + + + + Calculate the distance between a point and one contour. + Instance represents: Input contour. + + Row coordinate of the point. + Column coordinate of the point. + Minimum distance between the point and the contour. + Maximum distance between the point and the contour. + + + + Read XLD contours from a DXF file. + Modified instance represents: Read XLD contours. + + Name of the DXF file. + Names of the generic parameters that can be adjusted for the DXF input. Default: [] + Values of the generic parameters that can be adjusted for the DXF input. Default: [] + Status information. + + + + Read XLD contours from a DXF file. + Modified instance represents: Read XLD contours. + + Name of the DXF file. + Names of the generic parameters that can be adjusted for the DXF input. Default: [] + Values of the generic parameters that can be adjusted for the DXF input. Default: [] + Status information. + + + + Write XLD contours to a file in DXF format. + Instance represents: XLD contours to be written. + + Name of the DXF file. + + + + Choose all contours or polygons containing a given point. + Instance represents: Contours or polygons to be examined. + + Line coordinate of the test point. Default: 100.0 + Column coordinate of the test point. Default: 100.0 + All contours or polygons containing the test point. + + + + Choose all contours or polygons containing a given point. + Instance represents: Contours or polygons to be examined. + + Line coordinate of the test point. Default: 100.0 + Column coordinate of the test point. Default: 100.0 + All contours or polygons containing the test point. + + + + Select contours or polygons using shape features. + Instance represents: Contours or polygons to be examined. + + Shape features to be checked. Default: "area" + Operation type between the individual features. Default: "and" + Lower limits of the features or 'min'. Default: 150.0 + Upper limits of the features or 'max'. Default: 99999.0 + Contours or polygons fulfilling the condition(s). + + + + Select contours or polygons using shape features. + Instance represents: Contours or polygons to be examined. + + Shape features to be checked. Default: "area" + Operation type between the individual features. Default: "and" + Lower limits of the features or 'min'. Default: 150.0 + Upper limits of the features or 'max'. Default: 99999.0 + Contours or polygons fulfilling the condition(s). + + + + Transform the shape of contours or polygons. + Instance represents: Contours or polygons to be transformed. + + Type of transformation. Default: "convex" + Transformed contours respectively polygons. + + + + Calibrate the radial distortion. + Instance represents: Contours that are available for the calibration. + + Width of the images from which the contours were extracted. Default: 640 + Height of the images from which the contours were extracted. Default: 480 + Threshold for the classification of outliers. Default: 0.05 + Seed value for the random number generator. Default: 42 + Determines the distortion model. Default: "division" + Determines how the distortion center will be estimated. Default: "variable" + Controls the deviation of the distortion center from the image center; larger values allow larger deviations from the image center; 0 switches the penalty term off. Default: 0.0 + Internal camera parameters. + Contours that were used for the calibration + + + + Transform an XLD contour into the plane z=0 of a world coordinate system. + Instance represents: Input XLD contours to be transformed in image coordinates. + + Internal camera parameters. + 3D pose of the world coordinate system in camera coordinates. + Scale or dimension Default: "m" + Transformed XLD contours in world coordinates. + + + + Transform an XLD contour into the plane z=0 of a world coordinate system. + Instance represents: Input XLD contours to be transformed in image coordinates. + + Internal camera parameters. + 3D pose of the world coordinate system in camera coordinates. + Scale or dimension Default: "m" + Transformed XLD contours in world coordinates. + + + + Change the radial distortion of contours. + Instance represents: Original contours. + + Internal camera parameter for Contours. + Internal camera parameter for ContoursRectified. + Resulting contours with modified radial distortion. + + + + Calculate the minimum distance between two contours and the points used for the calculation. + Instance represents: First input contour. + + Second input contour. + Distance calculation mode. Default: "fast_point_to_segment" + Row coordinate of the point on Contour1. + Column coordinate of the point on Contour1. + Row coordinate of the point on Contour2. + Column coordinate of the point on Contour2. + Minimum distance between the two contours. + + + + Calculate the minimum distance between two contours and the points used for the calculation. + Instance represents: First input contour. + + Second input contour. + Distance calculation mode. Default: "fast_point_to_segment" + Row coordinate of the point on Contour1. + Column coordinate of the point on Contour1. + Row coordinate of the point on Contour2. + Column coordinate of the point on Contour2. + Minimum distance between the two contours. + + + + Insert objects into an iconic object tuple. + Instance represents: Input object tuple. + + Object tuple to insert. + Index to insert objects. + Extended object tuple. + + + + Remove objects from an iconic object tuple. + Instance represents: Input object tuple. + + Indices of the objects to be removed. + Remaining object tuple. + + + + Remove objects from an iconic object tuple. + Instance represents: Input object tuple. + + Indices of the objects to be removed. + Remaining object tuple. + + + + Replaces one or more elements of an iconic object tuple. + Instance represents: Iconic Input Object. + + Element(s) to replace. + Index/Indices of elements to be replaced. + Tuple with replaced elements. + + + + Replaces one or more elements of an iconic object tuple. + Instance represents: Iconic Input Object. + + Element(s) to replace. + Index/Indices of elements to be replaced. + Tuple with replaced elements. + + + Returns the iconic object(s) at the specified index + + + Represents an instance of a XLD distance transformation. + + + + Read an XLD distance transform from a file. + Modified instance represents: Handle of the XLD distance transform. + + Name of the file. + + + + Create the XLD distance transform. + Modified instance represents: Handle of the XLD distance transform. + + Reference contour(s). + Compute the distance to points ('point_to_point') or entire segments ('point_to_segment'). Default: "point_to_point" + Maximum distance of interest. Default: 20.0 + + + + Create the XLD distance transform. + Modified instance represents: Handle of the XLD distance transform. + + Reference contour(s). + Compute the distance to points ('point_to_point') or entire segments ('point_to_segment'). Default: "point_to_point" + Maximum distance of interest. Default: 20.0 + + + Serialize object to binary stream in HALCON format + + + Deserialize object from binary stream in HALCON format + + + + Clear a XLD distance transform. + Instance represents: Handle of the XLD distance transform. + + + + + Determine the pointwise distance of two contours using an XLD distance transform. + Instance represents: Handle of the XLD distance transform of the reference contour. + + Contour(s) for whose points the distances are calculated. + Copy of Contour containing the distances as an attribute. + + + + Read an XLD distance transform from a file. + Modified instance represents: Handle of the XLD distance transform. + + Name of the file. + + + + Deserialize an XLD distance transform. + Modified instance represents: Handle of the deserialized XLD distance transform. + + Handle of the serialized XLD distance transform. + + + + Serialize an XLD distance transform. + Instance represents: Handle of the XLD distance transform. + + Handle of the serialized XLD distance transform. + + + + Write an XLD distance transform into a file. + Instance represents: Handle of the XLD distance transform. + + Name of the file. + + + + Set new parameters for an XLD distance transform. + Instance represents: Handle of the XLD distance transform. + + Names of the generic parameters. Default: "mode" + Values of the generic parameters. Default: "point_to_point" + + + + Set new parameters for an XLD distance transform. + Instance represents: Handle of the XLD distance transform. + + Names of the generic parameters. Default: "mode" + Values of the generic parameters. Default: "point_to_point" + + + + Get the parameters used to build an XLD distance transform. + Instance represents: Handle of the XLD distance transform. + + Names of the generic parameters. Default: "mode" + Values of the generic parameters. + + + + Get the parameters used to build an XLD distance transform. + Instance represents: Handle of the XLD distance transform. + + Names of the generic parameters. Default: "mode" + Values of the generic parameters. + + + + Get the reference contour used to build the XLD distance transform. + Instance represents: Handle of the XLD distance transform. + + Reference contour. + + + + Create the XLD distance transform. + Modified instance represents: Handle of the XLD distance transform. + + Reference contour(s). + Compute the distance to points ('point_to_point') or entire segments ('point_to_segment'). Default: "point_to_point" + Maximum distance of interest. Default: 20.0 + + + + Create the XLD distance transform. + Modified instance represents: Handle of the XLD distance transform. + + Reference contour(s). + Compute the distance to points ('point_to_point') or entire segments ('point_to_segment'). Default: "point_to_point" + Maximum distance of interest. Default: 20.0 + + + Represents an instance of an XLD extended parallel object(-array). + + + Create an uninitialized iconic object + + + + Join modified XLD parallels lying on the same polygon. + Instance represents: Extended XLD parallels. + + Maximally extended parallels. + + + + Calculate the difference of two object tuples. + Instance represents: Object tuple 1. + + Object tuple 2. + Objects from Objects that are not part of ObjectsSub. + + + + Copy an iconic object in the HALCON database. + Instance represents: Objects to be copied. + + Starting index of the objects to be copied. Default: 1 + Number of objects to be copied or -1. Default: 1 + Copied objects. + + + + Concatenate two iconic object tuples. + Instance represents: Object tuple 1. + + Object tuple 2. + Concatenated objects. + + + + Select objects from an object tuple. + Instance represents: Input objects. + + Indices of the objects to be selected. Default: 1 + Selected objects. + + + + Select objects from an object tuple. + Instance represents: Input objects. + + Indices of the objects to be selected. Default: 1 + Selected objects. + + + + Compare iconic objects regarding equality. + Instance represents: Reference objects. + + Test objects. + Maximum allowed difference between two gray values or coordinates etc. Default: 0.0 + Boolean result value. + + + + Compare iconic objects regarding equality. + Instance represents: Reference objects. + + Test objects. + Maximum allowed difference between two gray values or coordinates etc. Default: 0.0 + Boolean result value. + + + + Compare image objects regarding equality. + Instance represents: Test objects. + + Comparative objects. + boolean result value. + + + + Compute the mapping between the distorted image and the rectified image based upon the points of a regular grid. + Instance represents: Input contours. + + Input image. + Output contours. + Distance of the grid points in the rectified image. + Rotation to be applied to the point grid. Default: "auto" + Row coordinates of the grid points. + Column coordinates of the grid points. + Type of mapping. Default: "bilinear" + Image containing the mapping data. + + + + Compute the mapping between the distorted image and the rectified image based upon the points of a regular grid. + Instance represents: Input contours. + + Input image. + Output contours. + Distance of the grid points in the rectified image. + Rotation to be applied to the point grid. Default: "auto" + Row coordinates of the grid points. + Column coordinates of the grid points. + Type of mapping. Default: "bilinear" + Image containing the mapping data. + + + + Choose all contours or polygons containing a given point. + Instance represents: Contours or polygons to be examined. + + Line coordinate of the test point. Default: 100.0 + Column coordinate of the test point. Default: 100.0 + All contours or polygons containing the test point. + + + + Choose all contours or polygons containing a given point. + Instance represents: Contours or polygons to be examined. + + Line coordinate of the test point. Default: 100.0 + Column coordinate of the test point. Default: 100.0 + All contours or polygons containing the test point. + + + + Select contours or polygons using shape features. + Instance represents: Contours or polygons to be examined. + + Shape features to be checked. Default: "area" + Operation type between the individual features. Default: "and" + Lower limits of the features or 'min'. Default: 150.0 + Upper limits of the features or 'max'. Default: 99999.0 + Contours or polygons fulfilling the condition(s). + + + + Select contours or polygons using shape features. + Instance represents: Contours or polygons to be examined. + + Shape features to be checked. Default: "area" + Operation type between the individual features. Default: "and" + Lower limits of the features or 'min'. Default: 150.0 + Upper limits of the features or 'max'. Default: 99999.0 + Contours or polygons fulfilling the condition(s). + + + + Transform the shape of contours or polygons. + Instance represents: Contours or polygons to be transformed. + + Type of transformation. Default: "convex" + Transformed contours respectively polygons. + + + + Insert objects into an iconic object tuple. + Instance represents: Input object tuple. + + Object tuple to insert. + Index to insert objects. + Extended object tuple. + + + + Remove objects from an iconic object tuple. + Instance represents: Input object tuple. + + Indices of the objects to be removed. + Remaining object tuple. + + + + Remove objects from an iconic object tuple. + Instance represents: Input object tuple. + + Indices of the objects to be removed. + Remaining object tuple. + + + + Replaces one or more elements of an iconic object tuple. + Instance represents: Iconic Input Object. + + Element(s) to replace. + Index/Indices of elements to be replaced. + Tuple with replaced elements. + + + + Replaces one or more elements of an iconic object tuple. + Instance represents: Iconic Input Object. + + Element(s) to replace. + Index/Indices of elements to be replaced. + Tuple with replaced elements. + + + Returns the iconic object(s) at the specified index + + + Represents an instance of an XLD modified parallel object(-array). + + + Create an uninitialized iconic object + + + + Combine road hypotheses from two resolution levels. + Instance represents: Modified parallels obtained from EdgePolygons. + + XLD polygons to be examined. + Extended parallels obtained from EdgePolygons. + Road-center-line polygons to be examined. + Maximum angle between two parallel line segments. Default: 0.523598775598 + Maximum angle between two collinear line segments. Default: 0.261799387799 + Maximum distance between two parallel line segments. Default: 40 + Maximum distance between two collinear line segments. Default: 40 + Roadsides found. + + + + Combine road hypotheses from two resolution levels. + Instance represents: Modified parallels obtained from EdgePolygons. + + XLD polygons to be examined. + Extended parallels obtained from EdgePolygons. + Road-center-line polygons to be examined. + Maximum angle between two parallel line segments. Default: 0.523598775598 + Maximum angle between two collinear line segments. Default: 0.261799387799 + Maximum distance between two parallel line segments. Default: 40 + Maximum distance between two collinear line segments. Default: 40 + Roadsides found. + + + + Calculate the difference of two object tuples. + Instance represents: Object tuple 1. + + Object tuple 2. + Objects from Objects that are not part of ObjectsSub. + + + + Copy an iconic object in the HALCON database. + Instance represents: Objects to be copied. + + Starting index of the objects to be copied. Default: 1 + Number of objects to be copied or -1. Default: 1 + Copied objects. + + + + Concatenate two iconic object tuples. + Instance represents: Object tuple 1. + + Object tuple 2. + Concatenated objects. + + + + Select objects from an object tuple. + Instance represents: Input objects. + + Indices of the objects to be selected. Default: 1 + Selected objects. + + + + Select objects from an object tuple. + Instance represents: Input objects. + + Indices of the objects to be selected. Default: 1 + Selected objects. + + + + Compare iconic objects regarding equality. + Instance represents: Reference objects. + + Test objects. + Maximum allowed difference between two gray values or coordinates etc. Default: 0.0 + Boolean result value. + + + + Compare iconic objects regarding equality. + Instance represents: Reference objects. + + Test objects. + Maximum allowed difference between two gray values or coordinates etc. Default: 0.0 + Boolean result value. + + + + Compare image objects regarding equality. + Instance represents: Test objects. + + Comparative objects. + boolean result value. + + + + Compute the mapping between the distorted image and the rectified image based upon the points of a regular grid. + Instance represents: Input contours. + + Input image. + Output contours. + Distance of the grid points in the rectified image. + Rotation to be applied to the point grid. Default: "auto" + Row coordinates of the grid points. + Column coordinates of the grid points. + Type of mapping. Default: "bilinear" + Image containing the mapping data. + + + + Compute the mapping between the distorted image and the rectified image based upon the points of a regular grid. + Instance represents: Input contours. + + Input image. + Output contours. + Distance of the grid points in the rectified image. + Rotation to be applied to the point grid. Default: "auto" + Row coordinates of the grid points. + Column coordinates of the grid points. + Type of mapping. Default: "bilinear" + Image containing the mapping data. + + + + Choose all contours or polygons containing a given point. + Instance represents: Contours or polygons to be examined. + + Line coordinate of the test point. Default: 100.0 + Column coordinate of the test point. Default: 100.0 + All contours or polygons containing the test point. + + + + Choose all contours or polygons containing a given point. + Instance represents: Contours or polygons to be examined. + + Line coordinate of the test point. Default: 100.0 + Column coordinate of the test point. Default: 100.0 + All contours or polygons containing the test point. + + + + Select contours or polygons using shape features. + Instance represents: Contours or polygons to be examined. + + Shape features to be checked. Default: "area" + Operation type between the individual features. Default: "and" + Lower limits of the features or 'min'. Default: 150.0 + Upper limits of the features or 'max'. Default: 99999.0 + Contours or polygons fulfilling the condition(s). + + + + Select contours or polygons using shape features. + Instance represents: Contours or polygons to be examined. + + Shape features to be checked. Default: "area" + Operation type between the individual features. Default: "and" + Lower limits of the features or 'min'. Default: 150.0 + Upper limits of the features or 'max'. Default: 99999.0 + Contours or polygons fulfilling the condition(s). + + + + Transform the shape of contours or polygons. + Instance represents: Contours or polygons to be transformed. + + Type of transformation. Default: "convex" + Transformed contours respectively polygons. + + + + Insert objects into an iconic object tuple. + Instance represents: Input object tuple. + + Object tuple to insert. + Index to insert objects. + Extended object tuple. + + + + Remove objects from an iconic object tuple. + Instance represents: Input object tuple. + + Indices of the objects to be removed. + Remaining object tuple. + + + + Remove objects from an iconic object tuple. + Instance represents: Input object tuple. + + Indices of the objects to be removed. + Remaining object tuple. + + + + Replaces one or more elements of an iconic object tuple. + Instance represents: Iconic Input Object. + + Element(s) to replace. + Index/Indices of elements to be replaced. + Tuple with replaced elements. + + + + Replaces one or more elements of an iconic object tuple. + Instance represents: Iconic Input Object. + + Element(s) to replace. + Index/Indices of elements to be replaced. + Tuple with replaced elements. + + + Returns the iconic object(s) at the specified index + + + Represents an instance of an XLD parallel object(-array). + + + Create an uninitialized iconic object + + + + Extract parallel XLD polygons enclosing a homogeneous area. + Instance represents: Input XLD parallels. + + Corresponding gray value image. + Extended XLD parallels. + Minimum quality factor (measure of parallelism). Default: 0.4 + Minimum mean gray value. Default: 160 + Maximum mean gray value. Default: 220 + Maximum allowed standard deviation. Default: 10.0 + Modified XLD parallels. + + + + Extract parallel XLD polygons enclosing a homogeneous area. + Instance represents: Input XLD parallels. + + Corresponding gray value image. + Extended XLD parallels. + Minimum quality factor (measure of parallelism). Default: 0.4 + Minimum mean gray value. Default: 160 + Maximum mean gray value. Default: 220 + Maximum allowed standard deviation. Default: 10.0 + Modified XLD parallels. + + + + Return information about the gray values of the area enclosed by XLD parallels. + Instance represents: Input XLD Parallels. + + Corresponding gray value image. + Minimum quality factor. + Maximum quality factor. + Minimum mean gray value. + Maximum mean gray value. + Minimum standard deviation. + Maximum standard deviation. + + + + Calculate the difference of two object tuples. + Instance represents: Object tuple 1. + + Object tuple 2. + Objects from Objects that are not part of ObjectsSub. + + + + Copy an iconic object in the HALCON database. + Instance represents: Objects to be copied. + + Starting index of the objects to be copied. Default: 1 + Number of objects to be copied or -1. Default: 1 + Copied objects. + + + + Concatenate two iconic object tuples. + Instance represents: Object tuple 1. + + Object tuple 2. + Concatenated objects. + + + + Select objects from an object tuple. + Instance represents: Input objects. + + Indices of the objects to be selected. Default: 1 + Selected objects. + + + + Select objects from an object tuple. + Instance represents: Input objects. + + Indices of the objects to be selected. Default: 1 + Selected objects. + + + + Compare iconic objects regarding equality. + Instance represents: Reference objects. + + Test objects. + Maximum allowed difference between two gray values or coordinates etc. Default: 0.0 + Boolean result value. + + + + Compare iconic objects regarding equality. + Instance represents: Reference objects. + + Test objects. + Maximum allowed difference between two gray values or coordinates etc. Default: 0.0 + Boolean result value. + + + + Compare image objects regarding equality. + Instance represents: Test objects. + + Comparative objects. + boolean result value. + + + + Compute the mapping between the distorted image and the rectified image based upon the points of a regular grid. + Instance represents: Input contours. + + Input image. + Output contours. + Distance of the grid points in the rectified image. + Rotation to be applied to the point grid. Default: "auto" + Row coordinates of the grid points. + Column coordinates of the grid points. + Type of mapping. Default: "bilinear" + Image containing the mapping data. + + + + Compute the mapping between the distorted image and the rectified image based upon the points of a regular grid. + Instance represents: Input contours. + + Input image. + Output contours. + Distance of the grid points in the rectified image. + Rotation to be applied to the point grid. Default: "auto" + Row coordinates of the grid points. + Column coordinates of the grid points. + Type of mapping. Default: "bilinear" + Image containing the mapping data. + + + + Choose all contours or polygons containing a given point. + Instance represents: Contours or polygons to be examined. + + Line coordinate of the test point. Default: 100.0 + Column coordinate of the test point. Default: 100.0 + All contours or polygons containing the test point. + + + + Choose all contours or polygons containing a given point. + Instance represents: Contours or polygons to be examined. + + Line coordinate of the test point. Default: 100.0 + Column coordinate of the test point. Default: 100.0 + All contours or polygons containing the test point. + + + + Select contours or polygons using shape features. + Instance represents: Contours or polygons to be examined. + + Shape features to be checked. Default: "area" + Operation type between the individual features. Default: "and" + Lower limits of the features or 'min'. Default: 150.0 + Upper limits of the features or 'max'. Default: 99999.0 + Contours or polygons fulfilling the condition(s). + + + + Select contours or polygons using shape features. + Instance represents: Contours or polygons to be examined. + + Shape features to be checked. Default: "area" + Operation type between the individual features. Default: "and" + Lower limits of the features or 'min'. Default: 150.0 + Upper limits of the features or 'max'. Default: 99999.0 + Contours or polygons fulfilling the condition(s). + + + + Transform the shape of contours or polygons. + Instance represents: Contours or polygons to be transformed. + + Type of transformation. Default: "convex" + Transformed contours respectively polygons. + + + + Insert objects into an iconic object tuple. + Instance represents: Input object tuple. + + Object tuple to insert. + Index to insert objects. + Extended object tuple. + + + + Remove objects from an iconic object tuple. + Instance represents: Input object tuple. + + Indices of the objects to be removed. + Remaining object tuple. + + + + Remove objects from an iconic object tuple. + Instance represents: Input object tuple. + + Indices of the objects to be removed. + Remaining object tuple. + + + + Replaces one or more elements of an iconic object tuple. + Instance represents: Iconic Input Object. + + Element(s) to replace. + Index/Indices of elements to be replaced. + Tuple with replaced elements. + + + + Replaces one or more elements of an iconic object tuple. + Instance represents: Iconic Input Object. + + Element(s) to replace. + Index/Indices of elements to be replaced. + Tuple with replaced elements. + + + Returns the iconic object(s) at the specified index + + + Represents an instance of an XLD polygon object(-array). + + + Create an uninitialized iconic object + + + + Compute the union of closed polygons. + Instance represents: Polygons enclosing the first region. + + Polygons enclosing the second region. + Polygons enclosing the union. + + + + Compute the symmetric difference of closed polygons. + Instance represents: Polygons enclosing the first region. + + Polygons enclosing the second region. + Polygons enclosing the symmetric difference. + + + + Compute the difference of closed polygons. + Instance represents: Polygons enclosing the region from which the second region is subtracted. + + Polygons enclosing the region that is subtracted from the first region. + Polygons enclosing the difference. + + + + Intersect closed polygons. + Instance represents: Polygons enclosing the first region to be intersected. + + Polygons enclosing the second region to be intersected. + Polygons enclosing the intersection. + + + + Read XLD polygons from a file in ARC/INFO generate format. + Modified instance represents: Read XLD polygons. + + Name of the ARC/INFO file. + + + + Write XLD polygons to a file in ARC/INFO generate format. + Instance represents: XLD polygons to be written. + + Name of the ARC/INFO file. + + + + Combine road hypotheses from two resolution levels. + Instance represents: XLD polygons to be examined. + + Modified parallels obtained from EdgePolygons. + Extended parallels obtained from EdgePolygons. + Road-center-line polygons to be examined. + Maximum angle between two parallel line segments. Default: 0.523598775598 + Maximum angle between two collinear line segments. Default: 0.261799387799 + Maximum distance between two parallel line segments. Default: 40 + Maximum distance between two collinear line segments. Default: 40 + Roadsides found. + + + + Combine road hypotheses from two resolution levels. + Instance represents: XLD polygons to be examined. + + Modified parallels obtained from EdgePolygons. + Extended parallels obtained from EdgePolygons. + Road-center-line polygons to be examined. + Maximum angle between two parallel line segments. Default: 0.523598775598 + Maximum angle between two collinear line segments. Default: 0.261799387799 + Maximum distance between two parallel line segments. Default: 40 + Maximum distance between two collinear line segments. Default: 40 + Roadsides found. + + + + Extract parallel XLD polygons. + Instance represents: Input polygons. + + Minimum length of the individual polygon segments. Default: 10.0 + Maximum distance between the polygon segments. Default: 30.0 + Maximum angle difference of the polygon segments. Default: 0.15 + Should adjacent parallel relations be merged? Default: "true" + Parallel polygons. + + + + Extract parallel XLD polygons. + Instance represents: Input polygons. + + Minimum length of the individual polygon segments. Default: 10.0 + Maximum distance between the polygon segments. Default: 30.0 + Maximum angle difference of the polygon segments. Default: 0.15 + Should adjacent parallel relations be merged? Default: "true" + Parallel polygons. + + + + Return an XLD polygon's data (as lines). + Instance represents: Input XLD polygons. + + Row coordinates of the lines' start points. + Column coordinates of the lines' start points. + Column coordinates of the lines' end points. + Column coordinates of the lines' end points. + Lengths of the line segments. + Angles of the line segments. + + + + Return an XLD polygon's data. + Instance represents: Input XLD polygon. + + Row coordinates of the polygons' points. + Column coordinates of the polygons' points. + Lengths of the line segments. + Angles of the line segments. + + + + Split XLD contours at dominant points. + Instance represents: Polygons for which the corresponding contours are to be split. + + Mode for the splitting of the contours. Default: "polygon" + Weight for the sensitiveness. Default: 1 + Width of the smoothing mask. Default: 5 + Split contours. + + + + Apply an arbitrary affine transformation to XLD polygons. + Instance represents: Input XLD polygons. + + Input transformation matrix. + Transformed XLD polygons. + + + + Calculate the difference of two object tuples. + Instance represents: Object tuple 1. + + Object tuple 2. + Objects from Objects that are not part of ObjectsSub. + + + + Copy an iconic object in the HALCON database. + Instance represents: Objects to be copied. + + Starting index of the objects to be copied. Default: 1 + Number of objects to be copied or -1. Default: 1 + Copied objects. + + + + Concatenate two iconic object tuples. + Instance represents: Object tuple 1. + + Object tuple 2. + Concatenated objects. + + + + Select objects from an object tuple. + Instance represents: Input objects. + + Indices of the objects to be selected. Default: 1 + Selected objects. + + + + Select objects from an object tuple. + Instance represents: Input objects. + + Indices of the objects to be selected. Default: 1 + Selected objects. + + + + Compare iconic objects regarding equality. + Instance represents: Reference objects. + + Test objects. + Maximum allowed difference between two gray values or coordinates etc. Default: 0.0 + Boolean result value. + + + + Compare iconic objects regarding equality. + Instance represents: Reference objects. + + Test objects. + Maximum allowed difference between two gray values or coordinates etc. Default: 0.0 + Boolean result value. + + + + Compare image objects regarding equality. + Instance represents: Test objects. + + Comparative objects. + boolean result value. + + + + Create a region from an XLD polygon. + Instance represents: Input polygon(s). + + Fill mode of the region(s). Default: "filled" + Created region(s). + + + + Compute the mapping between the distorted image and the rectified image based upon the points of a regular grid. + Instance represents: Input contours. + + Input image. + Output contours. + Distance of the grid points in the rectified image. + Rotation to be applied to the point grid. Default: "auto" + Row coordinates of the grid points. + Column coordinates of the grid points. + Type of mapping. Default: "bilinear" + Image containing the mapping data. + + + + Compute the mapping between the distorted image and the rectified image based upon the points of a regular grid. + Instance represents: Input contours. + + Input image. + Output contours. + Distance of the grid points in the rectified image. + Rotation to be applied to the point grid. Default: "auto" + Row coordinates of the grid points. + Column coordinates of the grid points. + Type of mapping. Default: "bilinear" + Image containing the mapping data. + + + + Read XLD polygons from a DXF file. + Modified instance represents: Read XLD polygons. + + Name of the DXF file. + Names of the generic parameters that can be adjusted for the DXF input. Default: [] + Values of the generic parameters that can be adjusted for the DXF input. Default: [] + Status information. + + + + Read XLD polygons from a DXF file. + Modified instance represents: Read XLD polygons. + + Name of the DXF file. + Names of the generic parameters that can be adjusted for the DXF input. Default: [] + Values of the generic parameters that can be adjusted for the DXF input. Default: [] + Status information. + + + + Write XLD polygons to a file in DXF format. + Instance represents: XLD polygons to be written. + + Name of the DXF file. + + + + Choose all contours or polygons containing a given point. + Instance represents: Contours or polygons to be examined. + + Line coordinate of the test point. Default: 100.0 + Column coordinate of the test point. Default: 100.0 + All contours or polygons containing the test point. + + + + Choose all contours or polygons containing a given point. + Instance represents: Contours or polygons to be examined. + + Line coordinate of the test point. Default: 100.0 + Column coordinate of the test point. Default: 100.0 + All contours or polygons containing the test point. + + + + Select contours or polygons using shape features. + Instance represents: Contours or polygons to be examined. + + Shape features to be checked. Default: "area" + Operation type between the individual features. Default: "and" + Lower limits of the features or 'min'. Default: 150.0 + Upper limits of the features or 'max'. Default: 99999.0 + Contours or polygons fulfilling the condition(s). + + + + Select contours or polygons using shape features. + Instance represents: Contours or polygons to be examined. + + Shape features to be checked. Default: "area" + Operation type between the individual features. Default: "and" + Lower limits of the features or 'min'. Default: 150.0 + Upper limits of the features or 'max'. Default: 99999.0 + Contours or polygons fulfilling the condition(s). + + + + Transform the shape of contours or polygons. + Instance represents: Contours or polygons to be transformed. + + Type of transformation. Default: "convex" + Transformed contours respectively polygons. + + + + Insert objects into an iconic object tuple. + Instance represents: Input object tuple. + + Object tuple to insert. + Index to insert objects. + Extended object tuple. + + + + Remove objects from an iconic object tuple. + Instance represents: Input object tuple. + + Indices of the objects to be removed. + Remaining object tuple. + + + + Remove objects from an iconic object tuple. + Instance represents: Input object tuple. + + Indices of the objects to be removed. + Remaining object tuple. + + + + Replaces one or more elements of an iconic object tuple. + Instance represents: Iconic Input Object. + + Element(s) to replace. + Index/Indices of elements to be replaced. + Tuple with replaced elements. + + + + Replaces one or more elements of an iconic object tuple. + Instance represents: Iconic Input Object. + + Element(s) to replace. + Index/Indices of elements to be replaced. + Tuple with replaced elements. + + + Returns the iconic object(s) at the specified index + + + + This class manages all communication with the HALCON library + + + + True when running on a 64-bit platform. + + + True when running on a Windows platform. + + + + Setting DoLicenseError(false) disables the license error dialog and + application termination. Instead, an exception is raised. + + + + + Setting HLIUseSpinLock(false) before calling the first operator + will cause HALCON to use mutex synchronization instead of spin locks. + This is usually less efficient but may prevent problems if a large + number of threads with differing priorities is used. + + + + + Setting HLIStartUpThreadPool(false) before calling the first + operator will disable the thread pool of HALCON + + + + + Aborts a draw_* operator as a right-click would (Windows only) + + + + + Returns whereas HALCON character encoding is set to UTF8 or locale. + + + + + Unpin the tuple's data, but first check if tuple is null. Notice that + PinTuple happens in HTuple as side effect of store. + + + + Releases the resources used by this tool object + + + + This exception is thrown whenever an error occurs during tuple access. + + + + + Enumeration of tuple types, as returned by HTuple.Type + + + + Tuple is empty + + + Tuple is represented by an array of System.Int32 + + + Tuple is represented by an array of System.Int64 + + + Tuple is represented by an array of System.Double + + + Tuple is represented by an array of strings + + + Tuple is represented by an array of HHandle values + + + Tuple is represented by an object array of boxed values. + + + + Get the value of this element as a 32-bit integer. + The element must represent integer data (32-bit or 64-bit). + + + + + Get the value of these elements as a 32-bit integer. + The elements must represent integer data (32-bit or 64-bit). + + + + + Get the value of this element as a 64-bit integer. + The elements must represent integer data (32-bit or 64-bit). + + + + + Get the value of these elements as a 64-bit integer. + The elements must represent integer data (32-bit or 64-bit). + + + + + Get the value of this element as a double. + The element must represent numeric data. + + + + + Get the value of these elements as doubles. + The elements must represent numeric data. + + + + + Get the value of this element as a string. + The element must represent a string value. + + + + + Get the value of these elements as strings. + The elements must represent string values. + + + + + Get the value of this element as a handle. + The element must represent a handle value. + + + + + Get the value of these elements as strings. + The elements must represent string values. + + + + + Get the value of this element as an object. + The element may be of any type. Numeric data will be boxed. + + + + + Get the value of these elements as objects. + The elements may be of any type. Numeric data will be boxed. + + + + + Get the value of this element as a float. + The element must represent numeric data. + + + + + Get the value of these elements as a float. + The elements must represent numeric data. + + + + + Get the value of this element as an IntPtr. + The element must represent an integer matching IntPtr.Size. + + + + + Get the value of these elements as IntPtrs. + The elements must represent integers matching IntPtr.Size. + + + + Get the data type of this element + + + Get the length of this element + + + + This exception is thrown whenever an error occurs during + vector operations + + + + + The HALCON vector classes are intended to support the export of + HDevelop code that uses vectors, and to pass vector arguments to + procedures that use vector parameters. They are not intended to be + used as generic container classes in user code. For this purpose, + consider using standard container classes such as List<T>. + + Also note HVector is abstract, you can only create instances + of HTupleVector or HObjectVector. + + + + + Read access to subvector at specified index. In contrast + to the index operator, an exception will be raised if index + is out of range. A reference to the internal subvector is + returned and needs to be cloned for independent manipulation. + + + + + Returns true if vector has same dimension, lengths, and elements + + + + + Concatenate two vectors, creating new vector + + + + + Append vector to this vector + + + + + Insert vector at specified index + + + + + Remove element at specified index from this vector + + + + + Remove all elements from this vector + + + + + Clear vector and dispose elements (if necessary). When called + on vector with dimension > 0 the effect is identical to clear + + + + + Provides a simple string representation of the vector, + which is mainly useful for debug outputs. + + + + + Access to subvector at specified index. The vector will be + enlarged to accomodate index, even in read access. For read + access without enlargement use the member function At(index). + A reference to the internal subvector is returned and needs + to be cloned for independent manipulation. + + + + + The HALCON vector classes are intended to support the export of + HDevelop code that uses vectors, and to pass vector arguments to + procedures that use vector parameters. They are not intended to be + used as generic container classes in user code. For this purpose, + consider using standard container classes such as List<T>. + + + + + Create empty vector of specified dimension. In case of dimension + 0 a leaf vector for an empty tuple is created + + + + + Create leaf vector of dimension 0 for the specified tuple + + + + + Create 1-dimensional vector by splitting input tuple into + blocks of fixed size (except possibly for the last block). + This corresponds to convert_tuple_to_vector_1d in HDevelop. + + + + + Create copy of tuple vector + + + + + Read access to subvector at specified index. An exception + will be raised if index is out of range. The returned data + is a copy and may be stored safely. + + + + + Returns true if vector has same dimension, lengths, and elements + + + + + Concatenate two vectors, creating new vector + + + + + Append vector to this vector + + + + + Insert vector at specified index + + + + + Remove element at specified index from this vector + + + + + Remove all elements from this vector + + + + + Create an independent copy of this vector + + + + + Concatenates all tuples stored in the vector + + + + + Provides a simple string representation of the vector, + which is mainly useful for debug outputs. + + + + + Access to the tuple value for leaf vectors (dimension 0) + + + + + Access to subvector at specified index. The vector will be + enlarged to accomodate index, even in read access. The internal + reference is returned to allow modifications of vector state. For + read access, preferrably use the member function At(index). + + + + + The HALCON vector classes are intended to support the export of + HDevelop code that uses vectors, and to pass vector arguments to + procedures that use vector parameters. They are not intended to be + used as generic container classes in user code. For this purpose, + consider using standard container classes such as List<T>. + + + + + Create empty vector of specified dimension. In case of dimension + 0 a leaf vector for an empty object is created + + + + + Create leaf vector of dimension 0 for the specified object + + + + + Create copy of object vector + + + + + Read access to subvector at specified index. An exception + will be raised if index is out of range. The returned data + is a copy and may be stored safely. + + + + + Returns true if vector has same dimension, lengths, and elements + + + + + Concatenate two vectors, creating new vector + + + + + Append vector to this vector + + + + + Insert vector at specified index + + + + + Remove element at specified index from this vector + + + + + Remove all elements from this vector + + + + + Create an independent copy of this vector + + + + + Provides a simple string representation of the vector, + which is mainly useful for debug outputs. + + + + + Access to the object value for leaf vectors (dimension 0). + Ownership of object resides with object vector and it will + be disposed when the vector is disposed. Copy the object + to create an object that will survive a vector dispose. + When storing an object in the vector, it will be + copied automatically. + + + + + Access to subvector at specified index. The vector will be + enlarged to accomodate index, even in read access. The internal + reference is returned to allow modifications of vector state. For + read access, preferrably use the member function At(index). + + + + + Summary description for HalconWindowLayoutDialog. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Provides a HALCON window for your Windows Forms application + + + + + Required designer variable. + + + + + Clean up any resources being used. + + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Adapt ImagePart to show the full image. + + + + + + Size of the HALCON window in pixels. + Without border, this will be identical to the control size. + + + + + This rectangle specifies the image part to be displayed. + The method SetFullImagePart() will adapt this property to + show the full image. + + + + + Width of optional border in pixels + + + + + Color of optional border around window + + + + + Occurs after the HALCON window has been initialized + + + Under Mono/Linux, the HALCON window cannot be initialized + before the Form is visible. Therefore, accessing the window + in the event Load of the Form is not portable. + + + + + Occurs when the mouse is moved over the HALCON window. Note that + delta is meaningless here. + + + + + Occurs when a button is pressed over the HALCON window. Note that + delta is meaningless here. + + + + + Occurs when a button is released over the HALCON window. Note that + delta is meaningless here. + + + + + Occurs when the wheel is used over the HALCON window. Note that + button is meaningless here. + + + + + Provides data for the HMouseUp, HMouseDown, and HMouseMove events. + + + + Gets which mouse button was pressed. + + + + Gets the number of times the mouse button was pressed and released. + + + + Gets the column coordinate of a mouse click. + + + Gets the row coordinate of a mouse click. + + + + Gets a signed count of the number of detents the mouse wheel + has rotated. A detent is one notch of the mouse wheel. + + + + + Represents the method that will handle the HMouseDown, HMouseUp, + or HMouseMove event of a HWindowControl. + + + + + Represents the method that will handle the InitWindow event + of a HWindowControl + + + + + Adapt ImagePart to show the full image. If HKeepAspectRatio is on, + the contents of the HALCON window are rescaled while keeping the aspect + ratio. Otherwise, the HALCON window contents are rescaled to fill up + the HSmartWindowControl. + + + + + + Force the Window Control to be repainted in a thread safe manner. + + + + + + Real pain in the ass. In WinForms events do not bubble, as it is the case + for most frameworks. + This means, we need to hand code the event chain. + + + + + + + Redirect relevant events up to the containing Form. + + Reference to the containing Control. + + + + Clean up event processing. + + + + + + Utility method that converts HALCON images into System.Drawing.Image used to + display images in Window Controls. + + + + + + + In order to allow interaction with drawing objects and being able to + zoom and drag the contents of the window, we need a mechanism to let + the user decide what to do. Currently, if the user keeps the left + Shift key pressed, he will be able to interact with the drawing + objects. Otherwise, he works in the default modus. + + True if the user is currently pressing the left shift key. + + + + + Translates native encoding of mouse buttons to HALCON encoding + (see get_mposition). + + + + + + + Shifts the window contents by (dx, dy) pixels. + + + + + + + UserControls under Windows Forms do not support the mouse wheel event. + As a solution, the user can set his MouseWheel event in his form to + call this method. + Please notice that the Visual Studio Designer does not show this event. + The reason is that UserControls do not support this type of event. + Hence, you need to manually add it to the initialization code of your + Windows Form, and set it to call the HSmartWindowControl_MouseWheel + method of the HALCON Window Control. + + + + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Occurs when the mouse is moved over the HALCON window. Note that + delta is meaningless here. + + + + + Occurs when a button is pressed over the HALCON window. Note that + delta is meaningless here. + + + + + Occurs when a button is released over the HALCON window. Note that + delta is meaningless here. + + + + + Occurs when a button is double-clicked over a HALCON window. Note + that delta is meaningless here. + + + + + Occurs when the wheel is used over a HALCON window while it has + focus. Note that button is meaningless here. + + + + + Occurs after the HALCON window has been initialized + + + + + Occurs when an internal error in the HSmartWindowControl happens. + + + + + Reliable way to check whether we are in designer mode. + + + + + Size of the HALCON window in pixels. + + + + + Initial part of the HALCON window. + + + + + In some situations (like a missing license in runtime), it can be the case that + internal exceptions are thrown, and the user has no way of capturing them. + This callback allows the user to react to such runtime errors. + + + + + + Modifier to manipulate drawing objects + + + + + Manipulate drawing objects without a modifier + + + + + Shift key must be pressed to modify drawing objects + + + + + Ctrl key must be pressed to modify drawing objects + + + + + Alt key must be pressed to modify drawing objects + + + + + Mouse wheel behavior + + + + + No effect on the contents + + + + + Moving the mouse wheel forward zooms in on the contents + + + + + Moving the mouse wheel backward zooms in on the contents + + + + diff --git a/ToolListRun/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache b/ToolListRun/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache new file mode 100644 index 0000000..aa91560 Binary files /dev/null and b/ToolListRun/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache differ diff --git a/ToolListRun/obj/Debug/TemporaryGeneratedFile_036C0B5B-1481-4323-8D20-8F5ADCB23D92.cs b/ToolListRun/obj/Debug/TemporaryGeneratedFile_036C0B5B-1481-4323-8D20-8F5ADCB23D92.cs new file mode 100644 index 0000000..e69de29 diff --git a/ToolListRun/obj/Debug/TemporaryGeneratedFile_5937a670-0e60-4077-877b-f7221da3dda1.cs b/ToolListRun/obj/Debug/TemporaryGeneratedFile_5937a670-0e60-4077-877b-f7221da3dda1.cs new file mode 100644 index 0000000..e69de29 diff --git a/ToolListRun/obj/Debug/TemporaryGeneratedFile_E7A71F73-0F8D-4B9B-B56E-8E70B10BC5D3.cs b/ToolListRun/obj/Debug/TemporaryGeneratedFile_E7A71F73-0F8D-4B9B-B56E-8E70B10BC5D3.cs new file mode 100644 index 0000000..e69de29 diff --git a/ToolListRun/obj/Debug/ToolListRun.csproj.FileListAbsolute.txt b/ToolListRun/obj/Debug/ToolListRun.csproj.FileListAbsolute.txt new file mode 100644 index 0000000..b7e9a02 Binary files /dev/null and b/ToolListRun/obj/Debug/ToolListRun.csproj.FileListAbsolute.txt differ diff --git a/ToolListRun/obj/Debug/ToolListRun.csprojResolveAssemblyReference.cache b/ToolListRun/obj/Debug/ToolListRun.csprojResolveAssemblyReference.cache new file mode 100644 index 0000000..54d6e00 Binary files /dev/null and b/ToolListRun/obj/Debug/ToolListRun.csprojResolveAssemblyReference.cache differ diff --git a/ToolListRun/obj/Debug/ToolListRun.dll b/ToolListRun/obj/Debug/ToolListRun.dll new file mode 100644 index 0000000..32d0efd Binary files /dev/null and b/ToolListRun/obj/Debug/ToolListRun.dll differ diff --git a/ToolListRun/obj/Debug/ToolListRun.pdb b/ToolListRun/obj/Debug/ToolListRun.pdb new file mode 100644 index 0000000..48de1fb Binary files /dev/null and b/ToolListRun/obj/Debug/ToolListRun.pdb differ diff --git a/VisionEdit/GlobalParams.cs b/VisionEdit/GlobalParams.cs index e311330..fe65f55 100644 --- a/VisionEdit/GlobalParams.cs +++ b/VisionEdit/GlobalParams.cs @@ -13,9 +13,9 @@ namespace VisionEdit /// /// 流程树 /// - public static TreeView myJobTreeView { get; set; } - public static VisionJob myVisionJob { get; set; } + public static TreeView myJobTreeView { get; set; } + public static VisionJob myVisionJob { get; set; } - public static VisionToolFactory myVisionToolFactory = new VisionToolFactory(); + // public static VisionToolFactory myVisionToolFactory = new VisionToolFactory(); } } diff --git a/VisionEdit/OperateJob.cs b/VisionEdit/OperateJob.cs index 53cbce5..3d92b55 100644 --- a/VisionEdit/OperateJob.cs +++ b/VisionEdit/OperateJob.cs @@ -5,13 +5,20 @@ using System.Reflection; using System.Text; using System.Threading.Tasks; using System.Windows.Forms; +using CommonMethods; using FindLineTool; namespace VisionEdit { - public class OperateJob + public class OperateJob:IVisionJob { + FormLib.FormLog inputFormLog = new FormLib.FormLog(); + + public OperateJob(FormLib.FormLog formLog) + { + inputFormLog = formLog; + } public static void CreateNewJob() { try diff --git a/VisionEdit/ToolRunLib/CaliperRun.cs b/VisionEdit/ToolRunLib/CaliperRun.cs new file mode 100644 index 0000000..0c7ad4c --- /dev/null +++ b/VisionEdit/ToolRunLib/CaliperRun.cs @@ -0,0 +1,71 @@ +using System; +using System.Collections.Generic; +using System.Drawing; +using System.Linq; +using System.Text; +using System.Text.RegularExpressions; +using System.Threading.Tasks; +using System.Windows.Forms; +using CaliperTool; +using CommonMethods; +using HalconDotNet; +using VisionEdit.FormLib; +using VisionEdit.ToolRunLib; + +namespace VisionEdit.ToolRunLib +{ + public class CaliperRun: IToolRun + { + public void ToolRun(int toolIndex, int inputItemNum, TreeNode selectNode, FormLog myFormLog, FormImageWindow myFormWindow, List L_toolList) + { + Caliper myCaliper = (Caliper)L_toolList[toolIndex].tool; + for (int j = 0; j < inputItemNum; j++) + { + if (L_toolList[toolIndex].toolInput[j].IOName == "InputImage" && L_toolList[toolIndex].GetInput(L_toolList[toolIndex].toolInput[j].IOName).value == null) + { + selectNode.ForeColor = Color.Red; + myFormLog.ShowLog(L_toolList[toolIndex].toolName + " 无输入图像"); + break; + } + else + { + if (L_toolList[toolIndex].GetInput(L_toolList[toolIndex].toolInput[j].IOName).value != null) + { + string sourceFrom = L_toolList[toolIndex].GetInput(L_toolList[toolIndex].toolInput[j].IOName).value.ToString(); + string sourceToolName = Regex.Split(sourceFrom, " . ")[0]; + sourceToolName = sourceToolName.Substring(3, Regex.Split(sourceFrom, " . ")[0].Length - 3); + string toolItem = Regex.Split(sourceFrom, " . ")[1]; + if (L_toolList[toolIndex].toolInput[j].IOName == "InputImage") + { + myCaliper.inputImage = GlobalParams.myVisionJob.GetToolInfoByToolName(GlobalParams.myVisionJob.JobName, sourceToolName).GetOutput(toolItem).value as HObject; + } + if (L_toolList[toolIndex].toolInput[j].IOName == "inputCenterRow") + { + myCaliper.expectRecStartRow = GlobalParams.myVisionJob.GetToolInfoByToolName(GlobalParams.myVisionJob.JobName, sourceToolName).GetOutput(toolItem).value as HTuple; + } + if (L_toolList[toolIndex].toolInput[j].IOName == "inputCenterCol") + { + myCaliper.expectRecStartColumn = GlobalParams.myVisionJob.GetToolInfoByToolName(GlobalParams.myVisionJob.JobName, sourceToolName).GetOutput(toolItem).value as HTuple; + } + if (L_toolList[toolIndex].toolInput[j].IOName == "inputPhi") + { + myCaliper.expectAngle = GlobalParams.myVisionJob.GetToolInfoByToolName(GlobalParams.myVisionJob.JobName, sourceToolName).GetOutput(toolItem).value as HTuple; + } + + } + } + } + myCaliper.Run(SoftwareRunState.Release); + if (myCaliper.toolRunStatu == ToolRunStatu.Succeed) + { + myCaliper.DispMainWindow(myFormWindow.myHWindow); + GlobalParams.myVisionJob.FormLogDisp(L_toolList[toolIndex].toolName + " 运行成功", Color.Green, selectNode); + } + else + { + GlobalParams.myVisionJob.FormLogDisp(L_toolList[toolIndex].toolName + " 运行失败", Color.Red, selectNode); + } + } + + } +} diff --git a/VisionEdit/ToolRunLib/FindLineRun.cs b/VisionEdit/ToolRunLib/FindLineRun.cs new file mode 100644 index 0000000..fe18e04 --- /dev/null +++ b/VisionEdit/ToolRunLib/FindLineRun.cs @@ -0,0 +1,52 @@ +using System; +using System.Collections.Generic; +using System.Drawing; +using System.Linq; +using System.Text; +using System.Text.RegularExpressions; +using System.Threading.Tasks; +using System.Windows.Forms; +using CommonMethods; +using FindLineTool; +using HalconDotNet; +using VisionEdit.FormLib; + +namespace VisionEdit.ToolRunLib +{ + public class FindLineRun : IToolRun + { + public void ToolRun(int toolIndex, int inputItemNum, TreeNode selectNode, FormLog myFormLog, FormImageWindow myFormWindow, List L_toolList) + { + FindLine myFindLine = (FindLine)L_toolList[toolIndex].tool; + for (int j = 0; j < inputItemNum; j++) + { + if (L_toolList[toolIndex].GetInput(L_toolList[toolIndex].toolInput[j].IOName).value == null) + { + selectNode.ForeColor = Color.Red; + myFormLog.ShowLog(L_toolList[toolIndex].toolName + " 无输入图像"); + } + else + { + string sourceFrom = L_toolList[toolIndex].GetInput(L_toolList[toolIndex].toolInput[j].IOName).value.ToString(); + if (L_toolList[toolIndex].toolInput[j].IOName == "InputImage") + { + string sourceToolName = Regex.Split(sourceFrom, " . ")[0]; + sourceToolName = sourceToolName.Substring(3, Regex.Split(sourceFrom, " . ")[0].Length - 3); + string toolItem = Regex.Split(sourceFrom, " . ")[1]; + myFindLine.inputImage = GlobalParams.myVisionJob.GetToolInfoByToolName(GlobalParams.myVisionJob.JobName, sourceToolName).GetOutput(toolItem).value as HObject; + } + } + } + myFindLine.Run(SoftwareRunState.Release); + if (myFindLine.toolRunStatu == ToolRunStatu.Succeed) + { + myFindLine.DispMainWindow(GlobalParams.myVisionJob.myFormImageWindow.myHWindow); + GlobalParams.myVisionJob.FormLogDisp(L_toolList[toolIndex].toolName + " 运行成功", Color.Green, selectNode); + } + else + { + GlobalParams.myVisionJob.FormLogDisp(L_toolList[toolIndex].toolName + " 运行失败", Color.Red, selectNode); + } + } + } +} diff --git a/VisionEdit/ToolRunLib/HalconToolRun.cs b/VisionEdit/ToolRunLib/HalconToolRun.cs new file mode 100644 index 0000000..f4bff94 --- /dev/null +++ b/VisionEdit/ToolRunLib/HalconToolRun.cs @@ -0,0 +1,30 @@ +using System; +using System.Collections.Generic; +using System.Drawing; +using System.Linq; +using System.Text; +using System.Threading.Tasks; +using System.Windows.Forms; +using CommonMethods; +using VisionEdit.FormLib; + +namespace VisionEdit.ToolRunLib +{ + public class HalconToolRun : IToolRun + { + public void ToolRun(int toolIndex, int inputItemNum, TreeNode selectNode, FormLog myFormLog, FormImageWindow myFormWindow, List L_toolList) + { + HalconTool.HalconTool myHalconTool = (HalconTool.HalconTool)L_toolList[toolIndex].tool; + myHalconTool.Run(SoftwareRunState.Release); + if (myHalconTool.outputImage == null) + { + GlobalParams.myVisionJob.FormLogDisp(L_toolList[toolIndex].toolName + " 运行失败", Color.Red, selectNode); + } + else + { + GlobalParams.myVisionJob.FormLogDisp(L_toolList[toolIndex].toolName + " 运行成功", Color.Green, selectNode); + GlobalParams.myVisionJob.myFormImageWindow.myHWindow.HobjectToHimage(myHalconTool.outputImage); + } + } + } +} diff --git a/VisionEdit/ToolRunLib/IToolRun.cs b/VisionEdit/ToolRunLib/IToolRun.cs new file mode 100644 index 0000000..90b8fdc --- /dev/null +++ b/VisionEdit/ToolRunLib/IToolRun.cs @@ -0,0 +1,15 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; +using System.Windows.Forms; +using VisionEdit.FormLib; + +namespace VisionEdit.ToolRunLib +{ + interface IToolRun + { + void ToolRun(int toolIndex, int inputItemNum, TreeNode selectNode, FormLog myFormLog, FormImageWindow myFormWindow, List L_toolList); + } +} diff --git a/VisionEdit/VisionEdit.csproj b/VisionEdit/VisionEdit.csproj index d0d602c..9f73fef 100644 --- a/VisionEdit/VisionEdit.csproj +++ b/VisionEdit/VisionEdit.csproj @@ -55,6 +55,7 @@ + Form @@ -89,6 +90,9 @@ + + + FormImageWindow.cs.cs diff --git a/VisionEdit/VisionJob.cs b/VisionEdit/VisionJob.cs index ab18454..e7dadee 100644 --- a/VisionEdit/VisionJob.cs +++ b/VisionEdit/VisionJob.cs @@ -14,6 +14,7 @@ using FindLineTool; using HalconDotNet; using ToolBase; using VisionEdit.FormLib; +using VisionEdit.ToolRunLib; using VisionJobFactory; namespace VisionEdit @@ -23,8 +24,8 @@ namespace VisionEdit public delegate void CreateLineDelegate(TreeView inputTreeView, TreeNode startNode, TreeNode endNode); CreateLineDelegate createLineDelegateFun; public TreeView tvwOnWorkJob = new TreeView(); - FormLog myFormLog = null; - FormImageWindow myFormImageWindow = null; + public FormLog myFormLog = null; + public FormImageWindow myFormImageWindow = null; public VisionJob(TreeView inputTreeView, FormLog inputFormLog, FormImageWindow inputFormImageWindow, string jobName) { @@ -40,7 +41,7 @@ namespace VisionEdit /// /// /// - internal void TvwJob_ItemDrag(object sender, ItemDragEventArgs e)//左键拖动 + public void TvwJob_ItemDrag(object sender, ItemDragEventArgs e)//左键拖动 { try { @@ -68,7 +69,7 @@ namespace VisionEdit /// /// /// - internal void TvwJob_DragEnter(object sender, DragEventArgs e) + public void TvwJob_DragEnter(object sender, DragEventArgs e) { try { @@ -92,7 +93,7 @@ namespace VisionEdit /// /// /// - internal void TvwJob_DragDrop(object sender, DragEventArgs e)//拖动 + public void TvwJob_DragDrop(object sender, DragEventArgs e)//拖动 { try { @@ -248,7 +249,7 @@ namespace VisionEdit } } - private void CancelUpDowm_MouseWheel(object sender, MouseEventArgs e) + public void CancelUpDowm_MouseWheel(object sender, MouseEventArgs e) { HandledMouseEventArgs h = e as HandledMouseEventArgs; if (h != null) @@ -258,16 +259,16 @@ namespace VisionEdit } #region 绘制输入输出指向线 - internal void tvw_job_AfterSelect(object sender, TreeViewEventArgs e) + public void tvw_job_AfterSelect(object sender, TreeViewEventArgs e) { nodeTextBeforeEdit = tvwOnWorkJob.SelectedNode.Text; } - internal void Draw_Line(object sender, TreeViewEventArgs e) + public void Draw_Line(object sender, TreeViewEventArgs e) { tvwOnWorkJob.Refresh(); DrawLine(); } - internal void tbc_jobs_SelectedIndexChanged(object sender, EventArgs e) + public void tbc_jobs_SelectedIndexChanged(object sender, EventArgs e) { tvwOnWorkJob.Refresh(); DrawLine(); @@ -277,14 +278,14 @@ namespace VisionEdit tvwOnWorkJob.Update(); DrawLine(); } - internal void MyJobTreeView_ChangeUICues(object sender, UICuesEventArgs e) + public void MyJobTreeView_ChangeUICues(object sender, UICuesEventArgs e) { tvwOnWorkJob.Update(); DrawLine(); } #endregion - internal void tvw_job_MouseClick(object sender, MouseEventArgs e) + public void tvw_job_MouseClick(object sender, MouseEventArgs e) { //判断是否在节点单击 TreeViewHitTestInfo test = GlobalParams.myJobTreeView.HitTest(e.X, e.Y); @@ -467,7 +468,7 @@ namespace VisionEdit /// /// 节点文本 /// 节点对象 - internal TreeNode GetToolNodeByNodeText(string nodeText) + public TreeNode GetToolNodeByNodeText(string nodeText) { try { @@ -676,118 +677,15 @@ namespace VisionEdit public void Run() { - for(int i = 0; i < L_toolList.Count; i++) + for (int i = 0; i < L_toolList.Count; i++) { TreeNode treeNode = GetToolNodeByNodeText(L_toolList[i].toolName); inputItemNum = (L_toolList[i]).toolInput.Count; outputItemNum = (L_toolList[i]).toolOutput.Count; - switch(L_toolList[i].toolType) - { - #region halconTool - case ToolType.HalconTool: - HalconTool.HalconTool myHalconTool = (HalconTool.HalconTool)L_toolList[i].tool; - myHalconTool.Run(SoftwareRunState.Release); - if(myHalconTool.outputImage == null) - { - FormLogDisp(L_toolList[i].toolName + " 运行失败", Color.Red, treeNode); - } - else - { - FormLogDisp(L_toolList[i].toolName + " 运行成功", Color.Green, treeNode); - myFormImageWindow.myHWindow.HobjectToHimage(myHalconTool.outputImage); - } - break; - #endregion - #region FindLine - case ToolType.FindLine: - FindLine myFindLine = (FindLine)L_toolList[i].tool; - for (int j = 0; j < inputItemNum; j++) - { - if(L_toolList[i].GetInput(L_toolList[i].toolInput[j].IOName).value == null) - { - treeNode.ForeColor = Color.Red; - myFormLog.ShowLog(L_toolList[i].toolName + " 无输入图像"); - } - else - { - string sourceFrom = L_toolList[i].GetInput(L_toolList[i].toolInput[j].IOName).value.ToString(); - if (L_toolList[i].toolInput[j].IOName == "InputImage") - { - string sourceToolName = Regex.Split(sourceFrom, " . ")[0]; - sourceToolName = sourceToolName.Substring(3, Regex.Split(sourceFrom, " . ")[0].Length - 3); - string toolItem = Regex.Split(sourceFrom, " . ")[1]; - myFindLine.inputImage = GetToolInfoByToolName(GlobalParams.myVisionJob.JobName, sourceToolName).GetOutput(toolItem).value as HObject; - } - } - } - myFindLine.Run(SoftwareRunState.Release); - if (myFindLine.toolRunStatu == ToolRunStatu.Succeed) - { - myFindLine.DispMainWindow(myFormImageWindow.myHWindow); - FormLogDisp(L_toolList[i].toolName + " 运行成功", Color.Green, treeNode); - } - else - { - FormLogDisp(L_toolList[i].toolName + " 运行失败", Color.Red, treeNode); - } - break; - #endregion - - case ToolType.Caliper: - Caliper myCaliper = (Caliper)L_toolList[i].tool; - //if(L_toolList[i].FormTool == null) - //{ - // FormLogDisp(L_toolList[i].toolName + " 运行失败", Color.Red, treeNode); - // continue; - //} - for (int j = 0; j < inputItemNum; j++) - { - if (L_toolList[i].toolInput[j].IOName == "InputImage" && L_toolList[i].GetInput(L_toolList[i].toolInput[j].IOName).value == null) - { - treeNode.ForeColor = Color.Red; - myFormLog.ShowLog(L_toolList[i].toolName + " 无输入图像"); - break; - } - else - { - if(L_toolList[i].GetInput(L_toolList[i].toolInput[j].IOName).value != null) - { - string sourceFrom = L_toolList[i].GetInput(L_toolList[i].toolInput[j].IOName).value.ToString(); - string sourceToolName = Regex.Split(sourceFrom, " . ")[0]; - sourceToolName = sourceToolName.Substring(3, Regex.Split(sourceFrom, " . ")[0].Length - 3); - string toolItem = Regex.Split(sourceFrom, " . ")[1]; - if (L_toolList[i].toolInput[j].IOName == "InputImage") - { - myCaliper.inputImage = GetToolInfoByToolName(GlobalParams.myVisionJob.JobName, sourceToolName).GetOutput(toolItem).value as HObject; - } - if(L_toolList[i].toolInput[j].IOName == "inputCenterRow") - { - myCaliper.expectRecStartRow = GetToolInfoByToolName(GlobalParams.myVisionJob.JobName, sourceToolName).GetOutput(toolItem).value as HTuple; - } - if (L_toolList[i].toolInput[j].IOName == "inputCenterCol") - { - myCaliper.expectRecStartColumn = GetToolInfoByToolName(GlobalParams.myVisionJob.JobName, sourceToolName).GetOutput(toolItem).value as HTuple; - } - if (L_toolList[i].toolInput[j].IOName == "inputPhi") - { - myCaliper.expectAngle = GetToolInfoByToolName(GlobalParams.myVisionJob.JobName, sourceToolName).GetOutput(toolItem).value as HTuple; - } - - } - } - } - myCaliper.Run(SoftwareRunState.Release); - if (myCaliper.toolRunStatu == ToolRunStatu.Succeed) - { - myCaliper.DispMainWindow(myFormImageWindow.myHWindow); - FormLogDisp(L_toolList[i].toolName + " 运行成功", Color.Green, treeNode); - } - else - { - FormLogDisp(L_toolList[i].toolName + " 运行失败", Color.Red, treeNode); - } - break; - } + string assemblyName = "VisionEdit.ToolRunLib." + L_toolList[i].toolType.ToString() + "Run" + ",VisionEdit"; + Type classType = Type.GetType(assemblyName); + IToolRun myCaliperRun = (IToolRun)Activator.CreateInstance(classType); + myCaliperRun.ToolRun(i, inputItemNum, treeNode, myFormLog, myFormImageWindow, L_toolList); } } diff --git a/VisionEdit/bin/Debug/CaliperTool.dll b/VisionEdit/bin/Debug/CaliperTool.dll index 47ccee6..287aade 100644 Binary files a/VisionEdit/bin/Debug/CaliperTool.dll and b/VisionEdit/bin/Debug/CaliperTool.dll differ diff --git a/VisionEdit/bin/Debug/CaliperTool.pdb b/VisionEdit/bin/Debug/CaliperTool.pdb index 85cd95e..885d879 100644 Binary files a/VisionEdit/bin/Debug/CaliperTool.pdb and b/VisionEdit/bin/Debug/CaliperTool.pdb differ diff --git a/VisionEdit/bin/Debug/CommonMethods.dll b/VisionEdit/bin/Debug/CommonMethods.dll index 998e514..11b7275 100644 Binary files a/VisionEdit/bin/Debug/CommonMethods.dll and b/VisionEdit/bin/Debug/CommonMethods.dll differ diff --git a/VisionEdit/bin/Debug/CommonMethods.pdb b/VisionEdit/bin/Debug/CommonMethods.pdb index 557a6ba..13bff77 100644 Binary files a/VisionEdit/bin/Debug/CommonMethods.pdb and b/VisionEdit/bin/Debug/CommonMethods.pdb differ diff --git a/VisionEdit/bin/Debug/DataStruct.dll b/VisionEdit/bin/Debug/DataStruct.dll index 9179ad7..4fad34e 100644 Binary files a/VisionEdit/bin/Debug/DataStruct.dll and b/VisionEdit/bin/Debug/DataStruct.dll differ diff --git a/VisionEdit/bin/Debug/DataStruct.pdb b/VisionEdit/bin/Debug/DataStruct.pdb index ba96465..13e0531 100644 Binary files a/VisionEdit/bin/Debug/DataStruct.pdb and b/VisionEdit/bin/Debug/DataStruct.pdb differ diff --git a/VisionEdit/bin/Debug/DockPanel.config b/VisionEdit/bin/Debug/DockPanel.config index d9e73c0..e576f90 100644 Binary files a/VisionEdit/bin/Debug/DockPanel.config and b/VisionEdit/bin/Debug/DockPanel.config differ diff --git a/VisionEdit/bin/Debug/FindCircleTool.dll b/VisionEdit/bin/Debug/FindCircleTool.dll index 9b2a176..58b0ed2 100644 Binary files a/VisionEdit/bin/Debug/FindCircleTool.dll and b/VisionEdit/bin/Debug/FindCircleTool.dll differ diff --git a/VisionEdit/bin/Debug/FindCircleTool.pdb b/VisionEdit/bin/Debug/FindCircleTool.pdb index f913fc1..31a158d 100644 Binary files a/VisionEdit/bin/Debug/FindCircleTool.pdb and b/VisionEdit/bin/Debug/FindCircleTool.pdb differ diff --git a/VisionEdit/bin/Debug/FindLineTool.dll b/VisionEdit/bin/Debug/FindLineTool.dll index 9a6e389..c89895e 100644 Binary files a/VisionEdit/bin/Debug/FindLineTool.dll and b/VisionEdit/bin/Debug/FindLineTool.dll differ diff --git a/VisionEdit/bin/Debug/FindLineTool.pdb b/VisionEdit/bin/Debug/FindLineTool.pdb index 06c8b4d..4b7d93d 100644 Binary files a/VisionEdit/bin/Debug/FindLineTool.pdb and b/VisionEdit/bin/Debug/FindLineTool.pdb differ diff --git a/VisionEdit/bin/Debug/HalconTool.dll b/VisionEdit/bin/Debug/HalconTool.dll index eeb932f..910a501 100644 Binary files a/VisionEdit/bin/Debug/HalconTool.dll and b/VisionEdit/bin/Debug/HalconTool.dll differ diff --git a/VisionEdit/bin/Debug/HalconTool.pdb b/VisionEdit/bin/Debug/HalconTool.pdb index 9fb4e45..c2f4bdd 100644 Binary files a/VisionEdit/bin/Debug/HalconTool.pdb and b/VisionEdit/bin/Debug/HalconTool.pdb differ diff --git a/VisionEdit/bin/Debug/HalconWindow.exe b/VisionEdit/bin/Debug/HalconWindow.exe index bd0485e..cd7cd1a 100644 Binary files a/VisionEdit/bin/Debug/HalconWindow.exe and b/VisionEdit/bin/Debug/HalconWindow.exe differ diff --git a/VisionEdit/bin/Debug/HalconWindow.pdb b/VisionEdit/bin/Debug/HalconWindow.pdb index 554ca39..db55f5a 100644 Binary files a/VisionEdit/bin/Debug/HalconWindow.pdb and b/VisionEdit/bin/Debug/HalconWindow.pdb differ diff --git a/VisionEdit/bin/Debug/ToolBase.dll b/VisionEdit/bin/Debug/ToolBase.dll index 8deeade..ad1ac8f 100644 Binary files a/VisionEdit/bin/Debug/ToolBase.dll and b/VisionEdit/bin/Debug/ToolBase.dll differ diff --git a/VisionEdit/bin/Debug/ToolBase.pdb b/VisionEdit/bin/Debug/ToolBase.pdb index 221e97e..cb221d8 100644 Binary files a/VisionEdit/bin/Debug/ToolBase.pdb and b/VisionEdit/bin/Debug/ToolBase.pdb differ diff --git a/VisionEdit/bin/Debug/VisionEdit.exe b/VisionEdit/bin/Debug/VisionEdit.exe index 3a00eea..636f2f9 100644 Binary files a/VisionEdit/bin/Debug/VisionEdit.exe and b/VisionEdit/bin/Debug/VisionEdit.exe differ diff --git a/VisionEdit/bin/Debug/VisionEdit.pdb b/VisionEdit/bin/Debug/VisionEdit.pdb index cd49e77..3cd95ea 100644 Binary files a/VisionEdit/bin/Debug/VisionEdit.pdb and b/VisionEdit/bin/Debug/VisionEdit.pdb differ diff --git a/VisionEdit/bin/Debug/VisionJobFactory.dll b/VisionEdit/bin/Debug/VisionJobFactory.dll index 4cc5824..3ce4616 100644 Binary files a/VisionEdit/bin/Debug/VisionJobFactory.dll and b/VisionEdit/bin/Debug/VisionJobFactory.dll differ diff --git a/VisionEdit/bin/Debug/VisionJobFactory.pdb b/VisionEdit/bin/Debug/VisionJobFactory.pdb index 054109f..c4f6cc7 100644 Binary files a/VisionEdit/bin/Debug/VisionJobFactory.pdb and b/VisionEdit/bin/Debug/VisionJobFactory.pdb differ diff --git a/VisionEdit/obj/Debug/VisionEdit.csproj.FileListAbsolute.txt b/VisionEdit/obj/Debug/VisionEdit.csproj.FileListAbsolute.txt index f727766..b941450 100644 Binary files a/VisionEdit/obj/Debug/VisionEdit.csproj.FileListAbsolute.txt and b/VisionEdit/obj/Debug/VisionEdit.csproj.FileListAbsolute.txt differ diff --git a/VisionEdit/obj/Debug/VisionEdit.csproj.GenerateResource.Cache b/VisionEdit/obj/Debug/VisionEdit.csproj.GenerateResource.Cache index 8afdad5..79c7c8e 100644 Binary files a/VisionEdit/obj/Debug/VisionEdit.csproj.GenerateResource.Cache and b/VisionEdit/obj/Debug/VisionEdit.csproj.GenerateResource.Cache differ diff --git a/VisionEdit/obj/Debug/VisionEdit.csprojResolveAssemblyReference.cache b/VisionEdit/obj/Debug/VisionEdit.csprojResolveAssemblyReference.cache index 5c0308f..78eef51 100644 Binary files a/VisionEdit/obj/Debug/VisionEdit.csprojResolveAssemblyReference.cache and b/VisionEdit/obj/Debug/VisionEdit.csprojResolveAssemblyReference.cache differ diff --git a/VisionEdit/obj/Debug/VisionEdit.exe b/VisionEdit/obj/Debug/VisionEdit.exe index 3a00eea..636f2f9 100644 Binary files a/VisionEdit/obj/Debug/VisionEdit.exe and b/VisionEdit/obj/Debug/VisionEdit.exe differ diff --git a/VisionEdit/obj/Debug/VisionEdit.pdb b/VisionEdit/obj/Debug/VisionEdit.pdb index cd49e77..3cd95ea 100644 Binary files a/VisionEdit/obj/Debug/VisionEdit.pdb and b/VisionEdit/obj/Debug/VisionEdit.pdb differ diff --git a/VisionEdit/obj/Debug/build.force b/VisionEdit/obj/Debug/build.force new file mode 100644 index 0000000..e69de29 diff --git a/VisionJobFactory/bin/Debug/CaliperTool.dll b/VisionJobFactory/bin/Debug/CaliperTool.dll index 47ccee6..287aade 100644 Binary files a/VisionJobFactory/bin/Debug/CaliperTool.dll and b/VisionJobFactory/bin/Debug/CaliperTool.dll differ diff --git a/VisionJobFactory/bin/Debug/CaliperTool.pdb b/VisionJobFactory/bin/Debug/CaliperTool.pdb index 85cd95e..885d879 100644 Binary files a/VisionJobFactory/bin/Debug/CaliperTool.pdb and b/VisionJobFactory/bin/Debug/CaliperTool.pdb differ diff --git a/VisionJobFactory/bin/Debug/CommonMethods.dll b/VisionJobFactory/bin/Debug/CommonMethods.dll index 998e514..11b7275 100644 Binary files a/VisionJobFactory/bin/Debug/CommonMethods.dll and b/VisionJobFactory/bin/Debug/CommonMethods.dll differ diff --git a/VisionJobFactory/bin/Debug/CommonMethods.pdb b/VisionJobFactory/bin/Debug/CommonMethods.pdb index 557a6ba..13bff77 100644 Binary files a/VisionJobFactory/bin/Debug/CommonMethods.pdb and b/VisionJobFactory/bin/Debug/CommonMethods.pdb differ diff --git a/VisionJobFactory/bin/Debug/DataStruct.dll b/VisionJobFactory/bin/Debug/DataStruct.dll index 9179ad7..4fad34e 100644 Binary files a/VisionJobFactory/bin/Debug/DataStruct.dll and b/VisionJobFactory/bin/Debug/DataStruct.dll differ diff --git a/VisionJobFactory/bin/Debug/DataStruct.pdb b/VisionJobFactory/bin/Debug/DataStruct.pdb index ba96465..13e0531 100644 Binary files a/VisionJobFactory/bin/Debug/DataStruct.pdb and b/VisionJobFactory/bin/Debug/DataStruct.pdb differ diff --git a/VisionJobFactory/bin/Debug/FindLineTool.dll b/VisionJobFactory/bin/Debug/FindLineTool.dll index 9a6e389..c89895e 100644 Binary files a/VisionJobFactory/bin/Debug/FindLineTool.dll and b/VisionJobFactory/bin/Debug/FindLineTool.dll differ diff --git a/VisionJobFactory/bin/Debug/FindLineTool.pdb b/VisionJobFactory/bin/Debug/FindLineTool.pdb index 06c8b4d..4b7d93d 100644 Binary files a/VisionJobFactory/bin/Debug/FindLineTool.pdb and b/VisionJobFactory/bin/Debug/FindLineTool.pdb differ diff --git a/VisionJobFactory/bin/Debug/HalconTool.dll b/VisionJobFactory/bin/Debug/HalconTool.dll index eeb932f..910a501 100644 Binary files a/VisionJobFactory/bin/Debug/HalconTool.dll and b/VisionJobFactory/bin/Debug/HalconTool.dll differ diff --git a/VisionJobFactory/bin/Debug/HalconTool.pdb b/VisionJobFactory/bin/Debug/HalconTool.pdb index 9fb4e45..c2f4bdd 100644 Binary files a/VisionJobFactory/bin/Debug/HalconTool.pdb and b/VisionJobFactory/bin/Debug/HalconTool.pdb differ diff --git a/VisionJobFactory/bin/Debug/HalconWindow.exe b/VisionJobFactory/bin/Debug/HalconWindow.exe index bd0485e..cd7cd1a 100644 Binary files a/VisionJobFactory/bin/Debug/HalconWindow.exe and b/VisionJobFactory/bin/Debug/HalconWindow.exe differ diff --git a/VisionJobFactory/bin/Debug/HalconWindow.pdb b/VisionJobFactory/bin/Debug/HalconWindow.pdb index 554ca39..db55f5a 100644 Binary files a/VisionJobFactory/bin/Debug/HalconWindow.pdb and b/VisionJobFactory/bin/Debug/HalconWindow.pdb differ diff --git a/VisionJobFactory/bin/Debug/ToolBase.dll b/VisionJobFactory/bin/Debug/ToolBase.dll index 8deeade..ad1ac8f 100644 Binary files a/VisionJobFactory/bin/Debug/ToolBase.dll and b/VisionJobFactory/bin/Debug/ToolBase.dll differ diff --git a/VisionJobFactory/bin/Debug/ToolBase.pdb b/VisionJobFactory/bin/Debug/ToolBase.pdb index 221e97e..cb221d8 100644 Binary files a/VisionJobFactory/bin/Debug/ToolBase.pdb and b/VisionJobFactory/bin/Debug/ToolBase.pdb differ diff --git a/VisionJobFactory/bin/Debug/VisionJobFactory.dll b/VisionJobFactory/bin/Debug/VisionJobFactory.dll index 4cc5824..3ce4616 100644 Binary files a/VisionJobFactory/bin/Debug/VisionJobFactory.dll and b/VisionJobFactory/bin/Debug/VisionJobFactory.dll differ diff --git a/VisionJobFactory/bin/Debug/VisionJobFactory.pdb b/VisionJobFactory/bin/Debug/VisionJobFactory.pdb index 054109f..c4f6cc7 100644 Binary files a/VisionJobFactory/bin/Debug/VisionJobFactory.pdb and b/VisionJobFactory/bin/Debug/VisionJobFactory.pdb differ diff --git a/VisionJobFactory/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache b/VisionJobFactory/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache index 494b54c..53086e1 100644 Binary files a/VisionJobFactory/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache and b/VisionJobFactory/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache differ diff --git a/VisionJobFactory/obj/Debug/VisionJobFactory.csproj.FileListAbsolute.txt b/VisionJobFactory/obj/Debug/VisionJobFactory.csproj.FileListAbsolute.txt index 29a43f0..b2448ef 100644 Binary files a/VisionJobFactory/obj/Debug/VisionJobFactory.csproj.FileListAbsolute.txt and b/VisionJobFactory/obj/Debug/VisionJobFactory.csproj.FileListAbsolute.txt differ diff --git a/VisionJobFactory/obj/Debug/VisionJobFactory.csprojResolveAssemblyReference.cache b/VisionJobFactory/obj/Debug/VisionJobFactory.csprojResolveAssemblyReference.cache index b5d498f..38fc2e4 100644 Binary files a/VisionJobFactory/obj/Debug/VisionJobFactory.csprojResolveAssemblyReference.cache and b/VisionJobFactory/obj/Debug/VisionJobFactory.csprojResolveAssemblyReference.cache differ diff --git a/VisionJobFactory/obj/Debug/VisionJobFactory.dll b/VisionJobFactory/obj/Debug/VisionJobFactory.dll index 4cc5824..3ce4616 100644 Binary files a/VisionJobFactory/obj/Debug/VisionJobFactory.dll and b/VisionJobFactory/obj/Debug/VisionJobFactory.dll differ diff --git a/VisionJobFactory/obj/Debug/VisionJobFactory.pdb b/VisionJobFactory/obj/Debug/VisionJobFactory.pdb index 054109f..c4f6cc7 100644 Binary files a/VisionJobFactory/obj/Debug/VisionJobFactory.pdb and b/VisionJobFactory/obj/Debug/VisionJobFactory.pdb differ diff --git a/VisionJobFactory/obj/Debug/build.force b/VisionJobFactory/obj/Debug/build.force new file mode 100644 index 0000000..e69de29