Skip to content

Commit 0217388

Browse files
pawchenpawchen
committed
Add doc files
1 parent b10e157 commit 0217388

4,721 files changed

Lines changed: 282872 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎en/XFunction/Category/Adjustments.html‎

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
<h1 class="firstHeading">2.6.1 Adjustments</h1><p><br />
2+
</p>
3+
<table class="simple">
4+
<tr>
5+
<th>Name
6+
</th>
7+
<th>Brief
8+
</th>
9+
<th>Example
10+
</th></tr>
11+
<tr>
12+
<td><a href="../../XFunction/X-Function/ImgAutoLevel.html" title="X-Function:ImgAutoLevel">imgAutoLevel</a>
13+
</td>
14+
<td>Apply auto leveling to image.
15+
</td>
16+
<td><a href="../../XFunction/X-Function/ImgAutoLevel.html#Examples" title="X-Function:ImgAutoLevel">Example</a>
17+
</td></tr>
18+
<tr>
19+
<td><a href="../../XFunction/X-Function/ImgBalance.html" title="X-Function:ImgBalance">imgBalance</a>
20+
</td>
21+
<td>Balance the color of image.
22+
</td>
23+
<td><a href="../../XFunction/X-Function/ImgBalance.html#Examples" title="X-Function:ImgBalance">Example</a>
24+
</td></tr>
25+
<tr>
26+
<td><a href="../../XFunction/X-Function/ImgBrightness.html" title="X-Function:ImgBrightness">imgBrightness</a>
27+
</td>
28+
<td>Adjust the brightness of Image.
29+
</td>
30+
<td><a href="../../XFunction/X-Function/ImgBrightness.html#Examples" title="X-Function:ImgBrightness">Example</a>
31+
</td></tr>
32+
<tr>
33+
<td><a href="../../XFunction/X-Function/ImgColorlevel.html" title="X-Function:ImgColorlevel">imgColorlevel</a>
34+
</td>
35+
<td>Apply user-defined color leveling to image.
36+
</td>
37+
<td><a href="../../XFunction/X-Function/ImgColorlevel.html#Examples" title="X-Function:ImgColorlevel">Example</a>
38+
</td></tr>
39+
<tr>
40+
<td><a href="../../XFunction/X-Function/ImgColorReplace.html" title="X-Function:ImgColorReplace">imgColorReplace</a>
41+
</td>
42+
<td>Replace color within pre-defined color range.
43+
</td>
44+
<td><a href="../../XFunction/X-Function/ImgColorReplace.html#Examples" title="X-Function:ImgColorReplace">Example</a>
45+
</td></tr>
46+
<tr>
47+
<td><a href="../../XFunction/X-Function/ImgContrast.html" title="X-Function:ImgContrast">imgContrast</a>
48+
</td>
49+
<td>Adjust contrast of image.
50+
</td>
51+
<td><a href="../../XFunction/X-Function/ImgContrast.html#Examples" title="X-Function:ImgContrast">Example</a>
52+
</td></tr>
53+
<tr>
54+
<td><a href="../../XFunction/X-Function/ImgFuncLUT.html" title="X-Function:ImgFuncLUT">imgFuncLUT</a>
55+
</td>
56+
<td>Apply lookup table function to image.
57+
</td>
58+
<td><a href="../../XFunction/X-Function/ImgFuncLUT.html#Examples" title="X-Function:ImgFuncLUT">Example</a>
59+
</td></tr>
60+
<tr>
61+
<td><a href="../../XFunction/X-Function/ImgGamma.html" title="X-Function:ImgGamma">imgGamma</a>
62+
</td>
63+
<td>Apply gamma correction to image.
64+
</td>
65+
<td><a href="../../XFunction/X-Function/ImgGamma.html#Examples" title="X-Function:ImgGamma">Example</a>
66+
</td></tr>
67+
<tr>
68+
<td><a href="../../XFunction/X-Function/ImgHistcontrast.html" title="X-Function:ImgHistcontrast">imgHistcontrast</a>
69+
</td>
70+
<td>Adjust the contrast of image, using histogram to calculate the median.
71+
</td>
72+
<td><a href="../../XFunction/X-Function/ImgHistcontrast.html#Examples" title="X-Function:ImgHistcontrast">Example</a>
73+
</td></tr>
74+
<tr>
75+
<td><a href="../../XFunction/X-Function/ImgHisteq.html" title="X-Function:ImgHisteq">imgHisteq</a>
76+
</td>
77+
<td>Apply histogram equalization.
78+
</td>
79+
<td><a href="../../XFunction/X-Function/ImgHisteq.html#Examples" title="X-Function:ImgHisteq">Example</a>
80+
</td></tr>
81+
<tr>
82+
<td><a href="../../XFunction/X-Function/ImgHue.html" title="X-Function:ImgHue">imgHue</a>
83+
</td>
84+
<td>Adjust hue of image.
85+
</td>
86+
<td><a href="../../XFunction/X-Function/ImgHue.html#Examples" title="X-Function:ImgHue">Example</a>
87+
</td></tr>
88+
<tr>
89+
<td><a href="../../XFunction/X-Function/ImgInvert.html" title="X-Function:ImgInvert">imgInvert</a>
90+
</td>
91+
<td>Invert image color.
92+
</td>
93+
<td><a href="../../XFunction/X-Function/ImgInvert.html#Examples" title="X-Function:ImgInvert">Example</a>
94+
</td></tr>
95+
<tr>
96+
<td><a href="../../XFunction/X-Function/ImgLevel.html" title="X-Function:ImgLevel">imgLevel</a>
97+
</td>
98+
<td>Adjust the levels of image.
99+
</td>
100+
<td><a href="../../XFunction/X-Function/ImgLevel.html#Examples" title="X-Function:ImgLevel">Example</a>
101+
</td></tr>
102+
<tr>
103+
<td><a href="../../XFunction/X-Function/ImgSaturation.html" title="X-Function:ImgSaturation">imgSaturation</a>
104+
</td>
105+
<td>Adjust Saturation of image.
106+
</td>
107+
<td><a href="../../XFunction/X-Function/ImgSaturation.html#Examples" title="X-Function:ImgSaturation">Example</a>
108+
</td></tr></table>
109+
110+
111+
112+
113+
114+

