| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222 |
- <?xml version="1.0"?>
- <doc>
- <assembly>
- "Cognex.VisionPro.CorePlus"
- </assembly>
- <members>
- <member name="M:Cognex.VisionPro.CogVisionDataContainer.GetRangeGreyImagePairs(Cognex.VisionPro.CogImage16Range[]@,Cognex.VisionPro.CogImage16Grey[]@,System.String[]@)">
- <summary>
- This method steps through the top level elements in the
- container. For every element that is itself a container
- holding exactly one CogImage16Range and exactly one
- CogImage16Grey (and possibly some other objects), copy a
- reference to that range image into the output array of
- CogImage16Range references. And copy a reference to the
- grey image into the output array of CogImage16Grey. And
- copy the associated top level dictionary key string into
- the output array of string references. The output arrays
- may be empty. This method ignores top level elements that
- are not of type CogVisionDataContainer. This method ignores
- top level elements that contain more than one CogImage16Range
- or more than one CogImage16Grey.
- </summary>
- <param name="rangeImages">
- The output array of CogImage16Range references. This output
- array is always allocated by this method, but the resultant
- array may be empty.
- </param>
- <param name="greyImages">
- The output array of CogImage16Grey references. This output
- array is always allocated by this method, but the resultant
- array may be empty.
- </param>
- <param name="identifiers">
- The output array of string references. This output array
- is always allocated by this method, but the resultant
- array may be empty.
- </param>
- </member>
- <member name="M:Cognex.VisionPro.CogVisionDataContainer.GetRangeImages(Cognex.VisionPro.CogImage16Range[]@,System.String[]@)">
- <summary>
- This method steps through the top level elements in this
- container and copies a reference to every CogImage16Range
- that it finds into an output array of CogImage16Range references.
- For every range image so identified, the associated dictionary
- key string is copied into an output array of string references.
- The resultant output arrays may be empty. This method ignores
- top level elements that are not of type CogImage16Range.
- </summary>
- <param name="rangeImages">
- The output array of CogImage16Range references. This output
- array is always allocated by this method, but the resultant
- array may be empty.
- </param>
- <param name="identifiers">
- The output array of string references. This output array
- is always allocated by this method, but the resultant
- array may be empty.
- </param>
- </member>
- <member name="P:Cognex.VisionPro.CogVisionDataContainer.ContainsRangeImagesOnly">
- <summary>
- Returns true if:
- <list type="bullet"><item>
- The collection contains at least one element that is
- a CogImage16Range, and
- </item><item>
- The collection contains no elements that are not
- a CogImage16Range.
- </item></list>
- Otherwise, returns false.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogVisionDataContainer.TryGetValue(System.String,Cognex.VisionPro.ICogVisionData@)">
- <summary>
- If this container holds the specified key,
- output the associated ICogVisionData value.
- Return true if the key was found, otherwise
- return false.
- </summary>
- <param name="key">
- Search for this key.
- </param>
- <param name="value">
- The found ICogVisionData value.
- </param>
- </member>
- <member name="M:Cognex.VisionPro.CogVisionDataContainer.ContainsValue(Cognex.VisionPro.ICogVisionData)">
- <summary>
- Returns true if the specified value is found in this container,
- otherwise returns false.
- </summary>
- <param name="value">
- The ICogVisionData value of interest.
- </param>
- </member>
- <member name="M:Cognex.VisionPro.CogVisionDataContainer.ContainsKey(System.String)">
- <summary>
- Returns true if the specified key is found in this container,
- otherwise returns false.
- </summary>
- <param name="key">
- The key of interest.
- </param>
- </member>
- <member name="P:Cognex.VisionPro.CogVisionDataContainer.Values">
- <summary>
- Gets a collection of all ICogVisionData values in this container.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.CogVisionDataContainer.Keys">
- <summary>
- Gets a collection of all key strings in this container.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogVisionDataContainer.Move(System.Int32,System.Int32)">
- <summary>
- Moves a key value pair from one position to another.
- </summary>
- <param name="fromIndex">The pair's original index.</param>
- <param name="toIndex">The pair's new index.</param>
- <exception cref="System.ArgumentOutOfRangeException">
- If fromIndex is less than zero or fromIndex is greater than
- or equal to Count.
- </exception>
- <exception cref="System.ArgumentOutOfRangeException">
- If toIndex is less than zero or toIndex is greater than
- or equal to Count.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.CogVisionDataContainer.Insert(System.Int32,System.String,Cognex.VisionPro.ICogVisionData)">
- <summary>
- Inserts a key value pair with the supplied
- string key and ICogVisionData value at the
- specified index.
- </summary>
- <param name="index">The zero-based index at which
- to insert the specified key value pair.
- </param>
- <param name="key">The string key to use for this
- new item. May not be null, and may not be an empty
- string.
- </param>
- <param name="value">The ICogVisionData value to use
- for this new item.
- </param>
- <exception cref="System.ArgumentOutOfRangeException">
- If index is less than zero or index is greater than
- Count.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.CogVisionDataContainer.Insert(System.Int32,System.Collections.Generic.KeyValuePair`2{System.String,Cognex.VisionPro.ICogVisionData})">
- <summary>
- Inserts the supplied key value pair at the specified index.
- </summary>
- <param name="index">The zero-based index at which
- to insert the supplied key value pair.
- </param>
- <exception cref="System.ArgumentOutOfRangeException">
- If index is less than zero or index is greater than
- Count.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.CogVisionDataContainer.RemoveAt(System.Int32)">
- <summary>
- Removes the key value pair at the specified index.
- </summary>
- <param name="index">The zero-based index of the
- key value pair to remove.
- </param>
- <exception cref="System.ArgumentOutOfRangeException">
- If index is less than zero or index is greater than or equal
- to Count.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.CogVisionDataContainer.Remove(Cognex.VisionPro.ICogVisionData)">
- <summary>
- Removes from this container the key value pair with the
- specified value. Does nothing if this value is not found.
- </summary>
- <param name="value">Remove the key value pair with this value,
- if found.
- </param>
- <returns>True if the specified key value pair was
- removed, False otherwise.
- </returns>
- </member>
- <member name="M:Cognex.VisionPro.CogVisionDataContainer.Remove(System.String)">
- <summary>
- Removes from this container the key value pair with the
- specified key. Does nothing if this key is not found.
- </summary>
- <param name="key">Remove the key value pair with this key,
- if found.
- </param>
- <returns>True if the specified key value pair was
- removed, False otherwise.
- </returns>
- </member>
- <member name="M:Cognex.VisionPro.CogVisionDataContainer.Remove(System.Collections.Generic.KeyValuePair`2{System.String,Cognex.VisionPro.ICogVisionData})">
- <summary>
- Removes the supplied key value pair from this container.
- Does nothing if the supplied key value pair is not found.
- </summary>
- <param name="pair">Remove this key value pair if found.
- </param>
- <returns>True if the specified key value pair was
- removed, False otherwise.
- </returns>
- </member>
- <member name="M:Cognex.VisionPro.CogVisionDataContainer.CopyTo(System.Collections.Generic.KeyValuePair`2{System.String,Cognex.VisionPro.ICogVisionData}[],System.Int32)">
- <summary>
- Copies the entire collection to a one-dimensional array
- of key value pairs, starting at the specified
- index of the target array.
- </summary>
- <param name="arr">The one-dimensional array that is the
- destination of the elements copied from this container.
- The array must have zero-based indexing.
- </param>
- <param name="index">The zero-based index in the target
- array at which copying begins.
- </param>
- <exception cref="System.ArgumentNullException">arr is null.
- </exception>
- <exception cref="System.ArgumentOutOfRangeException">index
- is less than 0.
- </exception>
- <exception cref="System.ArgumentException">The number of
- elements in this container is greater than the available
- space from index to the end of the destination array.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.CogVisionDataContainer.Contains(Cognex.VisionPro.ICogVisionData)">
- <summary>
- Returns true if the supplied value is found,
- otherwise returns false.
- </summary>
- <param name="value">
- Search for this value.
- </param>
- </member>
- <member name="M:Cognex.VisionPro.CogVisionDataContainer.Contains(System.String)">
- <summary>
- Returns true if the supplied key is found,
- otherwise returns false.
- </summary>
- <param name="key">
- Search for this key.
- </param>
- </member>
- <member name="M:Cognex.VisionPro.CogVisionDataContainer.Contains(System.Collections.Generic.KeyValuePair`2{System.String,Cognex.VisionPro.ICogVisionData})">
- <summary>
- Returns true if the supplied key value pair is found,
- otherwise returns false.
- </summary>
- <param name="pair">
- Search for this key value pair.
- </param>
- </member>
- <member name="M:Cognex.VisionPro.CogVisionDataContainer.GetKey(System.Int32)">
- <summary>
- Returns the key string associated with the
- specified index.
- </summary>
- <param name="index">The zero-based index of the
- key to get.</param>
- <exception cref="System.ArgumentOutOfRangeException">
- If index is less than zero, or not less than Count.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.CogVisionDataContainer.IndexOf(Cognex.VisionPro.ICogVisionData)">
- <summary>
- Searches the container for the key value pair with the
- specified value and returns its zero-based index.
- </summary>
- <param name="value">The value to locate.</param>
- <returns>The zero based index of the key value pair
- with the specified ICogVisionData value, if found;
- otherwise, -1 is returned.
- </returns>
- </member>
- <member name="M:Cognex.VisionPro.CogVisionDataContainer.IndexOf(System.String)">
- <summary>
- Searches the container for the key value pair with the
- specified key and returns its zero-based index.
- </summary>
- <param name="key">The key to locate.</param>
- <returns>The zero based index of the key value pair
- with the specified key, if found; otherwise, -1 is
- returned.
- </returns>
- </member>
- <member name="M:Cognex.VisionPro.CogVisionDataContainer.IndexOf(System.Collections.Generic.KeyValuePair`2{System.String,Cognex.VisionPro.ICogVisionData})">
- <summary>
- Searches the container for the specified key value pair and
- returns the zero-based index of the first occurrence.
- </summary>
- <param name="pair">The key value pair to locate.</param>
- <returns>The zero based index of the first occurrence of
- pair within the container, if found; otherwise, -1
- </returns>
- </member>
- <member name="M:Cognex.VisionPro.CogVisionDataContainer.Clear">
- <summary>
- Removes all key value pairs from the container.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogVisionDataContainer.Add(System.String,Cognex.VisionPro.ICogVisionData)">
- <summary>
- Adds to the end of the container a key value pair
- using the supplied key string and ICogVisionData value.
- </summary>
- <param name="key">The key string to be used.</param>
- <param name="value">The ICogVisionData value reference
- to be used.</param>
- <exception cref="System.ArgumentNullException">
- If the supplied key is null.
- </exception>
- <exception cref="System.ArgumentException">
- If the supplied key is an empty string.
- </exception>
- <exception cref="System.ArgumentException">
- If the supplied key already exists within the container.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.CogVisionDataContainer.Add(System.Collections.Generic.KeyValuePair`2{System.String,Cognex.VisionPro.ICogVisionData})">
- <summary>
- Adds the supplied key value pair to the end of the container.
- </summary>
- <param name="pair">The key value pair to add.</param>
- <exception cref="System.ArgumentNullException">
- If the supplied key is null.
- </exception>
- <exception cref="System.ArgumentException">
- If the supplied key is an empty string.
- </exception>
- <exception cref="System.ArgumentException">
- If the supplied key already exists within the container.
- </exception>
- </member>
- <member name="P:Cognex.VisionPro.CogVisionDataContainer.IsReadOnly">
- <summary>
- Returns true if this collection is ReadOnly
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.CogVisionDataContainer.Count">
- <summary>
- Gets the number of elements in this container.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogVisionDataContainer.GetEnumerator">
- <summary>
- Get an enumerator for this conllection of
- key value pairs.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.CogVisionDataContainer.PairIndexer(System.Int32)">
- <summary>
- Gets or sets the key value pair at the specified index.
- The key is a string and the value is an
- ICogVisionData reference.
- </summary>
- <param name="index">The zero-based index of the
- key value pair to get.</param>
- <returns>
- The key value pair at the specified index.
- </returns>
- <exception cref="System.ArgumentOutOfRangeException">
- If index is less than zero, or not less than Count.
- </exception>
- </member>
- <member name="P:Cognex.VisionPro.CogVisionDataContainer.default(System.String)">
- <summary>
- Gets or sets the ICogVisionData reference associated with
- the specified key string. When setting a the
- ICogVisionData reference for a key that does not yet
- exist within the container, a new container entry
- is created.
- </summary>
- <param name="key">The key associated with the
- ICogVisionData reference.</param>
- <returns>
- The ICogVisionData reference associated with the
- specified key.
- </returns>
- <exception cref="System.ArgumentNullException">
- If key is null.
- </exception>
- <exception cref="System.ArgumentException">
- If key is an empty string.
- </exception>
- <exception cref="System.Collections.Generic.KeyNotFoundException">
- If the key is not found when reading.
- </exception>
- </member>
- <member name="P:Cognex.VisionPro.CogVisionDataContainer.Item(System.Int32)">
- <summary>
- Gets or sets the ICogVisionData reference at the specified index.
- </summary>
- <param name="index">The zero-based index of the
- ICogVisionData reference to get.</param>
- <returns>
- The ICogVisionData reference at the specified index.
- </returns>
- <exception cref="System.ArgumentOutOfRangeException">
- If index is less than zero, or not less than Count.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.CogVisionDataContainer.OnDeserialization(System.Object)">
- <summary>
- Perform post-deserialization tasks.
- </summary>
- <param name="sender">
- The CogVisionDataContainer.
- </param>
- </member>
- <member name="M:Cognex.VisionPro.CogVisionDataContainer.#ctor(Cognex.VisionPro.CogVisionDataContainer)">
- <summary>
- Copy construct a CogVisionDataContainer from the
- supplied container. This is a shallow copy: the values are
- copied not cloned.
- </summary>
- <param name="Other">
- The CogVisionDataContainer to be copied.
- </param>
- </member>
- <member name="M:Cognex.VisionPro.CogVisionDataContainer.#ctor">
- <summary>
- Default construct a CogVisionDataContainer.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogVisionDataContainer.OnMovedItem(System.Int32,System.Int32)">
- <summary>
- Raises the MovedItem event and the Changed event.
- </summary>
- <param name="fromIndex">Source index of item moved.</param>
- <param name="toIndex">New index of item moved.</param>
- </member>
- <member name="M:Cognex.VisionPro.CogVisionDataContainer.OnMovingItem(System.Int32,System.Int32)">
- <summary>
- Raises the MovingItem event.
- </summary>
- <param name="fromIndex">Index of item being moved.</param>
- <param name="toIndex">Destination index of item being moved.</param>
- </member>
- <member name="M:Cognex.VisionPro.CogVisionDataContainer.OnReplacedItem(System.Int32,System.Object,System.Object)">
- <summary>
- Raises the ReplacedItem event and the Changed event.
- </summary>
- <param name="index">Index of item replaced.</param>
- <param name="oldValue">Value of item replaced.</param>
- <param name="newValue">Value of item that replaced oldValue.</param>
- </member>
- <member name="M:Cognex.VisionPro.CogVisionDataContainer.OnReplacingItem(System.Int32,System.Object,System.Object)">
- <summary>
- Raises the ReplacingItem event.
- </summary>
- <param name="index">Index of item being replaced.</param>
- <param name="oldValue">Value of item being replaced.</param>
- <param name="newValue">Value of item replacing oldValue.</param>
- </member>
- <member name="M:Cognex.VisionPro.CogVisionDataContainer.OnRemovedItem(System.Int32,System.Object)">
- <summary>
- Raises the RemovedItem event and the Changed event.
- </summary>
- <param name="index">Index of item removed.</param>
- <param name="value">Value of item removed.</param>
- </member>
- <member name="M:Cognex.VisionPro.CogVisionDataContainer.OnRemovingItem(System.Int32,System.Object)">
- <summary>
- Raises the RemovingItem event.
- </summary>
- <param name="index">Index of item being removed.</param>
- <param name="value">Value of item being removed.</param>
- </member>
- <member name="M:Cognex.VisionPro.CogVisionDataContainer.OnInsertedItem(System.Int32,System.Object)">
- <summary>
- Raises the InsertedItem event and the Changed event.
- </summary>
- <param name="index">Index at which item was inserted.</param>
- <param name="value">Value of item inserted.</param>
- </member>
- <member name="M:Cognex.VisionPro.CogVisionDataContainer.OnInsertingItem(System.Int32,System.Object)">
- <summary>
- Raises the InsertingItem event.
- </summary>
- <param name="index">Index to insert item being inserted.</param>
- <param name="value">Value of item being inserted.</param>
- </member>
- <member name="M:Cognex.VisionPro.CogVisionDataContainer.OnCleared">
- <summary>
- Raises the Cleared event and the Changed event.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogVisionDataContainer.OnClearing">
- <summary>
- Raises the Clearing event.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogVisionDataContainer.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Serialization construct a CogVisionDataContainer.
- </summary>
- <param name="Info">
- The standard SerializationInfo parameter.
- </param>
- <param name="Ctxt">
- The standard StreamingContext parameter.
- </param>
- </member>
- <member name="E:Cognex.VisionPro.CogVisionDataContainer.MovedItem">
- <summary>
- Raised after an item is moved to a new index.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.CogVisionDataContainer.MovingItem">
- <summary>
- Raised before an item is moved to a new index.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.CogVisionDataContainer.ReplacedItem">
- <summary>
- Raised after an item is replaced.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.CogVisionDataContainer.ReplacingItem">
- <summary>
- Raised before an item is replaced.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.CogVisionDataContainer.RemovedItem">
- <summary>
- Raised after an item is removed.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.CogVisionDataContainer.RemovingItem">
- <summary>
- Raised before an item is removed.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.CogVisionDataContainer.InsertedItem">
- <summary>
- Raised after an item is inserted.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.CogVisionDataContainer.InsertingItem">
- <summary>
- Raised before an item is inserted.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.CogVisionDataContainer.Cleared">
- <summary>
- Raised after the container is cleared.
- </summary>
- </member>
- <member name="E:Cognex.VisionPro.CogVisionDataContainer.Clearing">
- <summary>
- Raised before the container is cleared.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.CogVisionDataContainer.SfNextSf">
- <summary>
- Next state flag to be used in derived classes.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.CogVisionDataContainer.SfCount">
- <summary>
- State flag for the Count property.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.CogVisionDataContainer.SfItem">
- <summary>
- State flag for the Item (indexer) property.
- </summary>
- </member>
- <member name="T:Cognex.VisionPro.CogVisionDataContainer">
- <summary>
- This class is a general purpose container of vision data. Each
- element in this container has both a string key and a value of type
- ICogVisionData. This container maintains an ordered list of these key
- value pairs. A particular ICogVisionData value may be referenced by
- integer index as in a list, or by string key as in a dictionary. The
- keys must all be unique, non-null, non-empty strings. In addition,
- this class implements the ICogVisionData interface.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogCenterPointsToLines.Execute">
- <summary>
- Perform point to line centering.
- </summary>
- <returns>
- A CogCenterPointsToLinesResult object describing the mapping
- of points to lines.
- </returns>
- <exception cref="T:Cognex.VisionPro.Exceptions.CogTransformSingularException">
- If the solution is singular.
- </exception>
- <exception cref="T:Cognex.VisionPro.Exceptions.CogTimeoutExpiredException">
- If TimeoutEnabled is true and this method does not complete
- within Timeout milliseconds.
- </exception>
- <exception cref="T:System.ArgumentException">
- If any of the following is true:
- <list type="bullet"><item><see cref="P:Cognex.VisionPro.CogCenterPointsToLines.Mode" /> is set to
- <see cref="T:Cognex.VisionPro.CogCenterPointsToLinesModeConstants">
- Single</see> and
- <see cref="P:Cognex.VisionPro.CogCenterPointsToLines.Count" /> is
- less than 4.
- </item><item><see cref="P:Cognex.VisionPro.CogCenterPointsToLines.Mode" /> is set to
- <see cref="T:Cognex.VisionPro.CogCenterPointsToLinesModeConstants">
- Pair</see> and
- <see cref="P:Cognex.VisionPro.CogCenterPointsToLines.Count" /> is
- less than 3.
- </item></list></exception>
- <exception cref="T:System.ArgumentException">
- If any of the parameters is invalid.
- </exception>
- </member>
- <member name="P:Cognex.VisionPro.CogCenterPointsToLines.NormalDirectionInferenceMethod">
- <summary>
- How this class will infer the normal direction of the
- line segments.
- </summary>
- <value>
- The default value is InferFromConvexity.
- </value>
- <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
- Fires when the value of this property changes.
- </event>
- <exception cref="T:System.ArgumentException">
- The supplied value is not a member of the
- <see cref="T:Cognex.VisionPro.CogCenterPointsToLinesNormalDirectionInferenceMethodConstants" />
- enumeration.
- </exception>
- </member>
- <member name="P:Cognex.VisionPro.CogCenterPointsToLines.Timeout">
- <summary>
- The maximum number of milliseconds that may elapse while running
- the Execute method. This is only enforced if TimeoutEnabled is
- true.
- </summary>
- <value>
- The default value is 120000.
- </value>
- <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
- Fires when the value of this property changes.
- </event>
- <exception cref="T:System.ArgumentOutOfRangeException">
- The supplied value is less than zero.
- </exception>
- </member>
- <member name="P:Cognex.VisionPro.CogCenterPointsToLines.TimeoutEnabled">
- <summary>
- Whether the Execute method should be stopped after Timeout
- milliseconds.
- </summary>
- <value>
- The default value is False.
- </value>
- <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
- Fires when the value of this property changes.
- </event>
- </member>
- <member name="P:Cognex.VisionPro.CogCenterPointsToLines.SearchAngleMax">
- <summary>
- The upper bound of the search angle range, in radians. This
- parameter limits the rotation angle of the result transform.
- </summary>
- <remarks>
- Note that setting this property to a value less than
- SearchAngleMin will cause SearchAngleMin to be set to
- the new SearchAngleMax value.
- </remarks>
- <value>
- The default value is equal to 5 degrees.
- </value>
- <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
- Fires when the value of this property changes.
- </event>
- </member>
- <member name="P:Cognex.VisionPro.CogCenterPointsToLines.SearchAngleMin">
- <summary>
- The lower bound of the search angle range, in radians. This
- parameter limits the rotation angle of the result transform.
- </summary>
- <remarks>
- Note that setting this property to a value greater than
- SearchAngleMax will cause SearchAngleMax to be set to
- the new SearchAngleMin value.
- </remarks>
- <value>
- The default value is equal to -5 degrees.
- </value>
- <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
- Fires when the value of this property changes.
- </event>
- </member>
- <member name="P:Cognex.VisionPro.CogCenterPointsToLines.Mode">
- <summary>
- How this class will perform fitting. May be either point to line
- fit ("Single"), or point pair to line pair fit ("Pair").
- </summary>
- <value>
- The default value is Single.
- </value>
- <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
- Fires when the value of this property changes.
- </event>
- <exception cref="T:System.ArgumentException">
- The supplied value is not a member of the
- <see cref="T:Cognex.VisionPro.CogCenterPointsToLinesModeConstants" />
- enumeration.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.CogCenterPointsToLines.#ctor(Cognex.VisionPro.CogCenterPointsToLines)">
- <summary>
- Copy constructs a CogCenterPointsToLines object. This
- is a deep copy.
- </summary>
- <param name="Other">
- The CogCenterPointsToLines object to be copied.
- </param>
- <exception cref="T:System.ArgumentNullException">
- If Other is null.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.CogCenterPointsToLines.#ctor">
- <summary>
- Default construct a CogCenterPointsToLines.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogCenterPointsToLines.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Serialization construct a CogCenterPointsToLines object.
- </summary>
- <param name="Info">
- The standard SerializationInfo argument.
- </param>
- <param name="Ctxt">
- The standard StreamingContext argument.
- </param>
- </member>
- <member name="F:Cognex.VisionPro.CogCenterPointsToLines.SfTimeout">
- <summary>
- This bit will be set in the EventArgs of a Changed event
- every time the value returned by Timeout
- may have been changed.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.CogCenterPointsToLines.SfTimeoutEnabled">
- <summary>
- This bit will be set in the EventArgs of a Changed event
- every time the value returned by TimeoutEnabled
- may have been changed.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.CogCenterPointsToLines.SfSearchAngleMax">
- <summary>
- This bit will be set in the EventArgs of a Changed event
- every time the value returned by SearchAngleMax
- may have been changed.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.CogCenterPointsToLines.SfSearchAngleMin">
- <summary>
- This bit will be set in the EventArgs of a Changed event
- every time the value returned by SearchAngleMin
- may have been changed.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.CogCenterPointsToLines.SfNormalDirectionInferenceMethod">
- <summary>
- This bit will be set in the EventArgs of a Changed event
- every time the value returned by NormalDirectionInferenceMethod
- may have been changed.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.CogCenterPointsToLines.SfMode">
- <summary>
- This bit will be set in the EventArgs of a Changed event
- every time the value returned by Mode
- may have been changed.
- </summary>
- </member>
- <member name="T:Cognex.VisionPro.CogCenterPointsToLines">
- <summary>
- This class finds a 2D linear transform between points and
- lines, centering the lines with respect to the points.
- </summary>
- <remarks>
- <para>
- This class supports two modes of fitting:
- <list type="bullet"><item>
- Point to line fit ("Single").
- The feature correspondences are between individual points and lines.
- The class will minimize the variance in the point to line
- signed distance across all point to line correspondences.
- The class tries to make all of the point to line distances the
- same.
- </item><item>
- Point pair to line pair fit ("Pair").
- The feature correspondences are between point pairs and line
- pairs. The class will minimize the variation in the point to line
- signed distance differences, across all point pair line
- pair correspondences. The point to line distance difference for
- a given point pair line pair correspondence is the difference
- between the point to line distance for the first point and the
- point to line distance for the second point in the point pair.
- The class tries to make the two point to line signed distances
- in each point pair line pair correspondence the same. Signed
- distances are measured in the direction of the normal to the
- line.
- </item></list></para>
- <para>
- This class uses line segments to specify lines, but the centering
- is performed between points and lines (or point-pairs and
- line-pairs). In other words, the point to line distances are not
- affected by the end points of the line segments.
- </para>
- </remarks>
- </member>
- <member name="P:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.LineSegmentBEndY">
- <summary>
- The Y coordinate of the "B" line segment's end point.
- </summary>
- <value>
- The default value is zero.
- </value>
- <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
- Fires when the value of this property changes.
- </event>
- </member>
- <member name="P:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.LineSegmentBEndX">
- <summary>
- The X coordinate of the "B" line segment's end point.
- </summary>
- <value>
- The default value is zero.
- </value>
- <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
- Fires when the value of this property changes.
- </event>
- </member>
- <member name="P:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.LineSegmentBStartY">
- <summary>
- The Y coordinate of the "B" line segment's start point.
- </summary>
- <value>
- The default value is zero.
- </value>
- <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
- Fires when the value of this property changes.
- </event>
- </member>
- <member name="P:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.LineSegmentBStartX">
- <summary>
- The X coordinate of the "B" line segment's start point.
- </summary>
- <value>
- The default value is zero.
- </value>
- <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
- Fires when the value of this property changes.
- </event>
- </member>
- <member name="P:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.LineSegmentAEndY">
- <summary>
- The Y coordinate of the "A" line segment's end point.
- </summary>
- <value>
- The default value is zero.
- </value>
- <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
- Fires when the value of this property changes.
- </event>
- </member>
- <member name="P:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.LineSegmentAEndX">
- <summary>
- The X coordinate of the "A" line segment's end point.
- </summary>
- <value>
- The default value is zero.
- </value>
- <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
- Fires when the value of this property changes.
- </event>
- </member>
- <member name="P:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.LineSegmentAStartY">
- <summary>
- The Y coorinate of the "A" line segment's start point.
- </summary>
- <value>
- The default value is zero.
- </value>
- <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
- Fires when the value of this property changes.
- </event>
- </member>
- <member name="P:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.LineSegmentAStartX">
- <summary>
- The X coorinate of the "A" line segment's start point.
- </summary>
- <value>
- The default value is zero.
- </value>
- <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
- Fires when the value of this property changes.
- </event>
- </member>
- <member name="P:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.PointBY">
- <summary>
- The Y coordinate of the "B" point.
- </summary>
- <value>
- The default value is zero.
- </value>
- <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
- Fires when the value of this property changes.
- </event>
- </member>
- <member name="P:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.PointBX">
- <summary>
- The X coordinate of the "B" point.
- </summary>
- <value>
- The default value is zero.
- </value>
- <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
- Fires when the value of this property changes.
- </event>
- </member>
- <member name="P:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.PointAY">
- <summary>
- The Y coordinate of the "A" point.
- </summary>
- <value>
- The default value is zero.
- </value>
- <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
- Fires when the value of this property changes.
- </event>
- </member>
- <member name="P:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.PointAX">
- <summary>
- The X coordinate of the "A" point.
- </summary>
- <value>
- The default value is zero.
- </value>
- <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
- Fires when the value of this property changes.
- </event>
- </member>
- <member name="M:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.Finalize">
- <summary>
- Finalize this CogCenterPointsToLinesCorrespondence.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.Dispose">
- <summary>
- Destruct this CogCenterPointsToLinesCorrespondence.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.#ctor(Cognex.VisionPro.CogCenterPointsToLinesCorrespondence)">
- <summary>
- Copy constructs a CogCenterPointsToLinesCorrespondence
- object. This is a deep copy.
- </summary>
- <param name="Other">
- The CogCenterPointsToLinesCorrespondence object to be
- copied.
- </param>
- <exception cref="T:System.ArgumentNullException">
- If Other is null.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.#ctor">
- <summary>
- Default construct a CogCenterPointsToLinesCorrespondence.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Serialization construct a CogCenterPointsToLinesCorrespondence object.
- </summary>
- <param name="Info">
- The standard SerializationInfo argument.
- </param>
- <param name="Ctxt">
- The standard StreamingContext argument.
- </param>
- </member>
- <member name="F:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.SfLineSegmentBEndY">
- <summary>
- This bit will be set in the EventArgs of a Changed event
- every time the value returned by LineSegmentBEndY
- may have been changed.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.SfLineSegmentBEndX">
- <summary>
- This bit will be set in the EventArgs of a Changed event
- every time the value returned by LineSegmentBEndX
- may have been changed.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.SfLineSegmentBStartY">
- <summary>
- This bit will be set in the EventArgs of a Changed event
- every time the value returned by LineSegmentBStartY
- may have been changed.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.SfLineSegmentBStartX">
- <summary>
- This bit will be set in the EventArgs of a Changed event
- every time the value returned by LineSegmentBStartX
- may have been changed.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.SfLineSegmentAEndY">
- <summary>
- This bit will be set in the EventArgs of a Changed event
- every time the value returned by LineSegmentAEndY
- may have been changed.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.SfLineSegmentAEndX">
- <summary>
- This bit will be set in the EventArgs of a Changed event
- every time the value returned by LineSegmentAEndX
- may have been changed.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.SfLineSegmentAStartY">
- <summary>
- This bit will be set in the EventArgs of a Changed event
- every time the value returned by LineSegmentAStartY
- may have been changed.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.SfLineSegmentAStartX">
- <summary>
- This bit will be set in the EventArgs of a Changed event
- every time the value returned by LineSegmentAStartX
- may have been changed.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.SfPointBY">
- <summary>
- This bit will be set in the EventArgs of a Changed event
- every time the value returned by PointBY
- may have been changed.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.SfPointBX">
- <summary>
- This bit will be set in the EventArgs of a Changed event
- every time the value returned by PointBX
- may have been changed.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.SfPointAY">
- <summary>
- This bit will be set in the EventArgs of a Changed event
- every time the value returned by PointAY
- may have been changed.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence.SfPointAX">
- <summary>
- This bit will be set in the EventArgs of a Changed event
- every time the value returned by PointAX
- may have been changed.
- </summary>
- </member>
- <member name="T:Cognex.VisionPro.CogCenterPointsToLinesCorrespondence">
- <summary>
- This class holds a corresponded point and line segment,
- or a corresponded point pair and line segment pair.
- </summary>
- <remarks>
- This class has properties whose name includes either "A" or
- "B". When used in the context of
- <see cref="T:Cognex.VisionPro.CogCenterPointsToLinesModeConstants">
- Single</see> mode, only the "A" properties are meaningful.
- When used in the context of
- <see cref="T:Cognex.VisionPro.CogCenterPointsToLinesModeConstants">
- Pair</see> mode, both the "A" and "B" properties are meaningful.
- </remarks>
- </member>
- <member name="P:Cognex.VisionPro.CogCenterPointsToLinesResult.SignedDistanceAbsoluteDifferenceStatistics">
- <summary>
- The statistics of the absolute difference between the signed distances
- of each point and line in a point pair, across all point-pair
- line-pair correspondences. This property is null if Mode is
- Single.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.CogCenterPointsToLinesResult.SignedDistanceStatistics">
- <summary>
- The statistics of the signed distances between each point and its
- corresponding line.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.CogCenterPointsToLinesResult.SignedDistancesB">
- <summary>
- The signed distances from each ("B") point to its corresponding ("B")
- line, measured along the normal to the line.
- If Mode is Single then this property is null.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.CogCenterPointsToLinesResult.SignedDistancesA">
- <summary>
- The signed distances from each ("A") point to its corresponding ("A")
- line, measured along the normal to the line.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.CogCenterPointsToLinesResult.LinesFromPointsTransform">
- <summary>
- The best fit linear transform that maps from points to lines.
- If Mode was Single, this transform minimizes the variation in the
- signed distance between the ("A") points and the the ("A") lines.
- If Mode was Pair, then this transform minimizes the
- variation in the point to line signed distance differences
- across all point-pair line-pair correspondences.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.CogCenterPointsToLinesResult.Mode">
- <summary>
- How the centering process was performed. May be either "Single" or
- "Pair". If Mode was "Single", then both the SignedDistancesB property
- and the SignedDistanceAbsoluteDifferenceStatistics property will be
- null.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogCenterPointsToLinesResult.Finalize">
- <summary>
- Finalize this CogCenterPointsToLinesResult.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogCenterPointsToLinesResult.Dispose">
- <summary>
- Destruct this CogCenterPointsToLinesResult.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogCenterPointsToLinesResult.#ctor(Cognex.VisionPro.CogCenterPointsToLinesResult)">
- <summary>
- Copy constructs a CogCenterPointsToLinesResult object. This is a
- deep copy.
- </summary>
- <param name="Other">
- The result object to be copied. May not be null.
- </param>
- <exception cref="T:System.ArgumentNullException">
- If the input argument is null.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.CogCenterPointsToLinesResult.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Serialization construct a CogCenterPointsToLinesResult object.
- </summary>
- <param name="Info">
- The standard SerializationInfo argument.
- </param>
- <param name="Ctxt">
- The standard StreamingContext argument.
- </param>
- </member>
- <member name="T:Cognex.VisionPro.CogCenterPointsToLinesResult">
- <summary>
- The CogCenterPointsToLinesResult class describes the successful
- result of a call to the CogCenterPointsToLines Execute(...)
- method. This result class represents an immutable object - its content
- is set at construction and cannot be changed.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogImageCollectionMCamerasNPoses.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Serialization construct a CogImageCollectionMCamerasNPoses object.
- </summary>
- <param name="Info">
- The standard SerializationInfo argument.
- </param>
- <param name="Ctxt">
- The standard StreamingContext argument.
- </param>
- </member>
- <member name="M:Cognex.VisionPro.CogImageCollectionMCamerasNPoses.#ctor(Cognex.VisionPro.CogImageCollectionMCamerasNPoses)">
- <summary>
- Copy constructs a CogImageCollectionMCamerasNPoses object. This is a shallow
- copy for the images.
- </summary>
- <param name="other">
- The CogImageCollectionMCamerasNPoses object to be copied.
- </param>
- <exception cref="T:System.ArgumentNullException">
- If <paramref name="other" /> is null.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.CogImageCollectionMCamerasNPoses.#ctor">
- <summary>
- Constructs a default (empty) CogImageCollectionMCamerasNPoses.
- </summary>
- </member>
- <member name="T:Cognex.VisionPro.CogImageCollectionMCamerasNPoses">
- <summary>
- This class holds image collections of multiple cameras at multiple poses.
- <para>
- CogImageCollectionMCamerasNPoses[poseIndex][cameraIndex] is the <see cref="T:Cognex.VisionPro.ICogImage" />
- for camera "cameraIndex" at pose "poseIndex".
- </para></summary>
- </member>
- <member name="M:Cognex.VisionPro.CogImageCollection.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Serialization construct a CogImageCollection object.
- </summary>
- <param name="Info">
- The standard SerializationInfo argument.
- </param>
- <param name="Ctxt">
- The standard StreamingContext argument.
- </param>
- </member>
- <member name="M:Cognex.VisionPro.CogImageCollection.#ctor(Cognex.VisionPro.CogImageCollection)">
- <summary>
- Copy constructs a CogImageCollection object. This is a shallow
- copy for the images.
- </summary>
- <param name="Other">
- The CogImageCollection object to be copied.
- </param>
- <exception cref="T:System.ArgumentNullException">
- If <paramref name="Other" /> is null.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.CogImageCollection.#ctor">
- <summary>
- Constructs a default (empty) CogImageCollection.
- </summary>
- </member>
- <member name="T:Cognex.VisionPro.CogImageCollection">
- <summary>
- This class holds a collection of <see cref="T:Cognex.VisionPro.ICogImage" />.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.ResetCoordinateSpaceTree3D">
- <summary>
- For Cognex internal use only.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.Add3DSpace(System.String,System.String,System.IntPtr,System.Int32)">
- <summary>
- For Cognex internal use only.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.CreateScaledImage(System.Int32,System.Int32,System.IntPtr@)">
- <summary>
- For Cognex internal use only.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.Make3DTreeImageAlignedOnly(System.Double,System.String)">
- <summary>
- For Cognex internal use only.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.CopyMergeTree3D(System.IntPtr,System.Int32,System.String,System.IntPtr)">
- <summary>
- For Cognex internal use only.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.Rename3DSpace(System.String,System.String)">
- <summary>
- For Cognex internal use only.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.SetTree3DBinary(System.IntPtr)">
- <summary>
- For Cognex internal use only.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.GetTree3DBinary(System.IntPtr@)">
- <summary>
- For Cognex internal use only.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.CopyTrees(System.IntPtr)">
- <summary>
- For Cognex internal use only.
- </summary>
- </member>
- <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@)">
- <summary>
- For Cognex internal use only.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.Clone(System.IntPtr@)">
- <summary>
- For Cognex internal use only.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.InitForDisplay(System.IntPtr,System.IntPtr,System.IntPtr)">
- <summary>
- For Cognex internal use only.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.GetPel(System.Int32,System.Int32,System.Boolean@,System.Int32@)">
- <summary>
- For Cognex internal use only.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.SetSelectedSpaceName3D(System.String)">
- <summary>
- For Cognex internal use only.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.GetSelectedSpaceName3D">
- <summary>
- For Cognex internal use only.
- </summary>
- </member>
- <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)">
- <summary>
- For Cognex internal use only.
- </summary>
- </member>
- <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@)">
- <summary>
- For Cognex internal use only.
- </summary>
- </member>
- <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)">
- <summary>
- For Cognex internal use only.
- </summary>
- </member>
- <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@)">
- <summary>
- For Cognex internal use only.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.SetRoots(System.IntPtr,System.IntPtr)">
- <summary>
- For Cognex internal use only.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.GetRoots(System.IntPtr@,System.IntPtr@)">
- <summary>
- For Cognex internal use only.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.CogImage16Range.InteropPixelFromRootTransform">
- <summary>
- For Cognex internal use only.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.CogImage16Range.InteropCoordinateSpaceTree">
- <summary>
- For Cognex internal use only.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.CogImage16Range.InteropSelectedSpaceName">
- <summary>
- For Cognex internal use only.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.CogImage16Range.InteropWidth">
- <summary>
- For Cognex internal use only.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.CogImage16Range.InteropHeight">
- <summary>
- For Cognex internal use only.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.CogImage16Range.InteropAllocated">
- <summary>
- For Cognex internal use only.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.InteropGetTransform(System.String,System.String)">
- <summary>
- For Cognex internal use only.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.InteropCopyBase(Cognex.VisionPro.Interop.CogImageCopyModeConstants)">
- <summary>
- For Cognex internal use only.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.InteropAllocate(System.Int32,System.Int32)">
- <summary>
- For Cognex internal use only.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Serialization constructor for CogImage16Range object.
- </summary>
- <param name="Info">
- The standard SerializationInfo argument.
- </param>
- <param name="Ctxt">
- The standard StreamingContext argument.
- </param>
- </member>
- <member name="P:Cognex.VisionPro.CogImage16Range.CoordinateSpaceTree3D">
- <summary>
- Get or set the tree of all named three dimensional
- coordinate spaces for this image. The tree provides advanced
- functions for managing three dimensional coordinate spaces.
- </summary>
- <exception cref="T:System.ArgumentNullException">
- If NewVal is null.
- </exception>
- <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
- Fires when this property changes.
- </event>
- </member>
- <member name="P:Cognex.VisionPro.CogImage16Range.SelectedSpaceName3D">
- <summary>
- Gets or sets the name of the three dimensional
- coordinate space to be used by tools which process this image.
- </summary>
- <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
- Fires when this property changes.
- </event>
- </member>
- <member name="P:Cognex.VisionPro.CogImage16Range.PixelFromRootTransform3D">
- <summary>
- Get or set the transform that maps from
- three dimensional root space to pixel space.
- </summary>
- <exception cref="T:System.ArgumentNullException">
- If NewVal is null.
- </exception>
- <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
- Fires when this property changes.
- </event>
- </member>
- <member name="P:Cognex.VisionPro.CogImage16Range.PixelFromRootTransform">
- <summary>
- Gets a copy of the transform that maps from
- pixel space ("#") to two dimensional root space
- ("@"). Due to the unique nature of the CogImage16Range,
- setting PixelFromRootTransform is not allowed. Attempts to set
- PixelFromRootTransform will cause an InvalidOperationException
- to be thrown.
- </summary>
- <exception cref="T:System.InvalidOperationException">
- If you attempt to set this property.
- </exception>
- </member>
- <member name="P:Cognex.VisionPro.CogImage16Range.CoordinateSpaceTree">
- <summary>
- Get or set the tree of all named two dimensional
- coordinate spaces for this image. The tree provides advanced
- functions for managing two dimensional coordinate spaces.
- </summary>
- <exception cref="T:System.ArgumentNullException">
- If NewVal is null.
- </exception>
- <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
- Fires when this property changes.
- </event>
- </member>
- <member name="P:Cognex.VisionPro.CogImage16Range.SelectedSpaceName">
- <summary>
- Get or set the name of the two dimensional coordinate
- space to be used by tools that process this image.
- </summary>
- <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
- Fires when this property changes.
- </event>
- </member>
- <member name="P:Cognex.VisionPro.CogImage16Range.Width">
- <summary>
- The number of columns of pixels in this image.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.CogImage16Range.Height">
- <summary>
- The number of rows of pixels in this image.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.CogImage16Range.Allocated">
- <summary>
- Whether there is pixel data associated with this image.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.GetMaskData">
- <summary>
- Returns a CogImage8Grey that represents the mask
- data of this image. This data is commonly referred
- to as the "visible pixel mask" and is provided
- as an indication of which pixel values were
- visible to the camera during acquisition. Any
- range image pixel that was not visible has an undefined
- pixel value. The visible pixel mask represents
- a visible pixel at a given row and column
- with an 8 bit grey value of 255,
- and a non-visible pixel with an 8 bit grey value
- of zero. The CogImage8Root and the two
- dimensional coordinate space tree of this
- CogImage8Grey visible pixel mask representation
- are shared with this range image. Note that
- the value returned by this method may be null,
- in which case all pixel values are considered
- visible.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.GetPixelData">
- <summary>
- Returns a CogImage16Grey that represents the range or
- height data of this image. The root and two dimensional coordinate
- space tree are shared with this range image.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.MapPoints3DFrom2D(System.String,System.String,Cognex.VisionPro3D.Cog3DVect2Collection,System.Boolean[]@,Cognex.VisionPro3D.Cog3DVect3Collection@)">
- <summary>
- Maps the supplied collection of two dimensional
- points into the specified three dimensional
- space. This is accomplished by first mapping
- an input two dimensional point into pixel
- space. If the range image's visible pixel
- mask indicates that this pixel was not visible,
- then the corresponding element in the output
- Visible array is set to false and the corresponding
- element in the output DstPoints3D collection
- is set to a default (0,0,0) value. Otherwise,
- the pixel value is read. This range image
- pixel value is incremented by 0.5 to place it
- at a "middle" height within the subject voxel.
- The resulting pixel space coordinate triple is
- mapped into the requested three dimensional
- space.
- </summary>
- <param name="DstPoint3DSpaceName">
- The destination three dimensional space name.
- </param>
- <param name="SrcPoint2DSpaceName">
- The source two dimensional space name.
- </param>
- <param name="SrcPoints2D">
- The source two dimensional point collection.
- </param>
- <param name="Visible">
- An output array of boolean values indicating which
- input points were visible. The number of elements
- in this array will equal the number of input points.
- </param>
- <param name="DstPoints3D">
- The resulting mapped three dimensional points. Any
- element corresponding to an input point that was
- not visible will have the value 0,0,0. This
- collection will have the same size as the input
- point collection.
- </param>
- <exception cref="T:System.ArgumentNullException">
- If DstPoint3DSpaceName is null.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- If SrcPoint2DSpaceName is null.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- If SrcPoints2D is null.
- </exception>
- <exception cref="T:Cognex.VisionPro.Exceptions.CogImageNoPixelsException">
- If Allocated is false.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.MapPoint3DFrom2D(System.String,System.String,Cognex.VisionPro3D.Cog3DVect2,System.Boolean@,Cognex.VisionPro3D.Cog3DVect3@)">
- <summary>
- Maps the supplied two dimensional point into the
- specified three dimensional space. This is
- accomplished by first mapping the input two
- dimensional point to pixel space. If the
- range image's visible pixel mask indicates
- that this pixel was not visible, then the
- Visible output argument is set to false and
- no further processing is performed. Otherwise,
- the pixel value is read. This range
- image pixel value is incremented by 0.5
- to place it at a "middle" height within
- the subject voxel. The resulting pixel space
- coordinate triple is mapped into the
- requested three dimensional space.
- </summary>
- <param name="DstPoint3DSpaceName">
- The destination three dimensional space name.
- </param>
- <param name="SrcPoint2DSpaceName">
- The source two dimensional space name.
- </param>
- <param name="SrcPoint2D">
- The source two dimensional point.
- </param>
- <param name="Visible">
- True if the source two dimensional point was visible.
- </param>
- <param name="DstPoint3D">
- The resulting mapped three dimensional point. This will
- be 0,0,0 if Visible is false.
- </param>
- <exception cref="T:System.ArgumentNullException">
- If DstPoint3DSpaceName is null.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- If SrcPoint2DSpaceName is null.
- </exception>
- <exception cref="T:Cognex.VisionPro.Exceptions.CogImageNoPixelsException">
- If Allocated is false.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.MapPoints2DFrom3D(System.String,System.String,Cognex.VisionPro3D.Cog3DVect3Collection,Cognex.VisionPro3D.Cog3DVect2Collection@)">
- <summary>
- Maps the supplied collection of three dimensional
- points into the specified two dimensional space.
- This is accomplished by first mapping an input three
- dimensional point to root space. The X and Y coodinates
- of this root space point are then mapped to the specified
- two dimensional space to produce that output two
- dimensional point.
- </summary>
- <param name="DstPoint2DSpaceName">
- The destination two dimensional space name.
- </param>
- <param name="SrcPoint3DSpaceName">
- The source three dimensional space name.
- </param>
- <param name="SrcPoints3D">
- The source three dimensional point collection.
- </param>
- <param name="DstPoints2D">
- The resulting collection of mapped two dimensional points.
- </param>
- <exception cref="T:System.ArgumentNullException">
- If DstPoint2DSpaceName is null.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- If SrcPoint3DSpaceName is null.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- If SrcPoints3D is null.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.MapPoint2DFrom3D(System.String,System.String,Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DVect2@)">
- <summary>
- Maps the supplied three dimensional point into the
- specified two dimensional space. This is accomplished
- by first mapping the input three dimensional point to
- root space. The X and Y coodinates of this root space
- point are then mapped to the specified two dimensional
- space to produce the output two dimensional point.
- </summary>
- <param name="DstPoint2DSpaceName">
- The destination two dimensional space name.
- </param>
- <param name="SrcPoint3DSpaceName">
- The source three dimensional space name.
- </param>
- <param name="SrcPoint3D">
- The source three dimensional point.
- </param>
- <param name="DstPoint2D">
- The resulting mapped two dimensional point.
- </param>
- <exception cref="T:System.ArgumentNullException">
- If DstPoint2DSpaceName is null.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- If SrcPoint3DSpaceName is null.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.GetTransform3D(System.String,System.String)">
- <summary>
- Returns a transform that maps three dimensional points
- from the 'From' space to the 'To' space.
- The special string "." is accepted as an alias
- for the SelectedSpaceName3D of this image.
- </summary>
- <param name="ToSpaceName">
- The name of the three dimensional coordinate
- space to transform the point to. The special string "." is
- accepted as an alias for the SelectedSpaceName3D of this image.
- </param>
- <param name="FromSpaceName">
- The name of the three dimensional coordinate
- space to transform the point from. The special string "." is
- accepted as an alias for the SelectedSpaceName3D of this image.
- </param>
- <exception cref="T:System.ArgumentNullException">
- If ToSpaceName is null.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- If FromSpaceName is null.
- </exception>
- <exception cref="T:Cognex.VisionPro.Exceptions.CogImageNoTreeException">
- If CoordinateSpaceTree3D is null.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.ScaleImage(System.Int32,System.Int32)">
- <summary>
- Creates a scaled version of this image. The dimensions
- of the returned image (in pixels) are specified by the DesiredWidth
- and DesiredHeight arguments. The scaling is performed using bilinear
- interpolation.
- </summary>
- <param name="DesiredWidth">
- The width in pixels of the desired output image.
- </param>
- <param name="DesiredHeight">
- The height in pixels of the desired output image.
- </param>
- <exception cref="T:Cognex.VisionPro.Exceptions.CogImageNoPixelsException">
- If Allocated is false.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.ToBitmap">
- <summary>
- Creates a 24-bit RGB Windows bitmap from this image.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.GetTransform(System.String,System.String)">
- <summary>
- Returns a transform that maps two dimensional points
- from the 'From' space to the 'To' space.
- The special string "." is accepted as an alias
- for the SelectedSpaceName of this image.
- </summary>
- <param name="ToSpaceName">
- The name of the two dimensional coordinate
- space to transform the point to. The special string "." is
- accepted as an alias for the SelectedSpaceName of this image.
- </param>
- <param name="FromSpaceName">
- The name of the two dimensional coordinate
- space to transform the point from. The special string "." is
- accepted as an alias for the SelectedSpaceName of this image.
- </param>
- <exception cref="T:System.ArgumentNullException">
- If ToSpaceName is null.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- If FromSpaceName is null.
- </exception>
- <exception cref="T:Cognex.VisionPro.Exceptions.CogImageNoTreeException">
- If CoordinateSpaceTree is null.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.SetPixel(System.Int32,System.Int32,System.Boolean,System.UInt16)">
- <summary>
- Set the pixel and mask values at a given pixel space
- location. Note that setting VisibleValue to false
- on a CogImage16Range whose root currently has a null
- mask root will cause an appropriately sized and populated
- mask root to be created. The opposite is not true:
- setting the sole non-visible mask value to visible
- will not cause the mask root to be set to null.
- </summary>
- <param name="X">
- The pixel space X coordinate of interest.
- </param>
- <param name="Y">
- The pixel space Y coordinate of interest.
- </param>
- <param name="VisibleValue">
- True if this pixel is visible.
- </param>
- <param name="PixelValue">
- The raw pixel value at this location.
- </param>
- <exception cref="T:Cognex.VisionPro.Exceptions.CogImageNoPixelsException">
- If Allocated is false.
- </exception>
- <exception cref="T:Cognex.VisionPro.Exceptions.CogImageBadCoordException">
- If X is less than zero or not less than Width, or if Y is
- less than zero or not less than Height.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.GetPixel(System.Int32,System.Int32,System.Boolean@,System.UInt16@)">
- <summary>
- Gets the mask (visible) and pixel value at the specified
- pixel space coordinates.
- </summary>
- <param name="X">
- The pixel space X coordinate of interest.
- </param>
- <param name="Y">
- The pixel space Y coordinate of interest.
- </param>
- <param name="VisibleValue">
- True if this pixel was visible.
- </param>
- <param name="PixelValue">
- The raw pixel value at this location. This
- is undefined if VisibleValue is false.
- </param>
- <exception cref="T:Cognex.VisionPro.Exceptions.CogImageNoPixelsException">
- If Allocated is false.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.SetRoot(Cognex.VisionPro.CogImage16RangeRoot)">
- <summary>
- Sets the range image root.
- </summary>
- <param name="Root">
- The range image root.
- </param>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.GetRoot(Cognex.VisionPro.CogImage16RangeRoot@)">
- <summary>
- Returns the range image root object that contains
- the underlying pixel and mask roots.
- </summary>
- <param name="Root">
- The range image root.
- </param>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.CopyBase(Cognex.VisionPro.CogImageCopyModeConstants)">
- <summary>
- Create a copy of this image. Pixel and mask data
- may be shared between images by specifying CopyMode to be
- CogImageCopyModeConstants.SharePixels"
- </summary>
- <param name="CopyMode">
- How to copy. May be SharePixels, CopyPixels,
- or NoPixels.
- </param>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.Copy">
- <summary>
- Create a copy of this image. Pixel and mask data
- are copied.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.Copy(Cognex.VisionPro.CogImageCopyModeConstants)">
- <summary>
- Create a copy of this image. Pixel and mask data
- may be shared between images by specifying CopyMode to be
- CogImageCopyModeConstants.SharePixels.
- </summary>
- <param name="CopyMode">
- How to copy. May be SharePixels, CopyPixels, or NoPixels.
- </param>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.Allocate(System.Int32,System.Int32)">
- <summary>
- Initialize the image with (undefined) pixel and mask
- data of the given width and height. This method may not be
- called more than once.
- </summary>
- <param name="DesiredWidth">
- The desired width of the image in pixels.
- </param>
- <param name="DesiredHeight">
- The desired height of the image in pixels.
- </param>
- <exception cref="T:Cognex.VisionPro.Exceptions.CogImageAllocateSizeException">
- If the image is already allocated to a different size.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.Finalize">
- <summary>
- Finalize this CogImage16Range.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.Dispose">
- <summary>
- Destruct this CogImage16Range.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.#ctor(System.Drawing.Bitmap)">
- <summary>
- Construct a new instance of this class using the supplied
- bitmap to specify pixel data. Note that this produces
- an image with an assumed identity mapping from "Sensor3D"
- space to root space.
- </summary>
- <param name="Bmp">
- The Windows Bitmap to use as the definition of pixel data.
- </param>
- <exception cref="System.ArgumentNullException">
- If Bmp is null.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.#ctor(Cognex.VisionPro.CogImage16Grey,System.Int32,Cognex.VisionPro3D.ICog3DTransform)">
- <summary>
- Construct a new instance of this class using the supplied
- pixel data, missing pixel value, and RootFromSensor3D transform.
- Mask data is automatically computed by identifying any pixel
- in the PixelData argument whose value matches the
- MissingPixelValue as not visible while all other pixels are
- set to visible. If no missing pixels are found then the
- mask root is set to null.
- </summary>
- <param name="PixelData">
- Use the pixels in this CogImage16Grey as the height or
- range data for this image.
- </param>
- <param name="MissingPixelValue">
- Pixels in the PixelData argument that have this value
- are set to not visible, and all other pixels are
- set to visible.
- </param>
- <param name="RootFromSensor3D">
- An ICog3DTransform that specifies the mapping from
- "Sensor3D" space to root space. May not be null.
- </param>
- <exception cref="System.ArgumentNullException">
- If PixelData is null.
- </exception>
- <exception cref="System.ArgumentOutOfRangeException">
- If MissingPixelValue is less than zero.
- </exception>
- <exception cref="System.ArgumentNullException">
- If RootFromSensor3D is null.
- </exception>
- <exception cref="System.ArgumentException">
- If PixelData is not allocated.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.#ctor(Cognex.VisionPro.CogImage16Grey,Cognex.VisionPro.CogImage8Grey,Cognex.VisionPro3D.ICog3DTransform)">
- <summary>
- Construct a new instance of this class using the supplied
- pixel data, mask data, and RootFromSensor3D transform.
- </summary>
- <param name="PixelData">
- Use the pixels in this CogImage16Grey as the height or
- range data for this image. This argument may not be null.
- </param>
- <param name="MaskData">
- Use the pixels in this CogImage8Grey as the mask data
- for this image. Defined pixel values are zero (not
- visible) and 255 (visible). If this argument is null
- then all pixels are presumed to be visible.
- </param>
- <param name="RootFromSensor3D">
- An ICog3DTransform that specifies the mapping from
- "Sensor3D" space to root space. May not be null.
- </param>
- <exception cref="T:System.ArgumentNullException">
- If PixelData is null.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- If RootFromSensor3D is null.
- </exception>
- <exception cref="T:System.ArgumentException">
- If PixelData is not allocated.
- </exception>
- <exception cref="T:System.ArgumentException">
- If MaskData is not null and is not allocated.
- </exception>
- <exception cref="T:System.ArgumentException">
- If MaskData and PixelData do not have the same width.
- </exception>
- <exception cref="T:System.ArgumentException">
- If MaskData and PixelData do not have the same height.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.#ctor(System.Int32,System.Int32,Cognex.VisionPro3D.ICog3DTransform)">
- <summary>
- Construct a new instance of this class using the supplied
- RootFromSensor3D transform and allocating storage for
- the specified image size.
- </summary>
- <param name="Width">
- Width of this image in pixels. Must be greater than zero.
- </param>
- <param name="Height">
- Height of this image in pixels. Must be greate than zero.
- </param>
- <param name="RootFromSensor3D">
- An ICog3DTransform that specifies the mapping from
- "Sensor3D" space to root space. May not be null.
- </param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- If Width is less than 1.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- If Height is less than 1.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- If RootFromSensor3D is null.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.#ctor(Cognex.VisionPro3D.ICog3DTransform)">
- <summary>
- Construct a new instance of this class using the supplied
- RootFromSensor3D transform.
- </summary>
- <param name="RootFromSensor3D">
- An ICog3DTransform that specifies the mapping from
- "Sensor3D" space to root space. May not be null.
- </param>
- <exception cref="T:System.ArgumentNullException">
- If the input argument is null.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.#ctor(Cognex.VisionPro.CogImage16Range)">
- <summary>
- Construct a new instance of this class as a shallow copy of the
- given instance.
- </summary>
- <param name="Other">
- The CogImage16Range object to be copied. May not be null.
- </param>
- <exception cref="T:System.ArgumentNullException">
- If the input argument is null.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16Range.#ctor">
- <summary>
- Construct a new instance of this class.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.CogImage16Range.SfCoordinateSpaceTree3D">
- <summary>
- This bit will be set in the EventArgs of a Changed event
- every time the value returned by CoordinateSpaceTree3D
- may have changed.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.CogImage16Range.SfPixelFromRootTransform3D">
- <summary>
- This bit will be set in the EventArgs of a Changed event
- every time the value returned by PixelFromRootTransform3D
- may have changed.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.CogImage16Range.SfSelectedSpaceName3D">
- <summary>
- This bit will be set in the EventArgs of a Changed event
- every time the value returned by SelectedSpaceName3D
- may have changed.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.CogImage16Range.SfPixelFromRootTransform">
- <summary>
- This bit will be set in the EventArgs of a Changed event
- every time the value returned by PixelFromRootTransform
- may have changed.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.CogImage16Range.SfCoordinateSpaceTree">
- <summary>
- This bit will be set in the EventArgs of a Changed event
- every time the value returned by CoordinateSpaceTree
- may have changed.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.CogImage16Range.SfSelectedSpaceName">
- <summary>
- This bit will be set in the EventArgs of a Changed event
- every time the value returned by SelectedSpaceName
- may have changed.
- </summary>
- </member>
- <member name="T:Cognex.VisionPro.CogImage16Range">
- <summary>
- Object that describes a range image. A range image describes three
- dimensional surfaces. A CogImage16Range contains three dimensional
- height data, a "visible pixel mask" to identify which pixels are
- valid, three dimensional transform information, and two dimensional
- transform information.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16RangeRoot.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Serialization constructor for CogImage16RangeRoot object.
- </summary>
- <param name="Info">
- The standard SerializationInfo argument.
- </param>
- <param name="Ctxt">
- The standard StreamingContext argument.
- </param>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16RangeRoot.OnDeserialization(System.Object)">
- <summary>
- Perform post-deserialization setup for this CogImage16RangeRoot.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16RangeRoot.SetMaskRoot(Cognex.VisionPro.ICogImage8Root)">
- <summary>
- Set the MaskRoot to a new value. In much
- the same way that one can set a pixel value
- in an image without causing a Changed event
- to fire, one may set the MaskRoot to a new value
- and no Changed event is fired.
- </summary>
- <exception cref="System.ArgumentException">
- If the supplied mask root's width or height do not
- match those of the pixel root.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16RangeRoot.GetMaskRoot">
- <summary>
- Get the ICogImage8Root that corresponds to mask data.
- Note that this value may be null if there
- are no missing pixels.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16RangeRoot.GetPixelRoot">
- <summary>
- Get the ICogImage16Root that corresponds to pixel data.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.CogImage16RangeRoot.Width">
- <summary>
- Width of the image in pixels.
- </summary>
- </member>
- <member name="P:Cognex.VisionPro.CogImage16RangeRoot.Height">
- <summary>
- Height of the image in pixels.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16RangeRoot.Finalize">
- <summary>
- Finalize this CogImage16RangeRoot.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16RangeRoot.Dispose">
- <summary>
- Destruct this CogImage16RangeRoot.
- </summary>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16RangeRoot.#ctor(Cognex.VisionPro.CogImage16RangeRoot)">
- <summary>
- Constructs a new instance of this class as a deep copy of the
- given instance.
- </summary>
- <param name="Other">
- The CogImage16Root object to be copied. May not be null.
- </param>
- <exception cref="System.ArgumentNullException">
- If the input argument is null.
- </exception>
- </member>
- <member name="M:Cognex.VisionPro.CogImage16RangeRoot.#ctor(Cognex.VisionPro.ICogImage16Root,Cognex.VisionPro.ICogImage8Root)">
- <summary>
- Constructs a new instance of this class from the supplied
- parameters.
- </summary>
- <param name="PixelRoot">
- The pixel root.
- </param>
- <param name="MaskRoot">
- The mask root.
- </param>
- <exception cref="System.ArgumentNullException">
- If PixelRoot is null.
- </exception>
- </member>
- <member name="T:Cognex.VisionPro.CogImage16RangeRoot">
- <summary>
- Object that holds the raw pixel and mask data of a range image.
- </summary>
- </member>
- <member name="T:Cognex.VisionPro.CogCenterPointsToLinesNormalDirectionInferenceMethodConstants">
- <summary>
- How the <see cref="T:Cognex.VisionPro.CogCenterPointsToLines" />
- class will infer the normal direction of the line segments.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.CogCenterPointsToLinesNormalDirectionInferenceMethodConstants.UseLineSegmentNormalDirection">
- <summary>
- Use the direction of the given line segments to determine
- the normal direction for each line segment. The direction of
- a line segment is implied by the ordering of its start and
- end points (end - start). The normal direction is defined to be
- +90 degrees from the line segment direction.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.CogCenterPointsToLinesNormalDirectionInferenceMethodConstants.InferFromConvexity">
- <summary>
- Automatically infer the line segment normal direction for
- each input line segment. It requires the input line segments
- to form a convex shape. It selects the normal direction for
- each line segment such that the line normal points outwards.
- </summary>
- </member>
- <member name="T:Cognex.VisionPro.CogCenterPointsToLinesModeConstants">
- <summary>
- What fitting style was or will be used with the
- <see cref="T:Cognex.VisionPro.CogCenterPointsToLines" />
- object.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.CogCenterPointsToLinesModeConstants.Pair">
- <summary>
- For point pair to line pair fitting. The feature correspondences
- are between point pairs and line pairs. The
- <see cref="T:Cognex.VisionPro.CogCenterPointsToLines" />
- class will minimize the variation in the point to line
- signed distance differences, across all point pair line
- pair correspondences. The point to line distance difference for
- a given point pair line pair correspondence is the difference
- between the point to line distance for the first point and the
- point to line distance for the second point in the point pair.
- The class tries to make the two point to line signed distances
- in each point pair line pair correspondence the same. Signed
- distances are measured in the direction of the normal to the
- line.
- </summary>
- </member>
- <member name="F:Cognex.VisionPro.CogCenterPointsToLinesModeConstants.Single">
- <summary>
- For point to line fitting. The feature correspondences
- are between individual points and lines. The
- <see cref="T:Cognex.VisionPro.CogCenterPointsToLines" />
- class will minimize the variance in the point to line
- signed distance across all point to line correspondences.
- The class tries to make all of the point to line distances the
- same.
- </summary>
- </member>
- <!-- Discarding badly formed XML document comment for member 'P:Cognex.VisionPro.CogVisionDataContainer.ContainsRangeGreyImagePairsOnly'. -->
- </members>
- </doc>
|