autodoc.git/ autodoc.xml

Branch: Tag:

1999-03-01

1999-03-01 21:47:14 by Henrik Wallin <hedda@lysator.liu.se>

First version of this file.

Rev: src/modules/Image/match.c:1.1
Rev: src/modules/Image/phase.c:1.1
Rev: src/modules/Image/search.c:1.1

2196:   </docgroup>   </class>   <module name='Image'> + <doc> + <group><note/><text> + <p>Experimental functions.</p> + </text></group> +  + </doc>   <module name='ANY'>   <doc>   <text>
6602:      </doc>   </docgroup> + <docgroup homogen-name='apply_max' homogen-type='method'> + <method name='apply_max'> +  <returntype> +  <object>object </object></returntype> +  <arguments><argument name='matrix'><type> +  <array><valuetype> +  <array><valuetype> +  <or><int/><array><valuetype><int/></valuetype></array></or></valuetype></array></valuetype></array></type></argument> +  +  </arguments> + </method><method name='apply_max'> +  <returntype> +  <object>object </object></returntype> +  <arguments><argument name='matrix'><type> +  <array><valuetype> +  <array><valuetype> +  <or><int/><array><valuetype><int/></valuetype></array></or></valuetype></array></valuetype></array></type></argument> + <argument name='r'><type><int/></type></argument> + <argument name='g'><type><int/></type></argument> + <argument name='b'><type><int/></type></argument> +  +  </arguments> + </method><method name='apply_max'> +  <returntype> +  <object>object </object></returntype> +  <arguments><argument name='matrix'><type> +  <array><valuetype> +  <array><valuetype> +  <or><int/><array><valuetype><int/></valuetype></array></or></valuetype></array></valuetype></array></type></argument> + <argument name='r'><type><int/></type></argument> + <argument name='g'><type><int/></type></argument> + <argument name='b'><type><int/></type></argument> + <argument name='div'><type> +  <or><int/><float/></or></type></argument> +  +  </arguments> + </method><doc> + <text> + <p>This is the same as apply_matrix, but it uses the maximum + instead.</p> +  + <p>This function is not very fast. + </p> + </text> + <group> +  <param name='array'/> + <text><p>the matrix; innermost is a value or an array with red, green, blue + values for red, green, blue separation.</p></text></group> + <group> +  <param name='r'/> +  <param name='g'/> +  <param name='b'/> + <text><p>base level of result, default is zero</p></text></group> + <group> +  <param name='div'/> + <text><p>division factor, default is 1.0.</p></text></group> + <group><returns/><text> + <p>the new image object</p> + </text></group> +  + </doc> + </docgroup>   <docgroup homogen-name='autocrop' homogen-type='method'>   <method name='autocrop'>    <returntype>
7746:      </doc>   </docgroup> + <docgroup homogen-name='make_ascii' homogen-type='method'> + <method name='make_ascii'> +  <returntype> +  <object>object </object></returntype> +  <arguments><argument name='orient1'><type><object resolved='predef::Image.image.make_ascii'/></type></argument> + <argument name='objectorient2'><type> +  <object resolved='predef::Image.image.make_ascii'/></type></argument> +  +  </arguments> + </method><doc> + <text> + <p> object orient3, object orient4, +  int|void xsize, int|void ysize)</p> +  + <p>This method creates a string that look like + the image. Example: + <pre> +  //Stina is an image with a cat. +  array(object) Stina4=Stina-&gt;orient4(); +  Stina4[1]*=215; +  Stina4[3]*=215; +  string foo=Stina-&gt;make_ascii(@Stina4,40,4,8); + </pre> + </p> + </text> + <group><returns/><text> + <p>some nice acsii-art.</p> + </text></group> + <group><note/><text> + <p>Experimental. +  <pre> | / - \ +  hue= 0 64 128 192 (=red in an hsv image)</pre></p> + </text></group> + <group><seealso/><text> + <p><ref resolved='predef::Image.image.orient'>orient</ref>, <ref resolved='predef::Image.image.orient4'>orient4</ref></p></text></group> +  + </doc> + </docgroup>   <docgroup homogen-type='method'>   <method name='map_closest'>    <returntype>
7796:      </doc>   </docgroup> + <docgroup homogen-name='match' homogen-type='method'> + <method name='match'> +  <returntype> +  <object>object </object></returntype> +  <arguments><argument name='scale'><type> +  <or><int/><float/></or></type></argument> + <argument name='objectneedle'><type> +  <object resolved='predef::Image.image.match'/></type></argument> +  +  </arguments> + </method><method name='match'> +  <returntype> +  <object>object </object></returntype> +  <arguments><argument name='scale'><type> +  <or><int/><float/></or></type></argument> + <argument name='objectneedle'><type> +  <object resolved='predef::Image.image.match'/></type></argument> +  +  </arguments> + </method><doc> + <text> + <p>object haystack_cert, + object needle_cert)</p> + </text> +  + </doc> + </docgroup> + <docgroup homogen-name='match' homogen-type='method'> + <method name='match'> +  <returntype> +  <object>object </object></returntype> +  <arguments><argument name='scale'><type> +  <or><int/><float/></or></type></argument> + <argument name='objectneedle'><type> +  <object resolved='predef::Image.image.match'/></type></argument> +  +  </arguments> + </method><doc> + <text> + <p>object haystack_avoid, + int foo)</p> + </text> +  + </doc> + </docgroup> + <docgroup homogen-name='match' homogen-type='method'> + <method name='match'> +  <returntype> +  <object>object </object></returntype> +  <arguments><argument name='scale'><type> +  <or><int/><float/></or></type></argument> + <argument name='objectneedle'><type> +  <object resolved='predef::Image.image.match'/></type></argument> +  +  </arguments> + </method><doc> + <text> + <p> object haystack_cert, +  object needle_cert, +  object haystack_avoid, +  int foo)</p> +  + <p>This method creates an image that describes the + match in every pixel in the image and the + needle-Image.</p> +  + <p><pre> +  new pixel value = +  sum( abs(needle_pixel-haystack_pixel)) + </pre></p> +  + <p>The new image only have the red rgb-part set.</p> +  + <p/> + </text> + <group> +  <param name='scale'/> + <text><p>Every pixel is divided with this value. + Note that a proper value here depends on + the size of the neadle. + </p></text></group> + <group> +  <param name='needle'/> + <text><p>The image to use for the matching. + </p></text></group> + <group> +  <param name='haystack_cert'/> + <text><p>This image should be the same size as + the image itselves. A non-white-part of the + haystack_cert-image modifies the output + by lowering it. + </p></text></group> + <group> +  <param name='needle_cert'/> + <text><p>The same, but for the needle-image. + </p></text></group> + <group> +  <param name='foo'/> +  <param name='haystack_avoid'/> + <text><p>This image should be the same size as + the image itselves. If foo is less than the red + value in haystack_avoid the corresponding + matching-calculating is not calculated. The avoided parts + are drawn in the color 0,100,0. + </p></text></group> + <group><returns/><text> + <p>the new image object</p> + </text></group> + <group><note/><text> + <p>Experimental.</p> + </text></group> + <group><seealso/><text> + <p><ref resolved='predef::Image.image.phasev'>phasev</ref>, <ref resolved='predef::Image.image.phaseh'>phaseh</ref></p></text></group> +  + </doc> + </docgroup>   <docgroup homogen-name='mirrorx' homogen-type='method'>   <method name='mirrorx'>    <returntype>
8327:      </doc>   </docgroup> + <docgroup homogen-type='method'> + <method name='phaseh'> +  <returntype> +  <object>object </object></returntype> +  <arguments> +  </arguments> + </method><method name='phasev'> +  <returntype> +  <object>object </object></returntype> +  <arguments> +  </arguments> + </method><doc> + <text> + <p>Draws images describing the phase + of the current image. phaseh gives the + horizontal phase and phasev the vertical + phase.</p> +  + <p><tt>phaseh</tt> gives an image + were + <pre> +  max falling min rising + value= 0 64 128 192 + </pre></p> +  + <p>0 is set if there is no way to determine + if it is rising or falling. This is done + for the every red, green and blue part of + the image.</p> +  + <p>Phase images can be used to create ugly + effects or to find meta-information + in the orginal image. + </p> + </text> + <group><returns/><text> + <p>the new image object</p> + </text></group> + <group><note/><text> + <p>experimental status; may not be exact the same + output in later versions</p> + </text></group> + <group><bugs/><text> + <p>0 should not be set as explained above.</p> + </text></group> + <group><seealso/><text> + <p><ref>match_phase</ref></p></text></group> +  + </doc> + </docgroup>   <docgroup homogen-name='polyfill' homogen-type='method'>   <method name='polyfill'>    <returntype>