‎en/XFunction/Category/Analysis.html‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<h1 class="firstHeading">2.6.2 Analysis</h1><p><br />
2+
</p>
3+
<table class="simple">
4+
<tr>
5+
<th>Name
6+
</th>
7+
<th>Brief
8+
</th>
9+
<th>Example
10+
</th></tr>
11+
<tr>
12+
<td><a href="../../XFunction/X-Function/ImgHistogram.html" title="X-Function:ImgHistogram">imgHistogram</a>
13+
</td>
14+
<td>Histogram
15+
</td>
16+
<td><a href="../../XFunction/X-Function/ImgHistogram.html#Examples" title="X-Function:ImgHistogram">Example</a>
17+
</td></tr></table>
18+
19+
20+
21+
22+
23+

‎en/XFunction/Category/Arithmetic_Transform.html‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
<h1 class="firstHeading">2.6.3 Arithmetic Transform</h1><p><br />
2+
</p>
3+
<table class="simple">
4+
<tr>
5+
<th>Name
6+
</th>
7+
<th>Brief
8+
</th>
9+
<th>Example
10+
</th></tr>
11+
<tr>
12+
<td><a href="../../XFunction/X-Function/Img2xyz.html" title="X-Function:Img2xyz">img2xyz</a>
13+
</td>
14+
<td>Extract to XYZ Data.
15+
</td>
16+
<td><a href="../../XFunction/X-Function/Img2xyz.html#Examples" title="X-Function:Img2xyz">Example</a>
17+
</td></tr>
18+
<tr>
19+
<td><a href="../../XFunction/X-Function/ImgBlend.html" title="X-Function:ImgBlend">imgBlend</a>
20+
</td>
21+
<td>Blend two images into a combined image.
22+
</td>
23+
<td><a href="../../XFunction/X-Function/ImgBlend.html#Examples" title="X-Function:ImgBlend">Example</a>
24+
</td></tr>
25+
<tr>
26+
<td><a href="../../XFunction/X-Function/ImgMathfun.html" title="X-Function:ImgMathfun">imgMathfun</a>
27+
</td>
28+
<td>Re-maps the image according to a mathematical function such as: square, log, square root, sine and cosine.
29+
</td>
30+
<td><a href="../../XFunction/X-Function/ImgMathfun.html#Examples" title="X-Function:ImgMathfun">Example</a>
31+
</td></tr>
32+
<tr>
33+
<td><a href="../../XFunction/X-Function/ImgMorph.html" title="X-Function:ImgMorph">imgMorph</a>
34+
</td>
35+
<td>Apply morphological filter to numeric Matrix or grayscale/binary image.
36+
</td>
37+
<td><a href="../../XFunction/X-Function/ImgMorph.html#Examples" title="X-Function:ImgMorph">Example</a>
38+
</td></tr>
39+
<tr>
40+
<td><a href="../../XFunction/X-Function/ImgPixlog.html" title="X-Function:ImgPixlog">imgPixlog</a>
41+
</td>
42+
<td>Perform logic operation on pixels.
43+
</td>
44+
<td><a href="../../XFunction/X-Function/ImgPixlog.html#Examples" title="X-Function:ImgPixlog">Example</a>
45+
</td></tr>
46+
<tr>
47+
<td><a href="../../XFunction/X-Function/ImgReplaceBg.html" title="X-Function:ImgReplaceBg">imgReplaceBg</a>
48+
</td>
49+
<td>Replace background color.
50+
</td>
51+
<td><a href="../../XFunction/X-Function/ImgReplaceBg.html#Examples" title="X-Function:ImgReplaceBg">Example</a>
52+
</td></tr>
53+
<tr>
54+
<td><a href="../../XFunction/X-Function/ImgSimpleMath.html" title="X-Function:ImgSimpleMath">imgSimpleMath</a>
55+
</td>
56+
<td>Simple Math operation between two Images.
57+
</td>
58+
<td><a href="../../XFunction/X-Function/ImgSimpleMath.html#Examples" title="X-Function:ImgSimpleMath">Example</a>
59+
</td></tr>
60+
<tr>
61+
<td><a href="../../XFunction/X-Function/ImgSubtractBg.html" title="X-Function:ImgSubtractBg">imgSubtractBg</a>
62+
</td>
63+
<td>Subtract image background.
64+
</td>
65+
<td><a href="../../XFunction/X-Function/ImgSubtractBg.html#Examples" title="X-Function:ImgSubtractBg">Example</a>
66+
</td></tr>
67+
<tr>
68+
<td><a href="../../XFunction/X-Function/ImgSubtractInterpBG.html" title="X-Function:ImgSubtractInterpBG">imgSubtractInterpBG</a>
69+
</td>
70+
<td>Subtract the background created with interpolation.
71+
</td>
72+
<td><a href="../../XFunction/X-Function/ImgSubtractInterpBG.html#Examples" title="X-Function:ImgSubtractInterpBG">Example</a>
73+
</td></tr></table>
74+
75+
76+
77+
78+
79+

