Cognex.VisionPro.CorePlus.xml 85 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. "Cognex.VisionPro.CorePlus"
  5. </assembly>
  6. <members>
  7. <member name="M:Cognex.VisionPro.CogVisionDataContainer.GetRangeGreyImagePairs(Cognex.VisionPro.CogImage16Range[]@,Cognex.VisionPro.CogImage16Grey[]@,System.String[]@)">
  8. <summary>
  9. This method steps through the top level elements in the
  10. container. For every element that is itself a container
  11. holding exactly one CogImage16Range and exactly one
  12. CogImage16Grey (and possibly some other objects), copy a
  13. reference to that range image into the output array of
  14. CogImage16Range references. And copy a reference to the
  15. grey image into the output array of CogImage16Grey. And
  16. copy the associated top level dictionary key string into
  17. the output array of string references. The output arrays
  18. may be empty. This method ignores top level elements that
  19. are not of type CogVisionDataContainer. This method ignores
  20. top level elements that contain more than one CogImage16Range
  21. or more than one CogImage16Grey.
  22. </summary>
  23. <param name="rangeImages">
  24. The output array of CogImage16Range references. This output
  25. array is always allocated by this method, but the resultant
  26. array may be empty.
  27. </param>
  28. <param name="greyImages">
  29. The output array of CogImage16Grey references. This output
  30. array is always allocated by this method, but the resultant
  31. array may be empty.
  32. </param>
  33. <param name="identifiers">
  34. The output array of string references. This output array
  35. is always allocated by this method, but the resultant
  36. array may be empty.
  37. </param>
  38. </member>
  39. <member name="M:Cognex.VisionPro.CogVisionDataContainer.GetRangeImages(Cognex.VisionPro.CogImage16Range[]@,System.String[]@)">
  40. <summary>
  41. This method steps through the top level elements in this
  42. container and copies a reference to every CogImage16Range
  43. that it finds into an output array of CogImage16Range references.
  44. For every range image so identified, the associated dictionary
  45. key string is copied into an output array of string references.
  46. The resultant output arrays may be empty. This method ignores
  47. top level elements that are not of type CogImage16Range.
  48. </summary>
  49. <param name="rangeImages">
  50. The output array of CogImage16Range references. This output
  51. array is always allocated by this method, but the resultant
  52. array may be empty.
  53. </param>
  54. <param name="identifiers">
  55. The output array of string references. This output array
  56. is always allocated by this method, but the resultant
  57. array may be empty.
  58. </param>
  59. </member>
  60. <member name="P:Cognex.VisionPro.CogVisionDataContainer.ContainsRangeImagesOnly">
  61. <summary>
  62. Returns true if:
  63. <list type="bullet"><item>
  64. The collection contains at least one element that is
  65. a CogImage16Range, and
  66. </item><item>
  67. The collection contains no elements that are not
  68. a CogImage16Range.
  69. </item></list>
  70. Otherwise, returns false.
  71. </summary>
  72. </member>
  73. <member name="M:Cognex.VisionPro.CogVisionDataContainer.TryGetValue(System.String,Cognex.VisionPro.ICogVisionData@)">
  74. <summary>
  75. If this container holds the specified key,
  76. output the associated ICogVisionData value.
  77. Return true if the key was found, otherwise
  78. return false.
  79. </summary>
  80. <param name="key">
  81. Search for this key.
  82. </param>
  83. <param name="value">
  84. The found ICogVisionData value.
  85. </param>
  86. </member>
  87. <member name="M:Cognex.VisionPro.CogVisionDataContainer.ContainsValue(Cognex.VisionPro.ICogVisionData)">
  88. <summary>
  89. Returns true if the specified value is found in this container,
  90. otherwise returns false.
  91. </summary>
  92. <param name="value">
  93. The ICogVisionData value of interest.
  94. </param>
  95. </member>
  96. <member name="M:Cognex.VisionPro.CogVisionDataContainer.ContainsKey(System.String)">
  97. <summary>
  98. Returns true if the specified key is found in this container,
  99. otherwise returns false.
  100. </summary>
  101. <param name="key">
  102. The key of interest.
  103. </param>
  104. </member>
  105. <member name="P:Cognex.VisionPro.CogVisionDataContainer.Values">
  106. <summary>
  107. Gets a collection of all ICogVisionData values in this container.
  108. </summary>
  109. </member>
  110. <member name="P:Cognex.VisionPro.CogVisionDataContainer.Keys">
  111. <summary>
  112. Gets a collection of all key strings in this container.
  113. </summary>
  114. </member>
  115. <member name="M:Cognex.VisionPro.CogVisionDataContainer.Move(System.Int32,System.Int32)">
  116. <summary>
  117. Moves a key value pair from one position to another.
  118. </summary>
  119. <param name="fromIndex">The pair's original index.</param>
  120. <param name="toIndex">The pair's new index.</param>
  121. <exception cref="System.ArgumentOutOfRangeException">
  122. If fromIndex is less than zero or fromIndex is greater than
  123. or equal to Count.
  124. </exception>
  125. <exception cref="System.ArgumentOutOfRangeException">
  126. If toIndex is less than zero or toIndex is greater than
  127. or equal to Count.
  128. </exception>
  129. </member>
  130. <member name="M:Cognex.VisionPro.CogVisionDataContainer.Insert(System.Int32,System.String,Cognex.VisionPro.ICogVisionData)">
  131. <summary>
  132. Inserts a key value pair with the supplied
  133. string key and ICogVisionData value at the
  134. specified index.
  135. </summary>
  136. <param name="index">The zero-based index at which
  137. to insert the specified key value pair.
  138. </param>
  139. <param name="key">The string key to use for this
  140. new item. May not be null, and may not be an empty
  141. string.
  142. </param>
  143. <param name="value">The ICogVisionData value to use
  144. for this new item.
  145. </param>
  146. <exception cref="System.ArgumentOutOfRangeException">
  147. If index is less than zero or index is greater than
  148. Count.
  149. </exception>
  150. </member>
  151. <member name="M:Cognex.VisionPro.CogVisionDataContainer.Insert(System.Int32,System.Collections.Generic.KeyValuePair`2{System.String,Cognex.VisionPro.ICogVisionData})">
  152. <summary>
  153. Inserts the supplied key value pair at the specified index.
  154. </summary>
  155. <param name="index">The zero-based index at which
  156. to insert the supplied key value pair.
  157. </param>
  158. <exception cref="System.ArgumentOutOfRangeException">
  159. If index is less than zero or index is greater than
  160. Count.
  161. </exception>
  162. </member>
  163. <member name="M:Cognex.VisionPro.CogVisionDataContainer.RemoveAt(System.Int32)">
  164. <summary>
  165. Removes the key value pair at the specified index.
  166. </summary>
  167. <param name="index">The zero-based index of the
  168. key value pair to remove.
  169. </param>
  170. <exception cref="System.ArgumentOutOfRangeException">
  171. If index is less than zero or index is greater than or equal
  172. to Count.
  173. </exception>
  174. </member>
  175. <member name="M:Cognex.VisionPro.CogVisionDataContainer.Remove(Cognex.VisionPro.ICogVisionData)">
  176. <summary>
  177. Removes from this container the key value pair with the
  178. specified value. Does nothing if this value is not found.
  179. </summary>
  180. <param name="value">Remove the key value pair with this value,
  181. if found.
  182. </param>
  183. <returns>True if the specified key value pair was
  184. removed, False otherwise.
  185. </returns>
  186. </member>
  187. <member name="M:Cognex.VisionPro.CogVisionDataContainer.Remove(System.String)">
  188. <summary>
  189. Removes from this container the key value pair with the
  190. specified key. Does nothing if this key is not found.
  191. </summary>
  192. <param name="key">Remove the key value pair with this key,
  193. if found.
  194. </param>
  195. <returns>True if the specified key value pair was
  196. removed, False otherwise.
  197. </returns>
  198. </member>
  199. <member name="M:Cognex.VisionPro.CogVisionDataContainer.Remove(System.Collections.Generic.KeyValuePair`2{System.String,Cognex.VisionPro.ICogVisionData})">
  200. <summary>
  201. Removes the supplied key value pair from this container.
  202. Does nothing if the supplied key value pair is not found.
  203. </summary>
  204. <param name="pair">Remove this key value pair if found.
  205. </param>
  206. <returns>True if the specified key value pair was
  207. removed, False otherwise.
  208. </returns>
  209. </member>
  210. <member name="M:Cognex.VisionPro.CogVisionDataContainer.CopyTo(System.Collections.Generic.KeyValuePair`2{System.String,Cognex.VisionPro.ICogVisionData}[],System.Int32)">
  211. <summary>
  212. Copies the entire collection to a one-dimensional array
  213. of key value pairs, starting at the specified
  214. index of the target array.
  215. </summary>
  216. <param name="arr">The one-dimensional array that is the
  217. destination of the elements copied from this container.
  218. The array must have zero-based indexing.
  219. </param>
  220. <param name="index">The zero-based index in the target
  221. array at which copying begins.
  222. </param>
  223. <exception cref="System.ArgumentNullException">arr is null.
  224. </exception>
  225. <exception cref="System.ArgumentOutOfRangeException">index
  226. is less than 0.
  227. </exception>
  228. <exception cref="System.ArgumentException">The number of
  229. elements in this container is greater than the available
  230. space from index to the end of the destination array.
  231. </exception>
  232. </member>
  233. <member name="M:Cognex.VisionPro.CogVisionDataContainer.Contains(Cognex.VisionPro.ICogVisionData)">
  234. <summary>
  235. Returns true if the supplied value is found,
  236. otherwise returns false.
  237. </summary>
  238. <param name="value">
  239. Search for this value.
  240. </param>
  241. </member>
  242. <member name="M:Cognex.VisionPro.CogVisionDataContainer.Contains(System.String)">
  243. <summary>
  244. Returns true if the supplied key is found,
  245. otherwise returns false.
  246. </summary>
  247. <param name="key">
  248. Search for this key.
  249. </param>
  250. </member>
  251. <member name="M:Cognex.VisionPro.CogVisionDataContainer.Contains(System.Collections.Generic.KeyValuePair`2{System.String,Cognex.VisionPro.ICogVisionData})">
  252. <summary>
  253. Returns true if the supplied key value pair is found,
  254. otherwise returns false.
  255. </summary>
  256. <param name="pair">
  257. Search for this key value pair.
  258. </param>
  259. </member>
  260. <member name="M:Cognex.VisionPro.CogVisionDataContainer.GetKey(System.Int32)">
  261. <summary>
  262. Returns the key string associated with the
  263. specified index.
  264. </summary>
  265. <param name="index">The zero-based index of the
  266. key to get.</param>
  267. <exception cref="System.ArgumentOutOfRangeException">
  268. If index is less than zero, or not less than Count.
  269. </exception>
  270. </member>
  271. <member name="M:Cognex.VisionPro.CogVisionDataContainer.IndexOf(Cognex.VisionPro.ICogVisionData)">
  272. <summary>
  273. Searches the container for the key value pair with the
  274. specified value and returns its zero-based index.
  275. </summary>
  276. <param name="value">The value to locate.</param>
  277. <returns>The zero based index of the key value pair
  278. with the specified ICogVisionData value, if found;
  279. otherwise, -1 is returned.
  280. </returns>
  281. </member>
  282. <member name="M:Cognex.VisionPro.CogVisionDataContainer.IndexOf(System.String)">
  283. <summary>
  284. Searches the container for the key value pair with the
  285. specified key and returns its zero-based index.
  286. </summary>
  287. <param name="key">The key to locate.</param>
  288. <returns>The zero based index of the key value pair
  289. with the specified key, if found; otherwise, -1 is
  290. returned.
  291. </returns>
  292. </member>
  293. <member name="M:Cognex.VisionPro.CogVisionDataContainer.IndexOf(System.Collections.Generic.KeyValuePair`2{System.String,Cognex.VisionPro.ICogVisionData})">
  294. <summary>
  295. Searches the container for the specified key value pair and
  296. returns the zero-based index of the first occurrence.
  297. </summary>
  298. <param name="pair">The key value pair to locate.</param>
  299. <returns>The zero based index of the first occurrence of
  300. pair within the container, if found; otherwise, -1
  301. </returns>
  302. </member>
  303. <member name="M:Cognex.VisionPro.CogVisionDataContainer.Clear">
  304. <summary>
  305. Removes all key value pairs from the container.
  306. </summary>
  307. </member>
  308. <member name="M:Cognex.VisionPro.CogVisionDataContainer.Add(System.String,Cognex.VisionPro.ICogVisionData)">
  309. <summary>
  310. Adds to the end of the container a key value pair
  311. using the supplied key string and ICogVisionData value.
  312. </summary>
  313. <param name="key">The key string to be used.</param>
  314. <param name="value">The ICogVisionData value reference
  315. to be used.</param>
  316. <exception cref="System.ArgumentNullException">
  317. If the supplied key is null.
  318. </exception>
  319. <exception cref="System.ArgumentException">
  320. If the supplied key is an empty string.
  321. </exception>
  322. <exception cref="System.ArgumentException">
  323. If the supplied key already exists within the container.
  324. </exception>
  325. </member>
  326. <member name="M:Cognex.VisionPro.CogVisionDataContainer.Add(System.Collections.Generic.KeyValuePair`2{System.String,Cognex.VisionPro.ICogVisionData})">
  327. <summary>
  328. Adds the supplied key value pair to the end of the container.
  329. </summary>
  330. <param name="pair">The key value pair to add.</param>
  331. <exception cref="System.ArgumentNullException">
  332. If the supplied key is null.
  333. </exception>
  334. <exception cref="System.ArgumentException">
  335. If the supplied key is an empty string.
  336. </exception>
  337. <exception cref="System.ArgumentException">
  338. If the supplied key already exists within the container.
  339. </exception>
  340. </member>
  341. <member name="P:Cognex.VisionPro.CogVisionDataContainer.IsReadOnly">
  342. <summary>
  343. Returns true if this collection is ReadOnly
  344. </summary>
  345. </member>
  346. <member name="P:Cognex.VisionPro.CogVisionDataContainer.Count">
  347. <summary>
  348. Gets the number of elements in this container.
  349. </summary>
  350. </member>
  351. <member name="M:Cognex.VisionPro.CogVisionDataContainer.GetEnumerator">
  352. <summary>
  353. Get an enumerator for this conllection of
  354. key value pairs.
  355. </summary>
  356. </member>
  357. <member name="P:Cognex.VisionPro.CogVisionDataContainer.PairIndexer(System.Int32)">
  358. <summary>
  359. Gets or sets the key value pair at the specified index.
  360. The key is a string and the value is an
  361. ICogVisionData reference.
  362. </summary>
  363. <param name="index">The zero-based index of the
  364. key value pair to get.</param>
  365. <returns>
  366. The key value pair at the specified index.
  367. </returns>
  368. <exception cref="System.ArgumentOutOfRangeException">
  369. If index is less than zero, or not less than Count.
  370. </exception>
  371. </member>
  372. <member name="P:Cognex.VisionPro.CogVisionDataContainer.default(System.String)">
  373. <summary>
  374. Gets or sets the ICogVisionData reference associated with
  375. the specified key string. When setting a the
  376. ICogVisionData reference for a key that does not yet
  377. exist within the container, a new container entry
  378. is created.
  379. </summary>
  380. <param name="key">The key associated with the
  381. ICogVisionData reference.</param>
  382. <returns>
  383. The ICogVisionData reference associated with the
  384. specified key.
  385. </returns>
  386. <exception cref="System.ArgumentNullException">
  387. If key is null.
  388. </exception>
  389. <exception cref="System.ArgumentException">
  390. If key is an empty string.
  391. </exception>
  392. <exception cref="System.Collections.Generic.KeyNotFoundException">
  393. If the key is not found when reading.
  394. </exception>
  395. </member>
  396. <member name="P:Cognex.VisionPro.CogVisionDataContainer.Item(System.Int32)">
  397. <summary>
  398. Gets or sets the ICogVisionData reference at the specified index.
  399. </summary>
  400. <param name="index">The zero-based index of the
  401. ICogVisionData reference to get.</param>
  402. <returns>
  403. The ICogVisionData reference at the specified index.
  404. </returns>
  405. <exception cref="System.ArgumentOutOfRangeException">
  406. If index is less than zero, or not less than Count.
  407. </exception>
  408. </member>
  409. <member name="M:Cognex.VisionPro.CogVisionDataContainer.OnDeserialization(System.Object)">
  410. <summary>
  411. Perform post-deserialization tasks.
  412. </summary>
  413. <param name="sender">
  414. The CogVisionDataContainer.
  415. </param>
  416. </member>
  417. <member name="M:Cognex.VisionPro.CogVisionDataContainer.#ctor(Cognex.VisionPro.CogVisionDataContainer)">
  418. <summary>
  419. Copy construct a CogVisionDataContainer from the
  420. supplied container. This is a shallow copy: the values are
  421. copied not cloned.
  422. </summary>
  423. <param name="Other">
  424. The CogVisionDataContainer to be copied.
  425. </param>
  426. </member>
  427. <member name="M:Cognex.VisionPro.CogVisionDataContainer.#ctor">
  428. <summary>
  429. Default construct a CogVisionDataContainer.
  430. </summary>
  431. </member>
  432. <member name="M:Cognex.VisionPro.CogVisionDataContainer.OnMovedItem(System.Int32,System.Int32)">
  433. <summary>
  434. Raises the MovedItem event and the Changed event.
  435. </summary>
  436. <param name="fromIndex">Source index of item moved.</param>
  437. <param name="toIndex">New index of item moved.</param>
  438. </member>
  439. <member name="M:Cognex.VisionPro.CogVisionDataContainer.OnMovingItem(System.Int32,System.Int32)">
  440. <summary>
  441. Raises the MovingItem event.
  442. </summary>
  443. <param name="fromIndex">Index of item being moved.</param>
  444. <param name="toIndex">Destination index of item being moved.</param>
  445. </member>
  446. <member name="M:Cognex.VisionPro.CogVisionDataContainer.OnReplacedItem(System.Int32,System.Object,System.Object)">
  447. <summary>
  448. Raises the ReplacedItem event and the Changed event.
  449. </summary>
  450. <param name="index">Index of item replaced.</param>
  451. <param name="oldValue">Value of item replaced.</param>
  452. <param name="newValue">Value of item that replaced oldValue.</param>
  453. </member>
  454. <member name="M:Cognex.VisionPro.CogVisionDataContainer.OnReplacingItem(System.Int32,System.Object,System.Object)">
  455. <summary>
  456. Raises the ReplacingItem event.
  457. </summary>
  458. <param name="index">Index of item being replaced.</param>
  459. <param name="oldValue">Value of item being replaced.</param>
  460. <param name="newValue">Value of item replacing oldValue.</param>
  461. </member>
  462. <member name="M:Cognex.VisionPro.CogVisionDataContainer.OnRemovedItem(System.Int32,System.Object)">
  463. <summary>
  464. Raises the RemovedItem event and the Changed event.
  465. </summary>
  466. <param name="index">Index of item removed.</param>
  467. <param name="value">Value of item removed.</param>
  468. </member>
  469. <member name="M:Cognex.VisionPro.CogVisionDataContainer.OnRemovingItem(System.Int32,System.Object)">
  470. <summary>
  471. Raises the RemovingItem event.
  472. </summary>
  473. <param name="index">Index of item being removed.</param>
  474. <param name="value">Value of item being removed.</param>
  475. </member>
  476. <member name="M:Cognex.VisionPro.CogVisionDataContainer.OnInsertedItem(System.Int32,System.Object)">
  477. <summary>
  478. Raises the InsertedItem event and the Changed event.
  479. </summary>
  480. <param name="index">Index at which item was inserted.</param>
  481. <param name="value">Value of item inserted.</param>
  482. </member>
  483. <member name="M:Cognex.VisionPro.CogVisionDataContainer.OnInsertingItem(System.Int32,System.Object)">
  484. <summary>
  485. Raises the InsertingItem event.
  486. </summary>
  487. <param name="index">Index to insert item being inserted.</param>
  488. <param name="value">Value of item being inserted.</param>
  489. </member>
  490. <member name="M:Cognex.VisionPro.CogVisionDataContainer.OnCleared">
  491. <summary>
  492. Raises the Cleared event and the Changed event.
  493. </summary>
  494. </member>
  495. <member name="M:Cognex.VisionPro.CogVisionDataContainer.OnClearing">
  496. <summary>
  497. Raises the Clearing event.
  498. </summary>
  499. </member>
  500. <member name="M:Cognex.VisionPro.CogVisionDataContainer.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  501. <summary>
  502. Serialization construct a CogVisionDataContainer.
  503. </summary>
  504. <param name="Info">
  505. The standard SerializationInfo parameter.
  506. </param>
  507. <param name="Ctxt">
  508. The standard StreamingContext parameter.
  509. </param>
  510. </member>
  511. <member name="E:Cognex.VisionPro.CogVisionDataContainer.MovedItem">
  512. <summary>
  513. Raised after an item is moved to a new index.
  514. </summary>
  515. </member>
  516. <member name="E:Cognex.VisionPro.CogVisionDataContainer.MovingItem">
  517. <summary>
  518. Raised before an item is moved to a new index.
  519. </summary>
  520. </member>
  521. <member name="E:Cognex.VisionPro.CogVisionDataContainer.ReplacedItem">
  522. <summary>
  523. Raised after an item is replaced.
  524. </summary>
  525. </member>
  526. <member name="E:Cognex.VisionPro.CogVisionDataContainer.ReplacingItem">
  527. <summary>
  528. Raised before an item is replaced.
  529. </summary>
  530. </member>
  531. <member name="E:Cognex.VisionPro.CogVisionDataContainer.RemovedItem">
  532. <summary>
  533. Raised after an item is removed.
  534. </summary>
  535. </member>
  536. <member name="E:Cognex.VisionPro.CogVisionDataContainer.RemovingItem">
  537. <summary>
  538. Raised before an item is removed.
  539. </summary>
  540. </member>
  541. <member name="E:Cognex.VisionPro.CogVisionDataContainer.InsertedItem">
  542. <summary>
  543. Raised after an item is inserted.
  544. </summary>
  545. </member>
  546. <member name="E:Cognex.VisionPro.CogVisionDataContainer.InsertingItem">
  547. <summary>
  548. Raised before an item is inserted.
  549. </summary>
  550. </member>
  551. <member name="E:Cognex.VisionPro.CogVisionDataContainer.Cleared">
  552. <summary>
  553. Raised after the container is cleared.
  554. </summary>
  555. </member>
  556. <member name="E:Cognex.VisionPro.CogVisionDataContainer.Clearing">
  557. <summary>
  558. Raised before the container is cleared.
  559. </summary>
  560. </member>
  561. <member name="F:Cognex.VisionPro.CogVisionDataContainer.SfNextSf">
  562. <summary>
  563. Next state flag to be used in derived classes.
  564. </summary>
  565. </member>
  566. <member name="F:Cognex.VisionPro.CogVisionDataContainer.SfCount">
  567. <summary>
  568. State flag for the Count property.
  569. </summary>
  570. </member>
  571. <member name="F:Cognex.VisionPro.CogVisionDataContainer.SfItem">
  572. <summary>
  573. State flag for the Item (indexer) property.
  574. </summary>
  575. </member>
  576. <member name="T:Cognex.VisionPro.CogVisionDataContainer">
  577. <summary>
  578. This class is a general purpose container of vision data. Each
  579. element in this container has both a string key and a value of type
  580. ICogVisionData. This container maintains an ordered list of these key
  581. value pairs. A particular ICogVisionData value may be referenced by
  582. integer index as in a list, or by string key as in a dictionary. The
  583. keys must all be unique, non-null, non-empty strings. In addition,
  584. this class implements the ICogVisionData interface.
  585. </summary>
  586. </member>
  587. <member name="M:Cognex.VisionPro.CogCenterPointsToLines.Execute">
  588. <summary>
  589. Perform point to line centering.
  590. </summary>
  591. <returns>
  592. A CogCenterPointsToLinesResult object describing the mapping
  593. of points to lines.
  594. </returns>
  595. <exception cref="T:Cognex.VisionPro.Exceptions.CogTransformSingularException">
  596. If the solution is singular.
  597. </exception>
  598. <exception cref="T:Cognex.VisionPro.Exceptions.CogTimeoutExpiredException">
  599. If TimeoutEnabled is true and this method does not complete
  600. within Timeout milliseconds.
  601. </exception>
  602. <exception cref="T:System.ArgumentException">
  603. If any of the following is true:
  604. <list type="bullet"><item><see cref="P:Cognex.VisionPro.CogCenterPointsToLines.Mode" /> is set to
  605. <see cref="T:Cognex.VisionPro.CogCenterPointsToLinesModeConstants">
  606. Single</see> and
  607. <see cref="P:Cognex.VisionPro.CogCenterPointsToLines.Count" /> is
  608. less than 4.
  609. </item><item><see cref="P:Cognex.VisionPro.CogCenterPointsToLines.Mode" /> is set to
  610. <see cref="T:Cognex.VisionPro.CogCenterPointsToLinesModeConstants">
  611. Pair</see> and
  612. <see cref="P:Cognex.VisionPro.CogCenterPointsToLines.Count" /> is
  613. less than 3.
  614. </item></list></exception>
  615. <exception cref="T:System.ArgumentException">
  616. If any of the parameters is invalid.
  617. </exception>
  618. </member>
  619. <member name="P:Cognex.VisionPro.CogCenterPointsToLines.NormalDirectionInferenceMethod">
  620. <summary>
  621. How this class will infer the normal direction of the
  622. line segments.
  623. </summary>
  624. <value>
  625. The default value is InferFromConvexity.
  626. </value>
  627. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  628. Fires when the value of this property changes.
  629. </event>
  630. <exception cref="T:System.ArgumentException">
  631. The supplied value is not a member of the
  632. <see cref="T:Cognex.VisionPro.CogCenterPointsToLinesNormalDirectionInferenceMethodConstants" />
  633. enumeration.
  634. </exception>
  635. </member>
  636. <member name="P:Cognex.VisionPro.CogCenterPointsToLines.Timeout">
  637. <summary>
  638. The maximum number of milliseconds that may elapse while running
  639. the Execute method. This is only enforced if TimeoutEnabled is
  640. true.
  641. </summary>
  642. <value>
  643. The default value is 120000.
  644. </value>
  645. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  646. Fires when the value of this property changes.
  647. </event>
  648. <exception cref="T:System.ArgumentOutOfRangeException">
  649. The supplied value is less than zero.
  650. </exception>
  651. </member>
  652. <member name="P:Cognex.VisionPro.CogCenterPointsToLines.TimeoutEnabled">
  653. <summary>
  654. Whether the Execute method should be stopped after Timeout
  655. milliseconds.
  656. </summary>
  657. <value>
  658. The default value is False.
  659. </value>
  660. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  661. Fires when the value of this property changes.
  662. </event>
  663. </member>
  664. <member name="P:Cognex.VisionPro.CogCenterPointsToLines.SearchAngleMax">
  665. <summary>
  666. The upper bound of the search angle range, in radians. This
  667. parameter limits the rotation angle of the result transform.
  668. </summary>
  669. <remarks>
  670. Note that setting this property to a value less than
  671. SearchAngleMin will cause SearchAngleMin to be set to
  672. the new SearchAngleMax value.
  673. </remarks>
  674. <value>
  675. The default value is equal to 5 degrees.
  676. </value>
  677. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  678. Fires when the value of this property changes.
  679. </event>
  680. </member>
  681. <member name="P:Cognex.VisionPro.CogCenterPointsToLines.SearchAngleMin">
  682. <summary>
  683. The lower bound of the search angle range, in radians. This
  684. parameter limits the rotation angle of the result transform.
  685. </summary>
  686. <remarks>
  687. Note that setting this property to a value greater than
  688. SearchAngleMax will cause SearchAngleMax to be set to
  689. the new SearchAngleMin value.
  690. </remarks>
  691. <value>
  692. The default value is equal to -5 degrees.
  693. </value>
  694. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  695. Fires when the value of this property changes.
  696. </event>
  697. </member>
  698. <member name="P:Cognex.VisionPro.CogCenterPointsToLines.Mode">
  699. <summary>
  700. How this class will perform fitting. May be either point to line
  701. fit ("Single"), or point pair to line pair fit ("Pair").
  702. </summary>
  703. <value>
  704. The default value is Single.
  705. </value>
  706. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  707. Fires when the value of this property changes.
  708. </event>
  709. <exception cref="T:System.ArgumentException">
  710. The supplied value is not a member of the
  711. <see cref="T:Cognex.VisionPro.CogCenterPointsToLinesModeConstants" />
  712. enumeration.
  713. </exception>
  714. </member>
  715. <member name="M:Cognex.VisionPro.CogCenterPointsToLines.#ctor(Cognex.VisionPro.CogCenterPointsToLines)">
  716. <summary>
  717. Copy constructs a CogCenterPointsToLines object. This
  718. is a deep copy.
  719. </summary>
  720. <param name="Other">
  721. The CogCenterPointsToLines object to be copied.
  722. </param>
  723. <exception cref="T:System.ArgumentNullException">
  724. If Other is null.
  725. </exception>
  726. </member>
  727. <member name="M:Cognex.VisionPro.CogCenterPointsToLines.#ctor">
  728. <summary>
  729. Default construct a CogCenterPointsToLines.
  730. </summary>
  731. </member>
  732. <member name="M:Cognex.VisionPro.CogCenterPointsToLines.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  733. <summary>
  734. Serialization construct a CogCenterPointsToLines object.
  735. </summary>
  736. <param name="Info">
  737. The standard SerializationInfo argument.
  738. </param>
  739. <param name="Ctxt">
  740. The standard StreamingContext argument.
  741. </param>
  742. </member>
  743. <member name="F:Cognex.VisionPro.CogCenterPointsToLines.SfTimeout">
  744. <summary>
  745. This bit will be set in the EventArgs of a Changed event
  746. every time the value returned by Timeout
  747. may have been changed.
  748. </summary>
  749. </member>
  750. <member name="F:Cognex.VisionPro.CogCenterPointsToLines.SfTimeoutEnabled">
  751. <summary>
  752. This bit will be set in the EventArgs of a Changed event
  753. every time the value returned by TimeoutEnabled
  754. may have been changed.
  755. </summary>
  756. </member>
  757. <member name="F:Cognex.VisionPro.CogCenterPointsToLines.SfSearchAngleMax">
  758. <summary>
  759. This bit will be set in the EventArgs of a Changed event
  760. every time the value returned by SearchAngleMax
  761. may have been changed.
  762. </summary>
  763. </member>
  764. <member name="F:Cognex.VisionPro.CogCenterPointsToLines.SfSearchAngleMin">
  765. <summary>
  766. This bit will be set in the EventArgs of a Changed event
  767. every time the value returned by SearchAngleMin
  768. may have been changed.
  769. </summary>
  770. </member>
  771. <member name="F:Cognex.VisionPro.CogCenterPointsToLines.SfNormalDirectionInferenceMethod">
  772. <summary>
  773. This bit will be set in the EventArgs of a Changed event
  774. every time the value returned by NormalDirectionInferenceMethod
  775. may have been changed.
  776. </summary>
  777. </member>
  778. <member name="F:Cognex.VisionPro.CogCenterPointsToLines.SfMode">
  779. <summary>
  780. This bit will be set in the EventArgs of a Changed event
  781. every time the value returned by Mode
  782. may have been changed.
  783. </summary>
  784. </member>
  785. <member name="T:Cognex.VisionPro.CogCenterPointsToLines">
  786. <summary>
  787. This class finds a 2D linear transform between points and
  788. lines, centering the lines with respect to the points.
  789. </summary>
  790. <remarks>
  791. <para>
  792. This class supports two modes of fitting:
  793. <list type="bullet"><item>
  794. Point to line fit ("Single").
  795. The feature correspondences are between individual points and lines.
  796. The class will minimize the variance in the point to line
  797. signed distance across all point to line correspondences.
  798. The class tries to make all of the point to line distances the
  799. same.
  800. </item><item>
  801. Point pair to line pair fit ("Pair").
  802. The feature correspondences are between point pairs and line
  803. pairs. The class will minimize the variation in the point to line
  804. signed distance differences, across all point pair line
  805. pair correspondences. The point to line distance difference for
  806. a given point pair line pair correspondence is the difference
  807. between the point to line distance for the first point and the
  808. point to line distance for the second point in the point pair.
  809. The class tries to make the two point to line signed distances
  810. in each point pair line pair correspondence the same. Signed
  811. distances are measured in the direction of the normal to the
  812. line.
  813. </item></list></para>
  814. <para>
  815. This class uses line segments to specify lines, but the centering
  816. is performed between points and lines (or point-pairs and
  817. line-pairs). In other words, the point to line distances are not
  818. affected by the end points of the line segments.
  819. </para>
  820. </remarks>
  821. </member>
  822. <member name="P:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.LineSegmentBEndY">
  823. <summary>
  824. The Y coordinate of the "B" line segment's end point.
  825. </summary>
  826. <value>
  827. The default value is zero.
  828. </value>
  829. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  830. Fires when the value of this property changes.
  831. </event>
  832. </member>
  833. <member name="P:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.LineSegmentBEndX">
  834. <summary>
  835. The X coordinate of the "B" line segment's end point.
  836. </summary>
  837. <value>
  838. The default value is zero.
  839. </value>
  840. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  841. Fires when the value of this property changes.
  842. </event>
  843. </member>
  844. <member name="P:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.LineSegmentBStartY">
  845. <summary>
  846. The Y coordinate of the "B" line segment's start point.
  847. </summary>
  848. <value>
  849. The default value is zero.
  850. </value>
  851. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  852. Fires when the value of this property changes.
  853. </event>
  854. </member>
  855. <member name="P:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.LineSegmentBStartX">
  856. <summary>
  857. The X coordinate of the "B" line segment's start point.
  858. </summary>
  859. <value>
  860. The default value is zero.
  861. </value>
  862. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  863. Fires when the value of this property changes.
  864. </event>
  865. </member>
  866. <member name="P:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.LineSegmentAEndY">
  867. <summary>
  868. The Y coordinate of the "A" line segment's end point.
  869. </summary>
  870. <value>
  871. The default value is zero.
  872. </value>
  873. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  874. Fires when the value of this property changes.
  875. </event>
  876. </member>
  877. <member name="P:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.LineSegmentAEndX">
  878. <summary>
  879. The X coordinate of the "A" line segment's end point.
  880. </summary>
  881. <value>
  882. The default value is zero.
  883. </value>
  884. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  885. Fires when the value of this property changes.
  886. </event>
  887. </member>
  888. <member name="P:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.LineSegmentAStartY">
  889. <summary>
  890. The Y coorinate of the "A" line segment's start point.
  891. </summary>
  892. <value>
  893. The default value is zero.
  894. </value>
  895. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  896. Fires when the value of this property changes.
  897. </event>
  898. </member>
  899. <member name="P:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.LineSegmentAStartX">
  900. <summary>
  901. The X coorinate of the "A" line segment's start point.
  902. </summary>
  903. <value>
  904. The default value is zero.
  905. </value>
  906. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  907. Fires when the value of this property changes.
  908. </event>
  909. </member>
  910. <member name="P:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.PointBY">
  911. <summary>
  912. The Y coordinate of the "B" point.
  913. </summary>
  914. <value>
  915. The default value is zero.
  916. </value>
  917. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  918. Fires when the value of this property changes.
  919. </event>
  920. </member>
  921. <member name="P:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.PointBX">
  922. <summary>
  923. The X coordinate of the "B" point.
  924. </summary>
  925. <value>
  926. The default value is zero.
  927. </value>
  928. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  929. Fires when the value of this property changes.
  930. </event>
  931. </member>
  932. <member name="P:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.PointAY">
  933. <summary>
  934. The Y coordinate of the "A" point.
  935. </summary>
  936. <value>
  937. The default value is zero.
  938. </value>
  939. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  940. Fires when the value of this property changes.
  941. </event>
  942. </member>
  943. <member name="P:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.PointAX">
  944. <summary>
  945. The X coordinate of the "A" point.
  946. </summary>
  947. <value>
  948. The default value is zero.
  949. </value>
  950. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  951. Fires when the value of this property changes.
  952. </event>
  953. </member>
  954. <member name="M:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.Finalize">
  955. <summary>
  956. Finalize this CogCenterPointsToLinesCorrespondence.
  957. </summary>
  958. </member>
  959. <member name="M:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.Dispose">
  960. <summary>
  961. Destruct this CogCenterPointsToLinesCorrespondence.
  962. </summary>
  963. </member>
  964. <member name="M:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.#ctor(Cognex.VisionPro.CogCenterPointsToLinesCorrespondence)">
  965. <summary>
  966. Copy constructs a CogCenterPointsToLinesCorrespondence
  967. object. This is a deep copy.
  968. </summary>
  969. <param name="Other">
  970. The CogCenterPointsToLinesCorrespondence object to be
  971. copied.
  972. </param>
  973. <exception cref="T:System.ArgumentNullException">
  974. If Other is null.
  975. </exception>
  976. </member>
  977. <member name="M:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.#ctor">
  978. <summary>
  979. Default construct a CogCenterPointsToLinesCorrespondence.
  980. </summary>
  981. </member>
  982. <member name="M:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  983. <summary>
  984. Serialization construct a CogCenterPointsToLinesCorrespondence object.
  985. </summary>
  986. <param name="Info">
  987. The standard SerializationInfo argument.
  988. </param>
  989. <param name="Ctxt">
  990. The standard StreamingContext argument.
  991. </param>
  992. </member>
  993. <member name="F:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.SfLineSegmentBEndY">
  994. <summary>
  995. This bit will be set in the EventArgs of a Changed event
  996. every time the value returned by LineSegmentBEndY
  997. may have been changed.
  998. </summary>
  999. </member>
  1000. <member name="F:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.SfLineSegmentBEndX">
  1001. <summary>
  1002. This bit will be set in the EventArgs of a Changed event
  1003. every time the value returned by LineSegmentBEndX
  1004. may have been changed.
  1005. </summary>
  1006. </member>
  1007. <member name="F:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.SfLineSegmentBStartY">
  1008. <summary>
  1009. This bit will be set in the EventArgs of a Changed event
  1010. every time the value returned by LineSegmentBStartY
  1011. may have been changed.
  1012. </summary>
  1013. </member>
  1014. <member name="F:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.SfLineSegmentBStartX">
  1015. <summary>
  1016. This bit will be set in the EventArgs of a Changed event
  1017. every time the value returned by LineSegmentBStartX
  1018. may have been changed.
  1019. </summary>
  1020. </member>
  1021. <member name="F:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.SfLineSegmentAEndY">
  1022. <summary>
  1023. This bit will be set in the EventArgs of a Changed event
  1024. every time the value returned by LineSegmentAEndY
  1025. may have been changed.
  1026. </summary>
  1027. </member>
  1028. <member name="F:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.SfLineSegmentAEndX">
  1029. <summary>
  1030. This bit will be set in the EventArgs of a Changed event
  1031. every time the value returned by LineSegmentAEndX
  1032. may have been changed.
  1033. </summary>
  1034. </member>
  1035. <member name="F:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.SfLineSegmentAStartY">
  1036. <summary>
  1037. This bit will be set in the EventArgs of a Changed event
  1038. every time the value returned by LineSegmentAStartY
  1039. may have been changed.
  1040. </summary>
  1041. </member>
  1042. <member name="F:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.SfLineSegmentAStartX">
  1043. <summary>
  1044. This bit will be set in the EventArgs of a Changed event
  1045. every time the value returned by LineSegmentAStartX
  1046. may have been changed.
  1047. </summary>
  1048. </member>
  1049. <member name="F:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.SfPointBY">
  1050. <summary>
  1051. This bit will be set in the EventArgs of a Changed event
  1052. every time the value returned by PointBY
  1053. may have been changed.
  1054. </summary>
  1055. </member>
  1056. <member name="F:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.SfPointBX">
  1057. <summary>
  1058. This bit will be set in the EventArgs of a Changed event
  1059. every time the value returned by PointBX
  1060. may have been changed.
  1061. </summary>
  1062. </member>
  1063. <member name="F:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.SfPointAY">
  1064. <summary>
  1065. This bit will be set in the EventArgs of a Changed event
  1066. every time the value returned by PointAY
  1067. may have been changed.
  1068. </summary>
  1069. </member>
  1070. <member name="F:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.SfPointAX">
  1071. <summary>
  1072. This bit will be set in the EventArgs of a Changed event
  1073. every time the value returned by PointAX
  1074. may have been changed.
  1075. </summary>
  1076. </member>
  1077. <member name="T:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence">
  1078. <summary>
  1079. This class holds a corresponded point and line segment,
  1080. or a corresponded point pair and line segment pair.
  1081. </summary>
  1082. <remarks>
  1083. This class has properties whose name includes either "A" or
  1084. "B". When used in the context of
  1085. <see cref="T:Cognex.VisionPro.CogCenterPointsToLinesModeConstants">
  1086. Single</see> mode, only the "A" properties are meaningful.
  1087. When used in the context of
  1088. <see cref="T:Cognex.VisionPro.CogCenterPointsToLinesModeConstants">
  1089. Pair</see> mode, both the "A" and "B" properties are meaningful.
  1090. </remarks>
  1091. </member>
  1092. <member name="P:Cognex.VisionPro.CogCenterPointsToLinesResult.SignedDistanceAbsoluteDifferenceStatistics">
  1093. <summary>
  1094. The statistics of the absolute difference between the signed distances
  1095. of each point and line in a point pair, across all point-pair
  1096. line-pair correspondences. This property is null if Mode is
  1097. Single.
  1098. </summary>
  1099. </member>
  1100. <member name="P:Cognex.VisionPro.CogCenterPointsToLinesResult.SignedDistanceStatistics">
  1101. <summary>
  1102. The statistics of the signed distances between each point and its
  1103. corresponding line.
  1104. </summary>
  1105. </member>
  1106. <member name="P:Cognex.VisionPro.CogCenterPointsToLinesResult.SignedDistancesB">
  1107. <summary>
  1108. The signed distances from each ("B") point to its corresponding ("B")
  1109. line, measured along the normal to the line.
  1110. If Mode is Single then this property is null.
  1111. </summary>
  1112. </member>
  1113. <member name="P:Cognex.VisionPro.CogCenterPointsToLinesResult.SignedDistancesA">
  1114. <summary>
  1115. The signed distances from each ("A") point to its corresponding ("A")
  1116. line, measured along the normal to the line.
  1117. </summary>
  1118. </member>
  1119. <member name="P:Cognex.VisionPro.CogCenterPointsToLinesResult.LinesFromPointsTransform">
  1120. <summary>
  1121. The best fit linear transform that maps from points to lines.
  1122. If Mode was Single, this transform minimizes the variation in the
  1123. signed distance between the ("A") points and the the ("A") lines.
  1124. If Mode was Pair, then this transform minimizes the
  1125. variation in the point to line signed distance differences
  1126. across all point-pair line-pair correspondences.
  1127. </summary>
  1128. </member>
  1129. <member name="P:Cognex.VisionPro.CogCenterPointsToLinesResult.Mode">
  1130. <summary>
  1131. How the centering process was performed. May be either "Single" or
  1132. "Pair". If Mode was "Single", then both the SignedDistancesB property
  1133. and the SignedDistanceAbsoluteDifferenceStatistics property will be
  1134. null.
  1135. </summary>
  1136. </member>
  1137. <member name="M:Cognex.VisionPro.CogCenterPointsToLinesResult.Finalize">
  1138. <summary>
  1139. Finalize this CogCenterPointsToLinesResult.
  1140. </summary>
  1141. </member>
  1142. <member name="M:Cognex.VisionPro.CogCenterPointsToLinesResult.Dispose">
  1143. <summary>
  1144. Destruct this CogCenterPointsToLinesResult.
  1145. </summary>
  1146. </member>
  1147. <member name="M:Cognex.VisionPro.CogCenterPointsToLinesResult.#ctor(Cognex.VisionPro.CogCenterPointsToLinesResult)">
  1148. <summary>
  1149. Copy constructs a CogCenterPointsToLinesResult object. This is a
  1150. deep copy.
  1151. </summary>
  1152. <param name="Other">
  1153. The result object to be copied. May not be null.
  1154. </param>
  1155. <exception cref="T:System.ArgumentNullException">
  1156. If the input argument is null.
  1157. </exception>
  1158. </member>
  1159. <member name="M:Cognex.VisionPro.CogCenterPointsToLinesResult.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  1160. <summary>
  1161. Serialization construct a CogCenterPointsToLinesResult object.
  1162. </summary>
  1163. <param name="Info">
  1164. The standard SerializationInfo argument.
  1165. </param>
  1166. <param name="Ctxt">
  1167. The standard StreamingContext argument.
  1168. </param>
  1169. </member>
  1170. <member name="T:Cognex.VisionPro.CogCenterPointsToLinesResult">
  1171. <summary>
  1172. The CogCenterPointsToLinesResult class describes the successful
  1173. result of a call to the CogCenterPointsToLines Execute(...)
  1174. method. This result class represents an immutable object - its content
  1175. is set at construction and cannot be changed.
  1176. </summary>
  1177. </member>
  1178. <member name="M:Cognex.VisionPro.CogImageCollectionMCamerasNPoses.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  1179. <summary>
  1180. Serialization construct a CogImageCollectionMCamerasNPoses object.
  1181. </summary>
  1182. <param name="Info">
  1183. The standard SerializationInfo argument.
  1184. </param>
  1185. <param name="Ctxt">
  1186. The standard StreamingContext argument.
  1187. </param>
  1188. </member>
  1189. <member name="M:Cognex.VisionPro.CogImageCollectionMCamerasNPoses.#ctor(Cognex.VisionPro.CogImageCollectionMCamerasNPoses)">
  1190. <summary>
  1191. Copy constructs a CogImageCollectionMCamerasNPoses object. This is a shallow
  1192. copy for the images.
  1193. </summary>
  1194. <param name="other">
  1195. The CogImageCollectionMCamerasNPoses object to be copied.
  1196. </param>
  1197. <exception cref="T:System.ArgumentNullException">
  1198. If <paramref name="other" /> is null.
  1199. </exception>
  1200. </member>
  1201. <member name="M:Cognex.VisionPro.CogImageCollectionMCamerasNPoses.#ctor">
  1202. <summary>
  1203. Constructs a default (empty) CogImageCollectionMCamerasNPoses.
  1204. </summary>
  1205. </member>
  1206. <member name="T:Cognex.VisionPro.CogImageCollectionMCamerasNPoses">
  1207. <summary>
  1208. This class holds image collections of multiple cameras at multiple poses.
  1209. <para>
  1210. CogImageCollectionMCamerasNPoses[poseIndex][cameraIndex] is the <see cref="T:Cognex.VisionPro.ICogImage" />
  1211. for camera "cameraIndex" at pose "poseIndex".
  1212. </para></summary>
  1213. </member>
  1214. <member name="M:Cognex.VisionPro.CogImageCollection.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  1215. <summary>
  1216. Serialization construct a CogImageCollection object.
  1217. </summary>
  1218. <param name="Info">
  1219. The standard SerializationInfo argument.
  1220. </param>
  1221. <param name="Ctxt">
  1222. The standard StreamingContext argument.
  1223. </param>
  1224. </member>
  1225. <member name="M:Cognex.VisionPro.CogImageCollection.#ctor(Cognex.VisionPro.CogImageCollection)">
  1226. <summary>
  1227. Copy constructs a CogImageCollection object. This is a shallow
  1228. copy for the images.
  1229. </summary>
  1230. <param name="Other">
  1231. The CogImageCollection object to be copied.
  1232. </param>
  1233. <exception cref="T:System.ArgumentNullException">
  1234. If <paramref name="Other" /> is null.
  1235. </exception>
  1236. </member>
  1237. <member name="M:Cognex.VisionPro.CogImageCollection.#ctor">
  1238. <summary>
  1239. Constructs a default (empty) CogImageCollection.
  1240. </summary>
  1241. </member>
  1242. <member name="T:Cognex.VisionPro.CogImageCollection">
  1243. <summary>
  1244. This class holds a collection of <see cref="T:Cognex.VisionPro.ICogImage" />.
  1245. </summary>
  1246. </member>
  1247. <member name="M:Cognex.VisionPro.CogImage16Range.ResetCoordinateSpaceTree3D">
  1248. <summary>
  1249. For Cognex internal use only.
  1250. </summary>
  1251. </member>
  1252. <member name="M:Cognex.VisionPro.CogImage16Range.Add3DSpace(System.String,System.String,System.IntPtr,System.Int32)">
  1253. <summary>
  1254. For Cognex internal use only.
  1255. </summary>
  1256. </member>
  1257. <member name="M:Cognex.VisionPro.CogImage16Range.CreateScaledImage(System.Int32,System.Int32,System.IntPtr@)">
  1258. <summary>
  1259. For Cognex internal use only.
  1260. </summary>
  1261. </member>
  1262. <member name="M:Cognex.VisionPro.CogImage16Range.Make3DTreeImageAlignedOnly(System.Double,System.String)">
  1263. <summary>
  1264. For Cognex internal use only.
  1265. </summary>
  1266. </member>
  1267. <member name="M:Cognex.VisionPro.CogImage16Range.CopyMergeTree3D(System.IntPtr,System.Int32,System.String,System.IntPtr)">
  1268. <summary>
  1269. For Cognex internal use only.
  1270. </summary>
  1271. </member>
  1272. <member name="M:Cognex.VisionPro.CogImage16Range.Rename3DSpace(System.String,System.String)">
  1273. <summary>
  1274. For Cognex internal use only.
  1275. </summary>
  1276. </member>
  1277. <member name="M:Cognex.VisionPro.CogImage16Range.SetTree3DBinary(System.IntPtr)">
  1278. <summary>
  1279. For Cognex internal use only.
  1280. </summary>
  1281. </member>
  1282. <member name="M:Cognex.VisionPro.CogImage16Range.GetTree3DBinary(System.IntPtr@)">
  1283. <summary>
  1284. For Cognex internal use only.
  1285. </summary>
  1286. </member>
  1287. <member name="M:Cognex.VisionPro.CogImage16Range.CopyTrees(System.IntPtr)">
  1288. <summary>
  1289. For Cognex internal use only.
  1290. </summary>
  1291. </member>
  1292. <member name="M:Cognex.VisionPro.CogImage16Range.GetTransform3D(System.String,System.String,System.Double@,System.Double@,System.Double@,System.Double@,System.Double@,System.Double@,System.Double@,System.Double@,System.Double@,System.Double@,System.Double@,System.Double@)">
  1293. <summary>
  1294. For Cognex internal use only.
  1295. </summary>
  1296. </member>
  1297. <member name="M:Cognex.VisionPro.CogImage16Range.Clone(System.IntPtr@)">
  1298. <summary>
  1299. For Cognex internal use only.
  1300. </summary>
  1301. </member>
  1302. <member name="M:Cognex.VisionPro.CogImage16Range.InitForDisplay(System.IntPtr,System.IntPtr,System.IntPtr)">
  1303. <summary>
  1304. For Cognex internal use only.
  1305. </summary>
  1306. </member>
  1307. <member name="M:Cognex.VisionPro.CogImage16Range.GetPel(System.Int32,System.Int32,System.Boolean@,System.Int32@)">
  1308. <summary>
  1309. For Cognex internal use only.
  1310. </summary>
  1311. </member>
  1312. <member name="M:Cognex.VisionPro.CogImage16Range.SetSelectedSpaceName3D(System.String)">
  1313. <summary>
  1314. For Cognex internal use only.
  1315. </summary>
  1316. </member>
  1317. <member name="M:Cognex.VisionPro.CogImage16Range.GetSelectedSpaceName3D">
  1318. <summary>
  1319. For Cognex internal use only.
  1320. </summary>
  1321. </member>
  1322. <member name="M:Cognex.VisionPro.CogImage16Range.SetPixelFromRoot3D(System.Double,System.Double,System.Double,System.Double,System.Double,System.Double,System.Double,System.Double,System.Double,System.Double,System.Double,System.Double)">
  1323. <summary>
  1324. For Cognex internal use only.
  1325. </summary>
  1326. </member>
  1327. <member name="M:Cognex.VisionPro.CogImage16Range.GetPixelFromRoot3D(System.Double@,System.Double@,System.Double@,System.Double@,System.Double@,System.Double@,System.Double@,System.Double@,System.Double@,System.Double@,System.Double@,System.Double@)">
  1328. <summary>
  1329. For Cognex internal use only.
  1330. </summary>
  1331. </member>
  1332. <member name="M:Cognex.VisionPro.CogImage16Range.SetRootFromSensor3D(System.Double,System.Double,System.Double,System.Double,System.Double,System.Double,System.Double,System.Double,System.Double,System.Double,System.Double,System.Double)">
  1333. <summary>
  1334. For Cognex internal use only.
  1335. </summary>
  1336. </member>
  1337. <member name="M:Cognex.VisionPro.CogImage16Range.GetRootFromSensor3D(System.Double@,System.Double@,System.Double@,System.Double@,System.Double@,System.Double@,System.Double@,System.Double@,System.Double@,System.Double@,System.Double@,System.Double@)">
  1338. <summary>
  1339. For Cognex internal use only.
  1340. </summary>
  1341. </member>
  1342. <member name="M:Cognex.VisionPro.CogImage16Range.SetRoots(System.IntPtr,System.IntPtr)">
  1343. <summary>
  1344. For Cognex internal use only.
  1345. </summary>
  1346. </member>
  1347. <member name="M:Cognex.VisionPro.CogImage16Range.GetRoots(System.IntPtr@,System.IntPtr@)">
  1348. <summary>
  1349. For Cognex internal use only.
  1350. </summary>
  1351. </member>
  1352. <member name="P:Cognex.VisionPro.CogImage16Range.InteropPixelFromRootTransform">
  1353. <summary>
  1354. For Cognex internal use only.
  1355. </summary>
  1356. </member>
  1357. <member name="P:Cognex.VisionPro.CogImage16Range.InteropCoordinateSpaceTree">
  1358. <summary>
  1359. For Cognex internal use only.
  1360. </summary>
  1361. </member>
  1362. <member name="P:Cognex.VisionPro.CogImage16Range.InteropSelectedSpaceName">
  1363. <summary>
  1364. For Cognex internal use only.
  1365. </summary>
  1366. </member>
  1367. <member name="P:Cognex.VisionPro.CogImage16Range.InteropWidth">
  1368. <summary>
  1369. For Cognex internal use only.
  1370. </summary>
  1371. </member>
  1372. <member name="P:Cognex.VisionPro.CogImage16Range.InteropHeight">
  1373. <summary>
  1374. For Cognex internal use only.
  1375. </summary>
  1376. </member>
  1377. <member name="P:Cognex.VisionPro.CogImage16Range.InteropAllocated">
  1378. <summary>
  1379. For Cognex internal use only.
  1380. </summary>
  1381. </member>
  1382. <member name="M:Cognex.VisionPro.CogImage16Range.InteropGetTransform(System.String,System.String)">
  1383. <summary>
  1384. For Cognex internal use only.
  1385. </summary>
  1386. </member>
  1387. <member name="M:Cognex.VisionPro.CogImage16Range.InteropCopyBase(Cognex.VisionPro.Interop.CogImageCopyModeConstants)">
  1388. <summary>
  1389. For Cognex internal use only.
  1390. </summary>
  1391. </member>
  1392. <member name="M:Cognex.VisionPro.CogImage16Range.InteropAllocate(System.Int32,System.Int32)">
  1393. <summary>
  1394. For Cognex internal use only.
  1395. </summary>
  1396. </member>
  1397. <member name="M:Cognex.VisionPro.CogImage16Range.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  1398. <summary>
  1399. Serialization constructor for CogImage16Range object.
  1400. </summary>
  1401. <param name="Info">
  1402. The standard SerializationInfo argument.
  1403. </param>
  1404. <param name="Ctxt">
  1405. The standard StreamingContext argument.
  1406. </param>
  1407. </member>
  1408. <member name="P:Cognex.VisionPro.CogImage16Range.CoordinateSpaceTree3D">
  1409. <summary>
  1410. Get or set the tree of all named three dimensional
  1411. coordinate spaces for this image. The tree provides advanced
  1412. functions for managing three dimensional coordinate spaces.
  1413. </summary>
  1414. <exception cref="T:System.ArgumentNullException">
  1415. If NewVal is null.
  1416. </exception>
  1417. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  1418. Fires when this property changes.
  1419. </event>
  1420. </member>
  1421. <member name="P:Cognex.VisionPro.CogImage16Range.SelectedSpaceName3D">
  1422. <summary>
  1423. Gets or sets the name of the three dimensional
  1424. coordinate space to be used by tools which process this image.
  1425. </summary>
  1426. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  1427. Fires when this property changes.
  1428. </event>
  1429. </member>
  1430. <member name="P:Cognex.VisionPro.CogImage16Range.PixelFromRootTransform3D">
  1431. <summary>
  1432. Get or set the transform that maps from
  1433. three dimensional root space to pixel space.
  1434. </summary>
  1435. <exception cref="T:System.ArgumentNullException">
  1436. If NewVal is null.
  1437. </exception>
  1438. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  1439. Fires when this property changes.
  1440. </event>
  1441. </member>
  1442. <member name="P:Cognex.VisionPro.CogImage16Range.PixelFromRootTransform">
  1443. <summary>
  1444. Gets a copy of the transform that maps from
  1445. pixel space ("#") to two dimensional root space
  1446. ("@"). Due to the unique nature of the CogImage16Range,
  1447. setting PixelFromRootTransform is not allowed. Attempts to set
  1448. PixelFromRootTransform will cause an InvalidOperationException
  1449. to be thrown.
  1450. </summary>
  1451. <exception cref="T:System.InvalidOperationException">
  1452. If you attempt to set this property.
  1453. </exception>
  1454. </member>
  1455. <member name="P:Cognex.VisionPro.CogImage16Range.CoordinateSpaceTree">
  1456. <summary>
  1457. Get or set the tree of all named two dimensional
  1458. coordinate spaces for this image. The tree provides advanced
  1459. functions for managing two dimensional coordinate spaces.
  1460. </summary>
  1461. <exception cref="T:System.ArgumentNullException">
  1462. If NewVal is null.
  1463. </exception>
  1464. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  1465. Fires when this property changes.
  1466. </event>
  1467. </member>
  1468. <member name="P:Cognex.VisionPro.CogImage16Range.SelectedSpaceName">
  1469. <summary>
  1470. Get or set the name of the two dimensional coordinate
  1471. space to be used by tools that process this image.
  1472. </summary>
  1473. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  1474. Fires when this property changes.
  1475. </event>
  1476. </member>
  1477. <member name="P:Cognex.VisionPro.CogImage16Range.Width">
  1478. <summary>
  1479. The number of columns of pixels in this image.
  1480. </summary>
  1481. </member>
  1482. <member name="P:Cognex.VisionPro.CogImage16Range.Height">
  1483. <summary>
  1484. The number of rows of pixels in this image.
  1485. </summary>
  1486. </member>
  1487. <member name="P:Cognex.VisionPro.CogImage16Range.Allocated">
  1488. <summary>
  1489. Whether there is pixel data associated with this image.
  1490. </summary>
  1491. </member>
  1492. <member name="M:Cognex.VisionPro.CogImage16Range.GetMaskData">
  1493. <summary>
  1494. Returns a CogImage8Grey that represents the mask
  1495. data of this image. This data is commonly referred
  1496. to as the "visible pixel mask" and is provided
  1497. as an indication of which pixel values were
  1498. visible to the camera during acquisition. Any
  1499. range image pixel that was not visible has an undefined
  1500. pixel value. The visible pixel mask represents
  1501. a visible pixel at a given row and column
  1502. with an 8 bit grey value of 255,
  1503. and a non-visible pixel with an 8 bit grey value
  1504. of zero. The CogImage8Root and the two
  1505. dimensional coordinate space tree of this
  1506. CogImage8Grey visible pixel mask representation
  1507. are shared with this range image. Note that
  1508. the value returned by this method may be null,
  1509. in which case all pixel values are considered
  1510. visible.
  1511. </summary>
  1512. </member>
  1513. <member name="M:Cognex.VisionPro.CogImage16Range.GetPixelData">
  1514. <summary>
  1515. Returns a CogImage16Grey that represents the range or
  1516. height data of this image. The root and two dimensional coordinate
  1517. space tree are shared with this range image.
  1518. </summary>
  1519. </member>
  1520. <member name="M:Cognex.VisionPro.CogImage16Range.MapPoints3DFrom2D(System.String,System.String,Cognex.VisionPro3D.Cog3DVect2Collection,System.Boolean[]@,Cognex.VisionPro3D.Cog3DVect3Collection@)">
  1521. <summary>
  1522. Maps the supplied collection of two dimensional
  1523. points into the specified three dimensional
  1524. space. This is accomplished by first mapping
  1525. an input two dimensional point into pixel
  1526. space. If the range image's visible pixel
  1527. mask indicates that this pixel was not visible,
  1528. then the corresponding element in the output
  1529. Visible array is set to false and the corresponding
  1530. element in the output DstPoints3D collection
  1531. is set to a default (0,0,0) value. Otherwise,
  1532. the pixel value is read. This range image
  1533. pixel value is incremented by 0.5 to place it
  1534. at a "middle" height within the subject voxel.
  1535. The resulting pixel space coordinate triple is
  1536. mapped into the requested three dimensional
  1537. space.
  1538. </summary>
  1539. <param name="DstPoint3DSpaceName">
  1540. The destination three dimensional space name.
  1541. </param>
  1542. <param name="SrcPoint2DSpaceName">
  1543. The source two dimensional space name.
  1544. </param>
  1545. <param name="SrcPoints2D">
  1546. The source two dimensional point collection.
  1547. </param>
  1548. <param name="Visible">
  1549. An output array of boolean values indicating which
  1550. input points were visible. The number of elements
  1551. in this array will equal the number of input points.
  1552. </param>
  1553. <param name="DstPoints3D">
  1554. The resulting mapped three dimensional points. Any
  1555. element corresponding to an input point that was
  1556. not visible will have the value 0,0,0. This
  1557. collection will have the same size as the input
  1558. point collection.
  1559. </param>
  1560. <exception cref="T:System.ArgumentNullException">
  1561. If DstPoint3DSpaceName is null.
  1562. </exception>
  1563. <exception cref="T:System.ArgumentNullException">
  1564. If SrcPoint2DSpaceName is null.
  1565. </exception>
  1566. <exception cref="T:System.ArgumentNullException">
  1567. If SrcPoints2D is null.
  1568. </exception>
  1569. <exception cref="T:Cognex.VisionPro.Exceptions.CogImageNoPixelsException">
  1570. If Allocated is false.
  1571. </exception>
  1572. </member>
  1573. <member name="M:Cognex.VisionPro.CogImage16Range.MapPoint3DFrom2D(System.String,System.String,Cognex.VisionPro3D.Cog3DVect2,System.Boolean@,Cognex.VisionPro3D.Cog3DVect3@)">
  1574. <summary>
  1575. Maps the supplied two dimensional point into the
  1576. specified three dimensional space. This is
  1577. accomplished by first mapping the input two
  1578. dimensional point to pixel space. If the
  1579. range image's visible pixel mask indicates
  1580. that this pixel was not visible, then the
  1581. Visible output argument is set to false and
  1582. no further processing is performed. Otherwise,
  1583. the pixel value is read. This range
  1584. image pixel value is incremented by 0.5
  1585. to place it at a "middle" height within
  1586. the subject voxel. The resulting pixel space
  1587. coordinate triple is mapped into the
  1588. requested three dimensional space.
  1589. </summary>
  1590. <param name="DstPoint3DSpaceName">
  1591. The destination three dimensional space name.
  1592. </param>
  1593. <param name="SrcPoint2DSpaceName">
  1594. The source two dimensional space name.
  1595. </param>
  1596. <param name="SrcPoint2D">
  1597. The source two dimensional point.
  1598. </param>
  1599. <param name="Visible">
  1600. True if the source two dimensional point was visible.
  1601. </param>
  1602. <param name="DstPoint3D">
  1603. The resulting mapped three dimensional point. This will
  1604. be 0,0,0 if Visible is false.
  1605. </param>
  1606. <exception cref="T:System.ArgumentNullException">
  1607. If DstPoint3DSpaceName is null.
  1608. </exception>
  1609. <exception cref="T:System.ArgumentNullException">
  1610. If SrcPoint2DSpaceName is null.
  1611. </exception>
  1612. <exception cref="T:Cognex.VisionPro.Exceptions.CogImageNoPixelsException">
  1613. If Allocated is false.
  1614. </exception>
  1615. </member>
  1616. <member name="M:Cognex.VisionPro.CogImage16Range.MapPoints2DFrom3D(System.String,System.String,Cognex.VisionPro3D.Cog3DVect3Collection,Cognex.VisionPro3D.Cog3DVect2Collection@)">
  1617. <summary>
  1618. Maps the supplied collection of three dimensional
  1619. points into the specified two dimensional space.
  1620. This is accomplished by first mapping an input three
  1621. dimensional point to root space. The X and Y coodinates
  1622. of this root space point are then mapped to the specified
  1623. two dimensional space to produce that output two
  1624. dimensional point.
  1625. </summary>
  1626. <param name="DstPoint2DSpaceName">
  1627. The destination two dimensional space name.
  1628. </param>
  1629. <param name="SrcPoint3DSpaceName">
  1630. The source three dimensional space name.
  1631. </param>
  1632. <param name="SrcPoints3D">
  1633. The source three dimensional point collection.
  1634. </param>
  1635. <param name="DstPoints2D">
  1636. The resulting collection of mapped two dimensional points.
  1637. </param>
  1638. <exception cref="T:System.ArgumentNullException">
  1639. If DstPoint2DSpaceName is null.
  1640. </exception>
  1641. <exception cref="T:System.ArgumentNullException">
  1642. If SrcPoint3DSpaceName is null.
  1643. </exception>
  1644. <exception cref="T:System.ArgumentNullException">
  1645. If SrcPoints3D is null.
  1646. </exception>
  1647. </member>
  1648. <member name="M:Cognex.VisionPro.CogImage16Range.MapPoint2DFrom3D(System.String,System.String,Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DVect2@)">
  1649. <summary>
  1650. Maps the supplied three dimensional point into the
  1651. specified two dimensional space. This is accomplished
  1652. by first mapping the input three dimensional point to
  1653. root space. The X and Y coodinates of this root space
  1654. point are then mapped to the specified two dimensional
  1655. space to produce the output two dimensional point.
  1656. </summary>
  1657. <param name="DstPoint2DSpaceName">
  1658. The destination two dimensional space name.
  1659. </param>
  1660. <param name="SrcPoint3DSpaceName">
  1661. The source three dimensional space name.
  1662. </param>
  1663. <param name="SrcPoint3D">
  1664. The source three dimensional point.
  1665. </param>
  1666. <param name="DstPoint2D">
  1667. The resulting mapped two dimensional point.
  1668. </param>
  1669. <exception cref="T:System.ArgumentNullException">
  1670. If DstPoint2DSpaceName is null.
  1671. </exception>
  1672. <exception cref="T:System.ArgumentNullException">
  1673. If SrcPoint3DSpaceName is null.
  1674. </exception>
  1675. </member>
  1676. <member name="M:Cognex.VisionPro.CogImage16Range.GetTransform3D(System.String,System.String)">
  1677. <summary>
  1678. Returns a transform that maps three dimensional points
  1679. from the 'From' space to the 'To' space.
  1680. The special string "." is accepted as an alias
  1681. for the SelectedSpaceName3D of this image.
  1682. </summary>
  1683. <param name="ToSpaceName">
  1684. The name of the three dimensional coordinate
  1685. space to transform the point to. The special string "." is
  1686. accepted as an alias for the SelectedSpaceName3D of this image.
  1687. </param>
  1688. <param name="FromSpaceName">
  1689. The name of the three dimensional coordinate
  1690. space to transform the point from. The special string "." is
  1691. accepted as an alias for the SelectedSpaceName3D of this image.
  1692. </param>
  1693. <exception cref="T:System.ArgumentNullException">
  1694. If ToSpaceName is null.
  1695. </exception>
  1696. <exception cref="T:System.ArgumentNullException">
  1697. If FromSpaceName is null.
  1698. </exception>
  1699. <exception cref="T:Cognex.VisionPro.Exceptions.CogImageNoTreeException">
  1700. If CoordinateSpaceTree3D is null.
  1701. </exception>
  1702. </member>
  1703. <member name="M:Cognex.VisionPro.CogImage16Range.ScaleImage(System.Int32,System.Int32)">
  1704. <summary>
  1705. Creates a scaled version of this image. The dimensions
  1706. of the returned image (in pixels) are specified by the DesiredWidth
  1707. and DesiredHeight arguments. The scaling is performed using bilinear
  1708. interpolation.
  1709. </summary>
  1710. <param name="DesiredWidth">
  1711. The width in pixels of the desired output image.
  1712. </param>
  1713. <param name="DesiredHeight">
  1714. The height in pixels of the desired output image.
  1715. </param>
  1716. <exception cref="T:Cognex.VisionPro.Exceptions.CogImageNoPixelsException">
  1717. If Allocated is false.
  1718. </exception>
  1719. </member>
  1720. <member name="M:Cognex.VisionPro.CogImage16Range.ToBitmap">
  1721. <summary>
  1722. Creates a 24-bit RGB Windows bitmap from this image.
  1723. </summary>
  1724. </member>
  1725. <member name="M:Cognex.VisionPro.CogImage16Range.GetTransform(System.String,System.String)">
  1726. <summary>
  1727. Returns a transform that maps two dimensional points
  1728. from the 'From' space to the 'To' space.
  1729. The special string "." is accepted as an alias
  1730. for the SelectedSpaceName of this image.
  1731. </summary>
  1732. <param name="ToSpaceName">
  1733. The name of the two dimensional coordinate
  1734. space to transform the point to. The special string "." is
  1735. accepted as an alias for the SelectedSpaceName of this image.
  1736. </param>
  1737. <param name="FromSpaceName">
  1738. The name of the two dimensional coordinate
  1739. space to transform the point from. The special string "." is
  1740. accepted as an alias for the SelectedSpaceName of this image.
  1741. </param>
  1742. <exception cref="T:System.ArgumentNullException">
  1743. If ToSpaceName is null.
  1744. </exception>
  1745. <exception cref="T:System.ArgumentNullException">
  1746. If FromSpaceName is null.
  1747. </exception>
  1748. <exception cref="T:Cognex.VisionPro.Exceptions.CogImageNoTreeException">
  1749. If CoordinateSpaceTree is null.
  1750. </exception>
  1751. </member>
  1752. <member name="M:Cognex.VisionPro.CogImage16Range.SetPixel(System.Int32,System.Int32,System.Boolean,System.UInt16)">
  1753. <summary>
  1754. Set the pixel and mask values at a given pixel space
  1755. location. Note that setting VisibleValue to false
  1756. on a CogImage16Range whose root currently has a null
  1757. mask root will cause an appropriately sized and populated
  1758. mask root to be created. The opposite is not true:
  1759. setting the sole non-visible mask value to visible
  1760. will not cause the mask root to be set to null.
  1761. </summary>
  1762. <param name="X">
  1763. The pixel space X coordinate of interest.
  1764. </param>
  1765. <param name="Y">
  1766. The pixel space Y coordinate of interest.
  1767. </param>
  1768. <param name="VisibleValue">
  1769. True if this pixel is visible.
  1770. </param>
  1771. <param name="PixelValue">
  1772. The raw pixel value at this location.
  1773. </param>
  1774. <exception cref="T:Cognex.VisionPro.Exceptions.CogImageNoPixelsException">
  1775. If Allocated is false.
  1776. </exception>
  1777. <exception cref="T:Cognex.VisionPro.Exceptions.CogImageBadCoordException">
  1778. If X is less than zero or not less than Width, or if Y is
  1779. less than zero or not less than Height.
  1780. </exception>
  1781. </member>
  1782. <member name="M:Cognex.VisionPro.CogImage16Range.GetPixel(System.Int32,System.Int32,System.Boolean@,System.UInt16@)">
  1783. <summary>
  1784. Gets the mask (visible) and pixel value at the specified
  1785. pixel space coordinates.
  1786. </summary>
  1787. <param name="X">
  1788. The pixel space X coordinate of interest.
  1789. </param>
  1790. <param name="Y">
  1791. The pixel space Y coordinate of interest.
  1792. </param>
  1793. <param name="VisibleValue">
  1794. True if this pixel was visible.
  1795. </param>
  1796. <param name="PixelValue">
  1797. The raw pixel value at this location. This
  1798. is undefined if VisibleValue is false.
  1799. </param>
  1800. <exception cref="T:Cognex.VisionPro.Exceptions.CogImageNoPixelsException">
  1801. If Allocated is false.
  1802. </exception>
  1803. </member>
  1804. <member name="M:Cognex.VisionPro.CogImage16Range.SetRoot(Cognex.VisionPro.CogImage16RangeRoot)">
  1805. <summary>
  1806. Sets the range image root.
  1807. </summary>
  1808. <param name="Root">
  1809. The range image root.
  1810. </param>
  1811. </member>
  1812. <member name="M:Cognex.VisionPro.CogImage16Range.GetRoot(Cognex.VisionPro.CogImage16RangeRoot@)">
  1813. <summary>
  1814. Returns the range image root object that contains
  1815. the underlying pixel and mask roots.
  1816. </summary>
  1817. <param name="Root">
  1818. The range image root.
  1819. </param>
  1820. </member>
  1821. <member name="M:Cognex.VisionPro.CogImage16Range.CopyBase(Cognex.VisionPro.CogImageCopyModeConstants)">
  1822. <summary>
  1823. Create a copy of this image. Pixel and mask data
  1824. may be shared between images by specifying CopyMode to be
  1825. CogImageCopyModeConstants.SharePixels"
  1826. </summary>
  1827. <param name="CopyMode">
  1828. How to copy. May be SharePixels, CopyPixels,
  1829. or NoPixels.
  1830. </param>
  1831. </member>
  1832. <member name="M:Cognex.VisionPro.CogImage16Range.Copy">
  1833. <summary>
  1834. Create a copy of this image. Pixel and mask data
  1835. are copied.
  1836. </summary>
  1837. </member>
  1838. <member name="M:Cognex.VisionPro.CogImage16Range.Copy(Cognex.VisionPro.CogImageCopyModeConstants)">
  1839. <summary>
  1840. Create a copy of this image. Pixel and mask data
  1841. may be shared between images by specifying CopyMode to be
  1842. CogImageCopyModeConstants.SharePixels.
  1843. </summary>
  1844. <param name="CopyMode">
  1845. How to copy. May be SharePixels, CopyPixels, or NoPixels.
  1846. </param>
  1847. </member>
  1848. <member name="M:Cognex.VisionPro.CogImage16Range.Allocate(System.Int32,System.Int32)">
  1849. <summary>
  1850. Initialize the image with (undefined) pixel and mask
  1851. data of the given width and height. This method may not be
  1852. called more than once.
  1853. </summary>
  1854. <param name="DesiredWidth">
  1855. The desired width of the image in pixels.
  1856. </param>
  1857. <param name="DesiredHeight">
  1858. The desired height of the image in pixels.
  1859. </param>
  1860. <exception cref="T:Cognex.VisionPro.Exceptions.CogImageAllocateSizeException">
  1861. If the image is already allocated to a different size.
  1862. </exception>
  1863. </member>
  1864. <member name="M:Cognex.VisionPro.CogImage16Range.Finalize">
  1865. <summary>
  1866. Finalize this CogImage16Range.
  1867. </summary>
  1868. </member>
  1869. <member name="M:Cognex.VisionPro.CogImage16Range.Dispose">
  1870. <summary>
  1871. Destruct this CogImage16Range.
  1872. </summary>
  1873. </member>
  1874. <member name="M:Cognex.VisionPro.CogImage16Range.#ctor(System.Drawing.Bitmap)">
  1875. <summary>
  1876. Construct a new instance of this class using the supplied
  1877. bitmap to specify pixel data. Note that this produces
  1878. an image with an assumed identity mapping from "Sensor3D"
  1879. space to root space.
  1880. </summary>
  1881. <param name="Bmp">
  1882. The Windows Bitmap to use as the definition of pixel data.
  1883. </param>
  1884. <exception cref="System.ArgumentNullException">
  1885. If Bmp is null.
  1886. </exception>
  1887. </member>
  1888. <member name="M:Cognex.VisionPro.CogImage16Range.#ctor(Cognex.VisionPro.CogImage16Grey,System.Int32,Cognex.VisionPro3D.ICog3DTransform)">
  1889. <summary>
  1890. Construct a new instance of this class using the supplied
  1891. pixel data, missing pixel value, and RootFromSensor3D transform.
  1892. Mask data is automatically computed by identifying any pixel
  1893. in the PixelData argument whose value matches the
  1894. MissingPixelValue as not visible while all other pixels are
  1895. set to visible. If no missing pixels are found then the
  1896. mask root is set to null.
  1897. </summary>
  1898. <param name="PixelData">
  1899. Use the pixels in this CogImage16Grey as the height or
  1900. range data for this image.
  1901. </param>
  1902. <param name="MissingPixelValue">
  1903. Pixels in the PixelData argument that have this value
  1904. are set to not visible, and all other pixels are
  1905. set to visible.
  1906. </param>
  1907. <param name="RootFromSensor3D">
  1908. An ICog3DTransform that specifies the mapping from
  1909. "Sensor3D" space to root space. May not be null.
  1910. </param>
  1911. <exception cref="System.ArgumentNullException">
  1912. If PixelData is null.
  1913. </exception>
  1914. <exception cref="System.ArgumentOutOfRangeException">
  1915. If MissingPixelValue is less than zero.
  1916. </exception>
  1917. <exception cref="System.ArgumentNullException">
  1918. If RootFromSensor3D is null.
  1919. </exception>
  1920. <exception cref="System.ArgumentException">
  1921. If PixelData is not allocated.
  1922. </exception>
  1923. </member>
  1924. <member name="M:Cognex.VisionPro.CogImage16Range.#ctor(Cognex.VisionPro.CogImage16Grey,Cognex.VisionPro.CogImage8Grey,Cognex.VisionPro3D.ICog3DTransform)">
  1925. <summary>
  1926. Construct a new instance of this class using the supplied
  1927. pixel data, mask data, and RootFromSensor3D transform.
  1928. </summary>
  1929. <param name="PixelData">
  1930. Use the pixels in this CogImage16Grey as the height or
  1931. range data for this image. This argument may not be null.
  1932. </param>
  1933. <param name="MaskData">
  1934. Use the pixels in this CogImage8Grey as the mask data
  1935. for this image. Defined pixel values are zero (not
  1936. visible) and 255 (visible). If this argument is null
  1937. then all pixels are presumed to be visible.
  1938. </param>
  1939. <param name="RootFromSensor3D">
  1940. An ICog3DTransform that specifies the mapping from
  1941. "Sensor3D" space to root space. May not be null.
  1942. </param>
  1943. <exception cref="T:System.ArgumentNullException">
  1944. If PixelData is null.
  1945. </exception>
  1946. <exception cref="T:System.ArgumentNullException">
  1947. If RootFromSensor3D is null.
  1948. </exception>
  1949. <exception cref="T:System.ArgumentException">
  1950. If PixelData is not allocated.
  1951. </exception>
  1952. <exception cref="T:System.ArgumentException">
  1953. If MaskData is not null and is not allocated.
  1954. </exception>
  1955. <exception cref="T:System.ArgumentException">
  1956. If MaskData and PixelData do not have the same width.
  1957. </exception>
  1958. <exception cref="T:System.ArgumentException">
  1959. If MaskData and PixelData do not have the same height.
  1960. </exception>
  1961. </member>
  1962. <member name="M:Cognex.VisionPro.CogImage16Range.#ctor(System.Int32,System.Int32,Cognex.VisionPro3D.ICog3DTransform)">
  1963. <summary>
  1964. Construct a new instance of this class using the supplied
  1965. RootFromSensor3D transform and allocating storage for
  1966. the specified image size.
  1967. </summary>
  1968. <param name="Width">
  1969. Width of this image in pixels. Must be greater than zero.
  1970. </param>
  1971. <param name="Height">
  1972. Height of this image in pixels. Must be greate than zero.
  1973. </param>
  1974. <param name="RootFromSensor3D">
  1975. An ICog3DTransform that specifies the mapping from
  1976. "Sensor3D" space to root space. May not be null.
  1977. </param>
  1978. <exception cref="T:System.ArgumentOutOfRangeException">
  1979. If Width is less than 1.
  1980. </exception>
  1981. <exception cref="T:System.ArgumentOutOfRangeException">
  1982. If Height is less than 1.
  1983. </exception>
  1984. <exception cref="T:System.ArgumentNullException">
  1985. If RootFromSensor3D is null.
  1986. </exception>
  1987. </member>
  1988. <member name="M:Cognex.VisionPro.CogImage16Range.#ctor(Cognex.VisionPro3D.ICog3DTransform)">
  1989. <summary>
  1990. Construct a new instance of this class using the supplied
  1991. RootFromSensor3D transform.
  1992. </summary>
  1993. <param name="RootFromSensor3D">
  1994. An ICog3DTransform that specifies the mapping from
  1995. "Sensor3D" space to root space. May not be null.
  1996. </param>
  1997. <exception cref="T:System.ArgumentNullException">
  1998. If the input argument is null.
  1999. </exception>
  2000. </member>
  2001. <member name="M:Cognex.VisionPro.CogImage16Range.#ctor(Cognex.VisionPro.CogImage16Range)">
  2002. <summary>
  2003. Construct a new instance of this class as a shallow copy of the
  2004. given instance.
  2005. </summary>
  2006. <param name="Other">
  2007. The CogImage16Range object to be copied. May not be null.
  2008. </param>
  2009. <exception cref="T:System.ArgumentNullException">
  2010. If the input argument is null.
  2011. </exception>
  2012. </member>
  2013. <member name="M:Cognex.VisionPro.CogImage16Range.#ctor">
  2014. <summary>
  2015. Construct a new instance of this class.
  2016. </summary>
  2017. </member>
  2018. <member name="F:Cognex.VisionPro.CogImage16Range.SfCoordinateSpaceTree3D">
  2019. <summary>
  2020. This bit will be set in the EventArgs of a Changed event
  2021. every time the value returned by CoordinateSpaceTree3D
  2022. may have changed.
  2023. </summary>
  2024. </member>
  2025. <member name="F:Cognex.VisionPro.CogImage16Range.SfPixelFromRootTransform3D">
  2026. <summary>
  2027. This bit will be set in the EventArgs of a Changed event
  2028. every time the value returned by PixelFromRootTransform3D
  2029. may have changed.
  2030. </summary>
  2031. </member>
  2032. <member name="F:Cognex.VisionPro.CogImage16Range.SfSelectedSpaceName3D">
  2033. <summary>
  2034. This bit will be set in the EventArgs of a Changed event
  2035. every time the value returned by SelectedSpaceName3D
  2036. may have changed.
  2037. </summary>
  2038. </member>
  2039. <member name="F:Cognex.VisionPro.CogImage16Range.SfPixelFromRootTransform">
  2040. <summary>
  2041. This bit will be set in the EventArgs of a Changed event
  2042. every time the value returned by PixelFromRootTransform
  2043. may have changed.
  2044. </summary>
  2045. </member>
  2046. <member name="F:Cognex.VisionPro.CogImage16Range.SfCoordinateSpaceTree">
  2047. <summary>
  2048. This bit will be set in the EventArgs of a Changed event
  2049. every time the value returned by CoordinateSpaceTree
  2050. may have changed.
  2051. </summary>
  2052. </member>
  2053. <member name="F:Cognex.VisionPro.CogImage16Range.SfSelectedSpaceName">
  2054. <summary>
  2055. This bit will be set in the EventArgs of a Changed event
  2056. every time the value returned by SelectedSpaceName
  2057. may have changed.
  2058. </summary>
  2059. </member>
  2060. <member name="T:Cognex.VisionPro.CogImage16Range">
  2061. <summary>
  2062. Object that describes a range image. A range image describes three
  2063. dimensional surfaces. A CogImage16Range contains three dimensional
  2064. height data, a "visible pixel mask" to identify which pixels are
  2065. valid, three dimensional transform information, and two dimensional
  2066. transform information.
  2067. </summary>
  2068. </member>
  2069. <member name="M:Cognex.VisionPro.CogImage16RangeRoot.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  2070. <summary>
  2071. Serialization constructor for CogImage16RangeRoot object.
  2072. </summary>
  2073. <param name="Info">
  2074. The standard SerializationInfo argument.
  2075. </param>
  2076. <param name="Ctxt">
  2077. The standard StreamingContext argument.
  2078. </param>
  2079. </member>
  2080. <member name="M:Cognex.VisionPro.CogImage16RangeRoot.OnDeserialization(System.Object)">
  2081. <summary>
  2082. Perform post-deserialization setup for this CogImage16RangeRoot.
  2083. </summary>
  2084. </member>
  2085. <member name="M:Cognex.VisionPro.CogImage16RangeRoot.SetMaskRoot(Cognex.VisionPro.ICogImage8Root)">
  2086. <summary>
  2087. Set the MaskRoot to a new value. In much
  2088. the same way that one can set a pixel value
  2089. in an image without causing a Changed event
  2090. to fire, one may set the MaskRoot to a new value
  2091. and no Changed event is fired.
  2092. </summary>
  2093. <exception cref="System.ArgumentException">
  2094. If the supplied mask root's width or height do not
  2095. match those of the pixel root.
  2096. </exception>
  2097. </member>
  2098. <member name="M:Cognex.VisionPro.CogImage16RangeRoot.GetMaskRoot">
  2099. <summary>
  2100. Get the ICogImage8Root that corresponds to mask data.
  2101. Note that this value may be null if there
  2102. are no missing pixels.
  2103. </summary>
  2104. </member>
  2105. <member name="M:Cognex.VisionPro.CogImage16RangeRoot.GetPixelRoot">
  2106. <summary>
  2107. Get the ICogImage16Root that corresponds to pixel data.
  2108. </summary>
  2109. </member>
  2110. <member name="P:Cognex.VisionPro.CogImage16RangeRoot.Width">
  2111. <summary>
  2112. Width of the image in pixels.
  2113. </summary>
  2114. </member>
  2115. <member name="P:Cognex.VisionPro.CogImage16RangeRoot.Height">
  2116. <summary>
  2117. Height of the image in pixels.
  2118. </summary>
  2119. </member>
  2120. <member name="M:Cognex.VisionPro.CogImage16RangeRoot.Finalize">
  2121. <summary>
  2122. Finalize this CogImage16RangeRoot.
  2123. </summary>
  2124. </member>
  2125. <member name="M:Cognex.VisionPro.CogImage16RangeRoot.Dispose">
  2126. <summary>
  2127. Destruct this CogImage16RangeRoot.
  2128. </summary>
  2129. </member>
  2130. <member name="M:Cognex.VisionPro.CogImage16RangeRoot.#ctor(Cognex.VisionPro.CogImage16RangeRoot)">
  2131. <summary>
  2132. Constructs a new instance of this class as a deep copy of the
  2133. given instance.
  2134. </summary>
  2135. <param name="Other">
  2136. The CogImage16Root object to be copied. May not be null.
  2137. </param>
  2138. <exception cref="System.ArgumentNullException">
  2139. If the input argument is null.
  2140. </exception>
  2141. </member>
  2142. <member name="M:Cognex.VisionPro.CogImage16RangeRoot.#ctor(Cognex.VisionPro.ICogImage16Root,Cognex.VisionPro.ICogImage8Root)">
  2143. <summary>
  2144. Constructs a new instance of this class from the supplied
  2145. parameters.
  2146. </summary>
  2147. <param name="PixelRoot">
  2148. The pixel root.
  2149. </param>
  2150. <param name="MaskRoot">
  2151. The mask root.
  2152. </param>
  2153. <exception cref="System.ArgumentNullException">
  2154. If PixelRoot is null.
  2155. </exception>
  2156. </member>
  2157. <member name="T:Cognex.VisionPro.CogImage16RangeRoot">
  2158. <summary>
  2159. Object that holds the raw pixel and mask data of a range image.
  2160. </summary>
  2161. </member>
  2162. <member name="T:Cognex.VisionPro.CogCenterPointsToLinesNormalDirectionInferenceMethodConstants">
  2163. <summary>
  2164. How the <see cref="T:Cognex.VisionPro.CogCenterPointsToLines" />
  2165. class will infer the normal direction of the line segments.
  2166. </summary>
  2167. </member>
  2168. <member name="F:Cognex.VisionPro.CogCenterPointsToLinesNormalDirectionInferenceMethodConstants.UseLineSegmentNormalDirection">
  2169. <summary>
  2170. Use the direction of the given line segments to determine
  2171. the normal direction for each line segment. The direction of
  2172. a line segment is implied by the ordering of its start and
  2173. end points (end - start). The normal direction is defined to be
  2174. +90 degrees from the line segment direction.
  2175. </summary>
  2176. </member>
  2177. <member name="F:Cognex.VisionPro.CogCenterPointsToLinesNormalDirectionInferenceMethodConstants.InferFromConvexity">
  2178. <summary>
  2179. Automatically infer the line segment normal direction for
  2180. each input line segment. It requires the input line segments
  2181. to form a convex shape. It selects the normal direction for
  2182. each line segment such that the line normal points outwards.
  2183. </summary>
  2184. </member>
  2185. <member name="T:Cognex.VisionPro.CogCenterPointsToLinesModeConstants">
  2186. <summary>
  2187. What fitting style was or will be used with the
  2188. <see cref="T:Cognex.VisionPro.CogCenterPointsToLines" />
  2189. object.
  2190. </summary>
  2191. </member>
  2192. <member name="F:Cognex.VisionPro.CogCenterPointsToLinesModeConstants.Pair">
  2193. <summary>
  2194. For point pair to line pair fitting. The feature correspondences
  2195. are between point pairs and line pairs. The
  2196. <see cref="T:Cognex.VisionPro.CogCenterPointsToLines" />
  2197. class will minimize the variation in the point to line
  2198. signed distance differences, across all point pair line
  2199. pair correspondences. The point to line distance difference for
  2200. a given point pair line pair correspondence is the difference
  2201. between the point to line distance for the first point and the
  2202. point to line distance for the second point in the point pair.
  2203. The class tries to make the two point to line signed distances
  2204. in each point pair line pair correspondence the same. Signed
  2205. distances are measured in the direction of the normal to the
  2206. line.
  2207. </summary>
  2208. </member>
  2209. <member name="F:Cognex.VisionPro.CogCenterPointsToLinesModeConstants.Single">
  2210. <summary>
  2211. For point to line fitting. The feature correspondences
  2212. are between individual points and lines. The
  2213. <see cref="T:Cognex.VisionPro.CogCenterPointsToLines" />
  2214. class will minimize the variance in the point to line
  2215. signed distance across all point to line correspondences.
  2216. The class tries to make all of the point to line distances the
  2217. same.
  2218. </summary>
  2219. </member>
  2220. <!-- Discarding badly formed XML document comment for member 'P:Cognex.VisionPro.CogVisionDataContainer.ContainsRangeGreyImagePairsOnly'. -->
  2221. </members>
  2222. </doc>