‎en/XFunction/Category/Conversion.html‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
<h1 class="firstHeading">2.6.4 Conversion</h1><table class="simple">
2+
<tr>
3+
<th>Name
4+
</th>
5+
<th>Brief
6+
</th>
7+
<th>Example
8+
</th></tr>
9+
<tr>
10+
<td><a href="../../XFunction/X-Function/Img2m.html" title="X-Function:Img2m">img2m</a>
11+
</td>
12+
<td>Convert a grayscale image to a numeric data matrix.
13+
</td>
14+
<td><a href="../../XFunction/X-Function/Img2m.html#Examples" title="X-Function:Img2m">Example</a>
15+
</td></tr>
16+
<tr>
17+
<td><a href="../../XFunction/X-Function/ImgAutoBinary.html" title="X-Function:ImgAutoBinary">imgAutoBinary</a>
18+
</td>
19+
<td>Auto convert to binary.
20+
</td>
21+
<td><a href="../../XFunction/X-Function/ImgAutoBinary.html#Examples" title="X-Function:ImgAutoBinary">Example</a>
22+
</td></tr>
23+
<tr>
24+
<td><a href="../../XFunction/X-Function/ImgBinary.html" title="X-Function:ImgBinary">imgBinary</a>
25+
</td>
26+
<td>Convert to binary.
27+
</td>
28+
<td><a href="../../XFunction/X-Function/ImgBinary.html#Examples" title="X-Function:ImgBinary">Example</a>
29+
</td></tr>
30+
<tr>
31+
<td><a href="../../XFunction/X-Function/ImgC2gray.html" title="X-Function:ImgC2gray">imgC2gray</a>
32+
</td>
33+
<td>Convert to a grayscale image.
34+
</td>
35+
<td><a href="../../XFunction/X-Function/ImgC2gray.html#Examples" title="X-Function:ImgC2gray">Example</a>
36+
</td></tr>
37+
<tr>
38+
<td><a href="../../XFunction/X-Function/ImgDynamicBinary.html" title="X-Function:ImgDynamicBinary">imgDynamicBinary</a>
39+
</td>
40+
<td>Convert to binary using dynamic threshold.
41+
</td>
42+
<td><a href="../../XFunction/X-Function/ImgDynamicBinary.html#Examples" title="X-Function:ImgDynamicBinary">Example</a>
43+
</td></tr>
44+
<tr>
45+
<td><a href="../../XFunction/X-Function/ImgInfo.html" title="X-Function:ImgInfo">imgInfo</a>
46+
</td>
47+
<td>Print out the given image's basic parameters in script window.
48+
</td>
49+
<td>
50+
</td></tr>
51+
<tr>
52+
<td><a href="../../XFunction/X-Function/ImgPalette.html" title="X-Function:ImgPalette">imgPalette</a>
53+
</td>
54+
<td>Apply palette to image.
55+
</td>
56+
<td><a href="../../XFunction/X-Function/ImgPalette.html#Examples" title="X-Function:ImgPalette">Example</a>
57+
</td></tr>
58+
<tr>
59+
<td><a href="../../XFunction/X-Function/ImgRGBmerge.html" title="X-Function:ImgRGBmerge">imgRGBmerge</a>
60+
</td>
61+
<td>Merge RGB channels to recombine a color image.
62+
</td>
63+
<td><a href="../../XFunction/X-Function/ImgRGBmerge.html#Examples" title="X-Function:ImgRGBmerge">Example</a>
64+
</td></tr>
65+
<tr>
66+
<td><a href="../../XFunction/X-Function/ImgRGBsplit.html" title="X-Function:ImgRGBsplit">imgRGBsplit</a>
67+
</td>
68+
<td>Split color image into R,G, B channels.
69+
</td>
70+
<td><a href="../../XFunction/X-Function/ImgRGBsplit.html#Examples" title="X-Function:ImgRGBsplit">Example</a>
71+
</td></tr>
72+
<tr>
73+
<td><a href="../../XFunction/X-Function/ImgScale.html" title="X-Function:ImgScale">imgScale</a>
74+
</td>
75+
<td>Rescale image.
76+
</td>
77+
<td><a href="../../XFunction/X-Function/ImgScale.html#Examples" title="X-Function:ImgScale">Example</a>
78+
</td></tr>
79+
<tr>
80+
<td><a href="../../XFunction/X-Function/ImgThreshold.html" title="X-Function:ImgThreshold">imgThreshold</a>
81+
</td>
82+
<td>Convert part of an image to black and white using threshold.
83+
</td>
84+
<td><a href="../../XFunction/X-Function/ImgThreshold.html#Examples" title="X-Function:ImgThreshold">Example</a>
85+
</td></tr>
86+
<tr>
87+
<td><a href="../../XFunction/X-Function/M2img.html" title="X-Function:M2img">m2img</a>
88+
</td>
89+
<td>Convert a numeric matrix to a grayscale image.
90+
</td>
91+
<td><a href="../../XFunction/X-Function/M2img.html#Examples" title="X-Function:M2img">Example</a>
92+
</td></tr></table>
93+
94+
95+
96+
97+
98+

‎en/XFunction/Category/Creating_an_X-Function.html‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<h1 class="firstHeading">1.1 Creating an X-Function</h1><p><span class="OIndex" style="display:none">X-Function, Create</span>
2+
Creating an X-Function is a two-step process: first, the X-Function and its parameters are defined in <b>X-Function Builder</b>; second, the X-Function's Origin C code is written and compiled in <b>Code Builder</b>.
3+
</p>
4+
<table class="catlist">
5+
6+
<tr>
7+
<td><i><b>This section covers the following topics:</b></i>
8+
<div class="CategoryTreeTag" data-ct-mode="20" data-ct-options="{&quot;mode&quot;:20,&quot;hideprefix&quot;:10,&quot;showcount&quot;:false,&quot;namespaces&quot;:false}"><li> <a class="CategoryTreeLabel CategoryTreeLabelNs114 CategoryTreeLabelPage" href="../../XFunction/X-Function/Creating_a_Simple_X-Function.html">Creating a Simple X-Function</a></li>
9+
10+
<li> <a class="CategoryTreeLabel CategoryTreeLabelNs114 CategoryTreeLabelPage" href="../../XFunction/X-Function/X-Function_Builder.html">X-Function Builder</a></li>
11+
12+
<li> <a class="CategoryTreeLabel CategoryTreeLabelNs114 CategoryTreeLabelPage" href="../../XFunction/X-Function/Programming_in_Code_Builder.html">Programming in Code Builder</a></li>
13+
14+
<li> <a class="CategoryTreeLabel CategoryTreeLabelNs114 CategoryTreeLabelPage" href="../../XFunction/X-Function/Creating_Graph_Preview_GetN_Dialog.html">Creating Graph Preview GetN Dialog</a></li>
15+
16+
<li> <a class="CategoryTreeLabel CategoryTreeLabelNs114 CategoryTreeLabelPage" href="../../XFunction/X-Function/Creating_Image_GetN_Dialog.html">Creating Image GetN Dialog</a></li>
17+
18+
<li> <a class="CategoryTreeLabel CategoryTreeLabelNs114 CategoryTreeLabelPage" href="../../XFunction/X-Function/Creating_Custom_Dialog.html">Creating Custom Dialog</a></li>
19+
20+
<li> <a class="CategoryTreeLabel CategoryTreeLabelNs114 CategoryTreeLabelPage" href="../../XFunction/X-Function/Creating_Wizard_Dialog.html">Creating Wizard Dialog</a></li>
21+
22+
<li> <a class="CategoryTreeLabel CategoryTreeLabelNs114 CategoryTreeLabelPage" href="../../XFunction/X-Function/Creating_a_Gadget_Tool_with_X-Function.html">Creating a Gadget Tool with X-Function</a></li>
23+
24+
<li> <a class="CategoryTreeLabel CategoryTreeLabelNs114 CategoryTreeLabelPage" href="../../XFunction/X-Function/X-Function_install_Python_Packages.html">X-Function install Python Packages</a></li>
25+
26+
</div>
27+
</td></tr></table>
28+
29+
30+
31+

‎en/XFunction/Category/Customizing_an_X-Function.html‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<h1 class="firstHeading">1.2 Customizing an X-Function</h1><table class="catlist">
2+
3+
<tr>
4+
<td><i><b>This section covers the following topics:</b></i>
5+
<div class="CategoryTreeTag" data-ct-mode="20" data-ct-options="{&quot;mode&quot;:20,&quot;hideprefix&quot;:10,&quot;showcount&quot;:false,&quot;namespaces&quot;:false}"><li> <a class="CategoryTreeLabel CategoryTreeLabelNs114 CategoryTreeLabelPage" href="../../XFunction/X-Function/Putting_an_X-Function_in_the_Product_Menu.html">Putting an X-Function in the Product Menu</a></li>
6+
7+
<li> <a class="CategoryTreeLabel CategoryTreeLabelNs114 CategoryTreeLabelPage" href="../../XFunction/X-Function/Adding_Documentation_to_an_X-Function.html">Adding Documentation to an X-Function</a></li>
8+
9+
<li> <a class="CategoryTreeLabel CategoryTreeLabelNs114 CategoryTreeLabelPage" href="../../XFunction/X-Function/Adding_Custom_Button_on_Dialog.html">Adding Custom Button on Dialog</a></li>
10+
11+
<li> <a class="CategoryTreeLabel CategoryTreeLabelNs114 CategoryTreeLabelPage" href="../../XFunction/X-Function/Creating_Tab-based_Dialog.html">Creating Tab-based Dialog</a></li>
12+
13+
</div>
14+
</td></tr></table>
15+
16+
17+
18+

0 commit comments

Comments
 (0)