Cognex.VisionPro3D.xml 825 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. "Cognex.VisionPro3D"
  5. </assembly>
  6. <members>
  7. <member name="M:Cognex.VisionPro3D.Cog3DVisionDataStitchTool.ClearSetupImage">
  8. <summary>
  9. This method clears any previously cached SetupImage.
  10. </summary>
  11. </member>
  12. <member name="M:Cognex.VisionPro3D.Cog3DVisionDataStitchTool.ComputeSetupImage">
  13. <summary>
  14. Use the current InputVisionData to produce a maximally sized range
  15. image. This is done using most of the current RunParams settings,
  16. while ignoring the OutputImageXYMode, OutputImageZMode, and
  17. OutputEnable settings. This range image is available via the read-only
  18. SetupImage property. This range image will be used by
  19. CreateCurrentRecord if available and requested.
  20. </summary>
  21. <exception cref="!:T:System.ArgumentNullException">
  22. The input vision data argument is null.
  23. </exception>
  24. <exception cref="!:T:System.ArgumentException">
  25. The supplied input vision data does not contain
  26. the specified output space source.
  27. </exception>
  28. <exception cref="!:T:System.ArgumentException">
  29. The input range and grey images do not match in size.
  30. </exception>
  31. <exception cref="!:T:System.ArgumentException">
  32. The input CogVisionDataContainer is not either all range
  33. images or all range / grey image pairs.
  34. </exception>
  35. <exception cref="!:T:System.ArgumentException">
  36. The input range images do not all contain the specified
  37. shared space.
  38. </exception>
  39. <exception cref="!:T:System.ArgumentException">
  40. The input range image identified as the output space
  41. source does not contain the specified output space.
  42. </exception>
  43. </member>
  44. <member name="M:Cognex.VisionPro3D.Cog3DVisionDataStitchTool.Run">
  45. <summary>
  46. Runs this Cog3DVisionDataStitchTool using the current
  47. parameter settings.
  48. </summary>
  49. <event cref="!:E:Cognex.VisionPro.ICogTool.Running">
  50. Fires before the tool runs.
  51. </event>
  52. <event cref="!:E:Cognex.VisionPro.ICogChangedEvent.Changed">
  53. Fires when the tool runs. If the run was successful, results are
  54. generated; if the run was not successful, no results are generated
  55. and the previous results are cleared.
  56. </event>
  57. <event cref="!:E:Cognex.VisionPro.ICogTool.Ran">
  58. Fires after the tool runs.
  59. </event>
  60. </member>
  61. <member name="P:Cognex.VisionPro3D.Cog3DVisionDataStitchTool.LastRunRecordDiagEnable">
  62. <summary>
  63. Enable creation of records by bitwise ORing the appropriate
  64. <see cref="!:T:Cognex.VisionPro3D.Cog3DVisionDataStitchLastRunRecordDiagConstants" />.
  65. </summary>
  66. <event cref="!:E:Cognex.VisionPro.ICogChangedEvent.Changed">
  67. Fires when the value of this property changes.
  68. </event>
  69. </member>
  70. <member name="P:Cognex.VisionPro3D.Cog3DVisionDataStitchTool.LastRunRecordEnable">
  71. <summary>
  72. Enable creation of records by bitwise ORing the appropriate
  73. <see cref="!:T:Cognex.VisionPro3D.Cog3DVisionDataStitchLastRunRecordConstants" />.
  74. </summary>
  75. <event cref="!:E:Cognex.VisionPro.ICogChangedEvent.Changed">
  76. Fires when the value of this property changes.
  77. </event>
  78. </member>
  79. <member name="P:Cognex.VisionPro3D.Cog3DVisionDataStitchTool.CurrentRecordEnable">
  80. <summary>
  81. Enable creation of records by bitwise ORing the appropriate
  82. <see cref="!:T:Cognex.VisionPro3D.Cog3DVisionDataStitchCurrentRecordConstants" />.
  83. </summary>
  84. <event cref="!:E:Cognex.VisionPro.ICogChangedEvent.Changed">
  85. Fires when the value of this property changes.
  86. </event>
  87. </member>
  88. <member name="P:Cognex.VisionPro3D.Cog3DVisionDataStitchTool.SetupImage">
  89. <summary>
  90. The SetupImage from the most recent call to ComputeSetupImage.
  91. This property may be null.
  92. </summary>
  93. </member>
  94. <member name="P:Cognex.VisionPro3D.Cog3DVisionDataStitchTool.Result">
  95. <summary>
  96. The result of the most recent run of this tool.
  97. </summary>
  98. </member>
  99. <member name="P:Cognex.VisionPro3D.Cog3DVisionDataStitchTool.RunParams">
  100. <summary>
  101. The operator that performs the actual stitching.
  102. </summary>
  103. <event cref="!:E:Cognex.VisionPro.ICogChangedEvent.Changed">
  104. Fires when the value of this property changes.
  105. </event>
  106. </member>
  107. <member name="P:Cognex.VisionPro3D.Cog3DVisionDataStitchTool.InputVisionData">
  108. <summary>
  109. The input vision data (either range images or range image / grey
  110. image pairs) to be processed by the contained operator.
  111. </summary>
  112. <event cref="!:E:Cognex.VisionPro.ICogChangedEvent.Changed">
  113. Fires when the value of this property changes.
  114. </event>
  115. </member>
  116. <member name="M:Cognex.VisionPro3D.Cog3DVisionDataStitchTool.OnDeserialization(System.Object)">
  117. <summary>
  118. Perform post deserialization setup. This method
  119. may safely be called more than once.
  120. </summary>
  121. </member>
  122. <member name="M:Cognex.VisionPro3D.Cog3DVisionDataStitchTool.Dispose">
  123. <summary>
  124. Destruct this Cog3DVisionDataStitchTool.
  125. </summary>
  126. </member>
  127. <member name="M:Cognex.VisionPro3D.Cog3DVisionDataStitchTool.#ctor(Cognex.VisionPro3D.Cog3DVisionDataStitchTool)">
  128. <summary>
  129. Constructs a new instance of this class as a copy
  130. of the given instance.
  131. </summary>
  132. </member>
  133. <member name="M:Cognex.VisionPro3D.Cog3DVisionDataStitchTool.#ctor">
  134. <summary>
  135. Construct a new instance of this class.
  136. </summary>
  137. </member>
  138. <member name="M:Cognex.VisionPro3D.Cog3DVisionDataStitchTool.Clone">
  139. <summary>
  140. Create a clone, or copy, of this Cog3DVisionDataStitchTool.
  141. </summary>
  142. </member>
  143. <member name="M:Cognex.VisionPro3D.Cog3DVisionDataStitchTool.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  144. <summary>
  145. Serializer for Cog3DVisionDataStitchTool object.
  146. </summary>
  147. <param name="Info">
  148. The standard SerializationInfo argument.
  149. </param>
  150. <param name="Ctxt">
  151. The standard StreamingContext argument.
  152. </param>
  153. </member>
  154. <member name="M:Cognex.VisionPro3D.Cog3DVisionDataStitchTool.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  155. <summary>
  156. Serialization constructor for a Cog3DVisionDataStitchTool object.
  157. </summary>
  158. <param name="Info">
  159. The standard SerializationInfo argument.
  160. </param>
  161. <param name="Ctxt">
  162. The standard StreamingContext argument.
  163. </param>
  164. </member>
  165. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitchTool.SfSetupImage">
  166. <summary>
  167. This bit will be set in the EventArgs of a Changed event
  168. every time the value returned by SetupImage
  169. may have changed.
  170. </summary>
  171. </member>
  172. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitchTool.SfResult">
  173. <summary>
  174. This bit will be set in the EventArgs of a Changed event
  175. every time the value returned by Result
  176. may have changed.
  177. </summary>
  178. </member>
  179. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitchTool.SfInputVisionData">
  180. <summary>
  181. This bit will be set in the EventArgs of a Changed event
  182. every time the value returned by InputVisionData
  183. may have changed.
  184. </summary>
  185. </member>
  186. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitchTool.SfRunParams">
  187. <summary>
  188. This bit will be set in the EventArgs of a Changed event
  189. every time the value returned by RunParams
  190. may have changed.
  191. </summary>
  192. </member>
  193. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitchTool.SfCurrentRecordEnable">
  194. <summary>
  195. This bit will be set in the EventArgs of a Changed event
  196. every time the value returned by CurrentRecordEnable
  197. may have changed.
  198. </summary>
  199. </member>
  200. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitchTool.SfLastRunRecordDiagEnable">
  201. <summary>
  202. This bit will be set in the EventArgs of a Changed event
  203. every time the value returned by LastRunRecordDiagEnable
  204. may have changed.
  205. </summary>
  206. </member>
  207. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitchTool.SfLastRunRecordEnable">
  208. <summary>
  209. This bit will be set in the EventArgs of a Changed event
  210. every time the value returned by LastRunRecordEnable
  211. may have changed.
  212. </summary>
  213. </member>
  214. <member name="T:Cognex.VisionPro3D.Cog3DVisionDataStitchTool">
  215. <summary>
  216. The Cog3DVisionDataStitchTool class facilitates the use of a
  217. Cog3DVisionDataStitch operator.
  218. </summary>
  219. </member>
  220. <member name="T:Cognex.VisionPro3D.Cog3DVisionDataStitchLastRunRecordDiagConstants">
  221. <summary>
  222. Enumeration of the diagnostic data that can be provided
  223. in the tool's LasRunRecord.
  224. </summary>
  225. <remarks>
  226. Use these constants with
  227. <see cref="!:P:Cognex.VisionPro3D.Cog3DVisionDataStitchTool.LastRunRecordDiagEnable" />
  228. to specify the diagnostic
  229. <see cref="!:u:Programming.Tools.Theory.ToolRecords">tool records</see>
  230. that the Cog3DVisionDataStitchTool generates when you call
  231. <see cref="!:M:Cognex.VisionPro.ICogTool.CreateLastRunRecord" />.
  232. </remarks>
  233. </member>
  234. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitchLastRunRecordDiagConstants.All">
  235. <summary>
  236. Include all of the diagnostic data in the LastRunRecord.
  237. </summary>
  238. </member>
  239. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitchLastRunRecordDiagConstants.DestinationRectangle">
  240. <summary>
  241. Draw the (non-interactive) destination rectangle on any displayed
  242. input range image.
  243. </summary>
  244. </member>
  245. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitchLastRunRecordDiagConstants.InputGreyImages">
  246. <summary>
  247. Create a subrecord for each of the input grey images. Images are
  248. by reference.
  249. </summary>
  250. </member>
  251. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitchLastRunRecordDiagConstants.InputRangeImages">
  252. <summary>
  253. Create a subrecord for each of the input range images. Images are
  254. by reference.
  255. </summary>
  256. </member>
  257. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitchLastRunRecordDiagConstants.None">
  258. <summary>
  259. Do not include any of the diagnostic data in the
  260. LastRunRecord.
  261. </summary>
  262. </member>
  263. <member name="T:Cognex.VisionPro3D.Cog3DVisionDataStitchLastRunRecordConstants">
  264. <summary>
  265. Enumeration of the non-diagnostic data that can be provided
  266. in the tool's LasRunRecord.
  267. </summary>
  268. <remarks>
  269. Use these constants with
  270. <see cref="!:P:Cognex.VisionPro3D.Cog3DVisionDataStitchTool.LastRunRecordEnable" />
  271. to specify the
  272. <see cref="!:u:Programming.Tools.Theory.ToolRecords">tool records</see>
  273. that the Cog3DVisionDataStitchTool generates when you call
  274. <see cref="!:M:Cognex.VisionPro.ICogTool.CreateLastRunRecord" />.
  275. </remarks>
  276. </member>
  277. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitchLastRunRecordConstants.All">
  278. <summary>
  279. Include all of the non-diagnostic data in the
  280. LastRunRecord.
  281. </summary>
  282. </member>
  283. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitchLastRunRecordConstants.OutputGreyImage">
  284. <summary>
  285. Create a subrecord that references the output grey image.
  286. </summary>
  287. </member>
  288. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitchLastRunRecordConstants.OutputRangeImage">
  289. <summary>
  290. Create a subrecord that references the output range image.
  291. </summary>
  292. </member>
  293. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitchLastRunRecordConstants.None">
  294. <summary>
  295. Do not include any of the non-diagnostic data in the
  296. LastRunRecord.
  297. </summary>
  298. </member>
  299. <member name="T:Cognex.VisionPro3D.Cog3DVisionDataStitchCurrentRecordConstants">
  300. <summary>
  301. Enumeration of the data that can be provided in the tool's CurrentRecord.
  302. </summary>
  303. <remarks>
  304. Use these constants with
  305. <see cref="!:P:Cognex.VisionPro3D.Cog3DVisionDataStitchTool.CurrentRecordEnable" />
  306. to specify the
  307. <see cref="!:u:Programming.Tools.Theory.ToolRecords">tool records</see>
  308. that the Cog3DVisionDataStitchTool generates when you call
  309. <secc cref="!:M:Cognex.VisionPro.ICogTool.CreateCurrentRecord" />.
  310. </remarks>
  311. </member>
  312. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitchCurrentRecordConstants.All">
  313. <summary>
  314. Include all possible records in the CurrentRecord.
  315. </summary>
  316. </member>
  317. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitchCurrentRecordConstants.DestinationRectangle">
  318. <summary>
  319. Add an interactive CogRectangle as a subrecord of the SetupImage
  320. subrecord. This rectangle is coupled to the RunParam's OutputImageXMin,
  321. OutputImageXMax, OutputImageYMin, and OutputImageYMax parameters.
  322. </summary>
  323. </member>
  324. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitchCurrentRecordConstants.SetupImage">
  325. <summary>
  326. Create a subrecord for the cached, maximally sized setup image.
  327. </summary>
  328. </member>
  329. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitchCurrentRecordConstants.InputGreyImages">
  330. <summary>
  331. Create a subrecord for each of the input grey images. Images are
  332. by reference.
  333. </summary>
  334. </member>
  335. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitchCurrentRecordConstants.InputRangeImages">
  336. <summary>
  337. Create a subrecord for each of the input range images. Images are
  338. by reference.
  339. </summary>
  340. </member>
  341. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitchCurrentRecordConstants.None">
  342. <summary>
  343. Do not include any records in the CurrentRecord.
  344. </summary>
  345. </member>
  346. <member name="M:Cognex.VisionPro3D.Cog3DVisionDataStitch.Execute(Cognex.VisionPro.CogVisionDataContainer)">
  347. <summary>
  348. Perform stitching on the supplied vision data.
  349. </summary>
  350. <param name="inputVisionData">
  351. The CogVisionDataContainer containing the range images
  352. (and optionally grey images) to be stitched.
  353. </param>
  354. <returns>
  355. A
  356. <see cref="!:T:Cognex.VisionPro3D.Cog3DVisionDataStitchResult" />
  357. containing the results of the stitching operation.
  358. </returns>
  359. <exception cref="!:T:System.ArgumentNullException">
  360. The input vision data argument is null.
  361. </exception>
  362. <exception cref="!:T:System.ArgumentException">
  363. No output is enabled.
  364. </exception>
  365. <exception cref="!:T:System.ArgumentException">
  366. Grey output is requested but there is no grey input.
  367. </exception>
  368. <exception cref="!:T:System.ArgumentException">
  369. The supplied input vision data does not contain
  370. the specified output space source.
  371. </exception>
  372. <exception cref="!:T:System.ArgumentException">
  373. The input range and grey images do not match in size.
  374. </exception>
  375. <exception cref="!:T:System.ArgumentException">
  376. The input CogVisionDataContainer is not either all range
  377. images or all range / grey image pairs.
  378. </exception>
  379. <exception cref="!:T:System.ArgumentException">
  380. The input range images do not all contain the specified
  381. shared space.
  382. </exception>
  383. <exception cref="!:T:System.ArgumentException">
  384. The input range image identified as the output space
  385. source does not contain the specified output space.
  386. </exception>
  387. </member>
  388. <member name="P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputImageOverlapPriorities">
  389. <summary>
  390. When
  391. <see cref="!:P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputImageOverlapMode" />
  392. is
  393. <see cref="!:T:Cognex.VisionPro3D.Cog3DVisionDataStitch.Cog3DVisionDataStitchOverlapModeConstants">Priority</see>,
  394. this is how we select an output pixel value from more than one
  395. overlapping input pixel. In such a case, the overlapping input
  396. image with the numerically lowest priority value is chosen.
  397. </summary>
  398. <remarks>
  399. The structure of this CogDictionary is as follows. There should be
  400. one key/value entry for each input image. The key should be the
  401. same string as that used to idenitify an input image in the
  402. <see cref="!:T:Cognex.VisionPro.CogVisionDataContainer" />
  403. that is supplied to the
  404. <see cref="!:M:Cognex.VisionPro3D.Cog3DVisionDataStitch::Execute" />
  405. method. The value should be a positive integer indicating
  406. priority for that image: zero is the highest priority,
  407. then one, then two, and so on.
  408. </remarks>
  409. </member>
  410. <member name="P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputImageOverlapMode">
  411. <summary>
  412. How input pixels that overlap in X and Y will be processed to produce
  413. an output pixel value.
  414. </summary>
  415. <value>
  416. The default is
  417. <see cref="!:T:Cognex.VisionPro3D.Cog3DVisionDataStitchOverlapModeConstants">
  418. MaxZ</see>.
  419. </value>
  420. <event cref="!:E:Cognex.VisionPro.ICogChangedEvent.Changed">
  421. Fires when the value of this property changes.
  422. </event>
  423. <exception cref="!:T:System.ArgumentException">
  424. The supplied value is not a member of
  425. <see cref="!:T:Cognex.VisionPro3D.Cog3DVisionDataStitchOverlapModeConstants" /></exception>
  426. </member>
  427. <member name="P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputImageZConsistencyDistance">
  428. <summary>
  429. The maximum Z difference in client space over which overlapping pixel
  430. values will be averaged. If
  431. <see cref="!:P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OverlapMode" />
  432. is
  433. <see cref="!:T:Cognex.VisionPro3D.Cog3DVisionDataStitchOverlapModeConstants">
  434. MaxZ</see>, then overlapping pixels whose height is within this distance
  435. of the maximum height at that location will be averaged. And if
  436. <see cref="!:P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OverlapMode" />
  437. is
  438. <see cref="!:T:Cognex.VisionPro3D.Cog3DVisionDataStitchOverlapModeConstants">
  439. MinZ</see>, then overlapping pixels whose height is within this distance of
  440. the minimum height at that location will be averaged. Overlapping pixel
  441. height values that are outside the specified range will be ignored.
  442. Finally, if
  443. <see cref="!:P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OverlapMode" />
  444. is any other value, this parameter is ignored.
  445. </summary>
  446. <value>
  447. The default is 0.0.
  448. </value>
  449. </member>
  450. <member name="P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputImageZContinuityThreshold">
  451. <summary>
  452. The maximum allowable Z difference in client space
  453. (<see cref="!:P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputSpaceName3D" />)
  454. between adjacent source data positions, between which range image voxels
  455. will be interpolated. Adjacencies whose Z difference exceeds this value
  456. will be disconnected. If
  457. <see cref="!:P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputImageZContinuityThresholdEnabled" />
  458. is false then this property is ignored and processing is
  459. performed as if this value were set to
  460. <see cref="!:F:System.Double.MaxValue" />).
  461. </summary>
  462. <value>
  463. The default is 10.0.
  464. </value>
  465. <event cref="!:E:Cognex.VisionPro.ICogChangedEvent.Changed">
  466. Fires when the value of this property changes.
  467. </event>
  468. <exception cref="!:T:System.ArgumentOutOfRangeException">
  469. The supplied value must be greater than or equal to zero.
  470. </exception>
  471. </member>
  472. <member name="P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputImageZContinuityThresholdEnabled">
  473. <summary>
  474. Controls whether
  475. <see cref="!:P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputImageZContinuityThreshold" />
  476. is used during processing. If false, processing is performed
  477. as if the threshold were set to
  478. <see cref="!:F:System.Double.MaxValue" />).
  479. </summary>
  480. <value>
  481. The default is false.
  482. </value>
  483. </member>
  484. <member name="P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputImageZMin">
  485. <summary>
  486. Client space
  487. (<see cref="!:P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputSpaceName3D" />)
  488. minimum Z. If
  489. <see cref="!:P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputImageZMode" />
  490. is
  491. <see cref="!:T:Cognex.VisionPro3D.Cog3DVisionDataStitchZModeConstants">
  492. UseZMin</see>, then this parameter will be the output space Z that
  493. corresponds to a minimum output pixel value. This parameter is ignored if
  494. <see cref="!:P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputImageZMode" />
  495. is not
  496. <see cref="!:T:Cognex.VisionPro3D.Cog3DVisionDataStitchZModeConstants">
  497. UseZMin</see>.
  498. </summary>
  499. <value>
  500. The default is -100.0.
  501. </value>
  502. <event cref="!:E:Cognex.VisionPro.ICogChangedEvent.Changed">
  503. Fires when the value of this property changes.
  504. </event>
  505. </member>
  506. <member name="P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputImageZMode">
  507. <summary>
  508. How to handle the Z values of the output range image. There are two
  509. defined modes:
  510. <see cref="!:T:Cognex.VisionPro3D.Cog3DVisionDataStitchZModeConstants">
  511. UseZMin</see> and
  512. <see cref="!:T:Cognex.VisionPro3D.Cog3DVisionDataStitchZModeConstants">
  513. Auto</see>.
  514. </summary>
  515. <value>
  516. The default is
  517. <see cref="!:T:Cognex.VisionPro3D.Cog3DVisionDataStitchZModeConstants">
  518. Auto</see>.
  519. </value>
  520. <event cref="!:E:Cognex.VisionPro.ICogChangedEvent.Changed">
  521. Fires when the value of this property changes.
  522. </event>
  523. <exception cref="!:T:System.ArgumentException">
  524. The supplied value is not a member of
  525. <see cref="!:T:Cognex.VisionPro3D.Cog3DVisionDataStitchZModeConstants" /></exception>
  526. </member>
  527. <member name="P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputImageYMax">
  528. <summary>
  529. Client space
  530. (<see cref="!:P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputSpaceName3D" />)
  531. maximum Y bounds for the output range image. Ignored if
  532. <see cref="!:P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputImageXYMode" />
  533. is not
  534. <see cref="!:T:Cognex.VisionPro3D.Cog3DVisionDataStitchXYModeConstants">
  535. Limit</see>.
  536. Note that setting this value to less than the current
  537. <see cref="!:P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputImageYMin" />
  538. will cause OutputImageYMin to be set to the new value as well.
  539. </summary>
  540. <value>
  541. The default is 100.0.
  542. </value>
  543. <event cref="!:E:Cognex.VisionPro.ICogChangedEvent.Changed">
  544. Fires when the value of this property changes.
  545. </event>
  546. </member>
  547. <member name="P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputImageYMin">
  548. <summary>
  549. Client space
  550. (<see cref="!:P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputSpaceName3D" />)
  551. minimum Y bounds for the output range image. Ignored if
  552. <see cref="!:P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputImageXYMode" />
  553. is not
  554. <see cref="!:T:Cognex.VisionPro3D.Cog3DVisionDataStitchXYModeConstants">
  555. Limit</see>.
  556. Note that setting this value to greater than the current
  557. <see cref="!:P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputImageYMax" />
  558. will cause OutputImageYMax to be set to the new value as well.
  559. </summary>
  560. <value>
  561. The default is -100.0.
  562. </value>
  563. <event cref="!:E:Cognex.VisionPro.ICogChangedEvent.Changed">
  564. Fires when the value of this property changes.
  565. </event>
  566. </member>
  567. <member name="P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputImageXMax">
  568. <summary>
  569. Client space
  570. (<see cref="!:P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputSpaceName3D" />)
  571. maximum X bounds for the output range image. Ignored if
  572. <see cref="!:P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputImageXYMode" />
  573. is not
  574. <see cref="!:T:Cognex.VisionPro3D.Cog3DVisionDataStitchXYModeConstants">
  575. Limit</see>.
  576. Note that setting this value to less than the current
  577. <see cref="!:P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputImageXMin" />
  578. will cause OutputImageXMin to be set to the new value as well.
  579. </summary>
  580. <value>
  581. The default is 100.0.
  582. </value>
  583. <event cref="!:E:Cognex.VisionPro.ICogChangedEvent.Changed">
  584. Fires when the value of this property changes.
  585. </event>
  586. </member>
  587. <member name="P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputImageXMin">
  588. <summary>
  589. Client space
  590. (<see cref="!:P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputSpaceName3D" />)
  591. minimum X bounds for the output range image. Ignored if
  592. <see cref="!:P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputImageXYMode" />
  593. is not
  594. <see cref="!:T:Cognex.VisionPro3D.Cog3DVisionDataStitchXYModeConstants">
  595. Limit</see>.
  596. Note that setting this value to greater than the current
  597. <see cref="!:P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputImageXMax" />
  598. will cause OutputImageXMax to be set to the new value as well.
  599. </summary>
  600. <value>
  601. The default is -100.0.
  602. </value>
  603. <event cref="!:E:Cognex.VisionPro.ICogChangedEvent.Changed">
  604. Fires when the value of this property changes.
  605. </event>
  606. </member>
  607. <member name="P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputImageXYMode">
  608. <summary>
  609. How to define the X, Y bounds of the output image. There are two
  610. defined modes:
  611. <see cref="!:T:Cognex.VisionPro3D.Cog3DVisionDataStitchXYModeConstants">
  612. Limit</see> and
  613. <see cref="!:T:Cognex.VisionPro3D.Cog3DVisionDataStitchXYModeConstants">
  614. Auto</see>.
  615. </summary>
  616. <value>
  617. The default is
  618. <see cref="!:T:Cognex.VisionPro3D.Cog3DVisionDataStitchXYModeConstants">
  619. Auto</see>.
  620. </value>
  621. <event cref="!:E:Cognex.VisionPro.ICogChangedEvent.Changed">
  622. Fires when the value of this property changes.
  623. </event>
  624. <exception cref="!:T:System.ArgumentException">
  625. The supplied value is not a member of
  626. <see cref="!:T:Cognex.VisionPro3D.Cog3DVisionDataStitchXYModeConstants" /></exception>
  627. </member>
  628. <member name="P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputImageZScale">
  629. <summary>
  630. The Z scale factor to use when generating the output range image.
  631. Ignored when
  632. <see cref="!:P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputImageScaleMode" />
  633. is
  634. <see cref="!:T:Cognex.VisionPro3D.Cog3DVisionDataStitchScaleModeConstants">
  635. UseInputImageScales</see>.
  636. </summary>
  637. <value>
  638. The default is 1.0.
  639. </value>
  640. <event cref="!:E:Cognex.VisionPro.ICogChangedEvent.Changed">
  641. Fires when the value of this property changes.
  642. </event>
  643. <exception cref="!:T:System.ArgumentOutOfRangeException">
  644. The supplied value must be greater than zero.
  645. </exception>
  646. </member>
  647. <member name="P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputImageYScale">
  648. <summary>
  649. The Y scale factor to use when generating the output range image.
  650. Ignored when
  651. <see cref="!:P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputImageScaleMode" />
  652. is
  653. <see cref="!:T:Cognex.VisionPro3D.Cog3DVisionDataStitchScaleModeConstants">
  654. UseInputImageScales</see>.
  655. </summary>
  656. <value>
  657. The default is 1.0.
  658. </value>
  659. <event cref="!:E:Cognex.VisionPro.ICogChangedEvent.Changed">
  660. Fires when the value of this property changes.
  661. </event>
  662. <exception cref="!:T:System.ArgumentOutOfRangeException">
  663. The supplied value must be greater than zero.
  664. </exception>
  665. </member>
  666. <member name="P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputImageXScale">
  667. <summary>
  668. The X scale factor to use when generating the output range image.
  669. Ignored when
  670. <see cref="!:P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputImageScaleMode" />
  671. is
  672. <see cref="!:T:Cognex.VisionPro3D.Cog3DVisionDataStitchScaleModeConstants">
  673. UseInputImageScales</see>.
  674. </summary>
  675. <value>
  676. The default is 1.0.
  677. </value>
  678. <event cref="!:E:Cognex.VisionPro.ICogChangedEvent.Changed">
  679. Fires when the value of this property changes.
  680. </event>
  681. <exception cref="!:T:System.ArgumentOutOfRangeException">
  682. The supplied value must be greater than zero.
  683. </exception>
  684. </member>
  685. <member name="P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputImageScaleMode">
  686. <summary>
  687. How to scale the output range image. This controls the resolution
  688. of the output range image. There are two defined modes:
  689. <see cref="!:T:Cognex.VisionPro3D.Cog3DVisionDataStitchScaleModeConstants">
  690. UseXYZScales</see> and
  691. <see cref="!:T:Cognex.VisionPro3D.Cog3DVisionDataStitchScaleModeConstants">
  692. UseInputImageScales</see>.
  693. </summary>
  694. <value>
  695. The default is
  696. <see cref="!:T:Cognex.VisionPro3D.Cog3DVisionDataStitchScaleModeContants">
  697. UseInputImageSclaes</see></value>
  698. <event cref="!:E:Cognex.VisionPro.ICogChangedEvent.Changed">
  699. Fires when the value of this property changes.
  700. </event>
  701. <exception cref="!:T:System.ArgumentException">
  702. The supplied value is not a member of
  703. <see cref="!:T:Cognex.VisionPro3D.Cog3DVisionDataStitchScaleModeConstants" /></exception>
  704. </member>
  705. <member name="P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputEnable">
  706. <summary>
  707. Specify the desired ouputput by bitwise ORing the appropriate
  708. <see cref="!:T:Cognex.VisionPro3D.Cog3DVisionDataStitchOutputConstants" />.
  709. </summary>
  710. <event cref="!:E:Cognex.VisionPro.ICogChangedEvent.Changed">
  711. Fires when the value of this property changes.
  712. </event>
  713. <value>
  714. The default is
  715. <see cref="!:T:Cognex.VisionPro3D.Cog3DVisionDataStitchOutputContants">
  716. Range</see></value>
  717. </member>
  718. <member name="P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputSpaceName3D">
  719. <summary>
  720. The name of the 3D space in which the output range image will be
  721. rendered. The
  722. <see cref="!:M:Cognex.VisionPro3D.Cog3DVisionDataStitch.Execute" />
  723. method will throw an ArgumentException if this space name does not
  724. exist within the 3D coordinate space tree of the specified
  725. range image.
  726. </summary>
  727. <event cref="!:E:Cognex.VisionPro.ICogChangedEvent.Changed">
  728. Fires when the value of this property changes.
  729. </event>
  730. <exception cref="!:T:System.ArgumentNullException">
  731. The supplied value is null.
  732. </exception>
  733. </member>
  734. <member name="P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputSpaceSource">
  735. <summary>
  736. <para>
  737. The dictionary key of the input range image whose 3D coordinate
  738. space tree holds the desired output space. In the case of input
  739. range / greyscale image pairs, this is the key of the nested
  740. container that in turn holds the range image whose 3D coordinate
  741. space tree holds the desired output space. The
  742. <see cref="!:M:Cognex.VisionPro3D.Cog3DVisionDataStitch.Execute" />
  743. method will throw an ArgumentException if this dictionary key
  744. does not exist within the input
  745. <see cref="!:T:Cognex.VisionPro.CogVisionDataContainer" />.
  746. </para>
  747. <para>
  748. When set to an empty string, this parameter is treated specially.
  749. An empty string is interpreted to mean that we will use
  750. an arbitrarily chosen input range image as the source of the
  751. output space. This may be usefull when the output space is defined
  752. in all input images.
  753. </para>
  754. </summary>
  755. <event cref="!:E:Cognex.VisionPro.ICogChangedEvent.Changed">
  756. Fires when the value of this property changes.
  757. </event>
  758. <exception cref="!:T:System.ArgumentNullException">
  759. The supplied value is null.
  760. </exception>
  761. </member>
  762. <member name="P:Cognex.VisionPro3D.Cog3DVisionDataStitch.SharedSpaceName3D">
  763. <summary>
  764. The name of the 3D space shared by all input range images. The
  765. <see cref="!:M:Cognex.VisionPro3D.Cog3DVisionDataStitch.Execute" />
  766. method will throw an ArgumentException if this space name
  767. does not exist in the 3D coordinate space tree of every input
  768. range image.
  769. </summary>
  770. <event cref="!:E:Cognex.VisionPro.ICogChangedEvent.Changed">
  771. Fires when the value of this property changes.
  772. </event>
  773. <exception cref="!:T:System.ArgumentNullException">
  774. The supplied value is null.
  775. </exception>
  776. </member>
  777. <member name="M:Cognex.VisionPro3D.Cog3DVisionDataStitch.#ctor(Cognex.VisionPro3D.Cog3DVisionDataStitch)">
  778. <summary>
  779. Constructs a new instance of this class as a deep copy of
  780. the given instance.
  781. </summary>
  782. <param name="Other">
  783. The Cog3DVisionDataStitch object to be copied. May not be null.
  784. </param>
  785. <exception cref="!:T:System.ArgumentNullException">
  786. If the input argument is null.
  787. </exception>
  788. </member>
  789. <member name="M:Cognex.VisionPro3D.Cog3DVisionDataStitch.#ctor">
  790. <summary>
  791. Constructs a new instance of this class.
  792. </summary>
  793. </member>
  794. <member name="M:Cognex.VisionPro3D.Cog3DVisionDataStitch.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  795. <summary>
  796. Serialization constructor for Cog3DVisionDataStitch object.
  797. </summary>
  798. <param name="Info">
  799. The standard SerializationInfo argument.
  800. </param>
  801. <param name="Ctxt">
  802. The standard StreamingContext argument.
  803. </param>
  804. </member>
  805. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitch.SfOutputImageOverlapPriorities">
  806. <summary>
  807. This bit will be set in the EventArgs of a Changed event
  808. every time the value returned by OutputImageOverlapPriorities
  809. may have changed.
  810. </summary>
  811. </member>
  812. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitch.SfOutputImageOverlapMode">
  813. <summary>
  814. This bit will be set in the EventArgs of a Changed event
  815. every time the value returned by OutputImageOverlapMode
  816. may have changed.
  817. </summary>
  818. </member>
  819. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitch.SfOutputImageZConsistencyDistance">
  820. <summary>
  821. This bit will be set in the EventArgs of a Changed event
  822. every time the value returned by OutputImageZConsistencyDistance
  823. may have changed.
  824. </summary>
  825. </member>
  826. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitch.SfOutputImageZContinuityThreshold">
  827. <summary>
  828. This bit will be set in the EventArgs of a Changed event
  829. every time the value returned by OutputImageZContinuityThreshold
  830. may have changed.
  831. </summary>
  832. </member>
  833. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitch.SfOutputImageZContinuityThresholdEnabled">
  834. <summary>
  835. This bit will be set in the EventArgs of a Changed event
  836. every time the value returned by
  837. OutputImageZContinuityThresholdEnabled may have
  838. changed.
  839. </summary>
  840. </member>
  841. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitch.SfOutputImageZMin">
  842. <summary>
  843. This bit will be set in the EventArgs of a Changed event
  844. every time the value returned by OutputImageZMin
  845. may have changed.
  846. </summary>
  847. </member>
  848. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitch.SfOutputImageZMode">
  849. <summary>
  850. This bit will be set in the EventArgs of a Changed event
  851. every time the value returned by OutputImageZMode
  852. may have changed.
  853. </summary>
  854. </member>
  855. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitch.SfOutputImageYMax">
  856. <summary>
  857. This bit will be set in the EventArgs of a Changed event
  858. every time the value returned by OutputImageYMax
  859. may have changed.
  860. </summary>
  861. </member>
  862. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitch.SfOutputImageYMin">
  863. <summary>
  864. This bit will be set in the EventArgs of a Changed event
  865. every time the value returned by OutputImageYMin
  866. may have changed.
  867. </summary>
  868. </member>
  869. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitch.SfOutputImageXMax">
  870. <summary>
  871. This bit will be set in the EventArgs of a Changed event
  872. every time the value returned by OutputImageXMax
  873. may have changed.
  874. </summary>
  875. </member>
  876. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitch.SfOutputImageXMin">
  877. <summary>
  878. This bit will be set in the EventArgs of a Changed event
  879. every time the value returned by OutputImageXMin
  880. may have changed.
  881. </summary>
  882. </member>
  883. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitch.SfOutputImageXYMode">
  884. <summary>
  885. This bit will be set in the EventArgs of a Changed event
  886. every time the value returned by OutputImageXYMode
  887. may have changed.
  888. </summary>
  889. </member>
  890. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitch.SfOutputImageZScale">
  891. <summary>
  892. This bit will be set in the EventArgs of a Changed event
  893. every time the value returned by OutputImageZScale
  894. may have changed.
  895. </summary>
  896. </member>
  897. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitch.SfOutputImageYScale">
  898. <summary>
  899. This bit will be set in the EventArgs of a Changed event
  900. every time the value returned by OutputImageYScale
  901. may have changed.
  902. </summary>
  903. </member>
  904. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitch.SfOutputImageXScale">
  905. <summary>
  906. This bit will be set in the EventArgs of a Changed event
  907. every time the value returned by OutputImageXScale
  908. may have changed.
  909. </summary>
  910. </member>
  911. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitch.SfOutputImageScaleMode">
  912. <summary>
  913. This bit will be set in the EventArgs of a Changed event
  914. every time the value returned by OutputImageScaleMode
  915. may have changed.
  916. </summary>
  917. </member>
  918. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitch.SfOutputEnable">
  919. <summary>
  920. This bit will be set in the EventArgs of a Changed event
  921. every time the value returned by OutputEnable
  922. may have changed.
  923. </summary>
  924. </member>
  925. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitch.SfOutputSpaceName3D">
  926. <summary>
  927. This bit will be set in the EventArgs of a Changed event
  928. every time the value returned by OutputSpaceName3D
  929. may have changed.
  930. </summary>
  931. </member>
  932. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitch.SfOutputSpaceSource">
  933. <summary>
  934. This bit will be set in the EventArgs of a Changed event
  935. every time the value returned by OutputSpaceSource
  936. may have changed.
  937. </summary>
  938. </member>
  939. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitch.SfSharedSpaceName3D">
  940. <summary>
  941. This bit will be set in the EventArgs of a Changed event
  942. every time the value returned by SharedSpaceName3D
  943. may have changed.
  944. </summary>
  945. </member>
  946. <member name="T:Cognex.VisionPro3D.Cog3DVisionDataStitch">
  947. <summary>
  948. An operator for stitching together three dimensional vision data into
  949. a single result in a user-specified space.
  950. </summary>
  951. </member>
  952. <member name="T:Cognex.VisionPro3D.Cog3DVisionDataStitchOverlapModeConstants">
  953. <summary>
  954. How input pixels that overlap in X and Y will be processed to
  955. produce an output pixel value.
  956. </summary>
  957. </member>
  958. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitchOverlapModeConstants.Priority">
  959. <summary>
  960. Select the overlapping visible range image value from the
  961. image with the numerically lowest priority value,
  962. as specified in the OutputImageOverlapPriorities parameter.
  963. </summary>
  964. </member>
  965. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitchOverlapModeConstants.NearestImageCenter">
  966. <summary>
  967. Use the overlapping visible range image value from the
  968. image with the closest center.
  969. </summary>
  970. </member>
  971. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitchOverlapModeConstants.MinZ">
  972. <summary>
  973. Use the minimum of the input values.
  974. </summary>
  975. </member>
  976. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitchOverlapModeConstants.MaxZ">
  977. <summary>
  978. Use the maximum of the input values.
  979. </summary>
  980. </member>
  981. <member name="T:Cognex.VisionPro3D.Cog3DVisionDataStitchZModeConstants">
  982. <summary>
  983. How to handle the Z values of the output range image.
  984. </summary>
  985. </member>
  986. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitchZModeConstants.Auto">
  987. <summary>
  988. A ZMin value will be automatically computed from the input images by
  989. mapping image Z = 0 corner points into output space and taking the
  990. miniumum mapped Z value.
  991. </summary>
  992. </member>
  993. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitchZModeConstants.UseZMin">
  994. <summary>
  995. The
  996. <see cref="!:P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputImageZMin" />
  997. parameter will be the output space Z that corresponds to a minimum
  998. output voxel value. Any output voxel at or below the voxel pierced
  999. by the specified output space Z value will be set to this value.
  1000. </summary>
  1001. </member>
  1002. <member name="T:Cognex.VisionPro3D.Cog3DVisionDataStitchXYModeConstants">
  1003. <summary>
  1004. How to define the XY bounds of
  1005. <see cref="!:T:Cognex.VisionPro3D.Cot3DVisionDataStitch" />'s
  1006. output image.
  1007. </summary>
  1008. </member>
  1009. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitchXYModeConstants.Auto">
  1010. <summary>
  1011. Automatically size the output range image in X and Y to contain the
  1012. bounding corners (at image Z = 0 and at image Z = 64K) of the input
  1013. images.
  1014. </summary>
  1015. </member>
  1016. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitchXYModeConstants.Limit">
  1017. <summary>
  1018. Clip the output in X and Y according to
  1019. <see cref="!:P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputImageXMin" />,
  1020. <see cref="!:P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputImageXMax" />.
  1021. <see cref="!:P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputImageYMin" />,
  1022. and
  1023. <see cref="!:P:Cognex.VisionPro3D.Cog3DVisionDataStitch.OutputImageYMax" />.
  1024. </summary>
  1025. </member>
  1026. <member name="T:Cognex.VisionPro3D.Cog3DVisionDataStitchScaleModeConstants">
  1027. <summary>
  1028. How the <see cref="!:T:Cognex.VisionPro3D.Cog3DVisionDataStitch" /> will
  1029. scale the result.
  1030. </summary>
  1031. </member>
  1032. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitchScaleModeConstants.UseInputImageScales">
  1033. <summary>
  1034. If all input range images have identical X scale values, and they
  1035. all have identical Y scale values, and they all have identical
  1036. Z scale values, then use those same scale values in the output
  1037. range image. Otherwise throw an ArgumentException.
  1038. </summary>
  1039. </member>
  1040. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitchScaleModeConstants.UseXYZScales">
  1041. <summary>
  1042. Always use the specified X, Y, and Z scale values to generate
  1043. the output.
  1044. </summary>
  1045. </member>
  1046. <member name="T:Cognex.VisionPro3D.Cog3DVisionDataStitchOutputConstants">
  1047. <summary>
  1048. What outputs will be generated by a call to
  1049. <see cref="!:M:Cognex.VisionPro3D.Cog3DVisionDataStitch.Execute(Cognex.VisionPro.CogVisionDataContainer)" />.
  1050. </summary>
  1051. </member>
  1052. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitchOutputConstants.Grey">
  1053. <summary>
  1054. Produce a <see cref="!:T:Cognex.VisionPro.CogImage16Grey" />
  1055. as part of the output. This will require that the input
  1056. include appropriate greyscale images.
  1057. </summary>
  1058. </member>
  1059. <member name="F:Cognex.VisionPro3D.Cog3DVisionDataStitchOutputConstants.Range">
  1060. <summary>
  1061. Produce a <see cref="!:T:Cognex.VisionPro.CogImage16Range" />
  1062. as part of the output.
  1063. </summary>
  1064. </member>
  1065. <member name="M:Cognex.VisionPro3D.Cog3DVisionDataStitchResult.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  1066. <summary>
  1067. Serialization construct a Cog3DVisionDataStitchResult object.
  1068. </summary>
  1069. <param name="Info">
  1070. The standard SerializationInfo argument.
  1071. </param>
  1072. <param name="Ctxt">
  1073. The standard StreamingContext argument.
  1074. </param>
  1075. </member>
  1076. <member name="P:Cognex.VisionPro3D.Cog3DVisionDataStitchResult.VisionData">
  1077. <summary>
  1078. This will always point to all of the rendered data. So if you
  1079. requested just Range output, this will point to the RangeImage
  1080. property. If you request just Grey output, this will point to
  1081. the GreyImage property. And if you requested both Range and
  1082. Grey output, this will point to a CogVisionDataContainer
  1083. object holding both the range and the grey output.
  1084. </summary>
  1085. </member>
  1086. <member name="P:Cognex.VisionPro3D.Cog3DVisionDataStitchResult.GreyImage">
  1087. <summary>
  1088. The stitched grey image. This will be null if Grey
  1089. output was not requested.
  1090. </summary>
  1091. </member>
  1092. <member name="P:Cognex.VisionPro3D.Cog3DVisionDataStitchResult.RangeImage">
  1093. <summary>
  1094. The stitched range image. This will be null if Range
  1095. output was not requested.
  1096. </summary>
  1097. </member>
  1098. <member name="M:Cognex.VisionPro3D.Cog3DVisionDataStitchResult.#ctor(Cognex.VisionPro3D.Cog3DVisionDataStitchResult)">
  1099. <summary>
  1100. Copy construct a Cog3DVisionDataStitchResult object. This
  1101. is a shallow copy.
  1102. </summary>
  1103. <param name="Other">
  1104. The Cog3DVisionDataStitchResult object to be copied.
  1105. </param>
  1106. <exception cref="!:T:System.ArgumentNullException">
  1107. If Other is null.
  1108. </exception>
  1109. </member>
  1110. <member name="T:Cognex.VisionPro3D.Cog3DVisionDataStitchResult">
  1111. <summary>
  1112. This is the result produced by a call to the
  1113. Execute method of the Cog3DVisionDataStitch class.
  1114. </summary>
  1115. </member>
  1116. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointCircle.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  1117. <summary>
  1118. Serialization constructor for Cog3DRangeImageCrossSectionPointCircle
  1119. object.
  1120. </summary>
  1121. <param name="Info">
  1122. The standard SerializationInfo argument.
  1123. </param>
  1124. <param name="Ctxt">
  1125. The standard StreamingContext argument.
  1126. </param>
  1127. </member>
  1128. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointCircle.Execute(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile)">
  1129. <summary>
  1130. Returns the point of the circle
  1131. </summary>
  1132. <param name="profile">
  1133. The point is computed in the profile selected space name.
  1134. </param>
  1135. <exception cref="T:Cognex.VisionPro.Exceptions.CogSecurityViolationException">
  1136. If licensing for this class cannot be confirmed.
  1137. </exception>
  1138. <exception cref="T:System.ArgumentNullException">
  1139. If the operator is not in a collection.
  1140. </exception>
  1141. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  1142. <para>Fires when this method is called.</para>
  1143. <para>The following state flag may be affected:</para>
  1144. <list type="bullet">
  1145. <item>SfStatus</item>
  1146. <item>SfPoint</item>
  1147. <item>SfPointInImage</item>
  1148. <item>SfPointInImage3D</item>
  1149. </list>
  1150. </event>
  1151. <remarks>
  1152. <para>
  1153. The status returned can be one of the following:
  1154. <list type="bullet"><item> The point was computed successfully and passed any enabled tolerance checking.
  1155. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">Passed</see></item><item> The point was computed successfully but failed tolerance checking.
  1156. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">FailedTolerance </see></item><item> The operator failed.
  1157. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">FailedToCompute</see></item><item> The line segment was not found in the collection at run time.
  1158. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">InputFeatureMissing </see></item></list></para>
  1159. </remarks>
  1160. </member>
  1161. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointCircle.ClearResults">
  1162. <summary>
  1163. Clear the results' properties of this class.
  1164. </summary>
  1165. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  1166. <para>Fires when this method is called.</para>
  1167. <para>The following state flag may be affected:</para>
  1168. <list type="bullet">
  1169. <para>SfStatus</para>
  1170. <para>SfPoint</para>
  1171. <para>SfPointInImage</para>
  1172. <para>SfPointInImage3D</para>
  1173. </list>
  1174. </event>
  1175. </member>
  1176. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointCircle.CreateResultGraphics(Cognex.VisionPro.CogGraphicCollection,System.Boolean)">
  1177. <summary>
  1178. Create the graphics and add them to the graphicCollection provided.
  1179. </summary>
  1180. <param name="graphicCollection">
  1181. A constructed CogGraphicCollection.
  1182. </param>
  1183. <param name="lastRun">
  1184. If lastRun is true, do not include the input graphics.
  1185. </param>
  1186. <remarks>
  1187. The input graphics are the regions of extracted line segment.
  1188. The output graphic is the point graphic.
  1189. </remarks>
  1190. </member>
  1191. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointCircle.SetCircleUsingOperator(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams,Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase)">
  1192. <summary>
  1193. Sets the name of the operator producing Circle.
  1194. </summary>
  1195. <param name="parentCollection">
  1196. The Cog3DRangeImageCrossSectionOperatorsParams collection that holds the
  1197. line segment operator.
  1198. </param>
  1199. <param name="op">
  1200. The operator object producing Circle.
  1201. </param>
  1202. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  1203. <para>Fires when this method is called.</para>
  1204. <para>The following state flag may be affected:</para>
  1205. <list type="bullet">
  1206. <item>SfCircle</item>
  1207. </list>
  1208. </event>
  1209. <remarks>
  1210. This is a convenience setter for programmatic users to specify
  1211. the line segment using the operator's object.
  1212. The operator is not held internally, it is used to extract
  1213. the internal unique id of the operator. The id is used
  1214. by this operator at run time.
  1215. </remarks>
  1216. <remarks>
  1217. The method can be called before the operator is
  1218. added to the collection.
  1219. </remarks>
  1220. <exception cref="T:System.ArgumentException">
  1221. If operator is not found
  1222. in the parentCollection provided.
  1223. </exception>
  1224. <exception cref="T:System.ArgumentNullException">
  1225. If the parentCollection in null.
  1226. </exception>
  1227. </member>
  1228. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointCircle.PointInImage3D">
  1229. <summary>
  1230. Gets the point computed by the execute method.
  1231. Always check the status of the operator to be either Passed or FailedTolerance before calling the getter.
  1232. </summary>
  1233. <remarks>
  1234. The point is in the SelectedSpaceName3D of the range image
  1235. stored in the profile.
  1236. </remarks>
  1237. <exception cref="T:System.ArgumentException">
  1238. If the point was not computed.
  1239. The Cog3DVect3 is a ValueType and cannot return a null.
  1240. </exception>
  1241. </member>
  1242. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointCircle.PointInImage">
  1243. <summary>
  1244. Gets the point computed by the execute method.
  1245. </summary>
  1246. <remarks>
  1247. The point is in the SelectedSpaceName of the range image
  1248. stored in the profile.
  1249. Returns null if the point was not computed.
  1250. </remarks>
  1251. </member>
  1252. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointCircle.Point">
  1253. <summary>
  1254. Gets the point computed by the execute method.
  1255. </summary>
  1256. <remarks>
  1257. The point is in the ProfileSelectedSpaceName.
  1258. Returns null if the point was not computed.
  1259. </remarks>
  1260. </member>
  1261. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointCircle.Circle">
  1262. <summary>
  1263. Gets or sets the name of the operator producing Circle.
  1264. </summary>
  1265. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  1266. <para>Fires when this property changes.</para>
  1267. <para>The following state flag may be affected:</para>
  1268. <list type="bullet">
  1269. <item>SfCircle</item>
  1270. </list>
  1271. </event>
  1272. <remarks>
  1273. The property is a link between the operator producing the line segment and this operator, and
  1274. therefore requires that all operators are added to the collection before it can be called.
  1275. The name of the operator is not held internally. It is used to extract
  1276. the internal unique id of the operator within the collection.
  1277. </remarks>
  1278. <exception cref="T:System.ArgumentNullException">
  1279. If the operator is not in a collection.
  1280. </exception>
  1281. <exception cref="T:System.ArgumentException">
  1282. If the name of the operator producing Circle is not found
  1283. in the collection.
  1284. </exception>
  1285. </member>
  1286. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointCircle.YTolerance">
  1287. <summary>
  1288. Gets the Cog3DRangeImageCrossSectionTolerance object to
  1289. tolerance the Y position.
  1290. </summary>
  1291. <remarks>
  1292. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Min" /> and
  1293. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Max" /> values are specified in profile selected space name.
  1294. If the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Enabled" /> property is set to true, the tolerance
  1295. check will be performed at run time.
  1296. </remarks>
  1297. </member>
  1298. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointCircle.XTolerance">
  1299. <summary>
  1300. Gets the Cog3DRangeImageCrossSectionTolerance object to
  1301. tolerance the X position.
  1302. </summary>
  1303. <remarks>
  1304. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Min" /> and
  1305. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Max" /> values are specified in profile selected space name.
  1306. If the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Enabled" /> property is set to true, the tolerance
  1307. check will be performed at run time.
  1308. </remarks>
  1309. </member>
  1310. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointCircle.Finalize">
  1311. <summary>
  1312. Finalize this Cog3DRangeImageCrossSectionPointCircle.
  1313. </summary>
  1314. </member>
  1315. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointCircle.Dispose">
  1316. <summary>
  1317. Destruct this Cog3DRangeImageCrossSectionPointCircle.
  1318. </summary>
  1319. </member>
  1320. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointCircle.#ctor(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointCircle)">
  1321. <summary>
  1322. Construct a deep copy of the supplied
  1323. Cog3DRangeImageCrossSectionPointCircle object.
  1324. </summary>
  1325. <param name="other">
  1326. The Cog3DRangeImageCrossSectionPointCircle object to be copied.
  1327. </param>
  1328. <exception cref="T:System.ArgumentNullException">
  1329. If the supplied argument is null.
  1330. </exception>
  1331. <remarks>
  1332. The copy constructor is meant to be used with the collection
  1333. copy constructor.
  1334. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointCircle.Circle" /> property
  1335. refer to
  1336. internal id within the <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams">operators</see> collection and
  1337. its value is meaningless outside a collection.
  1338. </remarks>
  1339. </member>
  1340. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointCircle.#ctor">
  1341. <summary>
  1342. Construct a default Cog3DRangeImageCrossSectionPointCircle object.
  1343. </summary>
  1344. </member>
  1345. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointCircle.SfNextSf">
  1346. <summary>
  1347. NextSf state flag.
  1348. </summary>
  1349. </member>
  1350. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointCircle.SfPointInImage3D">
  1351. <summary>
  1352. This bit will be set in the EventArgs of a Changed event every time
  1353. the value returned by PointInImage3D may have changed.
  1354. </summary>
  1355. </member>
  1356. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointCircle.SfPointInImage">
  1357. <summary>
  1358. This bit will be set in the EventArgs of a Changed event every time
  1359. the value returned by PointInImage may have changed.
  1360. </summary>
  1361. </member>
  1362. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointCircle.SfPoint">
  1363. <summary>
  1364. This bit will be set in the EventArgs of a Changed event every time
  1365. the value returned by Point may have changed.
  1366. </summary>
  1367. </member>
  1368. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointCircle.SfCircle">
  1369. <summary>
  1370. This bit will be set in the EventArgs of a Changed event every time
  1371. the value returned by Circle may have changed.
  1372. </summary>
  1373. </member>
  1374. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointCircle">
  1375. <summary>
  1376. The class to return a point of a circle
  1377. This operator must be added to the <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams">operators</see> collection before it
  1378. is configured. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointCircle.Circle" />
  1379. property hold the internal id of the operator producing the circle,
  1380. and the operator must also be in the operators collection.
  1381. </summary>
  1382. </member>
  1383. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCircleFit.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  1384. <summary>
  1385. Serialization constructor for Cog3DRangeImageCrossSectionExtractCircleFit
  1386. object.
  1387. </summary>
  1388. <param name="Info">
  1389. The standard SerializationInfo argument.
  1390. </param>
  1391. <param name="Ctxt">
  1392. The standard StreamingContext argument.
  1393. </param>
  1394. </member>
  1395. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCircleFit.Execute(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile)">
  1396. <summary>
  1397. Extracts a circle.
  1398. </summary>
  1399. <param name="profile">
  1400. The circle is extracted and reported in the profile selected space name.
  1401. </param>
  1402. <exception cref="T:Cognex.VisionPro.Exceptions.CogSecurityViolationException">
  1403. If licensing for this class cannot be confirmed.
  1404. </exception>
  1405. <exception cref="T:System.ArgumentException">
  1406. If the regions selected space name was not found in the profile space tree.
  1407. </exception>
  1408. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  1409. <para>Fires when this method is called.</para>
  1410. <para>The following state flag may be affected:</para>
  1411. <list type="bullet">
  1412. <item>SfStatus</item>
  1413. <item>SfCircle</item>
  1414. <item>SfCircleInImage</item>
  1415. <item>SfCircleInImage3D</item>
  1416. </list>
  1417. </event>
  1418. <remarks>
  1419. <para>
  1420. The status returned can be one of the following:
  1421. <list type="bullet"><item> The circle was extracted successfully and passed any enabled tolerance checking.
  1422. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">Passed</see></item><item> The circle was extracted successfully but failed tolerance checking
  1423. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">FailedTolerance </see></item><item> The circle was not extracted because because not enough points were found to extract the line.
  1424. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">FeatureNoExtracted </see></item></list></para>
  1425. </remarks>
  1426. </member>
  1427. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCircleFit.ClearResults">
  1428. <summary>
  1429. Clear the results' properties of this class.
  1430. </summary>
  1431. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  1432. <para>Fires when this method is called.</para>
  1433. <para>The following state flag may be affected:</para>
  1434. <list type="bullet">
  1435. <para>SfRMSError</para>
  1436. <para>SfCircle</para>
  1437. <para>SfCircleInImage</para>
  1438. <para>SfCircleInImage3D</para>
  1439. </list>
  1440. </event>
  1441. </member>
  1442. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCircleFit.CreateResultGraphics(Cognex.VisionPro.CogGraphicCollection,System.Boolean)">
  1443. <summary>
  1444. Create the graphics and add them to the graphicCollection provided.
  1445. </summary>
  1446. <param name="graphicCollection">
  1447. A constructed CogGraphicCollection.
  1448. </param>
  1449. <param name="lastRun">
  1450. If lastRun is true, do not include the input graphics.
  1451. </param>
  1452. <remarks>
  1453. The input graphics are the regions.
  1454. The output graphic is the circle graphic.
  1455. </remarks>
  1456. </member>
  1457. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCircleFit.RadiusTolerance">
  1458. <summary>
  1459. Gets the <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance">Cog3DRangeImageCrossSectionTolerance</see> object to
  1460. tolerance the Radius.
  1461. </summary>
  1462. <remarks>
  1463. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Min" /> and
  1464. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Max" /> values are specified in profile selected space name.
  1465. If the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Enabled" /> property is set to true, the tolerance
  1466. check will be performed at run time.
  1467. </remarks>
  1468. </member>
  1469. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCircleFit.CenterYTolerance">
  1470. <summary>
  1471. Gets the <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance">Cog3DRangeImageCrossSectionTolerance</see> object to
  1472. tolerance the CenterY position.
  1473. </summary>
  1474. <remarks>
  1475. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Min" /> and
  1476. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Max" /> values are specified in profile selected space name.
  1477. If the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Enabled" /> property is set to true, the tolerance
  1478. check will be performed at run time.
  1479. </remarks>
  1480. </member>
  1481. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCircleFit.CenterXTolerance">
  1482. <summary>
  1483. Gets the <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance">Cog3DRangeImageCrossSectionTolerance</see> object to
  1484. tolerance the CenterX position.
  1485. </summary>
  1486. <remarks>
  1487. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Min" /> and
  1488. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Max" /> values are specified in profile selected space name.
  1489. If the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Enabled" /> property is set to true, the tolerance
  1490. check will be performed at run time.
  1491. </remarks>
  1492. </member>
  1493. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCircleFit.RMSTolerance">
  1494. <summary>
  1495. Gets the <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance">Cog3DRangeImageCrossSectionTolerance</see> object for
  1496. the RMS error.
  1497. </summary>
  1498. <remarks>
  1499. If the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Enabled" /> property is set to true, the tolerance
  1500. check will be performed at run time.
  1501. </remarks>
  1502. </member>
  1503. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCircleFit.RMSError">
  1504. <summary>
  1505. Gets the RMS error of the circle.
  1506. </summary>
  1507. <remarks>
  1508. RMS is the root mean squared perpendicular error between
  1509. the line and all of the points in the user specified region
  1510. </remarks>
  1511. </member>
  1512. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCircleFit.CircleInImage3D">
  1513. <summary>
  1514. Gets the circle extracted by the execute method. Note that the circle is seen as a LineSegment in the image.
  1515. </summary>
  1516. <remarks>
  1517. The circle is in the SelectedSpaceName3D of the range image
  1518. stored in the profile.
  1519. Return null is the circle was not computed.
  1520. </remarks>
  1521. </member>
  1522. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCircleFit.CircleInImage">
  1523. <summary>
  1524. Gets the circle extracted by the execute method. Note that the circle is seen as a LineSegment in the image.
  1525. </summary>
  1526. <remarks>
  1527. The circle is in the SelectedSpaceName of the range image
  1528. stored in the profile.
  1529. Return null is the circle was not computed.
  1530. </remarks>
  1531. </member>
  1532. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCircleFit.Circle">
  1533. <summary>
  1534. Gets the circle extracted by the execute method.
  1535. Always check the status of the operator to be either Passed or FailedTolerance before calling the getter.
  1536. </summary>
  1537. <remarks>
  1538. The circle is in the ProfileSelectedSpaceName.
  1539. Return null is the circle was not computed.
  1540. </remarks>
  1541. </member>
  1542. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCircleFit.Finalize">
  1543. <summary>
  1544. Finalize this Cog3DRangeImageCrossSectionExtractCircleFit.
  1545. </summary>
  1546. </member>
  1547. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCircleFit.Dispose">
  1548. <summary>
  1549. Destruct this Cog3DRangeImageCrossSectionExtractCircleFit.
  1550. </summary>
  1551. </member>
  1552. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCircleFit.#ctor(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCircleFit)">
  1553. <summary>
  1554. Construct a deep copy of the supplied
  1555. Cog3DRangeImageCrossSectionExtractCircleFit object.
  1556. </summary>
  1557. <param name="other">
  1558. The Cog3DRangeImageCrossSectionExtractCircleFit object to be copied.
  1559. </param>
  1560. <exception cref="T:System.ArgumentNullException">
  1561. If the supplied argument is null.
  1562. </exception>
  1563. </member>
  1564. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCircleFit.#ctor">
  1565. <summary>
  1566. Construct a default Cog3DRangeImageCrossSectionExtractCircleFit object.
  1567. </summary>
  1568. </member>
  1569. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCircleFit.SfNextSf">
  1570. <summary>
  1571. NextSf state flag.
  1572. </summary>
  1573. </member>
  1574. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCircleFit.SfCircleInImage3D">
  1575. <summary>
  1576. This bit will be set in the EventArgs of a Changed event every time
  1577. the value returned by CircleInImage3D may have changed.
  1578. </summary>
  1579. </member>
  1580. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCircleFit.SfCircleInImage">
  1581. <summary>
  1582. This bit will be set in the EventArgs of a Changed event every time
  1583. the value returned by CircleInImage may have changed.
  1584. </summary>
  1585. </member>
  1586. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCircleFit.SfCircle">
  1587. <summary>
  1588. This bit will be set in the EventArgs of a Changed event every time
  1589. the value returned by Circle may have changed.
  1590. </summary>
  1591. </member>
  1592. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCircleFit.SfRMSError">
  1593. <summary>
  1594. This bit will be set in the EventArgs of a Changed event every time
  1595. the value returned by RMSError may have changed.
  1596. </summary>
  1597. </member>
  1598. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCircleFit">
  1599. <summary>
  1600. The class to fit a circle on a profile points that are within the regions.
  1601. This operator holds a collection of regions. There must be always one region in the
  1602. collection. The user may add and delete any region as long as the count does not dip below 1.
  1603. NOTE: this is a circle fitter not a circle finder operator. It will fit a circle using the given point
  1604. and not try to find a circle on the given points
  1605. </summary>
  1606. </member>
  1607. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointAreaResult.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  1608. <summary>
  1609. Serialization constructor for Cog3DRangeImageCrossSectionPointAreaResult
  1610. object.
  1611. </summary>
  1612. <param name="Info">
  1613. The standard SerializationInfo argument.
  1614. </param>
  1615. <param name="Ctxt">
  1616. The standard StreamingContext argument.
  1617. </param>
  1618. </member>
  1619. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointAreaResult.Execute(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile)">
  1620. <summary>
  1621. Extracts a point.
  1622. </summary>
  1623. <param name="profile">
  1624. The point is extracted and reported in the profile selected space name.
  1625. </param>
  1626. <exception cref="T:Cognex.VisionPro.Exceptions.CogSecurityViolationException">
  1627. If licensing for this class cannot be confirmed.
  1628. </exception>
  1629. <exception cref="T:System.ArgumentException">
  1630. If the regions selected space name was not found in the profile space tree.
  1631. </exception>
  1632. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  1633. <para>Fires when this method is called.</para>
  1634. <para>The following state flag may be affected:</para>
  1635. <list type="bullet">
  1636. <item>SfStatus</item>
  1637. <item>SfPoint</item>
  1638. <item>SfPointInImage</item>
  1639. <item>SfPointInImage3D</item>
  1640. </list>
  1641. </event>
  1642. <remarks>
  1643. <para>
  1644. The status returned can be one of the following:
  1645. <list type="bullet"><item> The point was computed successfully and passed any enabled tolerance checking.
  1646. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">Passed</see></item><item> The point was computed successfully but failed tolerance checking.
  1647. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">FailedTolerance</see></item><item> The point was not computed (missing from the input AreaResult).
  1648. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">FeatureNotComputed</see></item><item> The input AreaResult is not available.
  1649. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">InputFeatureMissing</see></item></list></para>
  1650. </remarks>
  1651. </member>
  1652. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointAreaResult.ClearResults">
  1653. <summary>
  1654. Clear the results' properties of this class.
  1655. </summary>
  1656. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  1657. <para>Fires when this method is called.</para>
  1658. <para>The following state flag may be affected:</para>
  1659. <list type="bullet">
  1660. <para>SfPoint</para>
  1661. <para>SfPointInImage</para>
  1662. <para>SfPointInImage3D</para>
  1663. </list>
  1664. </event>
  1665. </member>
  1666. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointAreaResult.CreateResultGraphics(Cognex.VisionPro.CogGraphicCollection,System.Boolean)">
  1667. <summary>
  1668. Create the graphics and add them to the graphicCollection provided.
  1669. </summary>
  1670. <param name="graphicCollection">
  1671. A constructed CogGraphicCollection.
  1672. </param>
  1673. <param name="lastRun">
  1674. If lastRun is true, do not include the input graphics.
  1675. </param>
  1676. <remarks>
  1677. The input graphics are the regions.
  1678. The output graphic is the point graphic.
  1679. </remarks>
  1680. </member>
  1681. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointAreaResult.YTolerance">
  1682. <summary>
  1683. Gets the Cog3DRangeImageCrossSectionTolerance object to
  1684. tolerance the Y position.
  1685. </summary>
  1686. <remarks>
  1687. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Min" /> and
  1688. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Max" /> values are specified in profile selected space name.
  1689. If the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Enabled" /> property is set to true, the tolerance
  1690. check will be performed at run time.
  1691. </remarks>
  1692. </member>
  1693. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointAreaResult.XTolerance">
  1694. <summary>
  1695. Gets the Cog3DRangeImageCrossSectionTolerance object to
  1696. tolerance the X position.
  1697. </summary>
  1698. <remarks>
  1699. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Min" /> and
  1700. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Max" /> values are specified in profile selected space name.
  1701. If the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Enabled" /> property is set to true, the tolerance
  1702. check will be performed at run time.
  1703. </remarks>
  1704. </member>
  1705. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointAreaResult.PointInImage3D">
  1706. <summary>
  1707. Gets the point extracted by the execute method.
  1708. Always check the status of the operator to be either Passed or FailedTolerance before calling the getter.
  1709. </summary>
  1710. <remarks>
  1711. The point is in the SelectedSpaceName3D of the range image
  1712. stored in the profile.
  1713. </remarks>
  1714. <exception cref="T:System.ArgumentException">
  1715. If the corner was not computed.
  1716. The Cog3DVect3 is a ValueType and cannot return a null.
  1717. </exception>
  1718. </member>
  1719. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointAreaResult.PointInImage">
  1720. <summary>
  1721. Gets the point extracted by the execute method.
  1722. </summary>
  1723. <remarks>
  1724. The point is in the SelectedSpaceName of the range image
  1725. stored in the profile.
  1726. Returns null if the point was not computed.
  1727. </remarks>
  1728. </member>
  1729. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointAreaResult.Point">
  1730. <summary>
  1731. Gets the point extracted by the execute method.
  1732. </summary>
  1733. <remarks>
  1734. The point is in the ProfileSelectedSpaceName.
  1735. Returns null if the point was not computed.
  1736. </remarks>
  1737. </member>
  1738. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointAreaResult.PointType">
  1739. <summary>
  1740. Gets or sets the point type. Specifies the point to extract.
  1741. </summary>
  1742. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  1743. <para>Fires when this property changes.</para>
  1744. <para>The following state flag may be affected:</para>
  1745. <list type="bullet">
  1746. <item>SfPointType</item>
  1747. </list>
  1748. </event>
  1749. <exception cref="T:System.ArgumentException">
  1750. If the value is invalid.
  1751. </exception>
  1752. </member>
  1753. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointAreaResult.SetAreaResultUsingOperator(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams,Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase)">
  1754. <summary>
  1755. Sets the operator producing AreaResult.
  1756. </summary>
  1757. <param name="parentCollection">
  1758. The Cog3DRangeImageCrossSectionOperatorsParams collection that holds the
  1759. line segment operator.
  1760. </param>
  1761. <param name="op">
  1762. The operator object producing AreaResult.
  1763. </param>
  1764. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  1765. <para>Fires when this method is called.</para>
  1766. <para>The following state flag may be affected:</para>
  1767. <list type="bullet">
  1768. <item>SfArea</item>
  1769. </list>
  1770. </event>
  1771. <remarks>
  1772. This is a convenience setter for programmatic users to specify
  1773. the AreaResult using the operator's object.
  1774. The operator is not held internally, it is used to extract
  1775. the internal unique id of the operator. The id is used
  1776. by this operator at run time.
  1777. </remarks>
  1778. <remarks>
  1779. The method can be called before the operator is
  1780. added to the collection.
  1781. </remarks>
  1782. <exception cref="T:System.ArgumentException">
  1783. If operator is not found
  1784. in the parentCollection provided.
  1785. </exception>
  1786. <exception cref="T:System.ArgumentNullException">
  1787. If the parentCollection in null.
  1788. </exception>
  1789. </member>
  1790. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointAreaResult.Area">
  1791. <summary>
  1792. Gets or sets the name of the operator producing the <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaResult">AreaResult</see>.
  1793. </summary>
  1794. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  1795. <para>Fires when this property changes.</para>
  1796. <para>The following state flag may be affected:</para>
  1797. <list type="bullet">
  1798. <item>SfArea</item>
  1799. </list>
  1800. </event>
  1801. <remarks>
  1802. The property is a link between the operator producing the line segment and this operator, and
  1803. therefore requires that all operators are added to the collection before it can be called.
  1804. The name of the operator is not held internally. It is used to extract
  1805. the internal unique id of the operator within the collection.
  1806. </remarks>
  1807. <exception cref="T:System.ArgumentNullException">
  1808. If the operator is not in a collection.
  1809. </exception>
  1810. <exception cref="T:System.ArgumentException">
  1811. If the name of the operator producing AreaResult is not found
  1812. in the collection.
  1813. </exception>
  1814. </member>
  1815. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointAreaResult.Finalize">
  1816. <summary>
  1817. Finalize this Cog3DRangeImageCrossSectionPointAreaResult.
  1818. </summary>
  1819. </member>
  1820. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointAreaResult.Dispose">
  1821. <summary>
  1822. Destruct this Cog3DRangeImageCrossSectionPointAreaResult.
  1823. </summary>
  1824. </member>
  1825. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointAreaResult.#ctor(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointAreaResult)">
  1826. <summary>
  1827. Construct a deep copy of the supplied
  1828. Cog3DRangeImageCrossSectionPointAreaResult object.
  1829. </summary>
  1830. <param name="other">
  1831. The Cog3DRangeImageCrossSectionPointAreaResult object to be copied.
  1832. </param>
  1833. <exception cref="T:System.ArgumentNullException">
  1834. If the supplied argument is null.
  1835. </exception>
  1836. </member>
  1837. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointAreaResult.#ctor">
  1838. <summary>
  1839. Construct a default Cog3DRangeImageCrossSectionPointAreaResult object.
  1840. </summary>
  1841. </member>
  1842. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointAreaResult.SfNextSf">
  1843. <summary>
  1844. NextSf state flag.
  1845. </summary>
  1846. </member>
  1847. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointAreaResult.SfArea">
  1848. <summary>
  1849. This bit will be set in the EventArgs of a Changed event every time
  1850. the value returned by Area may have changed.
  1851. </summary>
  1852. </member>
  1853. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointAreaResult.SfPointInImage3D">
  1854. <summary>
  1855. This bit will be set in the EventArgs of a Changed event every time
  1856. the value returned by PointInImage3D may have changed.
  1857. </summary>
  1858. </member>
  1859. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointAreaResult.SfPointInImage">
  1860. <summary>
  1861. This bit will be set in the EventArgs of a Changed event every time
  1862. the value returned by PointInImage may have changed.
  1863. </summary>
  1864. </member>
  1865. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointAreaResult.SfPoint">
  1866. <summary>
  1867. This bit will be set in the EventArgs of a Changed event every time
  1868. the value returned by Point may have changed.
  1869. </summary>
  1870. </member>
  1871. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointAreaResult.SfPointType">
  1872. <summary>
  1873. This bit will be set in the EventArgs of a Changed event every time
  1874. the value returned by PointType may have changed.
  1875. </summary>
  1876. </member>
  1877. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointAreaResult">
  1878. <summary>
  1879. The class To get a point from the AreaResult object.
  1880. </summary>
  1881. </member>
  1882. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaLineSegments.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  1883. <summary>
  1884. Serialization constructor for Cog3DRangeImageCrossSectionAreaLineSegments
  1885. object.
  1886. </summary>
  1887. <param name="Info">
  1888. The standard SerializationInfo argument.
  1889. </param>
  1890. <param name="Ctxt">
  1891. The standard StreamingContext argument.
  1892. </param>
  1893. </member>
  1894. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaLineSegments.CreateResultInputGraphics(Cognex.VisionPro.CogGraphicCollection,System.String,System.String,Cognex.VisionPro.CogTransform2DLinear)">
  1895. <summary>
  1896. Create the input graphics and add them to the graphicCollection provided..
  1897. </summary>
  1898. <param name="graphicCollection">
  1899. A constructed CogGraphicCollection.
  1900. </param>
  1901. <param name="profileDefaultSpace">
  1902. The default space name of the profile
  1903. </param>
  1904. <param name="profileSelectedSpaceName">
  1905. The selected space name of the profile
  1906. </param>
  1907. <param name="xformProfileDefaultFromProfileSSN">
  1908. The 2D linear transform that maps from the profile's selected space to the profile's default space
  1909. </param>
  1910. </member>
  1911. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaLineSegments.InputAvailable">
  1912. <summary>
  1913. Returns whether all the line segments that are specified as inputs are available or not
  1914. </summary>
  1915. </member>
  1916. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaLineSegments.RemoveLineSegment(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase)">
  1917. <summary>
  1918. Removed a line segment from the inputs by its operator
  1919. </summary>
  1920. <param name="op">
  1921. The operator instance that produces the line segment
  1922. </param>
  1923. </member>
  1924. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaLineSegments.RemoveLineSegment(System.Int32)">
  1925. <summary>
  1926. Removes the line segment from the inputs by index
  1927. </summary>
  1928. <param name="index">
  1929. The index of the line segment to be removed
  1930. </param>
  1931. </member>
  1932. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaLineSegments.RemoveLineSegment(System.String)">
  1933. <summary>
  1934. Removes the line segment from the inputs by its name
  1935. </summary>
  1936. <param name="name">
  1937. The name of the operator that produces the line segment
  1938. </param>
  1939. </member>
  1940. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaLineSegments.AddLineSegment(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase)">
  1941. <summary>
  1942. Adds a line segment as an input by its operator
  1943. </summary>
  1944. <param name="op">
  1945. The operator instance that produces the line segment
  1946. </param>
  1947. </member>
  1948. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaLineSegments.AddLineSegment(System.String)">
  1949. <summary>
  1950. Adds a line segment as an input by its name
  1951. </summary>
  1952. <param name="name">
  1953. The name of the operator that produces the line segment
  1954. </param>
  1955. </member>
  1956. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaLineSegments.LineSegmentNames">
  1957. <summary>
  1958. Gets the name of the input line segments
  1959. </summary>
  1960. </member>
  1961. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaLineSegments.ReferenceProfile">
  1962. <summary>
  1963. Gets os sets how to create the reference profile from the line segments. Either use the highest or the lowest linesegment.
  1964. </summary>
  1965. </member>
  1966. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaLineSegments.Finalize">
  1967. <summary>
  1968. Finalize this Cog3DRangeImageCrossSectionAreaLineSegments.
  1969. </summary>
  1970. </member>
  1971. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaLineSegments.Dispose">
  1972. <summary>
  1973. Destruct this Cog3DRangeImageCrossSectionAreaLineSegments.
  1974. </summary>
  1975. </member>
  1976. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaLineSegments.#ctor(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaLineSegments)">
  1977. <summary>
  1978. Construct a deep copy of the supplied
  1979. Cog3DRangeImageCrossSectionAreaLineSegments object.
  1980. </summary>
  1981. <param name="other">
  1982. The Cog3DRangeImageCrossSectionAreaLineSegments object to be copied.
  1983. </param>
  1984. <exception cref="T:System.ArgumentNullException">
  1985. If the supplied argument is null.
  1986. </exception>
  1987. </member>
  1988. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaLineSegments.#ctor">
  1989. <summary>
  1990. Construct a default Cog3DRangeImageCrossSectionAreaLineSegments object.
  1991. </summary>
  1992. </member>
  1993. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaLineSegments.SfNextSf">
  1994. <summary>
  1995. NextSf state flag.
  1996. </summary>
  1997. </member>
  1998. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaLineSegments.SfLineSegmentNames">
  1999. <summary>
  2000. This bit will be set in the EventArgs of a Changed event every time
  2001. the value returned by LineSegmentNames may have changed.
  2002. </summary>
  2003. </member>
  2004. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaLineSegments.SfReferenceProfile">
  2005. <summary>
  2006. This bit will be set in the EventArgs of a Changed event every time
  2007. the value returned by ReferenceProfile may have changed.
  2008. </summary>
  2009. </member>
  2010. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaLineSegments">
  2011. <summary>
  2012. The class to do difference measurements between a CrossSection and line segments.
  2013. </summary>
  2014. </member>
  2015. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorMultipleInputs.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  2016. <summary>
  2017. Serialization constructor for Cog3DRangeImageCrossSectionOperatorMultipleInputs
  2018. object.
  2019. </summary>
  2020. <param name="Info">
  2021. The standard SerializationInfo argument.
  2022. </param>
  2023. <param name="Ctxt">
  2024. The standard StreamingContext argument.
  2025. </param>
  2026. </member>
  2027. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorMultipleInputs.Finalize">
  2028. <summary>
  2029. Finalize this Cog3DRangeImageCrossSectionOperatorMultipleInputs.
  2030. </summary>
  2031. </member>
  2032. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorMultipleInputs.Dispose">
  2033. <summary>
  2034. Destruct this Cog3DRangeImageCrossSectionOperatorMultipleInputs.
  2035. </summary>
  2036. </member>
  2037. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorMultipleInputs.#ctor(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorMultipleInputs)">
  2038. <summary>
  2039. Construct a deep copy of the supplied
  2040. Cog3DRangeImageCrossSectionOperatorMultipleInputs object.
  2041. </summary>
  2042. <param name="other">
  2043. The Cog3DRangeImageCrossSectionOperatorMultipleInputs object to be copied.
  2044. </param>
  2045. <exception cref="T:System.ArgumentNullException">
  2046. If the supplied argument is null.
  2047. </exception>
  2048. </member>
  2049. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorMultipleInputs.#ctor(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase)">
  2050. <summary>
  2051. Construct a default Cog3DRangeImageCrossSectionOperatorMultipleInputs object.
  2052. </summary>
  2053. </member>
  2054. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorMultipleInputs.SfNextSf">
  2055. <summary>
  2056. NextSf state flag.
  2057. </summary>
  2058. </member>
  2059. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorMultipleInputs.SfInputShapes">
  2060. <summary>
  2061. This bit will be set in the EventArgs of a Changed event every time
  2062. the value returned by InputShapes may have changed.
  2063. </summary>
  2064. </member>
  2065. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorMultipleInputs.SfInputOperatorNames">
  2066. <summary>
  2067. This bit will be set in the EventArgs of a Changed event every time
  2068. the value returned by InputOperatorNames may have changed.
  2069. </summary>
  2070. </member>
  2071. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorMultipleInputs">
  2072. <summary>
  2073. The class is a helper class for every operator that has multiple inputs
  2074. It provides the necessary function to Add / Remove / List the input operators of this operator
  2075. INTERNAL USE ONLY!
  2076. </summary>
  2077. </member>
  2078. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.InputAvailable">
  2079. <summary>
  2080. Called at the beginning of the Execute method to check if the result of the input operator is available or not
  2081. If not it does not even try to execute the operator and returns with InputFeatureMissing
  2082. </summary>
  2083. </member>
  2084. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.WeightThreshold">
  2085. <summary>
  2086. Gets the weight threshold. Always returns 0.
  2087. In VisionPro if a profile data has a weight higher than 0 it counts
  2088. </summary>
  2089. </member>
  2090. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.InputOperatorType">
  2091. <summary>
  2092. Returns the type of the input operator of this operator
  2093. </summary>
  2094. </member>
  2095. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  2096. <summary>
  2097. Serialization constructor for Cog3DRangeImageCrossSectionAreaOperatorBase
  2098. object.
  2099. </summary>
  2100. <param name="Info">
  2101. The standard SerializationInfo argument.
  2102. </param>
  2103. <param name="Ctxt">
  2104. The standard StreamingContext argument.
  2105. </param>
  2106. </member>
  2107. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.Execute(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile)">
  2108. <summary>
  2109. Compute the area between the input profile and the reference profile.
  2110. </summary>
  2111. <param name="profile">
  2112. The area and the points of interest and reported in the profile selected space name.
  2113. </param>
  2114. <exception cref="T:Cognex.VisionPro.Exceptions.CogSecurityViolationException">
  2115. If licensing for this class cannot be confirmed.
  2116. </exception>
  2117. <exception cref="T:System.ArgumentException">
  2118. If the regions selected space name was not found in the profile space tree.
  2119. </exception>
  2120. <event cref="!:E:Cognex.VisionPro.ICogChangedEvent.Changed">
  2121. <para>Fires when this method is called.</para>
  2122. <para>The following state flag may be affected:</para>
  2123. <list type="bullet">
  2124. <item>SfStatus</item>
  2125. <para>SfMeasurementResult</para>
  2126. </list>
  2127. </event>
  2128. <remarks>
  2129. <para>
  2130. The status returned can be one of the following:
  2131. <list type="bullet"><item> The measurement was successful and passed any enabled tolerance checking.
  2132. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">Passed</see></item><item> The measurement was successful but failed tolerance checking
  2133. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">FailedTolerance</see></item><item> The measurement was not successful for any reason.
  2134. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">FailedToMeasure</see></item></list></para>
  2135. </remarks>
  2136. </member>
  2137. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.ExecuteMeasureArea(c3img_crossSectionConst!System.Runtime.CompilerServices.IsConst*,cmath_shapeRegionSet!System.Runtime.CompilerServices.IsConst*,c3ip_crossSectionDiffMeasureResult*)">
  2138. <summary>
  2139. This method needs to be overridden in the inherited class to perform the
  2140. conrecte operator specific area measurement
  2141. </summary>
  2142. <param name="crossSection">
  2143. The CrossSection to perform the area measurement on
  2144. </param>
  2145. <param name="regionSet">
  2146. The set of user defined regions
  2147. </param>
  2148. <param name="result">
  2149. The pointer to result structure holding the results of the area measurement
  2150. </param>
  2151. </member>
  2152. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.ClearResults">
  2153. <summary>
  2154. Clear the results' properties of this class.
  2155. </summary>
  2156. <event cref="!:E:Cognex.VisionPro.ICogChangedEvent.Changed">
  2157. <para>Fires when this method is called.</para>
  2158. <para>The following state flag may be affected:</para>
  2159. <list type="bullet">
  2160. <para>SfAreaResult</para>
  2161. </list>
  2162. </event>
  2163. </member>
  2164. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.CreateResultGraphics(Cognex.VisionPro.CogGraphicCollection,System.Boolean)">
  2165. <summary>
  2166. Create the graphics and add them to the graphicCollection provided.
  2167. </summary>
  2168. <param name="graphicCollection">
  2169. A constructed CogGraphicCollection.
  2170. </param>
  2171. <param name="lastRun">
  2172. If lastRun is true, do not include the input graphics.
  2173. </param>
  2174. <remarks>
  2175. The input graphics are the regions and input graphics of the specific area measurement operator
  2176. The output graphic is the difference cross section.
  2177. The base classes method draws everything except the concrete operator specific input graphics
  2178. </remarks>
  2179. </member>
  2180. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.CreateResultInputGraphics(Cognex.VisionPro.CogGraphicCollection,System.String,System.String,Cognex.VisionPro.CogTransform2DLinear)">
  2181. <summary>
  2182. Create the input graphics and add them to the provided graphicCollection
  2183. </summary>
  2184. <param name="graphicCollection">
  2185. A constructed CogGraphicCollection to add the graphics to.
  2186. </param>
  2187. <param name="profileDefaultSpace">
  2188. The profile's default sapcen name
  2189. </param>
  2190. <param name="profileSelectedSpaceName">
  2191. The profile's selected space name
  2192. </param>
  2193. <param name="xformProfileDefaultFromProfileSSN">
  2194. The 2D transformation to map shapes from the profile's SelectedSpaceName to the profile's DefaultSpaceName
  2195. </param>
  2196. </member>
  2197. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.DrawThresholdGraphics">
  2198. <summary>
  2199. Gets or sets whether the threshold graphics will be drawn or not
  2200. </summary>
  2201. <event cref="!:E:Cognex.VisionPro.ICogChangedEvent.Changed">
  2202. <para>Fires when this property changes.</para>
  2203. <para>The following state flag may be affected:</para>
  2204. <list type="bullet">
  2205. <item>SfDrawThresholdGraphics</item>
  2206. </list>
  2207. </event>
  2208. </member>
  2209. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.DrawFarthestPointBelowReferenceProfileGraphics">
  2210. <summary>
  2211. Gets or sets whether the Farthest point below the reference profile will be drawn or not
  2212. </summary>
  2213. <event cref="!:E:Cognex.VisionPro.ICogChangedEvent.Changed">
  2214. <para>Fires when this property changes.</para>
  2215. <para>The following state flag may be affected:</para>
  2216. <list type="bullet">
  2217. <item>SfDrawFarthestPointBelowReferenceProfileGraphics</item>
  2218. </list>
  2219. </event>
  2220. </member>
  2221. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.DrawClosestPointBelowReferenceProfileGraphics">
  2222. <summary>
  2223. Gets or sets whether the closest point below the reference profile will be drawn or not
  2224. </summary>
  2225. <event cref="!:E:Cognex.VisionPro.ICogChangedEvent.Changed">
  2226. <para>Fires when this property changes.</para>
  2227. <para>The following state flag may be affected:</para>
  2228. <list type="bullet">
  2229. <item>SfDrawClosestPointBelowReferenceProfileGraphics</item>
  2230. </list>
  2231. </event>
  2232. </member>
  2233. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.DrawFarthestPointAboveReferenceProfileGraphics">
  2234. <summary>
  2235. Gets or sets whether the Farthest point Above the reference profile will be drawn or not
  2236. </summary>
  2237. <event cref="!:E:Cognex.VisionPro.ICogChangedEvent.Changed">
  2238. <para>Fires when this property changes.</para>
  2239. <para>The following state flag may be affected:</para>
  2240. <list type="bullet">
  2241. <item>SfDrawFarthestPointAboveReferenceProfileGraphics</item>
  2242. </list>
  2243. </event>
  2244. </member>
  2245. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.DrawClosestPointAboveReferenceProfileGraphics">
  2246. <summary>
  2247. Gets or sets whether the closest point above the reference profile will be drawn or not
  2248. </summary>
  2249. <event cref="!:E:Cognex.VisionPro.ICogChangedEvent.Changed">
  2250. <para>Fires when this property changes.</para>
  2251. <para>The following state flag may be affected:</para>
  2252. <list type="bullet">
  2253. <item>SfDrawClosestPointAboveReferenceProfileGraphics</item>
  2254. </list>
  2255. </event>
  2256. </member>
  2257. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.DrawRightPointGraphics">
  2258. <summary>
  2259. Gets or sets whether the rightmost point of the computed area will be drawn or not
  2260. </summary>
  2261. <event cref="!:E:Cognex.VisionPro.ICogChangedEvent.Changed">
  2262. <para>Fires when this property changes.</para>
  2263. <para>The following state flag may be affected:</para>
  2264. <list type="bullet">
  2265. <item>SfDrawRightPointGraphics</item>
  2266. </list>
  2267. </event>
  2268. </member>
  2269. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.DrawLeftPointGraphics">
  2270. <summary>
  2271. Gets or sets whether the leftmost point of the computed area will be drawn or not
  2272. </summary>
  2273. <event cref="!:E:Cognex.VisionPro.ICogChangedEvent.Changed">
  2274. <para>Fires when this property changes.</para>
  2275. <para>The following state flag may be affected:</para>
  2276. <list type="bullet">
  2277. <item>SfDrawLeftPointGraphics</item>
  2278. </list>
  2279. </event>
  2280. </member>
  2281. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.DrawAreaBackgroundGraphics">
  2282. <summary>
  2283. Gets or sets whether the computed area's background will be painted or not
  2284. </summary>
  2285. <event cref="!:E:Cognex.VisionPro.ICogChangedEvent.Changed">
  2286. <para>Fires when this property changes.</para>
  2287. <para>The following state flag may be affected:</para>
  2288. <list type="bullet">
  2289. <item>SfDrawAreaBackgroundGraphics</item>
  2290. </list>
  2291. </event>
  2292. </member>
  2293. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.ClosestPointBelowReferenceProfileYTolerance">
  2294. <summary>
  2295. Gets the <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance">Cog3DRangeImageCrossSectionTolerance</see> object to tolerance
  2296. the point's Y coordinate that is below the reference profile and closest to it.
  2297. </summary>
  2298. <remarks>
  2299. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Min" /> and
  2300. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Max" /> values are specified in profile selected space name.
  2301. If the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Enabled" /> property is set to true, the tolerance
  2302. check will be performed at run time.
  2303. </remarks>
  2304. </member>
  2305. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.ClosestPointBelowReferenceProfileXTolerance">
  2306. <summary>
  2307. Gets the <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance">Cog3DRangeImageCrossSectionTolerance</see> object to tolerance
  2308. the point's X coordinate that is below the reference profile and closest to it.
  2309. </summary>
  2310. <remarks>
  2311. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Min" /> and
  2312. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Max" /> values are specified in profile selected space name.
  2313. If the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Enabled" /> property is set to true, the tolerance
  2314. check will be performed at run time.
  2315. </remarks>
  2316. </member>
  2317. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.FarthestPointBelowReferenceProfileYTolerance">
  2318. <summary>
  2319. Gets the <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance">Cog3DRangeImageCrossSectionTolerance</see> object to tolerance
  2320. the point's Y coordinate that is below the reference profile and farthest from it.
  2321. </summary>
  2322. <remarks>
  2323. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Min" /> and
  2324. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Max" /> values are specified in profile selected space name.
  2325. If the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Enabled" /> property is set to true, the tolerance
  2326. check will be performed at run time.
  2327. </remarks>
  2328. </member>
  2329. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.FarthestPointBelowReferenceProfileXTolerance">
  2330. <summary>
  2331. Gets the <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance">Cog3DRangeImageCrossSectionTolerance</see> object to tolerance
  2332. the point's X coordinate that is below the reference profile and farthest from it.
  2333. </summary>
  2334. <remarks>
  2335. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Min" /> and
  2336. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Max" /> values are specified in profile selected space name.
  2337. If the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Enabled" /> property is set to true, the tolerance
  2338. check will be performed at run time.
  2339. </remarks>
  2340. </member>
  2341. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.ClosestPointAboveReferenceProfileYTolerance">
  2342. <summary>
  2343. Gets the <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance">Cog3DRangeImageCrossSectionTolerance</see> object to tolerance
  2344. the point's Y coordinate that is above the reference profile and closes to it.
  2345. </summary>
  2346. <remarks>
  2347. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Min" /> and
  2348. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Max" /> values are specified in profile selected space name.
  2349. If the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Enabled" /> property is set to true, the tolerance
  2350. check will be performed at run time.
  2351. </remarks>
  2352. </member>
  2353. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.ClosestPointAboveReferenceProfileXTolerance">
  2354. <summary>
  2355. Gets the <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance">Cog3DRangeImageCrossSectionTolerance</see> object to tolerance
  2356. the point's X coordinate that is above the reference profile and closest to it.
  2357. </summary>
  2358. <remarks>
  2359. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Min" /> and
  2360. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Max" /> values are specified in profile selected space name.
  2361. If the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Enabled" /> property is set to true, the tolerance
  2362. check will be performed at run time.
  2363. </remarks>
  2364. </member>
  2365. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.FarthestPointAboveReferenceProfileYTolerance">
  2366. <summary>
  2367. Gets the <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance">Cog3DRangeImageCrossSectionTolerance</see> object to tolerance
  2368. the point's Y coordinate that is above the reference profile and farthest from it.
  2369. </summary>
  2370. <remarks>
  2371. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Min" /> and
  2372. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Max" /> values are specified in profile selected space name.
  2373. If the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Enabled" /> property is set to true, the tolerance
  2374. check will be performed at run time.
  2375. </remarks>
  2376. </member>
  2377. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.FarthestPointAboveReferenceProfileXTolerance">
  2378. <summary>
  2379. Gets the <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance">Cog3DRangeImageCrossSectionTolerance</see> object to tolerance
  2380. the point's X coordinate that is above the reference profile and farthest from it.
  2381. </summary>
  2382. <remarks>
  2383. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Min" /> and
  2384. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Max" /> values are specified in profile selected space name.
  2385. If the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Enabled" /> property is set to true, the tolerance
  2386. check will be performed at run time.
  2387. </remarks>
  2388. </member>
  2389. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.RightPointYTolerance">
  2390. <summary>
  2391. Gets the <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance">Cog3DRangeImageCrossSectionTolerance</see> object to tolerance
  2392. the right point's Y coordinate.
  2393. </summary>
  2394. <remarks>
  2395. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Min" /> and
  2396. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Max" /> values are specified in profile selected space name.
  2397. If the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Enabled" /> property is set to true, the tolerance
  2398. check will be performed at run time.
  2399. </remarks>
  2400. </member>
  2401. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.RightPointXTolerance">
  2402. <summary>
  2403. Gets the <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance">Cog3DRangeImageCrossSectionTolerance</see> object to tolerance
  2404. the right point's X coordinate.
  2405. </summary>
  2406. <remarks>
  2407. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Min" /> and
  2408. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Max" /> values are specified in profile selected space name.
  2409. If the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Enabled" /> property is set to true, the tolerance
  2410. check will be performed at run time.
  2411. </remarks>
  2412. </member>
  2413. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.LeftPointYTolerance">
  2414. <summary>
  2415. Gets the <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance">Cog3DRangeImageCrossSectionTolerance</see> object to tolerance
  2416. the the left point's Y coordinate.
  2417. </summary>
  2418. <remarks>
  2419. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Min" /> and
  2420. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Max" /> values are specified in profile selected space name.
  2421. If the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Enabled" /> property is set to true, the tolerance
  2422. check will be performed at run time.
  2423. </remarks>
  2424. </member>
  2425. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.LeftPointXTolerance">
  2426. <summary>
  2427. Gets the <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance">Cog3DRangeImageCrossSectionTolerance</see> object to tolerance
  2428. the left point's X coordinate.
  2429. </summary>
  2430. <remarks>
  2431. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Min" /> and
  2432. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Max" /> values are specified in profile selected space name.
  2433. If the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Enabled" /> property is set to true, the tolerance
  2434. check will be performed at run time.
  2435. </remarks>
  2436. </member>
  2437. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.AreaTolerance">
  2438. <summary>
  2439. Gets the <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance">Cog3DRangeImageCrossSectionTolerance</see> object to tolerance
  2440. the area.
  2441. </summary>
  2442. <remarks>
  2443. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Min" /> and
  2444. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Max" /> values are specified in profile selected space name.
  2445. If the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Enabled" /> property is set to true, the tolerance
  2446. check will be performed at run time.
  2447. </remarks>
  2448. </member>
  2449. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.AreaResult">
  2450. <summary>
  2451. Gets the result computed by the execute method.
  2452. Always check the status of the operator to be either Passed or FailedTolerance before calling the getter.
  2453. </summary>
  2454. <remarks>
  2455. The result is in the ProfileSelectedSpaceName.
  2456. Returns null if the result was not computed.
  2457. </remarks>
  2458. </member>
  2459. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.Area">
  2460. <summary>
  2461. Gets or sets what area is being measured: abover or below the reference profile or both of those
  2462. and if both, how they are combined
  2463. </summary>
  2464. <event cref="!:E:Cognex.VisionPro.ICogChangedEvent.Changed">
  2465. <para>Fires when this property changes.</para>
  2466. <para>The following state flag may be affected:</para>
  2467. <list type="bullet">
  2468. <item>SfArea</item>
  2469. </list>
  2470. </event>
  2471. <exception cref="!:T:System.ArgumentException">
  2472. If the value is not <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaConstants" /></exception>
  2473. </member>
  2474. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.MaxFillLength">
  2475. <summary>
  2476. Gets or sets max length of a missing stretch to fill along x-axis in ProfileSelectedSpaceName.
  2477. </summary>
  2478. <event cref="!:E:Cognex.VisionPro.ICogChangedEvent.Changed">
  2479. <para>Fires when this property changes.</para>
  2480. <para>The following state flag may be affected:</para>
  2481. <list type="bullet">
  2482. <item>SfMaxFillLength</item>
  2483. </list>
  2484. </event>
  2485. <exception cref="!:T:System.ArgumentException">
  2486. If the value is less than 0.
  2487. </exception>
  2488. </member>
  2489. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.HeightThreshold">
  2490. <summary>
  2491. Gets or sets the height threshold.
  2492. Points with heights below this threshold are treated as noise
  2493. and are thus excluded from the computations. Note that 'height'
  2494. in this context means the difference in height between the cross
  2495. section and the lines. The heights are measured in
  2496. ProfileSelectedSpaceName units along the Image Y axis.
  2497. </summary>
  2498. <value>
  2499. Please note that because of the nature of the surfaces in the real world
  2500. and the accuracy of the sensor setting a height threshold to 0.0 will not
  2501. benefit the calculation at all. We stringly recommend to set it to a value
  2502. higher than 0.0.
  2503. </value>
  2504. <event cref="!:E:Cognex.VisionPro.ICogChangedEvent.Changed">
  2505. <para>Fires when this property changes.</para>
  2506. <para>The following state flag may be affected:</para>
  2507. <list type="bullet">
  2508. <item>SfHeightThreshold</item>
  2509. </list>
  2510. </event>
  2511. <exception cref="!:T:System.ArgumentException">
  2512. If the value is less than 0.
  2513. </exception>
  2514. </member>
  2515. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.Finalize">
  2516. <summary>
  2517. Finalize this Cog3DRangeImageCrossSectionAreaOperatorBase.
  2518. </summary>
  2519. </member>
  2520. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.Dispose">
  2521. <summary>
  2522. Destruct this Cog3DRangeImageCrossSectionAreaOperatorBase.
  2523. </summary>
  2524. </member>
  2525. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.#ctor(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase)">
  2526. <summary>
  2527. Construct a deep copy of the supplied
  2528. Cog3DRangeImageCrossSectionAreaOperatorBase object.
  2529. </summary>
  2530. <param name="other">
  2531. The Cog3DRangeImageCrossSectionAreaOperatorBase object to be copied.
  2532. </param>
  2533. <exception cref="!:T:System.ArgumentNullException">
  2534. If the supplied argument is null.
  2535. </exception>
  2536. </member>
  2537. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.#ctor(System.String,Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaInputOperatorTypeConstants)">
  2538. <summary>
  2539. Construct a default Cog3DRangeImageCrossSectionAreaOperatorBase object.
  2540. </summary>
  2541. </member>
  2542. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.SfNextSf">
  2543. <summary>
  2544. NextSf state flag.
  2545. </summary>
  2546. </member>
  2547. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.SfDrawThresholdGraphics">
  2548. <summary>
  2549. This bit will be set in the EventArgs of a Changed event every time
  2550. the value returned by DrawThresholdGraphics may have changed.
  2551. </summary>
  2552. </member>
  2553. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.SfDrawFarthestPointBelowReferenceProfileGraphics">
  2554. <summary>
  2555. This bit will be set in the EventArgs of a Changed event every time
  2556. the value returned by DrawFarthestPointBelowReferenceProfileGraphics may have changed.
  2557. </summary>
  2558. </member>
  2559. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.SfDrawClosestPointBelowReferenceProfileGraphics">
  2560. <summary>
  2561. This bit will be set in the EventArgs of a Changed event every time
  2562. the value returned by DrawClosestPointBelowReferenceProfileGraphics may have changed.
  2563. </summary>
  2564. </member>
  2565. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.SfDrawFarthestPointAboveReferenceProfileGraphics">
  2566. <summary>
  2567. This bit will be set in the EventArgs of a Changed event every time
  2568. the value returned by DrawFarthestPointAboveReferenceProfileGraphics may have changed.
  2569. </summary>
  2570. </member>
  2571. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.SfDrawClosestPointAboveReferenceProfileGraphics">
  2572. <summary>
  2573. This bit will be set in the EventArgs of a Changed event every time
  2574. the value returned by DrawClosestPointAboveReferenceProfileGraphics may have changed.
  2575. </summary>
  2576. </member>
  2577. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.SfDrawRightPointGraphics">
  2578. <summary>
  2579. This bit will be set in the EventArgs of a Changed event every time
  2580. the value returned by DrawRightPointGraphics may have changed.
  2581. </summary>
  2582. </member>
  2583. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.SfDrawLeftPointGraphics">
  2584. <summary>
  2585. This bit will be set in the EventArgs of a Changed event every time
  2586. the value returned by DrawLeftPointGraphics may have changed.
  2587. </summary>
  2588. </member>
  2589. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.SfDrawAreaBackgroundGraphics">
  2590. <summary>
  2591. This bit will be set in the EventArgs of a Changed event every time
  2592. the value returned by DrawAreaBackgroundGraphics may have changed.
  2593. </summary>
  2594. </member>
  2595. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.SfInputOperator">
  2596. <summary>
  2597. This bit will be set in the EventArgs of a Changed event every time
  2598. the value returned by InputOperator may have changed.
  2599. </summary>
  2600. </member>
  2601. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.SfArea">
  2602. <summary>
  2603. This bit will be set in the EventArgs of a Changed event every time
  2604. the value returned by Area may have changed.
  2605. </summary>
  2606. </member>
  2607. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.SfMeasurementPosition">
  2608. <summary>
  2609. This bit will be set in the EventArgs of a Changed event every time
  2610. the value returned by MeasurementPosition may have changed.
  2611. </summary>
  2612. </member>
  2613. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.SfMaxFillLength">
  2614. <summary>
  2615. This bit will be set in the EventArgs of a Changed event every time
  2616. the value returned by MaxFillLength may have changed.
  2617. </summary>
  2618. </member>
  2619. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.SfHeightThreshold">
  2620. <summary>
  2621. This bit will be set in the EventArgs of a Changed event every time
  2622. the value returned by HeightThreshold may have changed.
  2623. </summary>
  2624. </member>
  2625. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase.SfAreaResult">
  2626. <summary>
  2627. This bit will be set in the EventArgs of a Changed event every time
  2628. the value returned by AreaResult may have changed.
  2629. </summary>
  2630. </member>
  2631. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaOperatorBase">
  2632. <summary>
  2633. The class is the base class for every CrossSectionTool operator that performs area measurement
  2634. </summary>
  2635. </member>
  2636. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTool.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  2637. <summary>
  2638. Serialization constructor for Cog3DRangeImageCrossSectionTool object.
  2639. </summary>
  2640. <param name="Info">
  2641. The standard SerializationInfo argument.
  2642. </param>
  2643. <param name="Ctxt">
  2644. The standard StreamingContext argument.
  2645. </param>
  2646. </member>
  2647. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTool.RunParams">
  2648. <summary>
  2649. Gets or sets the RunParams.
  2650. </summary>
  2651. <value>
  2652. A default constructed
  2653. Cog3DRangeImageCrossSectionRunParams.
  2654. </value>
  2655. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  2656. <para>Fires when this property changes.</para>
  2657. <para>The following state flag may be affected:</para>
  2658. <list type="bullet">
  2659. <item>SfRunParams</item>
  2660. </list>
  2661. </event>
  2662. <exception cref="T:System.ArgumentNullException">
  2663. If the supplied argument is null.
  2664. </exception>
  2665. </member>
  2666. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTool.InputImage">
  2667. <summary>
  2668. Gets or sets the input range image for use in the Cross Section.
  2669. </summary>
  2670. <value>
  2671. The default is null.
  2672. </value>
  2673. <exception cref="T:Cognex.VisionPro.Exceptions.CogImageBadTypeException">
  2674. If the supplied input image is not CogImage16Range.
  2675. </exception>
  2676. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  2677. <para>Fires when this property changes.</para>
  2678. <para>The following state flag may be affected:</para>
  2679. <list type="bullet">
  2680. <item>SfInputImage</item>
  2681. </list>
  2682. </event>
  2683. </member>
  2684. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTool.LastRunRecordDiagEnable">
  2685. <summary>
  2686. Enable creation of records by bitwise ORing the appropriate
  2687. Cog3DRangeImageCrossSectionLastRunRecordDiagConstants.
  2688. </summary>
  2689. <value>
  2690. The default is (int)Cog3DRangeImageCrossSectionLastRunRecordDiagConstants::InputImageByReference | (int)Cog3DRangeImageCrossSectionLastRunRecordDiagConstants::Region
  2691. </value>
  2692. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  2693. <para>Fires when this property changes.</para>
  2694. <para>The following state flag may be affected:</para>
  2695. <list type="bullet">
  2696. <item>SfLastRunRecordDiagEnable</item>
  2697. </list>
  2698. </event>
  2699. </member>
  2700. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTool.LastRunRecordEnable">
  2701. <summary>
  2702. Enable creation of records by bitwise ORing the appropriate
  2703. Cog3DRangeImageCrossSectionLastRunRecordConstants.
  2704. </summary>
  2705. <value>
  2706. The default is Cog3DRangeImageCrossSectionLastRunRecordConstants::All
  2707. </value>
  2708. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  2709. <para>Fires when this property changes.</para>
  2710. <para>The following state flag may be affected:</para>
  2711. <list type="bullet">
  2712. <item>SfLastRunRecordEnable</item>
  2713. <item>SfCreateLastRunRecord</item>
  2714. </list>
  2715. </event>
  2716. </member>
  2717. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTool.CurrentRecordEnable">
  2718. <summary>
  2719. Enable creation of records by bitwise ORing the appropriate
  2720. Cog3DRangeImageCrossSectionCurrentRecordConstants.
  2721. </summary>
  2722. <value>
  2723. The default is (int)Cog3DRangeImageCrossSectionCurrentRecordConstants::InputImage | (int)Cog3DRangeImageCrossSectionCurrentRecordConstants::Region
  2724. </value>
  2725. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  2726. <para>Fires when this property changes.</para>
  2727. <para>The following state flag may be affected:</para>
  2728. <list type="bullet">
  2729. <item>SfCurrentRecordEnable</item>
  2730. <item>SfCreateCurrentRecord</item>
  2731. </list>
  2732. </event>
  2733. </member>
  2734. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTool.Finalize">
  2735. <summary>
  2736. Finalize this Cog3DRangeImageCrossSectionTool object.
  2737. </summary>
  2738. </member>
  2739. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTool.Dispose">
  2740. <summary>
  2741. Destruct this Cog3DRangeImageCrossSectionTool object.
  2742. </summary>
  2743. </member>
  2744. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTool.#ctor(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTool)">
  2745. <summary>
  2746. Construct a deep copy of the supplied Cog3DRangeImageCrossSectionTool object.
  2747. </summary>
  2748. <param name="Other">
  2749. The Cog3DRangeImageCrossSectionTool object to be copied. May not be null.
  2750. </param>
  2751. <exception cref="T:System.ArgumentNullException">
  2752. If the input argument is null.
  2753. </exception>
  2754. </member>
  2755. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTool.#ctor">
  2756. <summary>
  2757. Construct a default Cog3DRangeImageCrossSectionTool object.
  2758. </summary>
  2759. </member>
  2760. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTool.SfNextSf">
  2761. <summary>
  2762. NextSf state flag.
  2763. </summary>
  2764. </member>
  2765. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTool.SfRunParams">
  2766. <summary>
  2767. This bit will be set in the EventArgs of a Changed event every time
  2768. the value returned by RunParams may have changed.
  2769. </summary>
  2770. </member>
  2771. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTool.SfInputImage">
  2772. <summary>
  2773. This bit will be set in the EventArgs of a Changed event every time
  2774. the value returned by InputImage may have changed.
  2775. </summary>
  2776. </member>
  2777. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTool.SfCurrentRecordEnable">
  2778. <summary>
  2779. This bit will be set in the EventArgs of a Changed event every time
  2780. the value returned by CurrentRecordEnable may have changed.
  2781. </summary>
  2782. </member>
  2783. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTool.SfLastRunRecordDiagEnable">
  2784. <summary>
  2785. This bit will be set in the EventArgs of a Changed event every time
  2786. the value returned by LastRunRecordDiagEnable may have changed.
  2787. </summary>
  2788. </member>
  2789. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTool.SfLastRunRecordEnable">
  2790. <summary>
  2791. This bit will be set in the EventArgs of a Changed event every time
  2792. the value returned by LastRunRecordEnable may have changed.
  2793. </summary>
  2794. </member>
  2795. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTool">
  2796. <summary>
  2797. The Cross Section tool allows you to take a thin slice of the part in the range image,
  2798. look at it from the side, make measurements and apply tolerances.
  2799. </summary>
  2800. <remarks>
  2801. The highlights of the Cross Section tool:
  2802. <list type="bullet"><item>
  2803. The tool allows a user to specify a region in the X-Y plane of the range image to create the vertical profile.
  2804. The vertical profile lies parallel to the z-axis of the range image.
  2805. </item><item>
  2806. To make measurements within the profile, we establish a family of coordinate spaces that lie within the cutting plane.
  2807. The profile coordinate spaces are 2D x-y coordinate spaces, glued to the profile,
  2808. typically expressed in physical units (e.g. millimeters).
  2809. </item><item>
  2810. The tool provides a user with a set of operators to
  2811. extract features from the profile such as corners or line segments,
  2812. compute features using other features such as midpoints or line intersections and
  2813. perform measurements on the features. For example, you can measure the angle
  2814. between 2 line segments or the distance between 2 points.
  2815. Optionally perform tolerance checking on all geometry data.
  2816. </item></list></remarks>
  2817. </member>
  2818. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionRunParams.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  2819. <summary>
  2820. Serialization constructor for Cog3DRangeImageCrossSectionRunParams
  2821. object.
  2822. </summary>
  2823. <param name="Info">
  2824. The standard SerializationInfo argument.
  2825. </param>
  2826. <param name="Ctxt">
  2827. The standard StreamingContext argument.
  2828. </param>
  2829. </member>
  2830. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionRunParams.Execute(Cognex.VisionPro.ICogImage)">
  2831. <summary>
  2832. Execute the ProfileParams.Execute() and OperatorsParams.Execute().
  2833. </summary>
  2834. <remarks>
  2835. The outputs of the execute are:
  2836. <list type="bullet"><item>the OutputProfile</item><item>The OperatorsParams.Status, the overall status of executing all the operators </item><item>The operators' results</item></list></remarks>
  2837. <exception cref="T:Cognex.VisionPro.Exceptions.CogOperatorNoInputImageException">
  2838. If the image is null
  2839. </exception>
  2840. <exception cref="T:Cognex.VisionPro.Exceptions.CogImageBadTypeException">
  2841. If the image is not a CogImage16Range
  2842. </exception>
  2843. <exception cref="T:System.ArgumentNullException">
  2844. If the ProfileParams is null
  2845. </exception>
  2846. <exception cref="T:System.ArgumentNullException">
  2847. If the OperatorsParams is null
  2848. </exception>
  2849. <exception cref="T:System.ArgumentNullException">
  2850. If the InputProfile is null and UseInputProfile is set to true.
  2851. </exception>
  2852. <exception cref="T:System.ArgumentNullException">
  2853. If the OutputProfile produced by the ProfileParams is null.
  2854. </exception>
  2855. <exception cref="T:Cognex.VisionPro.Exceptions.CogSecurityViolationException">
  2856. If licensing for this class cannot be confirmed.
  2857. </exception>
  2858. </member>
  2859. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionRunParams.OperatorsParams">
  2860. <summary>Gets or sets the OperatorsParams.
  2861. </summary>
  2862. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  2863. <para>
  2864. Fires when the value of this property changes.
  2865. </para>
  2866. <list type="bullet">
  2867. <item>SfOperatorsParams</item>
  2868. </list>
  2869. </event>
  2870. <exception cref="T:System.ArgumentNullException">
  2871. If the value is null.
  2872. </exception>
  2873. </member>
  2874. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionRunParams.ProfileParams">
  2875. <summary>Gets or sets the ProfileParams.
  2876. </summary>
  2877. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  2878. <para>
  2879. Fires when the value of this property changes.
  2880. </para>
  2881. <list type="bullet">
  2882. <item>SfProfileParams</item>
  2883. </list>
  2884. </event>
  2885. <exception cref="T:System.ArgumentNullException">
  2886. If the value is null.
  2887. </exception>
  2888. </member>
  2889. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionRunParams.InputProfile">
  2890. <summary>Gets or sets the InputProfile.
  2891. The InputProfile will not be used by the tool
  2892. unless the UseInputProfile is set to true.
  2893. </summary>
  2894. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  2895. <para>
  2896. Fires when the value of this property changes.
  2897. </para>
  2898. <list type="bullet">
  2899. <item>SfInputProfile</item>
  2900. </list>
  2901. </event>
  2902. </member>
  2903. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionRunParams.OutputProfile">
  2904. <summary>Gets the OutputProfile produced by the execute method.
  2905. The OutputProfile cannot be set by the user.
  2906. </summary>
  2907. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  2908. <para>
  2909. Fires when the value of this property changes.
  2910. </para>
  2911. <list type="bullet">
  2912. <item>SfOutputProfile</item>
  2913. </list>
  2914. </event>
  2915. </member>
  2916. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionRunParams.UseInputProfile">
  2917. <summary>
  2918. Gets or sets the UseInputProfile. If True, use the InputProfile
  2919. attached to the RunParams.
  2920. </summary>
  2921. <value>Default value is false.</value>
  2922. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  2923. <para>
  2924. Fires when the value of this property changes.
  2925. </para>
  2926. <list type="bullet">
  2927. <item>SfUseInputProfile</item>
  2928. </list>
  2929. </event>
  2930. </member>
  2931. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionRunParams.Finalize">
  2932. <summary>
  2933. Finalize this Cog3DRangeImageCrossSectionRunParams.
  2934. </summary>
  2935. </member>
  2936. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionRunParams.Dispose">
  2937. <summary>
  2938. Destruct this Cog3DRangeImageCrossSectionRunParams.
  2939. </summary>
  2940. </member>
  2941. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionRunParams.#ctor(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionRunParams)">
  2942. <summary>
  2943. Construct a deep copy of the supplied
  2944. Cog3DRangeImageCrossSectionRunParams object.
  2945. </summary>
  2946. <param name="other">
  2947. The Cog3DRangeImageCrossSectionRunParams object to be copied.
  2948. May not be null.
  2949. </param>
  2950. <exception cref="T:System.ArgumentNullException">
  2951. If the supplied argument is null.
  2952. </exception>
  2953. </member>
  2954. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionRunParams.#ctor">
  2955. <summary>
  2956. Construct a default Cog3DRangeImageCrossSectionRunParams object.
  2957. </summary>
  2958. </member>
  2959. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionRunParams.SfNextSf">
  2960. <summary>
  2961. NextSf state flag.
  2962. </summary>
  2963. </member>
  2964. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionRunParams.SfOutputProfile">
  2965. <summary>This bit will be set in the EventArgs of a Changed event
  2966. every time the value returned by OutputProfile may have changed.
  2967. </summary>
  2968. </member>
  2969. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionRunParams.SfUseInputProfile">
  2970. <summary>This bit will be set in the EventArgs of a Changed event
  2971. every time the value returned by UseInputProfile may have changed.
  2972. </summary>
  2973. </member>
  2974. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionRunParams.SfInputProfile">
  2975. <summary>This bit will be set in the EventArgs of a Changed event
  2976. every time the value returned by InputProfile may have changed.
  2977. </summary>
  2978. </member>
  2979. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionRunParams.SfOperatorsParams">
  2980. <summary>This bit will be set in the EventArgs of a Changed event
  2981. every time the value returned by OperatorsParams may have changed.
  2982. </summary>
  2983. </member>
  2984. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionRunParams.SfProfileParams">
  2985. <summary>This bit will be set in the EventArgs of a Changed event
  2986. every time the value returned by ProfileParams may have changed.
  2987. </summary>
  2988. </member>
  2989. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionRunParams">
  2990. <summary>
  2991. This class is the RunParams class of the cross section tool.
  2992. The Cross Section tool has 2 parts: one to create the profile and the other
  2993. to run the operators. This class provides a central location for executing
  2994. both parts. The first part can be skipped if the user passes in the profile.
  2995. </summary>
  2996. </member>
  2997. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointLine.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  2998. <summary>
  2999. Serialization constructor for Cog3DRangeImageCrossSectionDistancePointLine
  3000. object.
  3001. </summary>
  3002. <param name="Info">
  3003. The standard SerializationInfo argument.
  3004. </param>
  3005. <param name="Ctxt">
  3006. The standard StreamingContext argument.
  3007. </param>
  3008. </member>
  3009. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointLine.Execute(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile)">
  3010. <summary>
  3011. Computes the distance between the point and the line segment.
  3012. </summary>
  3013. <param name="profile">
  3014. The distance is computed in the profile selected space name.
  3015. </param>
  3016. <exception cref="T:Cognex.VisionPro.Exceptions.CogSecurityViolationException">
  3017. If licensing for this class cannot be confirmed.
  3018. </exception>
  3019. <exception cref="T:System.ArgumentNullException">
  3020. If the operator is not in a collection.
  3021. </exception>
  3022. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  3023. <para>Fires when this method is called.</para>
  3024. <para>The following state flag may be affected:</para>
  3025. <list type="bullet">
  3026. <item>SfStatus</item>
  3027. <item>SfDistance</item>
  3028. </list>
  3029. </event>
  3030. <remarks>
  3031. The status returned can be one of the following:
  3032. <list type="bullet"><item> The distance was computed successfully and passed any enabled tolerance checking.
  3033. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">Passed</see></item><item> The distance was computed successfully but failed tolerance checking
  3034. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">FailedTolerance </see></item><item> The point and/or the line segment were/was not found at run time
  3035. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">InputFeatureMissing </see></item></list></remarks>
  3036. </member>
  3037. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointLine.ClearResults">
  3038. <summary>
  3039. Clear the results' properties of this class.
  3040. </summary>
  3041. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  3042. <para>Fires when this method is called.</para>
  3043. <para>The following state flag may be affected:</para>
  3044. <list type="bullet">
  3045. <para>SfDistance</para>
  3046. </list>
  3047. </event>
  3048. </member>
  3049. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointLine.CreateResultGraphics(Cognex.VisionPro.CogGraphicCollection,System.Boolean)">
  3050. <summary>
  3051. Create the graphics and add them to the graphicCollection provided.
  3052. </summary>
  3053. <param name="graphicCollection">
  3054. A constructed CogGraphicCollection.
  3055. </param>
  3056. <param name="lastRun">
  3057. If lastRun is true, do not include the input graphics.
  3058. </param>
  3059. <remarks>
  3060. The input graphics are the regions of input features.
  3061. The output graphic is a line segment representing the distance.
  3062. </remarks>
  3063. </member>
  3064. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointLine.SetLineSegmentPointUsingOperators(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams,Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase,Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase)">
  3065. <summary>
  3066. Sets the name of the operators producing LineSegment and Point.
  3067. </summary>
  3068. <param name="parentCollection">
  3069. The Cog3DRangeImageCrossSectionOperatorsParams collection that holds the
  3070. operators.
  3071. </param>
  3072. <param name="lineSegOp">
  3073. The operator object producing LineSegment.
  3074. </param>
  3075. <param name="pointOp">
  3076. The operator object producing pointOp.
  3077. </param>
  3078. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  3079. <para>Fires when this method is called.</para>
  3080. <para>The following state flag may be affected:</para>
  3081. <list type="bullet">
  3082. <item>SfLineSegment</item>
  3083. <item>SfPoint</item>
  3084. </list>
  3085. </event>
  3086. <remarks>
  3087. This is a convenience setter for programmatic users to specify
  3088. the line segment and the point using the operators' objects.
  3089. The operators are not held internally, they are used to extract
  3090. the internal unique ids of the operators. The ids are used
  3091. by this operator at run time.
  3092. </remarks>
  3093. <remarks>
  3094. The method can be called before the operator is
  3095. added to the collection.
  3096. </remarks>
  3097. <exception cref="T:System.ArgumentException">
  3098. If lineSegOp and/or pointOp were not found
  3099. in the parentCollection provided.
  3100. </exception>
  3101. <exception cref="T:System.ArgumentNullException">
  3102. If the parentCollection in null.
  3103. </exception>
  3104. </member>
  3105. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointLine.Distance">
  3106. <summary>
  3107. Gets the distance computed by the execute method.
  3108. Always check the status of the operator to be either Passed or FailedTolerance before calling the getter.
  3109. </summary>
  3110. <remarks>
  3111. The measured distance is in the profile selected space name.
  3112. </remarks>
  3113. <exception cref="T:System.ArgumentException">
  3114. If the distance was not computed.
  3115. </exception>
  3116. </member>
  3117. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointLine.NearestType">
  3118. <summary>
  3119. Gets or sets NearestType.
  3120. </summary>
  3121. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  3122. <para>Fires when this property changes.</para>
  3123. <para>The following state flag may be affected:</para>
  3124. <list type="bullet">
  3125. <item>SfNearestType</item>
  3126. </list>
  3127. </event>
  3128. <remarks>
  3129. Specifies whether or not to treat a line
  3130. segment as an infinite line when determining the point "on" the
  3131. segment that is nearest to a given point.
  3132. </remarks>
  3133. <exception cref="T:System.ArgumentException">
  3134. The value is invalid.
  3135. </exception>
  3136. </member>
  3137. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointLine.LineSegment">
  3138. <summary>
  3139. Gets or sets the name of the operator producing LineSegment.
  3140. </summary>
  3141. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  3142. <para>Fires when this property changes.</para>
  3143. <para>The following state flag may be affected:</para>
  3144. <list type="bullet">
  3145. <item>SfLineSegment</item>
  3146. </list>
  3147. </event>
  3148. <remarks>
  3149. The property is a link between the operator producing the line segment and this operator, and
  3150. therefore requires that all operators are added to the collection before it can be called.
  3151. The name of the operator is not held internally. It is used to extract
  3152. the internal unique id of the operator within the collection.
  3153. </remarks>
  3154. <exception cref="T:System.ArgumentNullException">
  3155. If the operator is not in a collection.
  3156. </exception>
  3157. <exception cref="T:System.ArgumentException">
  3158. If the name of the operator producing LineSegment is not found
  3159. in the collection.
  3160. </exception>
  3161. </member>
  3162. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointLine.Point">
  3163. <summary>
  3164. Gets or sets the name of the operator producing Point.
  3165. </summary>
  3166. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  3167. <para>Fires when this property changes.</para>
  3168. <para>The following state flag may be affected:</para>
  3169. <list type="bullet">
  3170. <item>SfPoint</item>
  3171. </list>
  3172. </event>
  3173. <remarks>
  3174. The property is a link between the operator producing the point and this operator, and
  3175. therefore requires that all operators are added to the collection before it can be called.
  3176. The name of the operator is not held internally. It is used to extract
  3177. the internal unique id of the operator within the collection.
  3178. </remarks>
  3179. <exception cref="T:System.ArgumentNullException">
  3180. If the operator is not in a collection.
  3181. </exception>
  3182. <exception cref="T:System.ArgumentException">
  3183. If the name of the operator producing Point is not found
  3184. in the collection.
  3185. </exception>
  3186. </member>
  3187. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointLine.DistanceTolerance">
  3188. <summary>
  3189. Gets the <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance">tolerance</see> object for
  3190. the distance.
  3191. </summary>
  3192. <remarks>
  3193. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Min" /> and
  3194. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Max" /> values are specified in profile selected space name.
  3195. If the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Enabled" /> property is set to true, the tolerance
  3196. check will be performed at run time.
  3197. </remarks>
  3198. </member>
  3199. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointLine.Finalize">
  3200. <summary>
  3201. Finalize this Cog3DRangeImageCrossSectionDistancePointLine.
  3202. </summary>
  3203. </member>
  3204. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointLine.Dispose">
  3205. <summary>
  3206. Destruct this Cog3DRangeImageCrossSectionDistancePointLine.
  3207. </summary>
  3208. </member>
  3209. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointLine.#ctor(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointLine)">
  3210. <summary>
  3211. Construct a deep copy of the supplied
  3212. Cog3DRangeImageCrossSectionDistancePointLine object.
  3213. </summary>
  3214. <param name="other">
  3215. The Cog3DRangeImageCrossSectionDistancePointLine object to be copied.
  3216. </param>
  3217. <exception cref="T:System.ArgumentNullException">
  3218. If the supplied argument is null.
  3219. </exception>
  3220. <remarks>
  3221. The copy constructor is meant to be used with the collection
  3222. copy constructor.
  3223. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointLine.Point" /> and
  3224. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointLine.LineSegment" /> properties
  3225. refer to
  3226. internal ids within the <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams">operators</see>
  3227. collection and
  3228. their values are meaningless outside a collection.
  3229. </remarks>
  3230. </member>
  3231. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointLine.#ctor">
  3232. <summary>
  3233. Construct a default Cog3DRangeImageCrossSectionDistancePointLine object.
  3234. </summary>
  3235. </member>
  3236. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointLine.SfNextSf">
  3237. <summary>
  3238. NextSf state flag.
  3239. </summary>
  3240. </member>
  3241. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointLine.SfDistance">
  3242. <summary>
  3243. This bit will be set in the EventArgs of a Changed event every time
  3244. the value returned by Distance may have changed.
  3245. </summary>
  3246. </member>
  3247. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointLine.SfNearestType">
  3248. <summary>
  3249. This bit will be set in the EventArgs of a Changed event every time
  3250. the value returned by NearestType may have changed.
  3251. </summary>
  3252. </member>
  3253. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointLine.SfLineSegment">
  3254. <summary>
  3255. This bit will be set in the EventArgs of a Changed event every time
  3256. the value returned by LineSegment may have changed.
  3257. </summary>
  3258. </member>
  3259. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointLine.SfPoint">
  3260. <summary>
  3261. This bit will be set in the EventArgs of a Changed event every time
  3262. the value returned by Point may have changed.
  3263. </summary>
  3264. </member>
  3265. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointLine">
  3266. <summary>
  3267. The class to compute the shortest distance between a point and a line that extends from the line segment or
  3268. the shortest distance between a point and the line segment.
  3269. This operator must be added to the <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams">operators</see> collection before it
  3270. is configured. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointLine.Point" /> and
  3271. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointLine.LineSegment" /> properties hold the internal ids
  3272. of the operators producing the features, and these operators must also be in the operators collection.
  3273. </summary>
  3274. </member>
  3275. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionNearestPoint.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  3276. <summary>
  3277. Serialization constructor for Cog3DRangeImageCrossSectionNearestPoint
  3278. object.
  3279. </summary>
  3280. <param name="Info">
  3281. The standard SerializationInfo argument.
  3282. </param>
  3283. <param name="Ctxt">
  3284. The standard StreamingContext argument.
  3285. </param>
  3286. </member>
  3287. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionNearestPoint.Execute(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile)">
  3288. <summary>
  3289. Computes the nearest point.
  3290. </summary>
  3291. <param name="profile">
  3292. The nearest point is computed in the profile selected space name.
  3293. </param>
  3294. <exception cref="T:Cognex.VisionPro.Exceptions.CogSecurityViolationException">
  3295. If licensing for this class cannot be confirmed.
  3296. </exception>
  3297. <exception cref="T:System.ArgumentNullException">
  3298. If the operator is not in a collection. The parent is null.
  3299. </exception>
  3300. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  3301. <para>Fires when this method is called.</para>
  3302. <para>The following state flag may be affected:</para>
  3303. <list type="bullet">
  3304. <item>SfStatus</item>
  3305. <item>SfNearestPoint</item>
  3306. <item>SfNearestPointInImage</item>
  3307. <item>SfNearestPointInImage3D</item>
  3308. </list>
  3309. </event>
  3310. <remarks>
  3311. <para>
  3312. The status returned can be one of the following:
  3313. <list type="bullet"><item> The nearest point was computed successfully and passed any enabled tolerance checking.
  3314. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">Passed</see></item><item> The nearest point was computed successfully but failed tolerance checking
  3315. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">FailedTolerance </see></item><item> The point and/or the line was/were not found at run time
  3316. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">InputFeatureMissing </see></item></list></para>
  3317. </remarks>
  3318. </member>
  3319. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionNearestPoint.ClearResults">
  3320. <summary>
  3321. Clear the results' properties of this class.
  3322. </summary>
  3323. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  3324. <para>Fires when this method is called.</para>
  3325. <para>The following state flag may be affected:</para>
  3326. <list type="bullet">
  3327. <para>SfStatus</para>
  3328. <para>SfNearestPoint</para>
  3329. <para>SfNearestPointInImage</para>
  3330. <para>SfNearestPointInImage3D</para>
  3331. </list>
  3332. </event>
  3333. </member>
  3334. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionNearestPoint.CreateResultGraphics(Cognex.VisionPro.CogGraphicCollection,System.Boolean)">
  3335. <summary>
  3336. Create the graphics and add them to the graphicCollection provided.
  3337. </summary>
  3338. <param name="graphicCollection">
  3339. A constructed CogGraphicCollection.
  3340. </param>
  3341. <param name="lastRun">
  3342. If lastRun is true, do not include the input graphics.
  3343. </param>
  3344. <remarks>
  3345. The input graphics are the regions of input features.
  3346. The output graphic is a point.
  3347. </remarks>
  3348. </member>
  3349. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionNearestPoint.SetLineSegmentPointUsingOperators(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams,Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase,Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase)">
  3350. <summary>
  3351. Sets the name of the operators producing LineSegment and Point.
  3352. </summary>
  3353. <param name="parentCollection">
  3354. The Cog3DRangeImageCrossSectionOperatorsParams collection that holds the
  3355. operators.
  3356. </param>
  3357. <param name="lineSegOp">
  3358. The operator object producing LineSegment.
  3359. </param>
  3360. <param name="pointOp">
  3361. The operator object producing pointOp.
  3362. </param>
  3363. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  3364. <para>Fires when this method is called.</para>
  3365. <para>The following state flag may be affected:</para>
  3366. <list type="bullet">
  3367. <item>SfLineSegment</item>
  3368. <item>SfPoint</item>
  3369. </list>
  3370. </event>
  3371. <remarks>
  3372. This is a convenience setter for programmatic users to specify
  3373. the line segment and the point using the operators' objects.
  3374. The operators are not held internally, they are used to extract
  3375. the internal unique ids of the operators. The ids are used
  3376. by this operator at run time.
  3377. </remarks>
  3378. <remarks>
  3379. The method can be called before the operator is
  3380. added to the collection.
  3381. </remarks>
  3382. <exception cref="T:System.ArgumentException">
  3383. If lineSegOp and/or pointOp were not found
  3384. in the parentCollection provided.
  3385. </exception>
  3386. <exception cref="T:System.ArgumentNullException">
  3387. If the parentCollection in null.
  3388. </exception>
  3389. </member>
  3390. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionNearestPoint.NearestPointInImage3D">
  3391. <summary>
  3392. Gets the nearest point found by the execute method.
  3393. Always check the status of the operator to be either Passed or FailedTolerance before calling the getter.
  3394. </summary>
  3395. <remarks>
  3396. The point is in the SelectedSpaceName3D of the range image
  3397. stored in the profile.
  3398. </remarks>
  3399. <exception cref="T:System.ArgumentException">
  3400. If the nearest point was not computed.
  3401. The Cog3DVect3 is a ValueType and cannot return a null.
  3402. </exception>
  3403. </member>
  3404. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionNearestPoint.NearestPointInImage">
  3405. <summary>
  3406. Gets the nearest point found by the execute method.
  3407. </summary>
  3408. <remarks>
  3409. The point is in the SelectedSpaceName of the range image
  3410. stored in the profile.
  3411. Returns null if the point was not computed.
  3412. </remarks>
  3413. </member>
  3414. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionNearestPoint.NearestPoint">
  3415. <summary>
  3416. Gets the nearest point found by the execute method.
  3417. </summary>
  3418. <remarks>
  3419. The point is in the ProfileSelectedSpaceName.
  3420. Returns null if the point was not computed.
  3421. </remarks>
  3422. </member>
  3423. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionNearestPoint.NearestType">
  3424. <summary>
  3425. Gets or sets NearestType.
  3426. </summary>
  3427. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  3428. <para>Fires when this property changes.</para>
  3429. <para>The following state flag may be affected:</para>
  3430. <list type="bullet">
  3431. <item>SfNearestType</item>
  3432. </list>
  3433. </event>
  3434. <remarks>
  3435. Specifies whether or not to treat a line
  3436. segment as an infinite line when determining the point "on" the
  3437. segment that is nearest to a given point.
  3438. </remarks>
  3439. <exception cref="T:System.ArgumentException">
  3440. The value is invalid.
  3441. </exception>
  3442. </member>
  3443. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionNearestPoint.Point">
  3444. <summary>
  3445. Gets or sets the name of the operator producing Point.
  3446. </summary>
  3447. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  3448. <para>Fires when this property changes.</para>
  3449. <para>The following state flag may be affected:</para>
  3450. <list type="bullet">
  3451. <item>SfPoint</item>
  3452. </list>
  3453. </event>
  3454. <remarks>
  3455. The property is a link between the operator producing the point and this operator, and
  3456. therefore requires that all operators are added to the collection before it can be called.
  3457. The name of the operator is not held internally. It is used to extract
  3458. the internal unique id of the operator within the collection.
  3459. </remarks>
  3460. <exception cref="T:System.ArgumentNullException">
  3461. If the operator is not in a collection.
  3462. </exception>
  3463. <exception cref="T:System.ArgumentException">
  3464. If the name of the operator producing Point is not found
  3465. in the collection.
  3466. </exception>
  3467. </member>
  3468. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionNearestPoint.LineSegment">
  3469. <summary>
  3470. Gets or sets the name of the operator producing LineSegment.
  3471. </summary>
  3472. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  3473. <para>Fires when this property changes.</para>
  3474. <para>The following state flag may be affected:</para>
  3475. <list type="bullet">
  3476. <item>SfLineSegment</item>
  3477. </list>
  3478. </event>
  3479. <remarks>
  3480. The property is a link between the operator producing the line segment and this operator, and
  3481. therefore requires that all operators are added to the collection before it can be called.
  3482. The name of the operator is not held internally. It is used to extract
  3483. the internal unique id of the operator within the collection.
  3484. </remarks>
  3485. <exception cref="T:System.ArgumentNullException">
  3486. If the operator is not in a collection.
  3487. </exception>
  3488. <exception cref="T:System.ArgumentException">
  3489. If the name of the operator producing LineSegment is not found
  3490. in the collection.
  3491. </exception>
  3492. </member>
  3493. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionNearestPoint.YTolerance">
  3494. <summary>
  3495. Gets the Cog3DRangeImageCrossSectionTolerance object to
  3496. tolerance the Y position.
  3497. </summary>
  3498. <remarks>
  3499. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Min" /> and
  3500. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Max" /> values are specified in profile selected space name.
  3501. If the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Enabled" /> property is set to true, the tolerance
  3502. check will be performed at run time.
  3503. </remarks>
  3504. </member>
  3505. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionNearestPoint.XTolerance">
  3506. <summary>
  3507. Gets the Cog3DRangeImageCrossSectionTolerance object to
  3508. tolerance the X position.
  3509. </summary>
  3510. <remarks>
  3511. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Min" /> and
  3512. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Max" /> values are specified in profile selected space name.
  3513. If the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Enabled" /> property is set to true, the tolerance
  3514. check will be performed at run time.
  3515. </remarks>
  3516. </member>
  3517. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionNearestPoint.Finalize">
  3518. <summary>
  3519. Finalize this Cog3DRangeImageCrossSectionNearestPoint.
  3520. </summary>
  3521. </member>
  3522. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionNearestPoint.Dispose">
  3523. <summary>
  3524. Destruct this Cog3DRangeImageCrossSectionNearestPoint.
  3525. </summary>
  3526. </member>
  3527. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionNearestPoint.#ctor(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionNearestPoint)">
  3528. <summary>
  3529. Construct a deep copy of the supplied
  3530. Cog3DRangeImageCrossSectionNearestPoint object.
  3531. </summary>
  3532. <param name="other">
  3533. The Cog3DRangeImageCrossSectionNearestPoint object to be copied.
  3534. </param>
  3535. <exception cref="T:System.ArgumentNullException">
  3536. If the supplied argument is null.
  3537. </exception>
  3538. <remarks>
  3539. The copy constructor is meant to be used with the collection
  3540. copy constructor.
  3541. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionNearestPoint.Point" /> and
  3542. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionNearestPoint.LineSegment" /> properties
  3543. refer to
  3544. internal ids within the <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams">operators</see>
  3545. collection and
  3546. their values are meaningless outside a collection.
  3547. </remarks>
  3548. </member>
  3549. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionNearestPoint.#ctor">
  3550. <summary>
  3551. Construct a default Cog3DRangeImageCrossSectionNearestPoint object.
  3552. </summary>
  3553. </member>
  3554. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionNearestPoint.SfNextSf">
  3555. <summary>
  3556. NextSf state flag.
  3557. </summary>
  3558. </member>
  3559. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionNearestPoint.SfNearestPointInImage3D">
  3560. <summary>
  3561. This bit will be set in the EventArgs of a Changed event every time
  3562. the value returned by NearestPointInImage3D may have changed.
  3563. </summary>
  3564. </member>
  3565. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionNearestPoint.SfNearestPointInImage">
  3566. <summary>
  3567. This bit will be set in the EventArgs of a Changed event every time
  3568. the value returned by NearestPointInImage may have changed.
  3569. </summary>
  3570. </member>
  3571. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionNearestPoint.SfNearestPoint">
  3572. <summary>
  3573. This bit will be set in the EventArgs of a Changed event every time
  3574. the value returned by NearestPoint may have changed.
  3575. </summary>
  3576. </member>
  3577. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionNearestPoint.SfNearestType">
  3578. <summary>
  3579. This bit will be set in the EventArgs of a Changed event every time
  3580. the value returned by NearestType may have changed.
  3581. </summary>
  3582. </member>
  3583. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionNearestPoint.SfLineSegment">
  3584. <summary>
  3585. This bit will be set in the EventArgs of a Changed event every time
  3586. the value returned by LineSegment may have changed.
  3587. </summary>
  3588. </member>
  3589. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionNearestPoint.SfPoint">
  3590. <summary>
  3591. This bit will be set in the EventArgs of a Changed event every time
  3592. the value returned by Point may have changed.
  3593. </summary>
  3594. </member>
  3595. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionNearestPoint">
  3596. <summary>
  3597. The class to compute the nearest point on a line segment or the nearest point on a line that extends from the line segment.
  3598. This operator must be added to the <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams">operators</see> collection before it
  3599. is configured. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionNearestPoint.Point" /> and
  3600. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionNearestPoint.LineSegment" /> properties hold the internal ids
  3601. of the operators producing the features, and these operators must also be in the operators collection.
  3602. </summary>
  3603. </member>
  3604. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointPoint.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  3605. <summary>
  3606. Serialization constructor for Cog3DRangeImageCrossSectionDistancePointPoint
  3607. object.
  3608. </summary>
  3609. <param name="Info">
  3610. The standard SerializationInfo argument.
  3611. </param>
  3612. <param name="Ctxt">
  3613. The standard StreamingContext argument.
  3614. </param>
  3615. </member>
  3616. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointPoint.Execute(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile)">
  3617. <summary>
  3618. Computes the distance between tow points.
  3619. </summary>
  3620. <param name="profile">
  3621. The distance is computed in the profile selected space name.
  3622. </param>
  3623. <exception cref="T:Cognex.VisionPro.Exceptions.CogSecurityViolationException">
  3624. If licensing for this class cannot be confirmed.
  3625. </exception>
  3626. <exception cref="T:System.ArgumentNullException">
  3627. If the operator is not in a collection.
  3628. </exception>
  3629. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  3630. <para>Fires when this method is called.</para>
  3631. <para>The following state flag may be affected:</para>
  3632. <list type="bullet">
  3633. <item>SfStatus</item>
  3634. <item>SfDistance</item>
  3635. </list>
  3636. </event>
  3637. <remarks>
  3638. The status returned can be one of the following:
  3639. <list type="bullet"><item> The distance was computed successfully and passed any enabled tolerance checking.
  3640. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">Passed</see></item><item> The distance was computed successfully but failed tolerance checking
  3641. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">FailedTolerance </see></item><item> The point and/or the line segment were/was not found at run time
  3642. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">InputFeatureMissing </see></item></list></remarks>
  3643. </member>
  3644. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointPoint.ClearResults">
  3645. <summary>
  3646. Clear the results' properties of this class.
  3647. </summary>
  3648. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  3649. <para>Fires when this method is called.</para>
  3650. <para>The following state flag may be affected:</para>
  3651. <list type="bullet">
  3652. <para>SfDistance</para>
  3653. </list>
  3654. </event>
  3655. </member>
  3656. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointPoint.CreateResultGraphics(Cognex.VisionPro.CogGraphicCollection,System.Boolean)">
  3657. <summary>
  3658. Create the graphics and add them to the graphicCollection provided.
  3659. </summary>
  3660. <param name="graphicCollection">
  3661. A constructed CogGraphicCollection.
  3662. </param>
  3663. <param name="lastRun">
  3664. If lastRun is true, do not include the input graphics.
  3665. </param>
  3666. <remarks>
  3667. The input graphics are the regions of input features.
  3668. The output graphic is a line segment representing the distance.
  3669. </remarks>
  3670. </member>
  3671. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointPoint.SetPointsUsingOperators(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams,Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase,Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase)">
  3672. <summary>
  3673. Sets the name of the operators producing Point1 and Point2.
  3674. </summary>
  3675. <param name="parentCollection">
  3676. The Cog3DRangeImageCrossSectionOperatorsParams object that holds the
  3677. operators.
  3678. </param>
  3679. <param name="operator1">
  3680. The operator object producing Point1.
  3681. </param>
  3682. <param name="operator2">
  3683. The operator object producing Point2.
  3684. </param>
  3685. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  3686. <para>Fires when this method is called.</para>
  3687. <para>The following state flag may be affected:</para>
  3688. <list type="bullet">
  3689. <item>SfPoint1</item>
  3690. <item>SfPoint2</item>
  3691. </list>
  3692. </event>
  3693. <remarks>
  3694. This is a convenience setter for programmatic users to set
  3695. the points using the operators' objects.
  3696. The operators are not held internally, they are used to extract
  3697. the internal unique index of the operators. The indices are used
  3698. by this operator at run time.
  3699. </remarks>
  3700. <remarks>
  3701. The method can be called before the operator is
  3702. added to the collection.
  3703. </remarks>
  3704. <exception cref="T:System.ArgumentException">
  3705. If operator1 and/or operator2 were not found
  3706. in the parentCollection provided.
  3707. </exception>
  3708. <exception cref="T:System.ArgumentNullException">
  3709. If the operator is not in the parentCollection.
  3710. </exception>
  3711. </member>
  3712. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointPoint.Distance">
  3713. <summary>
  3714. Gets the distance computed by the execute method.
  3715. Always check the status of the operator to be either Passed or FailedTolerance before calling the getter.
  3716. </summary>
  3717. <remarks>
  3718. The measured distance is in the profile selected space name.
  3719. </remarks>
  3720. <exception cref="T:System.ArgumentException">
  3721. If the distance was not computed.
  3722. </exception>
  3723. </member>
  3724. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointPoint.DistanceType">
  3725. <summary>
  3726. Gets or sets DistanceType.
  3727. </summary>
  3728. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  3729. <para>Fires when this property changes.</para>
  3730. <para>The following state flag may be affected:</para>
  3731. <list type="bullet">
  3732. <item>SfDistanceType</item>
  3733. </list>
  3734. </event>
  3735. <remarks>
  3736. To compute the distance between 2 points, the user can select
  3737. the euclidean distance, the distance in X or the distance in Y.
  3738. All of the measurements are in profile selected space name.
  3739. The distance in X is the width between the 2 points.
  3740. The distance in Y is the height between the 2 points.
  3741. </remarks>
  3742. <exception cref="T:System.ArgumentException">
  3743. The value is invalid.
  3744. </exception>
  3745. </member>
  3746. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointPoint.Point2">
  3747. <summary>
  3748. Gets or sets the name of the operator producing Point2.
  3749. </summary>
  3750. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  3751. <para>Fires when this property changes.</para>
  3752. <para>The following state flag may be affected:</para>
  3753. <list type="bullet">
  3754. <item>SfPoint2</item>
  3755. </list>
  3756. </event>
  3757. <remarks>
  3758. The property is a link between the operator producing the point and this operator, and
  3759. therefore requires that all operators are added to the collection before it can be called.
  3760. The name of the operator is not held internally. It is used to extract
  3761. the internal unique id of the operator within the collection.
  3762. </remarks>
  3763. <exception cref="T:System.ArgumentNullException">
  3764. If the operator is not in a collection.
  3765. </exception>
  3766. <exception cref="T:System.ArgumentException">
  3767. If the name of the operator producing Poin2t is not found
  3768. in the collection.
  3769. </exception>
  3770. </member>
  3771. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointPoint.Point1">
  3772. <summary>
  3773. Gets or sets the name of the operator producing Point1.
  3774. </summary>
  3775. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  3776. <para>Fires when this property changes.</para>
  3777. <para>The following state flag may be affected:</para>
  3778. <list type="bullet">
  3779. <item>SfPoint1</item>
  3780. </list>
  3781. </event>
  3782. <remarks>
  3783. The property is a link between the operator producing the point and this operator, and
  3784. therefore requires that all operators are added to the collection before it can be called.
  3785. The name of the operator is not held internally. It is used to extract
  3786. the internal unique id of the operator within the collection.
  3787. </remarks>
  3788. <exception cref="T:System.ArgumentNullException">
  3789. If the operator is not in a collection.
  3790. </exception>
  3791. <exception cref="T:System.ArgumentException">
  3792. If the name of the operator producing Point1 is not found
  3793. in the collection.
  3794. </exception>
  3795. </member>
  3796. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointPoint.DistanceTolerance">
  3797. <summary>
  3798. Gets the <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance">tolerance</see> object for
  3799. the distance.
  3800. </summary>
  3801. <remarks>
  3802. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Min" /> and
  3803. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Max" /> values are specified in profile selected space name.
  3804. If the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Enabled" /> property is set to true, the tolerance
  3805. check will be performed at run time.
  3806. </remarks>
  3807. </member>
  3808. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointPoint.Finalize">
  3809. <summary>
  3810. Finalize this Cog3DRangeImageCrossSectionDistancePointLine.
  3811. </summary>
  3812. </member>
  3813. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointPoint.Dispose">
  3814. <summary>
  3815. Destruct this Cog3DRangeImageCrossSectionDistancePointPoint.
  3816. </summary>
  3817. </member>
  3818. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointPoint.#ctor(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointPoint)">
  3819. <summary>
  3820. Construct a deep copy of the supplied
  3821. Cog3DRangeImageCrossSectionDistancePointPoint object.
  3822. </summary>
  3823. <param name="other">
  3824. The Cog3DRangeImageCrossSectionDistancePointPoint object to be copied.
  3825. </param>
  3826. <exception cref="T:System.ArgumentNullException">
  3827. If the supplied argument is null.
  3828. </exception>
  3829. <remarks>
  3830. The copy constructor is meant to be used with the collection
  3831. copy constructor.
  3832. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointPoint.Point1" /> and
  3833. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointPoint.Point2" /> properties
  3834. refer to
  3835. internal ids within the <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams">operators</see>
  3836. collection and
  3837. their values are meaningless outside a collection.
  3838. </remarks>
  3839. </member>
  3840. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointPoint.#ctor">
  3841. <summary>
  3842. Construct a default Cog3DRangeImageCrossSectionDistancePointPoint object.
  3843. </summary>
  3844. </member>
  3845. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointPoint.SfNextSf">
  3846. <summary>
  3847. NextSf state flag.
  3848. </summary>
  3849. </member>
  3850. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointPoint.SfDistance">
  3851. <summary>
  3852. This bit will be set in the EventArgs of a Changed event every time
  3853. the value returned by Distance may have changed.
  3854. </summary>
  3855. </member>
  3856. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointPoint.SfDistanceType">
  3857. <summary>
  3858. This bit will be set in the EventArgs of a Changed event every time
  3859. the value returned by DistanceType may have changed.
  3860. </summary>
  3861. </member>
  3862. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointPoint.SfPoint2">
  3863. <summary>
  3864. This bit will be set in the EventArgs of a Changed event every time
  3865. the value returned by Point2 may have changed.
  3866. </summary>
  3867. </member>
  3868. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointPoint.SfPoint1">
  3869. <summary>
  3870. This bit will be set in the EventArgs of a Changed event every time
  3871. the value returned by Point1 may have changed.
  3872. </summary>
  3873. </member>
  3874. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointPoint">
  3875. <summary>
  3876. The operator class to compute the distance between 2 points.
  3877. This operator must be added to the <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams">operators</see> collection before it
  3878. is configured. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointPoint.Point1" /> and
  3879. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistancePointPoint.Point2" /> properties hold the internal ids
  3880. of the operators producing the features, and these operators must also be in the operators collection.
  3881. </summary>
  3882. </member>
  3883. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionLineSegmentPointPoint.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  3884. <summary>
  3885. Serialization constructor for Cog3DRangeImageCrossSectionLineSegmentPointPoint
  3886. object.
  3887. </summary>
  3888. <param name="Info">
  3889. The standard SerializationInfo argument.
  3890. </param>
  3891. <param name="Ctxt">
  3892. The standard StreamingContext argument.
  3893. </param>
  3894. </member>
  3895. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionLineSegmentPointPoint.Execute(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile)">
  3896. <summary>
  3897. Computes the line segment using 2 points.
  3898. </summary>
  3899. <param name="profile">
  3900. The line segment is computed in the profile selected space name.
  3901. </param>
  3902. <exception cref="T:Cognex.VisionPro.Exceptions.CogSecurityViolationException">
  3903. If licensing for this class cannot be confirmed.
  3904. </exception>
  3905. <exception cref="T:System.ArgumentNullException">
  3906. If the operator is not in a collection.
  3907. </exception>
  3908. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  3909. <para>Fires when this method is called.</para>
  3910. <para>The following state flag may be affected:</para>
  3911. <list type="bullet">
  3912. <item>SfStatus</item>
  3913. <item>SfLineSegment</item>
  3914. <item>SfLineSegmentInImage</item>
  3915. <item>SfLineSegmentInImage3D</item>
  3916. </list>
  3917. </event>
  3918. <remarks>
  3919. <para>
  3920. The status returned can be one of the following:
  3921. <list type="bullet"><item> The line segment was computed successfully and passed any enabled tolerance checking.
  3922. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">Passed</see></item><item> The line segment was computed successfully but failed tolerance checking
  3923. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">FailedTolerance </see></item><item> The point(s) was/were not found at run time
  3924. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">InputFeatureMissing </see></item></list></para>
  3925. </remarks>
  3926. </member>
  3927. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionLineSegmentPointPoint.ClearResults">
  3928. <summary>
  3929. Clear the results' properties of this class.
  3930. </summary>
  3931. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  3932. <para>Fires when this method is called.</para>
  3933. <para>The following state flag may be affected:</para>
  3934. <list type="bullet">
  3935. <para>SfStatus</para>
  3936. <para>SfLineSegment</para>
  3937. <para>SfLineSegmentInImage</para>
  3938. <para>SfLineSegmentInImage3D</para>
  3939. </list>
  3940. </event>
  3941. </member>
  3942. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionLineSegmentPointPoint.CreateResultGraphics(Cognex.VisionPro.CogGraphicCollection,System.Boolean)">
  3943. <summary>
  3944. Create the graphics and add them to the graphicCollection provided.
  3945. </summary>
  3946. <param name="graphicCollection">
  3947. The constructed CogGraphicCollection.
  3948. </param>
  3949. <param name="lastRun">
  3950. If lastRun is true, do not include the input graphics.
  3951. </param>
  3952. <remarks>
  3953. The input graphics are the regions of input features.
  3954. The output graphic is the line segment.
  3955. </remarks>
  3956. </member>
  3957. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionLineSegmentPointPoint.SetPointsUsingOperators(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams,Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase,Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase)">
  3958. <summary>
  3959. Sets the name of the operators producing Point1 and Point2.
  3960. </summary>
  3961. <param name="parentCollection">
  3962. The Cog3DRangeImageCrossSectionOperatorsParams object that holds the
  3963. operators.
  3964. </param>
  3965. <param name="operator1">
  3966. The operator object producing Point1.
  3967. </param>
  3968. <param name="operator2">
  3969. The operator object producing Point2.
  3970. </param>
  3971. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  3972. <para>Fires when this method is called.</para>
  3973. <para>The following state flag may be affected:</para>
  3974. <list type="bullet">
  3975. <item>SfPoint1</item>
  3976. <item>SfPoint2</item>
  3977. </list>
  3978. </event>
  3979. <remarks>
  3980. This is a convenience setter for programmatic users to set
  3981. the points using the operators' objects.
  3982. The operators are not held internally, they are used to extract
  3983. the internal unique index of the operators. The indices are used
  3984. by this operator at run time.
  3985. </remarks>
  3986. <remarks>
  3987. The method can be called before the operator is
  3988. added to the collection.
  3989. </remarks>
  3990. <exception cref="T:System.ArgumentException">
  3991. If operator1 and/or operator2 were not found
  3992. in the parentCollection provided.
  3993. </exception>
  3994. <exception cref="T:System.ArgumentNullException">
  3995. If the operator is not in the parentCollection.
  3996. </exception>
  3997. </member>
  3998. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionLineSegmentPointPoint.LineSegmentInImage3D">
  3999. <summary>
  4000. Gets the line segment computed by the execute method.
  4001. </summary>
  4002. <remarks>
  4003. The line segment is in the SelectedSpaceName3D of the range image
  4004. stored in the profile.
  4005. Returns null if the line segment was not computed.
  4006. </remarks>
  4007. </member>
  4008. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionLineSegmentPointPoint.LineSegmentInImage">
  4009. <summary>
  4010. Gets the line segment computed by the execute method.
  4011. </summary>
  4012. <remarks>
  4013. The line segment is in the SelectedSpaceName of the range image
  4014. stored in the profile.
  4015. Returns null if the line segment was not computed.
  4016. </remarks>
  4017. </member>
  4018. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionLineSegmentPointPoint.LineSegment">
  4019. <summary>
  4020. Gets the line segment computed by the execute method.
  4021. Always check the status of the operator to be either Passed or FailedTolerance before calling the getter.
  4022. </summary>
  4023. <remarks>
  4024. The line segment is in the ProfileSelectedSpaceName.
  4025. Returns null if the line segment was not computed.
  4026. </remarks>
  4027. <exception cref="T:System.ArgumentException">
  4028. If the line segment was not computed.
  4029. </exception>
  4030. </member>
  4031. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionLineSegmentPointPoint.Point2">
  4032. <summary>
  4033. Gets or sets the name of the operator producing Point2.
  4034. </summary>
  4035. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  4036. <para>Fires when this property changes.</para>
  4037. <para>The following state flag may be affected:</para>
  4038. <list type="bullet">
  4039. <item>SfPoint2</item>
  4040. </list>
  4041. </event>
  4042. <remarks>
  4043. The property is a link between the operator producing the point and this operator, and
  4044. therefore requires that all operators are added to the collection before it can be called.
  4045. The name of the operator is not held internally. It is used to extract
  4046. the internal unique id of the operator within the collection.
  4047. </remarks>
  4048. <exception cref="T:System.ArgumentNullException">
  4049. If the operator is not in a collection.
  4050. </exception>
  4051. <exception cref="T:System.ArgumentException">
  4052. If the name of the operator producing Poin2t is not found
  4053. in the collection.
  4054. </exception>
  4055. </member>
  4056. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionLineSegmentPointPoint.Point1">
  4057. <summary>
  4058. Gets or sets the name of the operator producing Point1.
  4059. </summary>
  4060. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  4061. <para>Fires when this property changes.</para>
  4062. <para>The following state flag may be affected:</para>
  4063. <list type="bullet">
  4064. <item>SfPoint1</item>
  4065. </list>
  4066. </event>
  4067. <remarks>
  4068. The property is a link between the operator producing the point and this operator, and
  4069. therefore requires that all operators are added to the collection before it can be called.
  4070. The name of the operator is not held internally. It is used to extract
  4071. the internal unique id of the operator within the collection.
  4072. </remarks>
  4073. <exception cref="T:System.ArgumentNullException">
  4074. If the operator is not in a collection.
  4075. </exception>
  4076. <exception cref="T:System.ArgumentException">
  4077. If the name of the operator producing Point1 is not found
  4078. in the collection.
  4079. </exception>
  4080. </member>
  4081. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionLineSegmentPointPoint.AngleTolerance">
  4082. <summary>
  4083. Gets the <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance">tolerance</see> object for
  4084. the angle.
  4085. </summary>
  4086. <remarks>
  4087. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Min" /> and
  4088. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Max" /> values are specified in radians.
  4089. If the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Enabled" /> property is set to true, the tolerance
  4090. check will be performed at run time.
  4091. </remarks>
  4092. </member>
  4093. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionLineSegmentPointPoint.Finalize">
  4094. <summary>
  4095. Finalize this Cog3DRangeImageCrossSectionLineSegmentPointPoint.
  4096. </summary>
  4097. </member>
  4098. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionLineSegmentPointPoint.Dispose">
  4099. <summary>
  4100. Destruct this Cog3DRangeImageCrossSectionLineSegmentPointPoint.
  4101. </summary>
  4102. </member>
  4103. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionLineSegmentPointPoint.#ctor(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionLineSegmentPointPoint)">
  4104. <summary>
  4105. Construct a deep copy of the supplied
  4106. Cog3DRangeImageCrossSectionLineSegmentPointPoint object.
  4107. </summary>
  4108. <param name="other">
  4109. The Cog3DRangeImageCrossSectionLineSegmentPointPoint object to be copied.
  4110. </param>
  4111. <exception cref="T:System.ArgumentNullException">
  4112. If the supplied argument is null.
  4113. </exception>
  4114. <remarks>
  4115. The copy constructor is meant to be used with the collection
  4116. copy constructor.
  4117. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionLineSegmentPointPoint.Point1" /> and
  4118. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionLineSegmentPointPoint.Point2" /> properties
  4119. refer to
  4120. internal ids within the <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams">operators</see> collection and
  4121. their values are meaningless outside a collection.
  4122. </remarks>
  4123. </member>
  4124. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionLineSegmentPointPoint.#ctor">
  4125. <summary>
  4126. Construct a default Cog3DRangeImageCrossSectionLineSegmentPointPoint object.
  4127. </summary>
  4128. </member>
  4129. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionLineSegmentPointPoint.SfNextSf">
  4130. <summary>
  4131. NextSf state flag.
  4132. </summary>
  4133. </member>
  4134. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionLineSegmentPointPoint.SfLineSegmentInImage3D">
  4135. <summary>
  4136. This bit will be set in the EventArgs of a Changed event every time
  4137. the value returned by LineSegmentInImage3D may have changed.
  4138. </summary>
  4139. </member>
  4140. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionLineSegmentPointPoint.SfLineSegmentInImage">
  4141. <summary>
  4142. This bit will be set in the EventArgs of a Changed event every time
  4143. the value returned by LineSegmentInImage may have changed.
  4144. </summary>
  4145. </member>
  4146. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionLineSegmentPointPoint.SfLineSegment">
  4147. <summary>
  4148. This bit will be set in the EventArgs of a Changed event every time
  4149. the value returned by LineSegment may have changed.
  4150. </summary>
  4151. </member>
  4152. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionLineSegmentPointPoint.SfPoint2">
  4153. <summary>
  4154. This bit will be set in the EventArgs of a Changed event every time
  4155. the value returned by Point2 may have changed.
  4156. </summary>
  4157. </member>
  4158. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionLineSegmentPointPoint.SfPoint1">
  4159. <summary>
  4160. This bit will be set in the EventArgs of a Changed event every time
  4161. the value returned by Point1 may have changed.
  4162. </summary>
  4163. </member>
  4164. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionLineSegmentPointPoint">
  4165. <summary>
  4166. The class computes a line segment using 2 points.
  4167. This operator must be added to the <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams">operators</see> collection before it
  4168. is configured. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionLineSegmentPointPoint.Point1" /> and
  4169. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionLineSegmentPointPoint.Point2" /> properties hold the internal ids of the operators producing the points,
  4170. and these operators must also be in the operators collection.
  4171. </summary>
  4172. </member>
  4173. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionMidpointPointPoint.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  4174. <summary>
  4175. Serialization constructor for Cog3DRangeImageCrossSectionMidpointPointPoint
  4176. object.
  4177. </summary>
  4178. <param name="Info">
  4179. The standard SerializationInfo argument.
  4180. </param>
  4181. <param name="Ctxt">
  4182. The standard StreamingContext argument.
  4183. </param>
  4184. </member>
  4185. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionMidpointPointPoint.Execute(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile)">
  4186. <summary>
  4187. Computes the midpoint between 2 points.
  4188. </summary>
  4189. <param name="profile">
  4190. The midpoint is computed in the profile selected space name.
  4191. </param>
  4192. <exception cref="T:Cognex.VisionPro.Exceptions.CogSecurityViolationException">
  4193. If licensing for this class cannot be confirmed.
  4194. </exception>
  4195. <exception cref="T:System.ArgumentNullException">
  4196. If the operator is not in a collection. The parent is null.
  4197. </exception>
  4198. <para>Fires when this property changes.</para>
  4199. <para>The following state flag may be affected:</para>
  4200. <list type="bullet">
  4201. <item>SfStatus</item>
  4202. <item>SfMidpoint</item>
  4203. <item>SfMidpointInImage</item>
  4204. <item>SfMidpointInImage3D</item>
  4205. </list>
  4206. <remarks>
  4207. <para>
  4208. The status returned can be one of the following:
  4209. <para> The midpoint was computed successfully and passed any enabled tolerance checking.
  4210. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">Passed</see></para><para> The midpoint was computed successfully but failed tolerance checking
  4211. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">FailedTolerance </see></para><para> The point(s) was/were not found in the collection at run time.
  4212. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">InputFeatureMissing </see></para></para>
  4213. </remarks>
  4214. </member>
  4215. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionMidpointPointPoint.ClearResults">
  4216. <summary>
  4217. Clear the results' properties of this class.
  4218. </summary>
  4219. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  4220. <para>Fires when this property changes.</para>
  4221. <para>The following state flag may be affected:</para>
  4222. <list type="bullet">
  4223. <para>Status</para>
  4224. <para>Midpoint</para>
  4225. <para>MidpointInImage</para>
  4226. <para>MidpointInImage3D</para>
  4227. </list>
  4228. </event>
  4229. </member>
  4230. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionMidpointPointPoint.CreateResultGraphics(Cognex.VisionPro.CogGraphicCollection,System.Boolean)">
  4231. <summary>
  4232. Create the graphics and add them to the graphicCollection provided.
  4233. </summary>
  4234. <param name="graphicCollection">
  4235. A constructed CogGraphicCollection.
  4236. </param>
  4237. <param name="lastRun">
  4238. If lastRun is true, do not include the input graphics.
  4239. </param>
  4240. <remarks>
  4241. The input graphics are the regions of the input points.
  4242. The output graphic is the point graphic.
  4243. </remarks>
  4244. </member>
  4245. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionMidpointPointPoint.SetPointsUsingOperators(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams,Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase,Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase)">
  4246. <summary>
  4247. Sets the name of the operators producing Point1 and Point2.
  4248. </summary>
  4249. <param name="parentCollection">
  4250. The Cog3DRangeImageCrossSectionOperatorsParams object that holds the
  4251. operators.
  4252. </param>
  4253. <param name="operator1">
  4254. The operator object producing Point1.
  4255. </param>
  4256. <param name="operator2">
  4257. The operator object producing Point2.
  4258. </param>
  4259. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  4260. <para>Fires when this property changes.</para>
  4261. <para>The following state flag may be affected:</para>
  4262. <list type="bullet">
  4263. <item>SfPoint1</item>
  4264. <item>SfPoint2</item>
  4265. </list>
  4266. </event>
  4267. <remarks>
  4268. This is a convenience setter for programmatic users to set
  4269. the points using the operators' object.
  4270. The operators are not held internally, they are used to extract
  4271. the internal unique index of the operators. The indices are used
  4272. by this operator at run time.
  4273. </remarks>
  4274. <remarks>
  4275. The method can be called before the operator is
  4276. added to the collection.
  4277. </remarks>
  4278. <exception cref="T:System.ArgumentException">
  4279. If operator1 and/or operator2 were not found
  4280. in the parentCollection provided.
  4281. </exception>
  4282. <exception cref="T:System.ArgumentNullException">
  4283. If the operator is not in the parentCollection.
  4284. </exception>
  4285. </member>
  4286. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionMidpointPointPoint.MidpointInImage3D">
  4287. <summary>
  4288. Gets the midpoint found by the execute method.
  4289. Always check the status of the operator to be either Passed or FailedTolerance before calling the getter.
  4290. </summary>
  4291. <remarks>
  4292. The point is in the SelectedSpaceName3D of the range image
  4293. stored in the profile.
  4294. </remarks>
  4295. <exception cref="T:System.ArgumentException">
  4296. If the midpoint was not computed.
  4297. The Cog3DVect3 is a ValueType and cannot return a null.
  4298. </exception>
  4299. </member>
  4300. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionMidpointPointPoint.MidpointInImage">
  4301. <summary>
  4302. Gets the midpoint found by the execute method.
  4303. </summary>
  4304. <remarks>
  4305. The point is in the SelectedSpaceName of the range image
  4306. stored in the profile.
  4307. Returns null if the point was not computed.
  4308. </remarks>
  4309. </member>
  4310. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionMidpointPointPoint.Midpoint">
  4311. <summary>
  4312. Gets the point computed by the execute method.
  4313. </summary>
  4314. <remarks>
  4315. The point is in the ProfileSelectedSpaceName.
  4316. Returns null if the point was not computed.
  4317. </remarks>
  4318. </member>
  4319. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionMidpointPointPoint.Point2">
  4320. <summary>
  4321. Gets or sets the name of the operator producing Point2.
  4322. </summary>
  4323. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  4324. <para>Fires when this property changes.</para>
  4325. <para>The following state flag may be affected:</para>
  4326. <list type="bullet">
  4327. <item>SfPoint2</item>
  4328. </list>
  4329. </event>
  4330. <remarks>
  4331. The property is a link between the operator producing the point and this operator, and
  4332. therefore requires that all operators are added to the collection before it can be called.
  4333. The name of the operator is not held internally. It is used to extract
  4334. the internal unique id of the operator within the collection.
  4335. </remarks>
  4336. <exception cref="T:System.ArgumentNullException">
  4337. If the operator is not in a collection.
  4338. </exception>
  4339. <exception cref="T:System.ArgumentException">
  4340. If the name of the operator producing Poin2 is not found
  4341. in the collection.
  4342. </exception>
  4343. </member>
  4344. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionMidpointPointPoint.Point1">
  4345. <summary>
  4346. Gets or sets the name of the operator producing Point1.
  4347. </summary>
  4348. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  4349. <para>Fires when this property changes.</para>
  4350. <para>The following state flag may be affected:</para>
  4351. <list type="bullet">
  4352. <item>SfPoint1</item>
  4353. </list>
  4354. </event>
  4355. <remarks>
  4356. The property is a link between the operator producing the point and this operator, and
  4357. therefore requires that all operators are added to the collection before it can be called.
  4358. The name of the operator is not held internally. It is used to extract
  4359. the internal unique id of the operator within the collection.
  4360. </remarks>
  4361. <exception cref="T:System.ArgumentNullException">
  4362. If the operator is not in a collection.
  4363. </exception>
  4364. <exception cref="T:System.ArgumentException">
  4365. If the name of the operator producing Point1 is not found
  4366. in the collection.
  4367. </exception>
  4368. </member>
  4369. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionMidpointPointPoint.YTolerance">
  4370. <summary>
  4371. Gets the Cog3DRangeImageCrossSectionTolerance object to
  4372. tolerance the Y position.
  4373. </summary>
  4374. <remarks>
  4375. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Min" /> and
  4376. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Max" /> values are specified in profile selected space name.
  4377. If the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Enabled" /> property is set to true, the tolerance
  4378. check will be performed at run time.
  4379. </remarks>
  4380. </member>
  4381. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionMidpointPointPoint.XTolerance">
  4382. <summary>
  4383. Gets the Cog3DRangeImageCrossSectionTolerance object to
  4384. tolerance the X position.
  4385. </summary>
  4386. <remarks>
  4387. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Min" /> and
  4388. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Max" /> values are specified in profile selected space name.
  4389. If the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Enabled" /> property is set to true, the tolerance
  4390. check will be performed at run time.
  4391. </remarks>
  4392. </member>
  4393. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionMidpointPointPoint.Finalize">
  4394. <summary>
  4395. Finalize this Cog3DRangeImageCrossSectionMidpointPointPoint.
  4396. </summary>
  4397. </member>
  4398. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionMidpointPointPoint.Dispose">
  4399. <summary>
  4400. Destruct this Cog3DRangeImageCrossSectionMidpointPointPoint.
  4401. </summary>
  4402. </member>
  4403. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionMidpointPointPoint.#ctor(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionMidpointPointPoint)">
  4404. <summary>
  4405. Construct a deep copy of the supplied
  4406. Cog3DRangeImageCrossSectionMidpointPointPoint object.
  4407. </summary>
  4408. <param name="other">
  4409. The Cog3DRangeImageCrossSectionMidpointPointPoint object to be copied.
  4410. </param>
  4411. <exception cref="T:System.ArgumentNullException">
  4412. If the supplied argument is null.
  4413. </exception>
  4414. <remarks>
  4415. The copy constructor is meant to be used with the collection
  4416. copy constructor.
  4417. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionMidpointPointPoint.Point1" /> and
  4418. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionMidpointPointPoint.Point2" /> properties
  4419. refer to
  4420. internal ids within the <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams">operators</see>
  4421. collection and
  4422. their values are meaningless outside a collection.
  4423. </remarks>
  4424. </member>
  4425. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionMidpointPointPoint.#ctor">
  4426. <summary>
  4427. Construct a default Cog3DRangeImageCrossSectionMidpointPointPoint object.
  4428. </summary>
  4429. </member>
  4430. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionMidpointPointPoint.SfNextSf">
  4431. <summary>
  4432. NextSf state flag.
  4433. </summary>
  4434. </member>
  4435. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionMidpointPointPoint.SfMidpointInImage3D">
  4436. <summary>
  4437. This bit will be set in the EventArgs of a Changed event every time
  4438. the value returned by MidpointInRangeImage3D may have changed.
  4439. </summary>
  4440. </member>
  4441. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionMidpointPointPoint.SfMidpointInImage">
  4442. <summary>
  4443. This bit will be set in the EventArgs of a Changed event every time
  4444. the value returned by MidpointInRangeImage may have changed.
  4445. </summary>
  4446. </member>
  4447. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionMidpointPointPoint.SfMidpoint">
  4448. <summary>
  4449. This bit will be set in the EventArgs of a Changed event every time
  4450. the value returned by Midpoint may have changed.
  4451. </summary>
  4452. </member>
  4453. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionMidpointPointPoint.SfPoint2">
  4454. <summary>
  4455. This bit will be set in the EventArgs of a Changed event every time
  4456. the value returned by Point2 may have changed.
  4457. </summary>
  4458. </member>
  4459. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionMidpointPointPoint.SfPoint1">
  4460. <summary>
  4461. This bit will be set in the EventArgs of a Changed event every time
  4462. the value returned by Point1 may have changed.
  4463. </summary>
  4464. </member>
  4465. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionMidpointPointPoint">
  4466. <summary>
  4467. The class to compute the midpoint between two points.
  4468. This operator must be added to the <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams">operators</see> collection before it
  4469. is configured. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionMidpointPointPoint.Point1" /> and
  4470. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionMidpointPointPoint.Point2" /> properties hold the internal ids
  4471. of the operators producing the features, and these operators must also be in the operators collection.
  4472. </summary>
  4473. </member>
  4474. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointLineSegment.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  4475. <summary>
  4476. Serialization constructor for Cog3DRangeImageCrossSectionPointLineSegment
  4477. object.
  4478. </summary>
  4479. <param name="Info">
  4480. The standard SerializationInfo argument.
  4481. </param>
  4482. <param name="Ctxt">
  4483. The standard StreamingContext argument.
  4484. </param>
  4485. </member>
  4486. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointLineSegment.Execute(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile)">
  4487. <summary>
  4488. Returns the point on the line segment.
  4489. </summary>
  4490. <param name="profile">
  4491. The point is computed in the profile selected space name.
  4492. </param>
  4493. <exception cref="T:Cognex.VisionPro.Exceptions.CogSecurityViolationException">
  4494. If licensing for this class cannot be confirmed.
  4495. </exception>
  4496. <exception cref="T:System.ArgumentNullException">
  4497. If the operator is not in a collection.
  4498. </exception>
  4499. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  4500. <para>Fires when this method is called.</para>
  4501. <para>The following state flag may be affected:</para>
  4502. <list type="bullet">
  4503. <item>SfStatus</item>
  4504. <item>SfPoint</item>
  4505. <item>SfPointInImage</item>
  4506. <item>SfPointInImage3D</item>
  4507. </list>
  4508. </event>
  4509. <remarks>
  4510. <para>
  4511. The status returned can be one of the following:
  4512. <list type="bullet"><item> The point was computed successfully and passed any enabled tolerance checking.
  4513. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">Passed</see></item><item> The point was computed successfully but failed tolerance checking.
  4514. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">FailedTolerance </see></item><item> The operator failed.
  4515. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">FailedToCompute</see></item><item> The line segment was not found in the collection at run time.
  4516. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">InputFeatureMissing </see></item></list></para>
  4517. </remarks>
  4518. </member>
  4519. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointLineSegment.ClearResults">
  4520. <summary>
  4521. Clear the results' properties of this class.
  4522. </summary>
  4523. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  4524. <para>Fires when this method is called.</para>
  4525. <para>The following state flag may be affected:</para>
  4526. <list type="bullet">
  4527. <para>SfStatus</para>
  4528. <para>SfPoint</para>
  4529. <para>SfPointInImage</para>
  4530. <para>SfPointInImage3D</para>
  4531. </list>
  4532. </event>
  4533. </member>
  4534. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointLineSegment.CreateResultGraphics(Cognex.VisionPro.CogGraphicCollection,System.Boolean)">
  4535. <summary>
  4536. Create the graphics and add them to the graphicCollection provided.
  4537. </summary>
  4538. <param name="graphicCollection">
  4539. A constructed CogGraphicCollection.
  4540. </param>
  4541. <param name="lastRun">
  4542. If lastRun is true, do not include the input graphics.
  4543. </param>
  4544. <remarks>
  4545. The input graphics are the regions of extracted line segment.
  4546. The output graphic is the point graphic.
  4547. </remarks>
  4548. </member>
  4549. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointLineSegment.SetLineSegmentUsingOperator(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams,Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase)">
  4550. <summary>
  4551. Sets the name of the operator producing LineSegment.
  4552. </summary>
  4553. <param name="parentCollection">
  4554. The Cog3DRangeImageCrossSectionOperatorsParams collection that holds the
  4555. line segment operator.
  4556. </param>
  4557. <param name="op">
  4558. The operator object producing LineSegment.
  4559. </param>
  4560. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  4561. <para>Fires when this method is called.</para>
  4562. <para>The following state flag may be affected:</para>
  4563. <list type="bullet">
  4564. <item>SfLineSegment</item>
  4565. </list>
  4566. </event>
  4567. <remarks>
  4568. This is a convenience setter for programmatic users to specify
  4569. the line segment using the operator's object.
  4570. The operator is not held internally, it is used to extract
  4571. the internal unique id of the operator. The id is used
  4572. by this operator at run time.
  4573. </remarks>
  4574. <remarks>
  4575. The method can be called before the operator is
  4576. added to the collection.
  4577. </remarks>
  4578. <exception cref="T:System.ArgumentException">
  4579. If operator is not found
  4580. in the parentCollection provided.
  4581. </exception>
  4582. <exception cref="T:System.ArgumentNullException">
  4583. If the parentCollection in null.
  4584. </exception>
  4585. </member>
  4586. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointLineSegment.PointInImage3D">
  4587. <summary>
  4588. Gets the point computed by the execute method.
  4589. Always check the status of the operator to be either Passed or FailedTolerance before calling the getter.
  4590. </summary>
  4591. <remarks>
  4592. The point is in the SelectedSpaceName3D of the range image
  4593. stored in the profile.
  4594. </remarks>
  4595. <exception cref="T:System.ArgumentException">
  4596. If the point was not computed.
  4597. The Cog3DVect3 is a ValueType and cannot return a null.
  4598. </exception>
  4599. </member>
  4600. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointLineSegment.PointInImage">
  4601. <summary>
  4602. Gets the point computed by the execute method.
  4603. </summary>
  4604. <remarks>
  4605. The point is in the SelectedSpaceName of the range image
  4606. stored in the profile.
  4607. Returns null if the point was not computed.
  4608. </remarks>
  4609. </member>
  4610. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointLineSegment.Point">
  4611. <summary>
  4612. Gets the point computed by the execute method.
  4613. </summary>
  4614. <remarks>
  4615. The point is in the ProfileSelectedSpaceName.
  4616. Returns null if the point was not computed.
  4617. </remarks>
  4618. </member>
  4619. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointLineSegment.LineSegmentPoint">
  4620. <summary>
  4621. Gets or sets the LineSegmentPoint.
  4622. </summary>
  4623. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  4624. <para>Fires when this property changes.</para>
  4625. <para>The following state flag may be affected:</para>
  4626. <list type="bullet">
  4627. <item>SfLineSegmentPoint</item>
  4628. </list>
  4629. </event>
  4630. <exception cref="T:System.ArgumentException">
  4631. If the value is invalid.
  4632. </exception>
  4633. <remarks>
  4634. Specifies which point on the line segment to return.
  4635. </remarks>
  4636. </member>
  4637. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointLineSegment.LineSegment">
  4638. <summary>
  4639. Gets or sets the name of the operator producing LineSegment.
  4640. </summary>
  4641. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  4642. <para>Fires when this property changes.</para>
  4643. <para>The following state flag may be affected:</para>
  4644. <list type="bullet">
  4645. <item>SfLineSegment</item>
  4646. </list>
  4647. </event>
  4648. <remarks>
  4649. The property is a link between the operator producing the line segment and this operator, and
  4650. therefore requires that all operators are added to the collection before it can be called.
  4651. The name of the operator is not held internally. It is used to extract
  4652. the internal unique id of the operator within the collection.
  4653. </remarks>
  4654. <exception cref="T:System.ArgumentNullException">
  4655. If the operator is not in a collection.
  4656. </exception>
  4657. <exception cref="T:System.ArgumentException">
  4658. If the name of the operator producing LineSegment is not found
  4659. in the collection.
  4660. </exception>
  4661. </member>
  4662. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointLineSegment.YTolerance">
  4663. <summary>
  4664. Gets the Cog3DRangeImageCrossSectionTolerance object to
  4665. tolerance the Y position.
  4666. </summary>
  4667. <remarks>
  4668. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Min" /> and
  4669. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Max" /> values are specified in profile selected space name.
  4670. If the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Enabled" /> property is set to true, the tolerance
  4671. check will be performed at run time.
  4672. </remarks>
  4673. </member>
  4674. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointLineSegment.XTolerance">
  4675. <summary>
  4676. Gets the Cog3DRangeImageCrossSectionTolerance object to
  4677. tolerance the X position.
  4678. </summary>
  4679. <remarks>
  4680. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Min" /> and
  4681. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Max" /> values are specified in profile selected space name.
  4682. If the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Enabled" /> property is set to true, the tolerance
  4683. check will be performed at run time.
  4684. </remarks>
  4685. </member>
  4686. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointLineSegment.Finalize">
  4687. <summary>
  4688. Finalize this Cog3DRangeImageCrossSectionPointLineSegment.
  4689. </summary>
  4690. </member>
  4691. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointLineSegment.Dispose">
  4692. <summary>
  4693. Destruct this Cog3DRangeImageCrossSectionPointLineSegment.
  4694. </summary>
  4695. </member>
  4696. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointLineSegment.#ctor(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointLineSegment)">
  4697. <summary>
  4698. Construct a deep copy of the supplied
  4699. Cog3DRangeImageCrossSectionPointLineSegment object.
  4700. </summary>
  4701. <param name="other">
  4702. The Cog3DRangeImageCrossSectionPointLineSegment object to be copied.
  4703. </param>
  4704. <exception cref="T:System.ArgumentNullException">
  4705. If the supplied argument is null.
  4706. </exception>
  4707. <remarks>
  4708. The copy constructor is meant to be used with the collection
  4709. copy constructor.
  4710. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointLineSegment.LineSegment" /> property
  4711. refer to
  4712. internal id within the <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams">operators</see> collection and
  4713. its value is meaningless outside a collection.
  4714. </remarks>
  4715. </member>
  4716. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointLineSegment.#ctor">
  4717. <summary>
  4718. Construct a default Cog3DRangeImageCrossSectionPointLineSegment object.
  4719. </summary>
  4720. </member>
  4721. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointLineSegment.SfNextSf">
  4722. <summary>
  4723. NextSf state flag.
  4724. </summary>
  4725. </member>
  4726. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointLineSegment.SfPointInImage3D">
  4727. <summary>
  4728. This bit will be set in the EventArgs of a Changed event every time
  4729. the value returned by PointInImage3D may have changed.
  4730. </summary>
  4731. </member>
  4732. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointLineSegment.SfPointInImage">
  4733. <summary>
  4734. This bit will be set in the EventArgs of a Changed event every time
  4735. the value returned by PointInImage may have changed.
  4736. </summary>
  4737. </member>
  4738. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointLineSegment.SfPoint">
  4739. <summary>
  4740. This bit will be set in the EventArgs of a Changed event every time
  4741. the value returned by Point may have changed.
  4742. </summary>
  4743. </member>
  4744. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointLineSegment.SfLineSegmentPoint">
  4745. <summary>
  4746. This bit will be set in the EventArgs of a Changed event every time
  4747. the value returned by LineSegmentPoint may have changed.
  4748. </summary>
  4749. </member>
  4750. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointLineSegment.SfLineSegment">
  4751. <summary>
  4752. This bit will be set in the EventArgs of a Changed event every time
  4753. the value returned by LineSegment may have changed.
  4754. </summary>
  4755. </member>
  4756. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointLineSegment">
  4757. <summary>
  4758. The class to return a point on a line segment.
  4759. This operator must be added to the <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams">operators</see> collection before it
  4760. is configured. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointLineSegment.LineSegment" />
  4761. property hold the internal id of the operator producing the line segment,
  4762. and the operator must also be in the operators collection.
  4763. </summary>
  4764. </member>
  4765. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAngleLineLine.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  4766. <summary>
  4767. Serialization constructor for Cog3DRangeImageCrossSectionAngleLineLine
  4768. object.
  4769. </summary>
  4770. <param name="Info">
  4771. The standard SerializationInfo argument.
  4772. </param>
  4773. <param name="Ctxt">
  4774. The standard StreamingContext argument.
  4775. </param>
  4776. </member>
  4777. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAngleLineLine.Execute(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile)">
  4778. <summary>
  4779. Computes the angle between the lines that extend from the two line segments.
  4780. </summary>
  4781. <param name="profile">
  4782. The angle is computed in the profile selected space name.
  4783. </param>
  4784. <exception cref="T:Cognex.VisionPro.Exceptions.CogSecurityViolationException">
  4785. If licensing for this class cannot be confirmed.
  4786. </exception>
  4787. <exception cref="T:System.ArgumentNullException">
  4788. If the operator is not in a collection.
  4789. </exception>
  4790. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  4791. <para>Fires when this method is called.</para>
  4792. <para>The following state flag may be affected:</para>
  4793. <list type="bullet">
  4794. <item>SfStatus</item>
  4795. <item>SfAngle</item>
  4796. </list>
  4797. </event>
  4798. <remarks>
  4799. The status returned can be one of the following:
  4800. <list type="bullet"><item> The angle was computed successfully and passed any enabled tolerance checking.
  4801. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">Passed</see></item><item> The angle was computed successfully but failed tolerance checking.
  4802. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">FailedTolerance </see></item><item> The operator failed.
  4803. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">FailedToMeasure</see></item><item> The line segment(s) was/were not found in the collection at run time.
  4804. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">InputFeatureMissing </see></item></list></remarks>
  4805. </member>
  4806. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAngleLineLine.CreateResultGraphics(Cognex.VisionPro.CogGraphicCollection,System.Boolean)">
  4807. <summary>
  4808. Create the graphics and add them to the graphicCollection provided..
  4809. </summary>
  4810. <param name="graphicCollection">
  4811. A constructed CogGraphicCollection.
  4812. </param>
  4813. <param name="lastRun">
  4814. If lastRun is true, do not include the input graphics.
  4815. </param>
  4816. <remarks>
  4817. The input graphics are the regions of extracted line segments.
  4818. The output graphics are the angle graphics.
  4819. </remarks>
  4820. </member>
  4821. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAngleLineLine.ClearResults">
  4822. <summary>
  4823. Clear the results' properties of this class.
  4824. </summary>
  4825. <remarks>
  4826. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  4827. <para>Fires when this method is called.</para>
  4828. <para>The following state flag may be affected:</para>
  4829. <list type="bullet">
  4830. <item>SfAngle</item>
  4831. </list>
  4832. </event>
  4833. </remarks>
  4834. </member>
  4835. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAngleLineLine.SetLineSegmentsUsingOperators(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams,Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase,Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase)">
  4836. <summary>
  4837. Sets the name of the operators producing LineSegment1 and LineSegment2.
  4838. </summary>
  4839. <param name="parentCollection">
  4840. The Cog3DRangeImageCrossSectionOperatorsParams collection that holds the
  4841. line segments' operators.
  4842. </param>
  4843. <param name="operator1">
  4844. The operator object producing LineSegment1.
  4845. </param>
  4846. <param name="operator2">
  4847. The operator object producing LineSegment2.
  4848. </param>
  4849. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  4850. <para>Fires when this method is called.</para>
  4851. <para>The following state flag may be affected:</para>
  4852. <list type="bullet">
  4853. <item>SfLineSegment1</item>
  4854. <item>SfLineSegment2</item>
  4855. </list>
  4856. </event>
  4857. <remarks>
  4858. This is a convenience setter for programmatic users to specify
  4859. the line segments using the operators' objects.
  4860. The operators are not held internally, they are used to extract
  4861. the internal unique ids of the operators. The ids are used
  4862. by this operator at run time.
  4863. </remarks>
  4864. <remarks>
  4865. The method can be called before the operator is
  4866. added to the collection.
  4867. </remarks>
  4868. <exception cref="T:System.ArgumentException">
  4869. If operator1 and/or operator2 were/was not found
  4870. in the parentCollection provided.
  4871. </exception>
  4872. <exception cref="T:System.ArgumentNullException">
  4873. If the parentCollection in null.
  4874. </exception>
  4875. </member>
  4876. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAngleLineLine.Angle">
  4877. <summary>
  4878. Gets the angle computed by the execute method.
  4879. Always check the status of the operator to be either Passed or FailedTolerance before calling the getter.
  4880. </summary>
  4881. <remarks>
  4882. The angle is measured from LineSegment1 to LineSegment2.
  4883. If SupplementaryAngle is true, the angle is measured from -LineSegment2 to
  4884. LineSegment1.
  4885. The measured angle is in the profile selected space name and
  4886. it is reported in radians.
  4887. </remarks>
  4888. <exception cref="T:System.ArgumentException">
  4889. If the angle was not computed.
  4890. </exception>
  4891. </member>
  4892. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAngleLineLine.LineSegment2">
  4893. <summary>
  4894. Gets or sets the name of the operator producing LineSegment2.
  4895. </summary>
  4896. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  4897. <para>Fires when this property changes.</para>
  4898. <para>The following state flag may be affected:</para>
  4899. <list type="bullet">
  4900. <item>SfLineSegment2</item>
  4901. </list>
  4902. </event>
  4903. <remarks>
  4904. The property is a link between the operator producing the line segment and this operator, and
  4905. therefore requires that all operators are added to the collection before it can be called.
  4906. The name of the operator is not held internally. It is used to extract
  4907. the internal unique id of the operator within the collection.
  4908. </remarks>
  4909. <exception cref="T:System.ArgumentNullException">
  4910. If the operator is not in a collection.
  4911. </exception>
  4912. <exception cref="T:System.ArgumentException">
  4913. If the name of the operator producing LineSegment2 is not found
  4914. in the collection.
  4915. </exception>
  4916. </member>
  4917. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAngleLineLine.LineSegment1">
  4918. <summary>
  4919. Gets or sets the name of the operator producing LineSegment1.
  4920. </summary>
  4921. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  4922. <para>Fires when this property changes.</para>
  4923. <para>The following state flag may be affected:</para>
  4924. <list type="bullet">
  4925. <item>SfLineSegment1</item>
  4926. </list>
  4927. </event>
  4928. <remarks>
  4929. The property is a link between the operator producing the line segment and this operator, and
  4930. therefore requires that all operators are added to the collection before it can be called.
  4931. The name of the operator is not held internally. It is used to extract
  4932. the internal unique id of the operator within the collection.
  4933. </remarks>
  4934. <exception cref="T:System.ArgumentNullException">
  4935. If the operator is not in a collection.
  4936. </exception>
  4937. <exception cref="T:System.ArgumentException">
  4938. If the name of the operator producing LineSegment1 is not found
  4939. in the collection.
  4940. </exception>
  4941. </member>
  4942. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAngleLineLine.SupplementaryAngle">
  4943. <summary>
  4944. Gets or sets the SupplementaryAngle.
  4945. </summary>
  4946. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  4947. <para>Fires when this property changes.</para>
  4948. <para>The following state flag may be affected:</para>
  4949. <list type="bullet">
  4950. <item>SfSupplementaryAngle</item>
  4951. </list>
  4952. </event>
  4953. <remarks>
  4954. If true, the angle returned is the supplementary angle.
  4955. The SupplementaryAngle is measured from -LineSegment2 to LineSegment1.
  4956. </remarks>
  4957. </member>
  4958. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAngleLineLine.AngleTolerance">
  4959. <summary>
  4960. Gets the <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance">tolerance</see> object for
  4961. the angle.
  4962. </summary>
  4963. <remarks>
  4964. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Min" /> and
  4965. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Max" /> values are specified in radians.
  4966. If the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Enabled" /> property is set to true, the tolerance
  4967. check will be performed at run time.
  4968. </remarks>
  4969. </member>
  4970. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAngleLineLine.Finalize">
  4971. <summary>
  4972. Finalize this Cog3DRangeImageCrossSectionAngleLineLine.
  4973. </summary>
  4974. </member>
  4975. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAngleLineLine.Dispose">
  4976. <summary>
  4977. Destruct this Cog3DRangeImageCrossSectionAngleLineLine.
  4978. </summary>
  4979. </member>
  4980. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAngleLineLine.#ctor(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAngleLineLine)">
  4981. <summary>
  4982. Construct a deep copy of the supplied
  4983. Cog3DRangeImageCrossSectionAngleLineLine object.
  4984. </summary>
  4985. <param name="other">
  4986. The Cog3DRangeImageCrossSectionAngleLineLine object to be copied.
  4987. </param>
  4988. <exception cref="T:System.ArgumentNullException">
  4989. If the supplied argument is null.
  4990. </exception>
  4991. <remarks>
  4992. The copy constructor is meant to be used with the collection
  4993. copy constructor.
  4994. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAngleLineLine.LineSegment1" /> and
  4995. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAngleLineLine.LineSegment2" /> properties
  4996. refer to
  4997. internal ids within the <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams">operators</see> collection and
  4998. their values are meaningless outside a collection.
  4999. </remarks>
  5000. </member>
  5001. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAngleLineLine.#ctor">
  5002. <summary>
  5003. Construct a default Cog3DRangeImageCrossSectionAngleLineLine object.
  5004. </summary>
  5005. </member>
  5006. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAngleLineLine.SfNextSf">
  5007. <summary>
  5008. NextSf state flag.
  5009. </summary>
  5010. </member>
  5011. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAngleLineLine.SfAngle">
  5012. <summary>
  5013. This bit will be set in the EventArgs of a Changed event every time
  5014. the value returned by Angle may have changed.
  5015. </summary>
  5016. </member>
  5017. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAngleLineLine.SfSupplementaryAngle">
  5018. <summary>
  5019. This bit will be set in the EventArgs of a Changed event every time
  5020. the value returned by SupplementaryAngle may have changed.
  5021. </summary>
  5022. </member>
  5023. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAngleLineLine.SfLineSegment2">
  5024. <summary>
  5025. This bit will be set in the EventArgs of a Changed event every time
  5026. the value returned by LineSegment2 may have changed.
  5027. </summary>
  5028. </member>
  5029. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAngleLineLine.SfLineSegment1">
  5030. <summary>
  5031. This bit will be set in the EventArgs of a Changed event every time
  5032. the value returned by LineSegment1 may have changed.
  5033. </summary>
  5034. </member>
  5035. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAngleLineLine">
  5036. <summary>
  5037. The class to compute the angle between the lines that extend from the two line segments.
  5038. This operator must be added to the <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams">operators</see> collection before it
  5039. is configured. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAngleLineLine.LineSegment1" /> and
  5040. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAngleLineLine.LineSegment2" /> properties hold the internal ids of the operators producing the line segments, and these operators must also be in the operators collection.
  5041. <para>
  5042. The angle is measured from <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAngleLineLine.LineSegment1" /> to
  5043. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAngleLineLine.LineSegment2" />.
  5044. </para></summary>
  5045. </member>
  5046. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionIntersectLineLine.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  5047. <summary>
  5048. Serialization constructor for Cog3DRangeImageCrossSectionIntersectLineLine
  5049. object.
  5050. </summary>
  5051. <param name="Info">
  5052. The standard SerializationInfo argument.
  5053. </param>
  5054. <param name="Ctxt">
  5055. The standard StreamingContext argument.
  5056. </param>
  5057. </member>
  5058. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionIntersectLineLine.Execute(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile)">
  5059. <summary>
  5060. Computes the intersect point.
  5061. </summary>
  5062. <param name="profile">
  5063. The intersect point is computed in the profile selected space name.
  5064. </param>
  5065. <exception cref="T:Cognex.VisionPro.Exceptions.CogSecurityViolationException">
  5066. If licensing for this class cannot be confirmed.
  5067. </exception>
  5068. <exception cref="T:System.ArgumentNullException">
  5069. If the operator is not in a collection.
  5070. </exception>
  5071. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  5072. <para>Fires when this method is called.</para>
  5073. <para>The following state flag may be affected:</para>
  5074. <list type="bullet">
  5075. <item>SfStatus</item>
  5076. <item>SfIntersectPoint</item>
  5077. <item>SfIntersectPointInImage</item>
  5078. <item>SfIntersectPointInImage3D</item>
  5079. </list>
  5080. </event>
  5081. <remarks>
  5082. <para>
  5083. The status returned can be one of the following:
  5084. <list type="bullet"><item> The intersect point was computed successfully and passed any enabled tolerance checking.
  5085. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">Passed</see></item><item> The intersect point was computed successfully but failed tolerance checking
  5086. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">FailedTolerance </see></item><item> The line segment(s) was/were not found in the collection at run time.
  5087. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">InputFeatureMissing </see></item></list></para>
  5088. </remarks>
  5089. </member>
  5090. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionIntersectLineLine.ClearResults">
  5091. <summary>
  5092. Clear the results' properties of this class.
  5093. </summary>
  5094. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  5095. <para>Fires when this method is called.</para>
  5096. <para>The following state flag may be affected:</para>
  5097. <list type="bullet">
  5098. <para>SfStatus</para>
  5099. <para>SfIntersectPoint</para>
  5100. <para>SfIntersectPointInImage</para>
  5101. <para>SfIntersectPointInImage3D</para>
  5102. </list>
  5103. </event>
  5104. </member>
  5105. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionIntersectLineLine.CreateResultGraphics(Cognex.VisionPro.CogGraphicCollection,System.Boolean)">
  5106. <summary>
  5107. Create the graphics and add them to the graphicCollection provided.
  5108. </summary>
  5109. <param name="graphicCollection">
  5110. A constructed CogGraphicCollection.
  5111. </param>
  5112. <param name="lastRun">
  5113. If lastRun is true, do not include the input graphics.
  5114. </param>
  5115. <remarks>
  5116. The input graphics are the regions of extracted line segment.
  5117. The output graphic is the point graphic.
  5118. </remarks>
  5119. </member>
  5120. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionIntersectLineLine.SetLineSegmentsUsingOperators(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams,Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase,Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase)">
  5121. <summary>
  5122. Sets the name of the operator producing LineSegment1 and LineSegment2.
  5123. </summary>
  5124. <param name="parentCollection">
  5125. The Cog3DRangeImageCrossSectionOperatorsParams collection that holds the
  5126. line segment operator.
  5127. </param>
  5128. <param name="operator1">
  5129. The operator object producing LineSegment.
  5130. </param>
  5131. <param name="operator2">
  5132. The operator object producing LineSegment.
  5133. </param>
  5134. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  5135. <para>Fires when this method is called.</para>
  5136. <para>The following state flag may be affected:</para>
  5137. <list type="bullet">
  5138. <item>SfLineSegment</item>
  5139. </list>
  5140. </event>
  5141. <remarks>
  5142. This is a convenience setter for programmatic users to specify
  5143. the line segments using the operators' objects.
  5144. The operators are not held internally, they are used to extract
  5145. the internal unique ids of the operators. The ids are used
  5146. by this operator at run time.
  5147. </remarks>
  5148. <remarks>
  5149. The method can be called before the operator is
  5150. added to the collection.
  5151. </remarks>
  5152. <exception cref="T:System.ArgumentException">
  5153. If operator is not found
  5154. in the parentCollection provided.
  5155. </exception>
  5156. <exception cref="T:System.ArgumentNullException">
  5157. If the parentCollection in null.
  5158. </exception>
  5159. </member>
  5160. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionIntersectLineLine.IntersectPointInImage3D">
  5161. <summary>
  5162. Gets the point computed by the execute method.
  5163. Always check the status of the operator to be either Passed or FailedTolerance before calling the getter.
  5164. </summary>
  5165. <remarks>
  5166. The point is in the SelectedSpaceName3D of the range image
  5167. stored in the profile.
  5168. </remarks>
  5169. <exception cref="T:System.ArgumentException">
  5170. If the point was not computed.
  5171. The Cog3DVect3 is a ValueType and cannot return a null.
  5172. </exception>
  5173. </member>
  5174. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionIntersectLineLine.IntersectPointInImage">
  5175. <summary>
  5176. Gets the point computed by the execute method.
  5177. </summary>
  5178. <remarks>
  5179. The point is in the SelectedSpaceName of the range image
  5180. stored in the profile.
  5181. Returns null if the point was not computed.
  5182. </remarks>
  5183. </member>
  5184. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionIntersectLineLine.IntersectPoint">
  5185. <summary>
  5186. Gets the point computed by the execute method.
  5187. Always check the status of the operator to be either Passed or FailedTolerance before calling the getter.
  5188. </summary>
  5189. <remarks>
  5190. The point is in the ProfileSelectedSpaceName.
  5191. Returns null if the point was not computed.
  5192. </remarks>
  5193. </member>
  5194. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionIntersectLineLine.LineSegment2">
  5195. <summary>
  5196. Gets or sets the name of the operator producing LineSegment2.
  5197. </summary>
  5198. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  5199. <para>Fires when this property changes.</para>
  5200. <para>The following state flag may be affected:</para>
  5201. <list type="bullet">
  5202. <item>SfLineSegment2</item>
  5203. </list>
  5204. </event>
  5205. <remarks>
  5206. The property is a link between the operator producing the line segment and this operator, and
  5207. therefore requires that all operators are added to the collection before it can be called.
  5208. The name of the operator is not held internally. It is used to extract
  5209. the internal unique id of the operator within the collection.
  5210. </remarks>
  5211. <exception cref="T:System.ArgumentNullException">
  5212. If the operator is not in a collection.
  5213. </exception>
  5214. <exception cref="T:System.ArgumentException">
  5215. If the name of the operator producing LineSegment2 is not found
  5216. in the collection.
  5217. </exception>
  5218. </member>
  5219. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionIntersectLineLine.LineSegment1">
  5220. <summary>
  5221. Gets or sets the name of the operator producing LineSegment1.
  5222. </summary>
  5223. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  5224. <para>Fires when this property changes.</para>
  5225. <para>The following state flag may be affected:</para>
  5226. <list type="bullet">
  5227. <item>SfLineSegment1</item>
  5228. </list>
  5229. </event>
  5230. <remarks>
  5231. The property is a link between the operator producing the line segment and this operator, and
  5232. therefore requires that all operators are added to the collection before it can be called.
  5233. The name of the operator is not held internally. It is used to extract
  5234. the internal unique id of the operator within the collection.
  5235. </remarks>
  5236. <exception cref="T:System.ArgumentNullException">
  5237. If the operator is not in a collection.
  5238. </exception>
  5239. <exception cref="T:System.ArgumentException">
  5240. If the name of the operator producing LineSegment1 is not found
  5241. in the collection.
  5242. </exception>
  5243. </member>
  5244. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionIntersectLineLine.YTolerance">
  5245. <summary>
  5246. Gets the Cog3DRangeImageCrossSectionTolerance object to
  5247. tolerance the Y position.
  5248. </summary>
  5249. <remarks>
  5250. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Min" /> and
  5251. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Max" /> values are specified in profile selected space name.
  5252. If the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Enabled" /> property is set to true, the tolerance
  5253. check will be performed at run time.
  5254. </remarks>
  5255. </member>
  5256. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionIntersectLineLine.XTolerance">
  5257. <summary>
  5258. Gets the Cog3DRangeImageCrossSectionTolerance object to
  5259. tolerance the X position.
  5260. </summary>
  5261. <remarks>
  5262. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Min" /> and
  5263. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Max" /> values are specified in profile selected space name.
  5264. If the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Enabled" /> property is set to true, the tolerance
  5265. check will be performed at run time.
  5266. </remarks>
  5267. </member>
  5268. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionIntersectLineLine.Finalize">
  5269. <summary>
  5270. Finalize this Cog3DRangeImageCrossSectionIntersectLineLine.
  5271. </summary>
  5272. </member>
  5273. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionIntersectLineLine.Dispose">
  5274. <summary>
  5275. Destruct this Cog3DRangeImageCrossSectionIntersectLineLine.
  5276. </summary>
  5277. </member>
  5278. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionIntersectLineLine.#ctor(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionIntersectLineLine)">
  5279. <summary>
  5280. Construct a deep copy of the supplied
  5281. Cog3DRangeImageCrossSectionIntersectLineLine object.
  5282. </summary>
  5283. <param name="other">
  5284. The Cog3DRangeImageCrossSectionIntersectLineLine object to be copied.
  5285. </param>
  5286. <exception cref="T:System.ArgumentNullException">
  5287. If the supplied argument is null.
  5288. </exception>
  5289. <remarks>
  5290. The copy constructor is meant to be used with the collection
  5291. copy constructor.
  5292. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionIntersectLineLine.LineSegment1" /> and
  5293. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionIntersectLineLine.LineSegment2" /> properties
  5294. refer to
  5295. internal ids within the <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams">operators</see> collection and
  5296. their values are meaningless outside a collection.
  5297. </remarks>
  5298. </member>
  5299. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionIntersectLineLine.#ctor">
  5300. <summary>
  5301. Construct a default Cog3DRangeImageCrossSectionIntersectLineLine object.
  5302. </summary>
  5303. </member>
  5304. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionIntersectLineLine.SfNextSf">
  5305. <summary>
  5306. NextSf state flag.
  5307. </summary>
  5308. </member>
  5309. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionIntersectLineLine.SfIntersectPointInImage3D">
  5310. <summary>
  5311. This bit will be set in the EventArgs of a Changed event every time
  5312. the value returned by IntersectPointInImage3D may have changed.
  5313. </summary>
  5314. </member>
  5315. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionIntersectLineLine.SfIntersectPointInImage">
  5316. <summary>
  5317. This bit will be set in the EventArgs of a Changed event every time
  5318. the value returned by IntersectPointInImage may have changed.
  5319. </summary>
  5320. </member>
  5321. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionIntersectLineLine.SfIntersectPoint">
  5322. <summary>
  5323. This bit will be set in the EventArgs of a Changed event every time
  5324. the value returned by IntersectPoint may have changed.
  5325. </summary>
  5326. </member>
  5327. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionIntersectLineLine.SfLineSegment2">
  5328. <summary>
  5329. This bit will be set in the EventArgs of a Changed event every time
  5330. the value returned by LineSegment2 may have changed.
  5331. </summary>
  5332. </member>
  5333. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionIntersectLineLine.SfLineSegment1">
  5334. <summary>
  5335. This bit will be set in the EventArgs of a Changed event every time
  5336. the value returned by LineSegment1 may have changed.
  5337. </summary>
  5338. </member>
  5339. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionIntersectLineLine">
  5340. <summary>
  5341. The class to compute the intersect point between the lines that extend from the two line segments.
  5342. This operator must be added to the <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams">operators</see> collection before it
  5343. is configured. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionIntersectLineLine.LineSegment1" /> and
  5344. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionIntersectLineLine.LineSegment2" /> properties hold the internal ids of the operators producing the line segments, and these operators must also be in the operators collection.
  5345. </summary>
  5346. </member>
  5347. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCorner.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  5348. <summary>
  5349. Serialization constructor for Cog3DRangeImageCrossSectionExtractCorner
  5350. object.
  5351. </summary>
  5352. <param name="Info">
  5353. The standard SerializationInfo argument.
  5354. </param>
  5355. <param name="Ctxt">
  5356. The standard StreamingContext argument.
  5357. </param>
  5358. </member>
  5359. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCorner.NumCorners">
  5360. <summary>
  5361. Returns the number of corners found within the regions.
  5362. </summary>
  5363. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  5364. <para>Fires when this property changes.</para>
  5365. <para>The following state flag may be affected:</para>
  5366. <list type="bullet">
  5367. <item>SfNumCorners</item>
  5368. </list>
  5369. </event>
  5370. </member>
  5371. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCorner.Execute(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile)">
  5372. <summary>
  5373. Extracts a corner.
  5374. </summary>
  5375. <param name="profile">
  5376. The corner is extracted and reported in the profile selected space name.
  5377. </param>
  5378. <exception cref="T:Cognex.VisionPro.Exceptions.CogSecurityViolationException">
  5379. If licensing for this class cannot be confirmed.
  5380. </exception>
  5381. <exception cref="T:System.ArgumentException">
  5382. If the regions selected space name was not found in the profile space tree.
  5383. </exception>
  5384. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  5385. <para>Fires when this property changes.</para>
  5386. <para>The following state flag may be affected:</para>
  5387. <list type="bullet">
  5388. <item>SfStatus</item>
  5389. <item>SfCorner</item>
  5390. <item>SfCornerInImage</item>
  5391. <item>SfCornerInImage3D</item>
  5392. </list>
  5393. </event>
  5394. <remarks>
  5395. <para>
  5396. The status returned can be one of the following:
  5397. <list type="bullet"><item> The corner was extracted successfully and passed any enabled tolerance checking.
  5398. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">Passed</see></item><item> The corner was extracted successfully but failed tolerance checking
  5399. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">FailedTolerance </see></item><item> The corner was not extracted because not enough points were found to extract the corner,
  5400. the corner was below the sharpness threshold or the corner index is outside the range.
  5401. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">FeatureNoExtracted </see></item></list></para>
  5402. </remarks>
  5403. </member>
  5404. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCorner.ClearResults">
  5405. <summary>
  5406. Clear the results' properties of this class.
  5407. </summary>
  5408. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  5409. <para>Fires when this property changes.</para>
  5410. <para>The following state flag may be affected:</para>
  5411. <list type="bullet">
  5412. <para>SfCorner</para>
  5413. <para>SfCornerInImage</para>
  5414. <para>SfCornerInImage3D</para>
  5415. </list>
  5416. </event>
  5417. </member>
  5418. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCorner.CreateResultGraphics(Cognex.VisionPro.CogGraphicCollection,System.Boolean)">
  5419. <summary>
  5420. Create the graphics and add them to the graphicCollection provided.
  5421. </summary>
  5422. <param name="graphicCollection">
  5423. A constructed CogGraphicCollection.
  5424. </param>
  5425. <param name="lastRun">
  5426. If lastRun is true, do not include the input graphics.
  5427. </param>
  5428. <remarks>
  5429. The input graphics are the regions of extracted line segment.
  5430. The output graphic is the point graphic.
  5431. </remarks>
  5432. </member>
  5433. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCorner.YTolerance">
  5434. <summary>
  5435. Gets the Cog3DRangeImageCrossSectionTolerance object to
  5436. tolerance the Y position.
  5437. </summary>
  5438. <remarks>
  5439. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Min" /> and
  5440. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Max" /> values are specified in profile selected space name.
  5441. If the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Enabled" /> property is set to true, the tolerance
  5442. check will be performed at run time.
  5443. </remarks>
  5444. </member>
  5445. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCorner.XTolerance">
  5446. <summary>
  5447. Gets the Cog3DRangeImageCrossSectionTolerance object to
  5448. tolerance the X position.
  5449. </summary>
  5450. <remarks>
  5451. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Min" /> and
  5452. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Max" /> values are specified in profile selected space name.
  5453. If the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Enabled" /> property is set to true, the tolerance
  5454. check will be performed at run time.
  5455. </remarks>
  5456. </member>
  5457. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCorner.CornerInImage3D">
  5458. <summary>
  5459. Gets the corner extracted by the execute method.
  5460. Always check the status of the operator to be either Passed or FailedTolerance before calling the getter.
  5461. </summary>
  5462. <remarks>
  5463. The corner position is in the SelectedSpaceName3D of the range image
  5464. stored in the profile.
  5465. </remarks>
  5466. <exception cref="T:System.ArgumentException">
  5467. If the corner was not computed.
  5468. The Cog3DVect3 is a ValueType and cannot return a null.
  5469. </exception>
  5470. </member>
  5471. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCorner.CornerInImage">
  5472. <summary>
  5473. Gets the corner extracted by the execute method.
  5474. </summary>
  5475. <remarks>
  5476. The corner position is in the SelectedSpaceName of the range image
  5477. stored in the profile.
  5478. Returns null if the corner was not extracted.
  5479. </remarks>
  5480. </member>
  5481. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCorner.Corner">
  5482. <summary>
  5483. Gets the corner extracted by the execute method.
  5484. Always check the status of the operator to be either Passed or FailedTolerance before calling the getter.
  5485. </summary>
  5486. <remarks>
  5487. The corner position is in the ProfileSelectedSpaceName.
  5488. The corner returned is the corner specified by the cornerIndex property.
  5489. Returns null if the corner was not extracted.
  5490. </remarks>
  5491. </member>
  5492. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCorner.CornerIndex">
  5493. <summary>
  5494. Gets or sets the CornerIndex.
  5495. </summary>
  5496. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  5497. <para>Fires when this property changes.</para>
  5498. <para>The following state flag may be affected:</para>
  5499. <list type="bullet">
  5500. <item>SfCornerIndex</item>
  5501. </list>
  5502. </event>
  5503. <remarks>
  5504. The corner with the specified index to be returned as the found corner.
  5505. If more than one corner are found, the corners are sorted first and then
  5506. the corner with the index specified is returned.
  5507. </remarks>
  5508. <exception cref="T:System.ArgumentException">
  5509. If the value is less than 0;
  5510. </exception>
  5511. </member>
  5512. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCorner.FilterHalfSizeInPixels">
  5513. <summary>
  5514. Gets or sets the FilterHalfSizeInPixels.
  5515. </summary>
  5516. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  5517. <para>Fires when this property changes.</para>
  5518. <para>The following state flag may be affected:</para>
  5519. <list type="bullet">
  5520. <item>SfFilterHalfSizeInPixels</item>
  5521. </list>
  5522. </event>
  5523. <remarks> This field holds the half-length of the filter. The actual
  5524. filter length is 1+2*(FilterHalfSizeInPixels).
  5525. </remarks>
  5526. <exception cref="T:System.ArgumentException">
  5527. If the value is less than 1;
  5528. </exception>
  5529. </member>
  5530. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCorner.SortDirectionAngle">
  5531. <summary>
  5532. Gets or sets the SortDirectionAngle. The default is 0.
  5533. </summary>
  5534. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  5535. <para>Fires when this property changes.</para>
  5536. <para>The following state flag may be affected:</para>
  5537. <list type="bullet">
  5538. <item>SfSortDirectionAngle</item>
  5539. </list>
  5540. </event>
  5541. <remarks>
  5542. The field specifies the direction along which the SortType is applied to.
  5543. </remarks>
  5544. </member>
  5545. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCorner.SharpnessThreshold">
  5546. <summary>
  5547. Gets or sets the SharpnessThreshold.
  5548. </summary>
  5549. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  5550. <para>Fires when this property changes.</para>
  5551. <para>The following state flag may be affected:</para>
  5552. <list type="bullet">
  5553. <item>SfSharpnessThreshold</item>
  5554. </list>
  5555. </event>
  5556. <exception cref="T:System.ArgumentException">
  5557. If the value is less than 0 or greater than 65535
  5558. </exception>
  5559. <remarks>
  5560. The sharpness threshold is the minimum value of the sharpness needed for the profile point to be treated
  5561. as corner.
  5562. </remarks>
  5563. </member>
  5564. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCorner.SortType">
  5565. <summary>
  5566. Gets or sets the SortType. Specifies how to sort the corners before finding
  5567. the one specified by the order number.
  5568. </summary>
  5569. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  5570. <para>Fires when this property changes.</para>
  5571. <para>The following state flag may be affected:</para>
  5572. <list type="bullet">
  5573. <item>SfSortType</item>
  5574. </list>
  5575. </event>
  5576. <exception cref="T:System.ArgumentException">
  5577. If the value is invalid.
  5578. </exception>
  5579. </member>
  5580. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCorner.Polarity">
  5581. <summary>
  5582. Gets or sets the corner polarity. Specifies the sign of the sharpness of the corner in the profile.
  5583. </summary>
  5584. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  5585. <para>Fires when this property changes.</para>
  5586. <para>The following state flag may be affected:</para>
  5587. <list type="bullet">
  5588. <item>SfPolarity</item>
  5589. </list>
  5590. </event>
  5591. <exception cref="T:System.ArgumentException">
  5592. If the value is invalid.
  5593. </exception>
  5594. </member>
  5595. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCorner.Finalize">
  5596. <summary>
  5597. Finalize this Cog3DRangeImageCrossSectionExtractCorner.
  5598. </summary>
  5599. </member>
  5600. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCorner.Dispose">
  5601. <summary>
  5602. Destruct this Cog3DRangeImageCrossSectionExtractCorner.
  5603. </summary>
  5604. </member>
  5605. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCorner.#ctor(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCorner)">
  5606. <summary>
  5607. Construct a deep copy of the supplied
  5608. Cog3DRangeImageCrossSectionExtractCorner object.
  5609. </summary>
  5610. <param name="other">
  5611. The Cog3DRangeImageCrossSectionExtractCorner object to be copied.
  5612. </param>
  5613. <exception cref="T:System.ArgumentNullException">
  5614. If the supplied argument is null.
  5615. </exception>
  5616. </member>
  5617. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCorner.#ctor">
  5618. <summary>
  5619. Construct a default Cog3DRangeImageCrossSectionExtractCorner object.
  5620. </summary>
  5621. </member>
  5622. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCorner.SfNextSf">
  5623. <summary>
  5624. NextSf state flag.
  5625. </summary>
  5626. </member>
  5627. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCorner.SfNumCorners">
  5628. <summary>
  5629. This bit will be set in the EventArgs of a Changed event every time
  5630. the value returned by NumCorners may have changed.
  5631. </summary>
  5632. </member>
  5633. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCorner.SfCornerInImage3D">
  5634. <summary>
  5635. This bit will be set in the EventArgs of a Changed event every time
  5636. the value returned by CornerInImage3D may have changed.
  5637. </summary>
  5638. </member>
  5639. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCorner.SfCornerInImage">
  5640. <summary>
  5641. This bit will be set in the EventArgs of a Changed event every time
  5642. the value returned by CornerInImage may have changed.
  5643. </summary>
  5644. </member>
  5645. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCorner.SfCorner">
  5646. <summary>
  5647. This bit will be set in the EventArgs of a Changed event every time
  5648. the value returned by Corner may have changed.
  5649. </summary>
  5650. </member>
  5651. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCorner.SfSharpnessThreshold">
  5652. <summary>
  5653. This bit will be set in the EventArgs of a Changed event every time
  5654. the value returned by SharpnessThershold may have changed.
  5655. </summary>
  5656. </member>
  5657. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCorner.SfFilterHalfSizeInPixels">
  5658. <summary>
  5659. This bit will be set in the EventArgs of a Changed event every time
  5660. the value returned by FilterHalfSizeInPixels may have changed.
  5661. </summary>
  5662. </member>
  5663. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCorner.SfCornerIndex">
  5664. <summary>
  5665. This bit will be set in the EventArgs of a Changed event every time
  5666. the value returned by CornerIndex may have changed.
  5667. </summary>
  5668. </member>
  5669. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCorner.SfSortDirectionAngle">
  5670. <summary>
  5671. This bit will be set in the EventArgs of a Changed event every time
  5672. the value returned by SortDirectionAngle may have changed.
  5673. </summary>
  5674. </member>
  5675. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCorner.SfSortType">
  5676. <summary>
  5677. This bit will be set in the EventArgs of a Changed event every time
  5678. the value returned by SortType may have changed.
  5679. </summary>
  5680. </member>
  5681. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCorner.SfPolarity">
  5682. <summary>
  5683. This bit will be set in the EventArgs of a Changed event every time
  5684. the value returned by Polarity may have changed.
  5685. </summary>
  5686. </member>
  5687. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractCorner">
  5688. <summary>
  5689. The class to extract a corner from profile points that are within the regions.
  5690. This operator holds a collection of regions. There must be always one region in the
  5691. collection. The user may add and delete any region as long as the count does not dip below 1.
  5692. </summary>
  5693. </member>
  5694. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPoint.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  5695. <summary>
  5696. Serialization constructor for Cog3DRangeImageCrossSectionExtractPoint
  5697. object.
  5698. </summary>
  5699. <param name="Info">
  5700. The standard SerializationInfo argument.
  5701. </param>
  5702. <param name="Ctxt">
  5703. The standard StreamingContext argument.
  5704. </param>
  5705. </member>
  5706. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPoint.Execute(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile)">
  5707. <summary>
  5708. Extracts a point.
  5709. </summary>
  5710. <param name="profile">
  5711. The point is extracted and reported in the profile selected space name.
  5712. </param>
  5713. <exception cref="T:Cognex.VisionPro.Exceptions.CogSecurityViolationException">
  5714. If licensing for this class cannot be confirmed.
  5715. </exception>
  5716. <exception cref="T:System.ArgumentException">
  5717. If the regions selected space name was not found in the profile space tree.
  5718. </exception>
  5719. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  5720. <para>Fires when this method is called.</para>
  5721. <para>The following state flag may be affected:</para>
  5722. <list type="bullet">
  5723. <item>SfStatus</item>
  5724. <item>SfPoint</item>
  5725. <item>SfPointInImage</item>
  5726. <item>SfPointInImage3D</item>
  5727. </list>
  5728. </event>
  5729. <remarks>
  5730. <para>
  5731. The status returned can be one of the following:
  5732. <list type="bullet"><item> The point was extracted successfully and passed any enabled tolerance checking.
  5733. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">Passed</see></item><item> The point was extracted successfully but failed tolerance checking
  5734. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">FailedTolerance </see></item><item> The point was not extracted.
  5735. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">FeatureNoExtracted </see></item></list></para>
  5736. </remarks>
  5737. </member>
  5738. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPoint.ClearResults">
  5739. <summary>
  5740. Clear the results' properties of this class.
  5741. </summary>
  5742. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  5743. <para>Fires when this method is called.</para>
  5744. <para>The following state flag may be affected:</para>
  5745. <list type="bullet">
  5746. <para>SfPoint</para>
  5747. <para>SfPointInImage</para>
  5748. <para>SfPointInImage3D</para>
  5749. </list>
  5750. </event>
  5751. </member>
  5752. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPoint.CreateResultGraphics(Cognex.VisionPro.CogGraphicCollection,System.Boolean)">
  5753. <summary>
  5754. Create the graphics and add them to the graphicCollection provided.
  5755. </summary>
  5756. <param name="graphicCollection">
  5757. A constructed CogGraphicCollection.
  5758. </param>
  5759. <param name="lastRun">
  5760. If lastRun is true, do not include the input graphics.
  5761. </param>
  5762. <remarks>
  5763. The input graphics are the regions.
  5764. The output graphic is the point graphic.
  5765. </remarks>
  5766. </member>
  5767. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPoint.YTolerance">
  5768. <summary>
  5769. Gets the Cog3DRangeImageCrossSectionTolerance object to
  5770. tolerance the Y position.
  5771. </summary>
  5772. <remarks>
  5773. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Min" /> and
  5774. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Max" /> values are specified in profile selected space name.
  5775. If the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Enabled" /> property is set to true, the tolerance
  5776. check will be performed at run time.
  5777. </remarks>
  5778. </member>
  5779. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPoint.XTolerance">
  5780. <summary>
  5781. Gets the Cog3DRangeImageCrossSectionTolerance object to
  5782. tolerance the X position.
  5783. </summary>
  5784. <remarks>
  5785. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Min" /> and
  5786. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Max" /> values are specified in profile selected space name.
  5787. If the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Enabled" /> property is set to true, the tolerance
  5788. check will be performed at run time.
  5789. </remarks>
  5790. </member>
  5791. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPoint.PointInImage3D">
  5792. <summary>
  5793. Gets the point extracted by the execute method.
  5794. Always check the status of the operator to be either Passed or FailedTolerance before calling the getter.
  5795. </summary>
  5796. <remarks>
  5797. The point is in the SelectedSpaceName3D of the range image
  5798. stored in the profile.
  5799. </remarks>
  5800. <exception cref="T:System.ArgumentException">
  5801. If the corner was not computed.
  5802. The Cog3DVect3 is a ValueType and cannot return a null.
  5803. </exception>
  5804. </member>
  5805. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPoint.PointInImage">
  5806. <summary>
  5807. Gets the point extracted by the execute method.
  5808. </summary>
  5809. <remarks>
  5810. The point is in the SelectedSpaceName of the range image
  5811. stored in the profile.
  5812. Returns null if the point was not computed.
  5813. </remarks>
  5814. </member>
  5815. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPoint.Point">
  5816. <summary>
  5817. Gets the point extracted by the execute method.
  5818. </summary>
  5819. <remarks>
  5820. The point is in the ProfileSelectedSpaceName.
  5821. Returns null if the point was not computed.
  5822. </remarks>
  5823. </member>
  5824. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPoint.SetLineSegmentUsingOperator(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams,Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase)">
  5825. <summary>
  5826. Sets the name of the operator producing LineSegment.
  5827. </summary>
  5828. <param name="parentCollection">
  5829. The Cog3DRangeImageCrossSectionOperatorsParams collection that holds the
  5830. line segment operator.
  5831. </param>
  5832. <param name="op">
  5833. The operator object producing LineSegment.
  5834. </param>
  5835. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  5836. <para>Fires when this method is called.</para>
  5837. <para>The following state flag may be affected:</para>
  5838. <list type="bullet">
  5839. <item>SfLineSegment</item>
  5840. </list>
  5841. </event>
  5842. <remarks>
  5843. This is a convenience setter for programmatic users to specify
  5844. the line segment using the operator's object.
  5845. The operator is not held internally, it is used to extract
  5846. the internal unique id of the operator. The id is used
  5847. by this operator at run time.
  5848. </remarks>
  5849. <remarks>
  5850. The method can be called before the operator is
  5851. added to the collection.
  5852. </remarks>
  5853. <exception cref="T:System.ArgumentException">
  5854. If operator is not found
  5855. in the parentCollection provided.
  5856. </exception>
  5857. <exception cref="T:System.ArgumentNullException">
  5858. If the parentCollection in null.
  5859. </exception>
  5860. </member>
  5861. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPoint.DirectionRelativeToLineSegment">
  5862. <summary>
  5863. Gets or sets the direction of the point extraction relative to the line segment.
  5864. The value of this property will be used only if <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPoint.DirectionSelectionMode" />
  5865. is set to <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPointDirectionSelectionModeConstants.DirectionFromLineSegment" /></summary>
  5866. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  5867. <para>Fires when this property changes.</para>
  5868. <para>The following state flag may be affected:</para>
  5869. <list type="bullet">
  5870. <item>SfDirectionRelativeToLineSegment</item>
  5871. </list>
  5872. </event>
  5873. <exception cref="T:System.ArgumentException">
  5874. If the value is invalid.
  5875. </exception>
  5876. </member>
  5877. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPoint.LineSegment">
  5878. <summary>
  5879. Gets or sets the name of the operator producing LineSegment.
  5880. The value of this property will be used only if <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPoint.DirectionSelectionMode" />
  5881. is set to <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPointDirectionSelectionModeConstants.DirectionFromLineSegment" /></summary>
  5882. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  5883. <para>Fires when this property changes.</para>
  5884. <para>The following state flag may be affected:</para>
  5885. <list type="bullet">
  5886. <item>SfLineSegment</item>
  5887. </list>
  5888. </event>
  5889. <remarks>
  5890. The property is a link between the operator producing the line segment and this operator, and
  5891. therefore requires that all operators are added to the collection before it can be called.
  5892. The name of the operator is not held internally. It is used to extract
  5893. the internal unique id of the operator within the collection.
  5894. </remarks>
  5895. <exception cref="T:System.ArgumentNullException">
  5896. If the operator is not in a collection.
  5897. </exception>
  5898. <exception cref="T:System.ArgumentException">
  5899. If the name of the operator producing LineSegment is not found
  5900. in the collection.
  5901. </exception>
  5902. </member>
  5903. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPoint.AngleSelectedSpace">
  5904. <summary>
  5905. Gets or sets the selected space of the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPointDirectionSelectionModeConstants.Angle" />.
  5906. The value of this property will be used only if <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPoint.DirectionSelectionMode" />
  5907. is set to <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPointDirectionSelectionModeConstants.DirectionFromAngle" /></summary>
  5908. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  5909. <para>Fires when this property changes.</para>
  5910. <para>The following state flag may be affected:</para>
  5911. <list type="bullet">
  5912. <item>SfAngleSelectedSpace</item>
  5913. </list>
  5914. </event>
  5915. <exception cref="T:System.ArgumentException">
  5916. If the value is invalid.
  5917. </exception>
  5918. </member>
  5919. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPoint.Angle">
  5920. <summary>
  5921. Gets or sets the Angle in radians from the X-axis.
  5922. The X-axis is either in profile default space or profile selected space based on the value of <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPoint.AngleSelectedSpace" />
  5923. The value of this property will be used only if <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPoint.DirectionSelectionMode" />
  5924. is set to <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPointDirectionSelectionModeConstants.DirectionFromAngle" /></summary>
  5925. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  5926. <para>Fires when this property changes.</para>
  5927. <para>The following state flag may be affected:</para>
  5928. <list type="bullet">
  5929. <item>SfAngle</item>
  5930. </list>
  5931. </event>
  5932. </member>
  5933. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPoint.DirectionSelectionMode">
  5934. <summary>
  5935. Gets or sets the how the direction of the point extraction will be specified.
  5936. </summary>
  5937. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  5938. <para>Fires when this property changes.</para>
  5939. <para>The following state flag may be affected:</para>
  5940. <list type="bullet">
  5941. <item>SfDirectionSelectionMode</item>
  5942. </list>
  5943. </event>
  5944. <exception cref="T:System.ArgumentException">
  5945. If the value is invalid.
  5946. </exception>
  5947. </member>
  5948. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPoint.PointType">
  5949. <summary>
  5950. Gets or sets the point type. Specifies the point to extract.
  5951. The value of this property will be used only if <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPoint.DirectionSelectionMode" />
  5952. is set to <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPointDirectionSelectionModeConstants.DirectionFromPredefinedList" /></summary>
  5953. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  5954. <para>Fires when this property changes.</para>
  5955. <para>The following state flag may be affected:</para>
  5956. <list type="bullet">
  5957. <item>SfPointType</item>
  5958. </list>
  5959. </event>
  5960. <exception cref="T:System.ArgumentException">
  5961. If the value is invalid.
  5962. </exception>
  5963. </member>
  5964. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPoint.Finalize">
  5965. <summary>
  5966. Finalize this Cog3DRangeImageCrossSectionExtractPoint.
  5967. </summary>
  5968. </member>
  5969. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPoint.Dispose">
  5970. <summary>
  5971. Destruct this Cog3DRangeImageCrossSectionExtractPoint.
  5972. </summary>
  5973. </member>
  5974. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPoint.#ctor(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPoint)">
  5975. <summary>
  5976. Construct a deep copy of the supplied
  5977. Cog3DRangeImageCrossSectionExtractPoint object.
  5978. </summary>
  5979. <param name="other">
  5980. The Cog3DRangeImageCrossSectionExtractPoint object to be copied.
  5981. </param>
  5982. <exception cref="T:System.ArgumentNullException">
  5983. If the supplied argument is null.
  5984. </exception>
  5985. </member>
  5986. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPoint.#ctor">
  5987. <summary>
  5988. Construct a default Cog3DRangeImageCrossSectionExtractPoint object.
  5989. </summary>
  5990. </member>
  5991. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPoint.SfNextSf">
  5992. <summary>
  5993. NextSf state flag.
  5994. </summary>
  5995. </member>
  5996. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPoint.SfLineSegment">
  5997. <summary>
  5998. This bit will be set in the EventArgs of a Changed event every time
  5999. the value returned by LineSegment may have changed.
  6000. </summary>
  6001. </member>
  6002. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPoint.SfDirectionRelativeToLineSegment">
  6003. <summary>
  6004. This bit will be set in the EventArgs of a Changed event every time
  6005. the value returned by DirectionRelativeToLineSegment may have changed.
  6006. </summary>
  6007. </member>
  6008. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPoint.SfAngle">
  6009. <summary>
  6010. This bit will be set in the EventArgs of a Changed event every time
  6011. the value returned by Angle may have changed.
  6012. </summary>
  6013. </member>
  6014. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPoint.SfAngleSelectedSpace">
  6015. <summary>
  6016. This bit will be set in the EventArgs of a Changed event every time
  6017. the value returned by AngleSelectedSpace may have changed.
  6018. </summary>
  6019. </member>
  6020. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPoint.SfDirectionSelectionMode">
  6021. <summary>
  6022. This bit will be set in the EventArgs of a Changed event every time
  6023. the value returned by DirectionSelectionMode may have changed.
  6024. </summary>
  6025. </member>
  6026. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPoint.SfPointInImage3D">
  6027. <summary>
  6028. This bit will be set in the EventArgs of a Changed event every time
  6029. the value returned by PointInImage3D may have changed.
  6030. </summary>
  6031. </member>
  6032. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPoint.SfPointInImage">
  6033. <summary>
  6034. This bit will be set in the EventArgs of a Changed event every time
  6035. the value returned by PointInImage may have changed.
  6036. </summary>
  6037. </member>
  6038. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPoint.SfPoint">
  6039. <summary>
  6040. This bit will be set in the EventArgs of a Changed event every time
  6041. the value returned by Point may have changed.
  6042. </summary>
  6043. </member>
  6044. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPoint.SfPointType">
  6045. <summary>
  6046. This bit will be set in the EventArgs of a Changed event every time
  6047. the value returned by PointType may have changed.
  6048. </summary>
  6049. </member>
  6050. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPoint">
  6051. <summary>
  6052. The class To extract a point.
  6053. This operator holds a collection of regions. There must be always one region in the
  6054. collection. The user may add and delete any region as long as the count does not dip below 1.
  6055. </summary>
  6056. </member>
  6057. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractLineSegment.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  6058. <summary>
  6059. Serialization constructor for Cog3DRangeImageCrossSectionExtractLineSegment
  6060. object.
  6061. </summary>
  6062. <param name="Info">
  6063. The standard SerializationInfo argument.
  6064. </param>
  6065. <param name="Ctxt">
  6066. The standard StreamingContext argument.
  6067. </param>
  6068. </member>
  6069. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractLineSegment.Execute(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile)">
  6070. <summary>
  6071. Extracts a line segment.
  6072. </summary>
  6073. <param name="profile">
  6074. The line segment is extracted and reported in the profile selected space name.
  6075. </param>
  6076. <exception cref="T:Cognex.VisionPro.Exceptions.CogSecurityViolationException">
  6077. If licensing for this class cannot be confirmed.
  6078. </exception>
  6079. <exception cref="T:System.ArgumentException">
  6080. If the regions selected space name was not found in the profile space tree.
  6081. </exception>
  6082. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  6083. <para>Fires when this method is called.</para>
  6084. <para>The following state flag may be affected:</para>
  6085. <list type="bullet">
  6086. <item>SfStatus</item>
  6087. <item>SfLineSegment</item>
  6088. <item>SfLineSegmentInImage</item>
  6089. <item>SfLineSegmentInImage3D</item>
  6090. </list>
  6091. </event>
  6092. <remarks>
  6093. <para>
  6094. The status returned can be one of the following:
  6095. <list type="bullet"><item> The line segment was extracted successfully and passed any enabled tolerance checking.
  6096. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">Passed</see></item><item> The line segment was extracted successfully but failed tolerance checking
  6097. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">FailedTolerance </see></item><item> The line segment was not extracted because because not enough points were found to extract the line.
  6098. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">FeatureNoExtracted </see></item></list></para>
  6099. </remarks>
  6100. </member>
  6101. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractLineSegment.ClearResults">
  6102. <summary>
  6103. Clear the results' properties of this class.
  6104. </summary>
  6105. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  6106. <para>Fires when this method is called.</para>
  6107. <para>The following state flag may be affected:</para>
  6108. <list type="bullet">
  6109. <para>SfRMSError</para>
  6110. <para>SfLineSegment</para>
  6111. <para>SfLineSegmentInImage</para>
  6112. <para>SfLineSegmentInImage3D</para>
  6113. </list>
  6114. </event>
  6115. </member>
  6116. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractLineSegment.CreateResultGraphics(Cognex.VisionPro.CogGraphicCollection,System.Boolean)">
  6117. <summary>
  6118. Create the graphics and add them to the graphicCollection provided.
  6119. </summary>
  6120. <param name="graphicCollection">
  6121. A constructed CogGraphicCollection.
  6122. </param>
  6123. <param name="lastRun">
  6124. If lastRun is true, do not include the input graphics.
  6125. </param>
  6126. <remarks>
  6127. The input graphics are the regions.
  6128. The output graphic is the line segment graphic.
  6129. </remarks>
  6130. </member>
  6131. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractLineSegment.EndYTolerance">
  6132. <summary>
  6133. Gets the Cog3DRangeImageCrossSectionTolerance object to
  6134. tolerance the EndY position.
  6135. </summary>
  6136. <remarks>
  6137. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Min" /> and
  6138. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Max" /> values are specified in profile selected space name.
  6139. If the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Enabled" /> property is set to true, the tolerance
  6140. check will be performed at run time.
  6141. </remarks>
  6142. </member>
  6143. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractLineSegment.EndXTolerance">
  6144. <summary>
  6145. Gets the Cog3DRangeImageCrossSectionTolerance object to
  6146. tolerance the EndX position.
  6147. </summary>
  6148. <remarks>
  6149. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Min" /> and
  6150. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Max" /> values are specified in profile selected space name.
  6151. If the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Enabled" /> property is set to true, the tolerance
  6152. check will be performed at run time.
  6153. </remarks>
  6154. </member>
  6155. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractLineSegment.StartYTolerance">
  6156. <summary>
  6157. Gets the Cog3DRangeImageCrossSectionTolerance object to
  6158. tolerance the StartY position.
  6159. </summary>
  6160. <remarks>
  6161. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Min" /> and
  6162. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Max" /> values are specified in profile selected space name.
  6163. If the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Enabled" /> property is set to true, the tolerance
  6164. check will be performed at run time.
  6165. </remarks>
  6166. </member>
  6167. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractLineSegment.StartXTolerance">
  6168. <summary>
  6169. Gets the Cog3DRangeImageCrossSectionTolerance object to
  6170. tolerance the StartX position.
  6171. </summary>
  6172. <remarks>
  6173. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Min" /> and
  6174. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Max" /> values are specified in profile selected space name.
  6175. If the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Enabled" /> property is set to true, the tolerance
  6176. check will be performed at run time.
  6177. </remarks>
  6178. </member>
  6179. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractLineSegment.RMSTolerance">
  6180. <summary>
  6181. Gets the <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance">tolerance</see> object for
  6182. the RMS error.
  6183. </summary>
  6184. <remarks>
  6185. If the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Enabled" /> property is set to true, the tolerance
  6186. check will be performed at run time.
  6187. </remarks>
  6188. </member>
  6189. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractLineSegment.AngleTolerance">
  6190. <summary>
  6191. Gets the <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance">tolerance</see> object for
  6192. the angle.
  6193. </summary>
  6194. <remarks>
  6195. The <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Min" /> and
  6196. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Max" /> values are specified in radians.
  6197. If the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Enabled" /> property is set to true, the tolerance
  6198. check will be performed at run time.
  6199. </remarks>
  6200. </member>
  6201. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractLineSegment.RMSError">
  6202. <summary>
  6203. Gets the RMS error of the line segment.
  6204. </summary>
  6205. <remarks>
  6206. RMS is the root mean squared perpendicular error between
  6207. the line and all of the points in the user specified region
  6208. </remarks>
  6209. </member>
  6210. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractLineSegment.LineSegmentInImage3D">
  6211. <summary>
  6212. Gets the line segment extracted by the execute method.
  6213. </summary>
  6214. <remarks>
  6215. The line segment is in the SelectedSpaceName3D of the range image
  6216. stored in the profile.
  6217. Return null is the line segment was not computed.
  6218. </remarks>
  6219. </member>
  6220. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractLineSegment.LineSegmentInImage">
  6221. <summary>
  6222. Gets the line segment extracted by the execute method.
  6223. </summary>
  6224. <remarks>
  6225. The line segment is in the SelectedSpaceName of the range image
  6226. stored in the profile.
  6227. Return null is the line segment was not computed.
  6228. </remarks>
  6229. </member>
  6230. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractLineSegment.LineSegment">
  6231. <summary>
  6232. Gets the line segment extracted by the execute method.
  6233. Always check the status of the operator to be either Passed or FailedTolerance before calling the getter.
  6234. </summary>
  6235. <remarks>
  6236. The line segment is in the ProfileSelectedSpaceName.
  6237. Return null is the line segment was not computed.
  6238. </remarks>
  6239. </member>
  6240. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractLineSegment.Finalize">
  6241. <summary>
  6242. Finalize this Cog3DRangeImageCrossSectionExtractLineSegment.
  6243. </summary>
  6244. </member>
  6245. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractLineSegment.Dispose">
  6246. <summary>
  6247. Destruct this Cog3DRangeImageCrossSectionExtractLineSegment.
  6248. </summary>
  6249. </member>
  6250. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractLineSegment.#ctor(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractLineSegment)">
  6251. <summary>
  6252. Construct a deep copy of the supplied
  6253. Cog3DRangeImageCrossSectionExtractLineSegment object.
  6254. </summary>
  6255. <param name="other">
  6256. The Cog3DRangeImageCrossSectionExtractLineSegment object to be copied.
  6257. </param>
  6258. <exception cref="T:System.ArgumentNullException">
  6259. If the supplied argument is null.
  6260. </exception>
  6261. </member>
  6262. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractLineSegment.#ctor">
  6263. <summary>
  6264. Construct a default Cog3DRangeImageCrossSectionExtractLineSegment object.
  6265. </summary>
  6266. </member>
  6267. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractLineSegment.SfNextSf">
  6268. <summary>
  6269. NextSf state flag.
  6270. </summary>
  6271. </member>
  6272. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractLineSegment.SfLineSegmentInImage3D">
  6273. <summary>
  6274. This bit will be set in the EventArgs of a Changed event every time
  6275. the value returned by LineSegmentInImage3D may have changed.
  6276. </summary>
  6277. </member>
  6278. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractLineSegment.SfLineSegmentInImage">
  6279. <summary>
  6280. This bit will be set in the EventArgs of a Changed event every time
  6281. the value returned by LineSegmentInImage may have changed.
  6282. </summary>
  6283. </member>
  6284. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractLineSegment.SfLineSegment">
  6285. <summary>
  6286. This bit will be set in the EventArgs of a Changed event every time
  6287. the value returned by LineSegment may have changed.
  6288. </summary>
  6289. </member>
  6290. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractLineSegment.SfRMSError">
  6291. <summary>
  6292. This bit will be set in the EventArgs of a Changed event every time
  6293. the value returned by RMSError may have changed.
  6294. </summary>
  6295. </member>
  6296. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractLineSegment">
  6297. <summary>
  6298. The class to extract a line segment from a profile points that are within the regions.
  6299. This operator holds a collection of regions. There must be always one region in the
  6300. collection. The user may add and delete any region as long as the count does not dip below 1.
  6301. </summary>
  6302. </member>
  6303. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase.Parent">
  6304. <summary>
  6305. Cognex Internal Use Only.
  6306. </summary>
  6307. returns the parent of the operator which is a pointer to OperatorsParams.
  6308. </member>
  6309. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase.InternalID">
  6310. <summary>
  6311. Cognex Internal Use Only.
  6312. </summary>
  6313. returns the internal unique ID of the operator
  6314. </member>
  6315. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  6316. <summary>
  6317. Serialization constructor for Cog3DRangeImageCrossSectionOperatorBase
  6318. object.
  6319. </summary>
  6320. <param name="Info">
  6321. The standard SerializationInfo argument.
  6322. </param>
  6323. <param name="Ctxt">
  6324. The standard StreamingContext argument.
  6325. </param>
  6326. </member>
  6327. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase.GetDefaultRegion">
  6328. <summary>
  6329. Gets the default location for a new region
  6330. The default location is a 10x10mm rectangle in the center of the profile
  6331. </summary>
  6332. </member>
  6333. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase.SetRegionToDefaultLocation(System.Int32)">
  6334. <summary>
  6335. Sets the region with the given index to the default region location
  6336. Cognex Internal Use Only.
  6337. </summary>
  6338. <param name="idx">
  6339. The index of the region to be set to the default location.
  6340. </param>
  6341. </member>
  6342. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase.AddDefaultRegion">
  6343. <summary>
  6344. Adds a new region to the operator with a default location
  6345. </summary>
  6346. </member>
  6347. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase.ImageUsedForProfileDisplay">
  6348. <summary>
  6349. Cognex Internal Use Only.
  6350. </summary>
  6351. </member>
  6352. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase.CreateResultGraphics(Cognex.VisionPro.CogGraphicCollection,System.Boolean)">
  6353. <summary>
  6354. Create the graphics and add them to the graphicCollection provided..
  6355. </summary>
  6356. <param name="graphicCollection">
  6357. A constructed CogGraphicCollection.
  6358. </param>
  6359. <param name="lastRun">
  6360. If lastRun is true, do not include the input graphics.
  6361. </param>
  6362. </member>
  6363. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase.ClearResults">
  6364. <summary>
  6365. Clear the results' properties.
  6366. </summary>
  6367. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  6368. <para>Fires when this method is called.</para>
  6369. <para>The following state flag may be affected:</para>
  6370. <list type="bullet">
  6371. <item>SfStatus</item>
  6372. <item>SfResultObject</item>
  6373. <item>SfFeatureInImage</item>
  6374. <item>SfFeatureInImage3D</item>
  6375. </list>
  6376. </event>
  6377. </member>
  6378. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase.FeatureInImage3D">
  6379. <summary>
  6380. If the operator produces a feature, the feature is returned
  6381. in the range image SelectedSpaceName3D stored in the profile.
  6382. The FeatureInImage3D is available after the operator was run.
  6383. The FeatureInImage3D is set to null at the beginning of the tool run.
  6384. </summary>
  6385. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  6386. <para>Fires when this property changes.</para>
  6387. <para>The following state flag may be affected:</para>
  6388. <list type="bullet">
  6389. <item>SfFeatureInImage3D</item>
  6390. </list>
  6391. </event>
  6392. </member>
  6393. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase.FeatureInImage">
  6394. <summary>
  6395. If the operator produces a feature, the feature is returned
  6396. in the range image SelectedSpaceName stored in the profile.
  6397. The FeatureInImage is available after the operator was run.
  6398. The FeatureInImage is set to null at the beginning of the tool run.
  6399. </summary>
  6400. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  6401. <para>Fires when this property changes.</para>
  6402. <para>The following state flag may be affected:</para>
  6403. <list type="bullet">
  6404. <item>SfFeatureInImage</item>
  6405. </list>
  6406. </event>
  6407. </member>
  6408. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase.ResultObject">
  6409. <summary>
  6410. Gets the ResultObject of the operator.
  6411. The ResultObject is available after the operator was run.
  6412. The ResultObject is set to null at the beginning of the tool run.
  6413. </summary>
  6414. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  6415. <para>Fires when this property changes.</para>
  6416. <para>The following state flag may be affected:</para>
  6417. <list type="bullet">
  6418. <item>SfResultObject</item>
  6419. </list>
  6420. </event>
  6421. </member>
  6422. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase.GetNamesOfOperatorsByType(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOutputTypeConstants)">
  6423. <summary>
  6424. Gets the names of the operators by output type from the OperatorsParams
  6425. collection.
  6426. It returns only the operators that are listed prior to this operator
  6427. in the OperatorsParams collection.
  6428. Returns null if no operator was found.
  6429. </summary>
  6430. </member>
  6431. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase.Execute(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile)">
  6432. <summary>
  6433. Runs the operator.
  6434. </summary>
  6435. <param name="profile">
  6436. The profile.
  6437. </param>
  6438. </member>
  6439. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase.OutputType">
  6440. <summary>
  6441. Gets the OutputType of the operator.
  6442. </summary>
  6443. </member>
  6444. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase.Name">
  6445. <summary>
  6446. Gets or sets the name of the operator.
  6447. When the operator is within a collection, the name is checked for uniqueness.
  6448. </summary>
  6449. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  6450. <para>Fires when this property changes.</para>
  6451. <para>The following state flag may be affected:</para>
  6452. <list type="bullet">
  6453. <item>SfName</item>
  6454. </list>
  6455. </event>
  6456. <exception cref="T:System.ArgumentException">
  6457. If the supplied argument is null or contains white spaces.
  6458. </exception>
  6459. <exception cref="T:System.ArgumentException">
  6460. If the supplied argument is not unique.
  6461. </exception>
  6462. </member>
  6463. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase.Status">
  6464. <summary>
  6465. Gets the status.
  6466. </summary>
  6467. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  6468. <para>Fires when this property changes.</para>
  6469. <para>The following state flag may be affected:</para>
  6470. <list type="bullet">
  6471. <item>SfStatus</item>
  6472. </list>
  6473. </event>
  6474. </member>
  6475. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase.CombineGraphicsEnabled">
  6476. <summary>
  6477. Gets or sets the CombineGraphicsEnabled.
  6478. When true, the combined graphics will be displayed in the last run record.
  6479. Combined graphics usually are the features or measurements produced by an
  6480. operator.
  6481. </summary>
  6482. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  6483. <para>Fires when this property changes.</para>
  6484. <para>The following state flag may be affected:</para>
  6485. <list type="bullet">
  6486. <item>SfCombineGraphicsEnabled</item>
  6487. </list>
  6488. </event>
  6489. </member>
  6490. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase.OutputGraphicsEnabled">
  6491. <summary>
  6492. Gets or sets the OutputGraphicsEnabled.
  6493. When true, the output graphics will be displayed in the current record.
  6494. Output graphics usually are the features or measurements produced by an
  6495. operator.
  6496. </summary>
  6497. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  6498. <para>Fires when this property changes.</para>
  6499. <para>The following state flag may be affected:</para>
  6500. <list type="bullet">
  6501. <item>SfOutputGraphicsEnabled</item>
  6502. </list>
  6503. </event>
  6504. </member>
  6505. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase.InputGraphicsEnabled">
  6506. <summary>
  6507. Gets or sets the InputGraphicsEnabled.
  6508. When true, the input graphics will be displayed in the current record.
  6509. Input graphics usually are the regions.
  6510. </summary>
  6511. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  6512. <para>Fires when this property changes.</para>
  6513. <para>The following state flag may be affected:</para>
  6514. <list type="bullet">
  6515. <item>SfInputGraphicsEnabled</item>
  6516. </list>
  6517. </event>
  6518. </member>
  6519. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase.SelectedRegionIndex">
  6520. <summary>
  6521. Cognex Internal Use Only.
  6522. </summary>
  6523. </member>
  6524. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase.Regions">
  6525. <summary>
  6526. Gets the Regions. The regions property is a collection of ICogRegion.
  6527. </summary>
  6528. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  6529. <para>Fires when this property changes.</para>
  6530. <para>The following state flag may be affected:</para>
  6531. <list type="bullet">
  6532. <item>SfRegions</item>
  6533. </list>
  6534. </event>
  6535. <remarks> Extract operator creates one region during construction.
  6536. The last region cannot be deleted.
  6537. </remarks>
  6538. </member>
  6539. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase.Tolerances(System.String)">
  6540. <summary>
  6541. Gets the Tolerance object of an item specified by name.
  6542. if name is not found, the return is null.
  6543. </summary>
  6544. <param name="name">
  6545. The name of the tolerance object requested.
  6546. </param>
  6547. </member>
  6548. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase.ToleranceCollection">
  6549. <summary>
  6550. Gets the ToleranceCollection. The ToleranceCollection is initialiazed by the operator and the user
  6551. will not be able to delete or add to it. Each operator adds a pre-defined set based on the operator
  6552. result object. By default, all tolerances are disabled.
  6553. </summary>
  6554. </member>
  6555. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase.Finalize">
  6556. <summary>
  6557. Finalize this Cog3DRangeImageCrossSectionOperatorBase.
  6558. </summary>
  6559. </member>
  6560. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase.Dispose">
  6561. <summary>
  6562. Destruct this Cog3DRangeImageCrossSectionOperatorBase.
  6563. </summary>
  6564. </member>
  6565. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase.#ctor(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase)">
  6566. <summary>
  6567. Construct a deep copy of the supplied
  6568. Cog3DRangeImageCrossSectionOperatorBase object.
  6569. </summary>
  6570. <param name="other">
  6571. The Cog3DRangeImageCrossSectionOperatorBase object to be copied.
  6572. May not be null.
  6573. </param>
  6574. <exception cref="T:System.ArgumentNullException">
  6575. If the supplied argument is null.
  6576. </exception>
  6577. </member>
  6578. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase.#ctor(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOutputTypeConstants)">
  6579. <summary>
  6580. Construct a default Cog3DRangeImageCrossSectionOperatorBase object.
  6581. </summary>
  6582. </member>
  6583. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase.SfNextSf">
  6584. <summary>
  6585. NextSf state flag.
  6586. </summary>
  6587. </member>
  6588. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase.SfFeatureInImage3D">
  6589. <summary>
  6590. This bit will be set in the EventArgs of a Changed event every time
  6591. the value returned by FeatureInImage3D may have changed.
  6592. </summary>
  6593. </member>
  6594. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase.SfFeatureInImage">
  6595. <summary>
  6596. This bit will be set in the EventArgs of a Changed event every time
  6597. the value returned by FeatureInImage may have changed.
  6598. </summary>
  6599. </member>
  6600. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase.SfToleranceCollection">
  6601. <summary>
  6602. This bit will be set in the EventArgs of a Changed event every time
  6603. the value returned by ToleranceCollection may have changed.
  6604. </summary>
  6605. </member>
  6606. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase.SfSelectedRegionIndex">
  6607. <summary>
  6608. This bit will be set in the EventArgs of a Changed event every time
  6609. the value returned by SelectedRegionIndex may have changed.
  6610. </summary>
  6611. </member>
  6612. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase.SfRegions">
  6613. <summary>
  6614. This bit will be set in the EventArgs of a Changed event every time
  6615. the value returned by Regions may have changed.
  6616. </summary>
  6617. </member>
  6618. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase.SfCombineGraphicsEnabled">
  6619. <summary>
  6620. This bit will be set in the EventArgs of a Changed event every time
  6621. the value returned by CombinedGraphicsEnabled may have changed.
  6622. </summary>
  6623. </member>
  6624. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase.SfOutputGraphicsEnabled">
  6625. <summary>
  6626. This bit will be set in the EventArgs of a Changed event every time
  6627. the value returned by OutputGraphicsEnabled may have changed.
  6628. </summary>
  6629. </member>
  6630. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase.SfInputGraphicsEnabled">
  6631. <summary>
  6632. This bit will be set in the EventArgs of a Changed event every time
  6633. the value returned by InputGraphicsEnabled may have changed.
  6634. </summary>
  6635. </member>
  6636. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase.SfResultObject">
  6637. <summary>
  6638. This bit will be set in the EventArgs of a Changed event every time
  6639. the value returned by ResultObject may have changed.
  6640. </summary>
  6641. </member>
  6642. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase.SfStatus">
  6643. <summary>
  6644. This bit will be set in the EventArgs of a Changed event every time
  6645. the value returned by Status may have changed.
  6646. </summary>
  6647. </member>
  6648. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase.SfName">
  6649. <summary>
  6650. This bit will be set in the EventArgs of a Changed event every time
  6651. the value returned by Name may have changed.
  6652. </summary>
  6653. </member>
  6654. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase">
  6655. <summary>
  6656. The Cross Section operator base class.
  6657. The class holds common properties across operators.
  6658. </summary>
  6659. </member>
  6660. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  6661. <summary>
  6662. Serialization constructor for Cog3DRangeImageCrossSectionProfileParams
  6663. object.
  6664. </summary>
  6665. <param name="Info">
  6666. The standard SerializationInfo argument.
  6667. </param>
  6668. <param name="Ctxt">
  6669. The standard StreamingContext argument.
  6670. </param>
  6671. </member>
  6672. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams.Execute(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile)">
  6673. <summary>
  6674. The execute method in this class is responsible for:
  6675. <list type="bullet"><item>Fixturing the profile: adding a user defined space
  6676. to the profile space tree in the output profile (optional)
  6677. </item><item> Running the operators. The operators are run in the resulting
  6678. profile space. The operators interpret their regions in that space
  6679. and produce results in that space.
  6680. </item></list></summary>
  6681. <param name="profile">
  6682. The profile.
  6683. </param>
  6684. <exception cref="T:System.ArgumentNullException">
  6685. <para> If the supplied profile is null. </para>
  6686. <para> If the ProfileNewSpaceName is null and ProfileSpaceSelection
  6687. is set to New.
  6688. </para>
  6689. <para> If the ProfileExistingSpaceName is null and ProfileSpaceSelection
  6690. is set to Existing.
  6691. </para>
  6692. </exception>
  6693. <exception cref="T:System.ArgumentException">
  6694. If the supplied profile is invalid.
  6695. </exception>
  6696. <exception cref="T:Cognex.VisionPro.Exceptions.CogSecurityViolationException">
  6697. If licensing bit for this class cannot be confirmed.
  6698. </exception>
  6699. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  6700. <para>Fires when execute is called.</para>
  6701. <para>The following state flag may be affected:</para>
  6702. <list type="bullet">
  6703. <item>SfStatus</item>
  6704. </list>
  6705. </event>
  6706. </member>
  6707. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams.IsNameUnique(System.String)">
  6708. <summary>
  6709. Checks if the name is unique within the collection.
  6710. Return true if unique, false otherwise.
  6711. </summary>
  6712. </member>
  6713. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams.ProfileExistingSpaceName">
  6714. <summary>
  6715. Gets or sets the ProfileExistingSpaceName.
  6716. </summary>
  6717. <value>
  6718. The default is null.
  6719. </value>
  6720. <exception cref="T:System.ArgumentException">
  6721. If the supplied argument is null or an empty string.
  6722. </exception>
  6723. <remarks>
  6724. The name of the OutputProfile.ProfileSelectedSpaceName
  6725. when the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams.ProfileSpaceSelection" /> is
  6726. <see cref="!:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfileSpaceSelectionConstants">Existing</see>.
  6727. </remarks>
  6728. </member>
  6729. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams.ProfileNewSpaceName">
  6730. <summary>
  6731. Gets or sets the ProfileNewSpaceName.
  6732. </summary>
  6733. <value>
  6734. The default is null.
  6735. </value>
  6736. <exception cref="T:System.ArgumentException">
  6737. If the supplied argument is null or an empty string.
  6738. </exception>
  6739. <exception cref="T:Cognex.VisionPro.Exceptions.CogSpaceTreeInvalidNameSyntaxException">
  6740. if the value is not a valid syntax.
  6741. </exception>
  6742. <remarks>
  6743. This is the space name of the DefaultFromNewTransform.
  6744. The name of the OutputProfile.ProfileSelectedSpaceName
  6745. when the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams.ProfileSpaceSelection" /> is
  6746. <see cref="!:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfileSpaceSelectionConstants">New</see>.
  6747. </remarks>
  6748. </member>
  6749. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams.DefautFromNewTransform">
  6750. <summary>
  6751. Gets or sets the DefaultFromNewTransform.
  6752. </summary>
  6753. <value>
  6754. The default is an identity transform.
  6755. </value>
  6756. <exception cref="T:System.ArgumentNullException">
  6757. If the supplied argument is null.
  6758. </exception>
  6759. <remarks>
  6760. Defines the transform that will be added to the ProfileSpaceTree at runtime
  6761. when the <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams.ProfileSpaceSelection" /> is
  6762. <see cref="!:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfileSpaceSelectionConstants">New</see>.
  6763. </remarks>
  6764. </member>
  6765. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams.SelectedOperatorIndex">
  6766. <summary>
  6767. Gets or sets the SelectedOperatorIndex.
  6768. </summary>
  6769. <value>
  6770. The default is 0.
  6771. </value>
  6772. <exception cref="T:System.ArgumentOutOfRangeException">
  6773. If the supplied value is out of range.
  6774. </exception>
  6775. <remarks>
  6776. The Cross Section tool CreateCurrentRecord() method will create
  6777. the graphics only for the selected operator.
  6778. This property is used by the control, it is attached to the selected opertor
  6779. in the grid.
  6780. </remarks>
  6781. </member>
  6782. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams.InternalProfile">
  6783. <summary>
  6784. Internal Cognex use only.
  6785. </summary>
  6786. </member>
  6787. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams.ProfileSpaceSelection">
  6788. <summary>
  6789. Gets or sets the ProfileSpaceSelection.
  6790. </summary>
  6791. <value>
  6792. The default is Default.
  6793. </value>
  6794. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  6795. <para>Fires when this property changes.</para>
  6796. <para>The following state flag may be affected:</para>
  6797. <list type="bullet">
  6798. <item>SfProfileSpaceSelection</item>
  6799. </list>
  6800. </event>
  6801. <exception cref="T:System.ArgumentOutOfRangeException">
  6802. If the supplied value is out of range.
  6803. </exception>
  6804. </member>
  6805. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams.PinRegions">
  6806. <summary>
  6807. Gets or sets the PinRegions.
  6808. </summary>
  6809. <value>
  6810. The default is false.
  6811. </value>
  6812. <remarks>
  6813. The PinRegions allows the user to pin the profile regions specified in the operators
  6814. to their current location while the user is changing the profile space selection or
  6815. the new space transform. The profile regions with the default selected space name
  6816. equal to “.” will be updated.
  6817. The profile regions with any other selected space name will not be pinned, updated or modified.
  6818. The PinRegions applies only during setup of the Cross Section tool, it is ignored at runtime.
  6819. This property is only used by the control; the programmatic interface ignores this property.
  6820. </remarks>
  6821. </member>
  6822. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams.Status">
  6823. <summary>
  6824. Gets the status.
  6825. </summary>
  6826. <value>
  6827. The default is true.
  6828. </value>
  6829. <remarks>
  6830. The status is set at runtime.
  6831. The overall status of executing all the operators.
  6832. True indicates that all the operators passed. False indicates at least one operator failed.
  6833. </remarks>
  6834. </member>
  6835. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams.OnDeserialization(System.Object)">
  6836. <summary>
  6837. Internal Cognex use only.
  6838. </summary>
  6839. </member>
  6840. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams.Finalize">
  6841. <summary>
  6842. Finalize this Cog3DRangeImageCrossSectionOperatorsParams.
  6843. </summary>
  6844. </member>
  6845. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams.Dispose">
  6846. <summary>
  6847. Destruct this Cog3DRangeImageCrossSectionOperatorsParams.
  6848. </summary>
  6849. </member>
  6850. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams.#ctor(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams)">
  6851. <summary>
  6852. Construct a deep copy of the supplied
  6853. Cog3DRangeImageCrossSectionOperatorsParams object.
  6854. </summary>
  6855. <param name="other">
  6856. The Cog3DRangeImageCrossSectionOperatorsParams object to be copied.
  6857. May not be null.
  6858. </param>
  6859. <exception cref="T:System.ArgumentNullException">
  6860. If the supplied argument is null.
  6861. </exception>
  6862. </member>
  6863. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams.#ctor">
  6864. <summary>
  6865. Construct a default Cog3DRangeImageCrossSectionOperatorsParams object.
  6866. </summary>
  6867. </member>
  6868. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams.SfNextSf">
  6869. <summary>
  6870. NextSf state flag.
  6871. </summary>
  6872. </member>
  6873. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams.SfInternalProfile">
  6874. <summary>
  6875. This bit will be set in the EventArgs of a Changed event every time
  6876. the value returned by InternalProfile may have changed.
  6877. </summary>
  6878. </member>
  6879. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams.SfSelectedOperatorIndex">
  6880. <summary>
  6881. This bit will be set in the EventArgs of a Changed event every time
  6882. the value returned by SelectedOperatorIndex may have changed.
  6883. </summary>
  6884. </member>
  6885. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams.SfProfileExistingSpaceName">
  6886. <summary>
  6887. This bit will be set in the EventArgs of a Changed event every time
  6888. the value returned by ProfileExistingSpaceName may have changed.
  6889. </summary>
  6890. </member>
  6891. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams.SfProfileSpaceSelection">
  6892. <summary>
  6893. This bit will be set in the EventArgs of a Changed event every time
  6894. the value returned by ProfileSpaceSelection may have changed.
  6895. </summary>
  6896. </member>
  6897. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams.SfProfileNewSpaceName">
  6898. <summary>
  6899. This bit will be set in the EventArgs of a Changed event every time
  6900. the value returned by ProfileNewSpaceName may have changed.
  6901. </summary>
  6902. </member>
  6903. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams.SfDefautFromNewTransform">
  6904. <summary>
  6905. This bit will be set in the EventArgs of a Changed event every time
  6906. the value returned by DefaultFromNewTransform may have changed.
  6907. </summary>
  6908. </member>
  6909. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams.SfPinRegions">
  6910. <summary>
  6911. This bit will be set in the EventArgs of a Changed event every time
  6912. the value returned by PinRegions may have changed.
  6913. </summary>
  6914. </member>
  6915. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams.SfStatus">
  6916. <summary>
  6917. This bit will be set in the EventArgs of a Changed event every time
  6918. the value returned by Status may have changed.
  6919. </summary>
  6920. </member>
  6921. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams">
  6922. <summary>
  6923. the Cross Section operators collection class.
  6924. </summary>
  6925. <remarks>
  6926. The operators collection is responsible for optionally fixturing the profile and managing
  6927. all the operators.
  6928. <para>
  6929. The operators are the methods for extracting features from the profile, computing features
  6930. based on other features, and making measurements. Each operator will produce either a single feature
  6931. (like a point, or a line segment) or a single measurement (like a distance, or an angle).
  6932. </para><para>
  6933. Operators that extract a feature from the profile data typically require the user to provide
  6934. one or more regions (in the selected profile space). These regions identify the subset of the
  6935. profile data that should be used during feature extraction. The extracted feature can then be
  6936. used by other operators for additional computation or measurement.
  6937. </para><para>
  6938. Operators that make computations or measurements using extracted features never take the
  6939. features themselves as inputs. Instead, these operators accept a reference to the operator
  6940. that produces the feature. The concept of referencing operators is similar to linking a property
  6941. from one tool to the next. This concept fits nicely here because we execute the operators
  6942. in sequence and each operator produce a single object so there is no ambiguity.
  6943. </para><para>
  6944. The operators are not meant to be used standalone.
  6945. It is recommended that the operator is added to the collection and then configured.
  6946. This sequence is very important for the operators that reference other operators.
  6947. The paradigm of the operators is closely aligned with a tool group, for example
  6948. you cannot link the properties of a tool to other tools without adding the tool
  6949. first to the tool group. The operators that reference other operators are linking the operators together.
  6950. </para><para>
  6951. The overall status of executing all the operators is set in the status property. The status type is Boolean.
  6952. True indicates that all the operators passed. False indicates at least one operator failed.
  6953. </para><para>
  6954. The operator can be added only to one collection. The operator internal unique id within a collection is set
  6955. at the time the operator is added. Once the id is set, adding the operator to another collection will not be
  6956. allowed.
  6957. </para></remarks>
  6958. </member>
  6959. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaResult.PointsBelowReferenceProfileAreValid">
  6960. <summary>
  6961. Returns true when values of the FarthestPointBelowReferenceProfile and
  6962. ClosestPointBelowReferenceProfile have been successfully computed.
  6963. Otherwise returns false.
  6964. When computing these points only those points of the profile are considered valid
  6965. that are in region and the difference at those points between the profile
  6966. and the input shapes is outside the height threshold
  6967. </summary>
  6968. </member>
  6969. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaResult.PointsAboveReferenceProfileAreValid">
  6970. <summary>
  6971. Returns true when values of the FarthestPointAboveReferenceProfile and
  6972. ClosestPointAboveReferenceProfile have been successfully computed.
  6973. Otherwise returns false.
  6974. When computing these points only those points of the profile are considered valid
  6975. that are in region and the difference at those points between the profile
  6976. and the input shapes is outside the height threshold
  6977. </summary>
  6978. </member>
  6979. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaResult.LeftAndRightPointsAreValid">
  6980. <summary>
  6981. Returns true when values of the LeftPoint and RightPoint have been successfully computed.
  6982. Otherwise returns false.
  6983. When computing these points only those points of the profile are considered valid
  6984. that are in region and the difference at those points between the profile
  6985. and the input shapes is outside the height threshold
  6986. </summary>
  6987. </member>
  6988. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaResult.RightPoint">
  6989. <summary>
  6990. Gets the calculated rightmost point on the input profile.
  6991. The point has to be in range, the difference cannot be 0
  6992. and it has to be outside the height threshold.
  6993. </summary>
  6994. <exception cref="!:T:System.ArgumentException">
  6995. when PointsAreValid is False.
  6996. </exception>
  6997. </member>
  6998. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaResult.LeftPoint">
  6999. <summary>
  7000. Gets the calculated leftmost point on the input profile.
  7001. The point has to be in range, the difference cannot be 0
  7002. and it has to be outside the height threshold.
  7003. </summary>
  7004. <exception cref="!:T:System.ArgumentException">
  7005. when PointsAreValid is False.
  7006. </exception>
  7007. </member>
  7008. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaResult.ClosestPointBelowReferenceProfile">
  7009. <summary>
  7010. Gets the calculated point (if exists) of the input profile
  7011. that is below the reference profile and
  7012. where the difference is the minimum between the input profile and
  7013. the reference profile
  7014. The difference is measured in the profile image’s Y direction.
  7015. The point has to be in range, the difference cannot be 0 and it has to be
  7016. outside the height threshold.
  7017. </summary>
  7018. <exception cref="!:T:System.ArgumentException">
  7019. when PointsBelowReferenceProfileAreValid is False.
  7020. </exception>
  7021. </member>
  7022. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaResult.FarthestPointBelowReferenceProfile">
  7023. <summary>
  7024. Gets the calculated point (if exists) of the input profile
  7025. that is below the reference profile and
  7026. where the difference is the maximum between the input profile and
  7027. the reference profile
  7028. The difference is measured in the profile image’s Y direction.
  7029. The point has to be in range, the difference cannot be 0 and it has to be
  7030. outside the height threshold.
  7031. </summary>
  7032. <exception cref="!:T:System.ArgumentException">
  7033. when PointsBelowReferenceProfileAreValid is False.
  7034. </exception>
  7035. </member>
  7036. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaResult.ClosestPointAboveReferenceProfile">
  7037. <summary>
  7038. Gets the calculated point (if exists) of the input profile
  7039. that is above the reference profile and
  7040. where the difference is the minimum between the input profile and
  7041. the reference profile
  7042. The difference is measured in the profile image’s Y direction.
  7043. The point has to be in range, the difference cannot be 0 and it has to be
  7044. outside the height threshold.
  7045. </summary>
  7046. <exception cref="!:T:System.ArgumentException">
  7047. when PointsAboveReferenceProfileAreValid is False.
  7048. </exception>
  7049. </member>
  7050. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaResult.FarthestPointAboveReferenceProfile">
  7051. <summary>
  7052. Gets the calculated point (if exists) of the input profile
  7053. that is above the reference profile and
  7054. where the difference is the maximum between the input profile and
  7055. the reference profile
  7056. The difference is measured in the profile image’s Y direction.
  7057. The point has to be in range, the difference cannot be 0 and it has to be
  7058. outside the height threshold.
  7059. </summary>
  7060. <exception cref="!:T:System.ArgumentException">
  7061. when PointsAboveReferenceProfileAreValid is False.
  7062. </exception>
  7063. </member>
  7064. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaResult.Area">
  7065. <summary>
  7066. Gets the calculated area value. The value of the area depends
  7067. on the measurement position of Positive / Negative / Both
  7068. </summary>
  7069. </member>
  7070. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaResult.Finalize">
  7071. <summary>
  7072. Finalize this Cog3DRangeImageCrossSectionAreaResult.
  7073. </summary>
  7074. </member>
  7075. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaResult.Dispose">
  7076. <summary>
  7077. Destruct this Cog3DRangeImageCrossSectionAreaResult.
  7078. </summary>
  7079. </member>
  7080. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaResult.#ctor(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaResult)">
  7081. <summary>
  7082. Copy constructs a Cog3DRangeImageCrossSectionAreaResult object. This is a
  7083. deep copy.
  7084. </summary>
  7085. <param name="other">
  7086. The result object to be copied. May not be null.
  7087. </param>
  7088. <exception cref="!:T:System.ArgumentNullException">
  7089. If the input argument is null.
  7090. </exception>
  7091. </member>
  7092. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaResult.#ctor(System.Double,System.Boolean,Cognex.VisionPro3D.Cog3DVect2,Cognex.VisionPro3D.Cog3DVect2,System.Boolean,Cognex.VisionPro3D.Cog3DVect2,Cognex.VisionPro3D.Cog3DVect2,System.Boolean,Cognex.VisionPro3D.Cog3DVect2,Cognex.VisionPro3D.Cog3DVect2)">
  7093. <summary>
  7094. Constructs a Cog3DRangeImageCrossSectionAreaResult object.
  7095. </summary>
  7096. <param name="area">
  7097. The are value.
  7098. </param>
  7099. <exception cref="!:T:System.ArgumentNullException">
  7100. If the input argument is null.
  7101. </exception>
  7102. </member>
  7103. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaResult.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  7104. <summary>
  7105. Serialization construct a Cog3DRangeImageCrossSectionAreaResult object.
  7106. </summary>
  7107. <param name="Info">
  7108. The standard SerializationInfo argument.
  7109. </param>
  7110. <param name="Ctxt">
  7111. The standard StreamingContext argument.
  7112. </param>
  7113. </member>
  7114. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaResult">
  7115. <summary />
  7116. </member>
  7117. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfileParams.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  7118. <summary>
  7119. Serialization constructor for Cog3DRangeImageCrossSectionProfileParams
  7120. object.
  7121. </summary>
  7122. <param name="Info">
  7123. The standard SerializationInfo argument.
  7124. </param>
  7125. <param name="Ctxt">
  7126. The standard StreamingContext argument.
  7127. </param>
  7128. </member>
  7129. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfileParams.Execute(Cognex.VisionPro.ICogImage)">
  7130. <summary>
  7131. Creates the profile.
  7132. </summary>
  7133. <returns>
  7134. The Cog3DRangeImageCrossSectionProfile.
  7135. </returns>
  7136. <param name="image">
  7137. The range image.
  7138. </param>
  7139. <exception cref="T:Cognex.VisionPro.Exceptions.CogImageBadTypeException">
  7140. If the supplied input image argument is not a CogImage16Range.
  7141. </exception>
  7142. <exception cref="T:Cognex.VisionPro.Exceptions.CogOperatorNoInputImageException">
  7143. If the supplied input image argument is null.
  7144. </exception>
  7145. <exception cref="T:Cognex.VisionPro.Exceptions.CogSecurityViolationException">
  7146. If licensing for this class cannot be confirmed.
  7147. </exception>
  7148. <exception cref="T:System.ArgumentException">
  7149. If the region is less than 2 pixels in width or less than 1 pixel in height.
  7150. </exception>
  7151. </member>
  7152. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfileParams.ProfileDefaultSpaceName">
  7153. <summary>
  7154. Gets or sets the ProfileDefaultSpaceName.
  7155. </summary>
  7156. <value>
  7157. The default is "Profile2D"
  7158. </value>
  7159. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  7160. <para>Fires when this property changes.</para>
  7161. <para>The following state flag may be affected:</para>
  7162. <list type="bullet">
  7163. <item>SfProfileDefaultSpaceName</item>
  7164. </list>
  7165. </event>
  7166. <exception cref="T:System.ArgumentException">
  7167. If the supplied argument is null or an empty string.
  7168. </exception>
  7169. <exception cref="T:Cognex.VisionPro.Exceptions.CogSpaceTreeInvalidNameSyntaxException">
  7170. if the value is not a valid syntax.
  7171. </exception>
  7172. </member>
  7173. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfileParams.Region">
  7174. <summary>
  7175. Gets or sets the 2D region in the range image.
  7176. </summary>
  7177. <value>
  7178. The default is a default constructed region.
  7179. </value>
  7180. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  7181. <para>Fires when this property changes.</para>
  7182. <para>The following state flag may be affected:</para>
  7183. <list type="bullet">
  7184. <item>SfRegion</item>
  7185. </list>
  7186. </event>
  7187. <remarks>
  7188. The region is an affine rectangle that lies in the image X-Y plane of
  7189. the range image. It is specified in any space within the 2D
  7190. coordinate space tree of the range image.
  7191. The region must be at least 2 pixel in width and 1 pixel in height.
  7192. A run time error is returned if the region does not meet the requrements.
  7193. </remarks>
  7194. </member>
  7195. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfileParams.Finalize">
  7196. <summary>
  7197. Finalize this Cog3DRangeImageCrossSectionProfileParams.
  7198. </summary>
  7199. </member>
  7200. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfileParams.Dispose">
  7201. <summary>
  7202. Destruct this Cog3DRangeImageCrossSectionProfileParams.
  7203. </summary>
  7204. </member>
  7205. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfileParams.#ctor(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfileParams)">
  7206. <summary>
  7207. Construct a deep copy of the supplied
  7208. Cog3DRangeImageCrossSectionProfileParams object.
  7209. </summary>
  7210. <param name="other">
  7211. The Cog3DRangeImageCrossSectionProfileParams object to be copied.
  7212. May not be null.
  7213. </param>
  7214. <exception cref="T:System.ArgumentNullException">
  7215. If the supplied argument is null.
  7216. </exception>
  7217. </member>
  7218. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfileParams.#ctor">
  7219. <summary>
  7220. Construct a default Cog3DRangeImageCrossSectionProfileParams object.
  7221. </summary>
  7222. </member>
  7223. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfileParams.SfNextSf">
  7224. <summary>
  7225. NextSf state flag.
  7226. </summary>
  7227. </member>
  7228. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfileParams.SfProfileDefaultSpaceName">
  7229. <summary>
  7230. This bit will be set in the EventArgs of a Changed event every time
  7231. the value returned by ProfileDefaultSpaceName may have changed.
  7232. </summary>
  7233. </member>
  7234. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfileParams.SfRegion">
  7235. <summary>
  7236. This bit will be set in the EventArgs of a Changed event every time
  7237. the value returned by Region may have changed.
  7238. </summary>
  7239. </member>
  7240. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfileParams">
  7241. <summary>
  7242. The Cross Section profile params class.
  7243. It is a lightweight class with two properties: a region specified in the range image 2D selected space name and
  7244. the ProfileDefaultSpaceName.
  7245. The execute method creates the <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile">profile</see>.
  7246. The region specifies how the slice is aligned with the part in the range image.
  7247. The region in this tool is very similar to the region used in the caliper tool.
  7248. The region is limited to an affine rectangle like the region in the caliper tool.
  7249. </summary>
  7250. <remarks>
  7251. The origin of the default profile space is defined by the rectangle that specifies the cutting plane:
  7252. The profile default space x-axis begins at the start point of the cutting plane rectangle (start of the region).
  7253. The end point of the cutting plane rectangle identifies the positive direction of the x-axis (end of the region).
  7254. The start point of the profile is always associated with midpoint of the region affine rectangle between CornerOrigin and CornerY.
  7255. The profile default space y-axis begins where image z is equal to 0 in the range image.
  7256. The default y axis is directed out of the range image, straight toward the viewer, through the “start” point.
  7257. </remarks>
  7258. </member>
  7259. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  7260. <summary>
  7261. Serialization constructor for Cog3DRangeImageCrossSectionProfile object.
  7262. </summary>
  7263. <param name="Info">
  7264. The standard SerializationInfo argument.
  7265. </param>
  7266. <param name="Ctxt">
  7267. The standard StreamingContext argument.
  7268. </param>
  7269. </member>
  7270. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.GetBoundingBoxInProfileDefaultSpace">
  7271. <summary>
  7272. Gets the bounding rectangle of the profile in ProfileDefaultSpace
  7273. Returns null if the ProfileRoot is null.
  7274. </summary>
  7275. </member>
  7276. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.ImageUsedForProfileDisplay">
  7277. <summary>
  7278. Cognex Internal use only.
  7279. </summary>
  7280. </member>
  7281. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.BuildProfileGraphics(System.Boolean)">
  7282. <summary>
  7283. Creates the profile graphics for the current and the last run records.
  7284. </summary>
  7285. <param name="bLastRunRecord">
  7286. When true (in case of CombinedGraphics record), the coordinate x-axis is drawn closer to the profile data.
  7287. </param>
  7288. </member>
  7289. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.BuildProfileSharpnessGraphics(Cognex.VisionPro.CogGraphicCollection,System.Int32,System.Double)">
  7290. <summary>
  7291. Creates the profile sharpness graphics used as a visual aid
  7292. with the extract corner operator.
  7293. </summary>
  7294. <param name="profileGraphics">
  7295. The constructed graphic collection returned from BuildProfileGraphics().
  7296. </param>
  7297. <param name="filterHalfSizeInPixels">
  7298. The filter half size used to apply to the profile data and generate the sharpness data.
  7299. </param>
  7300. <param name="sharpnessThreshold">
  7301. The sharpness threshold to draw the cutoff lines.
  7302. </param>
  7303. </member>
  7304. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.GetUniqueSpaceName">
  7305. <summary>
  7306. Returns a unique space name within the ProfileSpaceTree.
  7307. The name will have Fixture as a base and the next available
  7308. index such as Fixture1 or Fixture2.
  7309. </summary>
  7310. </member>
  7311. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.GetProfileSSNParent">
  7312. <summary>
  7313. Returns the parent space name of the ProfileSelectedSpaceName.
  7314. Returns null if the ProfileSpaceTree is null.
  7315. </summary>
  7316. </member>
  7317. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.GetProfileDefaultSpace">
  7318. <summary>
  7319. Returns the first space in the ProfileSpaceTree.
  7320. The value is the ProfileDefaultSpaceName specified by
  7321. the tool that creates the profile.
  7322. </summary>
  7323. <exception cref="T:System.ArgumentException">
  7324. If the ProfileSpaceTree has no spaces in it.
  7325. </exception>
  7326. </member>
  7327. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.CuttingPlane">
  7328. <summary>
  7329. Returns the cutting plane.
  7330. The cutting plane lies parallel to the image z-axis of the range image
  7331. at the centerline of the region.
  7332. </summary>
  7333. </member>
  7334. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.MapCircleToRangeImage3D(Cognex.VisionPro.CogCircle,System.String)">
  7335. <summary>
  7336. Maps a profile circle to a circle in the range image SelectedSpaceName3D.
  7337. </summary>
  7338. <param name="profileCircle">
  7339. The circle in the profile.
  7340. </param>
  7341. <param name="spaceName">
  7342. The 3D space name from the CoordinateSpaceTree3D.
  7343. </param>
  7344. <returns>
  7345. A Cog3DCircle in the spaceName specified.
  7346. </returns>
  7347. <exception cref="T:System.ArgumentNullException">
  7348. If the spaceName is null.
  7349. </exception>
  7350. <exception cref="T:System.ArgumentNullException">
  7351. If the ProfileSpaceTree is null.
  7352. </exception>
  7353. <exception cref="T:System.ArgumentNullException">
  7354. If the CoordinateSpaceTree is null.
  7355. </exception>
  7356. <exception cref="T:System.ArgumentNullException">
  7357. If the ProfileSelectedSpaceName is null.
  7358. </exception>
  7359. <exception cref="T:Cognex.VisionPro.Exceptions.CogSpaceTreeNameNotInTreeException">
  7360. If the spaceName is not found in the CoordinateSpaceTree3D.
  7361. </exception>
  7362. </member>
  7363. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.MapCircleToRangeImage(Cognex.VisionPro.CogCircle,System.String)">
  7364. <summary>
  7365. Maps a profile circle to a line segment in the range image SelectedSpaceName.
  7366. </summary>
  7367. <param name="profileCircle">
  7368. The circle in the profile.
  7369. </param>
  7370. <param name="spaceName">
  7371. The 2D space name from the CoordinateSpaceTree.
  7372. </param>
  7373. <returns>
  7374. A CogLineSegment in the spaceName specified.
  7375. </returns>
  7376. <exception cref="T:System.ArgumentNullException">
  7377. If the spaceName is null.
  7378. </exception>
  7379. <exception cref="T:System.ArgumentNullException">
  7380. If the ProfileSpaceTree is null.
  7381. </exception>
  7382. <exception cref="T:System.ArgumentNullException">
  7383. If the CoordinateSpaceTree is null.
  7384. </exception>
  7385. <exception cref="T:System.ArgumentNullException">
  7386. If the ProfileSelectedSpaceName is null.
  7387. </exception>
  7388. <exception cref="T:Cognex.VisionPro.Exceptions.CogSpaceTreeNameNotInTreeException">
  7389. If the spaceName is not found in the CoordinateSpaceTree.
  7390. </exception>
  7391. </member>
  7392. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.MapLineSegmentToRangeImage3D(Cognex.VisionPro.CogLineSegment,System.String)">
  7393. <summary>
  7394. Maps a profile line segment to a line segment in the range image SelectedSpaceName3D.
  7395. </summary>
  7396. <param name="profileLineSeg">
  7397. The line segment in the profile.
  7398. </param>
  7399. <param name="spaceName">
  7400. The 3D space name from the CoordinateSpaceTree3D.
  7401. </param>
  7402. <returns>
  7403. A Cog3DLineSeg in the spaceName specified.
  7404. </returns>
  7405. <exception cref="T:System.ArgumentNullException">
  7406. If the spaceName is null.
  7407. </exception>
  7408. <exception cref="T:System.ArgumentNullException">
  7409. If the ProfileSpaceTree is null.
  7410. </exception>
  7411. <exception cref="T:System.ArgumentNullException">
  7412. If the CoordinateSpaceTree is null.
  7413. </exception>
  7414. <exception cref="T:System.ArgumentNullException">
  7415. If the ProfileSelectedSpaceName is null.
  7416. </exception>
  7417. <exception cref="T:Cognex.VisionPro.Exceptions.CogSpaceTreeNameNotInTreeException">
  7418. If the spaceName is not found in the CoordinateSpaceTree3D.
  7419. </exception>
  7420. </member>
  7421. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.MapLineSegmentToRangeImage(Cognex.VisionPro.CogLineSegment,System.String)">
  7422. <summary>
  7423. Maps a profile line segment to a line segment in the range image SelectedSpaceName.
  7424. </summary>
  7425. <param name="profileLineSeg">
  7426. The line segment in the profile.
  7427. </param>
  7428. <param name="spaceName">
  7429. The 2D space name from the CoordinateSpaceTree.
  7430. </param>
  7431. <returns>
  7432. A CogLineSegment in the spaceName specified.
  7433. </returns>
  7434. <exception cref="T:System.ArgumentNullException">
  7435. If the spaceName is null.
  7436. </exception>
  7437. <exception cref="T:System.ArgumentNullException">
  7438. If the ProfileSpaceTree is null.
  7439. </exception>
  7440. <exception cref="T:System.ArgumentNullException">
  7441. If the CoordinateSpaceTree is null.
  7442. </exception>
  7443. <exception cref="T:System.ArgumentNullException">
  7444. If the ProfileSelectedSpaceName is null.
  7445. </exception>
  7446. <exception cref="T:Cognex.VisionPro.Exceptions.CogSpaceTreeNameNotInTreeException">
  7447. If the spaceName is not found in the CoordinateSpaceTree.
  7448. </exception>
  7449. </member>
  7450. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.MapPointToRangeImage3D(System.Double,System.Double,System.String)">
  7451. <summary>
  7452. Maps a profile point to a point in the range image SelectedSpaceName3D.
  7453. </summary>
  7454. <param name="profilePointX">
  7455. The x-coordinate of the profile point.
  7456. </param>
  7457. <param name="profilePointY">
  7458. The y-coordinate of the profile point.
  7459. </param>
  7460. <param name="spaceName">
  7461. The 3D space name within the CoordinateSpaceTree3D.
  7462. </param>
  7463. <returns>
  7464. A point in the spaceName specified as a Cog3DVect3 object.
  7465. </returns>
  7466. <exception cref="T:System.ArgumentNullException">
  7467. If the spaceName is null.
  7468. </exception>
  7469. <exception cref="T:System.ArgumentNullException">
  7470. If the ProfileSpaceTree is null.
  7471. </exception>
  7472. <exception cref="T:System.ArgumentNullException">
  7473. If the CoordinateSpaceTree is null.
  7474. </exception>
  7475. <exception cref="T:System.ArgumentNullException">
  7476. If the ProfileSelectedSpaceName is null.
  7477. </exception>
  7478. <exception cref="T:Cognex.VisionPro.Exceptions.CogSpaceTreeNameNotInTreeException">
  7479. If the spaceName is not found in the CoordinateSpaceTree3D.
  7480. </exception>
  7481. </member>
  7482. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.MapPointToRangeImage(System.Double,System.Double,System.String,System.Double@,System.Double@)">
  7483. <summary>
  7484. Maps a profile point to a point in the range image SelectedSpaceName.
  7485. </summary>
  7486. <param name="profilePointX">
  7487. The x-coordinate of the profile point.
  7488. </param>
  7489. <param name="profilePointY">
  7490. The y-coordinate of the profile point.
  7491. </param>
  7492. <param name="spaceName">
  7493. The 2D space name within the CoordinateSpaceTree.
  7494. </param>
  7495. <param name="mappedX">
  7496. The resulting mapped x-coordinate in the spaceName specified.
  7497. </param>
  7498. <param name="mappedY">
  7499. The resulting mapped Y-coordinate in the spaceName specified.
  7500. </param>
  7501. <exception cref="T:System.ArgumentNullException">
  7502. If the spaceName is null.
  7503. </exception>
  7504. <exception cref="T:System.ArgumentNullException">
  7505. If the ProfileSpaceTree is null.
  7506. </exception>
  7507. <exception cref="T:System.ArgumentNullException">
  7508. If the CoordinateSpaceTree is null.
  7509. </exception>
  7510. <exception cref="T:System.ArgumentNullException">
  7511. If the ProfileSelectedSpaceName is null.
  7512. </exception>
  7513. <exception cref="T:Cognex.VisionPro.Exceptions.CogSpaceTreeNameNotInTreeException">
  7514. If the spaceName is not found in the CoordinateSpaceTree.
  7515. </exception>
  7516. </member>
  7517. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.Copy">
  7518. <summary>
  7519. Shallow copy of the profile.
  7520. </summary>
  7521. </member>
  7522. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.PixelFromRootTransform">
  7523. <summary>
  7524. Gets the PixelFromRootTransform. The transform is computed from PixelFromRootTransform3D.
  7525. Returns null if PixelFromRootTransform3D is null.
  7526. </summary>
  7527. <value>
  7528. The default is set when the profile is created.
  7529. </value>
  7530. <remarks>
  7531. The below ground transform, also known as the pixel from
  7532. root transform, records how the range image pixels within
  7533. the region were transformed and mangled to become the profile.
  7534. This transform links the range image coordinate spaces to the
  7535. profile spaces and define the bond between the range image
  7536. pixels and the profile data.
  7537. </remarks>
  7538. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  7539. <para>Fires when this property changes.</para>
  7540. <para>The following state flag may be affected:</para>
  7541. <list type="bullet">
  7542. <item>SfPixelFromRootTransform</item>
  7543. </list>
  7544. </event>
  7545. </member>
  7546. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.PixelFromRootTransform3D">
  7547. <summary>
  7548. Gets or sets the PixelFromRootTransform3D.
  7549. </summary>
  7550. <value>
  7551. The default is set when the profile is created.
  7552. </value>
  7553. <remarks>
  7554. The below ground transform, also known as the pixel from
  7555. root transform, records how the range image pixels within
  7556. the region were transformed and mangled to become the profile.
  7557. This transform links the range image coordinate spaces to the
  7558. profile spaces and define the bond between the range image
  7559. pixels and the profile data.
  7560. </remarks>
  7561. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  7562. <para>Fires when this property changes.</para>
  7563. <para>The following state flag may be affected:</para>
  7564. <list type="bullet">
  7565. <item>SfPixelFromRootTransform3D</item>
  7566. </list>
  7567. </event>
  7568. <exception cref="T:System.ArgumentException">
  7569. If the value is null.
  7570. </exception>
  7571. <remarks>
  7572. It is not recommended to overwrite the transform.
  7573. The integrity of the profile will break and the
  7574. tool may not operate properly.
  7575. </remarks>
  7576. </member>
  7577. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.ProfileSelectedSpaceName">
  7578. <summary>
  7579. Gets or sets the ProfileSelectedSpaceName
  7580. </summary>
  7581. <value>
  7582. The default is set when the profile is created.
  7583. The value depends on the OperatorsParams.ProfileSpaceSelection and
  7584. ProfileParams.ProfileDefaultSpaceName.
  7585. </value>
  7586. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  7587. <para>Fires when this property changes.</para>
  7588. <para>The following state flag may be affected:</para>
  7589. <list type="bullet">
  7590. <item>SfProfileSelectedSpaceName</item>
  7591. </list>
  7592. </event>
  7593. <exception cref="T:System.ArgumentException">
  7594. if the value is null or empty string.
  7595. </exception>
  7596. <exception cref="T:Cognex.VisionPro.Exceptions.CogSpaceTreeNameNotInTreeException">
  7597. if the value is not a valid syntax.
  7598. </exception>
  7599. </member>
  7600. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.ProjectionHeight">
  7601. <summary>
  7602. Gets the ProjectionHeight.
  7603. </summary>
  7604. <remarks>
  7605. The number of pixels in the projection direction will also be contained in the profile.
  7606. </remarks>
  7607. </member>
  7608. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.CoordinateSpaceTree">
  7609. <summary>
  7610. Gets or sets the CoordinateSpaceTree.
  7611. </summary>
  7612. <remarks>
  7613. The CoordinateSpaceTree will contain a reference to the
  7614. CoordinateSpaceTree held by the range image.
  7615. </remarks>
  7616. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  7617. <para>Fires when this property changes.</para>
  7618. <para>The following state flag may be affected:</para>
  7619. <list type="bullet">
  7620. <item>SfCoordinateSpaceTree</item>
  7621. </list>
  7622. </event>
  7623. <exception cref="T:System.ArgumentNullException">
  7624. If the value is null.
  7625. </exception>
  7626. <remarks>
  7627. It is not recommended to overwrite the tree.
  7628. The integrity of the profile will break and the
  7629. tool may not operate properly.
  7630. </remarks>
  7631. </member>
  7632. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.ProfileRoot">
  7633. <summary>
  7634. Gets the ProfileRoot. The ProfileRoot object contains
  7635. the profile height data and the weights.
  7636. </summary>
  7637. </member>
  7638. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.SelectedSpaceName3D">
  7639. <summary>
  7640. Gets or sets the SelectedSpaceName3D.
  7641. </summary>
  7642. <value>
  7643. The default is null.
  7644. </value>
  7645. <exception cref="T:System.ArgumentException">
  7646. If the supplied argument is null or an empty string.
  7647. </exception>
  7648. <remarks>
  7649. The SelectedSpaceName3D is used to map the features found in the profile to the range image.
  7650. </remarks>
  7651. </member>
  7652. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.SelectedSpaceName">
  7653. <summary>
  7654. Gets or sets the SelectedSpaceName.
  7655. </summary>
  7656. <value>
  7657. The default is null.
  7658. </value>
  7659. <exception cref="T:System.ArgumentException">
  7660. If the supplied argument is null or an empty string.
  7661. </exception>
  7662. <remarks>
  7663. The SelectedSpaceName is used to map the features found in the profile to the range image.
  7664. </remarks>
  7665. </member>
  7666. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.CoordinateSpaceTree3D">
  7667. <summary>
  7668. Gets or sets the CoordinateSpaceTree3D.
  7669. </summary>
  7670. <value>
  7671. The CoordinateSpaceTree3D will contain the "Sensor3D" space.
  7672. Eventually it will hold a reference to the range image
  7673. CoordinateSpaceTree3D.
  7674. </value>
  7675. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  7676. <para>Fires when this property changes.</para>
  7677. <para>The following state flag may be affected:</para>
  7678. <list type="bullet">
  7679. <item>SfCoordinateSpaceTree3D</item>
  7680. </list>
  7681. </event>
  7682. <exception cref="T:System.ArgumentNullException">
  7683. If the value is null.
  7684. </exception>
  7685. <remarks>
  7686. It is not recommended to overwrite the tree.
  7687. The integrity of the profile will break and the
  7688. tool may not operate properly.
  7689. </remarks>
  7690. </member>
  7691. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.ProfileSpaceTree">
  7692. <summary>
  7693. Gets or sets the ProfileSpaceTree.
  7694. </summary>
  7695. <value>
  7696. The ProfileSpaceTree, when the profile is created, will contain one space to convert the
  7697. profile data to physical units of the range image.
  7698. </value>
  7699. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  7700. <para>Fires when this property changes.</para>
  7701. <para>The following state flag may be affected:</para>
  7702. <list type="bullet">
  7703. <item>SfProfileSpaceTree</item>
  7704. </list>
  7705. </event>
  7706. <exception cref="T:System.ArgumentNullException">
  7707. If the value is null.
  7708. </exception>
  7709. <remarks>
  7710. The profile space tree stores a family of 2D coordinate spaces that
  7711. lie within the cutting plane. These profile spaces are typically
  7712. expressed in physical units (e.g. millimeters), with x and y axes
  7713. that are orthogonal in physical space.
  7714. <para>
  7715. It is not recommended to overwrite the tree.
  7716. The integrity of the profile will break and the
  7717. tool may not operate properly.
  7718. </para></remarks>
  7719. </member>
  7720. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.GetWeights">
  7721. <summary>
  7722. Gets the weights for each height value in the profile data.
  7723. The weight will indicate the number of pixels contributing
  7724. to the height value in the corresponding profile datum.
  7725. The weight value is between 0 and 1. A value of 0 indicates
  7726. that all pixels contributing to the height are missing.
  7727. Returns null if the ProfileRoot is null.
  7728. </summary>
  7729. </member>
  7730. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.GetProfileDataInRangeImageSelectedSpaceName3D(System.String)">
  7731. <summary>
  7732. Returns the profile data in the specified 3D space that can be found in the
  7733. CoogrdinateSpaceTree3D of the range image.
  7734. Each point in the profile is mapped back to the specified 3D space,
  7735. packaged as a Cog3DVect3 object, and added to the Cog3DVect3Collection.
  7736. Returns null if the ProfileRoot is null, or if the
  7737. profile has zero points.
  7738. </summary>
  7739. <param name="ssn3D">
  7740. A user specified profile selected space name.
  7741. If the value is null or ".", then the SelectedSpaceName3D
  7742. is used.
  7743. </param>
  7744. <exception cref="T:Cognex.VisionPro.Exceptions.CogSpaceTreeNameNotInTreeException">
  7745. if the ssn is not in the tree.
  7746. </exception>
  7747. <remarks>
  7748. The user should rely on the weights array (returned by GetWeights())
  7749. to determine what action to take with regards to non-visible pixels.
  7750. The weights array is of the same size as the profile data array,
  7751. and should be used to determine which points in the profile data are "missing".
  7752. Any point whose weight is zero is considered "missing" and should not be
  7753. examined: its height (z-value) is meaningless.
  7754. </remarks>
  7755. </member>
  7756. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.GetProfileDataInProfileSelectedSpaceName(System.String)">
  7757. <summary>
  7758. Returns the profile data in the specified space.
  7759. Each point in the profile is mapped from pels to the specified space,
  7760. packaged as a Cog3DVect2 object, and added to the Cog3DVect2Collection.
  7761. Returns null if the ProfileRoot is null, or if the
  7762. profile has zero points.
  7763. </summary>
  7764. <param name="ssn">
  7765. A user specified profile selected space name.
  7766. If the value is null or ".", then the ProfileSelectedSpaceName
  7767. is used.
  7768. </param>
  7769. <exception cref="T:Cognex.VisionPro.Exceptions.CogSpaceTreeNameNotInTreeException">
  7770. if the ssn is not in the tree.
  7771. </exception>
  7772. <remarks>
  7773. The user should rely on the weights array (returned by GetWeights())
  7774. to determine what action to take with regards to non-visible pixels.
  7775. The weights array is of the same size as the profile data array,
  7776. and should be used to determine which points in the profile data are "missing".
  7777. Any point whose weight is zero is considered "missing", and should not be
  7778. examined: its height (y-value) is meaningless.
  7779. </remarks>
  7780. </member>
  7781. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.GetProfileData">
  7782. <summary>
  7783. Gets the profile height data in pixels.
  7784. Returns null if the ProfileRoot is null.
  7785. </summary>
  7786. <remarks>
  7787. The user should rely on the weights array (returned by GetWeights())
  7788. to determine what action to take with regards to non-visible pixels.
  7789. The weights array is of the same size as the profile data array,
  7790. and should be used to determine which points in the profile data are "missing".
  7791. Any point whose weight is zero is considered "missing", and should not be
  7792. examined: its height (y-value) is meaningless.
  7793. </remarks>
  7794. </member>
  7795. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.Finalize">
  7796. <summary>
  7797. Finalize this Cog3DRangeImageCrossSectionProfile.
  7798. </summary>
  7799. </member>
  7800. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.Dispose">
  7801. <summary>
  7802. Destruct this Cog3DRangeImageCrossSectionProfile.
  7803. </summary>
  7804. </member>
  7805. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.#ctor(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile)">
  7806. <summary>
  7807. Construct a deep copy of the supplied
  7808. Cog3DRangeImageCrossSectionProfile object.
  7809. </summary>
  7810. <param name="other">
  7811. The Cog3DRangeImageCrossSectionProfile object to be copied.
  7812. May not be null.
  7813. </param>
  7814. <exception cref="T:System.ArgumentNullException">
  7815. If the supplied argument is null.
  7816. </exception>
  7817. </member>
  7818. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.#ctor">
  7819. <summary>
  7820. Construct a default Cog3DRangeImageCrossSectionProfile object.
  7821. </summary>
  7822. </member>
  7823. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.SfNextSf">
  7824. <summary>
  7825. NextSf state flag.
  7826. </summary>
  7827. </member>
  7828. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.SfSelectedSpaceName3D">
  7829. <summary>
  7830. This bit will be set in the EventArgs of a Changed event every time
  7831. the value returned by SelectedSpaceName3D may have changed.
  7832. </summary>
  7833. </member>
  7834. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.SfSelectedSpaceName">
  7835. <summary>
  7836. This bit will be set in the EventArgs of a Changed event every time
  7837. the value returned by SelectedSpaceName may have changed.
  7838. </summary>
  7839. </member>
  7840. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.SfCuttingPlane">
  7841. <summary>
  7842. This bit will be set in the EventArgs of a Changed event every time
  7843. the value returned by CuttingPlane may have changed.
  7844. </summary>
  7845. </member>
  7846. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.SfPixelFromRootTransform">
  7847. <summary>
  7848. This bit will be set in the EventArgs of a Changed event every time
  7849. the value returned by PixelFromRootTransform may have changed.
  7850. </summary>
  7851. </member>
  7852. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.SfCoordinateSpaceTree">
  7853. <summary>
  7854. This bit will be set in the EventArgs of a Changed event every time
  7855. the value returned by CoordinateSpaceTree may have changed.
  7856. </summary>
  7857. </member>
  7858. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.SfPixelFromRootTransform3D">
  7859. <summary>
  7860. This bit will be set in the EventArgs of a Changed event every time
  7861. the value returned by PixelFromRootTransform3D may have changed.
  7862. </summary>
  7863. </member>
  7864. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.SfCoordinateSpaceTree3D">
  7865. <summary>
  7866. This bit will be set in the EventArgs of a Changed event every time
  7867. the value returned by CoordinateSpaceTree3D may have changed.
  7868. </summary>
  7869. </member>
  7870. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.SfProfileSelectedSpaceName">
  7871. <summary>
  7872. This bit will be set in the EventArgs of a Changed event every time
  7873. the value returned by ProfileSelectedSpaceName may have changed.
  7874. </summary>
  7875. </member>
  7876. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.SfProfileSpaceTree">
  7877. <summary>
  7878. This bit will be set in the EventArgs of a Changed event every time
  7879. the value returned by ProfileSpaceTree may have changed.
  7880. </summary>
  7881. </member>
  7882. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.SfProjectionHeight">
  7883. <summary>
  7884. This bit will be set in the EventArgs of a Changed event every time
  7885. the value returned by ProjectionHeight may have changed.
  7886. </summary>
  7887. </member>
  7888. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.SfProfileRoot">
  7889. <summary>
  7890. This bit will be set in the EventArgs of a Changed event every time
  7891. the value returned by ProfileRoot may have changed.
  7892. </summary>
  7893. </member>
  7894. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile">
  7895. <summary>
  7896. The Cross Section profile class.
  7897. </summary>
  7898. <remarks>
  7899. The profile is the new image-like container of the 1-D height data.
  7900. It holds the one-dimensional height data and the one-dimensional
  7901. weight data produced by projection. The profile resembles a 1-D range image,
  7902. but it is not a true image. It does not support the ICogImage interface.
  7903. And the data it holds is a "sideways" view of the original image.
  7904. <para>
  7905. Similar to the image, the profile also has a profile selected space name.
  7906. All positional measurements from the operators will be reported in the profile selected space name.
  7907. </para><para>
  7908. To map points from the profile data back to the range image and to perform the mapping in the 2D and 3D user defined spaces, the profile holds on to:
  7909. <list type="bullet"><item>The 3D coordinate space tree of the range image</item><item>The 2D coordinate space tree of the range image </item><item> A 3D below ground transform linking the profile data to the range image pixels</item><item>A 2D below ground transform linking the profile data to the range image pixels</item></list></para><para>
  7910. There is no default constructor for the profile. It must be created by
  7911. running the tool.
  7912. </para></remarks>
  7913. </member>
  7914. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfileRoot.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  7915. <summary>
  7916. Serializer for ProfileData and Weights vector objects.
  7917. </summary>
  7918. <param name="Info">
  7919. The standard SerializationInfo argument.
  7920. </param>
  7921. <param name="Ctxt">
  7922. The standard StreamingContext argument.
  7923. </param>
  7924. </member>
  7925. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfileRoot.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  7926. <summary>
  7927. Serialization constructor for Cog3DRangeImageCrossSectionProfileRoot object.
  7928. </summary>
  7929. <param name="Info">
  7930. The standard SerializationInfo argument.
  7931. </param>
  7932. <param name="Ctxt">
  7933. The standard StreamingContext argument.
  7934. </param>
  7935. </member>
  7936. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfileRoot.GetWeights">
  7937. <summary>
  7938. Gets the weights. The weight value is between 0 and 1.
  7939. Returns null if the raw data is null.
  7940. </summary>
  7941. </member>
  7942. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfileRoot.GetProfileData">
  7943. <summary>
  7944. Gets the profile height data in pixels.
  7945. Returns null if the raw data is null.
  7946. </summary>
  7947. </member>
  7948. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfileRoot.Finalize">
  7949. <summary>
  7950. Finalize this Cog3DRangeImageCrossSectionProfileRoot.
  7951. </summary>
  7952. </member>
  7953. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfileRoot.Dispose">
  7954. <summary>
  7955. Destruct this Cog3DRangeImageCrossSectionProfileRoot.
  7956. </summary>
  7957. </member>
  7958. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfileRoot.#ctor(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfileRoot)">
  7959. <summary>
  7960. Construct a deep copy of the supplied
  7961. Cog3DRangeImageCrossSectionProfileRoot object.
  7962. </summary>
  7963. <param name="other">
  7964. The Cog3DRangeImageCrossSectionProfileRoot object to be copied.
  7965. May not be null.
  7966. </param>
  7967. <exception cref="T:System.ArgumentNullException">
  7968. If the supplied argument is null.
  7969. </exception>
  7970. </member>
  7971. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfileRoot.#ctor">
  7972. <summary>
  7973. Construct a default Cog3DRangeImageCrossSectionProfileRoot object.
  7974. </summary>
  7975. </member>
  7976. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfileRoot.SfNextSf">
  7977. <summary>
  7978. NextSf state flag.
  7979. </summary>
  7980. </member>
  7981. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfileRoot">
  7982. <summary>
  7983. The Cross Section profile root class. This class hold the actual
  7984. raw height and weight values of the profile.
  7985. </summary>
  7986. </member>
  7987. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  7988. <summary>
  7989. Serialization constructor for Cog3DRangeImageCrossSectionTolerance
  7990. object.
  7991. </summary>
  7992. <param name="Info">
  7993. The standard SerializationInfo argument.
  7994. </param>
  7995. <param name="Ctxt">
  7996. The standard StreamingContext argument.
  7997. </param>
  7998. </member>
  7999. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.isAngle">
  8000. <summary>Return true if the name is Angle.</summary>
  8001. </member>
  8002. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Max">
  8003. <summary>Gets or sets the maximum value to use for tolerance.
  8004. </summary>
  8005. <value>Default value is 0.</value>
  8006. <remarks>
  8007. If Min is less than Max, then Min value will be changed to be equal
  8008. to Max.
  8009. </remarks>
  8010. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  8011. <para>
  8012. Fires when the value of this property changes.
  8013. </para>
  8014. <list type="bullet">
  8015. <item>SfMax</item>
  8016. <item>SfMin</item>
  8017. </list>
  8018. </event>
  8019. </member>
  8020. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Min">
  8021. <summary>Gets or sets the minimum value to use for tolerance.
  8022. </summary>
  8023. <value>Default value is 0.</value>
  8024. <remarks>
  8025. If Max is less than Min, then Max value will be changed to be equal
  8026. to Min.
  8027. </remarks>
  8028. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  8029. <para>
  8030. Fires when the value of this property changes.
  8031. </para>
  8032. <list type="bullet">
  8033. <item>SfMin</item>
  8034. <item>SfMax</item>
  8035. </list>
  8036. </event>
  8037. </member>
  8038. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Enabled">
  8039. <summary>If True, the operator will check at run time
  8040. that the value is within the Min and Max values.
  8041. </summary>
  8042. <value>Default value is false.</value>
  8043. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  8044. <para>
  8045. Fires when the value of this property changes.
  8046. <list type="bullet"><item>SfEnabled</item></list></para>
  8047. </event>
  8048. </member>
  8049. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Name">
  8050. <summary>
  8051. Gets the name of the item being toleranced.
  8052. </summary>
  8053. </member>
  8054. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Finalize">
  8055. <summary>
  8056. Finalize this Cog3DRangeImageCrossSectionTolerance.
  8057. </summary>
  8058. </member>
  8059. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.Dispose">
  8060. <summary>
  8061. Destruct this Cog3DRangeImageCrossSectionTolerance.
  8062. </summary>
  8063. </member>
  8064. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.#ctor(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance)">
  8065. <summary>
  8066. Construct a deep copy of the supplied
  8067. Cog3DRangeImageCrossSectionTolerance
  8068. object.
  8069. </summary>
  8070. <param name="other">
  8071. The Cog3DRangeImageCrossSectionTolerance object to be copied.
  8072. May not be null.
  8073. </param>
  8074. <exception cref="T:System.ArgumentNullException">
  8075. If the supplied argument is null.
  8076. </exception>
  8077. </member>
  8078. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.#ctor(System.String)">
  8079. <summary>
  8080. Construct a default Cog3DRangeImageCrossSectionTolerance object.
  8081. </summary>
  8082. </member>
  8083. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.SfNextSf">
  8084. <summary>
  8085. NextSf state flag.
  8086. </summary>
  8087. </member>
  8088. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.SfMax">
  8089. <summary>
  8090. This bit will be set in the EventArgs of a Changed event every time
  8091. the value returned by Max may have changed.
  8092. </summary>
  8093. </member>
  8094. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.SfMin">
  8095. <summary>
  8096. This bit will be set in the EventArgs of a Changed event every time
  8097. the value returned by Min may have changed.
  8098. </summary>
  8099. </member>
  8100. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance.SfEnabled">
  8101. <summary>
  8102. This bit will be set in the EventArgs of a Changed event every time
  8103. the value returned by Enabled may have changed.
  8104. </summary>
  8105. </member>
  8106. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionTolerance">
  8107. <summary>
  8108. A common class to define the tolerance for a property.
  8109. </summary>
  8110. </member>
  8111. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPointLineSegmentDirectionConstants">
  8112. <summary>
  8113. An enumeration that specifies the direction of the extraction with respect to the given line segment
  8114. </summary>
  8115. </member>
  8116. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPointLineSegmentDirectionConstants.RightPerpendicular">
  8117. <summary>
  8118. In the direction of the right perpendicular of the line segment
  8119. </summary>
  8120. </member>
  8121. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPointLineSegmentDirectionConstants.LeftPerpendicular">
  8122. <summary>
  8123. In the direction of the left perpendicular of the line segment
  8124. </summary>
  8125. </member>
  8126. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPointLineSegmentDirectionConstants.OppositeOfLineSegment">
  8127. <summary>
  8128. In the opposite direction of the line segment
  8129. </summary>
  8130. </member>
  8131. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPointLineSegmentDirectionConstants.AlongLineSegment">
  8132. <summary>
  8133. In the direction of the line segment
  8134. </summary>
  8135. </member>
  8136. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionSpaceSelectionConstants">
  8137. <summary>
  8138. An enumeration that specifies whether a value should be understood in profile default space or profile selected space
  8139. </summary>
  8140. </member>
  8141. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionSpaceSelectionConstants.ProfileSelectedSpace">
  8142. <summary>
  8143. The value is specified in ProfileSelectedSpace
  8144. </summary>
  8145. </member>
  8146. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionSpaceSelectionConstants.ProfileDefaultSpace">
  8147. <summary>
  8148. The value is specified in ProfileDefaultSpace
  8149. </summary>
  8150. </member>
  8151. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPointDirectionSelectionModeConstants">
  8152. <summary>
  8153. An enumeration that specifies how the direction of the point extarction extraction will be defined.
  8154. </summary>
  8155. </member>
  8156. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPointDirectionSelectionModeConstants.DirectionFromLineSegment">
  8157. <summary>
  8158. The direction is specified by a line segment
  8159. </summary>
  8160. </member>
  8161. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPointDirectionSelectionModeConstants.DirectionFromAngle">
  8162. <summary>
  8163. The direction is specified by a user given angle
  8164. </summary>
  8165. </member>
  8166. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionExtractPointDirectionSelectionModeConstants.DirectionFromPredefinedList">
  8167. <summary>
  8168. The direction is specified by one of the points from the predefined list: top, left, etc...
  8169. </summary>
  8170. </member>
  8171. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaMeasurementInputPointTypeConstants.AboveThresholdPoint">
  8172. <summary>
  8173. The point of the input profile had a value outside the threshold
  8174. </summary>
  8175. </member>
  8176. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaMeasurementInputPointTypeConstants.InRegionPoint">
  8177. <summary>
  8178. The point of the input profile was in the given regions
  8179. </summary>
  8180. </member>
  8181. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaMeasurementInputPointTypeConstants.FilledPoint">
  8182. <summary>
  8183. The point of the input profile was missing but has been filled before the measurement
  8184. </summary>
  8185. </member>
  8186. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaMeasurementInputPointTypeConstants.MissingPoint">
  8187. <summary>
  8188. The point of the input profile was missing
  8189. </summary>
  8190. </member>
  8191. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaPointTypeConstants">
  8192. <summary>
  8193. An enumeration that specifies the point to find within one or more
  8194. profile regions.
  8195. </summary>
  8196. </member>
  8197. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaPointTypeConstants.ClosestPointBelowReferenceProfile">
  8198. <summary>
  8199. ClosestPointBelowReferenceProfile of the AreaResult (if exist):
  8200. the closest point below the reference profile.
  8201. </summary>
  8202. </member>
  8203. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaPointTypeConstants.FarthestPointBelowReferenceProfile">
  8204. <summary>
  8205. FarthestPointBelowReferenceProfile of the AreaResult (if exist):
  8206. the farthest point below the reference profile.
  8207. </summary>
  8208. </member>
  8209. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaPointTypeConstants.ClosestPointAboveReferenceProfile">
  8210. <summary>
  8211. ClosestPointAboveReferenceProfile of the AreaResult (if exist):
  8212. the closest point above the reference profile.
  8213. </summary>
  8214. </member>
  8215. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaPointTypeConstants.FarthestPointAboveReferenceProfile">
  8216. <summary>
  8217. FarthestPointAboveReferenceProfile of the AreaResult (if exist):
  8218. the farthest point above the reference profile.
  8219. </summary>
  8220. </member>
  8221. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaPointTypeConstants.RightPoint">
  8222. <summary>
  8223. RightPoint of the AreaResult (if exist): the point with the highest x coordinate.
  8224. </summary>
  8225. </member>
  8226. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaPointTypeConstants.LeftPoint">
  8227. <summary>
  8228. LeftPoint of the AreaResult (if exist): the point with the lowest x coordinate.
  8229. </summary>
  8230. </member>
  8231. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaInputOperatorTypeConstants.Circle">
  8232. <summary>
  8233. The input operator is one that provides CogCircle as output.
  8234. </summary>
  8235. </member>
  8236. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaInputOperatorTypeConstants.LineSegment">
  8237. <summary>
  8238. The input operator is one that provides CogLineSegment as output.
  8239. </summary>
  8240. </member>
  8241. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaReferenceProfileCreationConstants">
  8242. <summary>
  8243. Parameters for creating the reference profile from the input shapes.
  8244. </summary>
  8245. </member>
  8246. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaReferenceProfileCreationConstants.CreateFromLowest">
  8247. <summary>
  8248. Create the reference profile from the lowest shapes.
  8249. </summary>
  8250. </member>
  8251. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaReferenceProfileCreationConstants.CreateFromHighest">
  8252. <summary>
  8253. Create the reference profile from the highest shapes.
  8254. </summary>
  8255. </member>
  8256. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaConstants">
  8257. <summary>
  8258. An enumeration that specifies which area is being measured
  8259. - above the reference profile and below the input profile
  8260. - bwloe the reference profile and above the input profile
  8261. - above and below the reference profile and they added together
  8262. - above and below the reference profile and the below the below area is substracted from the above area
  8263. </summary>
  8264. </member>
  8265. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaConstants.AreaAboveMinusAreaBelow">
  8266. <summary>
  8267. The area being measured is both the above and below part and
  8268. the below area is subtracted from the above area
  8269. </summary>
  8270. </member>
  8271. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaConstants.AreaAbovePlusAreaBelow">
  8272. <summary>
  8273. The area being measured is both the above and below part and they are added together
  8274. </summary>
  8275. </member>
  8276. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaConstants.AreaBelowReferenceProfile">
  8277. <summary>
  8278. The area being measured is below the reference profile and above the input profile
  8279. </summary>
  8280. </member>
  8281. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionAreaConstants.AreaAboveReferenceProfile">
  8282. <summary>
  8283. The area being measured is above the reference profile and below the input profile
  8284. </summary>
  8285. </member>
  8286. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionLastRunRecordDiagConstants">
  8287. <summary>
  8288. Enumeration of diagnostic data that can be provided in the
  8289. Tool's LastRunRecord.
  8290. </summary>
  8291. </member>
  8292. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionLastRunRecordDiagConstants.All">
  8293. <summary>
  8294. Include all of the diagnostic data in the LastRunRecord.
  8295. </summary>
  8296. </member>
  8297. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionLastRunRecordDiagConstants.Region">
  8298. <summary>
  8299. Include a copy of the region in the LastRunRecord.
  8300. </summary>
  8301. </member>
  8302. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionLastRunRecordDiagConstants.InputImageDeepCopy">
  8303. <summary>
  8304. Include a deep copy of the input image in the LastRunRecord.
  8305. </summary>
  8306. </member>
  8307. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionLastRunRecordDiagConstants.InputImageByReference">
  8308. <summary>
  8309. Include a reference to the input image in the LastRunRecord.
  8310. </summary>
  8311. </member>
  8312. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionLastRunRecordDiagConstants.None">
  8313. <summary>
  8314. Do not include any of the diagnostic data in the LastRunRecord.
  8315. </summary>
  8316. </member>
  8317. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionLastRunRecordConstants">
  8318. <summary>
  8319. Enumeration of non-diagnostic data that can be provided in
  8320. the Tool's LastRunRecord.
  8321. </summary>
  8322. </member>
  8323. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionLastRunRecordConstants.All">
  8324. <summary>
  8325. Include all of the non-diagnostic data in the LastRunRecord.
  8326. </summary>
  8327. </member>
  8328. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionLastRunRecordConstants.Measurements">
  8329. <summary>
  8330. Include only the measurements in the LastRunRecord.CombinedGraphics.
  8331. </summary>
  8332. </member>
  8333. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionLastRunRecordConstants.Features">
  8334. <summary>
  8335. Include only the features in the LastRunRecord.CombinedGraphics.
  8336. </summary>
  8337. </member>
  8338. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionLastRunRecordConstants.None">
  8339. <summary>
  8340. Do not include any of the non-diagnostic data in the LastRunRecord.
  8341. </summary>
  8342. </member>
  8343. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionCurrentRecordConstants.All">
  8344. <summary>
  8345. Include all possible records in the CurrentRecord.
  8346. </summary>
  8347. </member>
  8348. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionCurrentRecordConstants.FixturedCoordinateAxes">
  8349. <summary>
  8350. Include the fixtured coordinate space origin
  8351. in the CurrentRecord.Profile
  8352. </summary>
  8353. </member>
  8354. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionCurrentRecordConstants.Region">
  8355. <summary>
  8356. Include the (interactive) region to be used as a mask
  8357. in the CurrentRecord.
  8358. </summary>
  8359. </member>
  8360. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionCurrentRecordConstants.InputImage">
  8361. <summary>
  8362. Include the input image in the CurrentRecord.
  8363. </summary>
  8364. </member>
  8365. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionCurrentRecordConstants.None">
  8366. <summary>
  8367. Do not include any records in the CurrentRecord.
  8368. </summary>
  8369. </member>
  8370. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants">
  8371. <summary>
  8372. An enumeration that specifies the status of an operator when run.
  8373. </summary>
  8374. </member>
  8375. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants.InputFeatureMissing">
  8376. <summary>
  8377. The operator ran but one or more of its input operators were not found.
  8378. </summary>
  8379. </member>
  8380. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants.FailedToMeasure">
  8381. <summary>
  8382. The operator ran but failed to produce a measurement.
  8383. </summary>
  8384. </member>
  8385. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants.FeatureNotExtracted">
  8386. <summary>
  8387. The operator ran but failed to extract a feature.
  8388. </summary>
  8389. </member>
  8390. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants.FeatureNotComputed">
  8391. <summary>
  8392. The operator ran but failed to compute a feature.
  8393. </summary>
  8394. </member>
  8395. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants.FailedTolerance">
  8396. <summary>
  8397. The operator ran but one or more of the tolerances failed.
  8398. </summary>
  8399. </member>
  8400. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants.Passed">
  8401. <summary>
  8402. The operator ran and passed.
  8403. </summary>
  8404. </member>
  8405. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorResultConstants.NotRun">
  8406. <summary>
  8407. The operator has not been run.
  8408. </summary>
  8409. </member>
  8410. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOutputTypeConstants">
  8411. <summary>
  8412. An enumeration that specifies the
  8413. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorBase.OutputType" />
  8414. of an operator.
  8415. </summary>
  8416. </member>
  8417. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOutputTypeConstants.Circle">
  8418. <summary>
  8419. The operator output is a Circle.
  8420. </summary>
  8421. </member>
  8422. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOutputTypeConstants.AreaResult">
  8423. <summary>
  8424. The operator output is a AreaStatistics.
  8425. </summary>
  8426. </member>
  8427. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOutputTypeConstants.Value">
  8428. <summary>
  8429. The operator output is a numerical value.
  8430. </summary>
  8431. </member>
  8432. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOutputTypeConstants.Angle">
  8433. <summary>
  8434. The operator output is an angle: a double value,
  8435. measured in radians.
  8436. </summary>
  8437. </member>
  8438. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOutputTypeConstants.LineSegment">
  8439. <summary>
  8440. The operator output is a CogLineSegment.
  8441. </summary>
  8442. </member>
  8443. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOutputTypeConstants.Point">
  8444. <summary>
  8445. The operator output is a CogPointMarker.
  8446. </summary>
  8447. </member>
  8448. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfileSpaceSelectionConstants">
  8449. <summary>
  8450. An enumeration that specifies which profile coordinate space will
  8451. be used as the
  8452. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.ProfileSelectedSpaceName">
  8453. selected profile space</see> when the
  8454. <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams">
  8455. operators</see> are executed.
  8456. </summary>
  8457. </member>
  8458. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfileSpaceSelectionConstants.New">
  8459. <summary>
  8460. A new profile coordinate space will created and used as the
  8461. selected profile space. The name of the new space is given by
  8462. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams.ProfileNewSpaceName" />
  8463. and its transform is given by
  8464. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams.DefautFromNewTransform" />.
  8465. </summary>
  8466. </member>
  8467. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfileSpaceSelectionConstants.Existing">
  8468. <summary>
  8469. An existing profile coordinate space will be used as the selected
  8470. profile space. The name of the existing space is given by
  8471. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams.ProfileExistingSpaceName" />.
  8472. </summary>
  8473. </member>
  8474. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfileSpaceSelectionConstants.Default">
  8475. <summary>
  8476. The selected profile space will not be changed. It is already
  8477. specified by the
  8478. <see cref="!:P:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile.ProfileSelectedSpaceName" />
  8479. of the <see cref="!:T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile">
  8480. profile </see> that is passed into the
  8481. <see cref="!:M:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionOperatorsParams.Execute(Cognex.VisionPro3D.Cog3DRangeImageCrossSectionProfile)" />
  8482. method.
  8483. </summary>
  8484. </member>
  8485. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointTypeConstants">
  8486. <summary>
  8487. An enumeration that specifies the point to find within one or more
  8488. profile regions.
  8489. </summary>
  8490. </member>
  8491. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointTypeConstants.BottomRight">
  8492. <summary>
  8493. BottomRight point: the point with the lowest y coordinate and highest x coordinate.
  8494. </summary>
  8495. </member>
  8496. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointTypeConstants.BottomLeft">
  8497. <summary>
  8498. BottomLeft point: the point with the lowest y coordinate and lowest x coordinate.
  8499. </summary>
  8500. </member>
  8501. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointTypeConstants.TopRight">
  8502. <summary>
  8503. TopRight point: the point with the highest y coordinate and highest x coordinate.
  8504. </summary>
  8505. </member>
  8506. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointTypeConstants.TopLeft">
  8507. <summary>
  8508. TopLeft point: the point with the highest y coordinate and lowest x coordinate.
  8509. </summary>
  8510. </member>
  8511. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointTypeConstants.Average">
  8512. <summary>
  8513. Average point: the average position of all points within one or
  8514. more profile regions.
  8515. </summary>
  8516. </member>
  8517. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointTypeConstants.Right">
  8518. <summary>
  8519. Rightmost point: the point with the highest x coordinate.
  8520. </summary>
  8521. </member>
  8522. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointTypeConstants.Left">
  8523. <summary>
  8524. Leftmost point: the point with the lowest x coordinate.
  8525. </summary>
  8526. </member>
  8527. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointTypeConstants.Bottom">
  8528. <summary>
  8529. Bottommost point: the point with the lowest y coordinate.
  8530. </summary>
  8531. </member>
  8532. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionPointTypeConstants.Top">
  8533. <summary>
  8534. Topmost point: the point with the highest y coordinate.
  8535. </summary>
  8536. </member>
  8537. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionCornerSortConstants">
  8538. <summary>
  8539. An enumeration that specifies the sorting order when multiple
  8540. corners are found within one or more profile regions.
  8541. </summary>
  8542. </member>
  8543. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionCornerSortConstants.Sharpness">
  8544. <summary>
  8545. The sorting order is based on the sharpness of the corner.
  8546. The corners are sorted from sharpest to least sharp.
  8547. </summary>
  8548. </member>
  8549. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionCornerSortConstants.RightToLeft">
  8550. <summary>
  8551. The sorting order is based on the x-axis position of the corner.
  8552. The corners are sorted from right to left.
  8553. </summary>
  8554. </member>
  8555. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionCornerSortConstants.LeftToRight">
  8556. <summary>
  8557. The sorting order is based on the x-axis position of the corner.
  8558. The corners are sorted from left to right.
  8559. </summary>
  8560. </member>
  8561. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionCornerPolarityConstants">
  8562. <summary>
  8563. An enumeration that specifies the polarity of a corner.
  8564. </summary>
  8565. </member>
  8566. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionCornerPolarityConstants.Both">
  8567. <summary>
  8568. The desired corner can be either a peak or a valley.
  8569. </summary>
  8570. </member>
  8571. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionCornerPolarityConstants.Valley">
  8572. <summary>
  8573. The corner occurs where the profile data is concave upward:
  8574. the slope of the profile increases as you move in the positive
  8575. direction along the x-axis.
  8576. </summary>
  8577. </member>
  8578. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionCornerPolarityConstants.Peak">
  8579. <summary>
  8580. The corner occurs where the profile data is concave downward:
  8581. the slope of the profile decreases as you move in the positive
  8582. direction along the x-axis.
  8583. </summary>
  8584. </member>
  8585. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionLineSegmentPointConstants">
  8586. <summary>
  8587. An enumeration that specifies a point on a given line segment.
  8588. </summary>
  8589. </member>
  8590. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionLineSegmentPointConstants.End">
  8591. <summary>
  8592. The end point of a line segment.
  8593. </summary>
  8594. </member>
  8595. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionLineSegmentPointConstants.Start">
  8596. <summary>
  8597. The start point of a line segment.
  8598. </summary>
  8599. </member>
  8600. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionLineSegmentPointConstants.Middle">
  8601. <summary>
  8602. The middle point of a line segment.
  8603. </summary>
  8604. </member>
  8605. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistanceTypeConstants">
  8606. <summary>
  8607. An enumeration that specifies how to compute the distance between
  8608. two points.
  8609. </summary>
  8610. </member>
  8611. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistanceTypeConstants.Y">
  8612. <summary>
  8613. Compute the y-axis distance between two points.
  8614. </summary>
  8615. </member>
  8616. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistanceTypeConstants.X">
  8617. <summary>
  8618. Compute the x-axis distance between two points.
  8619. </summary>
  8620. </member>
  8621. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionDistanceTypeConstants.Euclidean">
  8622. <summary>
  8623. Compute the Euclidean distance between two points.
  8624. </summary>
  8625. </member>
  8626. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionNearestTypeConstants">
  8627. <summary>
  8628. An enumeration that specifies whether or not to treat a line
  8629. segment as an infinite line when determining the point "on" the
  8630. segment that is nearest to a given point.
  8631. </summary>
  8632. </member>
  8633. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionNearestTypeConstants.NearestToLineSegment">
  8634. <summary>
  8635. The nearest point must fall on the line segment.
  8636. </summary>
  8637. </member>
  8638. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageCrossSectionNearestTypeConstants.NearestToLine">
  8639. <summary>
  8640. The nearest point may fall anywhere along the infinite line
  8641. that passes through the line segment.
  8642. </summary>
  8643. </member>
  8644. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.LastRunRecordDiagEnable">
  8645. <summary>
  8646. Enable creation of records by bitwise ORing the appropriate
  8647. Cog3DRangeImageHeightCalculatorLastRunRecordDiagConstants.
  8648. </summary>
  8649. <value>
  8650. The default is
  8651. (Cog3DRangeImageHeightCalculatorLastRunRecordDiagConstants::InputImageByReference |
  8652. Cog3DRangeImageHeightCalculatorLastRunRecordDiagConstants::Region |
  8653. Cog3DRangeImageHeightCalculatorLastRunRecordDiagConstants::UsedPixels |
  8654. Cog3DRangeImageHeightCalculatorLastRunRecordDiagConstants::Histogram)
  8655. </value>
  8656. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  8657. <para>Fires when this property changes.</para>
  8658. <para>The following state flag will be set:</para>
  8659. <list type="bullet">
  8660. <item>SfLastRunRecordDiagEnable</item>
  8661. </list>
  8662. </event>
  8663. </member>
  8664. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.LastRunRecordEnable">
  8665. <summary>
  8666. Enable creation of records by bitwise ORing the appropriate
  8667. Cog3DRangeImageHeightCalculatorLastRunRecordConstants.
  8668. </summary>
  8669. <value>
  8670. The default is Cog3DRangeImageHeightCalculatorLastRunRecordConstants::None
  8671. </value>
  8672. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  8673. <para>Fires when this property changes.</para>
  8674. <para>The following state flag will be set:</para>
  8675. <list type="bullet">
  8676. <item>SfLastRunRecordEnable</item>
  8677. <item>SfCreateLastRunRecord</item>
  8678. </list>
  8679. </event>
  8680. </member>
  8681. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.CurrentRecordEnable">
  8682. <summary>
  8683. Enable creation of records by bitwise ORing the appropriate
  8684. Cog3DRangeImageHeightCalculatorCurrentRecordConstants.
  8685. </summary>
  8686. <value>
  8687. The default is (int)Cog3DRangeImageHeightCalculatorCurrentRecordConstants::InputImage | (int)Cog3DRangeImageHeightCalculatorCurrentRecordConstants::Region
  8688. </value>
  8689. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  8690. <para>Fires when this property changes.</para>
  8691. <para>The following state flag will be set:</para>
  8692. <list type="bullet">
  8693. <item>SfCurrentRecordEnable</item>
  8694. <item>SfCreateCurrentRecord</item>
  8695. </list>
  8696. </event>
  8697. </member>
  8698. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.Result">
  8699. <summary>
  8700. The result of running the height calculator tool
  8701. </summary>
  8702. <remarks>
  8703. <para>
  8704. In the context of the height calculator, "used" pixels are the image
  8705. pixels that contribute to the height calculation.
  8706. </para>
  8707. <para>
  8708. A range image pixel is "used" to calculate the height if:
  8709. <list type="bullet"><item>
  8710. it is inside the 2D input
  8711. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.Region" />
  8712. of the tool.
  8713. </item><item>
  8714. it is marked "care" in the optional
  8715. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.InputImageMask" />
  8716. provided as part of the
  8717. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.RunParams" />.
  8718. </item><item>
  8719. it is marked as "visible pixel" in the visible pixel mask of the
  8720. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.InputImage" />.
  8721. The visible pixel mask can be accessed by calling
  8722. <see cref="M:Cognex.VisionPro.CogImage16Range.GetMaskData" /> on the range image.
  8723. </item><item>
  8724. its height falls within the valid height range configured in the height tool's
  8725. run parameters. See <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.HeightRangeFilterEnabled" />.
  8726. </item></list></para>
  8727. <para>
  8728. Pixels that meet these conditions contribute to the height computation
  8729. and are marked as "used" in the
  8730. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.PixelCountsDiagImage" />.
  8731. </para>
  8732. <para>
  8733. Only "used" pixels are included in the height tool's
  8734. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.Histogram" /> data.
  8735. </para>
  8736. <para>
  8737. Note that the height of an individual range image pixel is defined as
  8738. the signed distance from the center of the range image pixel to
  8739. the nearest point on the base plane (measured in selected space 3D units).
  8740. </para>
  8741. <para>
  8742. By default the positive height direction is defined to be in the same direction as the
  8743. normal vector of the base plane. However, the positive height direction can be
  8744. reversed by setting the <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.PlaneSide" /> property.
  8745. </para>
  8746. </remarks>
  8747. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  8748. <para>Fires when this property changes.</para>
  8749. <para>The following state flag will be set:</para>
  8750. <list type="bullet">
  8751. <item>SfResult</item>
  8752. </list>
  8753. </event>
  8754. </member>
  8755. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.RunParams">
  8756. <summary>
  8757. The height calculator tool's run parameters operator
  8758. </summary>
  8759. <value>
  8760. The value can not be null.
  8761. The default is a default Cog3DRangeImageHeightCalculator.
  8762. </value>
  8763. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  8764. <para>Fires when this property changes.</para>
  8765. <para>The following state flag will be set:</para>
  8766. <list type="bullet">
  8767. <item>SfRunParams</item>
  8768. </list>
  8769. </event>
  8770. </member>
  8771. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.BasePlane">
  8772. <summary>
  8773. The calculated height is the distance of the range image pixels from this
  8774. plane (see also
  8775. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.PlaneSide" />).
  8776. </summary>
  8777. <value>
  8778. The default is a horizontal plane at z = 0.
  8779. </value>
  8780. <remarks>
  8781. If BasePlane is set to null a horizontal plane at z = 0 will be used.
  8782. </remarks>
  8783. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  8784. <para>Fires when this property changes.</para>
  8785. <para>The following state flag will be set:</para>
  8786. <list type="bullet">
  8787. <item>SfBasePlane</item>
  8788. </list>
  8789. </event>
  8790. </member>
  8791. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.Region">
  8792. <summary>
  8793. The 2D region of the range image which contains the pixels
  8794. of interest. Only pixels contained within this region will
  8795. be used to calculate the height.
  8796. </summary>
  8797. <remarks>
  8798. A pixel is considered inside the 2D region if the pixel's
  8799. 2D center falls within the region.
  8800. </remarks>
  8801. <value>
  8802. The region can be null to use the entire range image.
  8803. The default is a default CogRectangleAffine
  8804. </value>
  8805. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  8806. <para>Fires when this property changes.</para>
  8807. <para>The following state flag will be set:</para>
  8808. <list type="bullet">
  8809. <item>SfRegion</item>
  8810. </list>
  8811. </event>
  8812. </member>
  8813. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.InputImage">
  8814. <summary>
  8815. The range image surface data used in the height calculation.
  8816. </summary>
  8817. <value>
  8818. The default is null.
  8819. </value>
  8820. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  8821. <para>Fires when this property changes.</para>
  8822. <para>The following state flag will be set:</para>
  8823. <list type="bullet">
  8824. <item>SfInputImage</item>
  8825. </list>
  8826. </event>
  8827. </member>
  8828. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.BuildHistogramRecord(Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult)">
  8829. <summary>
  8830. Constructs and returns a record containing a histogram graphic
  8831. for use in the tool's last run record.
  8832. </summary>
  8833. </member>
  8834. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.BuildHistogramChangeSpaceNameCmd(System.String,System.String)">
  8835. <summary>
  8836. Creates a DisplayMethod to be used as the content of
  8837. a parent image record's subrecord. When the parent image
  8838. record is displayed by a CogRecordDisplay, the subrecord
  8839. will cause a transform to be renamed in the Display's
  8840. UserPixelTree.
  8841. </summary>
  8842. </member>
  8843. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.BuildHistogramAddSpaceCmd(Cognex.VisionPro.CogTransform2DLinear,System.String)">
  8844. <summary>
  8845. Creates a DisplayMethod to be used as the content of
  8846. a parent image record's subrecord. When the parent image
  8847. record is displayed by a CogRecordDisplay, the subrecord
  8848. will cause a transform to be added to the Display's UserPixelTree.
  8849. </summary>
  8850. </member>
  8851. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.AddMarker(System.String,System.Double,System.Double,System.Int32,System.Drawing.Font,Cognex.VisionPro.CogGraphicCollection)">
  8852. <summary>
  8853. Draws a vertical line to mark a notable height
  8854. locations in the histogram graphics.
  8855. </summary>
  8856. </member>
  8857. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.GetMaxNumPixels(System.Int32[])">
  8858. <summary>
  8859. The statistical mode is not included in
  8860. the results returned from CVT.
  8861. This function finds the mode of the histogram.
  8862. </summary>
  8863. </member>
  8864. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  8865. <summary>
  8866. Serialization Constructor
  8867. </summary>
  8868. </member>
  8869. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.Clone">
  8870. <summary>
  8871. Returns a deep copy of this class instance.
  8872. </summary>
  8873. <remarks>
  8874. This method's implementation calls
  8875. <see cref="!:Cog3DRangeImageVolumeCalculatorTool(Cog3DRangeImageHeightCalculatorTool^)" />.
  8876. </remarks>
  8877. </member>
  8878. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.#ctor(Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool)">
  8879. <summary>
  8880. Constructs a deep copy of the supplied Cog3DRangeImageHeightCalculatorTool.
  8881. </summary>
  8882. <param name="other">
  8883. The Cog3DRangeImageHeightCalculatorTool to be copied. May not be null.
  8884. </param>
  8885. <exception cref="T:System.ArgumentNullException">
  8886. Thrown if <paramref name="other" /> is null.
  8887. </exception>
  8888. <exception cref="T:System.InvalidOperationException">
  8889. Thrown if <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.Region" /> does not support
  8890. <see cref="T:System.ICloneable" />.
  8891. </exception>
  8892. <remarks>
  8893. The properties of <paramref name="other" /> are copied as follows:
  8894. <list type="bullet"><item><see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.InputImage" />
  8895. is copied by calling <see cref="M:Cognex.VisionPro.ICogImage.CopyBase(Cognex.VisionPro.CogImageCopyModeConstants)" /> with the
  8896. <see cref="T:Cognex.VisionPro.CogImageCopyModeConstants">CogImageCopyModeConstants</see> flag set.
  8897. </item><item><see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.Region" />
  8898. is copied by calling <see cref="M:System.ICloneable.Clone" /> (an exception
  8899. is thrown if the region cannot does not support <see cref="T:System.ICloneable" />).
  8900. </item><item><see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.BasePlane" />
  8901. is copied by calling <see cref="M:Cognex.VisionPro3D.Cog3DPlane.#ctor(Cognex.VisionPro3D.Cog3DPlane)" />.
  8902. </item><item><see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.RunParams" />
  8903. is copied by calling <see cref="M:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.#ctor(Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator)" />.
  8904. </item><item><see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.Result" />
  8905. is copied by calling <see cref="M:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.#ctor(Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult)" />.
  8906. </item><item>
  8907. The
  8908. <see cref="P:Cognex.VisionPro.ICogTool.DataBindings" />
  8909. are copied by calling
  8910. <see cref="M:Cognex.VisionPro.CogDataBindingsCollection.#ctor(System.Object,Cognex.VisionPro.CogDataBindingsCollection)" />.
  8911. The data bindings of the original tool are duplicated in the new tool.
  8912. The databindings are copied with their destinations pointing _into_ the
  8913. new tool, while their sources are copied directly and still point _from_
  8914. the same upstream objects (tools) as the original tool's databindings.
  8915. </item><item>
  8916. The
  8917. <see cref="P:Cognex.VisionPro.ICogTool.UserData" />
  8918. is copied by calling
  8919. <see cref="M:Cognex.VisionPro.CogDictionary.#ctor(Cognex.VisionPro.CogDictionary)" />.
  8920. </item><item>
  8921. The <see cref="P:Cognex.VisionPro.ICogTool.RunStatus" />
  8922. is copied by calling
  8923. <see cref="M:Cognex.VisionPro.Implementation.CogRunStatus.#ctor(Cognex.VisionPro.ICogRunStatus)" />.
  8924. </item></list></remarks>
  8925. </member>
  8926. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.#ctor">
  8927. <summary>
  8928. Construct a new instance of this class.
  8929. </summary>
  8930. </member>
  8931. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.CacheLastRunData">
  8932. <summary>
  8933. Cache the last run record data so it
  8934. can be accesed by CreateLastRunRecord.
  8935. </summary>
  8936. </member>
  8937. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.ClearLastRunCache">
  8938. <summary>
  8939. Clear any cached last run record data.
  8940. </summary>
  8941. </member>
  8942. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.SfLastRunRecordDiagEnable">
  8943. <summary>
  8944. This bit will be set in the EventArgs of a Changed event every time the
  8945. value returned by LastRunRecordDiagEnable may have changed.
  8946. </summary>
  8947. </member>
  8948. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.SfLastRunRecordEnable">
  8949. <summary>
  8950. This bit will be set in the EventArgs of a Changed event every time the
  8951. value returned by LastRunRecordEnable may have changed.
  8952. </summary>
  8953. </member>
  8954. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.SfCurrentRecordEnable">
  8955. <summary>
  8956. This bit will be set in the EventArgs of a Changed event every time the
  8957. value returned by CurrentRecordEnable may have changed.
  8958. </summary>
  8959. </member>
  8960. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.SfResult">
  8961. <summary>
  8962. This bit will be set in the EventArgs of a Changed event every time the
  8963. value returned by RunParams may have changed.
  8964. </summary>
  8965. </member>
  8966. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.SfRunParams">
  8967. <summary>
  8968. This bit will be set in the EventArgs of a Changed event every time the
  8969. value returned by RunParams may have changed.
  8970. </summary>
  8971. </member>
  8972. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.SfBasePlane">
  8973. <summary>
  8974. This bit will be set in the EventArgs of a Changed event every time the
  8975. value returned by Region may have changed.
  8976. </summary>
  8977. </member>
  8978. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.SfRegion">
  8979. <summary>
  8980. This bit will be set in the EventArgs of a Changed event every time the
  8981. value returned by Region may have changed.
  8982. </summary>
  8983. </member>
  8984. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.SfInputImage">
  8985. <summary>
  8986. This bit will be set in the EventArgs of a Changed event every time the
  8987. value returned by InputImage may have changed.
  8988. </summary>
  8989. </member>
  8990. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool">
  8991. <summary>
  8992. <para>
  8993. A range image has pixel values that represent the distance from a
  8994. reference plane to an object.
  8995. </para>
  8996. <para>
  8997. The height calculator tool measures the height of the surface
  8998. defined by the range image pixels relative to a user supplied base plane.
  8999. </para>
  9000. <para>
  9001. The computed height is returned in the
  9002. <see cref="P:Cognex.VisionPro.CogImage16Range.SelectedSpaceName3D" />
  9003. units specified in the range image (e.g. mm^3).
  9004. </para>
  9005. </summary>
  9006. <remarks>
  9007. <para>
  9008. In the context of the height calculator, "used" pixels are the image
  9009. pixels that contribute to the height calculation.
  9010. </para>
  9011. <para>
  9012. A range image pixel is "used" to calculate the height if:
  9013. <list type="bullet"><item>
  9014. it is inside the 2D input
  9015. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.Region" />
  9016. of the tool.
  9017. </item><item>
  9018. it is marked "care" in the optional
  9019. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.InputImageMask" />
  9020. provided as part of the
  9021. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.RunParams" />.
  9022. </item><item>
  9023. it is marked as "visible pixel" in the visible pixel mask of the
  9024. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.InputImage" />.
  9025. The visible pixel mask can be accessed by calling
  9026. <see cref="M:Cognex.VisionPro.CogImage16Range.GetMaskData" /> on the range image.
  9027. </item><item>
  9028. its height falls within the valid height range configured in the height tool's
  9029. run parameters. See <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.HeightRangeFilterEnabled" />.
  9030. </item></list></para>
  9031. <para>
  9032. Pixels that meet these conditions contribute to the height computation
  9033. and are marked as "used" in the
  9034. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.PixelCountsDiagImage" />.
  9035. </para>
  9036. <para>
  9037. Only "used" pixels are included in the height tool's
  9038. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.Histogram" /> data.
  9039. </para>
  9040. <para>
  9041. Note that the height of an individual range image pixel is defined as
  9042. the signed distance from the center of the range image pixel to
  9043. the nearest point on the base plane (measured in selected space 3D units).
  9044. </para>
  9045. <para>
  9046. By default the positive height direction is defined to be in the same direction as the
  9047. normal vector of the base plane. However, the positive height direction can be
  9048. reversed by setting the <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.PlaneSide" /> property.
  9049. </para>
  9050. </remarks>
  9051. </member>
  9052. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorLastRunRecordDiagConstants">
  9053. <summary>
  9054. Enumeration of diagnostic data that can be provided in the Tool's
  9055. LastRunRecord.
  9056. </summary>
  9057. </member>
  9058. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorLastRunRecordDiagConstants.All">
  9059. <summary>
  9060. Include all possible records.
  9061. </summary>
  9062. </member>
  9063. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorLastRunRecordDiagConstants.Histogram">
  9064. <summary>
  9065. Include a histogram graphic
  9066. </summary>
  9067. </member>
  9068. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorLastRunRecordDiagConstants.UsedPixels">
  9069. <summary>
  9070. Include a mask graphic representing which range image
  9071. pixels were used in the height calculation
  9072. </summary>
  9073. </member>
  9074. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorLastRunRecordDiagConstants.InputImageMask">
  9075. <summary>
  9076. Include a graphic representing the input image mask in
  9077. the LastRunRecord.
  9078. </summary>
  9079. </member>
  9080. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorLastRunRecordDiagConstants.Region">
  9081. <summary>
  9082. Include a copy of the region in the LastRunRecord.
  9083. </summary>
  9084. </member>
  9085. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorLastRunRecordDiagConstants.InputImageDeepCopy">
  9086. <summary>
  9087. Include a deep copy of the input image in the LastRunRecord.
  9088. </summary>
  9089. </member>
  9090. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorLastRunRecordDiagConstants.InputImageByReference">
  9091. <summary>
  9092. Include a reference to the input image in the LastRunRecord.
  9093. </summary>
  9094. </member>
  9095. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorLastRunRecordDiagConstants.None">
  9096. <summary>
  9097. Do not include any of the non-diagnostic data in the LastRunRecord.
  9098. </summary>
  9099. </member>
  9100. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorLastRunRecordConstants">
  9101. <summary>
  9102. Enumeration of non-diagnostic data that can be provided in the Tool's
  9103. LastRunRecord.
  9104. </summary>
  9105. </member>
  9106. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorLastRunRecordConstants.All">
  9107. <summary>
  9108. Include all possible records.
  9109. </summary>
  9110. </member>
  9111. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorLastRunRecordConstants.None">
  9112. <summary>
  9113. Do not include any of the non-diagnostic data in the LastRunRecord.
  9114. </summary>
  9115. </member>
  9116. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorCurrentRecordConstants">
  9117. <summary>
  9118. Enumeration of data that can be provided in the Tool's CurrentRecord.
  9119. </summary>
  9120. </member>
  9121. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorCurrentRecordConstants.All">
  9122. <summary>
  9123. Include all possible records in the CurrentRecord.
  9124. </summary>
  9125. </member>
  9126. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorCurrentRecordConstants.InputImageMask">
  9127. <summary>
  9128. Include a graphic representing the input image mask in
  9129. the CurrentRecord.
  9130. </summary>
  9131. </member>
  9132. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorCurrentRecordConstants.Region">
  9133. <summary>
  9134. Include the (interactive) region to be processed at run time in the
  9135. CurrentRecord.
  9136. </summary>
  9137. </member>
  9138. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorCurrentRecordConstants.InputImage">
  9139. <summary>
  9140. Include the input image in the CurrentRecord.
  9141. </summary>
  9142. </member>
  9143. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorCurrentRecordConstants.None">
  9144. <summary>
  9145. Do not include any records in the CurrentRecord.
  9146. </summary>
  9147. </member>
  9148. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.Execute(Cognex.VisionPro.CogImage16Range,Cognex.VisionPro.ICogRegion,System.Double)">
  9149. <summary>
  9150. Computes the height of the range image surface relative to
  9151. a horizontal base plane with a user specified Z height.
  9152. <para>
  9153. The base plane has a 3D selected space coordinate normal vector (0, 0, 1),
  9154. i.e. oriented along the positive z axis.
  9155. </para></summary>
  9156. <param name="rangeImage">
  9157. The range image surface data of which the height is calculated.
  9158. </param>
  9159. <param name="region">
  9160. The 2D region of the range image which contains the pixels
  9161. of interest. Only pixels contained within this region will
  9162. be used to calculate the height.
  9163. The region can be null to use the entire range image.
  9164. </param>
  9165. <param name="horizontalPlaneZ">
  9166. The z value (usually the height) of the horizontal 3D plane,
  9167. in the selected space 3D coordinates of the range image
  9168. </param>
  9169. <exception cref="T:Cognex.VisionPro.Exceptions.CogOperatorNoInputImageException">
  9170. <list type="bullet">
  9171. <item>Thrown if <paramref name="rangeImage" /> is null.</item>
  9172. </list>
  9173. </exception>
  9174. <exception cref="T:Cognex.VisionPro.Exceptions.CogImageNoPixelsException">
  9175. <list type="bullet">
  9176. <item>Thrown if <paramref name="rangeImage" /> is is not allocated.</item>
  9177. </list>
  9178. </exception>
  9179. <exception cref="T:System.ArgumentException">
  9180. <list type="bullet">
  9181. <item>Thrown if <paramref name="rangeImage" /> has a transform that is
  9182. singular (i.e., not invertible).
  9183. </item>
  9184. </list>
  9185. </exception>
  9186. <exception cref="T:System.InvalidOperationException">
  9187. <list type="bullet">
  9188. <item>Thrown if <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.LowTailFrac" />
  9189. + <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.HighTailFrac" /> is greater
  9190. than 1.
  9191. </item>
  9192. <item>Thrown if <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.HeightRangeFilterLow" />
  9193. is greater than <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.HeightRangeFilterHigh" />.
  9194. </item>
  9195. </list>
  9196. </exception>
  9197. </member>
  9198. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.Execute(Cognex.VisionPro.CogImage16Range,Cognex.VisionPro.ICogRegion,Cognex.VisionPro3D.Cog3DPlane)">
  9199. <summary>
  9200. Computes the height between the surface defined by the range image
  9201. pixels and the specified base plane.
  9202. </summary>
  9203. <param name="rangeImage">
  9204. The range image surface data of which to calculate the height
  9205. </param>
  9206. <param name="region">
  9207. The 2D region of the range image which contains the pixels
  9208. of interest. Only pixels contained within this region will
  9209. be used to calculate the height.
  9210. The region can be null to use the entire range image.
  9211. </param>
  9212. <param name="basePlane">
  9213. The plane relative to which the height is calculated.
  9214. (see also <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.PlaneSide" />).
  9215. The basePlane can be null to use a horizontal plane at z = 0.
  9216. </param>
  9217. <exception cref="T:Cognex.VisionPro.Exceptions.CogOperatorNoInputImageException">
  9218. <list type="bullet">
  9219. <item>Thrown if <paramref name="rangeImage" /> is null.</item>
  9220. </list>
  9221. </exception>
  9222. <exception cref="T:System.ArgumentException">
  9223. <list type="bullet">
  9224. <item>Thrown if <paramref name="rangeImage" /> is is not allocated.</item>
  9225. <item>Thrown if <paramref name="rangeImage" /> has a transform that is
  9226. singular (i.e., not invertible).</item>
  9227. <item>Thrown if <paramref name="basePlane" /> is degenerate.</item>
  9228. </list>
  9229. </exception>
  9230. <exception cref="T:System.InvalidOperationException">
  9231. <list type="bullet">
  9232. <item>Thrown if <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.LowTailFrac" />
  9233. + <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.HighTailFrac" /> is greater
  9234. than 1.
  9235. </item>
  9236. <item>Thrown if <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.HeightRangeFilterLow" />
  9237. is greater than <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.HeightRangeFilterHigh" />.
  9238. </item>
  9239. </list>
  9240. </exception>
  9241. <exception cref="!:CogSpaceTreeNotInTreeException">
  9242. if the SelectedSpaceName3D of the range image is not in the tree, or if the
  9243. SelectedSpaceName3D of the plane is not in the tree.
  9244. </exception>
  9245. </member>
  9246. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.InputImageMaskOffsetY">
  9247. <summary>
  9248. Gets or sets the 2D InputImageMask Y offset value in pixels.
  9249. </summary>
  9250. <value>
  9251. The InputImageMask Y offset value in pixels. The X and Y offset values
  9252. set the offset from the upper-left corner of the run-time input
  9253. image to th upper-left corner of the
  9254. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.InputImageMask" />
  9255. in pixels. The default is 0.
  9256. </value>
  9257. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  9258. <para>Fires when this property changes.</para>
  9259. <para>The following state flag will be set:</para>
  9260. <list type="bullet">
  9261. <item>SfInputImageMaskOffsetY</item>
  9262. </list>
  9263. </event>
  9264. </member>
  9265. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.InputImageMaskOffsetX">
  9266. <summary>
  9267. Gets or sets the 2D InputImageMask X offset value in pixels.
  9268. </summary>
  9269. <value>
  9270. The InputImageMask X offset value in pixels. The X and Y offset values
  9271. set the offset from the upper-left corner of the run-time input
  9272. image to th upper-left corner of the
  9273. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.InputImageMask" />
  9274. in pixels. The default is 0.
  9275. </value>
  9276. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  9277. <para>Fires when this property changes.</para>
  9278. <para>The following state flag will be set:</para>
  9279. <list type="bullet">
  9280. <item>SfInputImageMaskOffsetX</item>
  9281. </list>
  9282. </event>
  9283. </member>
  9284. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.InputImageMask">
  9285. <summary>
  9286. Gets or sets the input image mask.
  9287. The input image mask allows you to ignore regions
  9288. of the range image by masking them out.
  9289. </summary>
  9290. <value>
  9291. InputImageMask is optional and may be null if no mask is
  9292. required. The default is null.
  9293. <para>
  9294. 255 = use this pixel
  9295. </para><para>
  9296. 0 = ignore this pixel
  9297. </para></value>
  9298. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  9299. <para>Fires when this property changes.</para>
  9300. <para>The following state flag will be set:</para>
  9301. <list type="bullet">
  9302. <item>SfInputImageMaskOffset</item>
  9303. </list>
  9304. </event>
  9305. <remarks>
  9306. The input image mask is applied to the input image after taking the
  9307. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.InputImageMaskOffsetX" />
  9308. and
  9309. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.InputImageMaskOffsetY" />
  9310. into account.
  9311. </remarks>
  9312. </member>
  9313. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.PlaneSide">
  9314. <summary>
  9315. Specifies which side of the plane to consider the positive height
  9316. direction when computing the height.
  9317. </summary>
  9318. <value>
  9319. The default is Cog3DPlaneSideConstants::IncreasingPlaneNormal.
  9320. </value>
  9321. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  9322. <para>Fires when this property changes.</para>
  9323. <para>The following state flag will be set:</para>
  9324. <list type="bullet">
  9325. <item>SfPlaneSide</item>
  9326. </list>
  9327. </event>
  9328. </member>
  9329. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.HighTailFrac">
  9330. <summary>
  9331. Gets or sets a value which controls how the
  9332. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.HighTail" />
  9333. property of the result is calculated.
  9334. </summary>
  9335. <value>
  9336. The default is 0.01. The value must be between [0, 1].
  9337. </value>
  9338. <remarks>
  9339. <para>
  9340. The fraction which dictates how many of the highest pixels are discarded
  9341. before calculating the <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.HighTail" />
  9342. height.
  9343. </para>
  9344. <para>
  9345. For example if the HighTailFrac is set to 0.01, then
  9346. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.HighTail" />
  9347. is set such that 1 percent of "used" pixel heights are above it.
  9348. </para>
  9349. </remarks>
  9350. <exception cref="T:System.ArgumentOutOfRangeException">
  9351. <list type="bullet">
  9352. <item>Thrown if value falls outside the range [0, 1].</item>
  9353. </list>
  9354. </exception>
  9355. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  9356. <para>Fires when this property changes.</para>
  9357. <para>The following state flag will be set:</para>
  9358. <list type="bullet">
  9359. <item>SfHighTailFrac</item>
  9360. </list>
  9361. </event>
  9362. </member>
  9363. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.LowTailFrac">
  9364. <summary>
  9365. Gets or sets a value which controls how the
  9366. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.LowTail" />
  9367. property of the result is calculated.
  9368. </summary>
  9369. <value>
  9370. The default is 0.01. The value must be between [0, 1].
  9371. </value>
  9372. <remarks>
  9373. <para>
  9374. The fraction which dictates how many of the lowest pixels are discarded
  9375. before calculating the <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.LowTail" />
  9376. height.
  9377. </para>
  9378. <para>
  9379. For example if the LowTailFrac is set to 0.01, then
  9380. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.LowTail" />
  9381. is set such that 1 percent of "used" pixel heights are below it.
  9382. </para>
  9383. </remarks>
  9384. <exception cref="T:System.ArgumentOutOfRangeException">
  9385. <list type="bullet">
  9386. <item>Thrown if value falls outside the range [0, 1].</item>
  9387. </list>
  9388. </exception>
  9389. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  9390. <para>Fires when this property changes.</para>
  9391. <para>The following state flag will be set:</para>
  9392. <list type="bullet">
  9393. <item>SfLowTailFrac</item>
  9394. </list>
  9395. </event>
  9396. </member>
  9397. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.StdDevMult">
  9398. <summary>
  9399. Gets or sets a value that controls how the
  9400. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.MeanPlusStdDevMult" />
  9401. property of the result is calculated.
  9402. </summary>
  9403. <value>
  9404. The default is 0.0.
  9405. </value>
  9406. <remarks>
  9407. <para>
  9408. The standard deviation of "used" range image pixel heights is multiplied by StdDevMult.
  9409. The resulting value is then added to the mean of all the "used" pixel heights and returned
  9410. as the <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.MeanPlusStdDevMult" />
  9411. property of the overall result.
  9412. </para>
  9413. <para>
  9414. Note that it is valid to set StdDevMult to a value less than 0.0.
  9415. </para>
  9416. </remarks>
  9417. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  9418. <para>Fires when this property changes.</para>
  9419. <para>The following state flag will be set:</para>
  9420. <list type="bullet">
  9421. <item>SfStdDevMult</item>
  9422. </list>
  9423. </event>
  9424. </member>
  9425. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.ComputePixelCountsDiagImage">
  9426. <summary>
  9427. Specifies whether or not to include a pixel counts diagnostics
  9428. image in the result. The pixel counts diagnostics image indicates
  9429. which pixels in the range image were used by the height calculation.
  9430. </summary>
  9431. <value>
  9432. The default is true.
  9433. </value>
  9434. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  9435. <para>Fires when this property changes.</para>
  9436. <para>The following state flag will be set:</para>
  9437. <list type="bullet">
  9438. <item>SfComputePixelCountsDiagImage</item>
  9439. </list>
  9440. </event>
  9441. </member>
  9442. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.IncludeHistogramInResult">
  9443. <summary>
  9444. Specifies whether or not to include the histogram data
  9445. in the result.
  9446. </summary>
  9447. <value>
  9448. The default is true.
  9449. </value>
  9450. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  9451. <para>Fires when this property changes.</para>
  9452. <para>The following state flag will be set:</para>
  9453. <list type="bullet">
  9454. <item>SfIncludeHistogramInResult</item>
  9455. </list>
  9456. </event>
  9457. </member>
  9458. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.HeightRangeFilterEnabled">
  9459. <summary>
  9460. Enables or disables the height range filter.
  9461. <para>
  9462. The height range filter allows the user to exclude pixels which do not fall
  9463. within a user selected range of height values.
  9464. </para></summary>
  9465. <value>
  9466. The default is false
  9467. </value>
  9468. <remarks>
  9469. <para>
  9470. Enable the height range filter to help remove the effect of noisy or
  9471. outlying height pixel data from the height calculation.
  9472. </para>
  9473. <para>
  9474. The height range filter is configured by setting
  9475. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.HeightRangeFilterLow" /> and
  9476. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.HeightRangeFilterHigh" />.
  9477. </para>
  9478. <para>
  9479. The configured height range can inverted by setting
  9480. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.HeightRangeFilterMode" /></para>
  9481. <para>
  9482. When a height range filter is enabled, the endpoints of the height range
  9483. filter (<see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.HeightRangeFilterLow" /> and
  9484. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.HeightRangeFilterHigh" />) are always
  9485. included in the pixel values used to calculate the height.
  9486. </para>
  9487. <para>
  9488. The "height" of a range image pixel relative to a base plane is defined as
  9489. the signed distance from the center of the range image pixel to the
  9490. nearest point on the base plane, measured in selected space 3D coordinates.
  9491. </para>
  9492. </remarks>
  9493. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  9494. <para>Fires when this property changes.</para>
  9495. <para>The following state flag will be set:</para>
  9496. <list type="bullet">
  9497. <item>SfHeightRangeFilterEnabled</item>
  9498. </list>
  9499. </event>
  9500. </member>
  9501. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.HeightRangeFilterMode">
  9502. <summary>
  9503. Controls whether the height range filter includes or excludes the
  9504. values between the HeightRangeFilterLow and the HeightRangeFilterHigh.
  9505. </summary>
  9506. <value>
  9507. The default is IncludeValuesInRange
  9508. </value>
  9509. <remarks>
  9510. <para>
  9511. The "height" of a range image pixel relative to a base plane is defined as
  9512. the signed distance from the center of the range image pixel to the
  9513. nearest point on the base plane, measured in selected space 3D coordinates.
  9514. </para>
  9515. <para>
  9516. When a height range filter is enabled, the endpoints of the height range
  9517. filter (HeightRangeFilterLow, HeightRangeFilterHigh) are always included
  9518. in the pixel values used to calculate the height.
  9519. </para>
  9520. </remarks>
  9521. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  9522. <para>Fires when this property changes.</para>
  9523. <para>The following state flag will be set:</para>
  9524. <list type="bullet">
  9525. <item>SfHeightRangeFilterMode</item>
  9526. </list>
  9527. </event>
  9528. </member>
  9529. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.HeightRangeFilterHigh">
  9530. <summary>
  9531. The largest height value to be included or excluded by the height range filter.
  9532. </summary>
  9533. <value>
  9534. The default is 100.
  9535. </value>
  9536. <remarks>
  9537. <para>
  9538. The "height" of a range image pixel relative to a base plane is defined as
  9539. the signed distance from the center of the range image pixel to the
  9540. nearest point on the base plane, measured in selected space 3D coordinates.
  9541. </para>
  9542. <para>
  9543. When a height range filter is enabled, the endpoints of the height range
  9544. filter (HeightRangeFilterLow, HeightRangeFilterHigh) are always included
  9545. in the pixel values used to calculate the height.
  9546. </para>
  9547. <para>
  9548. Setting this property to a value less than HeightRangeFilterLow will cause
  9549. HeightRangeFilterLow to be adjusted accordingly.
  9550. </para>
  9551. </remarks>
  9552. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  9553. <para>Fires when this property changes.</para>
  9554. <para>The following state flag will be set:</para>
  9555. <list type="bullet">
  9556. <item>SfHeightRangeFilterHigh</item>
  9557. </list>
  9558. </event>
  9559. </member>
  9560. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.HeightRangeFilterLow">
  9561. <summary>
  9562. The smallest height value to be included or excluded by the height range filter.
  9563. </summary>
  9564. <value>
  9565. The default is 10.
  9566. </value>
  9567. <remarks>
  9568. <para>
  9569. The "height" of a range image pixel relative to a base plane is defined as
  9570. the signed distance from the center of the range image pixel to the
  9571. nearest point on the base plane, measured in selected space 3D coordinates.
  9572. </para>
  9573. <para>
  9574. When a height range filter is enabled, the endpoints of the height range
  9575. filter (HeightRangeFilterLow, HeightRangeFilterHigh) are always included
  9576. in the pixel values used to calculate the height.
  9577. </para>
  9578. <para>
  9579. Setting this property to a value greater than HeightRangeFilterHigh will cause
  9580. HeightRangeFilterHigh to be adjusted accordingly.
  9581. </para>
  9582. </remarks>
  9583. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  9584. <para>Fires when this property changes.</para>
  9585. <para>The following state flag will be set:</para>
  9586. <list type="bullet">
  9587. <item>SfHeightRangeFilterLow</item>
  9588. </list>
  9589. </event>
  9590. </member>
  9591. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.RegionMode">
  9592. <summary>
  9593. Gets or sets the region mode. This controls how the optional run time
  9594. region is applied to the input image.
  9595. </summary>
  9596. <value>
  9597. The region mode. May be either PixelAlignedBoundingBox or
  9598. PixelAlignedBoundingBoxAdjustMask. Default is PixelAlignedBoundingBoxAdjustMask.
  9599. CogRegionModeConstants::AffineTransform is not a supported region mode.
  9600. </value>
  9601. <exception cref="T:System.ArgumentException">
  9602. If the supplied argument is not either PixelAlignedBoundingBox or
  9603. PixelAlignedBoundignBoxAdjustMask.
  9604. </exception>
  9605. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  9606. <para>Fires when this property changes.</para>
  9607. <para>The following state flag will be set:</para>
  9608. <list type="bullet">
  9609. <item>SfRegionMode</item>
  9610. </list>
  9611. </event>
  9612. </member>
  9613. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.SfHeightRangeFilterEnabled">
  9614. <summary>
  9615. This bit will be set in the EventArgs of a Chagned event every time the
  9616. value returned by HeightRangeFilterEnabled may have changed.
  9617. </summary>
  9618. </member>
  9619. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.SfIncludeHistogramInResult">
  9620. <summary>
  9621. This bit will be set in the EventArgs of a Chagned event every time the
  9622. value returned by IncludeHistogramInResult may have changed.
  9623. </summary>
  9624. </member>
  9625. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.SfStdDevMult">
  9626. <summary>
  9627. This bit will be set in the EventArgs of a Chagned event every time the
  9628. value returned by StdDevMult may have changed.
  9629. </summary>
  9630. </member>
  9631. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.SfHighTailFrac">
  9632. <summary>
  9633. This bit will be set in the EventArgs of a Chagned event every time the
  9634. value returned by HighTailFrac may have changed.
  9635. </summary>
  9636. </member>
  9637. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.SfLowTailFrac">
  9638. <summary>
  9639. This bit will be set in the EventArgs of a Chagned event every time the
  9640. value returned by LowTailFrac may have changed.
  9641. </summary>
  9642. </member>
  9643. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.SfInputImageMaskOffsetY">
  9644. <summary>
  9645. This bit will be set in the EventArgs of a Changed event every time the
  9646. value returned by InputImageMaskOffsetX may have changed.
  9647. </summary>
  9648. </member>
  9649. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.SfInputImageMaskOffsetX">
  9650. <summary>
  9651. This bit will be set in the EventArgs of a Changed event every time the
  9652. value returned by InputImageMaskOffsetX may have changed.
  9653. </summary>
  9654. </member>
  9655. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.SfInputImageMask">
  9656. <summary>
  9657. This bit will be set in the EventArgs of a Changed event every time the
  9658. value returned by InputImageMask may have changed.
  9659. </summary>
  9660. </member>
  9661. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.SfComputePixelCountsDiagImage">
  9662. <summary>
  9663. This bit will be set in the EventArgs of a Changed event every time the
  9664. value returned by ComputePixelCountsDiagImage may have changed.
  9665. </summary>
  9666. </member>
  9667. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.SfPlaneSide">
  9668. <summary>
  9669. This bit will be set in the EventArgs of a Changed event every time the
  9670. value returned by PlaneSide may have changed.
  9671. </summary>
  9672. </member>
  9673. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.SfHeightRangeFilterMode">
  9674. <summary>
  9675. This bit will be set in the EventArgs of a Changed event every time the
  9676. value returned by HeightRangeFilterMode may have changed.
  9677. </summary>
  9678. </member>
  9679. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.SfHeightRangeFilterHigh">
  9680. <summary>
  9681. This bit will be set in the EventArgs of a Changed event every time the
  9682. value returned by HeightThresholdHigh may have changed.
  9683. </summary>
  9684. </member>
  9685. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.SfHeightRangeFilterLow">
  9686. <summary>
  9687. This bit will be set in the EventArgs of a Changed event every time the
  9688. value returned by HeightRangeFilterLow may have changed.
  9689. </summary>
  9690. </member>
  9691. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.SfRegionMode">
  9692. <summary>
  9693. This bit will be set in the EventArgs of a Changed event every time the
  9694. value returned by RegionMode may have changed.
  9695. </summary>
  9696. </member>
  9697. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  9698. <summary>
  9699. Serialization Constructor
  9700. </summary>
  9701. </member>
  9702. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.#ctor(Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator)">
  9703. <summary>
  9704. Constructs a new instance of this class as a deep copy of the
  9705. given instance.
  9706. </summary>
  9707. <param name="other">
  9708. The Cog3DRangeImageHeightCalculator object to be copied. May not be null.
  9709. </param>
  9710. <exception cref="T:System.ArgumentException">
  9711. If the input argument is null.
  9712. </exception>
  9713. </member>
  9714. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.#ctor">
  9715. <summary>
  9716. Constructs a new instance of this class
  9717. </summary>
  9718. </member>
  9719. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator">
  9720. <summary>
  9721. The height calculator tool operator.
  9722. <para>
  9723. Holds the run parameters used by the height tool.
  9724. </para></summary>
  9725. <remarks>
  9726. Called by the height tool to
  9727. <see cref="M:Cognex::VisionPro::Cog3DRangeImageHeightCalculator::Execute()" /> the actual height calculation.
  9728. </remarks>
  9729. </member>
  9730. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.GetHistogramBinFromHeight(System.Double)">
  9731. <summary>
  9732. Get the histogram bin index for a given height value.
  9733. See also: <see cref="M:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.GetHeightFromHistogramBin(System.Int32)" /></summary>
  9734. <param name="height">
  9735. The height from which to find a cooresponding histogram bin index.
  9736. </param>
  9737. <exception cref="T:System.InvalidOperationException">
  9738. <list type="bullet">
  9739. <item>If the result does not contain any histogram data.</item>
  9740. <item>If <param name="height" /> falls outside range of histogram data.</item>
  9741. <item>If the transform from histogram bins to height values is invalid.</item>
  9742. </list>
  9743. </exception>
  9744. </member>
  9745. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.GetHeightFromHistogramBin(System.Int32)">
  9746. <summary>
  9747. Get the height value for a given histogram bin index.
  9748. See also: <see cref="M:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.GetHistogramBinFromHeight(System.Double)" /></summary>
  9749. <param name="bin">
  9750. The bin from which to find a cooresponding height value.
  9751. </param>
  9752. <exception cref="T:System.InvalidOperationException">
  9753. <list type="bullet">
  9754. <item>If the result does not contain any histogram data.</item>
  9755. <item>If <param name="bin" /> is less than 0 or greater the total number of bins.</item>
  9756. </list>
  9757. </exception>
  9758. </member>
  9759. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.PixelCountsDiagImageOffsetY">
  9760. <summary>
  9761. The 2D distance in the Y direction from the upper left corner
  9762. of the original input image to the upper left corner of the
  9763. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.PixelCountsDiagImage" />
  9764. (in pixels).
  9765. </summary>
  9766. </member>
  9767. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.PixelCountsDiagImageOffsetX">
  9768. <summary>
  9769. The 2D distance in the X direction from the upper left corner
  9770. of the original input image to the upper left corner of the
  9771. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.PixelCountsDiagImage" />
  9772. (in pixels).
  9773. </summary>
  9774. </member>
  9775. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.PixelCountsDiagImage">
  9776. <summary>
  9777. Identifies which pixels in the range image were "used" to calculate the height.
  9778. <para>
  9779. Each pixel in the pixel counts diag image is a bit-wise or of
  9780. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImagePixelCountsTypeConstants" />.
  9781. </para></summary>
  9782. <remarks>
  9783. <para>
  9784. In the context of the height calculator, "used" pixels are the image
  9785. pixels that contribute to the height calculation.
  9786. </para>
  9787. <para>
  9788. A range image pixel is "used" to calculate the height if:
  9789. <list type="bullet"><item>
  9790. it is inside the 2D input
  9791. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.Region" />
  9792. of the tool.
  9793. </item><item>
  9794. it is marked "care" in the optional
  9795. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.InputImageMask" />
  9796. provided as part of the
  9797. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.RunParams" />.
  9798. </item><item>
  9799. it is marked as "visible pixel" in the visible pixel mask of the
  9800. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.InputImage" />.
  9801. The visible pixel mask can be accessed by calling
  9802. <see cref="M:Cognex.VisionPro.CogImage16Range.GetMaskData" /> on the range image.
  9803. </item><item>
  9804. its height falls within the valid height range configured in the height tool's
  9805. run parameters. See <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.HeightRangeFilterEnabled" />.
  9806. </item></list></para>
  9807. <para>
  9808. Pixels that meet these conditions contribute to the height computation
  9809. and are marked as "used" in the
  9810. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.PixelCountsDiagImage" />.
  9811. </para>
  9812. <para>
  9813. Only "used" pixels are included in the height tool's
  9814. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.Histogram" /> data.
  9815. </para>
  9816. <para>
  9817. Note that the height of an individual range image pixel is defined as
  9818. the signed distance from the center of the range image pixel to
  9819. the nearest point on the base plane (measured in selected space 3D units).
  9820. </para>
  9821. <para>
  9822. By default the positive height direction is defined to be in the same direction as the
  9823. normal vector of the base plane. However, the positive height direction can be
  9824. reversed by setting the <see cref="P:Cognex::VisionPro3D::Cog3DRangeImageHeightCalculator::PlaneSide" /> property.
  9825. </para>
  9826. </remarks>
  9827. </member>
  9828. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.PixelCounts">
  9829. <summary>
  9830. Result information which identifies the number of pixels in the range image
  9831. that fall into each of 4 different categories.
  9832. <para>
  9833. See <see cref="T:Cognex.VisionPro3D.Cog3DRangeImagePixelCountsTypeConstants" />
  9834. for the definition of the different categories.
  9835. </para></summary>
  9836. <remarks>
  9837. <para>
  9838. In the context of the height calculator, "used" pixels are the image
  9839. pixels that contribute to the height calculation.
  9840. </para>
  9841. <para>
  9842. A range image pixel is "used" to calculate the height if:
  9843. <list type="bullet"><item>
  9844. it is inside the 2D input
  9845. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.Region" />
  9846. of the tool.
  9847. </item><item>
  9848. it is marked "care" in the optional
  9849. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.InputImageMask" />
  9850. provided as part of the
  9851. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.RunParams" />.
  9852. </item><item>
  9853. it is marked as "visible pixel" in the visible pixel mask of the
  9854. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.InputImage" />.
  9855. The visible pixel mask can be accessed by calling
  9856. <see cref="M:Cognex.VisionPro.CogImage16Range.GetMaskData" /> on the range image.
  9857. </item><item>
  9858. its height falls within the valid height range configured in the height tool's
  9859. run parameters. See <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.HeightRangeFilterEnabled" />.
  9860. </item></list></para>
  9861. <para>
  9862. Pixels that meet these conditions contribute to the height computation
  9863. and are marked as "used" in the
  9864. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.PixelCountsDiagImage" />.
  9865. </para>
  9866. <para>
  9867. Only "used" pixels are included in the height tool's
  9868. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.Histogram" /> data.
  9869. </para>
  9870. <para>
  9871. Note that the height of an individual range image pixel is defined as
  9872. the signed distance from the center of the range image pixel to
  9873. the nearest point on the base plane (measured in selected space 3D units).
  9874. </para>
  9875. <para>
  9876. By default the positive height direction is defined to be in the same direction as the
  9877. normal vector of the base plane. However, the positive height direction can be
  9878. reversed by setting the <see cref="P:Cognex::VisionPro3D::Cog3DRangeImageHeightCalculator::PlaneSide" /> property.
  9879. </para>
  9880. </remarks>
  9881. </member>
  9882. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.HistogramHeightFromBinOffset">
  9883. <summary>
  9884. The offset value need to map a histogram bin number to an actual height value.
  9885. <c>
  9886. binHeight = binIndex * HistogramHeightFromBinScale + HistogramHeightFromBinOffset
  9887. </c></summary>
  9888. <value>
  9889. This property returns 0.0 if <see cref="!:Cognex::VisionPro3D::Cog3DRangeImageHeightCalculator::IncludeHistogramInResult" />
  9890. was false or if the height calculation included 0 used pixels.
  9891. See: <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.PixelCounts" />.
  9892. </value>
  9893. </member>
  9894. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.HistogramHeightFromBinScale">
  9895. <summary>
  9896. The scale value needed to map a histogram bin number to an actual height value.
  9897. <c>
  9898. binHeight = binIndex * HistogramHeightFromBinScale + HistogramHeightFromBinOffset
  9899. </c></summary>
  9900. <value>
  9901. This property returns 0.0 if <see cref="!:Cognex::VisionPro3D::Cog3DRangeImageHeightCalculator::IncludeHistogramInResult" />
  9902. was false or if the height calculation included 0 used pixels.
  9903. See: <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.PixelCounts" />.
  9904. </value>
  9905. </member>
  9906. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.Histogram">
  9907. <summary>
  9908. Returns a histogram of the height values of the individual
  9909. range image pixels.
  9910. See also:
  9911. <see cref="M:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.GetHeightFromHistogramBin(System.Int32)" />
  9912. and
  9913. <see cref="M:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.GetHistogramBinFromHeight(System.Double)" /></summary>
  9914. <remarks>
  9915. Note that only pixels that were "used" as part of the
  9916. actual height calculation are included in the histogram data.
  9917. For example, the histogram bins for any height values
  9918. that were filtered out by the height range filter will contain
  9919. 0 pixels.
  9920. <para>
  9921. In the context of the height calculator, "used" pixels are the image
  9922. pixels that contribute to the height calculation.
  9923. </para><para>
  9924. A range image pixel is "used" to calculate the height if:
  9925. <list type="bullet"><item>
  9926. it is inside the 2D input
  9927. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.Region" />
  9928. of the tool.
  9929. </item><item>
  9930. it is marked "care" in the optional
  9931. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.InputImageMask" />
  9932. provided as part of the
  9933. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.RunParams" />.
  9934. </item><item>
  9935. it is marked as "visible pixel" in the visible pixel mask of the
  9936. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorTool.InputImage" />.
  9937. The visible pixel mask can be accessed by calling
  9938. <see cref="M:Cognex.VisionPro.CogImage16Range.GetMaskData" /> on the range image.
  9939. </item><item>
  9940. its height falls within the valid height range configured in the height tool's
  9941. run parameters. See <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.HeightRangeFilterEnabled" />.
  9942. </item></list></para><para>
  9943. Pixels that meet these conditions contribute to the height computation
  9944. and are marked as "used" in the
  9945. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.PixelCountsDiagImage" />.
  9946. </para><para>
  9947. Only "used" pixels are included in the height tool's
  9948. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.Histogram" /> data.
  9949. </para><para>
  9950. Note that the height of an individual range image pixel is defined as
  9951. the signed distance from the center of the range image pixel to
  9952. the nearest point on the base plane (measured in selected space 3D units).
  9953. </para><para>
  9954. By default the positive height direction is defined to be in the same direction as the
  9955. normal vector of the base plane. However, the positive height direction can be
  9956. reversed by setting the <see cref="P:Cognex::VisionPro3D::Cog3DRangeImageHeightCalculator::PlaneSide" /> property.
  9957. </para></remarks>
  9958. <value>
  9959. Note that this property will return null if <see cref="!:Cognex::VisionPro3D::Cog3DRangeImageHeightCalculator::IncludeHistogramInResult" />
  9960. was false or if the height calculation included 0 used pixels.
  9961. See: <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.PixelCounts" />.
  9962. </value>
  9963. </member>
  9964. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.StdDevMult">
  9965. <summary>
  9966. Returns the value of
  9967. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.StdDevMult" />
  9968. which was used to compute
  9969. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.MeanPlusStdDevMult" />.
  9970. </summary>
  9971. <value>
  9972. This property returns 0.0 if the
  9973. height calculation "used" 0 pixels.
  9974. See: <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.PixelCounts" />.
  9975. </value>
  9976. <remarks>
  9977. The mean plus std dev mult height is calcualted as:
  9978. <para><see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.MeanPlusStdDevMult" /> =
  9979. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.Mean" /> +
  9980. std dev of all used pixel heights * <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.StdDevMult" /></para></remarks>
  9981. </member>
  9982. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.MeanPlusStdDevMult">
  9983. <summary>
  9984. Returns the calculated mean plus standard deviation multiplier height.
  9985. </summary>
  9986. <value>
  9987. This property returns 0.0 if the
  9988. height calculation "used" 0 pixels.
  9989. See: <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.PixelCounts" />.
  9990. </value>
  9991. <remarks>
  9992. The mean plus std dev mult height is calcualted as:
  9993. <para><see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.MeanPlusStdDevMult" /> =
  9994. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.Mean" /> +
  9995. std dev of all used pixel heights * <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.StdDevMult" /></para><para>
  9996. In some applications this value may be used to provide a more
  9997. robust estimation of the real minimum or maximum height.
  9998. This value is less sensitive to outlying or noisy height data.
  9999. </para></remarks>
  10000. </member>
  10001. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.HighTail">
  10002. <summary>
  10003. Returns the calculated high tail height.
  10004. </summary>
  10005. <value>
  10006. This property returns 0.0 if the
  10007. height calculation "used" 0 pixels.
  10008. See: <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.PixelCounts" />.
  10009. </value>
  10010. <remarks>
  10011. The high tail height is the height at which:
  10012. <para>
  10013. (number of used pixels greater than this height /
  10014. total number of pixels used in the height calculation) =
  10015. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.HighTailFrac" /></para><para>
  10016. In some applications this value may be used to provide a more
  10017. robust estimation of the real maximum height.
  10018. This value is less sensitive to outlying or noisy height data.
  10019. </para></remarks>
  10020. </member>
  10021. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.LowTail">
  10022. <summary>
  10023. Returns the calculated low tail height.
  10024. </summary>
  10025. <value>
  10026. This property returns 0.0 if the
  10027. height calculation "used" 0 pixels.
  10028. See: <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.PixelCounts" />.
  10029. </value>
  10030. <remarks>
  10031. The low tail height is the height at which:
  10032. <para>
  10033. (number of used pixels less than this height /
  10034. total number of pixels used in the height calculation) =
  10035. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculator.LowTailFrac" /></para><para>
  10036. In some applications this value may be used to provide a more
  10037. robust estimation of the real minimum height.
  10038. This value is less sensitive to outlying or noisy height data.
  10039. </para></remarks>
  10040. </member>
  10041. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.Maximum">
  10042. <summary>
  10043. Returns the maximum height value of pixels used in
  10044. the height calculation.
  10045. </summary>
  10046. <value>
  10047. This property returns 0.0 if the
  10048. height calculation "used" 0 pixels.
  10049. See: <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.PixelCounts" />.
  10050. </value>
  10051. <remarks>
  10052. <para>
  10053. Because the maximum height returns the maximum height
  10054. of all used pixels, a single outlying or noisy pixel
  10055. may distort this value from the _real_ maximum height
  10056. of an object.
  10057. Consider using <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.HighTail" />
  10058. for a more robust estimate of the maximum height.
  10059. </para>
  10060. </remarks>
  10061. </member>
  10062. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.Minimum">
  10063. <summary>
  10064. Returns the minimum height value of pixels used in
  10065. the height calculation.
  10066. </summary>
  10067. <value>
  10068. This property returns 0.0 if the
  10069. height calculation "used" 0 pixels.
  10070. See: <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.PixelCounts" />.
  10071. </value>
  10072. <remarks>
  10073. <para>
  10074. Because the minimum height returns the minimum height
  10075. of all used pixels, a single outlying or noisy pixel
  10076. may distort this value from the _real_ minimum height
  10077. of an object.
  10078. Consider using <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.LowTail" />
  10079. for a more robust estimate of the minimum height.
  10080. </para>
  10081. </remarks>
  10082. </member>
  10083. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.Median">
  10084. <summary>
  10085. Returns the median height of all pixles used in
  10086. the height calculation.
  10087. </summary>
  10088. <value>
  10089. This property returns 0.0 if the
  10090. height calculation "used" 0 pixels.
  10091. See: <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.PixelCounts" />.
  10092. </value>
  10093. </member>
  10094. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.Mean">
  10095. <summary>
  10096. Returns the mean height of all pixels used in
  10097. the height calculation.
  10098. </summary>
  10099. <value>
  10100. This property returns 0.0 if the
  10101. height calculation "used" 0 pixels.
  10102. See: <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.PixelCounts" />.
  10103. </value>
  10104. </member>
  10105. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  10106. <summary>
  10107. Serialization Constructor
  10108. </summary>
  10109. </member>
  10110. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.SetFromCVT(c3d_heightResult!System.Runtime.CompilerServices.IsConst*!System.Runtime.CompilerServices.IsImplicitlyDereferenced,Cognex.VisionPro.CogImage16Range)">
  10111. <summary>
  10112. Populate the members of the Cog3DRangeImageHeightCalculatorResult from
  10113. its CVT equivilent.
  10114. </summary>
  10115. </member>
  10116. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.#ctor(c3d_heightResult!System.Runtime.CompilerServices.IsConst*!System.Runtime.CompilerServices.IsImplicitlyDereferenced,System.Int32,System.Int32,System.Double,Cognex.VisionPro.CogImage16Range)">
  10117. <summary>
  10118. Construct a Cog3DRangeImageHeightCalculatorResult based on its CVT equivilent.
  10119. </summary>
  10120. </member>
  10121. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.#ctor(Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult)">
  10122. <summary>
  10123. Constructs a new instance of this class as a deep copy of the
  10124. given instance.
  10125. </summary>
  10126. <param name="other">
  10127. The Cog3DRangeImageHeightCalculatorResult object to be copied.
  10128. May not be null.
  10129. </param>
  10130. <exception cref="T:System.ArgumentException">
  10131. If the input argument is null.
  10132. </exception>
  10133. </member>
  10134. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult.#ctor">
  10135. <summary>
  10136. Constructs a new instance of this class.
  10137. </summary>
  10138. </member>
  10139. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageHeightCalculatorResult">
  10140. <summary>
  10141. The result of running the Cog3DRangeImageHeightCalculator.
  10142. </summary>
  10143. </member>
  10144. <member name="T:Cognex.VisionPro3D.Cog3DHeightRangeFilterModeConstants">
  10145. <summary>
  10146. Enumeration of different modes for including
  10147. or excluding a range of pixel height values
  10148. from the overall height calculation.
  10149. </summary>
  10150. </member>
  10151. <member name="F:Cognex.VisionPro3D.Cog3DHeightRangeFilterModeConstants.ExcludeValuesInRange">
  10152. <summary>
  10153. Include only the values which fall outside the height
  10154. range in the height calculation.
  10155. </summary>
  10156. </member>
  10157. <member name="F:Cognex.VisionPro3D.Cog3DHeightRangeFilterModeConstants.IncludeValuesInRange">
  10158. <summary>
  10159. Include only the values which fall within the height
  10160. range in the height calculation.
  10161. </summary>
  10162. </member>
  10163. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorTool.LastRunRecordDiagEnable">
  10164. <summary>
  10165. Enable creation of records by bitwise ORing the appropriate
  10166. Cog3DRangeImageVolumeCalculatorLastRunRecordDiagConstants.
  10167. </summary>
  10168. <value>
  10169. The default is (int)Cog3DRangeImageVolumeCalculatorLastRunRecordDiagConstants::InputImageByReference | (int)Cog3DRangeImageVolumeCalculatorLastRunRecordDiagConstants::Region | (int)Cog3DRangeImageVolumeCalculatorLastRunRecordDiagConstants::UsedPixels
  10170. </value>
  10171. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  10172. <para>Fires when this property changes.</para>
  10173. <para>The following state flag will be set:</para>
  10174. <list type="bullet">
  10175. <item>SfLastRunRecordDiagEnable</item>
  10176. </list>
  10177. </event>
  10178. </member>
  10179. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorTool.LastRunRecordEnable">
  10180. <summary>
  10181. Enable creation of records by bitwise ORing the appropriate
  10182. Cog3DRangeImageVolumeCalculatorLastRunRecordConstants.
  10183. </summary>
  10184. <value>
  10185. The default is Cog3DRangeImageVolumeCalculatorLastRunRecordConstants::None
  10186. </value>
  10187. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  10188. <para>Fires when this property changes.</para>
  10189. <para>The following state flag will be set:</para>
  10190. <list type="bullet">
  10191. <item>SfLastRunRecordEnable</item>
  10192. <item>SfCreateLastRunRecord</item>
  10193. </list>
  10194. </event>
  10195. </member>
  10196. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorTool.CurrentRecordEnable">
  10197. <summary>
  10198. Enable creation of records by bitwise ORing the appropriate
  10199. Cog3DRangeImageVolumeCalculatorCurrentRecordConstants.
  10200. </summary>
  10201. <value>
  10202. The default is (int)Cog3DRangeImageVolumeCalculatorCurrentRecordConstants::InputImage | (int)Cog3DRangeImageVolumeCalculatorCurrentRecordConstants::Region
  10203. </value>
  10204. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  10205. <para>Fires when this property changes.</para>
  10206. <para>The following state flag will be set:</para>
  10207. <list type="bullet">
  10208. <item>SfCurrentRecordEnable</item>
  10209. <item>SfCreateCurrentRecord</item>
  10210. </list>
  10211. </event>
  10212. </member>
  10213. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorTool.Result">
  10214. <summary>
  10215. The result of running the volume calculator tool
  10216. </summary>
  10217. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  10218. <para>Fires when this property changes.</para>
  10219. <para>The following state flag will be set:</para>
  10220. <list type="bullet">
  10221. <item>SfResult</item>
  10222. </list>
  10223. </event>
  10224. </member>
  10225. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorTool.RunParams">
  10226. <summary>
  10227. The volume calculator tool's run parameters operator
  10228. </summary>
  10229. <value>
  10230. The value can not be null.
  10231. The default is a default Cog3DRangeImageVolumeCalculator.
  10232. </value>
  10233. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  10234. <para>Fires when this property changes.</para>
  10235. <para>The following state flag will be set:</para>
  10236. <list type="bullet">
  10237. <item>SfRunParams</item>
  10238. </list>
  10239. </event>
  10240. </member>
  10241. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorTool.BasePlane">
  10242. <summary>
  10243. The calculated volume is the volume bounded by the range image surface
  10244. and this plane (on the <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculator.PlaneSide" />).
  10245. </summary>
  10246. <value>
  10247. The default is a horizontal plane at z = 0.
  10248. </value>
  10249. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  10250. <para>Fires when this property changes.</para>
  10251. <para>The following state flag will be set:</para>
  10252. <list type="bullet">
  10253. <item>SfBasePlane</item>
  10254. </list>
  10255. </event>
  10256. <remarks>
  10257. If BasePlane is set to null a horizontal plane at z = 0 will be used.
  10258. </remarks>
  10259. </member>
  10260. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorTool.Region">
  10261. <summary>
  10262. The 2D region within which to calculate the volume.
  10263. </summary>
  10264. <remarks>
  10265. A pixel is considered inside the 2D region if the pixel's
  10266. 2D center falls within the region.
  10267. </remarks>
  10268. <value>
  10269. The region can be null to use the entire range image.
  10270. The default is a default CogRectangleAffine
  10271. </value>
  10272. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  10273. <para>Fires when this property changes.</para>
  10274. <para>The following state flag will be set:</para>
  10275. <list type="bullet">
  10276. <item>SfRegion</item>
  10277. </list>
  10278. </event>
  10279. </member>
  10280. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorTool.InputImage">
  10281. <summary>
  10282. The range image surface data used in the volume calculation.
  10283. </summary>
  10284. <value>
  10285. The default is null.
  10286. </value>
  10287. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  10288. <para>Fires when this property changes.</para>
  10289. <para>The following state flag will be set:</para>
  10290. <list type="bullet">
  10291. <item>SfInputImage</item>
  10292. </list>
  10293. </event>
  10294. </member>
  10295. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorTool.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  10296. <summary>
  10297. Serialization Constructor
  10298. </summary>
  10299. </member>
  10300. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorTool.Clone">
  10301. <summary>
  10302. Returns a deep copy of this class instance.
  10303. </summary>
  10304. <remarks>
  10305. This method's implementation calls
  10306. <see cref="M:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorTool.#ctor(Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorTool)" />.
  10307. </remarks>
  10308. </member>
  10309. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorTool.#ctor(Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorTool)">
  10310. <summary>
  10311. Constructs a deep copy of the supplied Cog3DRangeImageVolumeCalculatorTool.
  10312. </summary>
  10313. <param name="other">
  10314. The Cog3DRangeImageVolumeCalculatorTool to be copied. May not be null.
  10315. </param>
  10316. <exception cref="T:System.ArgumentNullException">
  10317. Thrown if <paramref name="other" /> is null.
  10318. </exception>
  10319. <exception cref="T:System.InvalidOperationException">
  10320. Thrown if <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorTool.Region" /> does not support
  10321. <see cref="T:System.ICloneable" />.
  10322. </exception>
  10323. <remarks>
  10324. The properties of <paramref name="other" /> are copied as follows:
  10325. <list type="bullet"><item><see cref="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorTool.InputImage" />
  10326. is copied by calling <see cref="M:Cognex.VisionPro.ICogImage.CopyBase(Cognex.VisionPro.CogImageCopyModeConstants)" /> with the
  10327. <see cref="T:Cognex.VisionPro.CogImageCopyModeConstants">CogImageCopyModeConstants</see> flag set.
  10328. </item><item><see cref="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorTool.Region" />
  10329. is copied by calling <see cref="M:System.ICloneable.Clone" /> (an exception
  10330. is thrown if the region cannot does not support <see cref="T:System.ICloneable" />).
  10331. </item><item><see cref="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorTool.BasePlane" />
  10332. is copied by calling <see cref="M:Cognex.VisionPro3D.Cog3DPlane.#ctor(Cognex.VisionPro3D.Cog3DPlane)" />.
  10333. </item><item><see cref="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorTool.RunParams" />
  10334. is copied by calling <see cref="M:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculator.#ctor(Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculator)" />.
  10335. </item><item><see cref="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorTool.Result" />
  10336. is copied by calling <see cref="M:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorResult.#ctor(Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorResult)" />.
  10337. </item><item>
  10338. The
  10339. <see cref="P:Cognex.VisionPro.ICogTool.DataBindings" />
  10340. are copied by calling
  10341. <see cref="M:Cognex.VisionPro.CogDataBindingsCollection.#ctor(System.Object,Cognex.VisionPro.CogDataBindingsCollection)" />.
  10342. The data bindings of the original tool are duplicated in the new tool.
  10343. The databindings are copied with their destinations pointing _into_ the
  10344. new tool, while their sources are copied directly and still point _from_
  10345. the same upstream objects (tools) as the original tool's databindings.
  10346. </item><item>
  10347. The
  10348. <see cref="P:Cognex.VisionPro.ICogTool.UserData" />
  10349. is copied by calling
  10350. <see cref="M:Cognex.VisionPro.CogDictionary.#ctor(Cognex.VisionPro.CogDictionary)" />.
  10351. </item><item>
  10352. The <see cref="P:Cognex.VisionPro.ICogTool.RunStatus" />
  10353. is copied by calling
  10354. <see cref="M:Cognex.VisionPro.Implementation.CogRunStatus.#ctor(Cognex.VisionPro.ICogRunStatus)" />.
  10355. </item></list></remarks>
  10356. </member>
  10357. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorTool.#ctor">
  10358. <summary>
  10359. Construct a new instance of this class.
  10360. </summary>
  10361. </member>
  10362. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorTool.CacheLastRunData">
  10363. <summary>
  10364. Cache the last run record data so it
  10365. can be accesed by CreateLastRunRecord.
  10366. </summary>
  10367. </member>
  10368. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorTool.ClearLastRunCache">
  10369. <summary>
  10370. Clear any cached last run record data.
  10371. </summary>
  10372. </member>
  10373. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorTool.SfLastRunRecordDiagEnable">
  10374. <summary>
  10375. This bit will be set in the EventArgs of a Changed event every time the
  10376. value returned by LastRunRecordDiagEnable may have changed.
  10377. </summary>
  10378. </member>
  10379. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorTool.SfLastRunRecordEnable">
  10380. <summary>
  10381. This bit will be set in the EventArgs of a Changed event every time the
  10382. value returned by LastRunRecordEnable may have changed.
  10383. </summary>
  10384. </member>
  10385. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorTool.SfCurrentRecordEnable">
  10386. <summary>
  10387. This bit will be set in the EventArgs of a Changed event every time the
  10388. value returned by CurrentRecordEnable may have changed.
  10389. </summary>
  10390. </member>
  10391. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorTool.SfResult">
  10392. <summary>
  10393. This bit will be set in the EventArgs of a Changed event every time the
  10394. value returned by RunParams may have changed.
  10395. </summary>
  10396. </member>
  10397. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorTool.SfRunParams">
  10398. <summary>
  10399. This bit will be set in the EventArgs of a Changed event every time the
  10400. value returned by RunParams may have changed.
  10401. </summary>
  10402. </member>
  10403. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorTool.SfBasePlane">
  10404. <summary>
  10405. This bit will be set in the EventArgs of a Changed event every time the
  10406. value returned by Region may have changed.
  10407. </summary>
  10408. </member>
  10409. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorTool.SfRegion">
  10410. <summary>
  10411. This bit will be set in the EventArgs of a Changed event every time the
  10412. value returned by Region may have changed.
  10413. </summary>
  10414. </member>
  10415. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorTool.SfInputImage">
  10416. <summary>
  10417. This bit will be set in the EventArgs of a Changed event every time the
  10418. value returned by InputImage may have changed.
  10419. </summary>
  10420. </member>
  10421. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorTool">
  10422. <summary>
  10423. <para>
  10424. A range image has pixel values that represent the
  10425. distance from a reference plane to an object.
  10426. </para>
  10427. <para>
  10428. The volume calculator tool measures the volume enclosed between
  10429. the surface of range image pixel data and one side of a user supplied
  10430. base plane.
  10431. </para>
  10432. <para>
  10433. The computed volume is returned in the
  10434. <see cref="P:Cognex.VisionPro.CogImage16Range.SelectedSpaceName3D" />
  10435. units specified in the range image.
  10436. </para>
  10437. </summary>
  10438. <remarks>
  10439. <para>
  10440. A range image pixel is "used" to calculate the volume if:
  10441. <list type="bullet"><item>
  10442. it is inside the 2D input
  10443. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorTool.Region" />
  10444. of the tool.
  10445. </item><item>
  10446. it is marked as "care" in the optional
  10447. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculator.InputImageMask" />
  10448. provided as part of the
  10449. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorTool.RunParams" />.
  10450. </item><item>
  10451. it is marked as a "visible pixel" in the visible pixel mask of the
  10452. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorTool.InputImage" />.
  10453. The visible pixel mask can be accessed by calling
  10454. <see cref="M:Cognex.VisionPro.CogImage16Range.GetMaskData" /> on the range image.
  10455. </item><item>
  10456. its height (relative to the base plane) is greater than
  10457. or equal to the
  10458. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculator.MinimumHeightThreshold" />.
  10459. </item></list></para>
  10460. <para>
  10461. Pixels that meet these conditions contribute to the volume computation
  10462. and are marked as "used" in the
  10463. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorResult.PixelCountsDiagImage" />.
  10464. </para>
  10465. <para>
  10466. Note that the height of an individual range image pixel is defined as
  10467. the signed distance from the center of the range image pixel to
  10468. the nearest point on the base plane (measured in selected space 3D units).
  10469. </para>
  10470. <para>
  10471. Note, however, that the volume is calculated by summing the contribution of
  10472. the range image pixels within the
  10473. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorTool.Region" />
  10474. projected along the pixel coordinate z axis until they intersect the base plane.
  10475. </para>
  10476. </remarks>
  10477. </member>
  10478. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorLastRunRecordDiagConstants">
  10479. <summary>
  10480. Enumeration of diagnostic data that can be provided in the Tool's
  10481. LastRunRecord.
  10482. </summary>
  10483. </member>
  10484. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorLastRunRecordDiagConstants.All">
  10485. <summary>
  10486. Include all possible records.
  10487. </summary>
  10488. </member>
  10489. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorLastRunRecordDiagConstants.UsedPixels">
  10490. <summary>
  10491. Include a mask graphic representing which range image
  10492. pixels were used in the volume calculation
  10493. </summary>
  10494. </member>
  10495. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorLastRunRecordDiagConstants.InputImageMask">
  10496. <summary>
  10497. Include a graphic representing the input image mask in
  10498. the LastRunRecord.
  10499. </summary>
  10500. </member>
  10501. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorLastRunRecordDiagConstants.Region">
  10502. <summary>
  10503. Include a copy of the region in the LastRunRecord.
  10504. </summary>
  10505. </member>
  10506. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorLastRunRecordDiagConstants.InputImageDeepCopy">
  10507. <summary>
  10508. Include a deep copy of the input image in the LastRunRecord.
  10509. </summary>
  10510. </member>
  10511. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorLastRunRecordDiagConstants.InputImageByReference">
  10512. <summary>
  10513. Include a reference to the input image in the LastRunRecord.
  10514. </summary>
  10515. </member>
  10516. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorLastRunRecordDiagConstants.None">
  10517. <summary>
  10518. Do not include any of the non-diagnostic data in the LastRunRecord.
  10519. </summary>
  10520. </member>
  10521. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorLastRunRecordConstants">
  10522. <summary>
  10523. Enumeration of non-diagnostic data that can be provided in the Tool's
  10524. LastRunRecord.
  10525. </summary>
  10526. </member>
  10527. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorLastRunRecordConstants.All">
  10528. <summary>
  10529. Include all possible records.
  10530. </summary>
  10531. </member>
  10532. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorLastRunRecordConstants.None">
  10533. <summary>
  10534. Do not include any of the non-diagnostic data in the LastRunRecord.
  10535. </summary>
  10536. </member>
  10537. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorCurrentRecordConstants">
  10538. <summary>
  10539. Enumeration of data that can be provided in the Tool's CurrentRecord.
  10540. </summary>
  10541. </member>
  10542. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorCurrentRecordConstants.All">
  10543. <summary>
  10544. Include all possible records in the CurrentRecord.
  10545. </summary>
  10546. </member>
  10547. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorCurrentRecordConstants.InputImageMask">
  10548. <summary>
  10549. Include a graphic representing the input image mask in
  10550. the CurrentRecord.
  10551. </summary>
  10552. </member>
  10553. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorCurrentRecordConstants.Region">
  10554. <summary>
  10555. Include the (interactive) region to be processed at run time in the
  10556. CurrentRecord.
  10557. </summary>
  10558. </member>
  10559. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorCurrentRecordConstants.InputImage">
  10560. <summary>
  10561. Include the input image in the CurrentRecord.
  10562. </summary>
  10563. </member>
  10564. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorCurrentRecordConstants.None">
  10565. <summary>
  10566. Do not include any records in the CurrentRecord.
  10567. </summary>
  10568. </member>
  10569. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculator.Execute(Cognex.VisionPro.CogImage16Range,Cognex.VisionPro.ICogRegion,System.Double)">
  10570. <summary>
  10571. Computes the volume between the range image surface and a specified base
  10572. plane. The plane has a 3D selected space coordinate normal vector (0, 0, 1),
  10573. i.e. oriented along the positive z axis.
  10574. </summary>
  10575. <param name="rangeImage">
  10576. The range image surface data relative which the volume is calculated.
  10577. </param>
  10578. <param name="region">
  10579. The 2D region within which to calculate the volume.
  10580. The region can be null to use the entire range image.
  10581. </param>
  10582. <param name="horizontalPlaneZ">
  10583. The z value of the horizontal 3D plane, in the selected space 3D coordinates
  10584. of the range image
  10585. </param>
  10586. <exception cref="T:Cognex.VisionPro.Exceptions.CogOperatorNoInputImageException">
  10587. <list type="bullet">
  10588. <item>Thrown if <paramref name="rangeImage" /> is null.</item>
  10589. </list>
  10590. </exception>
  10591. <exception cref="T:Cognex.VisionPro.Exceptions.CogImageNoPixelsException">
  10592. <list type="bullet">
  10593. <item>Thrown if <paramref name="rangeImage" /> is is not allocated.</item>
  10594. </list>
  10595. </exception>
  10596. <exception cref="T:System.ArgumentException">
  10597. <list type="bullet">
  10598. <item>Thrown if <paramref name="rangeImage" /> has a transform that is
  10599. singular (i.e., not invertible).</item>
  10600. </list>
  10601. </exception>
  10602. <remarks>
  10603. <para>
  10604. A range image pixel is "used" to calculate the volume if:
  10605. <list type="bullet"><item>
  10606. it is inside the 2D input
  10607. <see cref="P:Cognex::VisionPro3D::Cog3DRangeImageVolumeCalculatorTool::Region" />
  10608. of the tool.
  10609. </item><item>
  10610. it is marked as "care" in the optional
  10611. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculator.InputImageMask" />
  10612. provided as part of the
  10613. <see cref="P:Cognex::VisionPro3D::Cog3DRangeImageVolumeCalculatorTool::RunParams" />.
  10614. </item><item>
  10615. it is marked as a "visible pixel" in the visible pixel mask of the
  10616. <see cref="P:Cognex::VisionPro3D::Cog3DRangeImageVolumeCalculatorTool::InputImage" />.
  10617. The visible pixel mask can be accessed by calling
  10618. <see cref="M:Cognex.VisionPro.CogImage16Range.GetMaskData" /> on the range image.
  10619. </item><item>
  10620. its height (relative to the base plane) is greater than
  10621. or equal to the
  10622. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculator.MinimumHeightThreshold" />.
  10623. </item></list></para>
  10624. <para>
  10625. Pixels that meet these conditions contribute to the volume computation
  10626. and are marked as "used" in the
  10627. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorResult.PixelCountsDiagImage" />.
  10628. </para>
  10629. <para>
  10630. Note that the height of an individual range image pixel is defined as
  10631. the signed distance from the center of the range image pixel to
  10632. the nearest point on the base plane (measured in selected space 3D units).
  10633. </para>
  10634. <para>
  10635. Note, however, that the volume is calculated by summing the contribution of
  10636. the range image pixels within the
  10637. <see cref="P:Cognex::VisionPro3D::Cog3DRangeImageVolumeCalculatorTool::Region" />
  10638. projected along the pixel coordinate z axis until they intersect the base plane.
  10639. </para>
  10640. </remarks>
  10641. </member>
  10642. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculator.Execute(Cognex.VisionPro.CogImage16Range,Cognex.VisionPro.ICogRegion,Cognex.VisionPro3D.Cog3DPlane)">
  10643. <summary>
  10644. Computes the volume between the range image surface and a specified base
  10645. plane.
  10646. </summary>
  10647. <param name="rangeImage">
  10648. The range image surface data reletive which the volume is calculated
  10649. </param>
  10650. <param name="region">
  10651. The 2D region within which to calculate the volume.
  10652. The region can be null to use the entire range image.
  10653. </param>
  10654. <param name="basePlane">
  10655. The calculated volume is the volume bounded by the range image
  10656. surface and the base plane (on the <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculator.PlaneSide" />).
  10657. The basePlane can be null to use a hoizontal plane at z = 0.
  10658. </param>
  10659. <exception cref="T:Cognex.VisionPro.Exceptions.CogOperatorNoInputImageException">
  10660. <list type="bullet">
  10661. <item>Thrown if <paramref name="rangeImage" /> is null.</item>
  10662. </list>
  10663. </exception>
  10664. <exception cref="T:System.ArgumentException">
  10665. <list type="bullet">
  10666. <item>Thrown if <paramref name="rangeImage" /> is is not allocated.</item>
  10667. <item>Thrown if <paramref name="rangeImage" /> has a transform that is
  10668. singular (i.e., not invertible).</item>
  10669. <item>Thrown if <paramref name="basePlane" /> is degenerate.</item>
  10670. <item>Thrown if <paramref name="basePlane" /> is vertical in pixel space.</item>
  10671. </list>
  10672. </exception>
  10673. <remarks>
  10674. <para>
  10675. A range image pixel is "used" to calculate the volume if:
  10676. <list type="bullet"><item>
  10677. it is inside the 2D input
  10678. <see cref="P:Cognex::VisionPro3D::Cog3DRangeImageVolumeCalculatorTool::Region" />
  10679. of the tool.
  10680. </item><item>
  10681. it is marked as "care" in the optional
  10682. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculator.InputImageMask" />
  10683. provided as part of the
  10684. <see cref="P:Cognex::VisionPro3D::Cog3DRangeImageVolumeCalculatorTool::RunParams" />.
  10685. </item><item>
  10686. it is marked as a "visible pixel" in the visible pixel mask of the
  10687. <see cref="P:Cognex::VisionPro3D::Cog3DRangeImageVolumeCalculatorTool::InputImage" />.
  10688. The visible pixel mask can be accessed by calling
  10689. <see cref="M:Cognex.VisionPro.CogImage16Range.GetMaskData" /> on the range image.
  10690. </item><item>
  10691. its height (relative to the base plane) is greater than
  10692. or equal to the
  10693. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculator.MinimumHeightThreshold" />.
  10694. </item></list></para>
  10695. <para>
  10696. Pixels that meet these conditions contribute to the volume computation
  10697. and are marked as "used" in the
  10698. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorResult.PixelCountsDiagImage" />.
  10699. </para>
  10700. <para>
  10701. Note that the height of an individual range image pixel is defined as
  10702. the signed distance from the center of the range image pixel to
  10703. the nearest point on the base plane (measured in selected space 3D units).
  10704. </para>
  10705. <para>
  10706. Note, however, that the volume is calculated by summing the contribution of
  10707. the range image pixels within the
  10708. <see cref="P:Cognex::VisionPro3D::Cog3DRangeImageVolumeCalculatorTool::Region" />
  10709. projected along the pixel coordinate z axis until they intersect the base plane.
  10710. </para>
  10711. </remarks>
  10712. <exception cref="!:CogSpaceTreeNotInTreeException">
  10713. if the SelectedSpaceName3D of the range image is not in the tree, or if the
  10714. SelectedSpaceName3D of the plane is not in the tree.
  10715. </exception>
  10716. </member>
  10717. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculator.InputImageMaskOffsetY">
  10718. <summary>
  10719. Gets or sets the 2D InputImageMask Y offset value in pixels.
  10720. </summary>
  10721. <value>
  10722. The InputImageMask Y offset value in pixels. The X and Y offset values
  10723. set the offset from the upper-left corner of the run-time input
  10724. image to th upper-left corner of the
  10725. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculator.InputImageMask" />
  10726. in pixels. The default is 0.
  10727. </value>
  10728. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  10729. <para>Fires when this property changes.</para>
  10730. <para>The following state flag will be set:</para>
  10731. <list type="bullet">
  10732. <item>SfInputImageMaskOffsetY</item>
  10733. </list>
  10734. </event>
  10735. </member>
  10736. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculator.InputImageMaskOffsetX">
  10737. <summary>
  10738. Gets or sets the 2D InputImageMask X offset value in pixels.
  10739. </summary>
  10740. <value>
  10741. The InputImageMask X offset value in pixels. The X and Y offset values
  10742. set the offset from the upper-left corner of the run-time input
  10743. image to th upper-left corner of the
  10744. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculator.InputImageMask" />
  10745. in pixels. The default is 0.
  10746. </value>
  10747. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  10748. <para>Fires when this property changes.</para>
  10749. <para>The following state flag will be set:</para>
  10750. <list type="bullet">
  10751. <item>SfInputImageMaskOffsetX</item>
  10752. </list>
  10753. </event>
  10754. </member>
  10755. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculator.InputImageMask">
  10756. <summary>
  10757. Gets or sets the input image mask.
  10758. The input image mask allows you to ignore regions
  10759. of the range image by masking them out.
  10760. </summary>
  10761. <value>
  10762. InputImageMask is optional and may be null if no mask is
  10763. required. The default is null.
  10764. <para>
  10765. 255 = use this pixel
  10766. </para><para>
  10767. 0 = ignore this pixel
  10768. </para></value>
  10769. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  10770. <para>Fires when this property changes.</para>
  10771. <para>The following state flag will be set:</para>
  10772. <list type="bullet">
  10773. <item>SfInputImageMaskOffset</item>
  10774. </list>
  10775. </event>
  10776. <remarks>
  10777. The input image mask is applied to the input image after taking the
  10778. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculator.InputImageMaskOffsetX" />
  10779. and
  10780. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculator.InputImageMaskOffsetY" />
  10781. into account.
  10782. </remarks>
  10783. </member>
  10784. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculator.ComputePixelCountsDiagImage">
  10785. <summary>
  10786. Specifies whether or not to include a pixel counts diagnostics
  10787. image in the result. The pixel counts diagnostics image indicates
  10788. which pixels in the range image were used by the volume calculation.
  10789. </summary>
  10790. <value>
  10791. The default is true.
  10792. </value>
  10793. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  10794. <para>Fires when this property changes.</para>
  10795. <para>The following state flag will be set:</para>
  10796. <list type="bullet">
  10797. <item>SfComputePixelCountsDiagImage</item>
  10798. </list>
  10799. </event>
  10800. </member>
  10801. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculator.PlaneSide">
  10802. <summary>
  10803. Specifies which side of the plane to consider when computing the volume.
  10804. Only range image pixels that are on the specified side of the plane will
  10805. be used in computing the volume.
  10806. </summary>
  10807. <value>
  10808. The default is Cog3DPlaneSideConstants::IncreasingPlaneNormal.
  10809. </value>
  10810. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  10811. <para>Fires when this property changes.</para>
  10812. <para>The following state flag will be set:</para>
  10813. <list type="bullet">
  10814. <item>SfPlaneSide</item>
  10815. </list>
  10816. </event>
  10817. </member>
  10818. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculator.MinimumHeightThreshold">
  10819. <summary>
  10820. The minimum height value, in selected space 3D units, for each range
  10821. image pixel in order to include that pixel in the volume computation.
  10822. </summary>
  10823. <value>
  10824. The minimum height threshold must be in the range [0, Double::MaxValue].
  10825. The default is 0.0.
  10826. </value>
  10827. <remarks>
  10828. <para>
  10829. The "height" of a range image pixel relative to a base plane is defined as
  10830. the signed distance from the center of the range image pixel to the
  10831. nearest point on the base plane, measured in selected space 3D coordinates.
  10832. </para>
  10833. <para>
  10834. The user can specify a minimum height threshold so that
  10835. pixels with a small height (e.g. noise about the base plane) can be
  10836. excluded from the volume computation.
  10837. Only pixels with a positive height that is greater than or equal to the
  10838. user-specified minimum height threshold contribute to the computed volume.
  10839. </para>
  10840. <para>
  10841. Note that height threshold does not affect the amount a pixel
  10842. used in the computation contributes to the volume.
  10843. The height threshold only determines whether or not a
  10844. range image pixel is used.
  10845. </para>
  10846. </remarks>
  10847. Throws <exception cref="T:System.ArgumentOutOfRangeException">
  10848. if set to a value less than 0.0.
  10849. </exception><event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed"><para>Fires when this property changes.</para><para>The following state flag will be set:</para><list type="bullet"><item>SfMinimumHeightThreshold</item></list></event></member>
  10850. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculator.RegionMode">
  10851. <summary>
  10852. Gets or sets the region mode. This controls how the optional run time
  10853. region is applied to the input image.
  10854. </summary>
  10855. <value>
  10856. The region mode. May be either PixelAlignedBoundingBox or
  10857. PixelAlignedBoundingBoxAdjustMask. Default is PixelAlignedBoundingBoxAdjustMask.
  10858. CogRegionModeConstants::AffineTransform is not a supported region mode.
  10859. </value>
  10860. <exception cref="T:System.ArgumentException">
  10861. If the supplied argument is not either PixelAlignedBoundingBox or
  10862. PixelAlignedBoundignBoxAdjustMask.
  10863. </exception>
  10864. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  10865. <para>Fires when this property changes.</para>
  10866. <para>The following state flag will be set:</para>
  10867. <list type="bullet">
  10868. <item>SfRegionMode</item>
  10869. </list>
  10870. </event>
  10871. </member>
  10872. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculator.SfInputImageMaskOffsetY">
  10873. <summary>
  10874. This bit will be set in the EventArgs of a Changed event every time the
  10875. value returned by InputImageMaskOffsetX may have changed.
  10876. </summary>
  10877. </member>
  10878. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculator.SfInputImageMaskOffsetX">
  10879. <summary>
  10880. This bit will be set in the EventArgs of a Changed event every time the
  10881. value returned by InputImageMaskOffsetX may have changed.
  10882. </summary>
  10883. </member>
  10884. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculator.SfInputImageMask">
  10885. <summary>
  10886. This bit will be set in the EventArgs of a Changed event every time the
  10887. value returned by InputImageMask may have changed.
  10888. </summary>
  10889. </member>
  10890. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculator.SfComputePixelCountsDiagImage">
  10891. <summary>
  10892. This bit will be set in the EventArgs of a Changed event every time the
  10893. value returned by ComputePixelCountsDiagImage may have changed.
  10894. </summary>
  10895. </member>
  10896. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculator.SfPlaneSide">
  10897. <summary>
  10898. This bit will be set in the EventArgs of a Changed event every time the
  10899. value returned by PlaneSide may have changed.
  10900. </summary>
  10901. </member>
  10902. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculator.SfMinimumHeightThreshold">
  10903. <summary>
  10904. This bit will be set in the EventArgs of a Changed event every time the
  10905. value returned by MinimumHeightThreshold may have changed.
  10906. </summary>
  10907. </member>
  10908. <member name="F:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculator.SfRegionMode">
  10909. <summary>
  10910. This bit will be set in the EventArgs of a Changed event every time the
  10911. value returned by RegionMode may have changed.
  10912. </summary>
  10913. </member>
  10914. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculator.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  10915. <summary>
  10916. Serialization Constructor
  10917. </summary>
  10918. </member>
  10919. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculator.#ctor(Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculator)">
  10920. <summary>
  10921. Constructs a new instance of this class as a deep copy of the
  10922. given instance.
  10923. </summary>
  10924. <param name="other">
  10925. The Cog3DRangeImageVolumeCalculator object to be copied. May not be null.
  10926. </param>
  10927. <exception cref="T:System.ArgumentException">
  10928. If the input argument is null.
  10929. </exception>
  10930. </member>
  10931. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculator.#ctor">
  10932. <summary>
  10933. Constructs a new instance of this class
  10934. </summary>
  10935. </member>
  10936. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculator">
  10937. <summary>
  10938. The volume calculator tool operator
  10939. </summary>
  10940. </member>
  10941. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorResult.PixelCountsDiagImageOffsetY">
  10942. <summary>
  10943. The 2D distance in the Y direction from the upper left corner
  10944. of the original input image to the upper left corner of the
  10945. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorResult.PixelCountsDiagImage" />
  10946. (in pixels).
  10947. </summary>
  10948. </member>
  10949. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorResult.PixelCountsDiagImageOffsetX">
  10950. <summary>
  10951. The 2D distance in the X direction from the upper left corner
  10952. of the original input image to the upper left corner of the
  10953. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorResult.PixelCountsDiagImage" />
  10954. (in pixels).
  10955. </summary>
  10956. </member>
  10957. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorResult.PixelCountsDiagImage">
  10958. <summary>
  10959. Diagnostic which identifies which pixels in the range image fall
  10960. into each of 4 different categories.
  10961. <para>
  10962. See <see cref="T:Cognex.VisionPro3D.Cog3DRangeImagePixelCountsTypeConstants" />
  10963. for the definition of the different categories.
  10964. </para><para>
  10965. Each pixel in the pixel counts diag image is a bit-wise or of
  10966. <see cref="T:Cognex.VisionPro3D.Cog3DRangeImagePixelCountsTypeConstants" />.
  10967. </para></summary>
  10968. <remarks>
  10969. <para>
  10970. A range image pixel is "used" to calculate the volume if:
  10971. <list type="bullet"><item>
  10972. it is inside the 2D input
  10973. <see cref="P:Cognex::VisionPro3D::Cog3DRangeImageVolumeCalculatorTool::Region" />
  10974. of the tool.
  10975. </item><item>
  10976. it is marked as "care" in the optional
  10977. <see cref="P:Cognex::VisionPro3D::Cog3DRangeImageVolumeCalculator::InputImageMask" />
  10978. provided as part of the
  10979. <see cref="P:Cognex::VisionPro3D::Cog3DRangeImageVolumeCalculatorTool::RunParams" />.
  10980. </item><item>
  10981. it is marked as a "visible pixel" in the visible pixel mask of the
  10982. <see cref="P:Cognex::VisionPro3D::Cog3DRangeImageVolumeCalculatorTool::InputImage" />.
  10983. The visible pixel mask can be accessed by calling
  10984. <see cref="M:Cognex.VisionPro.CogImage16Range.GetMaskData" /> on the range image.
  10985. </item><item>
  10986. its height (relative to the base plane) is greater than
  10987. or equal to the
  10988. <see cref="P:Cognex::VisionPro3D::Cog3DRangeImageVolumeCalculator::MinimumHeightThreshold" />.
  10989. </item></list></para>
  10990. <para>
  10991. Pixels that meet these conditions contribute to the volume computation
  10992. and are marked as "used" in the
  10993. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorResult.PixelCountsDiagImage" />.
  10994. </para>
  10995. <para>
  10996. Note that the height of an individual range image pixel is defined as
  10997. the signed distance from the center of the range image pixel to
  10998. the nearest point on the base plane (measured in selected space 3D units).
  10999. </para>
  11000. <para>
  11001. Note, however, that the volume is calculated by summing the contribution of
  11002. the range image pixels within the
  11003. <see cref="P:Cognex::VisionPro3D::Cog3DRangeImageVolumeCalculatorTool::Region" />
  11004. projected along the pixel coordinate z axis until they intersect the base plane.
  11005. </para>
  11006. </remarks>
  11007. </member>
  11008. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorResult.PixelCounts">
  11009. <summary>
  11010. Result information which identifies the number of pixels in the range image
  11011. that fall into each of 4 different categories.
  11012. See <see cref="T:Cognex.VisionPro3D.Cog3DRangeImagePixelCountsTypeConstants" />
  11013. for the definition of the different categories.
  11014. </summary>
  11015. <remarks>
  11016. <para>
  11017. A range image pixel is "used" to calculate the volume if:
  11018. <list type="bullet"><item>
  11019. it is inside the 2D input
  11020. <see cref="P:Cognex::VisionPro3D::Cog3DRangeImageVolumeCalculatorTool::Region" />
  11021. of the tool.
  11022. </item><item>
  11023. it is marked as "care" in the optional
  11024. <see cref="P:Cognex::VisionPro3D::Cog3DRangeImageVolumeCalculator::InputImageMask" />
  11025. provided as part of the
  11026. <see cref="P:Cognex::VisionPro3D::Cog3DRangeImageVolumeCalculatorTool::RunParams" />.
  11027. </item><item>
  11028. it is marked as a "visible pixel" in the visible pixel mask of the
  11029. <see cref="P:Cognex::VisionPro3D::Cog3DRangeImageVolumeCalculatorTool::InputImage" />.
  11030. The visible pixel mask can be accessed by calling
  11031. <see cref="M:Cognex.VisionPro.CogImage16Range.GetMaskData" /> on the range image.
  11032. </item><item>
  11033. its height (relative to the base plane) is greater than
  11034. or equal to the
  11035. <see cref="P:Cognex::VisionPro3D::Cog3DRangeImageVolumeCalculator::MinimumHeightThreshold" />.
  11036. </item></list></para>
  11037. <para>
  11038. Pixels that meet these conditions contribute to the volume computation
  11039. and are marked as "used" in the
  11040. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorResult.PixelCountsDiagImage" />.
  11041. </para>
  11042. <para>
  11043. Note that the height of an individual range image pixel is defined as
  11044. the signed distance from the center of the range image pixel to
  11045. the nearest point on the base plane (measured in selected space 3D units).
  11046. </para>
  11047. <para>
  11048. Note, however, that the volume is calculated by summing the contribution of
  11049. the range image pixels within the
  11050. <see cref="P:Cognex::VisionPro3D::Cog3DRangeImageVolumeCalculatorTool::Region" />
  11051. projected along the pixel coordinate z axis until they intersect the base plane.
  11052. </para>
  11053. </remarks>
  11054. </member>
  11055. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorResult.Volume">
  11056. <summary>
  11057. The calculated volume between the 3D surface defined by the
  11058. range image pixels and the specified base plane, measured in the
  11059. <see cref="P:Cognex.VisionPro.CogImage16Range.SelectedSpaceName3D" />
  11060. coordinates (e.g. mm3) of the range image
  11061. </summary>
  11062. <remarks>
  11063. <para>
  11064. A range image pixel is "used" to calculate the volume if:
  11065. <list type="bullet"><item>
  11066. it is inside the 2D input
  11067. <see cref="P:Cognex::VisionPro3D::Cog3DRangeImageVolumeCalculatorTool::Region" />
  11068. of the tool.
  11069. </item><item>
  11070. it is marked as "care" in the optional
  11071. <see cref="P:Cognex::VisionPro3D::Cog3DRangeImageVolumeCalculator::InputImageMask" />
  11072. provided as part of the
  11073. <see cref="P:Cognex::VisionPro3D::Cog3DRangeImageVolumeCalculatorTool::RunParams" />.
  11074. </item><item>
  11075. it is marked as a "visible pixel" in the visible pixel mask of the
  11076. <see cref="P:Cognex::VisionPro3D::Cog3DRangeImageVolumeCalculatorTool::InputImage" />.
  11077. The visible pixel mask can be accessed by calling
  11078. <see cref="M:Cognex.VisionPro.CogImage16Range.GetMaskData" /> on the range image.
  11079. </item><item>
  11080. its height (relative to the base plane) is greater than
  11081. or equal to the
  11082. <see cref="P:Cognex::VisionPro3D::Cog3DRangeImageVolumeCalculator::MinimumHeightThreshold" />.
  11083. </item></list></para>
  11084. <para>
  11085. Pixels that meet these conditions contribute to the volume computation
  11086. and are marked as "used" in the
  11087. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorResult.PixelCountsDiagImage" />.
  11088. </para>
  11089. <para>
  11090. Note that the height of an individual range image pixel is defined as
  11091. the signed distance from the center of the range image pixel to
  11092. the nearest point on the base plane (measured in selected space 3D units).
  11093. </para>
  11094. <para>
  11095. Note, however, that the volume is calculated by summing the contribution of
  11096. the range image pixels within the
  11097. <see cref="P:Cognex::VisionPro3D::Cog3DRangeImageVolumeCalculatorTool::Region" />
  11098. projected along the pixel coordinate z axis until they intersect the base plane.
  11099. </para>
  11100. </remarks>
  11101. </member>
  11102. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorResult.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  11103. <summary>
  11104. Serialization Constructor
  11105. </summary>
  11106. </member>
  11107. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorResult.SetFromCVT(c3d_volumeResult!System.Runtime.CompilerServices.IsConst*!System.Runtime.CompilerServices.IsImplicitlyDereferenced,Cognex.VisionPro.CogImage16Range)">
  11108. <summary>
  11109. Populate the members of the Cog3DRangeImageVolumeCalculatorResult from its CVT equivilent.
  11110. </summary>
  11111. </member>
  11112. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorResult.#ctor(c3d_volumeResult!System.Runtime.CompilerServices.IsConst*!System.Runtime.CompilerServices.IsImplicitlyDereferenced,System.Int32,System.Int32,Cognex.VisionPro.CogImage16Range)">
  11113. <summary>
  11114. Construct a Cog3DRangeImageVolumeCalculatorResult based on its CVT equivilent.
  11115. </summary>
  11116. </member>
  11117. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorResult.#ctor(Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorResult)">
  11118. <summary>
  11119. Constructs a new instance of this class as a deep copy of the
  11120. given instance.
  11121. </summary>
  11122. <param name="other">
  11123. The Cog3DRangeImageVolumeCalculatorResult object to be copied. May not be null.
  11124. </param>
  11125. <exception cref="T:System.ArgumentException">
  11126. If the input argument is null.
  11127. </exception>
  11128. </member>
  11129. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorResult.#ctor">
  11130. <summary>
  11131. Constructs a new instance of this class.
  11132. </summary>
  11133. </member>
  11134. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageVolumeCalculatorResult">
  11135. <summary>
  11136. The result of running the 3D Volume Calculator Tool
  11137. </summary>
  11138. </member>
  11139. <member name="T:Cognex.VisionPro3D.Cog3DPlaneSideConstants">
  11140. <summary>
  11141. This enumeration is used to specify one side of a plane.
  11142. </summary>
  11143. </member>
  11144. <member name="F:Cognex.VisionPro3D.Cog3DPlaneSideConstants.DecreasingPlaneNormal">
  11145. <summary>
  11146. The side of the plane containing points in the negative
  11147. normal vector direction.
  11148. </summary>
  11149. </member>
  11150. <member name="F:Cognex.VisionPro3D.Cog3DPlaneSideConstants.IncreasingPlaneNormal">
  11151. <summary>
  11152. The side of the plane containing points in the positive
  11153. normal vector direction.
  11154. </summary>
  11155. </member>
  11156. <member name="P:Cognex.VisionPro3D.Cog3DRangeImagePixelCounts.NumUsedPixels">
  11157. <summary>
  11158. The number of pixels that were actually used by the tool or function to compute the
  11159. result. Such pixels must always be visible care pixels, but some
  11160. functions may choose to impose other restrictions as well. Each function should
  11161. document how it computes NumUsedPels. Note that this value is always less than
  11162. or equal to NumVisibleCarePels.
  11163. </summary>
  11164. </member>
  11165. <member name="P:Cognex.VisionPro3D.Cog3DRangeImagePixelCounts.NumVisibleCarePixels">
  11166. <summary>
  11167. The number of pixels in the effective source region that are both care pixels and
  11168. visible pixels. Note that this value is always less than or equal to NumCarePels.
  11169. </summary>
  11170. </member>
  11171. <member name="P:Cognex.VisionPro3D.Cog3DRangeImagePixelCounts.NumCarePixels">
  11172. <summary>
  11173. The number of care pixels in the region of interest. Note that this value
  11174. is always less than or equal to NumRegionBoundingBoxPixels.
  11175. </summary>
  11176. </member>
  11177. <member name="P:Cognex.VisionPro3D.Cog3DRangeImagePixelCounts.NumRegionBoundingBoxPixels">
  11178. <summary>
  11179. The number of pixels in the pixel aligned bounding box of the region of interest.
  11180. </summary>
  11181. </member>
  11182. <member name="M:Cognex.VisionPro3D.Cog3DRangeImagePixelCounts.SetFromCVT(c3ip_pixelCount!System.Runtime.CompilerServices.IsConst*!System.Runtime.CompilerServices.IsImplicitlyDereferenced)">
  11183. <summary>
  11184. Populate the members of the pixelCount_c from its CVT equivilent.
  11185. </summary>
  11186. </member>
  11187. <member name="M:Cognex.VisionPro3D.Cog3DRangeImagePixelCounts.#ctor(c3ip_pixelCount!System.Runtime.CompilerServices.IsConst*!System.Runtime.CompilerServices.IsImplicitlyDereferenced)">
  11188. <summary>
  11189. Construct a Cog3DRangeImagePixelCounts based on its CVT equivilent.
  11190. </summary>
  11191. </member>
  11192. <member name="M:Cognex.VisionPro3D.Cog3DRangeImagePixelCounts.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  11193. <summary>
  11194. Serialization Constructor
  11195. </summary>
  11196. </member>
  11197. <member name="M:Cognex.VisionPro3D.Cog3DRangeImagePixelCounts.#ctor(Cognex.VisionPro3D.Cog3DRangeImagePixelCounts)">
  11198. <summary>
  11199. Constructs a new instance of this class as a deep copy of the
  11200. given instance.
  11201. </summary>
  11202. <param name="other">
  11203. The Cog3DRangeImagePixelCounts object to be copied. May not be null.
  11204. </param>
  11205. <exception cref="T:System.ArgumentException">
  11206. If the input argument is null.
  11207. </exception>
  11208. </member>
  11209. <member name="M:Cognex.VisionPro3D.Cog3DRangeImagePixelCounts.#ctor">
  11210. <summary>
  11211. Constructs a new instance of this class.
  11212. </summary>
  11213. </member>
  11214. <member name="T:Cognex.VisionPro3D.Cog3DRangeImagePixelCounts">
  11215. <summary>
  11216. Result information about how a 3D tool used
  11217. the pixels of a range image.
  11218. </summary>
  11219. </member>
  11220. <member name="T:Cognex.VisionPro3D.Cog3DRangeImagePixelCountsTypeConstants">
  11221. <summary>
  11222. This enumeration is used as a diagnostic,
  11223. it reports whether a range image pixel was
  11224. "Used" by a 3D tool to produce the result
  11225. or if the pixel was ignored by the tool.
  11226. </summary>
  11227. </member>
  11228. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePixelCountsTypeConstants.Used">
  11229. <summary>
  11230. A pixel is a Used pixel if:
  11231. <para>
  11232. it is a VisibleCare pixel
  11233. </para><para>
  11234. AND
  11235. </para><para>
  11236. it was used by the operation
  11237. that is reporting the pixel count
  11238. </para></summary>
  11239. </member>
  11240. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePixelCountsTypeConstants.VisibleCare">
  11241. <summary>
  11242. A pixel is a VisibleCare pixel if:
  11243. <para>
  11244. it is a Care pixel
  11245. </para><para>
  11246. AND
  11247. </para><para>
  11248. it is marked as visible in the
  11249. range image.
  11250. </para></summary>
  11251. </member>
  11252. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePixelCountsTypeConstants.Care">
  11253. <summary>
  11254. A pixel is a Care pixel if:
  11255. <para>
  11256. it lies within the region of interest,
  11257. </para><para>
  11258. AND
  11259. </para><para>
  11260. its is not filtered out when
  11261. an input image mask is applied
  11262. </para></summary>
  11263. </member>
  11264. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePixelCountsTypeConstants.RegionBoundingBox">
  11265. NOTE:
  11266. THE PIXELS IN THE PIXEL COUNT MASK RETURNED FROM
  11267. CVT ARE A BITWISE OR OF THESE CONSTANTS.
  11268. THIS MAKES IT IMPORTANT THAT THE VALUES
  11269. OF THESE ENUMS ARE KEPT IN SYNC WITH THEIR
  11270. CVT EQUIVILENTS (WE DON'T CONVERT THE VALUES
  11271. OF THE RETURNED CVT IMAGE TO MACTH THESE VALUES).
  11272. <summary>
  11273. A pixel is a RegionBoundingBox pixel if:
  11274. <para>
  11275. it lies within the pixel aligned
  11276. bounding box of the region of interest
  11277. </para></summary></member>
  11278. <member name="M:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorTool.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  11279. <summary>
  11280. Serialization constructor for Cog3DRangeImagePlaneEstimatorTool object.
  11281. </summary>
  11282. <param name="Info">
  11283. The standard SerializationInfo argument.
  11284. </param>
  11285. <param name="Ctxt">
  11286. The standard StreamingContext argument.
  11287. </param>
  11288. </member>
  11289. <member name="P:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorTool.Result">
  11290. <summary>
  11291. Gets the results from the last call to the Run method.
  11292. A new instance of Cog3DRangeImagePlaneEstimatorResult is created for each
  11293. run of the tool.
  11294. </summary>
  11295. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  11296. <para>Fires when this property changes.</para>
  11297. <para>The following state flag may be affected:</para>
  11298. <list type="bullet">
  11299. <item>SfResult</item>
  11300. </list>
  11301. </event>
  11302. </member>
  11303. <member name="P:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorTool.RunParams">
  11304. <summary>
  11305. Gets or sets the run parameters (operator) for this Cog3DRangeImagePlaneEstimatorTool.
  11306. </summary>
  11307. <value>
  11308. The value can not be null.
  11309. The default is a default Cog3DRangeImagePlaneEstimator.
  11310. </value>
  11311. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  11312. <para>Fires when this property changes.</para>
  11313. <para>The following state flag may be affected:</para>
  11314. <list type="bullet">
  11315. <item>SfRunParams</item>
  11316. </list>
  11317. </event>
  11318. </member>
  11319. <member name="P:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorTool.Region">
  11320. <summary>
  11321. Gets or sets the optional 2D region that specifies a portion of the
  11322. input image to be used for plane estimation. The
  11323. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.RegionMode" />
  11324. property specifies exactly how this region will be applied to the
  11325. InputImage.
  11326. </summary>
  11327. <value>
  11328. The default is null.
  11329. </value>
  11330. <para>Fires when this property changes.</para>
  11331. <para>The following state flag may be affected:</para>
  11332. <list type="bullet">
  11333. <item>SfRegion</item>
  11334. </list>
  11335. </member>
  11336. <member name="P:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorTool.InputImage">
  11337. <summary>
  11338. Gets or sets the input range image for use in plane estimation.
  11339. </summary>
  11340. <value>
  11341. The default is null.
  11342. </value>
  11343. <exception cref="T:Cognex.VisionPro.Exceptions.CogImageBadTypeException">
  11344. If the supplied input image is not CogImage16Range.
  11345. </exception>
  11346. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  11347. <para>Fires when this property changes.</para>
  11348. <para>The following state flag may be affected:</para>
  11349. <list type="bullet">
  11350. <item>SfInputImage</item>
  11351. </list>
  11352. </event>
  11353. </member>
  11354. <member name="P:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorTool.LastRunRecordDiagEnable">
  11355. <summary>
  11356. Enable creation of records by bitwise ORing the appropriate
  11357. Cog3DRangeImagePlaneEstimatorLastRunRecordDiagConstants.
  11358. </summary>
  11359. <value>
  11360. the default is (int)Cog3DRangeImagePlaneEstimatorLastRunRecordDiagConstants::InputImageByReference | (int)Cog3DRangeImagePlaneEstimatorLastRunRecordDiagConstants::Region | (int)Cog3DRangeImagePlaneEstimatorLastRunRecordDiagConstants::InputImageMask
  11361. </value>
  11362. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  11363. <para>Fires when this property changes.</para>
  11364. <para>The following state flag may be affected:</para>
  11365. <list type="bullet">
  11366. <item>SfLastRunRecordDiagEnable</item>
  11367. </list>
  11368. </event>
  11369. </member>
  11370. <member name="P:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorTool.LastRunRecordEnable">
  11371. <summary>
  11372. Enable creation of records by bitwise ORing the appropriate
  11373. Cog3DRangeImagePlaneEstimatorLastRunRecordConstants.
  11374. </summary>
  11375. <value>
  11376. The default is Cog3DRangeImagePlaneEstimatorLastRunRecordConstants::All
  11377. </value>
  11378. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  11379. <para>Fires when this property changes.</para>
  11380. <para>The following state flag may be affected:</para>
  11381. <list type="bullet">
  11382. <item>SfLastRunRecordEnable</item>
  11383. <item>SfCreateLastRunRecord</item>
  11384. </list>
  11385. </event>
  11386. </member>
  11387. <member name="P:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorTool.CurrentRecordEnable">
  11388. <summary>
  11389. Enable creation of records by bitwise ORing the appropriate
  11390. Cog3DRangeImagePlaneEstimatorCurrentRecordConstants.
  11391. </summary>
  11392. <value>
  11393. The default is (int)Cog3DRangeImagePlaneEstimatorCurrentRecordConstants::InputImage | (int)Cog3DRangeImagePlaneEstimatorCurrentRecordConstants::Region | (int)Cog3DRangeImagePlaneEstimatorCurrentRecordConstants::InputImageMask
  11394. </value>
  11395. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  11396. <para>Fires when this property changes.</para>
  11397. <para>The following state flag may be affected:</para>
  11398. <list type="bullet">
  11399. <item>SfCurrentRecordEnable</item>
  11400. <item>SfCreateCurrentRecord</item>
  11401. </list>
  11402. </event>
  11403. </member>
  11404. <member name="M:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorTool.Finalize">
  11405. <summary>
  11406. Finalize this Cog3DRangeImagePlaneEstimatorTool object.
  11407. </summary>
  11408. </member>
  11409. <member name="M:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorTool.Dispose">
  11410. <summary>
  11411. Destruct this Cog3DRangeImagePlaneEstimatorTool object.
  11412. </summary>
  11413. </member>
  11414. <member name="M:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorTool.#ctor(Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorTool)">
  11415. <summary>
  11416. Construct a deep copy of the supplied Cog3DRangeImagePlaneEstimatorTool object.
  11417. </summary>
  11418. <param name="Other">
  11419. The Cog3DRangeImagePlaneEstimatorTool object to be copied. May not be null.
  11420. </param>
  11421. <exception cref="T:System.ArgumentNullException">
  11422. If the input argument is null.
  11423. </exception>
  11424. </member>
  11425. <member name="M:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorTool.#ctor">
  11426. <summary>
  11427. Construct a default Cog3DRangeImagePlaneEstimatorTool object.
  11428. </summary>
  11429. </member>
  11430. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorTool.SfResult">
  11431. <summary>
  11432. This bit will be set in the EventArgs of a Changed event every time
  11433. the value returned by Results may have changed.
  11434. </summary>
  11435. </member>
  11436. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorTool.SfRegion">
  11437. <summary>
  11438. This bit will be set in the EventArgs of a Changed event every time
  11439. the value returned by Region may have changed.
  11440. </summary>
  11441. </member>
  11442. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorTool.SfInputImage">
  11443. <summary>
  11444. This bit will be set in the EventArgs of a Changed event every time
  11445. the value returned by InputImage may have changed.
  11446. </summary>
  11447. </member>
  11448. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorTool.SfRunParams">
  11449. <summary>
  11450. This bit will be set in the EventArgs of a Changed event every time
  11451. the value returned by RunParams may have changed.
  11452. </summary>
  11453. </member>
  11454. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorTool.SfCurrentRecordEnable">
  11455. <summary>
  11456. This bit will be set in the EventArgs of a Changed event every time
  11457. the value returned by CurrentRecordEnable may have changed.
  11458. </summary>
  11459. </member>
  11460. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorTool.SfLastRunRecordDiagEnable">
  11461. <summary>
  11462. This bit will be set in the EventArgs of a Changed event every time
  11463. the value returned by LastRunRecordDiagEnable may have changed.
  11464. </summary>
  11465. </member>
  11466. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorTool.SfLastRunRecordEnable">
  11467. <summary>
  11468. This bit will be set in the EventArgs of a Changed event every time
  11469. the value returned by LastRunRecordEnable may have changed.
  11470. </summary>
  11471. </member>
  11472. <member name="T:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorTool">
  11473. <summary>
  11474. <para>
  11475. The purpose of the plane estimator tool is to find the best fitting plane
  11476. to a surface in a range image.
  11477. </para>
  11478. <para>
  11479. This plane estimator tool allows the user to fit a plane using pixels specified in a region or specified 2D point locations.
  11480. This class encapsulates all of the classes needed to perform
  11481. plane estimation on a range image.
  11482. </para>
  11483. <para>
  11484. The plane is returned in the
  11485. <see cref="P:Cognex.VisionPro.CogImage16Range.SelectedSpaceName3D" />
  11486. units specified in the range image.
  11487. </para>
  11488. </summary>
  11489. <remarks>
  11490. <para>
  11491. When <see cref="P:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.FitMethod" /> is set to Area:
  11492. Range image pixels that meet the following criteria are
  11493. used to fit the plane:
  11494. <para>
  11495. 1) must be contained within the 2D region of interest of the range image. No region means all of the input image.
  11496. </para><para>
  11497. 2) must be marked as "Care" if an input image mask is provided.
  11498. </para><para>
  11499. 3) must be marked as "Visible" in the range image's visible pixel mask.
  11500. </para>
  11501. Pixels that meet these conditions are used to fit the plane
  11502. and are counted in
  11503. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorResult.NumberOfPointsUsedInEstimation" /></para>
  11504. <para>
  11505. When <see cref="P:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.FitMethod" /> is set to Points:
  11506. Range image pixels that meet the following criteria are
  11507. used to fit the plane:
  11508. <para>
  11509. 1) must be contained within the range image boundaries.
  11510. </para><para>
  11511. 2) must be marked as "Visible" in the range image's visible pixel mask.
  11512. </para>
  11513. Pixels that meet these conditions are used to fit the plane
  11514. and are counted in
  11515. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorResult.NumberOfPointsUsedInEstimation" /></para>
  11516. </remarks>
  11517. </member>
  11518. <member name="M:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.Execute(Cognex.VisionPro.ICogImage,Cognex.VisionPro.ICogRegion)">
  11519. <summary>
  11520. Perform 3D plane fit on the supplied range image.
  11521. </summary>
  11522. <returns>
  11523. The 3D Plane (defined in SelectedSpaceName3D), RMS error and number of pixels used in estimation.
  11524. </returns>
  11525. <remarks>
  11526. <para>
  11527. When <see cref="P:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.FitMethod" /> is set to Area:
  11528. Range image pixels that meet the following criteria are
  11529. used to fit the plane:
  11530. <para>
  11531. 1) must be contained within the 2D region of interest of the range image. No region means all of the input image.
  11532. </para><para>
  11533. 2) must be marked as "Care" if an input image mask is provided.
  11534. </para><para>
  11535. 3) must be marked as "Visible" in the range image's visible pixel mask.
  11536. </para>
  11537. Pixels that meet these conditions are used to fit the plane
  11538. and are counted in
  11539. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorResult.NumberOfPointsUsedInEstimation" /></para>
  11540. <para>
  11541. When <see cref="P:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.FitMethod" /> is set to Points:
  11542. Range image pixels that meet the following criteria are
  11543. used to fit the plane:
  11544. <para>
  11545. 1) must be contained within the range image boundaries.
  11546. </para><para>
  11547. 2) must be marked as "Visible" in the range image's visible pixel mask.
  11548. </para>
  11549. Pixels that meet these conditions are used to fit the plane
  11550. and are counted in
  11551. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorResult.NumberOfPointsUsedInEstimation" /></para>
  11552. </remarks>
  11553. <param name="image">
  11554. The range image.
  11555. </param>
  11556. <param name="region">
  11557. An optional region used only the FitMethod is set to Area. May be null. If supplied, this region is used to
  11558. define the pixels used in fitting the 3D plane in the range image. The region
  11559. mode is defaulted to PixelAlignedBoundingBoxAdjustMask. If no
  11560. inputRegion is supplied, the entire input image is processed.
  11561. </param>
  11562. <exception cref="T:Cognex.VisionPro.Exceptions.CogImageBadTypeException">
  11563. If the supplied input image argument is not a CogImage16Range.
  11564. </exception>
  11565. <exception cref="T:Cognex.VisionPro.Exceptions.CogOperatorNoInputImageException">
  11566. If the supplied input image argument is null.
  11567. </exception>
  11568. <exception cref="T:System.ArgumentException">
  11569. If the supplied input image unbound.
  11570. </exception>
  11571. <exception cref="T:System.ArgumentException">
  11572. If the transform is not linear
  11573. </exception>
  11574. <exception cref="T:System.ArgumentException">
  11575. If region is outside of image
  11576. </exception>
  11577. <exception cref="T:Cognex.VisionPro3D.Cog3DException">
  11578. There are fewer than 3 points in the list of points that correspond to visible pixel locations in the image, or the combination of the input mask and visible pixel mask contains less than 3 care/visible pixels.
  11579. </exception>
  11580. <exception cref="T:Cognex.VisionPro3D.Cog3DException">
  11581. The list of points doesn't include 3 non-collinear points.
  11582. </exception>
  11583. <exception cref="T:Cognex.VisionPro3D.Cog3DException">
  11584. The list of input points is fewer than 3.
  11585. </exception>
  11586. <exception cref="T:Cognex.VisionPro3D.Cog3DException">
  11587. The pixel location of one or more points in the list of input points falls outside the extent of the image.
  11588. </exception>
  11589. <exception cref="T:Cognex.VisionPro3D.Cog3DException">
  11590. The RMS residual was above the threshold specified in the runtime params.
  11591. </exception>
  11592. <exception cref="T:Cognex.VisionPro3D.Cog3DException">
  11593. The tool was unable to compute the plane.
  11594. </exception>
  11595. <exception cref="T:Cognex.VisionPro.Exceptions.CogSecurityViolationException">
  11596. If licensing for this operator cannot be confirmed.
  11597. </exception>
  11598. </member>
  11599. <member name="P:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.SelectedIndex">
  11600. <summary>
  11601. For Cognex internal use only
  11602. </summary>
  11603. </member>
  11604. <member name="M:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.DeletePoint(System.Int32)">
  11605. <summary>
  11606. Delete a point from the input point list using the index specified
  11607. </summary>
  11608. <exception cref="T:System.ArgumentOutOfRangeException">
  11609. If the index is outside the range of points available.
  11610. </exception>
  11611. <remarks>
  11612. invalid range exception will be thrown
  11613. </remarks>
  11614. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  11615. <para>Fires when this property changes.</para>
  11616. <para>The following state flag may be affected:</para>
  11617. <list type="bullet">
  11618. <item>SfNumPoints</item>
  11619. </list>
  11620. </event>
  11621. </member>
  11622. <member name="M:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.AddPoint(System.Double,System.Double)">
  11623. <summary>
  11624. Add a point to the locations. The values are in selected space.
  11625. </summary>
  11626. <value>
  11627. The point will be added at the the end of the list.
  11628. </value>
  11629. <exception cref="T:System.OutOfMemoryException">
  11630. Out of memory exception will be thrown if the point could not be added.
  11631. </exception>
  11632. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  11633. <para>Fires when this property changes.</para>
  11634. <para>The following state flag may be affected:</para>
  11635. <list type="bullet">
  11636. <item>SfNumPoints</item>
  11637. </list>
  11638. </event>
  11639. </member>
  11640. <member name="P:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.PlaneDirection">
  11641. <summary>
  11642. Gets or sets the plane direction.
  11643. </summary>
  11644. <value>
  11645. The default plane direction positive image z direction.
  11646. </value>
  11647. <exception cref="T:System.ArgumentException">
  11648. If the argument supplied is not PositiveImageZ or NegativeImageZ.
  11649. </exception>
  11650. <remarks>
  11651. The plane direction specifies the direction in which the estimated plane's
  11652. normal should point. Note that, regardless of the direction selected, the
  11653. plane is always returned in selected space.
  11654. </remarks>
  11655. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  11656. <para>Fires when this property changes.</para>
  11657. <para>The following state flag may be affected:</para>
  11658. <list type="bullet">
  11659. <item>SfPlaneDirection</item>
  11660. </list>
  11661. </event>
  11662. </member>
  11663. <member name="M:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.SetPoint(System.Int32,System.Double,System.Double)">
  11664. <summary>
  11665. Sets the (x,y) coordinates defined in selected space for a single point using the index.
  11666. The points are used only when FitMethod is set to Points.
  11667. </summary>
  11668. <value>
  11669. The default is (0,0)
  11670. </value>
  11671. <exception cref="T:System.ArgumentOutOfRangeException">
  11672. If the index is outside the range of points available.
  11673. </exception>
  11674. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  11675. <para>Fires when this property changes.</para>
  11676. <para>The following state flag may be affected:</para>
  11677. <list type="bullet">
  11678. <item>SfGetPointX</item>
  11679. <item>SfGetPointY</item>
  11680. </list>
  11681. </event>
  11682. </member>
  11683. <member name="M:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.GetPoint(System.Int32,System.Double@,System.Double@)">
  11684. <summary>
  11685. Gets the (x,y) coordinates defined in selected space for a single point using the index.
  11686. The points are used only when FitMethod is set to Points.
  11687. </summary>
  11688. <value>
  11689. The default is (0,0)
  11690. </value>
  11691. <exception cref="T:System.ArgumentOutOfRangeException">
  11692. If the index is outside the range of points available.
  11693. </exception>
  11694. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  11695. <para>Fires when this property changes.</para>
  11696. <para>The following state flag may be affected:</para>
  11697. <list type="bullet">
  11698. <item>SfGetPointX</item>
  11699. <item>SfGetPointY</item>
  11700. </list>
  11701. </event>
  11702. </member>
  11703. <member name="M:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.SetPointY(System.Int32,System.Double)">
  11704. <summary>
  11705. Sets the Y (defined in selected space) for a single point using the index.
  11706. The points are used only when FitMethod is set to Points.
  11707. </summary>
  11708. <value>
  11709. The default is 0.
  11710. </value>
  11711. <exception cref="T:System.ArgumentOutOfRangeException">
  11712. If the index is outside the range of points available.
  11713. </exception>
  11714. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  11715. <para>Fires when this property changes.</para>
  11716. <para>The following state flag may be affected:</para>
  11717. <list type="bullet">
  11718. <item>SfGetPointY</item>
  11719. </list>
  11720. </event>
  11721. </member>
  11722. <member name="M:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.GetPointY(System.Int32)">
  11723. <summary>
  11724. Gets the Y (defined in selected space) for a single point using the index.
  11725. The points are used only when FitMethod is set to Points.
  11726. </summary>
  11727. <value>
  11728. The default is 0.
  11729. </value>
  11730. <exception cref="T:System.ArgumentOutOfRangeException">
  11731. If the index is outside the range of points available.
  11732. </exception>
  11733. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  11734. <para>Fires when this property changes.</para>
  11735. <para>The following state flag may be affected:</para>
  11736. <list type="bullet">
  11737. <item>SfGetPointY</item>
  11738. </list>
  11739. </event>
  11740. </member>
  11741. <member name="M:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.SetPointX(System.Int32,System.Double)">
  11742. <summary>
  11743. Sets the X (defined in selected space) for a single point using the index.
  11744. The points are used only when FitMethod is set to Points.
  11745. </summary>
  11746. <value>
  11747. The default is 0
  11748. </value>
  11749. <exception cref="T:System.ArgumentOutOfRangeException">
  11750. If the index is outside the range of points available.
  11751. </exception>
  11752. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  11753. <para>Fires when this property changes.</para>
  11754. <para>The following state flag may be affected:</para>
  11755. <list type="bullet">
  11756. <item>SfGetPointX</item>
  11757. </list>
  11758. </event>
  11759. </member>
  11760. <member name="M:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.GetPointX(System.Int32)">
  11761. <summary>
  11762. Gets the X (defined in selected space) for a single point using the index.
  11763. The points are used only when FitMethod is set to Points.
  11764. </summary>
  11765. <value>
  11766. The default is 0
  11767. </value>
  11768. <exception cref="T:System.ArgumentOutOfRangeException">
  11769. If the index is outside the range of points available.
  11770. </exception>
  11771. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  11772. <para>Fires when this property changes.</para>
  11773. <para>The following state flag may be affected:</para>
  11774. <list type="bullet">
  11775. <item>SfGetPointX</item>
  11776. </list>
  11777. </event>
  11778. </member>
  11779. <member name="P:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.NumPoints">
  11780. <summary>
  11781. Gets or sets the number of 2D locations specified in selected space.
  11782. The points are used only when FitMethod is set to Points.
  11783. </summary>
  11784. <value>
  11785. A minimum of 3 points are required to fit a plane. The default is 0.
  11786. </value>
  11787. <exception cref="T:System.ArgumentException">
  11788. If the index is less than 0.
  11789. </exception>
  11790. <exception cref="T:System.OutOfMemoryException">
  11791. When not enough memory available to allocate the number of points specified.
  11792. </exception>
  11793. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  11794. <para>Fires when this property changes.</para>
  11795. <para>The following state flag may be affected:</para>
  11796. <list type="bullet">
  11797. <item>SfNumPoints</item>
  11798. </list>
  11799. </event>
  11800. <remarks>
  11801. The locations are only used when the Fit Method is set to Points.
  11802. </remarks>
  11803. </member>
  11804. <member name="P:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.NeighborhoodSizeYInPixels">
  11805. <summary>
  11806. Gets or sets the NeighborhoodSizeYInPixels.
  11807. Only used when <see cref="P:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.FitMethod" /> is set to Points and
  11808. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.ZLookupMethod" /> is set to NeighborhoodMedian or Neighborhood.
  11809. </summary>
  11810. <value>
  11811. The neighborhood size in Y. The neighborhood to use when the
  11812. ZLookupMethod is NeighborhoodMedian or Neighborhood. The default is 5.
  11813. </value>
  11814. <exception cref="T:System.ArgumentException">
  11815. If the supplied argument is less than 1.
  11816. </exception>
  11817. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  11818. <para>Fires when this property changes.</para>
  11819. <para>The following state flag may be affected:</para>
  11820. <list type="bullet">
  11821. <item>SfNeighborhoodSizeYInPixels</item>
  11822. </list>
  11823. </event>
  11824. </member>
  11825. <member name="P:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.NeighborhoodSizeXInPixels">
  11826. <summary>
  11827. Gets or sets the NeighborhoodSizeXInPixels.
  11828. Only used when <see cref="P:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.FitMethod" /> is set to Points and
  11829. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.ZLookupMethod" /> is set to NeighborhoodMedian or Neighborhood.
  11830. </summary>
  11831. <value>
  11832. The neighborhood size in X. The neighborhood to use when the
  11833. ZLookupMethod is NeighborhoodMedian or Neighborhood. The default is 5.
  11834. </value>
  11835. <exception cref="T:System.ArgumentException">
  11836. If the supplied argument is less than 1.
  11837. </exception>
  11838. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  11839. <para>Fires when this property changes.</para>
  11840. <para>The following state flag may be affected:</para>
  11841. <list type="bullet">
  11842. <item>SfNeighborhoodSizeXInPixels</item>
  11843. </list>
  11844. </event>
  11845. </member>
  11846. <member name="P:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.ResidualsRMSThreshold">
  11847. <summary>
  11848. Gets or sets the Residuals RMS Threshold.
  11849. </summary>
  11850. <value>
  11851. If the Residuals RMS computed for the fitted plane
  11852. is above this threshold. The tool will throw.
  11853. The default is HUGE_VAL.
  11854. </value>
  11855. <exception cref="T:System.ArgumentException">
  11856. If the supplied argument is less than 0.
  11857. </exception>
  11858. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  11859. <para>Fires when this property changes.</para>
  11860. <para>The following state flag may be affected:</para>
  11861. <list type="bullet">
  11862. <item>SfResidualsRMSThreshold</item>
  11863. </list>
  11864. </event>
  11865. </member>
  11866. <member name="P:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.InputImageMaskOffsetY">
  11867. <summary>
  11868. Gets or sets the InputImageMask Y offset value in pixels.
  11869. </summary>
  11870. <value>
  11871. The InputImageMask Y offset value in pixels. The X and Y offset values
  11872. set the offset from the upper-left corner of the run-time input
  11873. image to the upper-left corner of the
  11874. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.InputImageMask" />
  11875. in pixels. The default is 0.
  11876. </value>
  11877. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  11878. <para>Fires when this property changes.</para>
  11879. <para>The following state flag may be affected:</para>
  11880. <list type="bullet">
  11881. <item>SfInputImageMaskOffsetY</item>
  11882. </list>
  11883. </event>
  11884. </member>
  11885. <member name="P:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.InputImageMaskOffsetX">
  11886. <summary>
  11887. Gets or sets the InputImageMask X offset value in pixels.
  11888. </summary>
  11889. <value>
  11890. The InputImageMask X offset value in pixels. The X and Y offset values
  11891. set the offset from the upper-left corner of the run-time input
  11892. image to the upper-left corner of the
  11893. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.InputImageMask" />
  11894. in pixels. The default is 0.
  11895. </value>
  11896. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  11897. <para>Fires when this property changes.</para>
  11898. <para>The following state flag may be affected:</para>
  11899. <list type="bullet">
  11900. <item>SfInputImageMaskOffsetX</item>
  11901. </list>
  11902. </event>
  11903. </member>
  11904. <member name="P:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.InputImageMask">
  11905. <summary>
  11906. Gets or sets the input image mask.
  11907. The input image mask allows you to ignore regions
  11908. of the range image by masking them out.
  11909. </summary>
  11910. <value>
  11911. InputImageMask is optional and may be null if no mask is
  11912. required. The default is null.
  11913. <para>
  11914. 255 = use this pixel
  11915. </para><para>
  11916. 0 = ignore this pixel
  11917. </para></value>
  11918. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  11919. <para>Fires when this property changes.</para>
  11920. <para>The following state flag may be affected:</para>
  11921. <list type="bullet">
  11922. <item>SfInputImageMask</item>
  11923. </list>
  11924. </event>
  11925. <remarks>
  11926. The input image mask is applied to the input image after taking the
  11927. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.InputImageMaskOffsetX" />
  11928. and
  11929. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.InputImageMaskOffsetY" />
  11930. into account.
  11931. </remarks>
  11932. </member>
  11933. <member name="P:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.FitMethod">
  11934. <summary>
  11935. Gets or sets the FitMethod.
  11936. </summary>
  11937. <value>
  11938. The fit Method specifies which mode is used to fit the plane. May be either Area or
  11939. Points. The default is Area.
  11940. </value>
  11941. <exception cref="T:System.ArgumentException">
  11942. If the supplied argument is not Area or
  11943. Points.
  11944. </exception>
  11945. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  11946. <para>Fires when this property changes.</para>
  11947. <para>The following state flag may be affected:</para>
  11948. <list type="bullet">
  11949. <item>SfFitMethod</item>
  11950. </list>
  11951. </event>
  11952. </member>
  11953. <member name="P:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.ZLookupMethod">
  11954. <summary>
  11955. Gets or sets the ZLookupMethod.
  11956. </summary>
  11957. <value>
  11958. The Z Lookup Method specifies how z values are looked up from pixels in the range image.
  11959. May be either Neighborhood, SinglePixel or
  11960. NeighborhoodMedian. The default is Neighborhood.
  11961. </value>
  11962. <remarks>
  11963. The Z Lookup Method is only used when the <see cref="P:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.FitMethod" /> is set to Points.
  11964. </remarks>
  11965. <exception cref="T:System.ArgumentException">
  11966. If the supplied argument is not Neighborhood, SinglePixel or
  11967. NeighborhoodMedian.
  11968. </exception>
  11969. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  11970. <para>Fires when this property changes.</para>
  11971. <para>The following state flag may be affected:</para>
  11972. <list type="bullet">
  11973. <item>SfZLookupMethod</item>
  11974. </list>
  11975. </event>
  11976. </member>
  11977. <member name="P:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.RegionMode">
  11978. <summary>
  11979. Gets or sets the region mode. This controls how the optional run time
  11980. region is applied to the input image.
  11981. </summary>
  11982. <value>
  11983. The region mode. May be either PixelAlignedBoundingBox or
  11984. PixelAlignedBoundingBoxAdjustMask. The Default is
  11985. PixelAlignedBoundingBoxAndAdjustMask.
  11986. </value>
  11987. <exception cref="T:System.ArgumentException">
  11988. If the supplied argument is not either PixelAlignedBoundingBox or
  11989. PixelAlignedBoundignBoxAdjustMask.
  11990. </exception>
  11991. <event cref="T:Cognex.VisionPro.ICogChangedEvent">
  11992. <para>Fires when this property changes.</para>
  11993. <para>The following state flag may be affected:</para>
  11994. <list type="bullet">
  11995. <item>SfRegionMode</item>
  11996. </list>
  11997. </event>
  11998. </member>
  11999. <member name="M:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  12000. <summary>
  12001. Serializer for point vector object.
  12002. </summary>
  12003. <param name="Info">
  12004. The standard SerializationInfo argument.
  12005. </param>
  12006. <param name="Ctxt">
  12007. The standard StreamingContext argument.
  12008. </param>
  12009. </member>
  12010. <member name="M:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  12011. <summary>
  12012. Serialization constructor for Cog3DRangeImagePlaneEstimator object.
  12013. </summary>
  12014. <param name="Info">
  12015. The standard SerializationInfo argument.
  12016. </param>
  12017. <param name="Ctxt">
  12018. The standard StreamingContext argument.
  12019. </param>
  12020. </member>
  12021. <member name="M:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.Finalize">
  12022. <summary>
  12023. Finalize this Cog3DRangeImagePlaneEstimator.
  12024. </summary>
  12025. </member>
  12026. <member name="M:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.Dispose">
  12027. <summary>
  12028. Destruct this Cog3DRangeImagePlaneEstimator.
  12029. </summary>
  12030. </member>
  12031. <member name="M:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.#ctor(Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator)">
  12032. <summary>
  12033. Construct a deep copy of the supplied Cog3DRangeImagePlaneEstimator object.
  12034. </summary>
  12035. <param name="Other">
  12036. The Cog3DRangeImagePlaneEstimator object to be copied. May not be null.
  12037. </param>
  12038. <exception cref="T:System.ArgumentNullException">
  12039. If the supplied argument is null.
  12040. </exception>
  12041. <exception cref="T:System.ArgumentException">
  12042. If the supplied argument is disposed.
  12043. </exception>
  12044. </member>
  12045. <member name="M:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.#ctor">
  12046. <summary>
  12047. Construct a default Cog3DRangeImagePlaneEstimator object.
  12048. </summary>
  12049. </member>
  12050. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.SfPlaneDirection">
  12051. <summary>
  12052. This bit will be set in the EventArgs of a changed event every time
  12053. the value returned by PlaneDirection may have cahnged.
  12054. </summary>
  12055. </member>
  12056. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.SfGetPointY">
  12057. <summary>
  12058. This bit will be set in the EventArgs of a Changed event every time
  12059. the value returned by GetPointY may have cahnged.
  12060. </summary>
  12061. </member>
  12062. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.SfGetPointX">
  12063. <summary>
  12064. This bit will be set in the EventArgs of a Changed event every time
  12065. the value returned by GetPointX may have cahnged.
  12066. </summary>
  12067. </member>
  12068. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.SfNumPoints">
  12069. <summary>
  12070. This bit will be set in the EventArgs of a Changed event every time
  12071. the value returned by NumPoints may have cahnged.
  12072. </summary>
  12073. </member>
  12074. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.SfFitMethod">
  12075. <summary>
  12076. This bit will be set in the EventArgs of a Changed event every time
  12077. the value returned by FitMethod may have cahnged.
  12078. </summary>
  12079. </member>
  12080. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.SfNeighborhoodSizeYInPixels">
  12081. <summary>
  12082. This bit will be set in the EventArgs of a Changed event every time
  12083. the value returned by NeighborhoodSizeYInPixels may have cahnged.
  12084. </summary>
  12085. </member>
  12086. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.SfNeighborhoodSizeXInPixels">
  12087. <summary>
  12088. This bit will be set in the EventArgs of a Changed event every time
  12089. the value returned by NeighborhoodSizeXInPixels may have cahnged.
  12090. </summary>
  12091. </member>
  12092. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.SfZLookupMethod">
  12093. <summary>
  12094. This bit will be set in the EventArgs of a Changed event every time
  12095. the value returned by ZLookupMethod may have cahnged.
  12096. </summary>
  12097. </member>
  12098. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.SfResidualsRMSThreshold">
  12099. <summary>
  12100. This bit will be set in the EventArgs of a Changed event every time
  12101. the value returned by ResidualsRMSThreshold may have cahnged.
  12102. </summary>
  12103. </member>
  12104. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.SfInputImageMaskOffsetY">
  12105. <summary>
  12106. This bit will be set in the EventArgs of a Changed event every time
  12107. the value returned by InputImageMaskOffsetY may have cahnged.
  12108. </summary>
  12109. </member>
  12110. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.SfInputImageMaskOffsetX">
  12111. <summary>
  12112. This bit will be set in the EventArgs of a Changed event every time
  12113. the value returned by InputImageMaskOffsetX may have cahnged.
  12114. </summary>
  12115. </member>
  12116. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.SfInputImageMask">
  12117. <summary>
  12118. This bit will be set in the EventArgs of a Changed event every time
  12119. the value returned by InputImageMask may have cahnged.
  12120. </summary>
  12121. </member>
  12122. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator.SfRegionMode">
  12123. <summary>
  12124. This bit will be set in the EventArgs of a Changed event every time
  12125. the value returned by RegionMode may have cahnged.
  12126. </summary>
  12127. </member>
  12128. <member name="T:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimator">
  12129. <summary>
  12130. The plane estimator operator.
  12131. </summary>
  12132. </member>
  12133. <member name="P:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorResult.Plane">
  12134. <summary>
  12135. The best fit plane found. The plane is defined in the
  12136. <see cref="P:Cognex.VisionPro.CogImage16Range.SelectedSpaceName3D" />
  12137. coordinates of the range image
  12138. </summary>
  12139. <remarks>
  12140. <para>
  12141. When FitMethod is set to Area:
  12142. Range image pixels that meet the following criteria are
  12143. used to fit the plane:
  12144. <para>
  12145. 1) must be contained within the 2D region of interest of the range image. No region means all of the input image.
  12146. </para><para>
  12147. 2) must be marked as "Care" if an input image mask is provided.
  12148. </para><para>
  12149. 3) must be marked as "Visible" in the range image's visible pixel mask.
  12150. </para>
  12151. Pixels that meet these conditions are used to fit the plane
  12152. and are counted in
  12153. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorResult.NumberOfPointsUsedInEstimation" /></para>
  12154. <para>
  12155. When FitMethod is set to Points:
  12156. Range image pixels that meet the following criteria are
  12157. used to fit the plane:
  12158. <para>
  12159. 1) must be contained within the range image boundaries.
  12160. </para><para>
  12161. 2) must be marked as "Visible" in the range image's visible pixel mask.
  12162. </para>
  12163. Pixels that meet these conditions are used to fit the plane
  12164. and are counted in
  12165. <see cref="P:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorResult.NumberOfPointsUsedInEstimation" /></para>
  12166. </remarks>
  12167. </member>
  12168. <member name="P:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorResult.NumberOfPointsUsedInEstimation">
  12169. <summary>
  12170. The number of points used to fit the plane
  12171. </summary>
  12172. </member>
  12173. <member name="P:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorResult.ResidualsRMS">
  12174. <summary>
  12175. The Residuals RMS error.
  12176. The RMS error should be small (less than 0.1)
  12177. to indicate that the plane is properly fitted.
  12178. </summary>
  12179. </member>
  12180. <member name="M:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorResult.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  12181. <summary>
  12182. Serialization constructor for Cog3DRangeImagePlaneEstimatorResult object.
  12183. </summary>
  12184. <param name="Info">
  12185. The standard SerializationInfo argument.
  12186. </param>
  12187. <param name="Ctxt">
  12188. The standard StreamingContext argument.
  12189. </param>
  12190. </member>
  12191. <member name="M:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorResult.Finalize">
  12192. <summary>
  12193. Finalize this Cog3DRangeImagePlaneEstimatorResult.
  12194. </summary>
  12195. </member>
  12196. <member name="M:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorResult.Dispose">
  12197. <summary>
  12198. Destruct this Cog3DRangeImagePlaneEstimatorResult.
  12199. </summary>
  12200. </member>
  12201. <member name="M:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorResult.#ctor(Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorResult)">
  12202. <summary>
  12203. Constructs a new instance of this class as a deep copy
  12204. of the given instance.
  12205. </summary>
  12206. <param name="other">
  12207. The Cog3DRangeImagePlaneEstimatorResult object to be copied. May not be null.
  12208. </param>
  12209. <exception cref="T:System.ArgumentException">
  12210. If the input argument is null.
  12211. </exception>
  12212. </member>
  12213. <member name="M:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorResult.#ctor">
  12214. <summary>
  12215. Constructs a new instance of this class.
  12216. </summary>
  12217. </member>
  12218. <member name="T:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorResult">
  12219. <summary>
  12220. The result of running the plane Estimator tool.
  12221. </summary>
  12222. </member>
  12223. <member name="T:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorLastRunRecordDiagConstants">
  12224. <summary>
  12225. Enumeration of diagnostic data that can be provided in the
  12226. Tool's LastRunRecord.
  12227. </summary>
  12228. </member>
  12229. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorLastRunRecordDiagConstants.All">
  12230. <summary>
  12231. Include all of the diagnostic data in the LastRunRecord.
  12232. </summary>
  12233. </member>
  12234. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorLastRunRecordDiagConstants.Points">
  12235. <summary>
  12236. Include a copy of the points in the LastRunRecord. When the ZLookupMethod is set to
  12237. Neighborhood or NeighborhoodMedian then a child rectangle
  12238. graphic representing the neighbors will be displayed.
  12239. </summary>
  12240. </member>
  12241. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorLastRunRecordDiagConstants.InputImageMask">
  12242. <summary>
  12243. Include a copy of the input image mask in the LastRunRecord.
  12244. </summary>
  12245. </member>
  12246. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorLastRunRecordDiagConstants.Region">
  12247. <summary>
  12248. Include a copy of the region in the LastRunRecord.
  12249. </summary>
  12250. </member>
  12251. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorLastRunRecordDiagConstants.InputImageDeepCopy">
  12252. <summary>
  12253. Include a deep copy of the input image in the LastRunRecord.
  12254. </summary>
  12255. </member>
  12256. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorLastRunRecordDiagConstants.InputImageByReference">
  12257. <summary>
  12258. Include a reference to the input image in the LastRunRecord.
  12259. </summary>
  12260. </member>
  12261. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorLastRunRecordDiagConstants.None">
  12262. <summary>
  12263. Do not include any of the diagnostic data in the LastRunRecord.
  12264. </summary>
  12265. </member>
  12266. <member name="T:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorLastRunRecordConstants">
  12267. <summary>
  12268. Enumeration of non-diagnostic data that can be provided in
  12269. the Tool's LastRunRecord.
  12270. </summary>
  12271. </member>
  12272. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorLastRunRecordConstants.All">
  12273. <summary>
  12274. Include all of the non-diagnostic data in the LastRunRecord.
  12275. </summary>
  12276. </member>
  12277. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorLastRunRecordConstants.None">
  12278. <summary>
  12279. Do not include any of the non-diagnostic data in the LastRunRecord.
  12280. </summary>
  12281. </member>
  12282. <member name="T:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorCurrentRecordConstants">
  12283. <summary>
  12284. Enumeration of data that can be provided in the Tool's
  12285. CurrentRecord.
  12286. </summary>
  12287. </member>
  12288. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorCurrentRecordConstants.All">
  12289. <summary>
  12290. Include all possible records in the CurrentRecord.
  12291. </summary>
  12292. </member>
  12293. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorCurrentRecordConstants.Points">
  12294. <summary>
  12295. Include a graphic representing the input points in
  12296. the CurrentRecord. When the ZLookupMethod is set to
  12297. Neighborhood or NeighborhoodMedian then a child rectangle
  12298. graphic representing the neighbors will be displayed.
  12299. </summary>
  12300. </member>
  12301. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorCurrentRecordConstants.InputImageMask">
  12302. <summary>
  12303. Include a graphic representing the input image mask in
  12304. the CurrentRecord.
  12305. </summary>
  12306. </member>
  12307. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorCurrentRecordConstants.Region">
  12308. <summary>
  12309. Include the (interactive) region to be used as a mask
  12310. in the CurrentRecord.
  12311. </summary>
  12312. </member>
  12313. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorCurrentRecordConstants.InputImage">
  12314. <summary>
  12315. Include the input image in the CurrentRecord.
  12316. </summary>
  12317. </member>
  12318. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorCurrentRecordConstants.None">
  12319. <summary>
  12320. Do not include any records in the CurrentRecord.
  12321. </summary>
  12322. </member>
  12323. <member name="T:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorFitMethodConstants">
  12324. <summary>
  12325. Constants used to specify how the plane is computed.
  12326. </summary>
  12327. </member>
  12328. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorFitMethodConstants.Area">
  12329. <summary>
  12330. Use the points specified by the region and mask to fit the plane.
  12331. </summary>
  12332. </member>
  12333. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorFitMethodConstants.Points">
  12334. <summary>
  12335. Use the points to fit the plane.
  12336. </summary>
  12337. </member>
  12338. <member name="T:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorZLookupMethodConstants">
  12339. <summary>
  12340. Constants used to specify how z values are
  12341. looked up from a range image.
  12342. </summary>
  12343. </member>
  12344. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorZLookupMethodConstants.Neighborhood">
  12345. <summary>
  12346. All visible pixels inside the neighborhood around each specified
  12347. location are used to estimate the plane. The z value for each pixel is
  12348. looked up using 'singlePixel' mode.
  12349. Only valid when FitMethod is set to Points.
  12350. </summary>
  12351. </member>
  12352. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorZLookupMethodConstants.NeighborhoodMedian">
  12353. <summary>
  12354. the z value is inferred from the median of an NxM neighborhood around each pixel in the range image.
  12355. Only valid when FitMethod is set to Points.
  12356. </summary>
  12357. </member>
  12358. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorZLookupMethodConstants.SinglePixel">
  12359. <summary>
  12360. the z value is inferred from a single pixel in the range image.
  12361. </summary>
  12362. </member>
  12363. <member name="T:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorPlaneDirectionConstants">
  12364. <summary>
  12365. An enumeration that specifies the direction in which the estimated plane's
  12366. normal should point. Note that, regardless of the direction selected, the
  12367. plane is always returned in selected space.
  12368. </summary>
  12369. </member>
  12370. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorPlaneDirectionConstants.NegativePixelSpaceZ">
  12371. <summary>
  12372. The estimated plane's normal (in selected space) is forced to point
  12373. towards the direction that corresponds approximately to the negative z-axis in pixel space
  12374. coordinates, when the plane is mapped to pixel space coordinates.
  12375. </summary>
  12376. </member>
  12377. <member name="F:Cognex.VisionPro3D.Cog3DRangeImagePlaneEstimatorPlaneDirectionConstants.PositivePixelSpaceZ">
  12378. <summary>
  12379. The estimated plane's normal (in selected space) is force to point
  12380. towards the direction that corresponds approximately to the positive z-axis in pixel space
  12381. coordinates, when the plane is mapped to pixel space coordinates.
  12382. </summary>
  12383. </member>
  12384. <member name="M:Cognex.VisionPro3D.Cog3DModelFeatureGeneratorUsingCrsp2D3Ds.GenerateFeaturesModel3D(System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCameraCalibration},System.Collections.Generic.List`1{System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCrsp2D3D}})">
  12385. <summary>
  12386. This static method generates 3D model features from the specified crsp2D3DsForAllPartPoses
  12387. and the specified raw2DFromPhys3Ds.
  12388. </summary>
  12389. <param name="raw2DFromPhys3Ds">
  12390. A List of camera calibration objects. May not be null.
  12391. </param>
  12392. <param name="crsp2D3DsForAllPartPoses">
  12393. <para>
  12394. The List of Lists of 2D feature to 3D model feature correspondences.
  12395. The specified crsp2D3DsForAllPartPoses are indexed as crsp2D3DsForAllPartPoses[partPoseIndex][crspIndex].
  12396. Each crsp2D3D in <paramref name="crsp2D3DsForAllPartPoses" /> should be fully initialized.
  12397. It is OK for the FeatureRaw2D member of some crsp2D3DsForAllPartPoses to be null, indicating that
  12398. no 2D feature was found.
  12399. </para>
  12400. <para>
  12401. If any crsp2D3D in <paramref name="crsp2D3DsForAllPartPoses" />[i][j] and <paramref name="crsp2D3DsForAllPartPoses" />[m][n]
  12402. correspond to the
  12403. same 3D model feature, then <paramref name="crsp2D3DsForAllPartPoses" />[i][j].FeatureModel3DIndex
  12404. must be the same as <paramref name="crsp2D3DsForAllPartPoses" />[m][n].FeatureModel3DIndex,
  12405. and <paramref name="crsp2D3DsForAllPartPoses" />[i][j].FeatureModel3DType
  12406. must be the same as <paramref name="crsp2D3DsForAllPartPoses" />[m][n].FeatureModel3DType.
  12407. </para>
  12408. <para>
  12409. <paramref name="crsp2D3DsForAllPartPoses" />[i][j].PartInstanceIndex must be 0.
  12410. </para>
  12411. </param>
  12412. <returns>
  12413. <para>
  12414. A <see cref="T:Cognex.VisionPro3D.Cog3DModelFeatureGeneratorUsingCrsp2D3DsResults" /> results object
  12415. containing a List of the 3D model features and a List of the pose of the part
  12416. in each part pose.
  12417. The List of part poses in the results object is indexed by part pose index.
  12418. The List of 3D model features is indexed by the FeatureModel3DIndex used in the specified crsp2D3DsForAllPartPoses.
  12419. Thus, the crsp2D3Ds in <paramref name="crsp2D3DsForAllPartPoses" /> with a
  12420. FeatureModel3DIndex of N, were used in the generation of
  12421. (<see cref="T:Cognex.VisionPro3D.Cog3DModelFeatureGeneratorUsingCrsp2D3DsResults" />).GetFeatureModel3DResults()[N].
  12422. </para>
  12423. <para> If
  12424. (<see cref="T:Cognex.VisionPro3D.Cog3DModelFeatureGeneratorUsingCrsp2D3DsResults" />).GetFeatureModel3DResults()[i].IsFound
  12425. is false, it means that there was not enough information in the <paramref name="crsp2D3DsForAllPartPoses" />
  12426. to generate 3D model feature[i].
  12427. </para>
  12428. </returns>
  12429. <exception cref="T:System.ArgumentNullException">
  12430. If any of the input arguments are null, or any input argument includes
  12431. a null item with the exception that the FeatureRaw2D member of a crsp2D3D can be null.
  12432. </exception>
  12433. <exception cref="T:System.ArgumentException">
  12434. <list type="bullet">
  12435. <item> If <paramref name="raw2DFromPhys3Ds" />.Count is less than 2; </item>
  12436. <item>
  12437. If <paramref name="crsp2D3DsForAllPartPoses" />[i] includes duplicate items
  12438. with the same CameraIndex,
  12439. the same PartInstanceIndex, and corresponding to the same model point;
  12440. </item>
  12441. <item> If <paramref name="crsp2D3DsForAllPartPoses" />[i][j].
  12442. PartInstanceIndex is not 0; </item>
  12443. <item> If <paramref name="crsp2D3DsForAllPartPoses" />[i][j].CameraIndex is
  12444. not inside range [0, <paramref name="raw2DFromPhys3Ds" />.Count-1];
  12445. </item>
  12446. <item> If <paramref name="crsp2D3DsForAllPartPoses" />[i][j].FeatureModel3DType
  12447. is not Cog3DVect3, Cog3DLine, Cog3DLineSeg,
  12448. Cog3DCylinder, or Cog3DCircle;
  12449. </item>
  12450. <item> If <paramref name="crsp2D3DsForAllPartPoses" />[i][j].FeatureModel3DType
  12451. is Cog3DVect3, but
  12452. <paramref name="crsp2D3DsForAllPartPoses" />[i][j].Subfeature is not
  12453. Cog3DSubfeatureConstants.Point0; </item>
  12454. <item> If <paramref name="crsp2D3DsForAllPartPoses" />[i][j].FeatureModel3DType
  12455. is Cog3DLine or Cog3DLineSeg, but
  12456. <paramref name="crsp2D3DsForAllPartPoses" />[i][j].Subfeature is not
  12457. Cog3DSubfeatureConstants.StraightEdge0; </item>
  12458. <item> If <paramref name="crsp2D3DsForAllPartPoses" />[i][j].FeatureModel3DType is
  12459. Cog3DCircle, but
  12460. <paramref name="crsp2D3DsForAllPartPoses" />[i][j].Subfeature is not
  12461. Cog3DSubfeatureConstants.CircleEdge0 or Cog3DSubfeatureConstants.Point0; </item>
  12462. <item> If <paramref name="crsp2D3DsForAllPartPoses" />[i][j].FeatureModel3DType is
  12463. Cog3DCylinder, but
  12464. <paramref name="crsp2D3DsForAllPartPoses" />[i][j].Subfeature is not
  12465. Cog3DSubfeatureConstants.OccludingEdge0, .OccludingEdge1, .CircularEdge0,
  12466. or .CircularEdge1; </item>
  12467. <item> If <paramref name="crsp2D3DsForAllPartPoses" />[i][j].FeatureRaw2D
  12468. is not null, and its type is not Cog3DVect2, or Cog3DVect2Collection;
  12469. </item>
  12470. <item> If <paramref name="crsp2D3DsForAllPartPoses" />[i][j].FeatureModel3DType
  12471. is Cog3DVect3,
  12472. <paramref name="crsp2D3DsForAllPartPoses" />[i][j].FeatureRaw2D
  12473. has type of Cog3DVect2Collection, and its size is greater than 1.
  12474. </item>
  12475. </list>
  12476. </exception>
  12477. <remarks>
  12478. <para>
  12479. The <paramref name="crsp2D3DsForAllPartPoses" /> should be created by
  12480. placing a single part under your cameras and simultaneously acquiring images
  12481. of the one part from all the cameras. This set of images constitutes a
  12482. "part pose". You should create several part poses of your part,
  12483. see the Best Practices listed below for details. Providing multiple
  12484. part poses improves the accuracy of the generated 3D model features.
  12485. </para>
  12486. <para>
  12487. After collecting the part poses (sets of images of the part), you need to extract
  12488. the crsp2D3Ds from each of them. For each part pose, extract the crsp2D3Ds from
  12489. the images of the part pose and put them into a List.
  12490. The List of crsp2D3Ds from each part pose is then placed in another List thereby creating
  12491. <paramref name="crsp2D3DsForAllPartPoses" /> which
  12492. is indexed as <paramref name="crsp2D3DsForAllPartPoses" />[partPoseIndex][crspIndex].
  12493. </para>
  12494. <para>
  12495. The 3D model features in the returned results object are in the Model3D coordinate space.
  12496. The Model3D coordinate space is defined in part pose 0 or <paramref name="crsp2D3DsForAllPartPoses" />[0]
  12497. i.e. the pose of the Phys3D origin in part pose 0 will be used to define the origin
  12498. of the part's 3D coordinate space - Model3D. Thus, the pose of the part (the transform
  12499. from Model3D space to Phys3D space) in <paramref name="crsp2D3DsForAllPartPoses" />[0]
  12500. is the identity transform.
  12501. </para>
  12502. <para>
  12503. If <paramref name="crsp2D3DsForAllPartPoses" />[i][j].FeatureRaw2D is null or empty,
  12504. then <paramref name="crsp2D3DsForAllPartPoses" />[i][j] is ignored
  12505. during model feature generation.
  12506. </para>
  12507. <para>
  12508. All the specified camera calibrations must refer to the same Phys3D coordinate space.
  12509. </para>
  12510. <para>
  12511. Best Practices for Generating 3D Model Features:
  12512. </para>
  12513. <list type="bullet">
  12514. <item>
  12515. The FOV must contain a single part.
  12516. </item>
  12517. <item>
  12518. Use the 5 part poses described below when creating <paramref name="crsp2D3DsForAllPartPoses" />.
  12519. <list type="bullet"><item>
  12520. Pose 0: Place the part as close as possible to the origin of Phys3D, use a z rotation of 0 degrees. Note that
  12521. the origin of the Model3D coordinate space (the coordinate space all your 3D model features are defined in) is defined
  12522. by the Phys3D origin in this pose.
  12523. </item><item>
  12524. Pose 1: Place the part in the upper left corner of FOV visible by both cameras, use a z rotation of ~20 degrees.
  12525. </item><item>
  12526. Pose 2: Place the part in the upper right corner of FOV visible by both cameras, use a z rotation of ~45 degrees.
  12527. </item><item>
  12528. Pose 3: Place the part in the lower left corner of FOV visible by both cameras, use a z rotation of ~67 degrees.
  12529. </item><item>
  12530. Pose 4: Place the part in the lower right corner of FOV visible by both cameras, use a z rotation of ~90 degrees.
  12531. </item></list></item>
  12532. <item>
  12533. Verify the IsFound and the residuals in GetFeatureModel3DResults() from the returned results object are acceptable for your 3D model.
  12534. </item>
  12535. </list>
  12536. </remarks>
  12537. </member>
  12538. <member name="T:Cognex.VisionPro3D.Cog3DModelFeatureGeneratorUsingCrsp2D3Ds">
  12539. <summary>
  12540. This class provides 3D model feature generation using crsp2D3Ds
  12541. and camera calibrations. Use this class to generate the 3D features
  12542. in your 3D model.
  12543. </summary>
  12544. </member>
  12545. <member name="M:Cognex.VisionPro3D.Cog3DModelFeatureGeneratorUsingCrsp2D3DsResults.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  12546. <inheritdoc cref="!:ICog3DBase::SerializationConstructor" />
  12547. </member>
  12548. <member name="M:Cognex.VisionPro3D.Cog3DModelFeatureGeneratorUsingCrsp2D3DsResults.ToString">
  12549. <inheritdoc cref="!:ICog3DBase::ToString" />
  12550. </member>
  12551. <member name="M:Cognex.VisionPro3D.Cog3DModelFeatureGeneratorUsingCrsp2D3DsResults.GetPoseResults">
  12552. <summary>
  12553. Gets a deep copy of the pose results for all the part poses used in 3D model feature generation,
  12554. indexed by part pose.
  12555. </summary>
  12556. <returns>
  12557. A deep copy of the pose results for all the part poses.
  12558. </returns>
  12559. </member>
  12560. <member name="M:Cognex.VisionPro3D.Cog3DModelFeatureGeneratorUsingCrsp2D3DsResults.GetFeatureModel3DResults">
  12561. <summary>
  12562. Gets a deep copy of the generated 3D model feature results, indexed by FeatureModel3DIndex.
  12563. </summary>
  12564. <returns>
  12565. A deep copy of the generated 3D model feature results.
  12566. </returns>
  12567. </member>
  12568. <member name="M:Cognex.VisionPro3D.Cog3DModelFeatureGeneratorUsingCrsp2D3DsResults.Finalize">
  12569. <inheritdoc cref="!:ICog3DBase::FinalizerForThisClass" />
  12570. </member>
  12571. <member name="M:Cognex.VisionPro3D.Cog3DModelFeatureGeneratorUsingCrsp2D3DsResults.Dispose">
  12572. <inheritdoc cref="!:ICog3DBase::DestructorForThisClass" />
  12573. </member>
  12574. <member name="M:Cognex.VisionPro3D.Cog3DModelFeatureGeneratorUsingCrsp2D3DsResults.#ctor(Cognex.VisionPro3D.Cog3DModelFeatureGeneratorUsingCrsp2D3DsResults)">
  12575. <inheritdoc cref="!:ICog3DBase::DeepCopyConstructorForThisClass" />
  12576. </member>
  12577. <member name="T:Cognex.VisionPro3D.Cog3DModelFeatureGeneratorUsingCrsp2D3DsResults">
  12578. <summary>
  12579. This class holds the results from a 3D model feature generation operation.
  12580. Note that this class is immutable - it may not be changed once
  12581. it has been constructed. The usage model for this class is that it
  12582. gets factoried by the Cog3DModelFeatureGeneratorUsingCrsp2D3Ds class.
  12583. </summary>
  12584. </member>
  12585. <member name="M:Cognex.VisionPro3D.Cog3DModelFeatureGeneratorUsingCrsp2D3DsResult.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  12586. <inheritdoc cref="!:ICog3DBase::SerializationConstructor" />
  12587. </member>
  12588. <member name="M:Cognex.VisionPro3D.Cog3DModelFeatureGeneratorUsingCrsp2D3DsResult.RealEqual(Cognex.VisionPro3D.Cog3DModelFeatureGeneratorUsingCrsp2D3DsResult,Cognex.VisionPro3D.Cog3DModelFeatureGeneratorUsingCrsp2D3DsResult,System.Double)">
  12589. <inheritdoc cref="!:ICog3DBase::RealEqual" />
  12590. </member>
  12591. <member name="M:Cognex.VisionPro3D.Cog3DModelFeatureGeneratorUsingCrsp2D3DsResult.ToString">
  12592. <inheritdoc cref="!:ICog3DBase::ToString" />
  12593. </member>
  12594. <member name="M:Cognex.VisionPro3D.Cog3DModelFeatureGeneratorUsingCrsp2D3DsResult.GetResidualsPhys3D">
  12595. <summary>
  12596. Gets the List of Phys3D residual statistics for this 3D model feature result
  12597. indexed by part pose.
  12598. </summary>
  12599. <exception cref="T:Cognex.VisionPro3D.Cog3DException">
  12600. If IsFound is false.
  12601. </exception>
  12602. <value>
  12603. The List of residual statistics of this result in Phys3D space for all the part poses.
  12604. </value>
  12605. <inheritdoc cref="!:ICog3DBase::TriangulatorOrModelGenerator" />
  12606. </member>
  12607. <member name="M:Cognex.VisionPro3D.Cog3DModelFeatureGeneratorUsingCrsp2D3DsResult.GetResidualsRaw2D">
  12608. <summary>
  12609. Gets the List of Raw2D residual statistics for this 3D model feature result
  12610. indexed by part pose.
  12611. </summary>
  12612. <exception cref="T:Cognex.VisionPro3D.Cog3DException">
  12613. If IsFound is false.
  12614. </exception>
  12615. <value>
  12616. The List of residual statistics of this 3D model feature result in Raw2D space for all the part poses.
  12617. </value>
  12618. <inheritdoc cref="!:ICog3DBase::TriangulatorOrModelGenerator" />
  12619. </member>
  12620. <member name="M:Cognex.VisionPro3D.Cog3DModelFeatureGeneratorUsingCrsp2D3DsResult.GetResidualsValid">
  12621. <summary>
  12622. Gets a deep copy of the flags indicating which residuals are valid.
  12623. Indexed by part pose.
  12624. </summary>
  12625. <returns>
  12626. A deep copy of the flags indicating which residuals are valid.
  12627. </returns>
  12628. <exception cref="T:Cognex.VisionPro3D.Cog3DException">
  12629. If IsFound is false.
  12630. </exception>
  12631. <remarks>
  12632. <para>
  12633. The returned List ResidualsValid indicates whether or not the 2D features
  12634. from a part pose contributed to the generation of this 3D model feature.
  12635. If ResidualsValid[i] is true, it means part pose[i] had 2D features
  12636. used in generating this 3D feature, and ResidualsRaw2D[i] and
  12637. ResidualsPhys3D[i] are valid.
  12638. If ResidualsValid[i] is false, it means 2D features from part pose[i] were not used
  12639. in generating this 3D model feature, and ResidualsRaw2D[i] and
  12640. ResidualsPhys3D[i] are not valid.
  12641. </para>
  12642. </remarks>
  12643. </member>
  12644. <member name="M:Cognex.VisionPro3D.Cog3DModelFeatureGeneratorUsingCrsp2D3DsResult.GetFeatureModel3D">
  12645. <summary>
  12646. Gets a deep copy of the generated 3D model feature.
  12647. </summary>
  12648. <returns>
  12649. Deep copy of the generated 3D model feature.
  12650. </returns>
  12651. <exception cref="T:Cognex.VisionPro3D.Cog3DException">
  12652. If IsFound is false.
  12653. </exception>
  12654. <remarks>
  12655. The return object type will be one of
  12656. Cog3DVect3,
  12657. Cog3DCircle, Cog3DLine, Cog3DLineSeg, or Cog3DCylinder.
  12658. </remarks>
  12659. </member>
  12660. <member name="P:Cognex.VisionPro3D.Cog3DModelFeatureGeneratorUsingCrsp2D3DsResult.FeatureModel3DIndex">
  12661. <summary>
  12662. Gets the 3D model feature index of this 3D feature within the List of 3D model features.
  12663. </summary>
  12664. <value>
  12665. The 3D model feature index, which is the same as FeatureModel3DIndex in the
  12666. crsp2D3Ds used for this 3D model feature generation.
  12667. </value>
  12668. </member>
  12669. <member name="P:Cognex.VisionPro3D.Cog3DModelFeatureGeneratorUsingCrsp2D3DsResult.IsFound">
  12670. <summary>
  12671. Gets whether or not this 3D model feature was found.
  12672. </summary>
  12673. <value>
  12674. True if this 3D model feature was found; false otherwise.
  12675. </value>
  12676. </member>
  12677. <member name="M:Cognex.VisionPro3D.Cog3DModelFeatureGeneratorUsingCrsp2D3DsResult.Finalize">
  12678. <inheritdoc cref="!:ICog3DBase::FinalizerForThisClass" />
  12679. </member>
  12680. <member name="M:Cognex.VisionPro3D.Cog3DModelFeatureGeneratorUsingCrsp2D3DsResult.Dispose">
  12681. <inheritdoc cref="!:ICog3DBase::DestructorForThisClass" />
  12682. </member>
  12683. <member name="M:Cognex.VisionPro3D.Cog3DModelFeatureGeneratorUsingCrsp2D3DsResult.#ctor(Cognex.VisionPro3D.Cog3DModelFeatureGeneratorUsingCrsp2D3DsResult)">
  12684. <inheritdoc cref="!:ICog3DBase::DeepCopyConstructorForThisClass" />
  12685. </member>
  12686. <member name="T:Cognex.VisionPro3D.Cog3DModelFeatureGeneratorUsingCrsp2D3DsResult">
  12687. <summary>
  12688. This class holds one 3D model feature result from a 3D model feature generation operation.
  12689. This class is immutable - it may not be changed once
  12690. it has been constructed. The usage model for this class is that it
  12691. gets factoried by the Cog3DModelFeatureGeneratorUsingCrsp2D3Ds class.
  12692. </summary>
  12693. </member>
  12694. <member name="M:Cognex.VisionPro3D.Cog3DPoseEstimatorUsingCrsp2D3Ds.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  12695. <inheritdoc cref="!:ICog3DBase::SerializationConstructor" />
  12696. </member>
  12697. <member name="M:Cognex.VisionPro3D.Cog3DPoseEstimatorUsingCrsp2D3Ds.RefinePoseUsingAllCrsp2D3Ds(System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCameraCalibration},System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCrsp2D3D},System.Int32,Cognex.VisionPro3D.Cog3DTransformRigid)">
  12698. <summary>
  12699. This method performs a 3D pose refinement based on an initial pose,
  12700. the specified crsp2D3DsUnified,
  12701. and the specified
  12702. camera calibrations, from one or multiple cameras/views. Note that this method
  12703. uses all the input features.
  12704. </summary>
  12705. <param name="initialPhys3DFromModel3D">
  12706. An initial estimation for the pose. May not be NULL.
  12707. </param>
  12708. <returns>
  12709. The refined 3D pose result. The pose maps
  12710. point/shape features from Model3D space to Phys3D space.
  12711. </returns>
  12712. <param name="raw2DFromPhys3Ds">
  12713. A List of camera calibrations. One calibration per camera/view.
  12714. The size of this list specifies the number of cameras/views.
  12715. May not be null.
  12716. </param>
  12717. <param name="crsp2D3DsUnified">
  12718. <para>
  12719. A List of crsp2D3Ds. May not be null. Note that
  12720. each item has the camera index, the index of the part instance,
  12721. the 2D feature(s), the corresponding 3D feature index,
  12722. and sub-feature type.
  12723. </para>
  12724. <para>
  12725. Note that when there is multiple part instances, the PartInstanceIndex
  12726. of <paramref name="crsp2D3DsUnified" />
  12727. must be unified for all cameras by calling part corresponder
  12728. (<see cref="M:Cognex.VisionPro3D.Cog3DPartCorresponderUsingCrsp2D3Ds.CorrespondPartsUsingPointsAndIntersectionPoints(System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCameraCalibration},System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCrsp2D3D},System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCrsp2D3D}@)">
  12729. Cog3DPartCorresponderUsingCrsp2D3Ds.Execute </see>).
  12730. Therefore, for the same 3D part instance, the same PartInstanceIndex
  12731. is used for the corresponding crsp2D3Ds items across all cameras.
  12732. </para>
  12733. <para>
  12734. If there is only one part instance, and the PartInstanceIndex
  12735. is 0 for all items of crsp2D3Ds, then no need to call part corresponder.
  12736. </para>
  12737. <para> Note that if <paramref name="crsp2D3DsUnified" />[i].FeatureRaw2D
  12738. is null or empty,
  12739. then <paramref name="crsp2D3DsUnified" />[i] is ignored
  12740. during pose estimation.
  12741. </para>
  12742. </param>
  12743. <param name="partInstanceIndex">
  12744. This parameter specifies which part instance to run the pose estimation.
  12745. If <paramref name="crsp2D3DsUnified" />[i].PartInstanceIndex is not equal to
  12746. <paramref name="partInstanceIndex" />, then that
  12747. <paramref name="crsp2D3DsUnified" /> element is not used in
  12748. the pose estimation.
  12749. </param>
  12750. <exception cref="T:System.ArgumentNullException">
  12751. If any of the arguments (except <paramref name="partInstanceIndex" />) is null,
  12752. or any input argument includes null item, or
  12753. FeaturesModel3D[<paramref name="crsp2D3DsUnified" />[i].FeatureModel3DIndex]
  12754. is null.
  12755. </exception>
  12756. <exception cref="T:System.ArgumentException">
  12757. <list type="bullet">
  12758. <item> If <paramref name="raw2DFromPhys3Ds" />.Count == 0; </item>
  12759. <item>
  12760. if <paramref name="raw2DFromPhys3Ds" />.Count is 1, and
  12761. <paramref name="raw2DFromPhys3Ds" />[0].IsTelecentric is true .
  12762. </item>
  12763. <item> If <paramref name="partInstanceIndex" /> is less than 0; </item>
  12764. <item> If <paramref name="crsp2D3DsUnified" />[i].CameraIndex is
  12765. not inside range [0, <paramref name="raw2DFromPhys3Ds" />.Count-1];
  12766. </item>
  12767. <item> If <paramref name="crsp2D3DsUnified" />[i].FeatureModel3DType
  12768. is not Cog3DVect3, Cog3DLine, Cog3DLineSeg,
  12769. Cog3DCylinder, or Cog3DCircle;
  12770. </item>
  12771. <item> If <paramref name="crsp2D3DsUnified" />[i].FeatureModel3DType
  12772. is Cog3DVect3, but
  12773. <paramref name="crsp2D3DsUnified" />[i].Subfeature is not
  12774. Cog3DSubfeatureConstants.Point0; </item>
  12775. <item> If <paramref name="crsp2D3DsUnified" />[i].FeatureModel3DType
  12776. is Cog3DLine or Cog3DLineSeg, but
  12777. <paramref name="crsp2D3DsUnified" />[i].Subfeature is not
  12778. Cog3DSubfeatureConstants.StraightEdge0; </item>
  12779. <item> If <paramref name="crsp2D3DsUnified" />[i].FeatureModel3DType is
  12780. Cog3DCircle, but
  12781. <paramref name="crsp2D3DsUnified" />[i].Subfeature is not
  12782. Cog3DSubfeatureConstants.CircleEdge0 or Cog3DSubfeatureConstants.Point0; </item>
  12783. <item> If <paramref name="crsp2D3DsUnified" />[i].FeatureModel3DType is
  12784. Cog3DCylinder, but
  12785. <paramref name="crsp2D3DsUnified" />[i].Subfeature is not
  12786. Cog3DSubfeatureConstants.OccludingEdge0, .OccludingEdge1, .CircularEdge0,
  12787. or .CircularEdge1; </item>
  12788. <item> If <paramref name="crsp2D3DsUnified" />[i].FeatureRaw2D
  12789. is not null, and its type is not Cog3DVect2, or Cog3DVect2Collection;
  12790. </item>
  12791. <item> If <paramref name="crsp2D3DsUnified" />[i].FeatureModel3DType
  12792. is Cog3DVect3,
  12793. <paramref name="crsp2D3DsUnified" />[i].FeatureRaw2D
  12794. has type of Cog3DVect2Collection, and its size is greater than 1.
  12795. </item>
  12796. <item> If <paramref name="crsp2D3DsUnified" />[i].FeatureModel3DIndex is
  12797. not inside range [0, FeaturesModel3D.Count-1];
  12798. </item>
  12799. <item> If <paramref name="crsp2D3DsUnified" />[i].FeatureModel3DType is not
  12800. the same as the type of
  12801. FeaturesModel3D[<paramref name="crsp2D3DsUnified" />[i].FeatureModel3DIndex];
  12802. </item>
  12803. </list>
  12804. </exception>
  12805. <remarks>
  12806. <para>
  12807. Note that this method handles a single part instance.
  12808. Therefore, all 2D features with the specified
  12809. <paramref name="partInstanceIndex" />
  12810. in <paramref name="crsp2D3DsUnified" /> must correspond to the same
  12811. part instance.
  12812. </para>
  12813. <para>
  12814. Note that if 3D line segment model features are used, and some 3D line
  12815. segments are shorter than the actual lengths, then it may return result(s)
  12816. with larger residuals. Dilating the 3D line segments
  12817. may avoid this problem.
  12818. </para>
  12819. </remarks>
  12820. </member>
  12821. <member name="M:Cognex.VisionPro3D.Cog3DPoseEstimatorUsingCrsp2D3Ds.EstimatePoseUsingInlierCrsp2D3Ds(System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCameraCalibration},System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCrsp2D3D},System.Int32,Cognex.VisionPro3D.Cog3DRobustPoseEstimationParametersSimple)">
  12822. <summary>
  12823. This method performs a 3D robust pose estimation for one part instance based on
  12824. the specified crsp2D3DsUnified, and the specified
  12825. camera calibrations, from one or multiple cameras/views. Note that
  12826. robust pose estimation parameters are used, and the returned result
  12827. includes information about feature outliers.
  12828. </summary>
  12829. <param name="robustPoseEstimationParamsSimple">
  12830. Simple parameters to specify the behavior of the robust pose estimation.
  12831. May not be null.
  12832. </param>
  12833. <returns>
  12834. The pose estimation result (<see cref="T:Cognex.VisionPro3D.Cog3DPoseEstimatorUsingCrsp2D3DsResult" />).
  12835. A pose estimation result is always returned
  12836. except when a throw occurs. The pose estimation result contains a list of
  12837. pose results (<see cref="M:Cognex.VisionPro3D.Cog3DPoseEstimatorUsingCrsp2D3DsResult.GetPoseResults" />)
  12838. and the list of crsp2D3D indices of the outliers
  12839. (<see cref="M:Cognex.VisionPro3D.Cog3DPoseEstimatorUsingCrsp2D3DsResult.GetIndicesOfOutlierCrsp2D3Ds" />) .
  12840. The pose in each pose result maps features from Model3D space to Phys3D space.
  12841. A list of pose results is returned in order to handle the situation where there
  12842. are multiple pose estimations for the available features.
  12843. The list of pose results will contain:
  12844. <list type="bullet"><item> 0 pose results, when no poses were found to meet the estimation parameters;
  12845. </item><item> 1 pose result, when there was a single pose that met the estimation parameters;
  12846. </item><item> &gt; 1 pose results, when there were multiple poses that satisfied the estimation
  12847. parameters
  12848. </item></list><para>
  12849. Note that the returned object of <see cref="T:Cognex.VisionPro3D.Cog3DPoseEstimatorUsingCrsp2D3DsResult" />
  12850. has properties
  12851. <see cref="P:Cognex.VisionPro3D.Cog3DPoseEstimatorUsingCrsp2D3DsResult.PartInstanceIndex" /> and
  12852. <see cref="P:Cognex.VisionPro3D.Cog3DPoseEstimatorUsingCrsp2D3DsResult.Message" />:
  12853. </para><para><see cref="P:Cognex.VisionPro3D.Cog3DPoseEstimatorUsingCrsp2D3DsResult.PartInstanceIndex" />
  12854. is the same as the input argument <paramref name="partInstanceIndex" />, and can
  12855. be used to correspond pose estimation results and part instances.
  12856. </para><para><see cref="P:Cognex.VisionPro3D.Cog3DPoseEstimatorUsingCrsp2D3DsResult.Message" /> is NULL if pose results
  12857. <see cref="M:Cognex.VisionPro3D.Cog3DPoseEstimatorUsingCrsp2D3DsResult.GetPoseResults" />
  12858. in the returned object is not empty; Otherwise,
  12859. <see cref="P:Cognex.VisionPro3D.Cog3DPoseEstimatorUsingCrsp2D3DsResult.Message" /> contains
  12860. diagnosis information about why the pose results in the returned object is empty.
  12861. </para></returns>
  12862. <param name="raw2DFromPhys3Ds">
  12863. A List of camera calibrations. One calibration per camera/view.
  12864. The size of this list specifies the number of cameras/views.
  12865. May not be null.
  12866. </param>
  12867. <param name="crsp2D3DsUnified">
  12868. <para>
  12869. A List of crsp2D3Ds. May not be null. Note that
  12870. each item has the camera index, the index of the part instance,
  12871. the 2D feature(s), the corresponding 3D feature index,
  12872. and sub-feature type.
  12873. </para>
  12874. <para>
  12875. Note that when there is multiple part instances, the PartInstanceIndex
  12876. of <paramref name="crsp2D3DsUnified" />
  12877. must be unified for all cameras by calling part corresponder
  12878. (<see cref="M:Cognex.VisionPro3D.Cog3DPartCorresponderUsingCrsp2D3Ds.CorrespondPartsUsingPointsAndIntersectionPoints(System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCameraCalibration},System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCrsp2D3D},System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCrsp2D3D}@)">
  12879. Cog3DPartCorresponderUsingCrsp2D3Ds.Execute </see>).
  12880. Therefore, for the same 3D part instance, the same PartInstanceIndex
  12881. is used for the corresponding crsp2D3Ds items across all cameras.
  12882. </para>
  12883. <para>
  12884. If there is only one part instance, and the PartInstanceIndex
  12885. is 0 for all items of crsp2D3Ds, then no need to call part corresponder.
  12886. </para>
  12887. <para> Note that if <paramref name="crsp2D3DsUnified" />[i].FeatureRaw2D
  12888. is null or empty,
  12889. then <paramref name="crsp2D3DsUnified" />[i] is ignored
  12890. during pose estimation.
  12891. </para>
  12892. </param>
  12893. <param name="partInstanceIndex">
  12894. This parameter specifies which part instance to run the pose estimation.
  12895. If <paramref name="crsp2D3DsUnified" />[i].PartInstanceIndex is not equal to
  12896. <paramref name="partInstanceIndex" />, then that
  12897. <paramref name="crsp2D3DsUnified" /> element is not used in
  12898. the pose estimation.
  12899. </param>
  12900. <exception cref="T:System.ArgumentNullException">
  12901. If any of the arguments (except <paramref name="partInstanceIndex" />) is null,
  12902. or any input argument includes null item, or
  12903. FeaturesModel3D[<paramref name="crsp2D3DsUnified" />[i].FeatureModel3DIndex]
  12904. is null.
  12905. </exception>
  12906. <exception cref="T:System.ArgumentException">
  12907. <list type="bullet">
  12908. <item> If <paramref name="raw2DFromPhys3Ds" />.Count == 0; </item>
  12909. <item>
  12910. if <paramref name="raw2DFromPhys3Ds" />.Count is 1, and
  12911. <paramref name="raw2DFromPhys3Ds" />[0].IsTelecentric is true .
  12912. </item>
  12913. <item> If <paramref name="partInstanceIndex" /> is less than 0; </item>
  12914. <item> If <paramref name="crsp2D3DsUnified" />[i].CameraIndex is
  12915. not inside range [0, <paramref name="raw2DFromPhys3Ds" />.Count-1];
  12916. </item>
  12917. <item> If <paramref name="crsp2D3DsUnified" />[i].FeatureModel3DType
  12918. is not Cog3DVect3, Cog3DLine, Cog3DLineSeg,
  12919. Cog3DCylinder, or Cog3DCircle;
  12920. </item>
  12921. <item> If <paramref name="crsp2D3DsUnified" />[i].FeatureModel3DType
  12922. is Cog3DVect3, but
  12923. <paramref name="crsp2D3DsUnified" />[i].Subfeature is not
  12924. Cog3DSubfeatureConstants.Point0; </item>
  12925. <item> If <paramref name="crsp2D3DsUnified" />[i].FeatureModel3DType
  12926. is Cog3DLine or Cog3DLineSeg, but
  12927. <paramref name="crsp2D3DsUnified" />[i].Subfeature is not
  12928. Cog3DSubfeatureConstants.StraightEdge0; </item>
  12929. <item> If <paramref name="crsp2D3DsUnified" />[i].FeatureModel3DType is
  12930. Cog3DCircle, but
  12931. <paramref name="crsp2D3DsUnified" />[i].Subfeature is not
  12932. Cog3DSubfeatureConstants.CircleEdge0 or Cog3DSubfeatureConstants.Point0; </item>
  12933. <item> If <paramref name="crsp2D3DsUnified" />[i].FeatureModel3DType is
  12934. Cog3DCylinder, but
  12935. <paramref name="crsp2D3DsUnified" />[i].Subfeature is not
  12936. Cog3DSubfeatureConstants.OccludingEdge0, .OccludingEdge1, .CircularEdge0,
  12937. or .CircularEdge1; </item>
  12938. <item> If <paramref name="crsp2D3DsUnified" />[i].FeatureRaw2D
  12939. is not null, and its type is not Cog3DVect2, or Cog3DVect2Collection;
  12940. </item>
  12941. <item> If <paramref name="crsp2D3DsUnified" />[i].FeatureModel3DType
  12942. is Cog3DVect3,
  12943. <paramref name="crsp2D3DsUnified" />[i].FeatureRaw2D
  12944. has type of Cog3DVect2Collection, and its size is greater than 1.
  12945. </item>
  12946. <item> If <paramref name="crsp2D3DsUnified" />[i].FeatureModel3DIndex is
  12947. not inside range [0, FeaturesModel3D.Count-1];
  12948. </item>
  12949. <item> If <paramref name="crsp2D3DsUnified" />[i].FeatureModel3DType is not
  12950. the same as the type of
  12951. FeaturesModel3D[<paramref name="crsp2D3DsUnified" />[i].FeatureModel3DIndex];
  12952. </item>
  12953. </list>
  12954. </exception>
  12955. <remarks>
  12956. <para>
  12957. Note that this method handles a single part instance.
  12958. Therefore, all 2D features with the specified
  12959. <paramref name="partInstanceIndex" />
  12960. in <paramref name="crsp2D3DsUnified" /> must correspond to the same
  12961. part instance.
  12962. </para>
  12963. <para>
  12964. Note that if 3D line segment model features are used, and some 3D line
  12965. segments are shorter than the actual lengths, then it may return result(s)
  12966. with larger residuals. Dilating the 3D line segments
  12967. may avoid this problem.
  12968. </para>
  12969. <para>
  12970. Note that this method might return multiple different poses with similar fitting residuals.
  12971. If the returned result has a list of multiple pose results, it means not enough
  12972. information in <paramref name="crsp2D3DsUnified" /> to get a unique pose for the specified part instance.
  12973. Pose ambiguities can be avoided by adding more feature correspondences.
  12974. </para>
  12975. <para>
  12976. The following is a list of situations that satisfy the requirements for
  12977. estimating a pose. Note that under some of these situations there may
  12978. be multiple poses with equivalent fitting residuals:
  12979. <list type="bullet"><item> There are 3 or more point correspondences; </item><item> There are 3 or more intersection points among 3D model lines or
  12980. line segments;</item><item> There are 3 or more model circles; </item><item> There are 2 or more non-parallel model cylinders;
  12981. </item><item> The combination of number of point correspondences, number of
  12982. intersection points among 3D model lines or line segments,
  12983. and number of model circles, is 3 or more; </item><item> There are 2 or more nonparallel model lines or line segments
  12984. observed simultaneously by two or more cameras; </item><item> There are 2 or more model circles observed simultaneously
  12985. by two or more cameras;</item><item> There are one or more model points, and one or more model circles
  12986. observed simultaneously by two or more cameras;</item><item> There are one or more model points, and one or more model lines
  12987. or line segments observed simultaneously by two or more cameras; </item><item> There are one or more model points, and one or more model
  12988. cylinders observed simultaneously by two or more cameras; </item><item> There are one or more model lines or line segments, and one or
  12989. more model circles observed simultaneously by two or more cameras;
  12990. </item><item> There are one or more model cylinders, and one or more model
  12991. circles observed simultaneously by two or more cameras; </item><item> There are one or more model cylinders, and one or more model
  12992. lines or line segments (not parallel to the cylinder's axis) observed
  12993. simultaneously by two or more cameras. </item></list></para>
  12994. <para>
  12995. Note that the returned result might have an empty list of pose results,
  12996. if it can not find any pose satisfying the requirements
  12997. specified by the robust pose estimation parameters.
  12998. </para>
  12999. </remarks>
  13000. </member>
  13001. <member name="M:Cognex.VisionPro3D.Cog3DPoseEstimatorUsingCrsp2D3Ds.EstimatePoseUsingAllCrsp2D3Ds(System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCameraCalibration},System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCrsp2D3D},System.Int32)">
  13002. <summary>
  13003. This method performs a 3D pose estimation for one part instance based on the specified
  13004. crsp2D3DsUnified and the specified camera calibrations, from one or multiple cameras/views.
  13005. </summary>
  13006. <returns>
  13007. The pose estimation result (<see cref="T:Cognex.VisionPro3D.Cog3DPoseEstimatorUsingCrsp2D3DsResult" />).
  13008. A pose estimation result is always returned
  13009. except when a throw occurs. The pose estimation result contains a list of
  13010. pose results (<see cref="M:Cognex.VisionPro3D.Cog3DPoseEstimatorUsingCrsp2D3DsResult.GetPoseResults" />)
  13011. and the list of crsp2D3D indices of the outliers
  13012. (<see cref="M:Cognex.VisionPro3D.Cog3DPoseEstimatorUsingCrsp2D3DsResult.GetIndicesOfOutlierCrsp2D3Ds" />).
  13013. The list of outliers is empty because this method does not remove outliers.
  13014. The pose in each pose result maps features from Model3D space to Phys3D space.
  13015. A list of pose results is returned in order to handle the situation where there
  13016. are multiple pose estimations for the available features.
  13017. The list of pose results will contain:
  13018. <list type="bullet"><item> 0 pose results, when no poses were found to meet the estimation parameters;
  13019. </item><item> 1 pose result, when there was a single pose that met the estimation parameters;
  13020. </item><item> &gt; 1 pose results, when there were multiple poses that satisfied the estimation
  13021. parameters
  13022. </item></list><para>
  13023. Note that the returned object of <see cref="T:Cognex.VisionPro3D.Cog3DPoseEstimatorUsingCrsp2D3DsResult" />
  13024. has properties
  13025. <see cref="P:Cognex.VisionPro3D.Cog3DPoseEstimatorUsingCrsp2D3DsResult.PartInstanceIndex" /> and
  13026. <see cref="P:Cognex.VisionPro3D.Cog3DPoseEstimatorUsingCrsp2D3DsResult.Message" />:
  13027. </para><para><see cref="P:Cognex.VisionPro3D.Cog3DPoseEstimatorUsingCrsp2D3DsResult.PartInstanceIndex" />
  13028. is the same as the input argument <paramref name="partInstanceIndex" />, and can
  13029. be used to correspond pose estimation results and part instances.
  13030. </para><para><see cref="P:Cognex.VisionPro3D.Cog3DPoseEstimatorUsingCrsp2D3DsResult.Message" /> is NULL if pose results
  13031. (<see cref="M:Cognex.VisionPro3D.Cog3DPoseEstimatorUsingCrsp2D3DsResult.GetPoseResults" />)
  13032. in the returned object is not empty; Otherwise,
  13033. <see cref="P:Cognex.VisionPro3D.Cog3DPoseEstimatorUsingCrsp2D3DsResult.Message" /> contains
  13034. diagnosis information about why the pose results in the returned object is empty.
  13035. </para></returns>
  13036. <param name="raw2DFromPhys3Ds">
  13037. A List of camera calibrations. One calibration per camera/view.
  13038. The size of this list specifies the number of cameras/views.
  13039. May not be null.
  13040. </param>
  13041. <param name="crsp2D3DsUnified">
  13042. <para>
  13043. A List of crsp2D3Ds. May not be null. Note that
  13044. each item has the camera index, the index of the part instance,
  13045. the 2D feature(s), the corresponding 3D feature index,
  13046. and sub-feature type.
  13047. </para>
  13048. <para>
  13049. Note that when there is multiple part instances, the PartInstanceIndex
  13050. of <paramref name="crsp2D3DsUnified" />
  13051. must be unified for all cameras by calling part corresponder
  13052. (<see cref="M:Cognex.VisionPro3D.Cog3DPartCorresponderUsingCrsp2D3Ds.CorrespondPartsUsingPointsAndIntersectionPoints(System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCameraCalibration},System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCrsp2D3D},System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCrsp2D3D}@)">
  13053. Cog3DPartCorresponderUsingCrsp2D3Ds.Execute </see>).
  13054. Therefore, for the same 3D part instance, the same PartInstanceIndex
  13055. is used for the corresponding crsp2D3Ds items across all cameras.
  13056. </para>
  13057. <para>
  13058. If there is only one part instance, and the PartInstanceIndex
  13059. is 0 for all items of crsp2D3Ds, then no need to call part corresponder.
  13060. </para>
  13061. <para> Note that if <paramref name="crsp2D3DsUnified" />[i].FeatureRaw2D
  13062. is null or empty,
  13063. then <paramref name="crsp2D3DsUnified" />[i] is ignored
  13064. during pose estimation.
  13065. </para>
  13066. </param>
  13067. <param name="partInstanceIndex">
  13068. This parameter specifies which part instance to run the pose estimation.
  13069. If <paramref name="crsp2D3DsUnified" />[i].PartInstanceIndex is not equal to
  13070. <paramref name="partInstanceIndex" />, then that
  13071. <paramref name="crsp2D3DsUnified" /> element is not used in
  13072. the pose estimation.
  13073. </param>
  13074. <exception cref="T:System.ArgumentNullException">
  13075. If any of the arguments (except <paramref name="partInstanceIndex" />) is null,
  13076. or any input argument includes null item, or
  13077. FeaturesModel3D[<paramref name="crsp2D3DsUnified" />[i].FeatureModel3DIndex]
  13078. is null.
  13079. </exception>
  13080. <exception cref="T:System.ArgumentException">
  13081. <list type="bullet">
  13082. <item> If <paramref name="raw2DFromPhys3Ds" />.Count == 0; </item>
  13083. <item>
  13084. if <paramref name="raw2DFromPhys3Ds" />.Count is 1, and
  13085. <paramref name="raw2DFromPhys3Ds" />[0].IsTelecentric is true .
  13086. </item>
  13087. <item> If <paramref name="partInstanceIndex" /> is less than 0; </item>
  13088. <item> If <paramref name="crsp2D3DsUnified" />[i].CameraIndex is
  13089. not inside range [0, <paramref name="raw2DFromPhys3Ds" />.Count-1];
  13090. </item>
  13091. <item> If <paramref name="crsp2D3DsUnified" />[i].FeatureModel3DType
  13092. is not Cog3DVect3, Cog3DLine, Cog3DLineSeg,
  13093. Cog3DCylinder, or Cog3DCircle;
  13094. </item>
  13095. <item> If <paramref name="crsp2D3DsUnified" />[i].FeatureModel3DType
  13096. is Cog3DVect3, but
  13097. <paramref name="crsp2D3DsUnified" />[i].Subfeature is not
  13098. Cog3DSubfeatureConstants.Point0; </item>
  13099. <item> If <paramref name="crsp2D3DsUnified" />[i].FeatureModel3DType
  13100. is Cog3DLine or Cog3DLineSeg, but
  13101. <paramref name="crsp2D3DsUnified" />[i].Subfeature is not
  13102. Cog3DSubfeatureConstants.StraightEdge0; </item>
  13103. <item> If <paramref name="crsp2D3DsUnified" />[i].FeatureModel3DType is
  13104. Cog3DCircle, but
  13105. <paramref name="crsp2D3DsUnified" />[i].Subfeature is not
  13106. Cog3DSubfeatureConstants.CircleEdge0 or Cog3DSubfeatureConstants.Point0; </item>
  13107. <item> If <paramref name="crsp2D3DsUnified" />[i].FeatureModel3DType is
  13108. Cog3DCylinder, but
  13109. <paramref name="crsp2D3DsUnified" />[i].Subfeature is not
  13110. Cog3DSubfeatureConstants.OccludingEdge0, .OccludingEdge1, .CircularEdge0,
  13111. or .CircularEdge1; </item>
  13112. <item> If <paramref name="crsp2D3DsUnified" />[i].FeatureRaw2D
  13113. is not null, and its type is not Cog3DVect2, or Cog3DVect2Collection;
  13114. </item>
  13115. <item> If <paramref name="crsp2D3DsUnified" />[i].FeatureModel3DType
  13116. is Cog3DVect3,
  13117. <paramref name="crsp2D3DsUnified" />[i].FeatureRaw2D
  13118. has type of Cog3DVect2Collection, and its size is greater than 1.
  13119. </item>
  13120. <item> If <paramref name="crsp2D3DsUnified" />[i].FeatureModel3DIndex is
  13121. not inside range [0, FeaturesModel3D.Count-1];
  13122. </item>
  13123. <item> If <paramref name="crsp2D3DsUnified" />[i].FeatureModel3DType is not
  13124. the same as the type of
  13125. FeaturesModel3D[<paramref name="crsp2D3DsUnified" />[i].FeatureModel3DIndex];
  13126. </item>
  13127. </list>
  13128. </exception>
  13129. <remarks>
  13130. <para>
  13131. Note that this method handles a single part instance.
  13132. Therefore, all 2D features with the specified
  13133. <paramref name="partInstanceIndex" />
  13134. in <paramref name="crsp2D3DsUnified" /> must correspond to the same
  13135. part instance.
  13136. </para>
  13137. <para>
  13138. Note that if 3D line segment model features are used, and some 3D line
  13139. segments are shorter than the actual lengths, then it may return result(s)
  13140. with larger residuals. Dilating the 3D line segments
  13141. may avoid this problem.
  13142. </para>
  13143. <para>
  13144. Note that this method might return multiple different poses with similar fitting residuals.
  13145. If the returned result has a list of multiple pose results, it means not enough
  13146. information in <paramref name="crsp2D3DsUnified" /> to get a unique pose for the specified part instance.
  13147. Pose ambiguities can be avoided by adding more feature correspondences.
  13148. </para>
  13149. <para>
  13150. The following is a list of situations that satisfy the requirements for
  13151. estimating a pose. Note that under some of these situations there may
  13152. be multiple poses with equivalent fitting residuals:
  13153. <list type="bullet"><item> There are 3 or more point correspondences; </item><item> There are 3 or more intersection points among 3D model lines or
  13154. line segments;</item><item> There are 3 or more model circles; </item><item> There are 2 or more non-parallel model cylinders;
  13155. </item><item> The combination of number of point correspondences, number of
  13156. intersection points among 3D model lines or line segments,
  13157. and number of model circles, is 3 or more; </item><item> There are 2 or more nonparallel model lines or line segments
  13158. observed simultaneously by two or more cameras; </item><item> There are 2 or more model circles observed simultaneously
  13159. by two or more cameras;</item><item> There are one or more model points, and one or more model circles
  13160. observed simultaneously by two or more cameras;</item><item> There are one or more model points, and one or more model lines
  13161. or line segments observed simultaneously by two or more cameras; </item><item> There are one or more model points, and one or more model
  13162. cylinders observed simultaneously by two or more cameras; </item><item> There are one or more model lines or line segments, and one or
  13163. more model circles observed simultaneously by two or more cameras;
  13164. </item><item> There are one or more model cylinders, and one or more model
  13165. circles observed simultaneously by two or more cameras; </item><item> There are one or more model cylinders, and one or more model
  13166. lines or line segments (not parallel to the cylinder's axis) observed
  13167. simultaneously by two or more cameras. </item></list></para>
  13168. <para>
  13169. Note that calling GetIndicesOfOutlierCrsp2D3Ds() from the returned result
  13170. will obtain an empty list since all features are used in this pose estimation method.
  13171. </para>
  13172. <para> Note that the returned result might have an empty list of pose results,
  13173. if it can not find any pose.
  13174. </para>
  13175. </remarks>
  13176. </member>
  13177. <member name="P:Cognex.VisionPro3D.Cog3DPoseEstimatorUsingCrsp2D3Ds.FeaturesModel3D">
  13178. <summary>
  13179. Gets/sets the 3D model features, in Model3D space, that define
  13180. the object of interest.
  13181. </summary>
  13182. <value>
  13183. A collection of 3D model features in Model3D space.
  13184. </value>
  13185. <exception cref="T:System.ArgumentNullException">
  13186. If input argument in the setter is null.
  13187. </exception>
  13188. </member>
  13189. <member name="M:Cognex.VisionPro3D.Cog3DPoseEstimatorUsingCrsp2D3Ds.Finalize">
  13190. <inheritdoc cref="!:ICog3DBase::FinalizerForThisClass" />
  13191. </member>
  13192. <member name="M:Cognex.VisionPro3D.Cog3DPoseEstimatorUsingCrsp2D3Ds.Dispose">
  13193. <inheritdoc cref="!:ICog3DBase::DestructorForThisClass" />
  13194. </member>
  13195. <member name="M:Cognex.VisionPro3D.Cog3DPoseEstimatorUsingCrsp2D3Ds.#ctor">
  13196. <summary>
  13197. Construct this default Cog3DPoseEstimatorUsingCrsp2D3Ds. Note that FeaturesModel3D is an empty collection.
  13198. </summary>
  13199. </member>
  13200. <member name="T:Cognex.VisionPro3D.Cog3DPoseEstimatorUsingCrsp2D3Ds">
  13201. <summary>
  13202. This class provides 3D pose estimation methods from the specified crsp2D3DsUnified
  13203. for one part instance (specified by the input parameter "partInstanceIndex" in the
  13204. methods).
  13205. The pose estimation is done by determining the best fit between
  13206. a set of 3D features
  13207. and the set or sets of corresponded 2D image features.
  13208. </summary>
  13209. </member>
  13210. <member name="M:Cognex.VisionPro3D.Cog3DPoseEstimatorUsingCrsp2D3DsResult.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  13211. <inheritdoc cref="!:ICog3DBase::SerializationConstructor" />
  13212. </member>
  13213. <member name="M:Cognex.VisionPro3D.Cog3DPoseEstimatorUsingCrsp2D3DsResult.ToString">
  13214. <inheritdoc cref="!:ICog3DBase::ToString" />
  13215. </member>
  13216. <member name="P:Cognex.VisionPro3D.Cog3DPoseEstimatorUsingCrsp2D3DsResult.Message">
  13217. <summary>
  13218. Get the message string of this result.
  13219. </summary>
  13220. <value>
  13221. The message string of this result.
  13222. </value>
  13223. <remarks>
  13224. <para>
  13225. The message might hold information about why no poses in this result.
  13226. </para>
  13227. <para>
  13228. It is null if no information provided.
  13229. </para>
  13230. </remarks>
  13231. </member>
  13232. <member name="P:Cognex.VisionPro3D.Cog3DPoseEstimatorUsingCrsp2D3DsResult.PartInstanceIndex">
  13233. <summary>
  13234. Get the index of the found part instance.
  13235. </summary>
  13236. <value>
  13237. The index of the found part instance.
  13238. </value>
  13239. <remarks>
  13240. This index is the same as the input parameter "partInstanceIndex"
  13241. in related methods of Cog3DPoseEstimatorUsingCrsp2D3Ds.
  13242. </remarks>
  13243. </member>
  13244. <member name="M:Cognex.VisionPro3D.Cog3DPoseEstimatorUsingCrsp2D3DsResult.GetIndicesOfOutlierCrsp2D3Ds">
  13245. <summary>
  13246. Gets the indices of the crsp2D3Ds classified as outliers
  13247. and excluded from the pose estimation.
  13248. </summary>
  13249. <returns>
  13250. The list of the indices of the crsp2D3Ds classified as
  13251. outliers.
  13252. </returns>
  13253. </member>
  13254. <member name="M:Cognex.VisionPro3D.Cog3DPoseEstimatorUsingCrsp2D3DsResult.GetPoseResults">
  13255. <summary>
  13256. Gets the 3D pose results for one part instance.
  13257. Note that multiple pose results might be returned.
  13258. </summary>
  13259. <returns>
  13260. The 3D pose results for one part instance.
  13261. </returns>
  13262. <remarks>
  13263. If the returned list has multiple pose results, it means not enough
  13264. information to get a unique pose during calling methods of
  13265. Cog3DPoseEstimatorUsingCrsp2D3Ds.
  13266. Pose ambiguities can be avoided by adding more feature correspondences.
  13267. </remarks>
  13268. </member>
  13269. <member name="M:Cognex.VisionPro3D.Cog3DPoseEstimatorUsingCrsp2D3DsResult.Finalize">
  13270. <inheritdoc cref="!:ICog3DBase::FinalizerForThisClass" />
  13271. </member>
  13272. <member name="M:Cognex.VisionPro3D.Cog3DPoseEstimatorUsingCrsp2D3DsResult.Dispose">
  13273. <inheritdoc cref="!:ICog3DBase::DestructorForThisClass" />
  13274. </member>
  13275. <member name="M:Cognex.VisionPro3D.Cog3DPoseEstimatorUsingCrsp2D3DsResult.#ctor(Cognex.VisionPro3D.Cog3DPoseEstimatorUsingCrsp2D3DsResult)">
  13276. <inheritdoc cref="!:ICog3DBase::DeepCopyConstructorForThisClass" />
  13277. </member>
  13278. <member name="T:Cognex.VisionPro3D.Cog3DPoseEstimatorUsingCrsp2D3DsResult">
  13279. <summary>
  13280. This class encapsulates the result of a 3D pose estimation using
  13281. the specified crsp2D3Ds for one part instance.
  13282. Note that this class is immutable - it may not be changed once
  13283. it has been constructed.
  13284. </summary>
  13285. </member>
  13286. <member name="M:Cognex.VisionPro3D.Cog3DRobustPoseEstimationParametersSimple.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  13287. <inheritdoc cref="!:ICog3DBase::GetObjectData" />
  13288. </member>
  13289. <member name="M:Cognex.VisionPro3D.Cog3DRobustPoseEstimationParametersSimple.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  13290. <inheritdoc cref="!:ICog3DBase::SerializationConstructor" />
  13291. </member>
  13292. <member name="M:Cognex.VisionPro3D.Cog3DRobustPoseEstimationParametersSimple.RealEqual(Cognex.VisionPro3D.Cog3DRobustPoseEstimationParametersSimple,Cognex.VisionPro3D.Cog3DRobustPoseEstimationParametersSimple,System.Double)">
  13293. <inheritdoc cref="!:ICog3DBase::RealEqual" />
  13294. </member>
  13295. <member name="M:Cognex.VisionPro3D.Cog3DRobustPoseEstimationParametersSimple.ToString">
  13296. <inheritdoc cref="!:ICog3DBase::ToString" />
  13297. </member>
  13298. <member name="P:Cognex.VisionPro3D.Cog3DRobustPoseEstimationParametersSimple.MinNumOfFeaturesModel3DFromAtLeast2Cameras">
  13299. <summary>
  13300. Gets/sets the minimum number of 3D model features from at least
  13301. 2 cameras to be used for the pose estimation.
  13302. </summary>
  13303. <value>
  13304. The minimum number of 3D model features from at least 2 cameras
  13305. to be used for the pose estimation.
  13306. </value>
  13307. <exception cref="T:System.ArgumentException">
  13308. If the input argument to the setter is less than 0.
  13309. </exception>
  13310. </member>
  13311. <member name="P:Cognex.VisionPro3D.Cog3DRobustPoseEstimationParametersSimple.MinNumOfFeaturesModel3D">
  13312. <summary>
  13313. Gets/sets the minimum number of 3D model features to be used
  13314. for the pose estimation.
  13315. </summary>
  13316. <value>
  13317. The minimum number of 3D model features to be used
  13318. for the pose estimation.
  13319. </value>
  13320. <exception cref="T:System.ArgumentException">
  13321. If the input argument to the setter is less than 1.
  13322. </exception>
  13323. </member>
  13324. <member name="P:Cognex.VisionPro3D.Cog3DRobustPoseEstimationParametersSimple.ResidualsPhys3DRmsThreshold">
  13325. <summary>
  13326. Gets/sets a threshold used to specify the desired quality of the pose
  13327. estimation. The threshold specifies the maximum allowed RMS value of
  13328. the distances between the rays of 2D features and their corresponding
  13329. mapped 3D model feature. If the threshold is exceeded, then the crsp2D3Ds
  13330. having the largest impact on the RMS residuals are
  13331. considered outliers. Default value is HUGE_VAL.
  13332. </summary>
  13333. <value>
  13334. The threshold of maximum residual in Phys3D.
  13335. </value>
  13336. <exception cref="T:System.ArgumentException">
  13337. If the input argument to the setter is less than 0.0.
  13338. </exception>
  13339. </member>
  13340. <member name="P:Cognex.VisionPro3D.Cog3DRobustPoseEstimationParametersSimple.ResidualsPhys3DMaxThreshold">
  13341. <summary>
  13342. Gets/sets a threshold used to specify the desired quality of the pose
  13343. estimation. The threshold specifies the maximum allowed distance
  13344. between the rays of any 2D feature and its corresponding mapped 3D
  13345. model feature. If the threshold is exceeded on one crsp2D3D, then that
  13346. crsp2D3D is considered an outlier. Default value is HUGE_VAL.
  13347. </summary>
  13348. <value>
  13349. The threshold of maximum residual in Phys3D.
  13350. </value>
  13351. <exception cref="T:System.ArgumentException">
  13352. If the input argument to the setter is less than 0.0.
  13353. </exception>
  13354. </member>
  13355. <member name="M:Cognex.VisionPro3D.Cog3DRobustPoseEstimationParametersSimple.Finalize">
  13356. <inheritdoc cref="!:ICog3DBase::FinalizerForThisClass" />
  13357. </member>
  13358. <member name="M:Cognex.VisionPro3D.Cog3DRobustPoseEstimationParametersSimple.Dispose">
  13359. <inheritdoc cref="!:ICog3DBase::DestructorForThisClass" />
  13360. </member>
  13361. <member name="M:Cognex.VisionPro3D.Cog3DRobustPoseEstimationParametersSimple.#ctor(Cognex.VisionPro3D.Cog3DRobustPoseEstimationParametersSimple)">
  13362. <inheritdoc cref="!:ICog3DBase::DeepCopyConstructorForThisClass" />
  13363. </member>
  13364. <member name="M:Cognex.VisionPro3D.Cog3DRobustPoseEstimationParametersSimple.#ctor">
  13365. <summary>
  13366. Default constructor. Default values are:
  13367. <list type="bullet"><item> ResidualsPhys3DMaxThreshold is HUGE_VAL </item><item> ResidualsPhys3DRmsThreshold is HUGE_VAL </item><item> MinNumOfFeaturesModel3D is 3. </item><item> MinNumOfFeaturesModel3DFromAtLeast2Cameras is 0. </item></list></summary>
  13368. </member>
  13369. <member name="T:Cognex.VisionPro3D.Cog3DRobustPoseEstimationParametersSimple">
  13370. <summary>
  13371. This class defines the simple robust pose estimation parameters that
  13372. controls the behavior of robust 3D pose estimation.
  13373. </summary>
  13374. </member>
  13375. <member name="M:Cognex.VisionPro3D.Cog3DCylinderFitterUsing2DPoints.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  13376. <inheritdoc cref="!:ICog3DBase::GetObjectData" />
  13377. </member>
  13378. <member name="M:Cognex.VisionPro3D.Cog3DCylinderFitterUsing2DPoints.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  13379. <inheritdoc cref="!:ICog3DBase::SerializationConstructor" />
  13380. </member>
  13381. <member name="M:Cognex.VisionPro3D.Cog3DCylinderFitterUsing2DPoints.Execute(System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCameraCalibration},System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DVect2Collection},System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DVect2Collection},System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DVect2Collection},System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DVect2Collection})">
  13382. <summary>
  13383. Fits a 3D cylinder from 2D point sets and a set of camera calibrations.
  13384. It is not required that the 2D points of the different cameras/views
  13385. correspond.
  13386. <para>
  13387. Notes:
  13388. <list type="bullet"><item> The result's IsFound property will be set to false
  13389. if no cylinder can be fit to the given points. </item><item> This operation determines the 3D cylinder which minimizes
  13390. the sum squared error in image pixels. </item><item> This operation can compute the cylinder's radius and height
  13391. if the input data includes image points from more than one camera.
  13392. </item></list></para></summary>
  13393. <param name="raw2DFromPhys3Ds">
  13394. The List of camera calibrations of the cameras used to extract the 2D points.
  13395. The size of the list defines the number of cameras/views used.
  13396. </param>
  13397. <param name="pointsRaw2DOnOccludingEdge0">
  13398. A List of 2D point collections for occluding edges, one collection per
  13399. camera/view. The size of the list must be equal to the number of cameras.
  13400. May not be null.
  13401. <para> Notes:
  13402. <list type="bullet"><item> It only requires that all points in
  13403. one collection correspond to the same occluding edge from that camera, i.e., all points
  13404. in <paramref name="pointsRaw2DOnOccludingEdge0" />[camIndex_i] must
  13405. correspond to one occluding edge,
  13406. and points in <paramref name="pointsRaw2DOnOccludingEdge0" />[camIndex_j]
  13407. must correspond to one occluding edge (but diffent from the one for
  13408. <paramref name="pointsRaw2DOnOccludingEdge0" />[camIndex_i] if
  13409. camIndex_j != camIndex_i).
  13410. </item><item> This function can tolerate the situation where some or all items
  13411. of pointsRaw2DOnOccludingEdge0 are empty (i.e.,
  13412. <paramref name="pointsRaw2DOnOccludingEdge0" />[camIndex_i].Count==0);
  13413. </item><item> It is NOT required that
  13414. <paramref name="pointsRaw2DOnOccludingEdge0" />[camIndex_i].Count ==
  13415. <paramref name="pointsRaw2DOnOccludingEdge0" />[camIndex_j].Count
  13416. (camIndex_i != camIndex_j); </item><item> It is NOT required that
  13417. <paramref name="pointsRaw2DOnOccludingEdge0" />[camIndex_i][k] corresponds
  13418. to <paramref name="pointsRaw2DOnOccludingEdge0" />[camIndex_j][k]
  13419. (camIndex_i != camIndex_j). </item></list></para></param>
  13420. <param name="pointsRaw2DOnOccludingEdge1">
  13421. A List of 2D point collections for occluding edges, one collection per
  13422. camera/view. The size of the list must be equal to the number of cameras.
  13423. May not be null.
  13424. Note that <paramref name="pointsRaw2DOnOccludingEdge1" />[camIndex_i] and
  13425. <paramref name="pointsRaw2DOnOccludingEdge0" />[camIndex_i] must correspond
  13426. to two different occluding edges of the same cylinder observed from the
  13427. same camera. For detailed specification, see the notes of
  13428. <paramref name="pointsRaw2DOnOccludingEdge0" /> for more information.
  13429. </param>
  13430. <param name="pointsRaw2DOnCircularEdge0">
  13431. A List of 2D point collections for circular edges, one collection per
  13432. camera/view. The size of the List must be equal to the number of cameras.
  13433. May not be null.
  13434. <para> Notes:
  13435. <list type="bullet"><item> It only requires that all points in
  13436. one collection correspond to the same circular edge (i.e., all points in
  13437. <paramref name="pointsRaw2DOnCircularEdge0" />[camIndex_i] must
  13438. correspond to one circular edge on the cylinder,
  13439. and points in <paramref name="pointsRaw2DOnCircularEdge0" />[camIndex_j]
  13440. must correspond to one circular edge on the cylinder (which might be
  13441. different from the one for
  13442. <paramref name="pointsRaw2DOnCircularEdge0" />[camIndex_i)).
  13443. </item><item> This function can tolerate the situation where some or all items
  13444. of <paramref name="pointsRaw2DOnCircularEdge0" /> are empty
  13445. (i.e., <paramref name="pointsRaw2DOnCircularEdge0" />[camIndex_i].Count==0);
  13446. </item><item> It is NOT required that
  13447. <paramref name="pointsRaw2DOnCircularEdge0" />[camIndex_i].Count ==
  13448. <paramref name="pointsRaw2DOnCircularEdge0" />[camIndex_j].Count
  13449. (camIndex_i != camIndex_j); </item><item> It is NOT required that
  13450. <paramref name="pointsRaw2DOnCircularEdge0" />[camIndex_i][k] corresponds
  13451. to <paramref name="pointsRaw2DOnCircularEdge0" />[camIndex_j][k]
  13452. (camIndex_i != camIndex_j). </item></list></para></param>
  13453. <param name="pointsRaw2DOnCircularEdge1">
  13454. A List of 2D point collections for circular edges, one collection per
  13455. camera/view. The size of the List must be equal to the number of cameras.
  13456. May not be null.
  13457. Note that <paramref name="pointsRaw2DOnCircularEdge1" />[camIndex_i]
  13458. <paramref name="pointsRaw2DOnCircularEdge0" />[camIndex_i] must correspond
  13459. to different circular edges of the same cylinder.
  13460. For detailed specification, see the notes of
  13461. <paramref name="pointsRaw2DOnCircularEdge0" /> for more information.
  13462. </param>
  13463. <returns>
  13464. A Cog3DCylinderFitterUsing2DPointsResult containing the fitted cylinder
  13465. and 2D and 3D residuals.
  13466. </returns>
  13467. <exception cref="T:System.ArgumentNullException">
  13468. If any of the input arguments is null or any argument includes null item.
  13469. </exception>
  13470. <exception cref="T:System.ArgumentException">
  13471. <list type="bullet">
  13472. <item> If <paramref name="raw2DFromPhys3Ds" />.Count is less than 1.
  13473. </item>
  13474. <item> If <paramref name="raw2DFromPhys3Ds" /> is not the same size as
  13475. <paramref name="pointsRaw2DOnOccludingEdge0" />,
  13476. <paramref name="pointsRaw2DOnOccludingEdge1" />,
  13477. <paramref name="pointsRaw2DOnCircularEdge0" />, or
  13478. <paramref name="pointsRaw2DOnCircularEdge1" /></item>
  13479. <item>
  13480. If Radius == 0 or Height == 0, and FitMode is
  13481. Cog3DCylinderFitterUsing2DPointsFitModeConstants.LeastSquaresUseSpecifiedRadiusAndHeight.
  13482. </item>
  13483. <item>
  13484. If FitMode is
  13485. Cog3DCylinderFitterUsing2DPointsFitModeConstants.LeastSquaresComputeRadiusAndHeight and
  13486. <paramref name="raw2DFromPhys3Ds" />.Count is 1.
  13487. </item>
  13488. <item>
  13489. If none or only one of collections in
  13490. <paramref name="pointsRaw2DOnOccludingEdge0" /> and
  13491. <paramref name="pointsRaw2DOnOccludingEdge1" /> contains two or more points, AND
  13492. none of the collections in <paramref name="pointsRaw2DOnCircularEdge0" /> and
  13493. <paramref name="pointsRaw2DOnCircularEdge1" /> contains five or more points.
  13494. </item>
  13495. <item>
  13496. if <paramref name="raw2DFromPhys3Ds" />.Count is 1, and
  13497. <paramref name="raw2DFromPhys3Ds" />[0].IsTelecentric is true .
  13498. </item>
  13499. </list>
  13500. </exception>
  13501. <remarks>
  13502. <para> The minimum 2D information required when fitting with
  13503. FitMode of
  13504. Cog3DCylinderFitterUsing2DPointsFitModeConstants.LeastSquaresUseSpecifiedRadiusAndHeight
  13505. is:
  13506. </para>
  13507. <para> At least two 2D points along each occluding edge for one camera;</para>
  13508. <para> or at least five 2D points along one of the circular edge for one camera. </para>
  13509. <para> The minimum 2D information required when fitting with
  13510. FitMode of
  13511. Cog3DCylinderFitterUsing2DPointsFitModeConstants.LeastSquaresComputeRadiusAndHeight is:
  13512. </para>
  13513. <para> At least two 2D points (from each camera) along each occluding edge for two cameras;
  13514. </para>
  13515. <para> Or at least five 2D points (from each camera) along the same circular edge for two cameras.
  13516. </para>
  13517. </remarks>
  13518. </member>
  13519. <member name="P:Cognex.VisionPro3D.Cog3DCylinderFitterUsing2DPoints.Height">
  13520. <summary>
  13521. Gets/sets the expected height of the cylinder to find.
  13522. </summary>
  13523. <value>
  13524. The expected height of the cylinder to find.
  13525. </value>
  13526. <exception cref="T:System.ArgumentException">
  13527. If <paramref name="value" /> is less than 0.
  13528. </exception>
  13529. <remarks>
  13530. If FitMode is
  13531. Cog3DCylinderFitterUsing2DPointsFitModeConstants.eLeastSquaresUseSpecifiedRaiusAndHeight,
  13532. then Execute() will use this specified height. If FitMode is
  13533. Cog3DCylinderFitterUsing2DPointsFitModeConstants.eLeastSquaresComputeRadiusAndHeight,
  13534. then Execute() will ignore this specified height.
  13535. </remarks>
  13536. </member>
  13537. <member name="P:Cognex.VisionPro3D.Cog3DCylinderFitterUsing2DPoints.Radius">
  13538. <summary>
  13539. Gets/sets the expected radius of the cylinder to find.
  13540. </summary>
  13541. <value>
  13542. The expected radius of the cylinder to find.
  13543. </value>
  13544. <exception cref="T:System.ArgumentException">
  13545. If <paramref name="value" /> is less than 0.
  13546. </exception>
  13547. <remarks>
  13548. If FitMode is
  13549. Cog3DCylinderFitterUsing2DPointsFitModeConstants.eLeastSquaresUseSpecifiedRadiusAndHeight,
  13550. then Execute() will use this specified radius. If FitMode is
  13551. Cog3DCylinderFitterUsing2DPointsFitModeConstants.eLeastSquaresComputeRadiusAndHeight,
  13552. then Execute() will ignore this specified radius.
  13553. </remarks>
  13554. </member>
  13555. <member name="P:Cognex.VisionPro3D.Cog3DCylinderFitterUsing2DPoints.FitMode">
  13556. <summary>
  13557. Gets/sets the fit mode for 3D cylinder fitting.
  13558. </summary>
  13559. <value>
  13560. The fit mode for cylinder fitting.
  13561. </value>
  13562. <exception cref="T:System.ArgumentException">
  13563. If an invalid fit mode is used in the setter.
  13564. </exception>
  13565. <remarks>
  13566. If FitMode is
  13567. Cog3DCylinderFitterUsing2DPointsFitModeConstants.eLeastSquaresUseSpecifiedRadiusAndHeight,
  13568. then Execute()
  13569. will use the values of Radius and Height . If FitMode is
  13570. Cog3DCylinderFitterUsing2DPointsFitModeConstants.eLeastSquaresComputeRadiusAndHeight,
  13571. then Execute() will ignore the values of Radius and Height.
  13572. </remarks>
  13573. </member>
  13574. <member name="M:Cognex.VisionPro3D.Cog3DCylinderFitterUsing2DPoints.Finalize">
  13575. <inheritdoc cref="!:ICog3DBase::FinalizerForThisClass" />
  13576. </member>
  13577. <member name="M:Cognex.VisionPro3D.Cog3DCylinderFitterUsing2DPoints.Dispose">
  13578. <inheritdoc cref="!:ICog3DBase::DestructorForThisClass" />
  13579. </member>
  13580. <member name="M:Cognex.VisionPro3D.Cog3DCylinderFitterUsing2DPoints.#ctor(Cognex.VisionPro3D.Cog3DCylinderFitterUsing2DPoints)">
  13581. <inheritdoc cref="!:ICog3DBase::DeepCopyConstructorForThisClass" />
  13582. </member>
  13583. <member name="M:Cognex.VisionPro3D.Cog3DCylinderFitterUsing2DPoints.#ctor">
  13584. <summary>
  13585. Default constructor. Initializes this object for use.
  13586. Note that FitMode is
  13587. Cog3DCylinderFitterUsing2DPointsFitModeConstants.LeastSquaresUseSpecifiedRadiusAndHeight,
  13588. Radius is 0, and Height is 0.
  13589. </summary>
  13590. </member>
  13591. <member name="T:Cognex.VisionPro3D.Cog3DCylinderFitterUsing2DPoints">
  13592. <summary>
  13593. This class provides 3D cylinder fitting from 2D points.
  13594. A 3D cylinder is fitted from multiple sets of 2D image points.
  13595. The sets of image points can come from different cameras or from
  13596. a single camera.
  13597. The 3D cylinder fitter computes the pose of the cylinder which
  13598. minimizes the sum squared image error with respect to the given 2D
  13599. image points from calibrated camera(s).
  13600. </summary>
  13601. </member>
  13602. <member name="T:Cognex.VisionPro3D.Cog3DCylinderFitterUsing2DPointsFitModeConstants">
  13603. <summary>
  13604. This enum class defines enumeration constants for the different 3D
  13605. cylinder fitting modes.
  13606. </summary>
  13607. </member>
  13608. <member name="F:Cognex.VisionPro3D.Cog3DCylinderFitterUsing2DPointsFitModeConstants.DefaultFitMode">
  13609. <summary>
  13610. DefaultFitMode is equal to LeastSquaresUseSpecifiedRadiusAndHeight.
  13611. </summary>
  13612. </member>
  13613. <member name="F:Cognex.VisionPro3D.Cog3DCylinderFitterUsing2DPointsFitModeConstants.LeastSquaresUseSpecifiedRadiusAndHeight">
  13614. <summary>
  13615. Least squares fit using the specified radius and height.
  13616. </summary>
  13617. </member>
  13618. <member name="F:Cognex.VisionPro3D.Cog3DCylinderFitterUsing2DPointsFitModeConstants.LeastSquaresComputeRadiusAndHeight">
  13619. <summary>
  13620. Least squares fit using the measured radius and height.
  13621. </summary>
  13622. </member>
  13623. <member name="M:Cognex.VisionPro3D.Cog3DCylinderFitterUsing2DPointsResult.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  13624. <inheritdoc cref="!:ICog3DBase::GetObjectData" />
  13625. </member>
  13626. <member name="M:Cognex.VisionPro3D.Cog3DCylinderFitterUsing2DPointsResult.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  13627. <inheritdoc cref="!:ICog3DBase::SerializationConstructor" />
  13628. </member>
  13629. <member name="M:Cognex.VisionPro3D.Cog3DCylinderFitterUsing2DPointsResult.RealEqual(Cognex.VisionPro3D.Cog3DCylinderFitterUsing2DPointsResult,Cognex.VisionPro3D.Cog3DCylinderFitterUsing2DPointsResult,System.Double)">
  13630. <inheritdoc cref="!:ICog3DBase::RealEqual" />
  13631. </member>
  13632. <member name="M:Cognex.VisionPro3D.Cog3DCylinderFitterUsing2DPointsResult.ToString">
  13633. <inheritdoc cref="!:ICog3DBase::ToString" />
  13634. </member>
  13635. <member name="P:Cognex.VisionPro3D.Cog3DCylinderFitterUsing2DPointsResult.ResidualsPhys3D">
  13636. <inheritdoc cref="!:ICog3DBase::ResidualsPhys3D" />
  13637. <exception cref="T:Cognex.VisionPro3D.Cog3DException">
  13638. If IsFound is false.
  13639. </exception>
  13640. </member>
  13641. <member name="P:Cognex.VisionPro3D.Cog3DCylinderFitterUsing2DPointsResult.ResidualsRaw2D">
  13642. <inheritdoc cref="!:ICog3DBase::ResidualsRaw2D" />
  13643. <exception cref="T:Cognex.VisionPro3D.Cog3DException">
  13644. If IsFound is false.
  13645. </exception>
  13646. </member>
  13647. <member name="M:Cognex.VisionPro3D.Cog3DCylinderFitterUsing2DPointsResult.GetCylinderPhys3D">
  13648. <summary>
  13649. Get a deep copy of the fitted 3D cylinder.
  13650. </summary>
  13651. <returns>
  13652. A deep copy of the fitted 3D cylinder.
  13653. </returns>
  13654. <exception cref="T:Cognex.VisionPro3D.Cog3DException">
  13655. If IsFound is false.
  13656. </exception>
  13657. </member>
  13658. <member name="P:Cognex.VisionPro3D.Cog3DCylinderFitterUsing2DPointsResult.IsFound">
  13659. <summary>
  13660. Gets whether or not a fitted cylinder was found.
  13661. </summary>
  13662. <value>
  13663. True if a fitted cylinder was found; false otherwise.
  13664. </value>
  13665. </member>
  13666. <member name="M:Cognex.VisionPro3D.Cog3DCylinderFitterUsing2DPointsResult.Finalize">
  13667. <inheritdoc cref="!:ICog3DBase::FinalizerForThisClass" />
  13668. </member>
  13669. <member name="M:Cognex.VisionPro3D.Cog3DCylinderFitterUsing2DPointsResult.Dispose">
  13670. <inheritdoc cref="!:ICog3DBase::DestructorForThisClass" />
  13671. </member>
  13672. <member name="M:Cognex.VisionPro3D.Cog3DCylinderFitterUsing2DPointsResult.#ctor(Cognex.VisionPro3D.Cog3DCylinderFitterUsing2DPointsResult)">
  13673. <inheritdoc cref="!:ICog3DBase::DeepCopyConstructorForThisClass" />
  13674. </member>
  13675. <member name="T:Cognex.VisionPro3D.Cog3DCylinderFitterUsing2DPointsResult">
  13676. <summary>
  13677. This class holds a result from a 3D cylinder fitting operation, where 2D
  13678. points have been used as input.
  13679. Note that this class is immutable - it may not be changed once
  13680. it has been constructed. The usage model for this class is that it
  13681. gets factoried by the Cog3DCylinderFitterUsing2DPoints class.
  13682. </summary>
  13683. </member>
  13684. <member name="M:Cognex.VisionPro3D.Cog3DPartCorresponderUsing2DPoses.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  13685. <inheritdoc cref="!:ICog3DBase::GetObjectData" />
  13686. </member>
  13687. <member name="M:Cognex.VisionPro3D.Cog3DPartCorresponderUsing2DPoses.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  13688. <inheritdoc cref="!:ICog3DBase::SerializationConstructor" />
  13689. </member>
  13690. <member name="M:Cognex.VisionPro3D.Cog3DPartCorresponderUsing2DPoses.ConvertToResults(System.Collections.Generic.List`1{System.Collections.Generic.Dictionary`2{System.Int32,System.Int32}})">
  13691. <summary>
  13692. Method to convert a Dictionary List (each Dictionary corresponds to one 3D part instance) to
  13693. a list of Cog3DPartCorresponderUsingCrsp2D3DsResult.
  13694. </summary>
  13695. <param name="partCorrespondences">
  13696. The Dictionary List, each item represents one 3D part instance.
  13697. </param>
  13698. <returns>
  13699. A list of Cog3DPartCorresponderUsingCrsp2D3DsResult.
  13700. </returns>
  13701. </member>
  13702. <member name="M:Cognex.VisionPro3D.Cog3DPartCorresponderUsing2DPoses.UnifyCrsp2D3D(System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCrsp2D3D},System.Collections.Generic.List`1{System.Collections.Generic.Dictionary`2{System.Int32,System.Int32}})">
  13703. <summary>
  13704. Method to create unified crsp2D3Ds based on the original (non-unified) crsp2D3Ds and the part correspondences.
  13705. </summary>
  13706. <param name="crsp2D3Ds">
  13707. The List of the original crsp2D3Ds with associated camera index and
  13708. original part instance index. May not be null.
  13709. <para> Note that <paramref name="crsp2D3Ds" />[i].PartInstanceIndex should be the same index of the corresponding item in
  13710. raw2DFromModel2Ds[<paramref name="crsp2D3Ds" />[i].CameraIndex] where raw2DFromModel2Ds is the input parameter used in Execute method.
  13711. In other words, crsps corresponding to raw2DFromModel2Ds[i][j] must have CameraIndex of i, and PartInstanceIndex of j.
  13712. </para></param>
  13713. <param name="partCorrespondences">
  13714. The part correspondences computed using method Execute. May not be null.
  13715. </param>
  13716. <returns>
  13717. A list of crsp2D3Ds where the PartInstanceIndex is modified so that each PartInstanceIndex refers to the same 3D part instance
  13718. for all cameras.
  13719. </returns>
  13720. <exception cref="T:System.ArgumentNullException">
  13721. If any input argument is null, or any item inside each input argument is null.
  13722. </exception>
  13723. <exception cref="T:System.ArgumentException">
  13724. <list type="bullet">
  13725. <item>
  13726. If <paramref name="partCorrespondences" />[i] has item whose Key is outside of the camera indices range specified
  13727. by the input parameter raw2DFromPhys3Ds in constructor.
  13728. </item>
  13729. <item> If <paramref name="crsp2D3Ds" />[i].CameraIndex is
  13730. outside of the camera indices range specified
  13731. by the input parameter raw2DFromPhys3Ds in constructor.
  13732. </item>
  13733. </list>
  13734. </exception>
  13735. </member>
  13736. <member name="M:Cognex.VisionPro3D.Cog3DPartCorresponderUsing2DPoses.Execute(System.Collections.Generic.List`1{System.Collections.Generic.List`1{Cognex.VisionPro.CogTransform2DLinear}})">
  13737. <summary>
  13738. Method to run the corresponder based on the 2D part poses for each part instance in each camera.
  13739. </summary>
  13740. <param name="raw2DFromModel2Ds">
  13741. A doubly indexed list of 2D part poses found in each camera, indexed first by camera, then by part instance.
  13742. May not be null.
  13743. <para />
  13744. Note that the indices of <paramref name="raw2DFromModel2Ds" /> specify the camera indices, and original part
  13745. instance indices.
  13746. </param>
  13747. <returns>
  13748. The part correspondences among different cameras. Each item is a Dictionary for one 3D part instance,
  13749. and each KeyValuePair inside the Dictionary
  13750. corresponds to (cameraIndex, originalPartInstanceIndex). Note that originalPartInstanceIndex is the index of
  13751. the corresponding item in <paramref name="raw2DFromModel2Ds" />.
  13752. <para>
  13753. In other words, if <paramref name="raw2DFromModel2Ds" />[i][j] belongs to one 3D part instance,
  13754. then the Dictionary for that 3D part instance has KeyValuePair of (i, j).
  13755. </para></returns>
  13756. <exception cref="T:System.ArgumentNullException">
  13757. If <paramref name="raw2DFromModel2Ds" /> is null.
  13758. </exception>
  13759. <exception cref="T:System.ArgumentException">
  13760. <list type="bullet">
  13761. <item> If <paramref name="raw2DFromModel2Ds" />.Count is not the same as the number of cameras specified by
  13762. the input parameter raw2DFromPhys3Ds in the constructor.
  13763. </item>
  13764. </list>
  13765. </exception>
  13766. <remarks>
  13767. Usage model is as follows:
  13768. <list type="bullet"><item> Run pattern finding tools ( such as trained PatMax) to find the 2D poses of part instances in each camera
  13769. (This step generates <paramref name="raw2DFromModel2Ds" />).
  13770. </item><item> Run this method to compute part correspondences among different cameras.
  13771. </item><item> Run feature extraction for each corresponded part.
  13772. </item><item> If there are enough features extracted for one part instance, run pose estimation for the corresponded part.
  13773. </item></list></remarks>
  13774. </member>
  13775. <member name="M:Cognex.VisionPro3D.Cog3DPartCorresponderUsing2DPoses.Finalize">
  13776. <inheritdoc cref="!:ICog3DBase::FinalizerForThisClass" />
  13777. </member>
  13778. <member name="M:Cognex.VisionPro3D.Cog3DPartCorresponderUsing2DPoses.Dispose">
  13779. <inheritdoc cref="!:ICog3DBase::DestructorForThisClass" />
  13780. </member>
  13781. <member name="M:Cognex.VisionPro3D.Cog3DPartCorresponderUsing2DPoses.#ctor(Cognex.VisionPro3D.Cog3DPartCorresponderUsing2DPoses)">
  13782. <inheritdoc cref="!:ICog3DBase::DeepCopyConstructorForThisClass" />
  13783. </member>
  13784. <member name="M:Cognex.VisionPro3D.Cog3DPartCorresponderUsing2DPoses.#ctor(System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCameraCalibration},System.Collections.Generic.List`1{System.Object},Cognex.VisionPro3D.Cog3DTransformRigid,System.Collections.Generic.List`1{Cognex.VisionPro.CogTransform2DLinear})">
  13785. <summary>
  13786. Construct this Cog3DPartCorresponderUsing2DPoses.
  13787. Upon construction, the corresponder will be trained using the provided data.
  13788. Therefore, a part must be located, e.g. in a training position. This training position
  13789. can be e.g. the position where its model features have been created.
  13790. The data needed to configure the corresponder is:
  13791. <list type="bullet"><item> The camera calibrations used to locate the part. </item><item> The 3D model features. </item><item> The 2D poses of the located part in the camera images. </item><item> The 3D pose of the part. </item></list></summary>
  13792. <param name="raw2DFromPhys3Ds">
  13793. The List of camera calibrations. One calibration per camera.
  13794. The size of this list specifies the number of cameras.
  13795. May not be null.
  13796. </param>
  13797. <param name="featuresModel3D">
  13798. The 3D model features, in Model3D space, that define
  13799. the object of interest. May not be null. Note that model features can be obtained
  13800. using Cog3DModelFeatureGeneratorUsingCrsp2D3Ds.
  13801. </param>
  13802. <param name="raw2DFromModel2DsOfTrainImageSet">
  13803. The 2D poses of the part for the train image set, one 2D pose per camera. May not be null.
  13804. </param>
  13805. <param name="pose3DOfTrainImageSet">
  13806. The 3D pose for the part in train time. May not be null. See the Remark section for more details.
  13807. </param>
  13808. <exception cref="T:System.ArgumentNullException">
  13809. If any input argument
  13810. is null, or any item in <paramref name="raw2DFromPhys3Ds" /> is null, or any item in <paramref name="raw2DFromModel2DsOfTrainImageSet" /> is null.
  13811. </exception>
  13812. <exception cref="T:System.ArgumentException">
  13813. <list type="bullet">
  13814. <item> If <paramref name="raw2DFromPhys3Ds" />.Count is less than 2;
  13815. </item>
  13816. <item> If <paramref name="raw2DFromPhys3Ds" />.Count != <paramref name="raw2DFromModel2DsOfTrainImageSet" />.Count;
  13817. </item>
  13818. <item> If there are not enough features in <paramref name="featuresModel3D" />;
  13819. </item>
  13820. </list>
  13821. </exception>
  13822. <remarks>
  13823. The usage model is as follows: At Train/Construction time.
  13824. <list type="bullet"><item> Acquire the train image sets with only one part inside the scene.
  13825. </item><item> Configure pattern finding tools (such as PatMax tools) and feature extraction tools based on the first train image set.
  13826. </item><item> Run pattern finding tools (such as PatMax tools) on the first train image set to obtain <paramref name="raw2DFromModel2DsOfTrainImageSet" />.
  13827. </item><item> Run the model feature generator tool (cog3DModelFeatureGeneratorUsingCrsp2D3Ds) to compute <paramref name="featuresModel3D" /> (or create <paramref name="featuresModel3D" /> based on known model information)
  13828. </item><item> Run pose estimator to compute the 3D pose of the part for the first train image set (this pose is used as <paramref name="pose3DOfTrainImageSet" />).
  13829. </item><item> Call this constructor to create a corresponder.
  13830. </item></list></remarks>
  13831. </member>
  13832. <member name="T:Cognex.VisionPro3D.Cog3DPartCorresponderUsing2DPoses">
  13833. <summary>
  13834. This class solves the correspondence problem that occurs when multiple
  13835. cameras are viewing a scene containing multiple instances of a part, and returns the
  13836. correct image pattern correspondences for each 3D part instance. 2D poses of
  13837. the 2D part models for the part are used in computing the part correspondences.
  13838. </summary>
  13839. <Remarks>
  13840. The usage model is:
  13841. <list type="bullet"><item> At train time, create a 2D part model (such as PatMax pattern) in each image from a training image set.
  13842. </item><item> At run time, run the pattern finder tool in each image and get the 2D poses for each found part instance.
  13843. </item><item> Call this part corresponder to get part correspondences.
  13844. </item></list>
  13845. See the constructor and methods for more detail information.
  13846. </Remarks>
  13847. </member>
  13848. <member name="M:Cognex.VisionPro3D.Cog3DPartCorresponderUsingCrsp2D3Ds.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  13849. <inheritdoc cref="!:ICog3DBase::SerializationConstructor" />
  13850. </member>
  13851. <member name="M:Cognex.VisionPro3D.Cog3DPartCorresponderUsingCrsp2D3Ds.CorrespondPartsUsingPointsAndIntersectionPoints(System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCameraCalibration},System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCrsp2D3D},System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCrsp2D3D}@)">
  13852. <summary>
  13853. This method determines the part correspondences among the multiple part instances seen
  13854. by multiple cameras using the original 2D/3D part feature correspondences
  13855. (<paramref name="crsp2D3Ds" />),
  13856. and the camera calibrations. After determining
  13857. the part correspondences across cameras, generate a result object for each
  13858. corresponded part instance and a result object for each uncorresponded part
  13859. instance.
  13860. Also generate a new set of 2D/3D part feature correspondences
  13861. (<paramref name="crsp2D3DsUnified" />)
  13862. with updated PartInstanceIndex members that map to the returned result objects.
  13863. </summary>
  13864. <param name="raw2DFromPhys3Ds">
  13865. The List of camera calibrations. One calibration per camera.
  13866. The size of this list specifies the number of cameras.
  13867. May not be null.
  13868. </param>
  13869. <param name="crsp2D3Ds">
  13870. The List of the original crsp2D3Ds with associated camera index and
  13871. original part instance index. May not be null.
  13872. <para> Note that if <paramref name="crsp2D3Ds" />[i].FeatureRaw2D
  13873. is null or empty, then <paramref name="crsp2D3Ds" />[i] is ignored
  13874. when computing the part correspondences.
  13875. </para></param>
  13876. <param name="crsp2D3DsUnified">
  13877. This is a copy of <paramref name="crsp2D3Ds" /> where the
  13878. PartInstanceIndex in <paramref name="crsp2D3DsUnified" /> have been updated to
  13879. reflect the correct part correspondences across cameras.
  13880. <paramref name="crsp2D3DsUnified" /> is created by first
  13881. making a shallow copy of each element in <paramref name="crsp2D3Ds" /> whose
  13882. (CameraIndex, PartInstance) exists in one item of
  13883. the returned List of <see cref="T:Cognex.VisionPro3D.Cog3DPartCorresponderUsingCrsp2D3DsResult" />, then updating
  13884. its PartInstanceIndex to be the index of the corresponding item in
  13885. the returned List of <see cref="T:Cognex.VisionPro3D.Cog3DPartCorresponderUsingCrsp2D3DsResult" />, i.e. if
  13886. (<paramref name="crsp2D3Ds" />[i].CameraIndex,
  13887. <paramref name="crsp2D3Ds" />[i].PartInstanceIndex) exists in
  13888. the returned List(<see cref="T:Cognex.VisionPro3D.Cog3DPartCorresponderUsingCrsp2D3DsResult" />)[j].GetIndicesOfCameraAndPartInstance(),
  13889. then a shallow copy of <paramref name="crsp2D3Ds" />[i] will be inside
  13890. <paramref name="crsp2D3DsUnified" /> and its PartInstanceIndex is modified to be
  13891. j.
  13892. </param>
  13893. <returns>
  13894. The List of result objects (<see cref="T:Cognex.VisionPro3D.Cog3DPartCorresponderUsingCrsp2D3DsResult" />). Each item contains
  13895. one 3D part instance's correspondences.
  13896. <para>
  13897. If there are 2 cameras, 10 parts in the scene observed by both cameras,
  13898. and all the parts are corresponded, then this returned list will include 10 items,
  13899. one item for each part instance.
  13900. </para><para>
  13901. If 6 of the parts are corresponded, then this returned list will include 14 items:
  13902. 6 items for the corresponded parts, 4 items for the uncorresponded parts in camera 0
  13903. and 4 items for the uncorresponded parts in camera 1.
  13904. </para><para>
  13905. Each item includes a dictionary of (key=camera index, value=original 2D part instance index).
  13906. </para></returns>
  13907. <exception cref="T:System.ArgumentNullException">
  13908. If <paramref name="crsp2D3Ds" /> or <paramref name="raw2DFromPhys3Ds" />
  13909. is null, or any item in one of them is null, or
  13910. FeaturesModel3D[<paramref name="crsp2D3Ds" />[i].FeatureModel3DIndex]
  13911. is null.
  13912. </exception>
  13913. <exception cref="T:System.ArgumentException">
  13914. <list type="bullet">
  13915. <item> If <paramref name="raw2DFromPhys3Ds" />.Count is less than 2;
  13916. </item>
  13917. <item>
  13918. If <paramref name="crsp2D3Ds" /> includes duplicate items
  13919. with the same CameraIndex,
  13920. the same PartInstanceIndex, and corresponding to the same
  13921. model point (model feature with type Cog3DVect3);
  13922. </item>
  13923. <item> If <paramref name="crsp2D3Ds" />[i].CameraIndex is
  13924. not inside range [0, <paramref name="raw2DFromPhys3Ds" />.Count-1];
  13925. </item>
  13926. <item> If <paramref name="crsp2D3Ds" />[i].FeatureModel3DType
  13927. is not Cog3DVect3, Cog3DLine, Cog3DLineSeg,
  13928. Cog3DCylinder, or Cog3DCircle;
  13929. </item>
  13930. <item> If <paramref name="crsp2D3Ds" />[i].FeatureModel3DType
  13931. is Cog3DVect3, but
  13932. <paramref name="crsp2D3Ds" />[i].Subfeature is not
  13933. Cog3DSubfeatureConstants.Point0; </item>
  13934. <item> If <paramref name="crsp2D3Ds" />[i].FeatureModel3DType
  13935. is Cog3DLine or Cog3DLineSeg, but
  13936. <paramref name="crsp2D3Ds" />[i].Subfeature is not
  13937. Cog3DSubfeatureConstants.StraightEdge0; </item>
  13938. <item> If <paramref name="crsp2D3Ds" />[i].FeatureModel3DType is
  13939. Cog3DCircle, but
  13940. <paramref name="crsp2D3Ds" />[i].Subfeature is not
  13941. Cog3DSubfeatureConstants.CircleEdge0 or Cog3DSubfeatureConstants.Point0; </item>
  13942. <item> If <paramref name="crsp2D3Ds" />[i].FeatureModel3DType is
  13943. Cog3DCylinder, but
  13944. <paramref name="crsp2D3Ds" />[i].Subfeature is not
  13945. Cog3DSubfeatureConstants.OccludingEdge0, .OccludingEdge1, .CircularEdge0,
  13946. or .CircularEdge1; </item>
  13947. <item> If <paramref name="crsp2D3Ds" />[i].FeatureRaw2D
  13948. is not null, and its type is not Cog3DVect2, or Cog3DVect2Collection;
  13949. </item>
  13950. <item> If <paramref name="crsp2D3Ds" />[i].FeatureModel3DType
  13951. is Cog3DVect3,
  13952. <paramref name="crsp2D3Ds" />[i].FeatureRaw2D
  13953. has type of Cog3DVect2Collection, and its size is greater than 1.
  13954. </item>
  13955. <item> If <paramref name="crsp2D3Ds" />[i].FeatureModel3DIndex is
  13956. not inside range [0, FeaturesModel3D.Count-1];
  13957. </item>
  13958. <item> If <paramref name="crsp2D3Ds" />[i].FeatureModel3DType is not
  13959. the same as the type of
  13960. FeaturesModel3D[<paramref name="crsp2D3Ds" />[i].FeatureModel3DIndex];
  13961. </item>
  13962. <item>
  13963. If FeaturesModel3D contains less than 3 distinct
  13964. model points (including derived 3D model points from intersected
  13965. 3D lines or 3D line segments).
  13966. </item>
  13967. </list>
  13968. </exception>
  13969. <remarks>
  13970. <para>
  13971. If there are 3D lines or 3D line segments in the model, this corresponder
  13972. internally computes the derived 3D model points from 3D line intersections,
  13973. and the corresponding derived 2D points from 2D line intersections.
  13974. </para>
  13975. <para>
  13976. In order for an intersection point to be computed and used, the two
  13977. line segments/lines in the image must have different directions
  13978. (difference of the direction angles must be 10 degrees or more),
  13979. and the nearest distance between the corresponding two 3D
  13980. line segments/lines must be small enough comparing to the size of the 3D model.
  13981. </para>
  13982. <para>
  13983. In order for a part instance to be corresponded, at least there are
  13984. 2 cameras seeing that part instance, and each camera sees at least
  13985. 3 2D points (including the derived 2D points
  13986. corresponding to the derived 3D model points).
  13987. </para>
  13988. <para>
  13989. If this does not happen,
  13990. then the part instance will not be corresponded.
  13991. </para>
  13992. <para>
  13993. Note that FeaturesModel3D and
  13994. <paramref name="crsp2D3Ds" />[i].FeatureModel3DIndex for any i
  13995. must be set
  13996. correctly in order to use this part corresponder.
  13997. Cog3DModelFeatureGeneratorUsing2D3Ds
  13998. might be used to generate 3D model features at train time.
  13999. </para>
  14000. </remarks>
  14001. </member>
  14002. <member name="P:Cognex.VisionPro3D.Cog3DPartCorresponderUsingCrsp2D3Ds.FeaturesModel3D">
  14003. <summary>
  14004. Gets/sets the 3D model features, in Model3D space, that define
  14005. the object of interest.
  14006. </summary>
  14007. <value>
  14008. A collection of 3D model features in Model3D space.
  14009. </value>
  14010. <exception cref="T:System.ArgumentNullException">
  14011. If input argument in the setter is null.
  14012. </exception>
  14013. </member>
  14014. <member name="M:Cognex.VisionPro3D.Cog3DPartCorresponderUsingCrsp2D3Ds.Finalize">
  14015. <inheritdoc cref="!:ICog3DBase::FinalizerForThisClass" />
  14016. </member>
  14017. <member name="M:Cognex.VisionPro3D.Cog3DPartCorresponderUsingCrsp2D3Ds.Dispose">
  14018. <inheritdoc cref="!:ICog3DBase::DestructorForThisClass" />
  14019. </member>
  14020. <member name="M:Cognex.VisionPro3D.Cog3DPartCorresponderUsingCrsp2D3Ds.#ctor">
  14021. <summary>
  14022. Construct this default Cog3DPartCorresponderUsingCrsp2D3Ds. Note that FeaturesModel3D is an empty collection.
  14023. </summary>
  14024. </member>
  14025. <member name="T:Cognex.VisionPro3D.Cog3DPartCorresponderUsingCrsp2D3Ds">
  14026. <summary>
  14027. This class solves the correspondence problem that occurs when multiple
  14028. cameras are viewing a scene containing multiple parts, and returns the
  14029. correct image pattern correspondences for each 3D part instance.
  14030. </summary>
  14031. <remarks>
  14032. <para> The inputs to this corresponder are crsp2D3Ds.
  14033. Each Cog3DCrsp2D3D
  14034. instance corresponds to a particular calibrated camera and a particular
  14035. part instance in the image acquired from that camera. Each part
  14036. instance in a calibrated camera corresponds to one or more
  14037. Cog3DCrsp2D3D instances.
  14038. All part instances are corresponded to the same 3D model.
  14039. </para>
  14040. <para> The corresponder can tolerate missing part instances.
  14041. In other words, it is acceptable for some of the
  14042. part instances to be absent from some of the cameras. </para>
  14043. <para>
  14044. The class determines a set of 3D part instances of the known 3D model
  14045. which best explain the input data.
  14046. </para>
  14047. </remarks>
  14048. </member>
  14049. <member name="T:Cognex.VisionPro3D.Cog3DQuickCorresponder">
  14050. <summary>
  14051. This class encapsulate the process running the part corresponder.
  14052. </summary>
  14053. </member>
  14054. <member name="M:Cognex.VisionPro3D.Cog3DPartCorresponderUsingCrsp2D3DsResult.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  14055. <inheritdoc cref="!:ICog3DBase::SerializationConstructor" />
  14056. </member>
  14057. <member name="M:Cognex.VisionPro3D.Cog3DPartCorresponderUsingCrsp2D3DsResult.ToString">
  14058. <inheritdoc cref="!:ICog3DBase::ToString" />
  14059. </member>
  14060. <member name="M:Cognex.VisionPro3D.Cog3DPartCorresponderUsingCrsp2D3DsResult.RealEqual(Cognex.VisionPro3D.Cog3DPartCorresponderUsingCrsp2D3DsResult,Cognex.VisionPro3D.Cog3DPartCorresponderUsingCrsp2D3DsResult,System.Double)">
  14061. <inheritdoc cref="!:ICog3DBase::RealEqual" />
  14062. </member>
  14063. <member name="M:Cognex.VisionPro3D.Cog3DPartCorresponderUsingCrsp2D3DsResult.GetIndicesOfCameraAndPartInstance">
  14064. <summary>
  14065. Gets the indices of the camera and the original part instance corresponding
  14066. to this result. Each KeyValuePair inside the returned Dictionary
  14067. corresponds to (cameraIndex, originalPartInstanceIndex).
  14068. </summary>
  14069. <returns>
  14070. The indices of the camera and the original part instance corresponding
  14071. to this result. Note that there is at most one Dictionary entry for
  14072. each camera.
  14073. </returns>
  14074. </member>
  14075. <member name="P:Cognex.VisionPro3D.Cog3DPartCorresponderUsingCrsp2D3DsResult.Coverage">
  14076. <summary>
  14077. Gets the coverage of this result.
  14078. </summary>
  14079. <value>
  14080. The coverage of this result.
  14081. </value>
  14082. <remarks>
  14083. The coverage is computed as follows:
  14084. <para>
  14085. Coverage = (number of 2D points) / ((number of 3D model points)
  14086. * (number of cameras))
  14087. </para><para>
  14088. Where the number of 3D model points includes the number of distinct
  14089. 3D model points in the specified crsp2D3Ds
  14090. (which is the input argument for Cog3DPartCorresponderUsingCrsp2D3Ds.CorrespondPartsUsingPointsAndIntersectionPoints)
  14091. and the number of the
  14092. derived 3D points from intersected 3D lines or 3D line segments in the model.
  14093. </para><para>
  14094. The number of 2D points is the
  14095. total number of 2D points corresponding to 3D model points for this part instance in
  14096. the specified crsp2D3Ds, plus
  14097. the total number of the derived 2D points corresponding to the derived 3D
  14098. points for this part instance.
  14099. </para><para>
  14100. Note that Coverage can be used to check whether multiple cameras can see the same
  14101. part instance or not. Coverage of 1.0 means all cameras can see this part instance.
  14102. </para></remarks>
  14103. </member>
  14104. <member name="M:Cognex.VisionPro3D.Cog3DPartCorresponderUsingCrsp2D3DsResult.Finalize">
  14105. <inheritdoc cref="!:ICog3DBase::FinalizerForThisClass" />
  14106. </member>
  14107. <member name="M:Cognex.VisionPro3D.Cog3DPartCorresponderUsingCrsp2D3DsResult.Dispose">
  14108. <inheritdoc cref="!:ICog3DBase::DestructorForThisClass" />
  14109. </member>
  14110. <member name="M:Cognex.VisionPro3D.Cog3DPartCorresponderUsingCrsp2D3DsResult.#ctor(Cognex.VisionPro3D.Cog3DPartCorresponderUsingCrsp2D3DsResult)">
  14111. <inheritdoc cref="!:ICog3DBase::DeepCopyConstructorForThisClass" />
  14112. </member>
  14113. <member name="T:Cognex.VisionPro3D.Cog3DPartCorresponderUsingCrsp2D3DsResult">
  14114. <summary>
  14115. This class encapsulates the result information for one 3D part instance
  14116. from part corresponder (Cog3DPartCorresponderUsingCrsp2D3Ds),
  14117. including a coverage score, and a Dictionary explaining the correspondence result.
  14118. Note that this class is immutable - it may not be changed once
  14119. it has been constructed.
  14120. </summary>
  14121. </member>
  14122. <member name="M:Cognex.VisionPro3D.Cog3DCrsp2D3D.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  14123. <inheritdoc cref="!:ICog3DBase::SerializationConstructor" />
  14124. </member>
  14125. <member name="M:Cognex.VisionPro3D.Cog3DCrsp2D3D.ToString">
  14126. <inheritdoc cref="!:ICog3DBase::ToString" />
  14127. </member>
  14128. <member name="P:Cognex.VisionPro3D.Cog3DCrsp2D3D.Subfeature">
  14129. <summary>
  14130. Gets/sets the subfeature type within the 3D model feature.
  14131. The found 2D feature(s) corresponds to this subfeature type.
  14132. </summary>
  14133. <value>
  14134. The subfeature type within the 3D feature.
  14135. </value>
  14136. <remarks> The subfeature type allows
  14137. explicit correspondence of the 2D features to a particular subfeature
  14138. of the 3D feature. For example, you can specify a set of 2D feature points
  14139. correspond to the circular end of a cylinder.
  14140. </remarks>
  14141. </member>
  14142. <member name="P:Cognex.VisionPro3D.Cog3DCrsp2D3D.ApplicationData">
  14143. <summary>
  14144. Gets/Sets an object that can be used to store application-specific information.
  14145. </summary>
  14146. <value>
  14147. An Object representing application-specific data.
  14148. </value>
  14149. </member>
  14150. <member name="P:Cognex.VisionPro3D.Cog3DCrsp2D3D.FeatureRaw2D">
  14151. <summary>
  14152. Gets/sets the 2D feature(s).
  14153. </summary>
  14154. <value>
  14155. An Object representing the found 2D feature or a collection
  14156. of found 2D features in the acquired image.
  14157. Set this property to null to indicate the 2D feature(s) was not found.
  14158. Note that most corresponders
  14159. and pose estimators support Objects of type Cog3DVect2 and Cog3DVect2Collection.
  14160. Check the corresponder/pose estimator you are using for supported 2D feature types.
  14161. </value>
  14162. </member>
  14163. <member name="P:Cognex.VisionPro3D.Cog3DCrsp2D3D.FeatureModel3DType">
  14164. <summary>
  14165. Gets/sets the 3D model feature type.
  14166. </summary>
  14167. <value>
  14168. The type of the corresponding 3D model feature.
  14169. Note that most corresponders
  14170. and pose estimators support type Cog3DVect3
  14171. as a minimum.
  14172. Check the corresponder/pose estimator you are using for supported 3D feature types.
  14173. </value>
  14174. <exception cref="T:System.ArgumentNullException">
  14175. If the input argument of the setter is null.
  14176. </exception>
  14177. </member>
  14178. <member name="P:Cognex.VisionPro3D.Cog3DCrsp2D3D.FeatureModel3DIndex">
  14179. <summary>
  14180. Gets/sets the 3D model feature index (within the 3D model feature collection)
  14181. corresponding to the found 2D feature(s).
  14182. </summary>
  14183. <value>
  14184. The 3D feature index (within the 3D model feature collection) corresponding to
  14185. the found 2D feature(s).
  14186. Note that most corresponders
  14187. and pose estimators support Objects of type Cog3DVect3
  14188. as a minimum.
  14189. Check the corresponder/pose estimator you are using for
  14190. supported 3D feature types.
  14191. </value>
  14192. <exception cref="T:System.ArgumentException">
  14193. If the input argument of the setter is less than 0.
  14194. </exception>
  14195. </member>
  14196. <member name="P:Cognex.VisionPro3D.Cog3DCrsp2D3D.PartInstanceIndex">
  14197. <summary>
  14198. Gets/sets the index of the found part instance.
  14199. </summary>
  14200. <value>
  14201. The index of the found part instance.
  14202. </value>
  14203. <exception cref="T:System.ArgumentException">
  14204. If the input argument of the setter is less than 0.
  14205. </exception>
  14206. <remarks>
  14207. <para>
  14208. Note that the index of the found part instance is particular
  14209. to the image acquired from the specified camera. The part instances
  14210. with the same index number from different cameras may not correspond
  14211. to the same part instance in the scene.
  14212. </para>
  14213. </remarks>
  14214. </member>
  14215. <member name="P:Cognex.VisionPro3D.Cog3DCrsp2D3D.CameraIndex">
  14216. <summary>
  14217. Gets/sets the index of the camera.
  14218. </summary>
  14219. <value>
  14220. The index of the camera from which the image was acquired.
  14221. </value>
  14222. <exception cref="T:System.ArgumentException">
  14223. If the input argument of the setter is less than 0.
  14224. </exception>
  14225. </member>
  14226. <member name="M:Cognex.VisionPro3D.Cog3DCrsp2D3D.Finalize">
  14227. <inheritdoc cref="!:ICog3DBase::FinalizerForThisClass" />
  14228. </member>
  14229. <member name="M:Cognex.VisionPro3D.Cog3DCrsp2D3D.Dispose">
  14230. <inheritdoc cref="!:ICog3DBase::DestructorForThisClass" />
  14231. </member>
  14232. <member name="M:Cognex.VisionPro3D.Cog3DCrsp2D3D.#ctor(System.Int32,System.Int32,System.Int32,System.Type,System.Object,Cognex.VisionPro3D.Cog3DSubfeatureConstants)">
  14233. <summary>
  14234. Construct this Cog3DCrsp2D3D with the supplied components.
  14235. </summary>
  14236. <param name="cameraIndex">
  14237. The index of the camera.
  14238. </param>
  14239. <param name="partInstanceIndex">
  14240. The index of the found part instance (in the image acquired from
  14241. the specified camera). </param>
  14242. <param name="featureModel3DIndex">
  14243. The index of the corresponding 3D feature within the 3D model feature
  14244. collection.
  14245. </param>
  14246. <param name="featureModel3DType">
  14247. The type of the corresponding 3D feature. May not be null.
  14248. </param>
  14249. <param name="featureRaw2D">
  14250. The 2D feature(s) corresponding to the subfeature type within the specified
  14251. 3D model feature. The 2D feature(s) must be in Raw2D space.
  14252. Note that it can be null to indicate the 2D feature was not found.
  14253. </param>
  14254. <param name="subfeature">
  14255. The subfeature type within the 3D feature corresponding to the 2D
  14256. feature(s).
  14257. </param>
  14258. <exception cref="T:System.ArgumentNullException">
  14259. If <paramref name="featureModel3DType" /> is null.
  14260. </exception>
  14261. <exception cref="T:System.ArgumentException">
  14262. If <paramref name="cameraIndex" />,
  14263. <paramref name="partInstanceIndex" />, or <paramref name="featureModel3DIndex" />
  14264. is less than 0.
  14265. </exception>
  14266. </member>
  14267. <member name="M:Cognex.VisionPro3D.Cog3DCrsp2D3D.#ctor">
  14268. <summary>
  14269. Construct this default
  14270. Cog3DCrsp2D3D:
  14271. <list type="bullet"><item> CameraIndex is 0; </item><item> PartInstanceIndex is 0; </item><item> FeatureModel3DIndex is 0; </item><item> FeatureModel3DType is type of Cog3DVect3; </item><item> FeatureRaw2D is null; </item><item> Subfeature is Cog3DSubfeatureConstants.Point0; </item></list></summary>
  14272. </member>
  14273. <member name="T:Cognex.VisionPro3D.Cog3DCrsp2D3D">
  14274. <summary>
  14275. This class holds feature correspondence information for a particular feature
  14276. (point, line segment, circle, etc.).
  14277. A Cog3DCrsp2D3D is a data holder class that expresses how a 2D feature(s)
  14278. (found in the acquired image from a particular
  14279. camera) corresponds to a 3D feature of the 3D model.
  14280. The feature correspondence information consists of:
  14281. <list type="bullet"><item> The index of the camera from which the image was acquired; </item><item> The index of the found part instance in the acquired image.
  14282. Each part found in an acquired image from camera C, must have a unique index.
  14283. Each part found in an acquired image from camera C+1, must also have a unique
  14284. index, however there is no requirement for the part indices across the
  14285. acquired images to match.
  14286. </item><item> An Object representing the found 2D feature e.g. Cog3DVect2 or an Object
  14287. representing a collection of found 2D features e.g. Cog3DVect2Collection
  14288. from the acquired image. The 2D feature's pose must be in Raw2D space of
  14289. the acquired image.
  14290. </item><item> The index of the 3D model feature within the 3D model feature collection
  14291. </item><item> The subfeature type (Cog3DSubfeatureConstants) within the 3D
  14292. feature that corresponds to the found 2D feature(s).
  14293. </item></list></summary>
  14294. <remarks>
  14295. <para> Note that the index of the found part instance is particular
  14296. to the image acquired from the specified camera. The part instances
  14297. with the same index number from different cameras may not correspond to
  14298. the same part in the scene.
  14299. </para>
  14300. </remarks>
  14301. </member>
  14302. <member name="T:Cognex.VisionPro3D.Cog3DSubfeatureConstants">
  14303. <summary>
  14304. This class defines enumeration constants of the subfeature types
  14305. available in decomposing 3D model features.
  14306. </summary>
  14307. </member>
  14308. <member name="F:Cognex.VisionPro3D.Cog3DSubfeatureConstants.OccludingEdge1">
  14309. <summary>
  14310. It indicates that the subfeature type is a 3D occluding edge
  14311. within a 3D feature
  14312. </summary>
  14313. </member>
  14314. <member name="F:Cognex.VisionPro3D.Cog3DSubfeatureConstants.OccludingEdge0">
  14315. <summary>
  14316. It indicates that the subfeature type is a 3D occluding edge
  14317. within a 3D feature
  14318. </summary>
  14319. </member>
  14320. <member name="F:Cognex.VisionPro3D.Cog3DSubfeatureConstants.CircularEdge1">
  14321. <summary>
  14322. It indicates that the subfeature type is a 3D circle curve
  14323. within a 3D feature
  14324. </summary>
  14325. </member>
  14326. <member name="F:Cognex.VisionPro3D.Cog3DSubfeatureConstants.CircularEdge0">
  14327. <summary>
  14328. It indicates that the subfeature type is a 3D circle curve
  14329. within a 3D feature
  14330. </summary>
  14331. </member>
  14332. <member name="F:Cognex.VisionPro3D.Cog3DSubfeatureConstants.StraightEdge0">
  14333. <summary>
  14334. It indicates that the subfeature type is a 3D line or a 3D line segment
  14335. within a 3D feature.
  14336. </summary>
  14337. </member>
  14338. <member name="F:Cognex.VisionPro3D.Cog3DSubfeatureConstants.Point0">
  14339. <summary>
  14340. It indicates that the subfeature type is a 3D point within a 3D feature.
  14341. </summary>
  14342. </member>
  14343. <member name="M:Cognex.VisionPro3D.Cog3DTelecentricCamerasOperations.ComputeAffineTransformsAmongTelecentricCameras(System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCameraCalibration},Cognex.VisionPro3D.Cog3DPlane,System.Int32)">
  14344. <summary>
  14345. <para>
  14346. Computes the affine transforms between images from telecentric cameras.
  14347. Telecentric cameras are cameras with telecentric lenses.
  14348. Specifically, this method computes the affine transforms from the image of
  14349. the camera specified as the base camera via
  14350. <paramref name="baseCameraIndex" />
  14351. to the images of all the other cameras specified in
  14352. <paramref name="raw2DFromPhys3Ds" />.
  14353. <para />
  14354. The affine transforms are computed using the cameras'
  14355. calibration information (<paramref name="raw2DFromPhys3Ds" />), and
  14356. a 3D plane in Phys3D (<paramref name="planarFeaturePhys3D" />).
  14357. The specified 3D plane should be the 3D plane coincident with the planar part
  14358. or a planar feature on the part.
  14359. This method assumes that all the telcentric cameras are viewing the same planar part
  14360. or the same planar feature on the part.
  14361. </para>
  14362. </summary>
  14363. <param name="raw2DFromPhys3Ds">
  14364. A list of Cog3DCameraCalibrations, indexed by camera. One calibration per
  14365. camera. May not be null. Note that all the camera calibrations must be
  14366. relative to the same Phys3D coordinate space.
  14367. </param>
  14368. <param name="planarFeaturePhys3D">
  14369. The feature's 3D plane in Phys3D. May not be null.
  14370. </param>
  14371. <param name="baseCameraIndex">
  14372. The index of the base camera.
  14373. </param>
  14374. <returns>
  14375. The List of CogTransform2DLinears representing the affine transforms between
  14376. the telecentric cameras' images. The List will have the same size as
  14377. <paramref name="raw2DFromPhys3Ds" />. The List element with index
  14378. <paramref name="baseCameraIndex" /> will be the identity transform.
  14379. </returns>
  14380. <remarks>
  14381. <para>
  14382. When pattern searching for a feature in each camera’s acquired
  14383. image, the 3D accuracy achieved by triangulating 3D points from the 2D
  14384. image pattern origin positions in the different images, is highly dependent on
  14385. the accuracy of the image pattern origins. This method provides
  14386. an accurate way to take an image pattern in the base camera's image and then
  14387. use this method’s output 2D affine transforms to map the base
  14388. camera's image pattern and/or the base camera's image pattern origin to the other cameras.
  14389. This technique assumes that all the cameras are viewing the same pattern
  14390. of interest.
  14391. </para>
  14392. <para>
  14393. Specifically, this method
  14394. <list type="bullet"><item>
  14395. Facilitates taking an image pattern (set of pixels in Raw2D space)
  14396. acquired by the base camera and mapping that image pattern to the Raw2D
  14397. image spaces of all the other cameras. The mapping can be achieved
  14398. using the VisionPro CogAffineTransformTool.</item><item>
  14399. Facilitates taking a 2D point e.g. the image pattern origin, in Raw2D space
  14400. of the base camera and mapping the 2D point to the Raw2D
  14401. image spaces of all the other cameras.</item><item>
  14402. Computes the affine transforms by projecting points from
  14403. the base camera's Raw2D space to the specified 3D plane (<paramref name="planarFeaturePhys3D" />),
  14404. and then projecting the points from the specified 3D plane to the other cameras' Raw2D space.</item></list></para>
  14405. <para> The 3D plane of the part or a planar feature of the part
  14406. (<paramref name="planarFeaturePhys3D" />) is defined in the 3D physical
  14407. space (Phys3D). This must be the same Phys3D space of the camera calibrations.
  14408. </para>
  14409. <para> If <paramref name="planarFeaturePhys3D" /> is parallel to the part
  14410. or a planar feature of the part but the actual feature is not lying
  14411. precisely in the specified 3D plane, then the translation part of the returned
  14412. affine transforms will not be accurate. However, all other
  14413. components of the returned affine transforms, such as aspect ratio,
  14414. rotation, skew, etc. will still be accurate. </para>
  14415. </remarks>
  14416. <exception cref="T:System.ArgumentNullException">
  14417. If <paramref name="raw2DFromPhys3Ds" /> or
  14418. <paramref name="planarFeaturePhys3D" /> is null, or any item
  14419. in <paramref name="raw2DFromPhys3Ds" /> is null.
  14420. </exception>
  14421. <exception cref="T:System.ArgumentException">
  14422. If any of the following conditions are true:
  14423. <list type="bullet"><item><paramref name="raw2DFromPhys3Ds" />.Count is less than 2. </item><item><paramref name="raw2DFromPhys3Ds" />[i].IsTelecentric is false
  14424. (i is inside [0, <paramref name="raw2DFromPhys3Ds" />.Count - 1]). </item><item><paramref name="baseCameraIndex" /> is less than 0 or greater than
  14425. <paramref name="raw2DFromPhys3Ds" />.Count - 1 </item><item><paramref name="planarFeaturePhys3D" /> is degenerate </item></list></exception>
  14426. </member>
  14427. <member name="T:Cognex.VisionPro3D.Cog3DTelecentricCamerasOperations">
  14428. <summary>
  14429. This class contains static methods that perform various operations for
  14430. telecentric cameras.
  14431. Telecentric cameras are cameras with telecentric lenses.
  14432. Note that this class is comprised of static methods.
  14433. </summary>
  14434. </member>
  14435. <member name="M:Cognex.VisionPro3D.Cog3DPlaneFitterUsing3DPoints.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  14436. <inheritdoc cref="!:ICog3DBase::GetObjectData" />
  14437. </member>
  14438. <member name="M:Cognex.VisionPro3D.Cog3DPlaneFitterUsing3DPoints.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  14439. <inheritdoc cref="!:ICog3DBase::SerializationConstructor" />
  14440. </member>
  14441. <member name="M:Cognex.VisionPro3D.Cog3DPlaneFitterUsing3DPoints.Execute(Cognex.VisionPro3D.Cog3DVect3Collection)">
  14442. <summary>
  14443. Fits a 3D plane from a 3D point set
  14444. </summary>
  14445. <param name="pointsPhys3D">
  14446. A 3D point collection.
  14447. </param>
  14448. <returns>
  14449. A Cog3DPlaneFitterUsing3DPointsResult containing the fitted plane and 3D
  14450. residuals.
  14451. </returns>
  14452. <exception cref="T:System.ArgumentNullException">
  14453. If the input argument is null.
  14454. </exception>
  14455. <exception cref="T:System.ArgumentException">
  14456. If <paramref name="pointsPhys3D" />.Count is less than 3.
  14457. </exception>
  14458. <exception cref="T:Cognex.VisionPro3D.Cog3DException">
  14459. If a 3D plane cannot be fitted.
  14460. </exception>
  14461. </member>
  14462. <member name="P:Cognex.VisionPro3D.Cog3DPlaneFitterUsing3DPoints.RobustFitParameters">
  14463. <inheritdoc cref="P:Cognex.VisionPro3D.Cog3DCircleFitterUsing3DPoints.RobustFitParameters" />
  14464. </member>
  14465. <member name="M:Cognex.VisionPro3D.Cog3DPlaneFitterUsing3DPoints.Finalize">
  14466. <inheritdoc cref="!:ICog3DBase::FinalizerForThisClass" />
  14467. </member>
  14468. <member name="M:Cognex.VisionPro3D.Cog3DPlaneFitterUsing3DPoints.Dispose">
  14469. <inheritdoc cref="!:ICog3DBase::DestructorForThisClass" />
  14470. </member>
  14471. <member name="M:Cognex.VisionPro3D.Cog3DPlaneFitterUsing3DPoints.#ctor(Cognex.VisionPro3D.Cog3DPlaneFitterUsing3DPoints)">
  14472. <inheritdoc cref="!:ICog3DBase::DeepCopyConstructorForThisClass" />
  14473. </member>
  14474. <member name="M:Cognex.VisionPro3D.Cog3DPlaneFitterUsing3DPoints.#ctor">
  14475. <summary>
  14476. Default constructor. Initializes this object for use.
  14477. Note that robust fit parameters are the same as the ones in
  14478. a default constructed
  14479. <see cref="M:Cognex.VisionPro3D.Cog3DRobustFitParameters.#ctor" />.
  14480. </summary>
  14481. </member>
  14482. <member name="T:Cognex.VisionPro3D.Cog3DPlaneFitterUsing3DPoints">
  14483. <summary>
  14484. This class provides 3D plane fitting from 3D points.
  14485. The 3D plane fitter computes the pose of a 3D plane
  14486. based on the specified 3D input points.
  14487. The fitting technique is controlled by the Cog3DRobustFitParameters.
  14488. See the Remarks section of the Cog3DRobustFitTechniqueConstants enum
  14489. and the Cog3DRobustFitParameters class for details.
  14490. </summary>
  14491. </member>
  14492. <member name="M:Cognex.VisionPro3D.Cog3DPlaneFitterUsing3DPointsResult.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  14493. <inheritdoc cref="!:ICog3DBase::GetObjectData" />
  14494. </member>
  14495. <member name="M:Cognex.VisionPro3D.Cog3DPlaneFitterUsing3DPointsResult.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  14496. <inheritdoc cref="!:ICog3DBase::SerializationConstructor" />
  14497. </member>
  14498. <member name="M:Cognex.VisionPro3D.Cog3DPlaneFitterUsing3DPointsResult.RealEqual(Cognex.VisionPro3D.Cog3DPlaneFitterUsing3DPointsResult,Cognex.VisionPro3D.Cog3DPlaneFitterUsing3DPointsResult,System.Double)">
  14499. <inheritdoc cref="!:ICog3DBase::RealEqual" />
  14500. </member>
  14501. <member name="M:Cognex.VisionPro3D.Cog3DPlaneFitterUsing3DPointsResult.ToString">
  14502. <inheritdoc cref="!:ICog3DBase::ToString" />
  14503. </member>
  14504. <member name="M:Cognex.VisionPro3D.Cog3DPlaneFitterUsing3DPointsResult.GetInlierIndices">
  14505. <summary>
  14506. Gets the indices of the data points classified as inliers
  14507. and included in the fit.
  14508. </summary>
  14509. <returns>
  14510. The list of indices of the data points classified as inliers.
  14511. </returns>
  14512. </member>
  14513. <member name="M:Cognex.VisionPro3D.Cog3DPlaneFitterUsing3DPointsResult.GetOutlierIndices">
  14514. <summary>
  14515. Gets the indices of the data points classified as outliers
  14516. and excluded from the fit.
  14517. </summary>
  14518. <returns>
  14519. The list of indices of the data points classified as outliers.
  14520. </returns>
  14521. </member>
  14522. <member name="P:Cognex.VisionPro3D.Cog3DPlaneFitterUsing3DPointsResult.ResidualsPhys3D">
  14523. <inheritdoc cref="!:ICog3DBase::ResidualsPhys3DUsing3DPoints" />
  14524. </member>
  14525. <member name="M:Cognex.VisionPro3D.Cog3DPlaneFitterUsing3DPointsResult.GetPlanePhys3D">
  14526. <summary>
  14527. Get a deep copy of the fitted 3D plane.
  14528. </summary>
  14529. <returns>
  14530. A deep copy of the fitted 3D plane.
  14531. </returns>
  14532. </member>
  14533. <member name="M:Cognex.VisionPro3D.Cog3DPlaneFitterUsing3DPointsResult.Finalize">
  14534. <inheritdoc cref="!:ICog3DBase::FinalizerForThisClass" />
  14535. </member>
  14536. <member name="M:Cognex.VisionPro3D.Cog3DPlaneFitterUsing3DPointsResult.Dispose">
  14537. <inheritdoc cref="!:ICog3DBase::DestructorForThisClass" />
  14538. </member>
  14539. <member name="M:Cognex.VisionPro3D.Cog3DPlaneFitterUsing3DPointsResult.#ctor(Cognex.VisionPro3D.Cog3DPlaneFitterUsing3DPointsResult)">
  14540. <inheritdoc cref="!:ICog3DBase::DeepCopyConstructorForThisClass" />
  14541. </member>
  14542. <member name="T:Cognex.VisionPro3D.Cog3DPlaneFitterUsing3DPointsResult">
  14543. <summary>
  14544. This class holds a result from a 3D plane fitting operation, where 3D
  14545. points have been used as input.
  14546. Note that this class is immutable - it may not be changed once
  14547. it has been constructed. The usage model for this class is that it
  14548. gets factoried by the Cog3DPlaneFitterUsing3DPoints class.
  14549. </summary>
  14550. </member>
  14551. <member name="M:Cognex.VisionPro3D.Cog3DLineFitterUsing3DPoints.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  14552. <inheritdoc cref="!:ICog3DBase::GetObjectData" />
  14553. </member>
  14554. <member name="M:Cognex.VisionPro3D.Cog3DLineFitterUsing3DPoints.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  14555. <inheritdoc cref="!:ICog3DBase::SerializationConstructor" />
  14556. </member>
  14557. <member name="M:Cognex.VisionPro3D.Cog3DLineFitterUsing3DPoints.Execute(Cognex.VisionPro3D.Cog3DVect3Collection)">
  14558. <summary>
  14559. Fits a 3D line from a 3D point set.
  14560. </summary>
  14561. <param name="pointsPhys3D">
  14562. A 3D point collection.
  14563. </param>
  14564. <returns>
  14565. A Cog3DLineFitterUsing3DPointsResult containing the fitted line and 3D
  14566. residuals.
  14567. </returns>
  14568. <exception cref="T:System.ArgumentNullException">
  14569. If the input argument is null.
  14570. </exception>
  14571. <exception cref="T:System.ArgumentException">
  14572. If <paramref name="pointsPhys3D" />.Count is less than 2.
  14573. </exception>
  14574. <exception cref="T:Cognex.VisionPro3D.Cog3DException">
  14575. If a 3D line cannot be fitted.
  14576. </exception>
  14577. </member>
  14578. <member name="P:Cognex.VisionPro3D.Cog3DLineFitterUsing3DPoints.RobustFitParameters">
  14579. <inheritdoc cref="P:Cognex.VisionPro3D.Cog3DCircleFitterUsing3DPoints.RobustFitParameters" />
  14580. </member>
  14581. <member name="M:Cognex.VisionPro3D.Cog3DLineFitterUsing3DPoints.Finalize">
  14582. <inheritdoc cref="!:ICog3DBase::FinalizerForThisClass" />
  14583. </member>
  14584. <member name="M:Cognex.VisionPro3D.Cog3DLineFitterUsing3DPoints.Dispose">
  14585. <inheritdoc cref="!:ICog3DBase::DestructorForThisClass" />
  14586. </member>
  14587. <member name="M:Cognex.VisionPro3D.Cog3DLineFitterUsing3DPoints.#ctor(Cognex.VisionPro3D.Cog3DLineFitterUsing3DPoints)">
  14588. <inheritdoc cref="!:ICog3DBase::DeepCopyConstructorForThisClass" />
  14589. </member>
  14590. <member name="M:Cognex.VisionPro3D.Cog3DLineFitterUsing3DPoints.#ctor">
  14591. <summary>
  14592. Default constructor. Initializes this object for use.
  14593. Note that robust fit parameters are the same as the ones in
  14594. a default constructed
  14595. <see cref="M:Cognex.VisionPro3D.Cog3DRobustFitParameters.#ctor" />.
  14596. </summary>
  14597. </member>
  14598. <member name="T:Cognex.VisionPro3D.Cog3DLineFitterUsing3DPoints">
  14599. <summary>
  14600. This class provides 3D line fitting from 3D points.
  14601. The 3D line fitter computes the pose of a 3D line
  14602. based on the specified 3D input points.
  14603. The fitting technique is controlled by the Cog3DRobustFitParameters.
  14604. See the Remarks section of the Cog3DRobustFitTechniqueConstants enum
  14605. and the Cog3DRobustFitParameters class for details.
  14606. </summary>
  14607. </member>
  14608. <member name="M:Cognex.VisionPro3D.Cog3DLineFitterUsing3DPointsResult.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  14609. <inheritdoc cref="!:ICog3DBase::GetObjectData" />
  14610. </member>
  14611. <member name="M:Cognex.VisionPro3D.Cog3DLineFitterUsing3DPointsResult.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  14612. <inheritdoc cref="!:ICog3DBase::SerializationConstructor" />
  14613. </member>
  14614. <member name="M:Cognex.VisionPro3D.Cog3DLineFitterUsing3DPointsResult.RealEqual(Cognex.VisionPro3D.Cog3DLineFitterUsing3DPointsResult,Cognex.VisionPro3D.Cog3DLineFitterUsing3DPointsResult,System.Double)">
  14615. <inheritdoc cref="!:ICog3DBase::RealEqual" />
  14616. </member>
  14617. <member name="M:Cognex.VisionPro3D.Cog3DLineFitterUsing3DPointsResult.ToString">
  14618. <inheritdoc cref="!:ICog3DBase::ToString" />
  14619. </member>
  14620. <member name="M:Cognex.VisionPro3D.Cog3DLineFitterUsing3DPointsResult.GetInlierIndices">
  14621. <summary>
  14622. Gets the indices of the data points classified as inliers
  14623. and included in the fit.
  14624. </summary>
  14625. <returns>
  14626. The list of indices of the data points classified as inliers.
  14627. </returns>
  14628. </member>
  14629. <member name="M:Cognex.VisionPro3D.Cog3DLineFitterUsing3DPointsResult.GetOutlierIndices">
  14630. <summary>
  14631. Gets the indices of the data points classified as outliers
  14632. and excluded from the fit.
  14633. </summary>
  14634. <returns>
  14635. The list of indices of the data points classified as outliers.
  14636. </returns>
  14637. </member>
  14638. <member name="P:Cognex.VisionPro3D.Cog3DLineFitterUsing3DPointsResult.ResidualsPhys3D">
  14639. <inheritdoc cref="!:ICog3DBase::ResidualsPhys3DUsing3DPoints" />
  14640. </member>
  14641. <member name="M:Cognex.VisionPro3D.Cog3DLineFitterUsing3DPointsResult.GetLinePhys3D">
  14642. <summary>
  14643. Get a deep copy of the fitted 3D line.
  14644. </summary>
  14645. <returns>
  14646. A deep copy of the fitted 3D line.
  14647. </returns>
  14648. <exception cref="T:Cognex.VisionPro3D.Cog3DException">
  14649. If IsFound is false.
  14650. </exception>
  14651. </member>
  14652. <member name="M:Cognex.VisionPro3D.Cog3DLineFitterUsing3DPointsResult.Finalize">
  14653. <inheritdoc cref="!:ICog3DBase::FinalizerForThisClass" />
  14654. </member>
  14655. <member name="M:Cognex.VisionPro3D.Cog3DLineFitterUsing3DPointsResult.Dispose">
  14656. <inheritdoc cref="!:ICog3DBase::DestructorForThisClass" />
  14657. </member>
  14658. <member name="M:Cognex.VisionPro3D.Cog3DLineFitterUsing3DPointsResult.#ctor(Cognex.VisionPro3D.Cog3DLineFitterUsing3DPointsResult)">
  14659. <inheritdoc cref="!:ICog3DBase::DeepCopyConstructorForThisClass" />
  14660. </member>
  14661. <member name="T:Cognex.VisionPro3D.Cog3DLineFitterUsing3DPointsResult">
  14662. <summary>
  14663. This class holds a result from a 3D line fitting operation, where 3D points
  14664. have been used as input.
  14665. Note that this class is immutable - it may not be changed once
  14666. it has been constructed. The usage model for this class is that it
  14667. gets factoried by the Cog3DLineFitterUsing3DPoints class.
  14668. </summary>
  14669. </member>
  14670. <member name="M:Cognex.VisionPro3D.Cog3DCircleFitterUsing3DPoints.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  14671. <inheritdoc cref="!:ICog3DBase::GetObjectData" />
  14672. </member>
  14673. <member name="M:Cognex.VisionPro3D.Cog3DCircleFitterUsing3DPoints.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  14674. <inheritdoc cref="!:ICog3DBase::SerializationConstructor" />
  14675. </member>
  14676. <member name="M:Cognex.VisionPro3D.Cog3DCircleFitterUsing3DPoints.Execute(Cognex.VisionPro3D.Cog3DVect3Collection)">
  14677. <summary>
  14678. Fits a 3D circle from a 3D point set.
  14679. </summary>
  14680. <param name="pointsPhys3D">
  14681. A 3D point collection.
  14682. </param>
  14683. <returns>
  14684. A Cog3DCircleFitterUsing3DPointsResult containing the fitted circle
  14685. and 3D residuals.
  14686. </returns>
  14687. <exception cref="T:System.ArgumentNullException">
  14688. If the input argument is null.
  14689. </exception>
  14690. <exception cref="T:System.ArgumentException">
  14691. If <paramref name="pointsPhys3D" />.Count is less than 3.
  14692. </exception>
  14693. <exception cref="T:Cognex.VisionPro3D.Cog3DException">
  14694. If a 3D circle cannot be fitted.
  14695. </exception>
  14696. </member>
  14697. <member name="P:Cognex.VisionPro3D.Cog3DCircleFitterUsing3DPoints.RobustFitParameters">
  14698. <summary>
  14699. Gets/sets the robust fitting parameters.
  14700. </summary>
  14701. <value>
  14702. A Cog3DRobustFitParameters containing the robust fitting parameters.
  14703. </value>
  14704. <exception cref="T:System.ArgumentNullException">
  14705. If the input argument to the setter is null.
  14706. </exception>
  14707. </member>
  14708. <member name="M:Cognex.VisionPro3D.Cog3DCircleFitterUsing3DPoints.Finalize">
  14709. <inheritdoc cref="!:ICog3DBase::FinalizerForThisClass" />
  14710. </member>
  14711. <member name="M:Cognex.VisionPro3D.Cog3DCircleFitterUsing3DPoints.Dispose">
  14712. <inheritdoc cref="!:ICog3DBase::DestructorForThisClass" />
  14713. </member>
  14714. <member name="M:Cognex.VisionPro3D.Cog3DCircleFitterUsing3DPoints.#ctor(Cognex.VisionPro3D.Cog3DCircleFitterUsing3DPoints)">
  14715. <inheritdoc cref="!:ICog3DBase::DeepCopyConstructorForThisClass" />
  14716. </member>
  14717. <member name="M:Cognex.VisionPro3D.Cog3DCircleFitterUsing3DPoints.#ctor">
  14718. <summary>
  14719. Default constructor. Initializes this object for use.
  14720. Note that robust fit parameters are the same as the ones in
  14721. a default constructed
  14722. <see cref="M:Cognex.VisionPro3D.Cog3DRobustFitParameters.#ctor" />.
  14723. </summary>
  14724. </member>
  14725. <member name="T:Cognex.VisionPro3D.Cog3DCircleFitterUsing3DPoints">
  14726. <summary>
  14727. This class provides 3D circle fitting from 3D points.
  14728. The 3D circle fitter computes the pose of a 3D circle
  14729. based on the specified 3D input points.
  14730. The fitting technique is controlled by the Cog3DRobustFitParameters.
  14731. See the Remarks section of the Cog3DRobustFitTechniqueConstants enum
  14732. and the Cog3DRobustFitParameters class for details.
  14733. </summary>
  14734. </member>
  14735. <member name="M:Cognex.VisionPro3D.Cog3DCircleFitterUsing3DPointsResult.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  14736. <inheritdoc cref="!:ICog3DBase::GetObjectData" />
  14737. </member>
  14738. <member name="M:Cognex.VisionPro3D.Cog3DCircleFitterUsing3DPointsResult.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  14739. <inheritdoc cref="!:ICog3DBase::SerializationConstructor" />
  14740. </member>
  14741. <member name="M:Cognex.VisionPro3D.Cog3DCircleFitterUsing3DPointsResult.RealEqual(Cognex.VisionPro3D.Cog3DCircleFitterUsing3DPointsResult,Cognex.VisionPro3D.Cog3DCircleFitterUsing3DPointsResult,System.Double)">
  14742. <inheritdoc cref="!:ICog3DBase::RealEqual" />
  14743. </member>
  14744. <member name="M:Cognex.VisionPro3D.Cog3DCircleFitterUsing3DPointsResult.ToString">
  14745. <inheritdoc cref="!:ICog3DBase::ToString" />
  14746. </member>
  14747. <member name="M:Cognex.VisionPro3D.Cog3DCircleFitterUsing3DPointsResult.GetInlierIndices">
  14748. <summary>
  14749. Gets the indices of the data points classified as inliers
  14750. and included in the fit.
  14751. </summary>
  14752. <returns>
  14753. The list of indices of the data points classified as inliers.
  14754. </returns>
  14755. </member>
  14756. <member name="M:Cognex.VisionPro3D.Cog3DCircleFitterUsing3DPointsResult.GetOutlierIndices">
  14757. <summary>
  14758. Gets the indices of the data points classified as outliers
  14759. and excluded from the fit.
  14760. </summary>
  14761. <returns>
  14762. The list of indices of the data points classified as outliers.
  14763. </returns>
  14764. </member>
  14765. <member name="P:Cognex.VisionPro3D.Cog3DCircleFitterUsing3DPointsResult.ResidualsPhys3D">
  14766. <inheritdoc cref="!:ICog3DBase::ResidualsPhys3DUsing3DPoints" />
  14767. </member>
  14768. <member name="M:Cognex.VisionPro3D.Cog3DCircleFitterUsing3DPointsResult.GetCirclePhys3D">
  14769. <summary>
  14770. Get a deep copy of the fitted 3D circle.
  14771. </summary>
  14772. <returns>
  14773. A deep copy of the fitted 3D circle.
  14774. </returns>
  14775. </member>
  14776. <member name="M:Cognex.VisionPro3D.Cog3DCircleFitterUsing3DPointsResult.Finalize">
  14777. <inheritdoc cref="!:ICog3DBase::FinalizerForThisClass" />
  14778. </member>
  14779. <member name="M:Cognex.VisionPro3D.Cog3DCircleFitterUsing3DPointsResult.Dispose">
  14780. <inheritdoc cref="!:ICog3DBase::DestructorForThisClass" />
  14781. </member>
  14782. <member name="M:Cognex.VisionPro3D.Cog3DCircleFitterUsing3DPointsResult.#ctor(Cognex.VisionPro3D.Cog3DCircleFitterUsing3DPointsResult)">
  14783. <inheritdoc cref="!:ICog3DBase::DeepCopyConstructorForThisClass" />
  14784. </member>
  14785. <member name="T:Cognex.VisionPro3D.Cog3DCircleFitterUsing3DPointsResult">
  14786. <summary>
  14787. This class holds a result from a 3D circle fitting operation, where 3D
  14788. points have been used as input.
  14789. Note that this class is immutable - it may not be changed once
  14790. it has been constructed. The usage model for this class is that it
  14791. gets factoried by the Cog3DCircleFitterUsing3DPoints class.
  14792. </summary>
  14793. </member>
  14794. <member name="M:Cognex.VisionPro3D.Cog3DRobustFitParameters.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  14795. <inheritdoc cref="!:ICog3DBase::GetObjectData" />
  14796. </member>
  14797. <member name="M:Cognex.VisionPro3D.Cog3DRobustFitParameters.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  14798. <inheritdoc cref="!:ICog3DBase::SerializationConstructor" />
  14799. </member>
  14800. <member name="M:Cognex.VisionPro3D.Cog3DRobustFitParameters.RealEqual(Cognex.VisionPro3D.Cog3DRobustFitParameters,Cognex.VisionPro3D.Cog3DRobustFitParameters,System.Double)">
  14801. <inheritdoc cref="!:ICog3DBase::RealEqual" />
  14802. </member>
  14803. <member name="M:Cognex.VisionPro3D.Cog3DRobustFitParameters.ToString">
  14804. <inheritdoc cref="!:ICog3DBase::ToString" />
  14805. </member>
  14806. <member name="P:Cognex.VisionPro3D.Cog3DRobustFitParameters.WorstCaseProportionOutliers">
  14807. <summary>
  14808. Gets/sets the worst case proportion of outliers that is expected
  14809. in the data points used for model fitting.
  14810. </summary>
  14811. <value>
  14812. The worst case proportion of outliers.
  14813. </value>
  14814. <exception cref="T:System.ArgumentException">
  14815. If the input argument to the setter is less than 0.0, or larger than or equal
  14816. to 1.0.
  14817. </exception>
  14818. <remarks>
  14819. This property will be used if RobustFitTechnique
  14820. is Cog3DRobustFitTechniqueConstants.AdaptiveRANSAC.
  14821. <para> If WorstCaseProportionOutliers is 0, all the input points are used
  14822. for fitting.
  14823. </para></remarks>
  14824. </member>
  14825. <member name="P:Cognex.VisionPro3D.Cog3DRobustFitParameters.Assurance">
  14826. <summary>
  14827. Gets/sets the proportion assurance. This parameter is the desired
  14828. likelihood that the computed fit contains only inliers.
  14829. </summary>
  14830. <value>
  14831. The proportion assurance.
  14832. </value>
  14833. <exception cref="T:System.ArgumentException">
  14834. If the input argument to the setter is less than or equal to 0.0, or larger than 1.0.
  14835. </exception>
  14836. <remarks>
  14837. If Assurance is 1.0, and if
  14838. RobustFitTechnique is Cog3DRobustFitTechniqueConstants.AdaptiveRANSAC, the
  14839. exhaustive technique is executed.
  14840. <para> This property will be used if RobustFitTechnique
  14841. is Cog3DRobustFitTechniqueConstants.AdaptiveRANSAC. </para></remarks>
  14842. </member>
  14843. <member name="P:Cognex.VisionPro3D.Cog3DRobustFitParameters.DistanceThreshold">
  14844. <summary>
  14845. Gets/sets the distance threshold. If the absolute distance between a
  14846. point and the model is greater than this parameter, then the point is
  14847. considered to be an outlier.
  14848. </summary>
  14849. <value>
  14850. The distance threshold.
  14851. </value>
  14852. <exception cref="T:System.ArgumentException">
  14853. If the input argument to the setter is less than 0.0.
  14854. </exception>
  14855. <remarks>
  14856. This property will be used if RobustFitTechnique is
  14857. Cog3DRobustFitTechniqueConstants.AdaptiveRANSAC.
  14858. </remarks>
  14859. </member>
  14860. <member name="P:Cognex.VisionPro3D.Cog3DRobustFitParameters.RobustFitTechnique">
  14861. <summary>
  14862. Gets/sets the type of robust fit technique to be employed.
  14863. </summary>
  14864. <value>
  14865. The type of robust fit technique to be employed.
  14866. </value>
  14867. <exception cref="T:System.ArgumentException">
  14868. If the input argument to the setter is not a valid
  14869. Cog3DRobustFitTechniqueConstants value.
  14870. </exception>
  14871. </member>
  14872. <member name="M:Cognex.VisionPro3D.Cog3DRobustFitParameters.Finalize">
  14873. <inheritdoc cref="!:ICog3DBase::FinalizerForThisClass" />
  14874. </member>
  14875. <member name="M:Cognex.VisionPro3D.Cog3DRobustFitParameters.Dispose">
  14876. <inheritdoc cref="!:ICog3DBase::DestructorForThisClass" />
  14877. </member>
  14878. <member name="M:Cognex.VisionPro3D.Cog3DRobustFitParameters.#ctor(Cognex.VisionPro3D.Cog3DRobustFitParameters)">
  14879. <inheritdoc cref="!:ICog3DBase::DeepCopyConstructorForThisClass" />
  14880. </member>
  14881. <member name="M:Cognex.VisionPro3D.Cog3DRobustFitParameters.#ctor">
  14882. <summary>
  14883. Default constructor. Default values are:
  14884. <list type="bullet"><item> RobustFitTechnique is Cog3DRobustFitTechniqueConstants.AllPoints
  14885. </item><item> DistanceThreshold is 1.0 </item><item> Assurance is 1.0 </item><item> WorstCaseProportionOutliers is 0.0 </item></list></summary>
  14886. </member>
  14887. <member name="T:Cognex.VisionPro3D.Cog3DRobustFitParameters">
  14888. <summary>
  14889. This class defines the robust fitting parameters that modify the behavior
  14890. of robust fitters.
  14891. </summary>
  14892. <remarks>
  14893. <para>
  14894. Classical techniques for parameter estimation, such as least squares,
  14895. optimize (according to a specified objective function) the fit of a
  14896. functional description (model) to all of the presented data. These techniques
  14897. have no internal mechanisms for detecting and rejecting gross errors in the data. They
  14898. are averaging techniques that rely on the assumption (the smoothing
  14899. assumption) that regardless of the size of the data set, there will always be
  14900. enough good values to smooth out any gross deviations.
  14901. </para>
  14902. <para>
  14903. In many practical parameter estimation problems the smoothing assumption
  14904. does not hold; i.e., the data contain uncompensated gross errors. To deal
  14905. with this situation, several heuristics have been proposed. The technique
  14906. usually employed is some variation of first using all the data to derive the
  14907. model parameters, then locating the datum that is farthest from agreement
  14908. with the instantiated model, assuming that it is a gross error, deleting it,
  14909. and iterating this process until either the maximum deviation is less then
  14910. some preset threshold or until there is no longer sufficient data to
  14911. proceed. It can easily be shown that a single gross error ("poisoned
  14912. point"), mixed in with a set of good data, can cause the above heuristic to
  14913. fail. Robust fitters use techniques that get around this shortcoming.
  14914. </para>
  14915. <para>
  14916. See the Remarks section of the Cog3DRobustFitTechniqueConstansts enum
  14917. for details on fitting techniques.
  14918. </para>
  14919. </remarks>
  14920. </member>
  14921. <member name="T:Cognex.VisionPro3D.Cog3DRobustFitTechniqueConstants">
  14922. <summary>
  14923. This class defines the enumeration constants for robust fitting techniques.
  14924. </summary>
  14925. <remarks>
  14926. RANSAC is a very popular technique and information about RANSAC can be
  14927. obtained from a number of sources.
  14928. One such source is "Random Sample Consensus: A paradigm for Model
  14929. fitting with Application to Image Analysis and Automated Cryptography",
  14930. Martin A. Fischler and Robert C. Bolles, Communications of ACM, June
  14931. 1981, Volume 24, Number 6, 381-395.
  14932. <para>
  14933. In the Adaptive RANSAC approach the number of tries is computed
  14934. adaptively. It is often the case that the proportion of outliers is not
  14935. known. In such cases the algorithm is initialized using the worst case
  14936. estimate of the proportion of outliers. The distance threshold t is
  14937. assumed to be specified. </para><para> The following is the outline of the approach. </para><list type="number"><item> Inputs:
  14938. <list type="bullet"><item> Data points. </item><item> Distance threshold, t. </item><item> The worst case proportion of data points that are outliers, w.
  14939. An outlier is a data point that is further away than t.</item><item> Proportion assurance, z. This is the likelihood that the
  14940. computed fit contains only inliers.</item></list></item><item> Compute the number of tries based upon w.</item><item> Randomly select a sample of s data points from a data set S and
  14941. instantiate the model from this subset, where s is the minimum number
  14942. of data points that are required to instantiate the free parameters of
  14943. the model.</item><item> Identify all the points that are within the distance threshold t. The
  14944. number of such points will be the number of inliers.</item><item> Set w = (number of outliers)/(total number of points).</item><item> Recompute the number of tries using w and z. </item><item> If the total number of tries thus far is greater than the number of
  14945. tries computed above, terminate the algorithm. Otherwise, repeat
  14946. steps 3-7.</item><item> Re-estimate the model using all the inliers.</item><item> Refine the above model by recategorizing the data points as inliers
  14947. and outliers and fitting to the inliers.</item><item> Repeat step 9. for a maximum of three times or until the number of
  14948. inliers ceases to increase</item></list><para>
  14949. It should be noted that the above technique is executed only if the
  14950. proportion assurance is less than 1. If not, an exhaustive technique
  14951. described below is executed. </para><list type="number"><item> The WorstCaseProportionOutliers is assumed to be the true proportion
  14952. of outliers and the number of inliers are computed.</item><item> If there are n input points and m outliers, a combinations generator
  14953. that generates nC(n-m) combinations is initialized.</item><item> A combination of points are considered as being inliers and the model
  14954. is computed.</item><item> The actual number of inliers for the above model is computed. If the
  14955. number of inliers is less than the expected number of inliers, steps
  14956. 3-4 is repeated until all the combinations are tested. If after
  14957. testing all combinations, a model could not be computed, the
  14958. algorithm will
  14959. terminate.</item><item> Re-estimate the model using all the inliers.</item><item> Refine the above model by recategorizing the data points as inliers
  14960. and outliers and fitting to the inliers.</item><item> Repeat step 6. for a maximum of three times or until the number of
  14961. inliers ceases to increase.</item></list></remarks>
  14962. </member>
  14963. <member name="F:Cognex.VisionPro3D.Cog3DRobustFitTechniqueConstants.AdaptiveRANSAC">
  14964. <summary>
  14965. Use Adaptive RANSAC robust fitting technique. See Remarks section.
  14966. </summary>
  14967. </member>
  14968. <member name="F:Cognex.VisionPro3D.Cog3DRobustFitTechniqueConstants.AllPoints">
  14969. <summary>
  14970. Do not use any robust fitting technique.
  14971. </summary>
  14972. </member>
  14973. <member name="M:Cognex.VisionPro3D.Cog3DHandEyeCalibrationValidator.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  14974. <inheritdoc cref="!:ICog3DBase::SerializationConstructor" />
  14975. </member>
  14976. <member name="M:Cognex.VisionPro3D.Cog3DHandEyeCalibrationValidator.Execute(System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCrspFeaturesCollection},System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DTransformRigid},Cognex.VisionPro3D.Cog3DHandEyeCalibrationResult)">
  14977. <summary>
  14978. Validate the specified hand-eye calibration result using the specified
  14979. calibration features and robot poses,
  14980. and then return the hand-eye calibration validation result.
  14981. </summary>
  14982. <param name="crspFeatures">
  14983. A list of feature correspondences from the camera viewing the calibration plate.
  14984. The list of feature correspondences are indexed
  14985. by the robot hand pose. <paramref name="crspFeatures" />[i] corresponds to the
  14986. ith robot pose. May not be null.
  14987. </param>
  14988. <param name="robotBase3DFromHand3Ds">
  14989. A list of Cog3DTransformRigid's defining the robot hand poses.
  14990. The list is indexed by robot hand pose.
  14991. The size of this list must match the size of <paramref name="crspFeatures" />. May not be null.
  14992. </param>
  14993. <param name="handEyeCalibrationResult">
  14994. The hand-eye calibration result to be validated.
  14995. </param>
  14996. <exception cref="T:System.ArgumentNullException">
  14997. If any input argument is null or any input argument includes a null item
  14998. (except <paramref name="crspFeatures" />[i].Weights).
  14999. </exception>
  15000. <exception cref="T:System.ArgumentException">
  15001. If input arguments do not match, e.g.
  15002. <list type="bullet"><item> If <paramref name="crspFeatures" />.Count !=
  15003. <paramref name="robotBase3DFromHand3Ds" />.Count; </item><item> If <paramref name="robotBase3DFromHand3Ds" />.Count is less than 2. </item><item> If <paramref name="crspFeatures" />[i].PointsModel3D.Count !=
  15004. <paramref name="crspFeatures" />[i].PointsRaw2D.Count
  15005. (i is inside [0, <paramref name="crspFeatures" />.Count-1]);</item><item> If <paramref name="crspFeatures" />[i].Weights is not null,
  15006. and <paramref name="crspFeatures" />[i].Weights.Count !=
  15007. <paramref name="crspFeatures" />[i].PointsModel3D.Count
  15008. (i is inside [0, <paramref name="crspFeatures" />.Count-1]);</item></list></exception>
  15009. <returns>
  15010. The hand-eye calibration validation result.
  15011. </returns>
  15012. <remarks>
  15013. Notes:
  15014. <list type="bullet"><item> This tool requires at least 2 sets of features, and
  15015. can provide more accurate results if more sets of features
  15016. (corresponding to distinct robot hand poses) are provided. </item><item> This tool requires all of the elements in <paramref name="crspFeatures" />
  15017. to be from the same camera. </item><item> The returned hand-eye calibration validation result includes a camera calibration validation result
  15018. characterizing the accuracy of the camera intrinsics, and 3D residuals characterizing
  15019. the accuracy of the whole hand-eye system. </item></list></remarks>
  15020. </member>
  15021. <member name="M:Cognex.VisionPro3D.Cog3DHandEyeCalibrationValidator.Finalize">
  15022. <inheritdoc cref="!:ICog3DBase::FinalizerForThisClass" />
  15023. </member>
  15024. <member name="M:Cognex.VisionPro3D.Cog3DHandEyeCalibrationValidator.Dispose">
  15025. <inheritdoc cref="!:ICog3DBase::DestructorForThisClass" />
  15026. </member>
  15027. <member name="M:Cognex.VisionPro3D.Cog3DHandEyeCalibrationValidator.#ctor(Cognex.VisionPro3D.Cog3DHandEyeCalibrationValidator)">
  15028. <inheritdoc cref="!:ICog3DBase::DeepCopyConstructorForThisClass" />
  15029. </member>
  15030. <member name="M:Cognex.VisionPro3D.Cog3DHandEyeCalibrationValidator.#ctor">
  15031. <summary>
  15032. Construct this default Cog3DHandEyeCalibrationValidator.
  15033. </summary>
  15034. </member>
  15035. <member name="T:Cognex.VisionPro3D.Cog3DHandEyeCalibrationValidator">
  15036. <summary>
  15037. This class is for validating an existing 3D hand-eye calibration for
  15038. one camera. The validation step accepts as inputs the
  15039. original hand-eye calibration, a set of robot poses, and a corresponding set of feature positions.
  15040. The output of the validation is a hand-eye validation result object.
  15041. the hand-eye validation result object contains a camera calibration validation result
  15042. and residuals for the hand-eye calibration validation. These
  15043. characterize the accuracy of the hand-eye system. The accuracy can be compared
  15044. to "baseline"
  15045. accuracy estimates from calibration time in order to determine if
  15046. the hand-eye system is still in calibration.
  15047. </summary>
  15048. <remarks>
  15049. A "baseline" validation should be performed immediately
  15050. after hand-eye calibration. That baseline validation step should involve
  15051. multiple view sets so that one can estimate the distribution of residuals.
  15052. The "baseline" validation measurements are
  15053. stored for future comparison.
  15054. <para> Then, at some arbitrary time (usually after the
  15055. system performed vision tasks for a period of time), the user
  15056. acquires images of the same calibration plate in some
  15057. set of (preferrably, the same) robot poses and executes hand-eye calibration validation to get the "current"
  15058. measurements. Finally, the user compares the "current" validation
  15059. measurements with the "baseline". </para><para> If the "current" measurements agree with the "baseline"
  15060. measurements to a satisfactory degree, then the system is in
  15061. calibration and the user does not need to perform any
  15062. recalibration.
  15063. If the measurements inside the camera calibration validation results
  15064. satisfactorily agree, but the measurements of hand-eye validation residuals
  15065. do not satisfactorily agree, then the user can use the baseline camera intrinsics
  15066. to re-perform hand-eye calibration.
  15067. If camera calibration validation results do not agree
  15068. and the hand-eye calibration validation results do not agree,
  15069. then camera calibration and hand-eye calibration both need to be performed again. </para></remarks>
  15070. </member>
  15071. <member name="M:Cognex.VisionPro3D.Cog3DLensDistortionCorrector.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  15072. <inheritdoc cref="!:ICog3DBase::GetObjectData" />
  15073. </member>
  15074. <member name="M:Cognex.VisionPro3D.Cog3DLensDistortionCorrector.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  15075. <inheritdoc cref="!:ICog3DBase::SerializationConstructor" />
  15076. </member>
  15077. <member name="M:Cognex.VisionPro3D.Cog3DLensDistortionCorrector.RealEqual(Cognex.VisionPro3D.Cog3DLensDistortionCorrector,Cognex.VisionPro3D.Cog3DLensDistortionCorrector,System.Double)">
  15078. <inheritdoc cref="!:ICog3DBase::RealEqual" />
  15079. </member>
  15080. <member name="M:Cognex.VisionPro3D.Cog3DLensDistortionCorrector.Execute(Cognex.VisionPro.ICogImage)">
  15081. <summary>
  15082. Perform image correction (lens distortion removal) on the specified image.
  15083. Use Raw2DFromPhys3DUsingCorrectImage as the camera calibration for the returned, corrected image.
  15084. </summary>
  15085. <param name="image">
  15086. The raw image to correct.
  15087. </param>
  15088. <exception cref="T:System.ArgumentNullException">
  15089. If the input argument is null.
  15090. </exception>
  15091. <exception cref="T:Cognex.VisionPro3D.Cog3DException">
  15092. If IsTrained is false.
  15093. </exception>
  15094. <returns>
  15095. The corrected image.
  15096. </returns>
  15097. </member>
  15098. <member name="M:Cognex.VisionPro3D.Cog3DLensDistortionCorrector.Untrain">
  15099. <summary>
  15100. Discard the trained data. Note that IsTrained will return false until Train() is called again.
  15101. </summary>
  15102. </member>
  15103. <member name="M:Cognex.VisionPro3D.Cog3DLensDistortionCorrector.Train(Cognex.VisionPro3D.Cog3DCameraCalibration)">
  15104. <summary>
  15105. Train the image corrector using the specified camera calibration.
  15106. </summary>
  15107. <param name="raw2DFromPhys3D">
  15108. The camera calibration associated with the raw (acquired) images.
  15109. </param>
  15110. <exception cref="T:System.ArgumentNullException">
  15111. If <paramref name="raw2DFromPhys3D" /> is null.
  15112. </exception>
  15113. <exception cref="T:System.InvalidOperationException">
  15114. If <paramref name="raw2DFromPhys3D" />.IsTelecentric is true.
  15115. </exception>
  15116. </member>
  15117. <member name="P:Cognex.VisionPro3D.Cog3DLensDistortionCorrector.Raw2DFromPhys3DUsingCorrectedImage">
  15118. <summary>
  15119. Gets the camera calibration produced at training-time.
  15120. This is the camera calibration which should be used with the corrected images.
  15121. </summary>
  15122. <value>
  15123. The camera calibration to be used with the corrected images.
  15124. </value>
  15125. <exception cref="T:Cognex.VisionPro3D.Cog3DException">
  15126. If IsTrained is false.
  15127. </exception>
  15128. </member>
  15129. <member name="P:Cognex.VisionPro3D.Cog3DLensDistortionCorrector.IsTrained">
  15130. <summary>
  15131. Gets whether this image corrector is trained.
  15132. </summary>
  15133. <value>
  15134. True if it is trained, and false otherwise.
  15135. </value>
  15136. </member>
  15137. <member name="M:Cognex.VisionPro3D.Cog3DLensDistortionCorrector.Finalize">
  15138. <inheritdoc cref="!:ICog3DBase::FinalizerForThisClass" />
  15139. </member>
  15140. <member name="M:Cognex.VisionPro3D.Cog3DLensDistortionCorrector.Dispose">
  15141. <inheritdoc cref="!:ICog3DBase::DestructorForThisClass" />
  15142. </member>
  15143. <member name="M:Cognex.VisionPro3D.Cog3DLensDistortionCorrector.#ctor(Cognex.VisionPro3D.Cog3DLensDistortionCorrector)">
  15144. <inheritdoc cref="!:ICog3DBase::DeepCopyConstructorForThisClass" />
  15145. </member>
  15146. <member name="M:Cognex.VisionPro3D.Cog3DLensDistortionCorrector.#ctor">
  15147. <summary>
  15148. Construct this default Cog3DLensDistortionCorrector. Note that IsTrained is false.
  15149. </summary>
  15150. </member>
  15151. <member name="T:Cognex.VisionPro3D.Cog3DLensDistortionCorrector">
  15152. <summary>
  15153. This class provides lens distortion correction based on a camera calibration.
  15154. At training-time, this class trains an image corrector using the lens distortion data in a camera calibration, and
  15155. produces a new camera calibration to be used with corrected images.
  15156. At run-time, via the Execute() method, this class converts an acquired (raw) image into
  15157. a corrected image where the lens distortion has been removed.
  15158. </summary>
  15159. <remarks>
  15160. The new camera calibration produced at training-time (Raw2DFromPhys3DUsingCorrectedImage) has
  15161. a distortion model of Cog3DCameraCalibrationDistortionModelConstants.eNoDistortion, and
  15162. has extrinsic parameters (Raw2DFromPhys3DUsingCorrectedImage.Camera3DFromPhys3D) that
  15163. are the same as the original camera calibration (specified at training-time) extrinsic parameters.
  15164. <para>
  15165. 2D features in the corrected image mapped to 3D rays in Phys3D space using
  15166. Raw2DFromPhys3DUsingCorrectedImage, correspond to exactly
  15167. the same 3D rays as corresponding 2D features in the
  15168. uncorrected image mapped using the original camera calibration specified at training-time.
  15169. </para></remarks>
  15170. </member>
  15171. <member name="M:Cognex.VisionPro3D.Cog3DCircleFitterUsing2DPoints.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  15172. <inheritdoc cref="!:ICog3DBase::GetObjectData" />
  15173. </member>
  15174. <member name="M:Cognex.VisionPro3D.Cog3DCircleFitterUsing2DPoints.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  15175. <inheritdoc cref="!:ICog3DBase::SerializationConstructor" />
  15176. </member>
  15177. <member name="M:Cognex.VisionPro3D.Cog3DCircleFitterUsing2DPoints.Execute(System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCameraCalibration},System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DVect2Collection})">
  15178. <summary>
  15179. Fits a 3D circle from 2D point sets and a set of camera calibrations.
  15180. Each 2D point set must have been extracted from different cameras or views.
  15181. The 2D point sets from the different cameras or views do not need to correspond,
  15182. but they must lie on the same 3D circle.
  15183. </summary>
  15184. <param name="raw2DFromPhys3Ds">
  15185. The camera calibrations used during the extraction of the 2D points.
  15186. The size of this list defines the number of cameras or views used.
  15187. </param>
  15188. <param name="pointsRaw2D">
  15189. The List of 2D point collections, one collection per camera or view.
  15190. The size of the list must be equal to the number of cameras/views.
  15191. </param>
  15192. <returns>
  15193. A List containing 1 or 2 Cog3DCircleFitterUsing2DPointsResult objects (see Remarks section).
  15194. Each result object contains the fitted 3D circle and 2D/3D residuals.
  15195. </returns>
  15196. <exception cref="T:System.ArgumentNullException">
  15197. If any input argument is null.
  15198. </exception>
  15199. <exception cref="T:System.ArgumentException">
  15200. If one of the following is true:
  15201. <list type="bullet"><item> The number of camera calibrations is less than 1. </item><item> The number of camera calibrations does not match the number of 2D point collections. </item><item> FitMode is Cog3DCircleFitterUsing2DPointsFitModeConstant.LeastSquaresUseSpecifiedRadius and Radius is 0.</item><item> FitMode is Cog3DCircleFitterUsing2DPointsFitModeConstant.LeastSquaresComputeRadius and only one camera calibration is provided.</item><item> None of the individual collections of 2D points contain five or more points. </item><item> If any of the camera calibrations have telecentric lens distortion. </item></list></exception>
  15202. <exception cref="T:Cognex.VisionPro3D.Cog3DException">
  15203. If a 3D circle cannot be fitted.
  15204. </exception>
  15205. <remarks>
  15206. This Execute method may return at
  15207. most two results. It returns a single result if
  15208. there is one unambiguous 3D circle which induces the minimum sum
  15209. squared image error. It returns two different 3D circles
  15210. if there are two different 3D circles which induce similar sum squared image errors
  15211. (For an explanation of why there are at most 2
  15212. different circles that match the image data, refer to the Forsyth et al paper "Invariant Descriptors for 3D
  15213. Object Recognition" which appeared in IEEE PAMI, Vol. 13, No. 10,
  15214. October 1991, pages 971 - 991)).
  15215. </remarks>
  15216. </member>
  15217. <member name="P:Cognex.VisionPro3D.Cog3DCircleFitterUsing2DPoints.FitMode">
  15218. <summary>
  15219. Gets/sets the fit mode for circle fitting.
  15220. </summary>
  15221. <value>
  15222. The fit mode for circle fitting.
  15223. </value>
  15224. <exception cref="T:System.ArgumentException">
  15225. If invalid fit mode is used in the setter.
  15226. </exception>
  15227. <remarks>
  15228. If FitMode is
  15229. Cog3DCircleFitterUsing2DPointsFitModeConstants.eLeastSquaresUseSpecifiedRadius, then Execute
  15230. will use the value of Radius. If FitMode is
  15231. Cog3DCircleFitterUsing2DPointsFitModeConstants.eLeastSquaresComputeRadius, then
  15232. Execute will ignore the value of Radius.
  15233. </remarks>
  15234. </member>
  15235. <member name="P:Cognex.VisionPro3D.Cog3DCircleFitterUsing2DPoints.Radius">
  15236. <summary>
  15237. Gets/sets the expected radius of the circle to find.
  15238. </summary>
  15239. <value>
  15240. The expected radius of the circle to find.
  15241. </value>
  15242. <exception cref="T:System.ArgumentException">
  15243. If <paramref name="newRadius" /> is less than 0.
  15244. </exception>
  15245. <remarks>
  15246. If FitMode is
  15247. Cog3DCircleFitterUsing2DPointsFitModeConstants.eLeastSquaresUseSpecifiedRadius, then Execute
  15248. will use this specified radius. If FitMode is
  15249. Cog3DCircleFitterUsing2DPointsFitModeConstants.eLeastSquaresComputeRadius, then
  15250. Execute will ignore this specified radius.
  15251. </remarks>
  15252. </member>
  15253. <member name="M:Cognex.VisionPro3D.Cog3DCircleFitterUsing2DPoints.#ctor(Cognex.VisionPro3D.Cog3DCircleFitterUsing2DPoints)">
  15254. <inheritdoc cref="!:ICog3DBase::DeepCopyConstructorForThisClass" />
  15255. </member>
  15256. <member name="M:Cognex.VisionPro3D.Cog3DCircleFitterUsing2DPoints.Finalize">
  15257. <inheritdoc cref="!:ICog3DBase::FinalizerForThisClass" />
  15258. </member>
  15259. <member name="M:Cognex.VisionPro3D.Cog3DCircleFitterUsing2DPoints.Dispose">
  15260. <inheritdoc cref="!:ICog3DBase::DestructorForThisClass" />
  15261. </member>
  15262. <member name="M:Cognex.VisionPro3D.Cog3DCircleFitterUsing2DPoints.#ctor">
  15263. <summary>
  15264. Default constructor. Note that FitMode is
  15265. Cog3DCircleFitterUsing2DPointsFitModeConstants.LeastSquaresUseSpecifiedRadius, and
  15266. Radius is 0.
  15267. </summary>
  15268. </member>
  15269. <member name="T:Cognex.VisionPro3D.Cog3DCircleFitterUsing2DPoints">
  15270. <summary>
  15271. This class provides 3D circle fitting from 2D points.
  15272. A 3D circle is fitted from one or multiple sets of 2D image points.
  15273. The sets of image points can come from different cameras or from
  15274. a single camera providing multiple views of the circle.
  15275. The 3D circle fitter computes the pose of the circle which
  15276. minimizes the sum squared image error with respect to the given 2D
  15277. image points from calibrated camera(s).
  15278. </summary>
  15279. </member>
  15280. <member name="T:Cognex.VisionPro3D.Cog3DCircleFitterUsing2DPointsFitModeConstants">
  15281. <summary>
  15282. This enum class defines enumeration constants for the different 3D circle fitting modes.
  15283. </summary>
  15284. </member>
  15285. <member name="F:Cognex.VisionPro3D.Cog3DCircleFitterUsing2DPointsFitModeConstants.DefaultFitMode">
  15286. <summary>
  15287. DefaultFitMode is equal to LeastSquaresUseSpecifiedRadius.
  15288. </summary>
  15289. </member>
  15290. <member name="F:Cognex.VisionPro3D.Cog3DCircleFitterUsing2DPointsFitModeConstants.LeastSquaresUseSpecifiedRadius">
  15291. <summary>
  15292. Least squares fit using the specified radius.
  15293. </summary>
  15294. </member>
  15295. <member name="F:Cognex.VisionPro3D.Cog3DCircleFitterUsing2DPointsFitModeConstants.LeastSquaresComputeRadius">
  15296. <summary>
  15297. Least squares fit using measured radius.
  15298. </summary>
  15299. </member>
  15300. <member name="M:Cognex.VisionPro3D.Cog3DCircleFitterUsing2DPointsResult.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  15301. <inheritdoc cref="!:ICog3DBase::GetObjectData" />
  15302. </member>
  15303. <member name="M:Cognex.VisionPro3D.Cog3DCircleFitterUsing2DPointsResult.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  15304. <inheritdoc cref="!:ICog3DBase::SerializationConstructor" />
  15305. </member>
  15306. <member name="M:Cognex.VisionPro3D.Cog3DCircleFitterUsing2DPointsResult.RealEqual(Cognex.VisionPro3D.Cog3DCircleFitterUsing2DPointsResult,Cognex.VisionPro3D.Cog3DCircleFitterUsing2DPointsResult,System.Double)">
  15307. <inheritdoc cref="!:ICog3DBase::RealEqual" />
  15308. </member>
  15309. <member name="M:Cognex.VisionPro3D.Cog3DCircleFitterUsing2DPointsResult.ToString">
  15310. <inheritdoc cref="!:ICog3DBase::ToString" />
  15311. </member>
  15312. <member name="P:Cognex.VisionPro3D.Cog3DCircleFitterUsing2DPointsResult.ResidualsPhys3D">
  15313. <inheritdoc cref="!:ICog3DBase::ResidualsPhys3D" />
  15314. </member>
  15315. <member name="P:Cognex.VisionPro3D.Cog3DCircleFitterUsing2DPointsResult.ResidualsRaw2D">
  15316. <inheritdoc cref="!:ICog3DBase::ResidualsRaw2D" />
  15317. </member>
  15318. <member name="M:Cognex.VisionPro3D.Cog3DCircleFitterUsing2DPointsResult.GetCirclePhys3D">
  15319. <summary>
  15320. Gets a copy of the fitted 3D circle.
  15321. </summary>
  15322. <returns>
  15323. A copy of the fitted 3D circle.
  15324. </returns>
  15325. </member>
  15326. <member name="M:Cognex.VisionPro3D.Cog3DCircleFitterUsing2DPointsResult.Finalize">
  15327. <summary>
  15328. Finalizer.
  15329. </summary>
  15330. </member>
  15331. <member name="M:Cognex.VisionPro3D.Cog3DCircleFitterUsing2DPointsResult.Dispose">
  15332. <inheritdoc cref="!:ICog3DBase::DestructorForThisClass" />
  15333. </member>
  15334. <member name="M:Cognex.VisionPro3D.Cog3DCircleFitterUsing2DPointsResult.#ctor(Cognex.VisionPro3D.Cog3DCircleFitterUsing2DPointsResult)">
  15335. <inheritdoc cref="!:ICog3DBase::DeepCopyConstructorForThisClass" />
  15336. </member>
  15337. <member name="T:Cognex.VisionPro3D.Cog3DCircleFitterUsing2DPointsResult">
  15338. <summary>
  15339. This class holds a result from a 3D circle fitting operation, where 2D points have been
  15340. used as input. Note that this class is immutable - it may not be changed once
  15341. it has been constructed. The usage model for this class is that it
  15342. gets factoried by the Cog3DCircleFitterUsing2DPoints class and always
  15343. contains a 3D circle fitting result.
  15344. </summary>
  15345. </member>
  15346. <member name="M:Cognex.VisionPro3D.Cog3DLineFitterUsing2DPoints.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  15347. <inheritdoc cref="!:ICog3DBase::GetObjectData" />
  15348. </member>
  15349. <member name="M:Cognex.VisionPro3D.Cog3DLineFitterUsing2DPoints.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  15350. <inheritdoc cref="!:ICog3DBase::SerializationConstructor" />
  15351. </member>
  15352. <member name="M:Cognex.VisionPro3D.Cog3DLineFitterUsing2DPoints.Execute(System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCameraCalibration},System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DVect2Collection})">
  15353. <summary>
  15354. Fits a 3D line from 2D point sets and a set of camera calibrations.
  15355. The 2D points must be extracted from different cameras or views.
  15356. It is not required that the 2D points of the different cameras/views correspond,
  15357. but all the 2D points must lie on the same 3D line.
  15358. <para> The stability and precision of the fitted line segment can
  15359. be determined by setting Perturbation to a value greater than 0.
  15360. This will estimate the precision of the found line segment by trying slight
  15361. perturbations of the fitted line segment and comparing the
  15362. residuals (induced by the perturbed line segment) with the
  15363. residuals corresponding to the fitted line segment.
  15364. The difference between the residuals induced by the perturbed line segment
  15365. and the residuals of the fitted line segment are stored in the
  15366. Cog3DLineFitterUsing2DPointsResult.MinDeltaResidualsPhys3D and
  15367. Cog3DLineFitterUsing2DPointsResult.MinDeltaResidualsRaw2D properties.
  15368. </para><para>
  15369. Notes:
  15370. <list type="bullet"><item> The result's IsFound property will be set to false
  15371. if no line can be fit to the given points (such as when the
  15372. line formed by the image points is exactly parallel to the baseline
  15373. between two cameras). </item><item> This operation determines the 3D line segment which minimizes
  15374. the sum squared error in image pixels. </item><item> The endpoints of the fitted line segment are determined by
  15375. inferring 3D rays from all the pointsRaw2D,
  15376. determining the nearest point on the fitted line segment to each 3D ray,
  15377. determining the 2 outermost points with respect to all the nearest points
  15378. on the fitted line segment. </item></list></para></summary>
  15379. <param name="raw2DFromPhys3Ds">
  15380. The camera calibrations of the cameras used to extract the 2D points.
  15381. The size of the list defines the number of cameras/views used.
  15382. </param>
  15383. <param name="pointsRaw2D">
  15384. A list of 2D point collections, one collection per camera/view.
  15385. The size of the list must be equal to the number of cameras.
  15386. <para> Notes:
  15387. <list type="bullet"><item> This function can tolerate the situation where some items
  15388. of pointsRaw2D are empty (i.e., <paramref name="pointsRaw2D" />[i].Count==0); </item><item> It is NOT
  15389. required that <paramref name="pointsRaw2D" />[camIndex_i].Count == <paramref name="pointsRaw2D" />[camIndex_j].Count (camIndex_i != camIndex_j); </item><item> It is NOT required that
  15390. <paramref name="pointsRaw2D" />[camIndex_i][k] corresponds to <paramref name="pointsRaw2D" />[camIndex_j][k]
  15391. (camIndex_i != camIndex_j). </item></list></para></param>
  15392. <returns>
  15393. A Cog3DLineFitterUsing2DPointsResult containing the fitted line segment and 2D and 3D residuals.
  15394. </returns>
  15395. <exception cref="T:System.ArgumentNullException">
  15396. If any of the input arguments is null.
  15397. </exception>
  15398. <exception cref="T:System.ArgumentException">
  15399. <list type="bullet">
  15400. <item> If <paramref name="raw2DFromPhys3Ds" />.Count is less than 2. </item>
  15401. <item> If <paramref name="raw2DFromPhys3Ds" />.Count != <paramref name="pointsRaw2D" />.Count. </item>
  15402. <item>
  15403. If fewer than two of the individual items in <paramref name="pointsRaw2D" />
  15404. contain two or more points. </item>
  15405. </list>
  15406. </exception>
  15407. </member>
  15408. <member name="P:Cognex.VisionPro3D.Cog3DLineFitterUsing2DPoints.Perturbation">
  15409. <summary>
  15410. Gets/sets the perturbation used for measuring the precision
  15411. of the estimated line segment.
  15412. <para> Note that perturbation is specified in physical units. </para></summary>
  15413. <value>
  15414. The perturbation used for measuring the precision
  15415. of the estimated line segment.
  15416. </value>
  15417. <exception cref="T:System.ArgumentException">
  15418. If <paramref name="value" /> is less than 0.
  15419. </exception>
  15420. <remarks>
  15421. The measurement using this perturbation involves
  15422. performing multiple experiments, measuring results, and
  15423. then saving the most extreme result. Each experiment
  15424. involves modifying the fitted line segment by moving
  15425. one of the fitted line segment's endpoints along a ray
  15426. (the ray starts from one of the cameras and is coincident with the endpoint)
  15427. by the specified perturbation
  15428. distance, and then computing the residuals (in both image
  15429. and physical coordinates) between the rays corresponding
  15430. to the raw2D image points and the perturbed line segment,
  15431. and then subtracting the respective residuals of the best
  15432. fit line.
  15433. </remarks>
  15434. </member>
  15435. <member name="M:Cognex.VisionPro3D.Cog3DLineFitterUsing2DPoints.Finalize">
  15436. <inheritdoc cref="!:ICog3DBase::FinalizerForThisClass" />
  15437. </member>
  15438. <member name="M:Cognex.VisionPro3D.Cog3DLineFitterUsing2DPoints.Dispose">
  15439. <inheritdoc cref="!:ICog3DBase::DestructorForThisClass" />
  15440. </member>
  15441. <member name="M:Cognex.VisionPro3D.Cog3DLineFitterUsing2DPoints.#ctor(Cognex.VisionPro3D.Cog3DLineFitterUsing2DPoints)">
  15442. <inheritdoc cref="!:ICog3DBase::DeepCopyConstructorForThisClass" />
  15443. </member>
  15444. <member name="M:Cognex.VisionPro3D.Cog3DLineFitterUsing2DPoints.#ctor">
  15445. <summary>
  15446. Default constructor. Initializes this object for use. Note that Perturbation is 0.
  15447. </summary>
  15448. </member>
  15449. <member name="T:Cognex.VisionPro3D.Cog3DLineFitterUsing2DPoints">
  15450. <summary>
  15451. This class provides 3D line fitting from 2D points.
  15452. A 3D line is fitted from multiple sets of 2D image points.
  15453. The sets of image points can come from different cameras or from
  15454. a single camera providing multiple views of the line.
  15455. The 3D line fitter computes the pose of the line which
  15456. minimizes the sum squared image error with respect to the given 2D
  15457. image points from calibrated camera(s).
  15458. </summary>
  15459. </member>
  15460. <member name="M:Cognex.VisionPro3D.Cog3DLineFitterUsing2DPointsResult.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  15461. <inheritdoc cref="!:ICog3DBase::GetObjectData" />
  15462. </member>
  15463. <member name="M:Cognex.VisionPro3D.Cog3DLineFitterUsing2DPointsResult.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  15464. <inheritdoc cref="!:ICog3DBase::SerializationConstructor" />
  15465. </member>
  15466. <member name="M:Cognex.VisionPro3D.Cog3DLineFitterUsing2DPointsResult.RealEqual(Cognex.VisionPro3D.Cog3DLineFitterUsing2DPointsResult,Cognex.VisionPro3D.Cog3DLineFitterUsing2DPointsResult,System.Double)">
  15467. <inheritdoc cref="!:ICog3DBase::RealEqual" />
  15468. </member>
  15469. <member name="M:Cognex.VisionPro3D.Cog3DLineFitterUsing2DPointsResult.ToString">
  15470. <inheritdoc cref="!:ICog3DBase::ToString" />
  15471. </member>
  15472. <member name="P:Cognex.VisionPro3D.Cog3DLineFitterUsing2DPointsResult.MinDeltaResidualsPhys3D">
  15473. <summary>
  15474. Gets a measure of the precision of the fitted line segment, and the measure is in Phys3D.
  15475. <para> Note that larger residuals indicate a more precise fitted line segment result
  15476. (because the more the residuals increase per line segment
  15477. perturbation, the more accurately the line segment is localized).
  15478. </para></summary>
  15479. <value>
  15480. A measure of the precision of the fitted line segment (in Phys3D units).
  15481. </value>
  15482. <exception cref="T:Cognex.VisionPro3D.Cog3DException">
  15483. If IsFound is false.
  15484. </exception>
  15485. </member>
  15486. <member name="P:Cognex.VisionPro3D.Cog3DLineFitterUsing2DPointsResult.MaxDeltaResidualsPhys3D">
  15487. <summary>
  15488. Deprecated. Please use MinDeltaResidualsPhys3D instead.
  15489. </summary>
  15490. </member>
  15491. <member name="P:Cognex.VisionPro3D.Cog3DLineFitterUsing2DPointsResult.MaxDeltaResidualsRaw2D">
  15492. <summary>
  15493. Deprecated. Please use MinDeltaResidualsRaw2D instead.
  15494. </summary>
  15495. </member>
  15496. <member name="P:Cognex.VisionPro3D.Cog3DLineFitterUsing2DPointsResult.MinDeltaResidualsRaw2D">
  15497. <summary>
  15498. Gets a measure of the precision of the fitted line segment in Raw2D space.
  15499. <para> Note that larger residuals indicate a more precise fitted line segment result
  15500. (because the more the residuals increase per line segment
  15501. perturbation, the more accurately the line segment is localized).
  15502. </para></summary>
  15503. <exception cref="T:Cognex.VisionPro3D.Cog3DException">
  15504. If IsFound is false.
  15505. </exception>
  15506. <value>
  15507. A measure of the precision of the fitted line segment (in Raw2D units).
  15508. </value>
  15509. </member>
  15510. <member name="P:Cognex.VisionPro3D.Cog3DLineFitterUsing2DPointsResult.ResidualsPhys3D">
  15511. <inheritdoc cref="!:ICog3DBase::ResidualsPhys3D" />
  15512. <exception cref="T:Cognex.VisionPro3D.Cog3DException">
  15513. If IsFound is false.
  15514. </exception>
  15515. </member>
  15516. <member name="P:Cognex.VisionPro3D.Cog3DLineFitterUsing2DPointsResult.ResidualsRaw2D">
  15517. <inheritdoc cref="!:ICog3DBase::ResidualsRaw2D" />
  15518. <exception cref="T:Cognex.VisionPro3D.Cog3DException">
  15519. If IsFound is false.
  15520. </exception>
  15521. </member>
  15522. <member name="M:Cognex.VisionPro3D.Cog3DLineFitterUsing2DPointsResult.GetLinePhys3D">
  15523. <summary>
  15524. Get a deep copy of the fitted 3D line.
  15525. </summary>
  15526. <returns>
  15527. A deep copy of the fitted 3D line.
  15528. </returns>
  15529. <exception cref="T:Cognex.VisionPro3D.Cog3DException">
  15530. If IsFound is false.
  15531. </exception>
  15532. </member>
  15533. <member name="M:Cognex.VisionPro3D.Cog3DLineFitterUsing2DPointsResult.GetLineSegmentPhys3D">
  15534. <summary>
  15535. Get a deep copy of the fitted 3D line segment.
  15536. Note that the line segment is the shortest line segment that incorporates
  15537. all of the 3D rays corresponding to the 2D points from calibrated
  15538. cameras/views.
  15539. </summary>
  15540. <returns>
  15541. The fitted 3D line segment.
  15542. </returns>
  15543. <exception cref="T:Cognex.VisionPro3D.Cog3DException">
  15544. If IsFound is false.
  15545. </exception>
  15546. </member>
  15547. <member name="P:Cognex.VisionPro3D.Cog3DLineFitterUsing2DPointsResult.IsFound">
  15548. <summary>
  15549. Gets whether or not a fitted line segment was found.
  15550. </summary>
  15551. <value>
  15552. True if a fitted line segment was found; false otherwise.
  15553. </value>
  15554. </member>
  15555. <member name="M:Cognex.VisionPro3D.Cog3DLineFitterUsing2DPointsResult.Finalize">
  15556. <inheritdoc cref="!:ICog3DBase::FinalizerForThisClass" />
  15557. </member>
  15558. <member name="M:Cognex.VisionPro3D.Cog3DLineFitterUsing2DPointsResult.Dispose">
  15559. <inheritdoc cref="!:ICog3DBase::DestructorForThisClass" />
  15560. </member>
  15561. <member name="M:Cognex.VisionPro3D.Cog3DLineFitterUsing2DPointsResult.#ctor(Cognex.VisionPro3D.Cog3DLineFitterUsing2DPointsResult)">
  15562. <inheritdoc cref="!:ICog3DBase::DeepCopyConstructorForThisClass" />
  15563. </member>
  15564. <member name="T:Cognex.VisionPro3D.Cog3DLineFitterUsing2DPointsResult">
  15565. <summary>
  15566. This class holds a result from a 3D line fitting operation, where 2D points have been used as input.
  15567. Note that this class is immutable - it may not be changed once
  15568. it has been constructed. The usage model for this class is that it
  15569. gets factoried by the Cog3DLineFitterUsing2DPoints class.
  15570. </summary>
  15571. </member>
  15572. <member name="M:Cognex.VisionPro3D.Cog3DPoseEstimatorUsing3DPoints.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  15573. <inheritdoc cref="!:ICog3DBase::SerializationConstructor" />
  15574. </member>
  15575. <member name="M:Cognex.VisionPro3D.Cog3DPoseEstimatorUsing3DPoints.Execute(Cognex.VisionPro3D.Cog3DVect3Collection)">
  15576. <summary>
  15577. Perform a 3D pose estimation using PointsModel3D (model points in Model3D space) and
  15578. and the specified 3D points in Phys3D space.
  15579. </summary>
  15580. <param name="pointsPhys3D">
  15581. The 3D point collection in Phys3D space. Each 3D point in this collection must
  15582. correspond to the 3D model point with the same index in PointsModel3D.
  15583. </param>
  15584. <returns>
  15585. The 3D estimated pose result object.
  15586. The pose in the result object is the pose of the model in Phys3D space
  15587. i.e. the pose maps points from the Model3D space to the Phys3D space.
  15588. </returns>
  15589. <exception cref="T:System.ArgumentNullException">
  15590. If the input argument is null.
  15591. </exception>
  15592. <exception cref="T:System.ArgumentException">
  15593. If the size of pointsPhys3D does not match the size of PointsModel3D.
  15594. </exception>
  15595. </member>
  15596. <member name="P:Cognex.VisionPro3D.Cog3DPoseEstimatorUsing3DPoints.PointsModel3D">
  15597. <summary>
  15598. Gets/sets the 3D model points, in Model3D space, that define
  15599. the object of interest.
  15600. </summary>
  15601. <value>
  15602. A collection of 3D model points in Model3D space.
  15603. </value>
  15604. <exception cref="T:System.ArgumentNullException">
  15605. If input argument in the setter is null.
  15606. </exception>
  15607. </member>
  15608. <member name="M:Cognex.VisionPro3D.Cog3DPoseEstimatorUsing3DPoints.Finalize">
  15609. <inheritdoc cref="!:ICog3DBase::FinalizerForThisClass" />
  15610. </member>
  15611. <member name="M:Cognex.VisionPro3D.Cog3DPoseEstimatorUsing3DPoints.Dispose">
  15612. <inheritdoc cref="!:ICog3DBase::DestructorForThisClass" />
  15613. </member>
  15614. <member name="M:Cognex.VisionPro3D.Cog3DPoseEstimatorUsing3DPoints.#ctor(Cognex.VisionPro3D.Cog3DPoseEstimatorUsing3DPoints)">
  15615. <inheritdoc cref="!:ICog3DBase::DeepCopyConstructorForThisClass" />
  15616. </member>
  15617. <member name="M:Cognex.VisionPro3D.Cog3DPoseEstimatorUsing3DPoints.#ctor">
  15618. <summary>
  15619. Construct this default Cog3DPoseEstimatorUsing3DPoints. Note that PointsModel3D is an empty collection.
  15620. </summary>
  15621. </member>
  15622. <member name="T:Cognex.VisionPro3D.Cog3DPoseEstimatorUsing3DPoints">
  15623. <summary>
  15624. This class provides 3D pose estimation from a set 3D "found" points
  15625. and their corresponding 3D model points.
  15626. The pose estimation is done by determining the best fit between
  15627. the set of 3D model points and the set of corresponded 3D found points.
  15628. </summary>
  15629. </member>
  15630. <member name="M:Cognex.VisionPro3D.Cog3DPoseEstimatorUsing2DPoints.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  15631. <inheritdoc cref="!:ICog3DBase::SerializationConstructor" />
  15632. </member>
  15633. <member name="M:Cognex.VisionPro3D.Cog3DPoseEstimatorUsing2DPoints.Execute(System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCameraCalibration},System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DVect2Collection},System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DScalarCollection})">
  15634. <summary>
  15635. Perform a 3D pose estimation based on the 3D model points, the specified camera calibrations,
  15636. the specified 2D image points, and the specified weights, from one or multiple cameras/views.
  15637. </summary>
  15638. <param name="raw2DFromPhys3Ds">
  15639. A List of CameraCalibrations. One calibration per camera/view.
  15640. The size of this list specifies the number of cameras/views.
  15641. </param>
  15642. <param name="pointsRaw2D">
  15643. A List of 2D point collections, indexed by camera/view.
  15644. The size of the List must equal the number of cameras/views.
  15645. The size of each collection must equal the number of model points.
  15646. Each point in <paramref name="pointsRaw2D" /> represents its corresponding model point from a specific camera/view,
  15647. i.e., <paramref name="pointsRaw2D" />[i][j] is from camera i, and corresponds to PointsModel3D[j].
  15648. The total number of valid 2D points must be &gt;= 3.
  15649. </param>
  15650. <param name="weights">
  15651. A List of collections of weights, indexed by camera/view.
  15652. The List may be null to indicate all points have a weight of 1.
  15653. If not null, then the size of the List must be equal to the number of cameras/views, and each collection in the List is
  15654. either null to indicate that all points from the corresponding camera have a weight of 1, or the collection has the same
  15655. size as the number of 3D model points.
  15656. Each weight must be &gt;= 0.
  15657. </param>
  15658. <returns>
  15659. The 3D estimated pose result object. The pose in the result object maps points from Model3D space to Phys3D space.
  15660. </returns>
  15661. <exception cref="T:System.ArgumentNullException">
  15662. If any of the arguments (except <paramref name="weights" />) is null.
  15663. </exception>
  15664. <exception cref="T:System.ArgumentException">
  15665. <list type="bullet">
  15666. <item> If <paramref name="raw2DFromPhys3Ds" />.Count == 0; </item>
  15667. <item> If <paramref name="raw2DFromPhys3Ds" />.Count != <paramref name="pointsRaw2D" />.Count; </item>
  15668. <item> If <paramref name="weights" /> is not null, and
  15669. <paramref name="weights" />.Count != <paramref name="pointsRaw2D" />.Count; </item>
  15670. <item> If <paramref name="pointsRaw2D" />[i].Count != PointsModel3D.Count
  15671. (i is inside [0, <paramref name="pointsRaw2D" />.Count-1]); </item>
  15672. <item> If <paramref name="weights" />[i] is not null, and
  15673. <paramref name="weights" />[i].Count != PointsModel3D.Count
  15674. (i is inside [0, <paramref name="pointsRaw2D" />.Count-1]). </item>
  15675. </list>
  15676. </exception>
  15677. </member>
  15678. <member name="P:Cognex.VisionPro3D.Cog3DPoseEstimatorUsing2DPoints.PointsModel3D">
  15679. <summary>
  15680. Gets/sets the 3D model points, in Model3D space, that define
  15681. the object of interest.
  15682. </summary>
  15683. <value>
  15684. A collection of 3D model points in Model3D space.
  15685. </value>
  15686. <exception cref="T:System.ArgumentNullException">
  15687. If input argument in the setter is null.
  15688. </exception>
  15689. </member>
  15690. <member name="M:Cognex.VisionPro3D.Cog3DPoseEstimatorUsing2DPoints.Finalize">
  15691. <inheritdoc cref="!:ICog3DBase::FinalizerForThisClass" />
  15692. </member>
  15693. <member name="M:Cognex.VisionPro3D.Cog3DPoseEstimatorUsing2DPoints.Dispose">
  15694. <inheritdoc cref="!:ICog3DBase::DestructorForThisClass" />
  15695. </member>
  15696. <member name="M:Cognex.VisionPro3D.Cog3DPoseEstimatorUsing2DPoints.#ctor(Cognex.VisionPro3D.Cog3DPoseEstimatorUsing2DPoints)">
  15697. <inheritdoc cref="!:ICog3DBase::DeepCopyConstructorForThisClass" />
  15698. </member>
  15699. <member name="M:Cognex.VisionPro3D.Cog3DPoseEstimatorUsing2DPoints.#ctor">
  15700. <summary>
  15701. Construct this default Cog3DPoseEstimatorUsing2DPoints. Note that PointsModel3D is an empty collection.
  15702. </summary>
  15703. </member>
  15704. <member name="T:Cognex.VisionPro3D.Cog3DPoseEstimatorUsing2DPoints">
  15705. <summary>
  15706. This class provides 3D pose estimation from a set or sets of 2D image points.
  15707. The pose estimation is done by determining the best fit between a set of 3D model points
  15708. and the set or sets of corresponded 2D image points.
  15709. </summary>
  15710. </member>
  15711. <member name="M:Cognex.VisionPro3D.Cog3DPoseEstimatorUsing3DPointsResult.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  15712. <inheritdoc cref="!:ICog3DBase::SerializationConstructor" />
  15713. </member>
  15714. <member name="M:Cognex.VisionPro3D.Cog3DPoseEstimatorUsing3DPointsResult.ToString">
  15715. <inheritdoc cref="!:ICog3DBase::ToString" />
  15716. </member>
  15717. <member name="P:Cognex.VisionPro3D.Cog3DPoseEstimatorUsing3DPointsResult.ResidualsPhys3D">
  15718. <inheritdoc cref="!:ICog3DBase::ResidualsPhys3DUsing3DPoints" />
  15719. </member>
  15720. <member name="P:Cognex.VisionPro3D.Cog3DPoseEstimatorUsing3DPointsResult.Phys3DFromModel3D">
  15721. <summary>
  15722. Gets the 3D pose of this result,
  15723. i.e. the 3D pose of the model in Phys3D space.
  15724. </summary>
  15725. <value>
  15726. The 3D pose of the model in Phys3D space.
  15727. </value>
  15728. </member>
  15729. <member name="M:Cognex.VisionPro3D.Cog3DPoseEstimatorUsing3DPointsResult.Finalize">
  15730. <inheritdoc cref="!:ICog3DBase::FinalizerForThisClass" />
  15731. </member>
  15732. <member name="M:Cognex.VisionPro3D.Cog3DPoseEstimatorUsing3DPointsResult.Dispose">
  15733. <inheritdoc cref="!:ICog3DBase::DestructorForThisClass" />
  15734. </member>
  15735. <member name="M:Cognex.VisionPro3D.Cog3DPoseEstimatorUsing3DPointsResult.#ctor(Cognex.VisionPro3D.Cog3DPoseEstimatorUsing3DPointsResult)">
  15736. <inheritdoc cref="!:ICog3DBase::DeepCopyConstructorForThisClass" />
  15737. </member>
  15738. <member name="T:Cognex.VisionPro3D.Cog3DPoseEstimatorUsing3DPointsResult">
  15739. <summary>
  15740. This class encapsulates the result of a 3D pose estimation using
  15741. 3D found points.
  15742. Note that this class is immutable - it may not be changed once
  15743. it has been constructed.
  15744. </summary>
  15745. </member>
  15746. <member name="M:Cognex.VisionPro3D.Cog3DPoseEstimatorUsing2DPointsResult.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  15747. <inheritdoc cref="!:ICog3DBase::SerializationConstructor" />
  15748. </member>
  15749. <member name="M:Cognex.VisionPro3D.Cog3DPoseEstimatorUsing2DPointsResult.ToString">
  15750. <inheritdoc cref="!:ICog3DBase::ToString" />
  15751. </member>
  15752. <member name="P:Cognex.VisionPro3D.Cog3DPoseEstimatorUsing2DPointsResult.ResidualsPhys3D">
  15753. <inheritdoc cref="!:ICog3DBase::ResidualsPhys3D" />
  15754. </member>
  15755. <member name="P:Cognex.VisionPro3D.Cog3DPoseEstimatorUsing2DPointsResult.ResidualsRaw2D">
  15756. <inheritdoc cref="!:ICog3DBase::ResidualsRaw2D" />
  15757. </member>
  15758. <member name="P:Cognex.VisionPro3D.Cog3DPoseEstimatorUsing2DPointsResult.Phys3DFromModel3D">
  15759. <summary>
  15760. Gets the 3D pose of this result,
  15761. i.e. the 3D pose of the model in Phys3D space.
  15762. </summary>
  15763. <value>
  15764. The 3D pose of the model in Phys3D space.
  15765. </value>
  15766. </member>
  15767. <member name="M:Cognex.VisionPro3D.Cog3DPoseEstimatorUsing2DPointsResult.Finalize">
  15768. <inheritdoc cref="!:ICog3DBase::FinalizerForThisClass" />
  15769. </member>
  15770. <member name="M:Cognex.VisionPro3D.Cog3DPoseEstimatorUsing2DPointsResult.Dispose">
  15771. <inheritdoc cref="!:ICog3DBase::DestructorForThisClass" />
  15772. </member>
  15773. <member name="M:Cognex.VisionPro3D.Cog3DPoseEstimatorUsing2DPointsResult.#ctor(Cognex.VisionPro3D.Cog3DPoseEstimatorUsing2DPointsResult)">
  15774. <inheritdoc cref="!:ICog3DBase::DeepCopyConstructorForThisClass" />
  15775. </member>
  15776. <member name="T:Cognex.VisionPro3D.Cog3DPoseEstimatorUsing2DPointsResult">
  15777. <summary>
  15778. This class encapsulates the result of a 3D pose estimation using
  15779. 2D image points.
  15780. Note that this class is immutable - it may not be changed once
  15781. it has been constructed.
  15782. </summary>
  15783. </member>
  15784. <member name="M:Cognex.VisionPro3D.Cog3DTriangulator.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  15785. <inheritdoc cref="!:ICog3DBase::SerializationConstructor" />
  15786. </member>
  15787. <member name="M:Cognex.VisionPro3D.Cog3DTriangulator.Execute(System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCameraCalibration},System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DVect2Collection},System.Collections.Generic.List`1{System.Collections.Generic.List`1{System.Boolean}},System.Collections.Generic.List`1{System.Boolean}@,System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DResiduals}@,System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DResiduals}@)">
  15788. <summary>
  15789. Triangulate a collection of 3D features from their corresponding 2D image points from different cameras.
  15790. </summary>
  15791. <param name="raw2DFromPhys3Ds">
  15792. A list of Cog3DCameraCalibration, indexed by camera. One calibration per camera.
  15793. The size of this list defines the number of cameras. Must be greater than or equal to two.
  15794. </param>
  15795. <param name="pointsRaw2D">
  15796. A List of 2D point collections, indexed by camera. Each 2D point collection contains all 2D feature points from a specific camera.
  15797. The size of the List must be equal to the number of cameras.
  15798. The size of each 2D point collection must be the same and defines the number of 3D features to be triangulated.
  15799. </param>
  15800. <param name="isPointValid">
  15801. A List of valid flags Lists, indexed by camera. The outer List may be null to indicate all points are valid.
  15802. If not null, the size of the outer List must be equal to the number of cameras, and each item in the outer List must
  15803. be either null (to indicate all points from the corresponding camera are valid), or have the same size
  15804. as the number of 3D features to be triangulated.
  15805. </param>
  15806. <param name="is3DPointValid">
  15807. This output parameter is a list of valid flags for the returned 3D features. If a 3D feature could not be triangulated,
  15808. its corresponding flag will be false; true otherwise.
  15809. The passed list will be re-initialized by this function.
  15810. </param>
  15811. <param name="residualsRaw2D">
  15812. 2D residual error information is returned via this Out argument.
  15813. One Cog3DResiduals per triangulated 3D feature.
  15814. The passed list will be re-initialized by this function.
  15815. </param>
  15816. <param name="residualsPhys3D">
  15817. 3D residual error information is returned via this Out argument.
  15818. One Cog3DResiduals per triangulated 3D feature.
  15819. The passed list will be re-initialized by this function.
  15820. </param>
  15821. <returns>
  15822. A collection of the triangulated 3D feature coordinates and updates <paramref name="is3DPointValid" />.
  15823. </returns>
  15824. <exception cref="T:System.ArgumentNullException">
  15825. <list type="bullet">
  15826. <item> If any of the input arguments (except <paramref name="isPointValid" />) is null; </item>
  15827. <item> If any item of <paramref name="raw2DFromPhys3Ds" /> is null; </item>
  15828. <item> If any item of <paramref name="pointsRaw2D" /> is null. </item>
  15829. </list>
  15830. </exception>
  15831. <exception cref="T:System.ArgumentException">
  15832. <list type="bullet">
  15833. <item> If the sizes of <paramref name="raw2DFromPhys3Ds" /> and <paramref name="pointsRaw2D" />
  15834. are different or are less than two; </item>
  15835. <item> If <paramref name="pointsRaw2D" />[i] does not have the same length as
  15836. <paramref name="pointsRaw2D" />[j] (i and j are inside [0, <paramref name="pointsRaw2D" />.Count-1]); </item>
  15837. <item> If <paramref name="isPointValid" /> is not null, and
  15838. does not have the same length as <paramref name="pointsRaw2D" />; </item>
  15839. <item> if <paramref name="isPointValid" />[i] is not null, and does not have the
  15840. same length as <paramref name="pointsRaw2D" />[i] (i is inside [0, <paramref name="pointsRaw2D" />.Count-1]). </item>
  15841. </list>
  15842. </exception>
  15843. <inheritdoc cref="!:ICog3DBase::TriangulatorOrModelGenerator" />
  15844. </member>
  15845. <member name="M:Cognex.VisionPro3D.Cog3DTriangulator.Execute(System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCameraCalibration},System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DVect2Collection},System.Collections.Generic.List`1{System.Collections.Generic.List`1{System.Boolean}},System.Collections.Generic.List`1{System.Boolean}@)">
  15846. <summary>
  15847. Triangulate a collection of 3D features from their corresponding 2D image points from different cameras.
  15848. </summary>
  15849. <param name="raw2DFromPhys3Ds">
  15850. A list of Cog3DCameraCalibration, indexed by camera. One calibration per camera.
  15851. The size of this list defines the number of cameras. Must be greater than or equal to two.
  15852. </param>
  15853. <param name="pointsRaw2D">
  15854. A List of 2D point collections, indexed by camera. Each 2D point collection contains all 2D feature points from a specific camera.
  15855. The size of the List must be equal to the number of cameras.
  15856. The size of each 2D point collection must be the same and defines the number of 3D features to be triangulated.
  15857. </param>
  15858. <param name="isPointValid">
  15859. A List of valid flags Lists, indexed by camera. The outer List may be null to indicate all points are valid.
  15860. If not null, the size of the outer List must be equal to the number of cameras, and each item in the outer List must
  15861. be either null (to indicate all points from the corresponding camera are valid), or have the same size
  15862. as the number of 3D features to be triangulated.
  15863. </param>
  15864. <param name="is3DPointValid">
  15865. This output parameter is a list of valid flags for the returned 3D features. If a 3D feature could not be triangulated,
  15866. its corresponding flag will be false; true otherwise.
  15867. The passed list will be re-initialized by this function.
  15868. </param>
  15869. <returns>
  15870. A collection of the triangulated 3D feature coordinates and updates <paramref name="is3DPointValid" />.
  15871. </returns>
  15872. <exception cref="T:System.ArgumentNullException">
  15873. <list type="bullet">
  15874. <item> If any of the input arguments (except <paramref name="isPointValid" />) is null; </item>
  15875. <item> If any item of <paramref name="raw2DFromPhys3Ds" /> is null; </item>
  15876. <item> If any item of <paramref name="pointsRaw2D" /> is null. </item>
  15877. </list>
  15878. </exception>
  15879. <exception cref="T:System.ArgumentException">
  15880. <list type="bullet">
  15881. <item> If the sizes of <paramref name="raw2DFromPhys3Ds" /> and <paramref name="pointsRaw2D" />
  15882. are different or are less than two </item>
  15883. <item> If <paramref name="pointsRaw2D" />[i] does not have the same length as
  15884. <paramref name="pointsRaw2D" />[j] (i and j are inside [0, <paramref name="pointsRaw2D" />.Count-1]); </item>
  15885. <item> If <paramref name="isPointValid" /> is not null, and
  15886. does not have the same length as <paramref name="pointsRaw2D" />; </item>
  15887. <item> If <paramref name="isPointValid" />[i] is not null, and does not have the
  15888. same length as <paramref name="pointsRaw2D" />[i] (i is inside [0, <paramref name="pointsRaw2D" />.Count-1]). </item>
  15889. </list>
  15890. </exception>
  15891. </member>
  15892. <member name="M:Cognex.VisionPro3D.Cog3DTriangulator.Execute(System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCameraCalibration},Cognex.VisionPro3D.Cog3DVect2Collection,System.Collections.Generic.List`1{System.Boolean},Cognex.VisionPro3D.Cog3DResiduals@,Cognex.VisionPro3D.Cog3DResiduals@)">
  15893. <summary>
  15894. Triangulate a 3D point from 2D image points from different cameras.
  15895. </summary>
  15896. <param name="raw2DFromPhys3Ds">
  15897. A list of Cog3DCameraCalibrations, indexed by camera. One calibration per camera.
  15898. </param>
  15899. <param name="pointsRaw2D">
  15900. A collection of 2D points, indexed by camera, representing the same object feature detected from different cameras.
  15901. </param>
  15902. <param name="isPointValid">
  15903. A collection of valid flags for each 2D point. This argument may be null, indicating that all points are valid.
  15904. If it is not null, its size must be the same as the size of pointsRaw2D.
  15905. </param>
  15906. <param name="residualsRaw2D">
  15907. 2D residual error information will be returned via this Out argument.
  15908. </param>
  15909. <param name="residualsPhys3D">
  15910. 3D residual error information will be returned via this Out argument.
  15911. </param>
  15912. <returns>
  15913. The triangulated 3D point coordinate.
  15914. </returns>
  15915. <exception cref="T:System.ArgumentNullException">
  15916. If any of the arguments (except <paramref name="isPointValid" />) is null, or any item of
  15917. <paramref name="raw2DFromPhys3Ds" /> is null.
  15918. </exception>
  15919. <exception cref="T:System.ArgumentException">
  15920. If the sizes of <paramref name="raw2DFromPhys3Ds" /> and <paramref name="pointsRaw2D" />
  15921. are different or are less than two; or <paramref name="isPointValid" /> is not null and does not
  15922. have the same length as <paramref name="pointsRaw2D" />.
  15923. </exception>
  15924. <inheritdoc cref="!:ICog3DBase::TriangulatorOrModelGenerator" />
  15925. </member>
  15926. <member name="M:Cognex.VisionPro3D.Cog3DTriangulator.Execute(System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCameraCalibration},Cognex.VisionPro3D.Cog3DVect2Collection,System.Collections.Generic.List`1{System.Boolean})">
  15927. <summary>
  15928. Triangulate a 3D point from 2D image points from different cameras.
  15929. </summary>
  15930. <param name="raw2DFromPhys3Ds">
  15931. A list of Cog3DCameraCalibrations, indexed by camera. One calibration per camera.
  15932. </param>
  15933. <param name="pointsRaw2D">
  15934. A collection of 2D points, indexed by camera, representing the same object feature detected from different cameras.
  15935. </param>
  15936. <param name="isPointValid">
  15937. A collection of valid flags for each 2D point. This argument may be null, indicating that all points are valid.
  15938. If it is not null, its size must be the same as the size of pointsRaw2D.
  15939. </param>
  15940. <returns>
  15941. The triangulated 3D point coordinate.
  15942. </returns>
  15943. <exception cref="T:System.ArgumentNullException">
  15944. If any of the arguments (except <paramref name="isPointValid" />) is null, or any item of
  15945. <paramref name="raw2DFromPhys3Ds" /> is null.
  15946. </exception>
  15947. <exception cref="T:System.ArgumentException">
  15948. If the sizes of <paramref name="raw2DFromPhys3Ds" /> and <paramref name="pointsRaw2D" />
  15949. are different or are less than two; or <paramref name="isPointValid" /> is not null and does not
  15950. have the same length as <paramref name="pointsRaw2D" />.
  15951. </exception>
  15952. </member>
  15953. <member name="M:Cognex.VisionPro3D.Cog3DTriangulator.Finalize">
  15954. <inheritdoc cref="!:ICog3DBase::FinalizerForThisClass" />
  15955. </member>
  15956. <member name="M:Cognex.VisionPro3D.Cog3DTriangulator.Dispose">
  15957. <inheritdoc cref="!:ICog3DBase::DestructorForThisClass" />
  15958. </member>
  15959. <member name="M:Cognex.VisionPro3D.Cog3DTriangulator.#ctor(Cognex.VisionPro3D.Cog3DTriangulator)">
  15960. <inheritdoc cref="!:ICog3DBase::DeepCopyConstructorForThisClass" />
  15961. </member>
  15962. <member name="M:Cognex.VisionPro3D.Cog3DTriangulator.#ctor">
  15963. <summary>
  15964. Construct this Cog3DTriangulator.
  15965. </summary>
  15966. </member>
  15967. <member name="T:Cognex.VisionPro3D.Cog3DTriangulator">
  15968. <summary>
  15969. This class encapsulates a 3D Triangulator.
  15970. It triangulates the 3D coordinate of an object's feature from 2D image coordinates
  15971. of that feature observed from different cameras.
  15972. </summary>
  15973. </member>
  15974. <member name="M:Cognex.VisionPro3D.Cog3DHandEyeCalibrator.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  15975. <inheritdoc cref="!:ICog3DBase::GetObjectData" />
  15976. </member>
  15977. <member name="M:Cognex.VisionPro3D.Cog3DHandEyeCalibrator.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  15978. <inheritdoc cref="!:ICog3DBase::SerializationConstructor" />
  15979. </member>
  15980. <member name="M:Cognex.VisionPro3D.Cog3DHandEyeCalibrator.Execute(System.Collections.Generic.List`1{System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DTransformRigid}},System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DTransformRigid})">
  15981. <summary>
  15982. Compute the hand-eye calibration(s) based on extrinsic camera transforms and robot poses.
  15983. </summary>
  15984. <param name="camera3DFromCalPlate3Ds">
  15985. A doubly indexed list of Cog3DTransformRigid for extrinsic camera transforms under various robot hand poses.
  15986. The first index is the robot hand pose index, the second index is the camera index.
  15987. The size of the outer list must equal the number of robot hand poses.
  15988. The size of each inner list must equal the number of cameras.
  15989. </param>
  15990. <param name="robotBase3DFromHand3Ds">
  15991. A list of Cog3DTransformRigid's defining the robot hand poses, indexed by robot hand pose.
  15992. The size of this list must equal the number of robot hand poses.
  15993. </param>
  15994. <returns>
  15995. A list of Cog3DTransformRigid indexed by camera, representing Camera3DFromHand3D if
  15996. IsCameraMoving is true, or representing CalPlate3DFromHand3D if IsCameraMoving is false.
  15997. </returns>
  15998. <exception cref="T:System.ArgumentNullException">
  15999. If any input argument is null or any input argument includes a null item.
  16000. </exception>
  16001. <exception cref="T:System.ArgumentException">
  16002. If any of the following is true:
  16003. <list type="bullet"><item><paramref name="camera3DFromCalPlate3Ds" /> is empty; </item><item><paramref name="camera3DFromCalPlate3Ds" />.Count is not equal to <paramref name="robotBase3DFromHand3Ds" />.Count; </item><item><paramref name="camera3DFromCalPlate3Ds" />[i].Count is not equal to <paramref name="camera3DFromCalPlate3Ds" />[j].Count (i, j are inside [0, <paramref name="camera3DFromCalPlate3Ds" />.Count]). </item></list></exception>
  16004. <exception cref="T:Cognex.VisionPro3D.Cog3DOperationCancelledByUserException">
  16005. If the operation is cancelled by user via the event handler.
  16006. </exception>
  16007. </member>
  16008. <member name="M:Cognex.VisionPro3D.Cog3DHandEyeCalibrator.Execute(System.Collections.Generic.List`1{System.Drawing.Rectangle},System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCameraCalibrationIntrinsics},System.Collections.Generic.List`1{System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DTransformRigid}},System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DTransformRigid})">
  16009. <summary>
  16010. Compute the hand-eye calibration(s) based on camera intrinsic parameters, extrinsic camera transforms,
  16011. and robot poses.
  16012. </summary>
  16013. <param name="pelRectRaw2Ds">
  16014. A list of rectangles indexed by camera, that specifies the region of interest
  16015. of the raw acquired calibration image (the camera's field of view).
  16016. The size of this list defines the number of cameras.
  16017. Each item must be the size of the acquired images for that camera (with origin (0,0)).
  16018. </param>
  16019. <param name="raw2DFromCamera2Ds">
  16020. A list of the cameras' intrinsic parameters indexed by camera.
  16021. The size of this list must equal the number of cameras.
  16022. </param>
  16023. <param name="camera3DFromCalPlate3Ds">
  16024. A doubly indexed list of Cog3DTransformRigid for extrinsic camera transforms under various robot hand poses.
  16025. The first index is the robot hand pose index, the second index is the camera index.
  16026. The size of the outer list must equal the number of robot hand poses.
  16027. The size of each inner list must equal the number of cameras.
  16028. </param>
  16029. <param name="robotBase3DFromHand3Ds">
  16030. A list of Cog3DTransformRigid's defining the robot hand poses, indexed by robot hand pose.
  16031. The size of this list must equal the number of robot hand poses.
  16032. </param>
  16033. <returns>
  16034. A list of Cog3DHandEyeCalibrationResult's indexed by camera containing the hand-eye calibration
  16035. result for each camera.
  16036. </returns>
  16037. <exception cref="T:System.ArgumentNullException">
  16038. If any input argument is null or any input argument includes null item.
  16039. </exception>
  16040. <exception cref="T:System.ArgumentException">
  16041. If any of the following is true:
  16042. <list type="bullet"><item><paramref name="camera3DFromCalPlate3Ds" /> is empty </item><item><paramref name="pelRectRaw2Ds" />, <paramref name="raw2DFromCamera2Ds" />,
  16043. and <paramref name="camera3DFromCalPlate3Ds" />[i]
  16044. (i is inside [0, <paramref name="camera3DFromCalPlate3Ds" />.Count -1]) are not the same size.</item><item><paramref name="camera3DFromCalPlate3Ds" />.Count is not equal to <paramref name="robotBase3DFromHand3Ds" />.Count </item></list></exception>
  16045. <exception cref="T:Cognex.VisionPro3D.Cog3DOperationCancelledByUserException">
  16046. If the operation is cancelled by user via the event handler.
  16047. </exception>
  16048. </member>
  16049. <member name="M:Cognex.VisionPro3D.Cog3DHandEyeCalibrator.Execute(System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCameraCalibrationIntrinsics},System.Collections.Generic.List`1{System.Collections.Generic.List`1{Cognex.VisionPro.ICogImage}},Cognex.VisionPro3D.ICog3DCalibrationFeatureExtractor,System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DTransformRigid})">
  16050. <summary>
  16051. Compute the hand-eye calibration(s) using the specified calibration plate images acquired from
  16052. different cameras and at different robot hand poses.
  16053. </summary>
  16054. <param name="raw2DFromCamera2Ds">
  16055. A list of the cameras' intrinsic parameters indexed by camera.
  16056. </param>
  16057. <param name="images">
  16058. A doubly indexed list of calibration plate images, acquired at various robot hand poses.
  16059. The first index is the robot hand pose index, the second index is the camera index.
  16060. </param>
  16061. <param name="featureExtractor">
  16062. The feature extractor to be used for extracting calibration features from the images.
  16063. </param>
  16064. <param name="robotBase3DFromHand3Ds">
  16065. A list of Cog3DTransformRigid's defining the robot hand poses, indexed by robot hand pose.
  16066. The size of this list must equal the number of robot hand poses.
  16067. </param>
  16068. <returns>
  16069. A list of Cog3DHandEyeCalibrationResults indexed by camera, containing the hand-eye calibration
  16070. result for each of the cameras.
  16071. </returns>
  16072. <exception cref="T:System.ArgumentNullException">
  16073. If any input argument is null or any input argument includes a null item.
  16074. </exception>
  16075. <exception cref="T:System.ArgumentException">
  16076. If any of the following is true:
  16077. <list type="bullet"><item><paramref name="images" />.Count is not equal to <paramref name="robotBase3DFromHand3Ds" />.Count </item><item><paramref name="images" />[i].Count (i is inside [0, <paramref name="images" />.Count -1]) is not equal to
  16078. <paramref name="raw2DFromCamera2Ds" />.Count </item></list></exception>
  16079. <exception cref="T:Cognex.VisionPro3D.Cog3DOperationCancelledByUserException">
  16080. If the operation is cancelled by user via the event handler.
  16081. </exception>
  16082. </member>
  16083. <member name="M:Cognex.VisionPro3D.Cog3DHandEyeCalibrator.Execute(System.Collections.Generic.List`1{System.Drawing.Rectangle},System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCameraCalibrationIntrinsics},System.Collections.Generic.List`1{System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCrspFeaturesCollection}},System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DTransformRigid})">
  16084. <summary>
  16085. Compute the hand-eye calibration(s) using previously extracted calibration
  16086. plate features and previously computed camera intrinsic parameters.
  16087. </summary>
  16088. <param name="pelRectRaw2Ds">
  16089. A list of rectangles indexed by camera, that specifies the region of interest
  16090. of the raw acquired calibration image (the camera's field of view).
  16091. The size of this list defines the number of cameras.
  16092. Each item must be the size of the acquired images for that camera (with origin (0,0)).
  16093. </param>
  16094. <param name="raw2DFromCamera2Ds">
  16095. A list of the cameras' intrinsic parameters indexed by camera.
  16096. The size of this list must equal the number of cameras.
  16097. </param>
  16098. <param name="crspFeatures">
  16099. A doubly indexed list of extracted calibration plate features from various robot hand poses.
  16100. The first index is the robot hand pose index, the second index is the camera index.
  16101. The size of the outer list must equal the number of robot hand poses.
  16102. The size of each inner list must equal the number of cameras.
  16103. </param>
  16104. <param name="robotBase3DFromHand3Ds">
  16105. A list of Cog3DTransformRigid's defining the robot hand poses, indexed by robot hand pose.
  16106. The size of this list must equal the number of robot hand poses.
  16107. </param>
  16108. <returns>
  16109. A list of Cog3DHandEyeCalibrationResults (index is camera) containing the hand-eye calibration
  16110. result for each camera.
  16111. </returns>
  16112. <exception cref="T:System.ArgumentNullException">
  16113. If any input argument is null or any input argument includes a null item
  16114. (except <paramref name="crspFeatures" />[i][j].Weights).
  16115. </exception>
  16116. <exception cref="T:System.ArgumentException">
  16117. If any of the following is true:
  16118. <list type="bullet"><item><paramref name="pelRectRaw2Ds" />, <paramref name="raw2DFromCamera2Ds" />,
  16119. and <paramref name="crspFeatures" />[i] (i is inside [0, <paramref name="crspFeatures" />.Count -1])
  16120. are not the same size; </item><item><paramref name="crspFeatures" /> and <paramref name="robotBase3DFromHand3Ds" /> are not the same size. </item><item> If <paramref name="crspFeatures" />[i][j].PointsModel3D.Count !=
  16121. <paramref name="crspFeatures" />[i][j].PointsRaw2D.Count
  16122. (i is inside [0, <paramref name="crspFeatures" />.Count-1],
  16123. and j is inside [0,<paramref name="crspFeatures" />[i].Count-1]);</item><item> If <paramref name="crspFeatures" />[i][j].Weights is not null,
  16124. and <paramref name="crspFeatures" />[i][j].Weights.Count !=
  16125. <paramref name="crspFeatures" />[i][j].PointsModel3D.Count
  16126. (i is inside [0, <paramref name="crspFeatures" />.Count-1],
  16127. and j is inside [0,<paramref name="crspFeatures" />[i].Count-1]);</item></list></exception>
  16128. <exception cref="T:Cognex.VisionPro3D.Cog3DOperationCancelledByUserException">
  16129. If the operation is cancelled by user via the event handler.
  16130. </exception>
  16131. </member>
  16132. <member name="P:Cognex.VisionPro3D.Cog3DHandEyeCalibrator.PlateRectangleForResidualComputing">
  16133. <summary>
  16134. Gets/Sets the sampling rectangle for residual error computation. The rectangle is specified in
  16135. 2D calibration plate space (the units are those in which the calibration plate grid pitch is specified, and
  16136. the origin is defined by the fiducial marks on the calibration plate).
  16137. If the width or height of the rectangle is 0, no residual statistics will be computed.
  16138. </summary>
  16139. <value>
  16140. The plate rectangle used for residual computation.
  16141. Getter returns null if the rectangle has not been set (default constructed Cog3DHandEyeCalibrator).
  16142. </value>
  16143. </member>
  16144. <member name="P:Cognex.VisionPro3D.Cog3DHandEyeCalibrator.NumPlateSamplesY">
  16145. <summary>
  16146. Gets/sets the number of residual error sampling points in the Y-direction of PlateRectangleForResidualComputing.
  16147. If this value is less than 1, no residual error will be computed.
  16148. </summary>
  16149. <value>
  16150. The number of residual error sampling points in the Y-direction of PlateRectangleForResidualComputing.
  16151. </value>
  16152. </member>
  16153. <member name="P:Cognex.VisionPro3D.Cog3DHandEyeCalibrator.NumPlateSamplesX">
  16154. <summary>
  16155. Gets/sets the number of residual error sampling points in the X-direction of PlateRectangleForResidualComputing.
  16156. If this value is less than 1, no residual error will be computed.
  16157. </summary>
  16158. <value>
  16159. The number of sample points (in X-direction) to be used for residual computation.
  16160. </value>
  16161. </member>
  16162. <member name="P:Cognex.VisionPro3D.Cog3DHandEyeCalibrator.IsCameraMoving">
  16163. <summary>
  16164. Gets/sets whether the calibrator should perform calibration for moving or stationary camera(s)
  16165. </summary>
  16166. <value>
  16167. The value indicating whether a moving camera hand-eye calibration shall be performed.
  16168. </value>
  16169. </member>
  16170. <member name="M:Cognex.VisionPro3D.Cog3DHandEyeCalibrator.Finalize">
  16171. <inheritdoc cref="!:ICog3DBase::FinalizerForThisClass" />
  16172. </member>
  16173. <member name="M:Cognex.VisionPro3D.Cog3DHandEyeCalibrator.Dispose">
  16174. <inheritdoc cref="!:ICog3DBase::DestructorForThisClass" />
  16175. </member>
  16176. <member name="M:Cognex.VisionPro3D.Cog3DHandEyeCalibrator.#ctor(Cognex.VisionPro3D.Cog3DHandEyeCalibrator)">
  16177. <inheritdoc cref="!:ICog3DBase::DeepCopyConstructorForThisClass" />
  16178. </member>
  16179. <member name="M:Cognex.VisionPro3D.Cog3DHandEyeCalibrator.#ctor">
  16180. <summary>
  16181. Construct this default Cog3DHandEyeCalibrator.
  16182. Note that IsCameraMoving is true, PlateRectangleForResidualComputing
  16183. is null,
  16184. NumPlateSamplesX is 0,
  16185. and NumPlateSamplesY is 0.
  16186. </summary>
  16187. </member>
  16188. <member name="M:Cognex.VisionPro3D.Cog3DHandEyeCalibrator.OnHandEyeCalibrationProgress(Cognex.VisionPro3D.Cog3DHandEyeCalibrationProgressEventArgs)">
  16189. <summary>
  16190. Method to support hand-eye calibration progress event.
  16191. </summary>
  16192. <param name="evntArgs">
  16193. The object containing hand-eye calibration progress event arguments.
  16194. </param>
  16195. </member>
  16196. <member name="E:Cognex.VisionPro3D.Cog3DHandEyeCalibrator.HandEyeCalibrationProgress">
  16197. <summary>
  16198. Hand-eye calibration progress event.
  16199. </summary>
  16200. </member>
  16201. <member name="T:Cognex.VisionPro3D.Cog3DHandEyeCalibrator">
  16202. <summary>
  16203. This class encapsulates hand-eye calibration. Hand-eye calibration
  16204. establishes the mapping between the camera(s) and the robot end effector.
  16205. The IsCameraMoving property when true, specifies the cameras are mounted
  16206. on the robot end effector; when false, specifies the cameras are stationary.
  16207. </summary>
  16208. </member>
  16209. <member name="T:Cognex.VisionPro3D.Cog3DHandEyeCalibrationProgressEventHandler">
  16210. <summary>
  16211. This is the delegate for the hand-eye calibration progress event handler.
  16212. </summary>
  16213. </member>
  16214. <member name="M:Cognex.VisionPro3D.Cog3DHandEyeCalibrationProgressEventArgs.RequestCancel">
  16215. <summary>
  16216. Request to cancel the current hand-eye calibration.
  16217. </summary>
  16218. </member>
  16219. <member name="P:Cognex.VisionPro3D.Cog3DHandEyeCalibrationProgressEventArgs.CancelRequested">
  16220. <summary>
  16221. Gets whether a request to cancel the hand-eye calibration has been made.
  16222. </summary>
  16223. <value>
  16224. True if cancel is requested; False Otherwise
  16225. </value>
  16226. </member>
  16227. <member name="P:Cognex.VisionPro3D.Cog3DHandEyeCalibrationProgressEventArgs.Message">
  16228. <summary>
  16229. Gets the message string.
  16230. </summary>
  16231. <value>
  16232. A string describing the progress.
  16233. </value>
  16234. </member>
  16235. <member name="P:Cognex.VisionPro3D.Cog3DHandEyeCalibrationProgressEventArgs.Progress">
  16236. <summary>
  16237. Gets the progress (fraction of completion).
  16238. </summary>
  16239. <value>
  16240. The progress which is a number between 0 (0%) and 1.0 (100%).
  16241. </value>
  16242. </member>
  16243. <member name="M:Cognex.VisionPro3D.Cog3DHandEyeCalibrationProgressEventArgs.Finalize">
  16244. <inheritdoc cref="!:ICog3DBase::FinalizerForThisClass" />
  16245. </member>
  16246. <member name="M:Cognex.VisionPro3D.Cog3DHandEyeCalibrationProgressEventArgs.Dispose">
  16247. <inheritdoc cref="!:ICog3DBase::DestructorForThisClass" />
  16248. </member>
  16249. <member name="M:Cognex.VisionPro3D.Cog3DHandEyeCalibrationProgressEventArgs.#ctor(System.Double,System.String)">
  16250. <summary>
  16251. Construct this Cog3DHandEyeCalibrationProgressEventArgs using the
  16252. specified progress and message.
  16253. </summary>
  16254. <param name="progress">
  16255. The progress (the fraction of completion).
  16256. </param>
  16257. <param name="message">
  16258. A string describing the progress.
  16259. </param>
  16260. </member>
  16261. <member name="T:Cognex.VisionPro3D.Cog3DHandEyeCalibrationProgressEventArgs">
  16262. <summary>
  16263. This class holds data generated by the hand-eye calibration progress
  16264. event. The hand-eye calibration progress event fires periodically during hand-eye calibration.
  16265. A progress value of 0.0 means 0% complete and a value of 1.0 means 100% complete.
  16266. </summary>
  16267. </member>
  16268. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrationValidator.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  16269. <inheritdoc cref="!:ICog3DBase::GetObjectData" />
  16270. </member>
  16271. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrationValidator.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  16272. <inheritdoc cref="!:ICog3DBase::SerializationConstructor" />
  16273. </member>
  16274. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrationValidator.Execute(System.Collections.Generic.List`1{System.Drawing.Rectangle},System.Collections.Generic.List`1{System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCrspFeaturesCollection}},System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCameraCalibration},Cognex.VisionPro3D.Cog3DCameraCalibrationValidationResult@,Cognex.VisionPro3D.Cog3DCameraCalibrationValidationResult@)">
  16275. <summary>
  16276. Use the specified calibration features and the specified camera calibrations
  16277. to compute 2 camera calibration validation results.
  16278. The first result (<paramref name="validationResultUsingOriginalCalibrations" />)
  16279. contains the residuals when the specified camera calibrations are used.
  16280. The second result (<paramref name="validationResultUsingRecomputedExtrinsics" />)
  16281. contains the residuals after a new set of extrinsic parameters are computed
  16282. using the specified calibration features.
  16283. Note that for the case of a single camera, the two results
  16284. should be exactly equal to each other.
  16285. </summary>
  16286. <param name="pelRectRaw2Ds">
  16287. The list of rectangles representing the size of the raw
  16288. acquired images (the fields of view of the cameras). May not be null.
  16289. </param>
  16290. <param name="crspFeatures">
  16291. The two-dimensional list of feature correspondences from the cameras viewing the calibration plate.
  16292. The feature correspondences are indexed first
  16293. by the calibration plate pose, then by camera. <paramref name="crspFeatures" />[i][j] corresponds to the
  16294. ith calibration plate pose and the jth camera. May not be null.
  16295. </param>
  16296. <param name="raw2DFromPhys3Ds">
  16297. The list of camera calibrations, indexed by camera. <paramref name="raw2DFromPhys3Ds" />[i]
  16298. corresponds to the ith camera. May not be null.
  16299. </param>
  16300. <param name="validationResultUsingOriginalCalibrations">
  16301. The computed validation result corresponding to using the original camera calibrations.
  16302. </param>
  16303. <param name="validationResultUsingRecomputedExtrinsics">
  16304. The computed validation result corresponding to using re-computed
  16305. extrinsics based on the specified calibration features. Note that the camera intrinsics are kept from the
  16306. input camera calibrations. Note that it will be set to null if any camera distortion model is
  16307. Cog3DCameraCalibrationDistortionModelConstants.eTelecentric.
  16308. </param>
  16309. <exception cref="T:System.ArgumentNullException">
  16310. If any input argument is null or any input argument includes null item
  16311. (except <paramref name="crspFeatures" />[i][j].Weights).
  16312. </exception>
  16313. <exception cref="T:System.ArgumentException">
  16314. If input arguments do not match, e.g.
  16315. <list type="bullet"><item> If <paramref name="pelRectRaw2Ds" />.Count, <paramref name="raw2DFromPhys3Ds" />.Count, and
  16316. <paramref name="crspFeatures" />[i].Count are not the same.
  16317. (i is inside [0, <paramref name="crspFeatures" />.Count-1]); </item><item> If <paramref name="crspFeatures" /> is empty; </item><item> If <paramref name="pelRectRaw2Ds" /> is empty; </item><item> If <paramref name="crspFeatures" />[i][j].PointsModel3D.Count !=
  16318. <paramref name="crspFeatures" />[i][j].PointsRaw2D.Count
  16319. (i is inside [0, <paramref name="crspFeatures" />.Count-1],
  16320. and j is inside [0,<paramref name="crspFeatures" />[i].Count-1]);</item><item> If <paramref name="crspFeatures" />[i][j].Weights is not null,
  16321. and <paramref name="crspFeatures" />[i][j].Weights.Count !=
  16322. <paramref name="crspFeatures" />[i][j].PointsModel3D.Count
  16323. (i is inside [0, <paramref name="crspFeatures" />.Count-1],
  16324. and j is inside [0,<paramref name="crspFeatures" />[i].Count-1]);</item></list></exception>
  16325. <remarks>
  16326. Notes:
  16327. <list type="bullet"><item> This tool only requires a single set of calibration features, but
  16328. can provide more accurate results if multiple sets of calibration features
  16329. are provided. </item><item> The tool can tolerate some of the correspondences being empty
  16330. so long as there are other correspondences which allow the
  16331. validation to be computed. </item><item> This tool handles calibration features with 3-dimensional
  16332. physical positions. </item><item> This tool requires that all of the elements in the calibration features vector
  16333. correspond to the same set of cameras. </item><item> This tool requires that all of the calibration features correspond to cameras,
  16334. and the optical paths associated with each camera are unchanged. </item></list></remarks>
  16335. </member>
  16336. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrationValidator.Finalize">
  16337. <inheritdoc cref="!:ICog3DBase::FinalizerForThisClass" />
  16338. </member>
  16339. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrationValidator.Dispose">
  16340. <inheritdoc cref="!:ICog3DBase::DestructorForThisClass" />
  16341. </member>
  16342. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrationValidator.#ctor(Cognex.VisionPro3D.Cog3DCameraCalibrationValidator)">
  16343. <inheritdoc cref="!:ICog3DBase::DeepCopyConstructorForThisClass" />
  16344. </member>
  16345. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrationValidator.#ctor">
  16346. <summary>
  16347. Construct this default Cog3DCameraCalibrationValidator.
  16348. </summary>
  16349. </member>
  16350. <member name="T:Cognex.VisionPro3D.Cog3DCameraCalibrationValidator">
  16351. <summary>
  16352. This class provides the ability to verify a set of camera calibrations
  16353. accurately reflects the current intrinsic parameters
  16354. for a set of cameras as well as the relative positions of the cameras.
  16355. Note that the size of the set of camera calibrations
  16356. and the size of the set of cameras can be 1.
  16357. <para>
  16358. The verification requires as input
  16359. the original camera calibrations and a set of calibration features that
  16360. have been extracted from a newly acquired set of images.
  16361. The verification outputs
  16362. the 2D and 3D residuals characterizing the current accuracy of the image
  16363. acquisition system. These "current" accuracies can be compared to the "baseline"
  16364. accuracies computed at the time of the original camera calibration.
  16365. The results of the comparison determine whether or not
  16366. the image acquisition system is still in calibration.
  16367. </para><para>
  16368. Due to the nature
  16369. of the validation procedure (positioning a calibration plate in an arbitrary pose),
  16370. the validation cannot determine if the world coordinate system has changed.
  16371. Validation can only determine if the camera intrinsics are out of calibration,
  16372. and if the camera positions RELATIVE TO EACH OTHER have changed.
  16373. </para></summary>
  16374. <remarks>
  16375. A "baseline" validation should be performed immediately
  16376. after camera calibration. That baseline validation step should involve
  16377. multiple view sets so it is possible to estimate the distribution of 2D
  16378. residuals and 3D residuals. The "baseline" validation measurements should be
  16379. stored for future comparison.
  16380. <para> Then, at some arbitrary time (usually after the
  16381. system performed vision tasks for a period of time), the user
  16382. acquires images of the same calibration plate in some
  16383. set of (preferrably, the same) poses and executes camera calibration validation to get the "current"
  16384. measurements. Finally, the user compares the "current" validation
  16385. measurements with the "baseline". </para><para> If the "current" measurements agree with the "baseline"
  16386. measurements to a satisfactory degree, then the system is in
  16387. calibration and the user does not need to perform any
  16388. recalibration. If the measurement computed using the "recomputed
  16389. extrinsics" satisfactorily agrees, but the measurement computed
  16390. using the existing "camera calibration" do not satisfactorily agrees, then the
  16391. user needs to perform extrinsic calibration. If neither validation
  16392. measurements agree, then the user needs to perform full recalibration. </para></remarks>
  16393. </member>
  16394. <member name="M:Cognex.VisionPro3D.Cog3DShapeProjector.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  16395. <inheritdoc cref="!:ICog3DBase::GetObjectData" />
  16396. </member>
  16397. <member name="M:Cognex.VisionPro3D.Cog3DShapeProjector.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  16398. <inheritdoc cref="!:ICog3DBase::SerializationConstructor" />
  16399. </member>
  16400. <member name="M:Cognex.VisionPro3D.Cog3DShapeProjector.Execute(Cognex.VisionPro3D.Cog3DVect3Collection,Cognex.VisionPro3D.Cog3DTransformRigid,Cognex.VisionPro3D.Cog3DCameraCalibration,Cognex.VisionPro.ICogGraphic,System.Boolean,Cognex.VisionPro.CogGraphicCollection)">
  16401. <summary>
  16402. Overload to draw a collection of 3D points.
  16403. <paramref name="exemplarShape" /> can be a VisionPro shape that
  16404. serves as a marker: CogCircle, CogPointMarker, or CogRectangle.
  16405. </summary>
  16406. <param name="pointsAny3D">
  16407. A collection of 3D points in an arbitrary 3D space.
  16408. </param>
  16409. <param name="phys3DFromAny3D">
  16410. The rigid transform used to map the points inside
  16411. <paramref name="pointsAny3D" /> to the Phy3D space of
  16412. <paramref name="raw2DFromPhys3D" />. This parameter can be null to signify
  16413. an identity transform should be used.
  16414. </param>
  16415. <param name="raw2DFromPhys3D">
  16416. The camera calibration used for projecting the mapped 3D points onto an
  16417. acquired image. May not be null.
  16418. </param>
  16419. <param name="exemplarShape">
  16420. An example shape graphic used to draw each projected 2D point.
  16421. </param>
  16422. <param name="usingGraphicPropertiesOfShapeProjector">
  16423. If it is true, the graphic properties of this shape projector will be used
  16424. in rendering, otherwise the graphic properties of
  16425. <paramref name="exemplarShape" /> will be used instead.
  16426. </param>
  16427. <param name="graphicCollection">
  16428. The VisionPro graphics collection the rendered graphics is appended to.
  16429. </param>
  16430. <exception cref="T:System.ArgumentNullException">
  16431. If <paramref name="pointsAny3D" />, <paramref name="raw2DFromPhys3D" />,
  16432. <paramref name="exemplarShape" />,
  16433. or <paramref name="graphicCollection" /> is null.
  16434. </exception>
  16435. <exception cref="T:System.ArgumentException">
  16436. If <paramref name="exemplarShape" /> is not of Type CogCircle,
  16437. CogRectangle, or CogPointMarker.
  16438. </exception>
  16439. </member>
  16440. <member name="M:Cognex.VisionPro3D.Cog3DShapeProjector.Execute(Cognex.VisionPro3D.Cog3DVect2Collection,Cognex.VisionPro.ICogGraphic,System.Boolean,Cognex.VisionPro.CogGraphicCollection)">
  16441. <summary>
  16442. Overload to draw a collection of 2D points.
  16443. <paramref name="exemplarShape" /> can be a VisionPro shape that
  16444. serves as a marker: CogCircle, CogPointMarker, or CogRectangle.
  16445. </summary>
  16446. <param name="pointsRaw2D">
  16447. A collection of 2D points in the Raw2D space.
  16448. </param>
  16449. <param name="exemplarShape">
  16450. An example shape graphic used to draw each 2D point.
  16451. </param>
  16452. <param name="usingGraphicPropertiesOfShapeProjector">
  16453. If it is true, the graphic properties of this shape projector will be used
  16454. in rendering, otherwise the graphic properties of
  16455. <paramref name="exemplarShape" /> will be used instead.
  16456. </param>
  16457. <param name="graphicCollection">
  16458. The VisionPro graphics collection the rendered graphics is appended to.
  16459. </param>
  16460. <exception cref="T:System.ArgumentNullException">
  16461. If <paramref name="pointsRaw2D" />,
  16462. <paramref name="exemplarShape" />,
  16463. or <paramref name="graphicCollection" /> is null.
  16464. </exception>
  16465. <exception cref="T:System.ArgumentException">
  16466. If <paramref name="exemplarShape" /> is not of Type CogCircle,
  16467. CogRectangle, or CogPointMarker.
  16468. </exception>
  16469. </member>
  16470. <member name="M:Cognex.VisionPro3D.Cog3DShapeProjector.Execute(Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DTransformRigid,Cognex.VisionPro3D.Cog3DCameraCalibration,System.String,Cognex.VisionPro.CogGraphicCollection)">
  16471. <summary>
  16472. Maps 3D coordinate axes using the phys3DFromAxes3D transform.
  16473. Then projects the mapped 3D coordinate axes using the raw2DFromPhys3D
  16474. camera calibration onto the image plane. The projected axes, along with
  16475. x, y, z text and specified label are then rendered as VisionPro graphics
  16476. and appended to the specified graphicsCollection.
  16477. </summary>
  16478. <param name="lengthAxes3D">
  16479. The 3D vector representing the physical length of the X, Y, and Z
  16480. coordinate axes to be projected and rendered.
  16481. </param>
  16482. <param name="phys3DFromAxes3D">
  16483. The rigid transform used to specify the pose of the 3D coordinate axes
  16484. in the Phys3D coordinate space of the specified
  16485. raw2DFromPhys3D camera calibration. This parameter can be null to signify
  16486. an identity transform should be used.
  16487. </param>
  16488. <param name="raw2DFromPhys3D">
  16489. The camera calibration used for projecting the 3D coordinate axes onto an
  16490. acquired image. May not be null.
  16491. </param>
  16492. <param name="label">
  16493. The specified label for the 3D coordinate axes. If it is null, then the
  16494. label string is empty.
  16495. </param>
  16496. <param name="graphicCollection">
  16497. The VisionPro graphics collection the projected and rendered axes are
  16498. appended to.
  16499. </param>
  16500. <exception cref="T:System.ArgumentException">
  16501. If <paramref name="lengthAxes3D" /> is zero or negative in any dimension.
  16502. </exception>
  16503. <exception cref="T:System.ArgumentNullException">
  16504. if <paramref name="raw2DFromPhys3D" />,
  16505. or <paramref name="graphicCollection" /> is null.
  16506. </exception>
  16507. </member>
  16508. <member name="M:Cognex.VisionPro3D.Cog3DShapeProjector.Execute(System.Collections.Generic.List`1{Cognex.VisionPro3D.ICog3DShape},Cognex.VisionPro3D.Cog3DTransformRigid,Cognex.VisionPro3D.Cog3DCameraCalibration,Cognex.VisionPro.CogGraphicCollection)">
  16509. <summary>
  16510. Maps a list of 3D shapes using the phys3DFromShape3D transform.
  16511. Then projects the mapped 3D shapes using the raw2DFromPhys3D camera calibration
  16512. onto the image plane. The shapes are then rendered as VisionPro graphics and
  16513. appended to the specified graphicsCollection.
  16514. </summary>
  16515. <param name="shapesShape3D">
  16516. The 3D shapes to be projected and rendered.
  16517. </param>
  16518. <param name="phys3DFromShape3D">
  16519. The rigid transform used to map the shapes from the coordinate space it is
  16520. defined into the Phys3D coordinate space of the specified
  16521. raw2DFromPhys3D camera calibration. This parameter can be null to signify
  16522. an identity transform should be used.
  16523. </param>
  16524. <param name="raw2DFromPhys3D">
  16525. The camera calibration used for projecting the 3D shapes onto an acquired image.
  16526. </param>
  16527. <param name="graphicCollection">
  16528. The VisionPro graphics collection the rendered shape is appended to.
  16529. </param>
  16530. <exception cref="T:System.ArgumentNullException">
  16531. If <paramref name="shapesShape3D" />,
  16532. any item of <paramref name="shapesShape3D" />,
  16533. <paramref name="raw2DFromPhys3D" />,
  16534. or <paramref name="graphicCollection" /> is null.
  16535. </exception>
  16536. </member>
  16537. <member name="M:Cognex.VisionPro3D.Cog3DShapeProjector.Execute(Cognex.VisionPro3D.ICog3DShape,Cognex.VisionPro3D.Cog3DTransformRigid,Cognex.VisionPro3D.Cog3DCameraCalibration,Cognex.VisionPro.CogGraphicCollection)">
  16538. <summary>
  16539. Maps the specified 3D shape using the phys3DFromShape3D transform.
  16540. Then projects the mapped 3D shape using the raw2DFromPhys3D camera
  16541. calibration onto the image plane. The shape is then rendered as a
  16542. VisionPro graphic and appended to the specified graphicsCollection.
  16543. </summary>
  16544. <param name="shapeShape3D">
  16545. The 3D shape to be projected and rendered.
  16546. </param>
  16547. <param name="phys3DFromShape3D">
  16548. The rigid transform used to map the shape from the coordinate space
  16549. it is defined into the Phys3D coordinate space of the specified
  16550. raw2DFromPhys3D camera calibration. This parameter can be null to
  16551. signify an identity transform should be used.
  16552. </param>
  16553. <param name="raw2DFromPhys3D">
  16554. The camera calibration used for projecting the 3D shape onto an acquired
  16555. image.
  16556. </param>
  16557. <param name="graphicCollection">
  16558. The VisionPro graphics collection the rendered shape is appended to.
  16559. </param>
  16560. <exception cref="T:System.ArgumentNullException">
  16561. If <paramref name="shapeShape3D" />, <paramref name="raw2DFromPhys3D" />,
  16562. or <paramref name="graphicCollection" /> is null.
  16563. </exception>
  16564. </member>
  16565. <member name="P:Cognex.VisionPro3D.Cog3DShapeProjector.LineStyle">
  16566. <summary>
  16567. Gets/sets the line style used for rendering the shapes.
  16568. </summary>
  16569. <value>
  16570. The line style used for rendering shapes.
  16571. </value>
  16572. </member>
  16573. <member name="P:Cognex.VisionPro3D.Cog3DShapeProjector.LineWidthInScreenPixels">
  16574. <summary>
  16575. Gets/sets the line width used for rendering the shapes.
  16576. </summary>
  16577. <value>
  16578. The line width in screen pixels used for rendering shapes.
  16579. </value>
  16580. <exception cref="T:System.ArgumentException">
  16581. From setter if <paramref name="lineWidthInScreenPixels" /> is less than 1.
  16582. </exception>
  16583. </member>
  16584. <member name="P:Cognex.VisionPro3D.Cog3DShapeProjector.Color">
  16585. <summary>
  16586. Gets/sets the color of the shapes being rendered.
  16587. </summary>
  16588. <value>
  16589. The color used for rendering shapes.
  16590. </value>
  16591. </member>
  16592. <member name="P:Cognex.VisionPro3D.Cog3DShapeProjector.ShapeRepresentation">
  16593. <summary>
  16594. Gets/sets how shapes are to be rendered.
  16595. </summary>
  16596. <value>
  16597. Bitfield specifying how shapes are rendered.
  16598. Set the Cog3DShapeStateConstants::Vertex bit to have vertices representing
  16599. the shape rendered.
  16600. Set the Cog3DShapeStateConstants::Curve bit to have the curves representing
  16601. the shape rendered.
  16602. </value>
  16603. <exception cref="T:System.ArgumentException">
  16604. The Cog3DShapeStateConstants::Vertex bit and/or the
  16605. Cog3DShapeStateConstants::Curve bit must be set in
  16606. <paramref name="shapeRepresentation" />.
  16607. </exception>
  16608. </member>
  16609. <member name="M:Cognex.VisionPro3D.Cog3DShapeProjector.Finalize">
  16610. <inheritdoc cref="!:ICog3DBase::FinalizerForThisClass" />
  16611. </member>
  16612. <member name="M:Cognex.VisionPro3D.Cog3DShapeProjector.Dispose">
  16613. <inheritdoc cref="!:ICog3DBase::DestructorForThisClass" />
  16614. </member>
  16615. <member name="M:Cognex.VisionPro3D.Cog3DShapeProjector.#ctor(Cognex.VisionPro3D.Cog3DShapeProjector)">
  16616. <inheritdoc cref="!:ICog3DBase::DeepCopyConstructorForThisClass" />
  16617. </member>
  16618. <member name="M:Cognex.VisionPro3D.Cog3DShapeProjector.#ctor">
  16619. <summary>
  16620. Initializes this object for use. It is initialized such that:
  16621. Color is CogColorConstants.Cyan,
  16622. LineWidthInScreenPixels is 1,
  16623. LineStyle is CogGraphicLineStyleConstants.Solid, and
  16624. ShapeRepresentation is
  16625. Cog3DShapeStateConstants.Vertex | Cog3DShapeStateConstants::Curve.
  16626. </summary>
  16627. </member>
  16628. <member name="T:Cognex.VisionPro3D.Cog3DShapeProjector">
  16629. <summary>
  16630. This class provides the functionality for projecting the
  16631. vertex and/or curve representations of 3D shapes onto the image plane
  16632. of a calibrated 2D camera i.e. acquired image, converting the
  16633. projection results to 2D VisionPro graphics and then appending the graphics
  16634. to a VisionPro CogGraphicCollection.
  16635. </summary>
  16636. </member>
  16637. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrator.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  16638. <inheritdoc cref="!:ICog3DBase::GetObjectData" />
  16639. </member>
  16640. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrator.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  16641. <inheritdoc cref="!:ICog3DBase::SerializationConstructor" />
  16642. </member>
  16643. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrator.ToString">
  16644. <inheritdoc cref="!:ICog3DBase::ToString" />
  16645. </member>
  16646. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrator.Execute(System.Collections.Generic.List`1{System.Drawing.Rectangle},System.Collections.Generic.List`1{System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCrspFeaturesCollection}},System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCameraCalibrationIntrinsics},System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DTransformRigid},System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCalibrationPlatePoseTypeConstants})">
  16647. <summary>
  16648. Overload for computing the 3D camera calibration from the given feature correspondences, camera
  16649. intrinsic parameters, and calibration plate poses. Note that
  16650. DistortionModel inside this Cog3DCameraCalibrator will be ignored, and the ones inside
  16651. <paramref name="raw2DFromCamera2Ds" /> will be used instead.
  16652. </summary>
  16653. <param name="pelRectRaw2Ds">
  16654. The list of the regions of interest (the fields of view) of the raw
  16655. acquired images (the fields of view of the cameras). May not be null.
  16656. Each item must be the size of acquired calibration images for that camera (with origin (0,0)).
  16657. </param>
  16658. <param name="crspFeatures">
  16659. Two-dimensional list of feature correspondences from the cameras viewing the calibration plate.
  16660. The feature correspondences are indexed first
  16661. by the calibration plate pose, then by camera. <paramref name="crspFeatures" />[i][j] corresponds to the
  16662. ith calibration plate pose and the jth camera. May not be null.
  16663. </param>
  16664. <param name="raw2DFromCamera2Ds">
  16665. A list of intrinsic camera calibration parameters, and indexed by camera. <paramref name="raw2DFromCamera2Ds" />[i]
  16666. corresponds to the ith camera. May not be null.
  16667. </param>
  16668. <param name="world3DFromCalPlate3Ds">
  16669. The list of poses of the calibration plate (with respect to the calibration plate pose
  16670. defining the world coordinate system). <paramref name="world3DFromCalPlate3Ds" />[i] corresponds to
  16671. the ith calibration plate pose.
  16672. Calibration plate pose does not need to be specified exactly for pose types of PoseElevated or
  16673. PoseTilted. The requirement is as follows:
  16674. <list type="bullet"><item> The poses for pose types of PoseSpecified must be valid/appropriate; </item><item> The poses for pose types of PoseTilted will be ignored; </item><item> The poses for pose types of PoseElevated will be used
  16675. to set the z height information of the calibration plate (only pose.Translation.Z will be used); </item><item> The pose for pose type of PoseDefineWorldCoord must be identity. </item></list></param>
  16676. <param name="poseTypes">
  16677. The list of calibration plate pose types. It should have the same length as <paramref name="world3DFromCalPlate3Ds" />. May not be null.
  16678. </param>
  16679. <exception cref="T:System.ArgumentNullException">
  16680. If any input argument is null or any input argument includes null item
  16681. (except <paramref name="crspFeatures" />[i][j].Weights).
  16682. </exception>
  16683. <exception cref="T:System.ArgumentException">
  16684. If input arguments do not match, e.g.
  16685. <list type="bullet"><item> If <paramref name="crspFeatures" />,
  16686. <paramref name="world3DFromCalPlate3Ds" />, and <paramref name="poseTypes" /> are not the same length; </item><item> If <paramref name="pelRectRaw2Ds" />, <paramref name="raw2DFromCamera2Ds" />, and
  16687. <paramref name="crspFeatures" />[i]
  16688. (i is inside [0, <paramref name="crspFeatures" />.Count-1]) are not the same length; </item><item> If <paramref name="crspFeatures" /> is empty; </item><item> If <paramref name="pelRectRaw2Ds" /> is empty. </item><item> If <paramref name="crspFeatures" />[i][j].PointsModel3D.Count !=
  16689. <paramref name="crspFeatures" />[i][j].PointsRaw2D.Count
  16690. (i is inside [0, <paramref name="crspFeatures" />.Count-1],
  16691. and j is inside [0,<paramref name="crspFeatures" />[i].Count-1]);</item><item> If <paramref name="crspFeatures" />[i][j].Weights is not null,
  16692. and <paramref name="crspFeatures" />[i][j].Weights.Count !=
  16693. <paramref name="crspFeatures" />[i][j].PointsModel3D.Count
  16694. (i is inside [0, <paramref name="crspFeatures" />.Count-1],
  16695. and j is inside [0,<paramref name="crspFeatures" />[i].Count-1]);</item></list></exception>
  16696. <exception cref="T:Cognex.VisionPro3D.Cog3DOperationCancelledByUserException">
  16697. If the operation is cancelled by user via the event handler.
  16698. </exception>
  16699. <returns>
  16700. The 3D camera calibration result.
  16701. </returns>
  16702. <remarks>
  16703. This overload ignores DistortionModel value of this Cog3DCameraCalibrator object.
  16704. </remarks>
  16705. </member>
  16706. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrator.Execute(System.Collections.Generic.List`1{System.Drawing.Rectangle},System.Collections.Generic.List`1{System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCrspFeaturesCollection}},System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCameraCalibrationIntrinsics},Cognex.VisionPro3D.Cog3DScalarCollection,System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCalibrationPlatePoseTypeConstants})">
  16707. <summary>
  16708. Overload for computing the 3D camera calibration from the given feature correspondences and camera
  16709. intrinsic parameters, and z height information of the calibration plate poses. Note that
  16710. DistortionModel inside this Cog3DCameraCalibrator will be ignored, and the ones inside
  16711. <paramref name="raw2DFromCamera2Ds" /> will be used instead.
  16712. </summary>
  16713. <param name="pelRectRaw2Ds">
  16714. The list of the regions of interest (the fields of view) of the raw
  16715. acquired images (the fields of view of the cameras). May not be null.
  16716. Each item must be the size of acquired calibration images for that camera (with origin (0,0)).
  16717. </param>
  16718. <param name="crspFeatures">
  16719. Two-dimensional list of feature correspondences from the cameras viewing the calibration plate.
  16720. The feature correspondences are indexed first
  16721. by the calibration plate pose, then by camera. <paramref name="crspFeatures" />[i][j] corresponds to the
  16722. ith calibration plate pose and the jth camera. May not be null.
  16723. </param>
  16724. <param name="raw2DFromCamera2Ds">
  16725. A list of intrinsic camera calibration parameters, and indexed by camera. <paramref name="raw2DFromCamera2Ds" />[i]
  16726. corresponds to the ith camera. May not be null.
  16727. </param>
  16728. <param name="zHeightsPhys3D">
  16729. The z positions of the calibration plate for different calibration plate poses.
  16730. <paramref name="zHeightsPhys3D" />[i] corresponds to the ith calibration plate pose. The requirement is as follows:
  16731. <list type="bullet"><item> The z positions corresponding to pose types of PoseElevated must be valid/appropriate; </item><item> The z position corresponding to pose type of PoseDefineWorldCoord must be 0; </item><item> The z positions corresponding to pose types of PoseTilted will be ignored; </item><item> The z positions corresponding to pose types of PoseSpecified require that the calibration
  16732. plate is a pure translation in Z from the PoseDefineWorldCoord poseType.
  16733. Thus, a Z value is all that is required. </item></list>
  16734. May not be null.
  16735. </param>
  16736. <param name="poseTypes">
  16737. The list of calibration plate pose types. <paramref name="poseTypes" />[i] corresponds to the ith calibration
  16738. plate pose type. It should have the same length as <paramref name="zHeightsPhys3D" />. May not be null.
  16739. </param>
  16740. <exception cref="T:System.ArgumentNullException">
  16741. If any input argument is null or any input argument includes null item
  16742. (except <paramref name="crspFeatures" />[i][j].Weights).
  16743. </exception>
  16744. <exception cref="T:System.ArgumentException">
  16745. If input arguments do not match, e.g.
  16746. <list type="bullet"><item> If <paramref name="crspFeatures" />, <paramref name="zHeightsPhys3D" />, and <paramref name="poseTypes" />
  16747. are not the same length; </item><item> If <paramref name="pelRectRaw2Ds" />, <paramref name="raw2DFromCamera2Ds" />, and <paramref name="crspFeatures" />[i]
  16748. (i is inside [0, <paramref name="crspFeatures" />.Count-1]) are not the same length; </item><item> If <paramref name="crspFeatures" /> is empty; </item><item> If <paramref name="pelRectRaw2Ds" /> is empty. </item><item> If <paramref name="crspFeatures" />[i][j].PointsModel3D.Count !=
  16749. <paramref name="crspFeatures" />[i][j].PointsRaw2D.Count
  16750. (i is inside [0, <paramref name="crspFeatures" />.Count-1],
  16751. and j is inside [0,<paramref name="crspFeatures" />[i].Count-1]);</item><item> If <paramref name="crspFeatures" />[i][j].Weights is not null,
  16752. and <paramref name="crspFeatures" />[i][j].Weights.Count !=
  16753. <paramref name="crspFeatures" />[i][j].PointsModel3D.Count
  16754. (i is inside [0, <paramref name="crspFeatures" />.Count-1],
  16755. and j is inside [0,<paramref name="crspFeatures" />[i].Count-1]);</item></list></exception>
  16756. <exception cref="T:Cognex.VisionPro3D.Cog3DOperationCancelledByUserException">
  16757. If the operation is cancelled by user via the event handler.
  16758. </exception>
  16759. <returns>
  16760. The 3D camera calibration result.
  16761. </returns>
  16762. <remarks>
  16763. This overload ignores DistortionModel value of this Cog3DCameraCalibrator object.
  16764. </remarks>
  16765. </member>
  16766. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrator.Execute(System.Collections.Generic.List`1{System.Drawing.Rectangle},System.Collections.Generic.List`1{System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCrspFeaturesCollection}},System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DTransformRigid},System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCalibrationPlatePoseTypeConstants})">
  16767. <summary>
  16768. Overload for computing the 3D camera calibration from the given feature correspondences, and
  16769. calibration plate poses.
  16770. </summary>
  16771. <param name="pelRectRaw2Ds">
  16772. The list of the regions of interest (the fields of view) of the raw
  16773. acquired images (the fields of view of the cameras). May not be null.
  16774. Each item must be the size of acquired calibration images for that camera (with origin (0,0)).
  16775. </param>
  16776. <param name="crspFeatures">
  16777. Two-dimensional list of feature correspondences from the cameras viewing the calibration plate.
  16778. The feature correspondences are indexed first
  16779. by the calibration plate pose, then by camera. <paramref name="crspFeatures" />[i][j] corresponds to the
  16780. ith calibration plate pose and the jth camera. May not be null.
  16781. </param>
  16782. <param name="world3DFromCalPlate3Ds">
  16783. The list of poses of the calibration plate (with respect to the calibration plate pose
  16784. defining the world coordinate system). <paramref name="world3DFromCalPlate3Ds" />[i] corresponds to
  16785. the ith calibration plate pose.
  16786. Calibration plate pose does not need to be specified exactly for pose types of PoseElevated or
  16787. PoseTilted. The requirement is as follows:
  16788. <list type="bullet"><item> The poses for pose types of PoseSpecified must be valid/appropriate; </item><item> The poses for pose types of PoseTilted will be ignored; </item><item> The poses for pose types of PoseElevated will be used
  16789. to set the z height information of the calibration plate (only pose.Translation.Z will be used); </item><item> The pose for pose type of PoseDefineWorldCoord must be identity. </item></list></param>
  16790. <param name="poseTypes">
  16791. The list of calibration plate pose types. It should have the same length as <paramref name="world3DFromCalPlate3Ds" />. May not be null.
  16792. </param>
  16793. <exception cref="T:System.ArgumentNullException">
  16794. If any input argument is null or any input argument includes null item
  16795. (except <paramref name="crspFeatures" />[i][j].Weights).
  16796. </exception>
  16797. <exception cref="T:System.ArgumentException">
  16798. If input arguments do not match, e.g.
  16799. <list type="bullet"><item> If <paramref name="crspFeatures" />, <paramref name="world3DFromCalPlate3Ds" />, and
  16800. <paramref name="poseTypes" /> are not the same length; </item><item> If <paramref name="pelRectRaw2Ds" /> does not have the same length as
  16801. <paramref name="crspFeatures" />[i]
  16802. (i is inside [0, <paramref name="crspFeatures" />.Count-1]); </item><item> If <paramref name="crspFeatures" /> is empty; </item><item> If <paramref name="pelRectRaw2Ds" /> is empty. </item><item> If <paramref name="crspFeatures" />[i][j].PointsModel3D.Count !=
  16803. <paramref name="crspFeatures" />[i][j].PointsRaw2D.Count
  16804. (i is inside [0, <paramref name="crspFeatures" />.Count-1],
  16805. and j is inside [0,<paramref name="crspFeatures" />[i].Count-1]);</item><item> If <paramref name="crspFeatures" />[i][j].Weights is not null,
  16806. and <paramref name="crspFeatures" />[i][j].Weights.Count !=
  16807. <paramref name="crspFeatures" />[i][j].PointsModel3D.Count
  16808. (i is inside [0, <paramref name="crspFeatures" />.Count-1],
  16809. and j is inside [0,<paramref name="crspFeatures" />[i].Count-1]);</item></list></exception>
  16810. <exception cref="T:Cognex.VisionPro3D.Cog3DOperationCancelledByUserException">
  16811. If the operation is cancelled by user via the event handler.
  16812. </exception>
  16813. <returns>
  16814. The 3D camera calibration result.
  16815. </returns>
  16816. </member>
  16817. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrator.Execute(System.Collections.Generic.List`1{System.Drawing.Rectangle},System.Collections.Generic.List`1{System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCrspFeaturesCollection}},Cognex.VisionPro3D.Cog3DScalarCollection,System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCalibrationPlatePoseTypeConstants})">
  16818. <summary>
  16819. Overload for computing the 3D camera calibration from the given feature correspondences, and z
  16820. height information of the calibration plate poses.
  16821. </summary>
  16822. <param name="pelRectRaw2Ds">
  16823. The list of the regions of interest (the fields of view) of the raw
  16824. acquired images (the fields of view of the cameras). May not be null.
  16825. Each item must be the size of acquired calibration images for that camera (with origin (0,0)).
  16826. </param>
  16827. <param name="crspFeatures">
  16828. Two-dimensional list of feature correspondences from the cameras viewing the calibration plate.
  16829. The feature correspondences are indexed first
  16830. by the calibration plate pose, then by camera. <paramref name="crspFeatures" />[i][j] corresponds to the
  16831. ith calibration plate pose and the jth camera. May not be null.
  16832. </param>
  16833. <param name="zHeightsPhys3D">
  16834. The z positions of the calibration plate for different calibration plate poses.
  16835. <paramref name="zHeightsPhys3D" />[i] corresponds to the ith calibration plate pose. The requirement is as follows:
  16836. <list type="bullet"><item> The z positions corresponding to pose types of PoseElevated must be valid/appropriate; </item><item> The z position corresponding to pose type of PoseDefineWorldCoord must be 0; </item><item> The z positions corresponding to pose types of PoseTilted will be ignored; </item><item> The z positions corresponding to pose types of PoseSpecified require that the calibration
  16837. plate is a pure translation in Z from the PoseDefineWorldCoord poseType.
  16838. Thus, a Z value is all that is required. </item></list>
  16839. May not be null.
  16840. </param>
  16841. <param name="poseTypes">
  16842. The list of calibration plate pose types. <paramref name="poseTypes" />[i] corresponds to the ith calibration
  16843. plate pose type. It should have the same length as <paramref name="zHeightsPhys3D" />. May not be null.
  16844. </param>
  16845. <exception cref="T:System.ArgumentNullException">
  16846. If any input argument is null or any input argument includes null item
  16847. (except <paramref name="crspFeatures" />[i][j].Weights).
  16848. </exception>
  16849. <exception cref="T:System.ArgumentException">
  16850. If input arguments do not match, e.g.
  16851. <list type="bullet"><item> If <paramref name="crspFeatures" />,
  16852. <paramref name="zHeightsPhys3D" />, and <paramref name="poseTypes" /> are not the same length; </item><item> If <paramref name="pelRectRaw2Ds" /> does not have the same length as
  16853. <paramref name="crspFeatures" />[i]
  16854. (i is inside [0, <paramref name="crspFeatures" />.Count-1]); </item><item> If <paramref name="crspFeatures" /> is empty; </item><item> If <paramref name="pelRectRaw2Ds" /> is empty;</item><item> If <paramref name="crspFeatures" />[i][j].PointsModel3D.Count !=
  16855. <paramref name="crspFeatures" />[i][j].PointsRaw2D.Count
  16856. (i is inside [0, <paramref name="crspFeatures" />.Count-1],
  16857. and j is inside [0,<paramref name="crspFeatures" />[i].Count-1]);</item><item> If <paramref name="crspFeatures" />[i][j].Weights is not null,
  16858. and <paramref name="crspFeatures" />[i][j].Weights.Count !=
  16859. <paramref name="crspFeatures" />[i][j].PointsModel3D.Count
  16860. (i is inside [0, <paramref name="crspFeatures" />.Count-1],
  16861. and j is inside [0,<paramref name="crspFeatures" />[i].Count-1]);</item></list></exception>
  16862. <exception cref="T:Cognex.VisionPro3D.Cog3DOperationCancelledByUserException">
  16863. If the operation is cancelled by user via the event handler.
  16864. </exception>
  16865. <returns>
  16866. The 3D camera calibration result.
  16867. </returns>
  16868. </member>
  16869. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrator.Execute(System.Collections.Generic.List`1{System.Collections.Generic.List`1{Cognex.VisionPro.ICogImage}},Cognex.VisionPro3D.ICog3DCalibrationFeatureExtractor,System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DTransformRigid},System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCalibrationPlatePoseTypeConstants})">
  16870. <summary>
  16871. Overload method of Computing the 3D camera calibration from the given images and calibration plate poses.
  16872. </summary>
  16873. <param name="images">
  16874. Two-dimensional list of images from the cameras viewing the calibration plate. The images are indexed first
  16875. by the calibration plate pose, then by camera. <paramref name="images" />[i][j] corresponds to the
  16876. ith calibration plate pose and the jth camera. May not be null.
  16877. </param>
  16878. <param name="featureExtractor">
  16879. The feature extractor operator to be used. A Cog3DCheckerboardFeatureExtractor should be used if using
  16880. Cognex checkerboard calibration plate. May not be null.
  16881. </param>
  16882. <param name="world3DFromCalPlate3Ds">
  16883. The list of poses of the calibration plate (with respect to the calibration plate pose
  16884. defining the world coordinate system). <paramref name="world3DFromCalPlate3Ds" />[i] corresponds to
  16885. the ith calibration plate pose.
  16886. Calibration plate pose does not need to be specified exactly for pose types of PoseElevated or
  16887. PoseTilted. The requirement is as follows:
  16888. <list type="bullet"><item> The poses for pose types of PoseSpecified must be valid/appropriate; </item><item> The poses for pose types of PoseTilted will be ignored; </item><item> The poses for pose types of PoseElevated will be used
  16889. to set the z height information of the calibration plate (only pose.Translation.Z will be used); </item><item> The pose for pose type of PoseDefineWorldCoord must be identity. </item></list></param>
  16890. <param name="poseTypes">
  16891. The list of calibration plate pose types. It should have the same length as <paramref name="world3DFromCalPlate3Ds" />. May not be null.
  16892. </param>
  16893. <exception cref="T:System.ArgumentNullException">
  16894. If any input argument is null or any input argument includes null item.
  16895. </exception>
  16896. <exception cref="T:System.ArgumentException">
  16897. If input arguments do not match, e.g.
  16898. <list type="bullet"><item> If <paramref name="images" />, <paramref name="world3DFromCalPlate3Ds" />, and
  16899. <paramref name="poseTypes" /> are not the same length; </item><item> If <paramref name="images" />[i] does not have the same length as
  16900. <paramref name="images" />[j] (i and j are inside [0, <paramref name="images" />.Count-1]); </item><item> If <paramref name="images" /> is empty or <paramref name="images" />[0] is empty. </item></list></exception>
  16901. <exception cref="T:Cognex.VisionPro3D.Cog3DOperationCancelledByUserException">
  16902. If the operation is cancelled by user via the event handler.
  16903. </exception>
  16904. <returns>
  16905. The 3D camera calibration result.
  16906. </returns>
  16907. </member>
  16908. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrator.Execute(System.Collections.Generic.List`1{System.Collections.Generic.List`1{Cognex.VisionPro.ICogImage}},Cognex.VisionPro3D.ICog3DCalibrationFeatureExtractor,Cognex.VisionPro3D.Cog3DScalarCollection,System.Collections.Generic.List`1{Cognex.VisionPro3D.Cog3DCalibrationPlatePoseTypeConstants})">
  16909. <summary>
  16910. Compute the 3D camera calibration from the given images and z height information of the calibration plate poses.
  16911. </summary>
  16912. <param name="images">
  16913. Two-dimensional list of images from the cameras viewing the calibration plate. The images are indexed first
  16914. by the calibration plate pose, then by camera. <paramref name="images" />[i][j] corresponds to the
  16915. ith calibration plate pose and the jth camera. May not be null.
  16916. </param>
  16917. <param name="featureExtractor">
  16918. The feature extractor operator to be used. A Cog3DCheckerboardFeatureExtractor should be used if using
  16919. Cognex checkerboard calibration plate. May not be null.
  16920. </param>
  16921. <param name="zHeightsPhys3D">
  16922. The z positions of the calibration plate for different calibration plate poses.
  16923. <paramref name="zHeightsPhys3D" />[i] corresponds to the ith calibration plate pose. The requirement is as follows:
  16924. <list type="bullet"><item> The z positions corresponding to pose types of PoseElevated must be valid/appropriate; </item><item> The z position corresponding to pose type of PoseDefineWorldCoord must be 0; </item><item> The z positions corresponding to pose types of PoseTilted will be ignored; </item><item> The z positions corresponding to pose types of PoseSpecified require that the calibration
  16925. plate is a pure translation in Z from the PoseDefineWorldCoord poseType.
  16926. Thus, a Z value is all that is required. </item></list>
  16927. May not be null.
  16928. </param>
  16929. <param name="poseTypes">
  16930. The list of calibration plate pose types. <paramref name="poseTypes" />[i] corresponds to the ith calibration
  16931. plate pose type. It should have the same length as <paramref name="zHeightsPhys3D" />. May not be null.
  16932. </param>
  16933. <exception cref="T:System.ArgumentNullException">
  16934. If any input argument is null or any input argument includes null item.
  16935. </exception>
  16936. <exception cref="T:System.ArgumentException">
  16937. If input arguments do not match, e.g.
  16938. <list type="bullet"><item> If <paramref name="images" />, <paramref name="zHeightsPhys3D" />, and
  16939. <paramref name="poseTypes" /> are not the same length;</item><item> If <paramref name="images" />[i] does not have the same length as
  16940. <paramref name="images" />[j] (i and j are inside [0, <paramref name="images" />.Count-1]); </item><item> If <paramref name="images" /> is empty or <paramref name="images" />[0] is empty. </item></list></exception>
  16941. <exception cref="T:Cognex.VisionPro3D.Cog3DOperationCancelledByUserException">
  16942. If the operation is cancelled by user via the event handler.
  16943. </exception>
  16944. <returns>
  16945. The 3D camera calibration result.
  16946. </returns>
  16947. </member>
  16948. <member name="P:Cognex.VisionPro3D.Cog3DCameraCalibrator.TelecentricPhys3DFromCamera3DZs">
  16949. <summary>
  16950. Gets/sets the approximate cameras' positions
  16951. with respect to the calibration plate (for telecentric cameras).
  16952. </summary>
  16953. <exception cref="T:System.ArgumentNullException">
  16954. If <paramref name="telecentricPhys3DFromCamera3DZs" /> of setter is null.
  16955. </exception>
  16956. <value>
  16957. The approximate estimates of the cameras' positions (Z heights in
  16958. Phys3D). May not be null.
  16959. </value>
  16960. <remarks>
  16961. Since the direction of Z axis of Phys3D is out the back of the calibration plate,
  16962. the Z values of cameras that can see the calibration plate when defining the world coordinate
  16963. should be negative.
  16964. </remarks>
  16965. </member>
  16966. <member name="P:Cognex.VisionPro3D.Cog3DCameraCalibrator.DistortionModel">
  16967. <summary>
  16968. Gets/sets the distortion model parameter.
  16969. </summary>
  16970. <value>
  16971. The distortion model used for camera calibration.
  16972. </value>
  16973. </member>
  16974. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrator.Finalize">
  16975. <inheritdoc cref="!:ICog3DBase::FinalizerForThisClass" />
  16976. </member>
  16977. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrator.Dispose">
  16978. <inheritdoc cref="!:ICog3DBase::DestructorForThisClass" />
  16979. </member>
  16980. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrator.#ctor(Cognex.VisionPro3D.Cog3DCameraCalibrator)">
  16981. <inheritdoc cref="!:ICog3DBase::DeepCopyConstructorForThisClass" />
  16982. </member>
  16983. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrator.#ctor">
  16984. <summary>
  16985. Construct this default Cog3DCameraCalibrator. Note that the default distortion model is
  16986. Cog3DCameraCalibrationDistortionModelConstants.e3ParamRadial.
  16987. </summary>
  16988. </member>
  16989. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrator.OnCameraCalibrationProgress(Cognex.VisionPro3D.Cog3DCameraCalibrationProgressEventArgs)">
  16990. <summary>
  16991. Method to support calibration progress event.
  16992. </summary>
  16993. <param name="evntArgs">
  16994. The object containing camera calibration progress event arguments.
  16995. </param>
  16996. </member>
  16997. <member name="E:Cognex.VisionPro3D.Cog3DCameraCalibrator.CameraCalibrationProgress">
  16998. <summary>
  16999. Camera calibration progress event.
  17000. </summary>
  17001. </member>
  17002. <member name="T:Cognex.VisionPro3D.Cog3DCameraCalibrator">
  17003. <summary>
  17004. This class is for executing 3D camera calibration for one or multiple cameras.
  17005. </summary>
  17006. <remarks>
  17007. Cognex 3D camera calibration tool requires:
  17008. <list type="bullet"><item> All of the images/features correspond to the same set of stationary cameras, and the optical paths associated with
  17009. each camera are unchanged. </item><item> All of the images/features correspond to the same calibration plate. </item></list>
  17010. Notes:
  17011. <list type="bullet"><item> The tool can tolerate it if the plate pose defining
  17012. world coordinates does not include features for some of the
  17013. cameras - as long as the camera poses can be induced from other
  17014. images. </item><item> The tool may take a relatively long time to run, and supports
  17015. progress event. </item><item> The tool can handle cameras of different camera intrinsics,
  17016. such as different resolutions and cameras with different focal
  17017. length lenses. </item><item> The calibration computation minimizes the sum squared error in image
  17018. coordinates. Therefore, if different cameras have different pixel
  17019. resolutions, then the calibration may be dominated by the
  17020. higher resolution cameras. Consequently, this tool is most
  17021. useful when all cameras have similar pixel resolutions. </item><item> Cognex strongly recommends performing a camera calibration validation after
  17022. you perform camera calibration. This camera calibration validation
  17023. establishes a baseline that can be used in the future to determine
  17024. if your cameras are still calibrated. See the Cog3DCameraCalibrationValidator
  17025. class for details. </item></list></remarks>
  17026. </member>
  17027. <member name="T:Cognex.VisionPro3D.Cog3DCalibrationPlatePoseTypeConstants">
  17028. <summary>
  17029. This class defines enumeration constants used for calibration plate pose types.
  17030. </summary>
  17031. </member>
  17032. <member name="F:Cognex.VisionPro3D.Cog3DCalibrationPlatePoseTypeConstants.DefaultPoseType">
  17033. <summary>
  17034. DefaultPoseType is equal to PoseDefineWorldCoord.
  17035. </summary>
  17036. </member>
  17037. <member name="F:Cognex.VisionPro3D.Cog3DCalibrationPlatePoseTypeConstants.PoseSpecified">
  17038. <summary>
  17039. The calibration plate is accurately positioned at a known pose in
  17040. the world coordinate system.
  17041. </summary>
  17042. </member>
  17043. <member name="F:Cognex.VisionPro3D.Cog3DCalibrationPlatePoseTypeConstants.PoseTilted">
  17044. <summary>
  17045. The calibration plate is arbitrarily positioned.
  17046. </summary>
  17047. </member>
  17048. <member name="F:Cognex.VisionPro3D.Cog3DCalibrationPlatePoseTypeConstants.PoseElevated">
  17049. <summary>
  17050. The calibration plate pose is precisely parallel to the pose that
  17051. defined the world coordinate system (and the offset between the
  17052. two calibration plate poses will be specified). Note that the
  17053. (x,y) translation and rotation in-the-plane are unconstrained.
  17054. </summary>
  17055. </member>
  17056. <member name="F:Cognex.VisionPro3D.Cog3DCalibrationPlatePoseTypeConstants.PoseDefineWorldCoord">
  17057. <summary>
  17058. The calibration plate pose defines the world coordinate system.
  17059. </summary>
  17060. </member>
  17061. <member name="T:Cognex.VisionPro3D.Cog3DCameraCalibrationProgressEventHandler">
  17062. <summary>
  17063. This is the delegate of camera calibration progress event handler.
  17064. </summary>
  17065. </member>
  17066. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrationProgressEventArgs.RequestCancel">
  17067. <summary>
  17068. Request to cancel the operation.
  17069. </summary>
  17070. </member>
  17071. <member name="P:Cognex.VisionPro3D.Cog3DCameraCalibrationProgressEventArgs.CancelRequested">
  17072. <summary>
  17073. Gets whether it is requested to cancel the operation.
  17074. </summary>
  17075. <value>
  17076. True if cancel is requested; False Otherwise
  17077. </value>
  17078. </member>
  17079. <member name="P:Cognex.VisionPro3D.Cog3DCameraCalibrationProgressEventArgs.Message">
  17080. <summary>
  17081. Gets the message string.
  17082. </summary>
  17083. <value>
  17084. A string describing the progress.
  17085. </value>
  17086. </member>
  17087. <member name="P:Cognex.VisionPro3D.Cog3DCameraCalibrationProgressEventArgs.Progress">
  17088. <summary>
  17089. Gets the progress (the fraction of completion).
  17090. </summary>
  17091. <value>
  17092. The progress.
  17093. </value>
  17094. </member>
  17095. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrationProgressEventArgs.Finalize">
  17096. <inheritdoc cref="!:ICog3DBase::FinalizerForThisClass" />
  17097. </member>
  17098. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrationProgressEventArgs.Dispose">
  17099. <inheritdoc cref="!:ICog3DBase::DestructorForThisClass" />
  17100. </member>
  17101. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrationProgressEventArgs.#ctor(System.Double,System.String)">
  17102. <summary>
  17103. Construct this Cog3DCameraCalibrationProgressEventArgs using the
  17104. specified progress and message.
  17105. </summary>
  17106. <param name="progress">
  17107. The progress (the fraction of completion).
  17108. </param>
  17109. <param name="message">
  17110. A string describing the progress.
  17111. </param>
  17112. </member>
  17113. <member name="T:Cognex.VisionPro3D.Cog3DCameraCalibrationProgressEventArgs">
  17114. <summary>
  17115. This class holds data provided by the camera calibration progress
  17116. event. The camera calibration progress event fires periodically during camera calibration.
  17117. A progress value of 1.0 means 100% complete.
  17118. </summary>
  17119. </member>
  17120. <member name="M:Cognex.VisionPro3D.Cog3DCheckerboardFeatureExtractor.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  17121. <inheritdoc cref="!:ICog3DBase::SerializationConstructor" />
  17122. </member>
  17123. <member name="M:Cognex.VisionPro3D.Cog3DCheckerboardFeatureExtractor.Execute(Cognex.VisionPro.ICogImage)">
  17124. <summary>
  17125. Extracts features from a Cognex checkerboard calibration plate image.
  17126. The fiducial defining the calibration plate's
  17127. origin, must be within the field of view or an exception is thrown.
  17128. </summary>
  17129. <param name="image">
  17130. The calibration image of the Cognex checkerboard calibration plate.
  17131. </param>
  17132. <returns>
  17133. The extracted feature correspondences and their weights.
  17134. </returns>
  17135. <exception cref="T:System.ArgumentNullException">
  17136. If the input argument is null.
  17137. </exception>
  17138. <exception cref="T:System.Exception">
  17139. If the expected origin fiducial feature could not be found.
  17140. </exception>
  17141. </member>
  17142. <member name="P:Cognex.VisionPro3D.Cog3DCheckerboardFeatureExtractor.IsThreadSafe">
  17143. <inheritdoc />
  17144. </member>
  17145. <member name="P:Cognex.VisionPro3D.Cog3DCheckerboardFeatureExtractor.DataMatrixTimeoutEnabled">
  17146. <summary>
  17147. If True, use the
  17148. <see cref="!:P:Cognex.VisionPro3D.Cog3DCheckerboardFeatureExtractor.DataMatrixTimeout" />
  17149. value when
  17150. <see cref="!:P:Cognex.VisionPro3D.Cog3DCheckerboardFeatureExtractor.LabelMode" />
  17151. is either
  17152. <see cref="!:T:Cognex.VisionPro3D.Cog3DCheckerboardFeatureExtractorLabelModeConstants">DataMatrix</see>
  17153. or
  17154. <see cref="!:T:Cognex.VisionPro3D.Cog3DCheckerboardFeatureExtractorLabelModeConstants">DataMatrixWithGridPitch</see>.
  17155. </summary>
  17156. <value>
  17157. The default value is False.
  17158. </value>
  17159. </member>
  17160. <member name="P:Cognex.VisionPro3D.Cog3DCheckerboardFeatureExtractor.DataMatrixTimeout">
  17161. <summary>
  17162. The maximum time in milliseconds to search for a single
  17163. DataMatrix fiducial.
  17164. </summary>
  17165. <remarks>
  17166. <para>
  17167. This property is only used when
  17168. <see cref="!:P:Cognex.VisionPro3D.Cog3DCheckerboardFeatureExtractor.DataMatrixTimeoutEnabled" />
  17169. is true and
  17170. <see cref="!:P:Cognex.VisionPro3D.Cog3DCheckerboardFeatureExtractor.LabelMode" />
  17171. is either
  17172. <see cref="!:T:Cognex.VisionPro3D.Cog3DCheckerboardFeatureExtractorLabelModeConstants">UseDataMatrix</see>
  17173. or
  17174. <see cref="!:T:Cognex.VisionPro3D.Cog3DCheckerboardFeatureExtractorLabelModeConstants">UseDataMatrixWithGridPitch</see>:
  17175. </para>
  17176. <para>
  17177. <list type="bullet">
  17178. <item>
  17179. If
  17180. <see cref="!:P:Cognex.VisionPro3D.Cog3DCheckerboardFeatureExtractor.Algorithm" />
  17181. is
  17182. <see cref="!:T:Cognex.VisionPro3D.Cog3DCheckerboardFeatureExtractorAlgorithmConstants">Exhaustive</see>,
  17183. an exception will occur if it takes longer than
  17184. <see cref="!:P:Cognex.VisionPro3D.Cog3DCheckerboardFeatureExtractor.DataMatrixTimeout" />
  17185. to find an acceptable DataMatrix fiducial.
  17186. </item>
  17187. <item>
  17188. If
  17189. <see cref="!:P:Cognex.VisionPro3D.Cog3DCheckerboardFeatureExtractor.Algorithm" />
  17190. is
  17191. <see cref="!:T:Cognex.VisionPro3D.Cog3DCheckerboardFeatureExtractorAlgorithmConstants">ExhaustiveMultiRegion</see>,
  17192. an exception will occur if it takes longer than
  17193. <see cref="!:P:Cognex.VisionPro3D.Cog3DCheckerboardFeatureExtractor.DataMatrixTimeout" />
  17194. to find the first acceptable DataMatrix fiducial. Once the operator
  17195. finds the first acceptable DataMatrix fiducial without timeout, the
  17196. operator processes each isolated region of checkerboard features. For
  17197. each isolated region of checkerboard features, if it takes longer than
  17198. <see cref="!:P:Cognex.VisionPro3D.Cog3DCheckerboardFeatureExtractor.DataMatrixTimeout" />
  17199. to find a DataMatrix fiducial, the operator will not include any
  17200. features from that region but no exception will be thrown.
  17201. </item>
  17202. </list>
  17203. </para>
  17204. </remarks>
  17205. <value>
  17206. The default value is 30000 (i.e. 30 seconds).
  17207. </value>
  17208. <exception cref="T:System.ArgumentException">
  17209. If the supplied value is less than or equal to zero.
  17210. </exception>
  17211. </member>
  17212. <member name="P:Cognex.VisionPro3D.Cog3DCheckerboardFeatureExtractor.Algorithm">
  17213. <summary>
  17214. Gets/sets the algorithm to be used for feature finding.
  17215. </summary>
  17216. <value>
  17217. The default is
  17218. <see cref="!:T:Cognex.VisionPro3D.Cog3DCheckerboardFeatureExtractorAlgorithmConstants">
  17219. Exhaustive</see>.
  17220. </value>
  17221. </member>
  17222. <member name="P:Cognex.VisionPro3D.Cog3DCheckerboardFeatureExtractor.LabelMode">
  17223. <summary>
  17224. Gets/sets the style of fiducial mark to be found on the
  17225. Cognex calibration plate.
  17226. </summary>
  17227. <value>
  17228. The default is
  17229. <see cref="!:T:Cognex.VisionPro3D.Cog3DCheckerboardFeatureExtractorLabelModeConstants">
  17230. UseFiducial</see>.
  17231. </value>
  17232. </member>
  17233. <member name="P:Cognex.VisionPro3D.Cog3DCheckerboardFeatureExtractor.PhysGridPitch">
  17234. <summary>
  17235. Gets/sets the physical grid pitch of the Cognex checkerboard
  17236. calibration plate.
  17237. </summary>
  17238. <value>
  17239. The physical grid pitch of the Cognex checkerboard calibration plate.
  17240. </value>
  17241. </member>
  17242. <member name="M:Cognex.VisionPro3D.Cog3DCheckerboardFeatureExtractor.#ctor(Cognex.VisionPro3D.Cog3DCheckerboardFeatureExtractor)">
  17243. <inheritdoc cref="!:ICog3DBase::DeepCopyConstructorForThisClass" />
  17244. </member>
  17245. <member name="M:Cognex.VisionPro3D.Cog3DCheckerboardFeatureExtractor.#ctor(Cognex.VisionPro3D.Cog3DVect2)">
  17246. <summary>
  17247. Construct this Cog3DCheckerboardFeatureExtractor using the specified
  17248. grid pitch.
  17249. </summary>
  17250. <param name="initialGridPitch">
  17251. The initial grid pitch for the calibration plate.
  17252. </param>
  17253. </member>
  17254. <member name="T:Cognex.VisionPro3D.Cog3DCheckerboardFeatureExtractor">
  17255. <summary>
  17256. This class defines a Cognex checkerboard calibration feature extractor.
  17257. This extractor extracts the calibration features from an image of a Cognex
  17258. checkerboard calibration plate.
  17259. </summary>
  17260. </member>
  17261. <member name="T:Cognex.VisionPro3D.Cog3DCheckerboardFeatureExtractorAlgorithmConstants">
  17262. <summary>
  17263. Enumeration that specifies the algorithm used in feature extraction.
  17264. </summary>
  17265. </member>
  17266. <member name="F:Cognex.VisionPro3D.Cog3DCheckerboardFeatureExtractorAlgorithmConstants.ExhaustiveMultiRegion">
  17267. <summary>
  17268. Similar to Exhaustive, but it returns feature correspondences from
  17269. all contiguous regions of checkerboard features in which a
  17270. DataMatrix was successfully decoded.
  17271. </summary>
  17272. </member>
  17273. <member name="F:Cognex.VisionPro3D.Cog3DCheckerboardFeatureExtractorAlgorithmConstants.Exhaustive">
  17274. <summary>
  17275. An exhaustive algorithm used for registering and labeling the
  17276. features.
  17277. </summary>
  17278. </member>
  17279. <member name="F:Cognex.VisionPro3D.Cog3DCheckerboardFeatureExtractorAlgorithmConstants.Standard">
  17280. <summary>
  17281. The standard algorithm used for registering and labeling the
  17282. features. This algorithm is fast and works well on clean
  17283. images but may fail on images better handled by Exhaustive mode.
  17284. </summary>
  17285. </member>
  17286. <member name="T:Cognex.VisionPro3D.Cog3DCheckerboardFeatureExtractorLabelModeConstants">
  17287. <summary>
  17288. Enumeration that specifies what style of fiducial mark
  17289. is present on the calibration plate.
  17290. </summary>
  17291. </member>
  17292. <member name="F:Cognex.VisionPro3D.Cog3DCheckerboardFeatureExtractorLabelModeConstants.UseDataMatrixWithGridPitch">
  17293. <summary>
  17294. The calibration plate has DataMatrix fiducial marks
  17295. that incorporate specification of the grid pitch.
  17296. </summary>
  17297. </member>
  17298. <member name="F:Cognex.VisionPro3D.Cog3DCheckerboardFeatureExtractorLabelModeConstants.UseDataMatrix">
  17299. <summary>
  17300. The calibration plate has DataMatrix fiducial marks.
  17301. </summary>
  17302. </member>
  17303. <member name="F:Cognex.VisionPro3D.Cog3DCheckerboardFeatureExtractorLabelModeConstants.UseFiducial">
  17304. <summary>
  17305. The calibration plate has a Cognex standard fiducial mark: two
  17306. rectangles of different lengths arranged in an 'L' shape.
  17307. </summary>
  17308. </member>
  17309. <member name="F:Cognex.VisionPro3D.Cog3DCheckerboardFeatureExtractorLabelModeConstants.None">
  17310. <summary>
  17311. The origin of the coordinate system is set at the vertex closest to
  17312. the center of the image. The X axis is set to be the direction
  17313. of a row or column of vertices along which X components of image
  17314. coordinates of vertices increase faster.
  17315. </summary>
  17316. </member>
  17317. <member name="M:Cognex.VisionPro3D.Cog3DCalibrationFeatureExtractorBase.OnFeaturesExtracted(System.Int32,System.Int32,Cognex.VisionPro3D.Cog3DCrspFeaturesCollection)">
  17318. <summary>
  17319. Method to support feature extraction progress event.
  17320. </summary>
  17321. <returns>
  17322. False if user requires to cancel the operation, and true otherwise.
  17323. </returns>
  17324. </member>
  17325. <member name="M:Cognex.VisionPro3D.Cog3DCalibrationFeatureExtractorBase.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  17326. <inheritdoc cref="!:ICog3DBase::SerializationConstructor" />
  17327. </member>
  17328. <member name="M:Cognex.VisionPro3D.Cog3DCalibrationFeatureExtractorBase.Execute(System.Collections.Generic.List`1{System.Collections.Generic.List`1{Cognex.VisionPro.ICogImage}})">
  17329. <summary>
  17330. Extract features from a set of calibration images, acquired
  17331. from one or multiple cameras over different calibration plate poses.
  17332. The images are organized in a List, indexed by calibration plate pose.
  17333. Each item in the list is a List of images, indexed by camera.
  17334. It is expected that the fiducial defining the calibration plate's
  17335. origin is within the field of view.
  17336. The feature extraction is done by calling the Execute( ICogImage )
  17337. method for each calibration image.
  17338. The Execute( ICogImage ) method will be invoked on multiple threads
  17339. if the IsThreadSafe property is true.
  17340. The FeaturesExtracted event is fired after the featues are extracted from each image.
  17341. </summary>
  17342. <param name="images">
  17343. A doubly indexed list of the calibration images, indexed first by calibration plate pose,
  17344. then by camera.
  17345. </param>
  17346. <returns>
  17347. The extracted feature correspondences and their weights.
  17348. The feature correspondences are arranged the same way as the calibration images.
  17349. </returns>
  17350. <exception cref="T:Cognex.VisionPro3D.Cog3DOperationCancelledByUserException">
  17351. If the operation is cancelled by user via the event handler.
  17352. </exception>
  17353. <exception cref="T:Cognex.VisionPro3D.Cog3DException">
  17354. If feature extraction for one image failed.
  17355. </exception>
  17356. </member>
  17357. <member name="P:Cognex.VisionPro3D.Cog3DCalibrationFeatureExtractorBase.IsThreadSafe">
  17358. <inheritdoc />
  17359. </member>
  17360. <member name="M:Cognex.VisionPro3D.Cog3DCalibrationFeatureExtractorBase.Execute(Cognex.VisionPro.ICogImage)">
  17361. <inheritdoc />
  17362. </member>
  17363. <member name="E:Cognex.VisionPro3D.Cog3DCalibrationFeatureExtractorBase.FeaturesExtracted">
  17364. <summary>
  17365. Feature extraction progress event.
  17366. </summary>
  17367. </member>
  17368. <member name="M:Cognex.VisionPro3D.Cog3DCalibrationFeatureExtractorBase.#ctor">
  17369. <summary>
  17370. Default constructor.
  17371. </summary>
  17372. </member>
  17373. <member name="T:Cognex.VisionPro3D.Cog3DCalibrationFeatureExtractorBase">
  17374. <summary>
  17375. This class is the abstract base class for 3D calibration feature extractors.
  17376. <para>
  17377. Clients that are using a Cognex checkerboard calibration plate can use the Cog3DCheckerboardFeatureExtractor class
  17378. to perform calibration feature extraction. These clients do not need to be concerned with this base class.
  17379. </para><para>
  17380. Clients that are not using a Cognex checkerboard calibration plate must implement their own calibration feature
  17381. extractor class capable of extracting calibration features from images of the special calibration object.
  17382. One way to implement such a custom calibration feature extractor class, is to derive the custom calibration
  17383. feature extraction class from this base class.
  17384. The derived calibration feature extraction class can then be passed into the Cog3DCameraCalibrator.Execute() overloads that
  17385. require an ICog3DCalibrationFeatureExtractor.
  17386. </para><para>
  17387. This abstract base class provides an implementation of
  17388. the ICog3DCalibrationFeatureExtractor.Execute(List&lt; List&lt; ICogImage &gt; &gt;) method.
  17389. This implementation calls derived class' ICog3DCalibrationFeatureExtractor.Execute( ICogImage ) and
  17390. will make the calls on multiple threads if the derived class' ICog3DCalibrationFeatureExtractor.IsThreadSave property is true.
  17391. The provided implementation supports feature extraction progress events as well - the FeaturesExtracted event is fired
  17392. as soon as feature extraction is completed on each calibration image.
  17393. </para><para>
  17394. Derived classes must: implement an override of the
  17395. ICog3DCalibrationFeatureExtractor.Execute( ICogImage ) method as well as implement
  17396. the IsThreadSafe property which specifies whether the override of Execute() is thread-safe or not.
  17397. </para></summary>
  17398. </member>
  17399. <member name="T:Cognex.VisionPro3D.Cog3DFeaturesExtractedEventHandler">
  17400. <summary>
  17401. This is the delegate of features Extracted progress event handler.
  17402. </summary>
  17403. </member>
  17404. <member name="M:Cognex.VisionPro3D.Cog3DFeaturesExtractedEventArgs.RequestCancel">
  17405. <summary>
  17406. Request to cancel the operation.
  17407. </summary>
  17408. </member>
  17409. <member name="P:Cognex.VisionPro3D.Cog3DFeaturesExtractedEventArgs.CancelRequested">
  17410. <summary>
  17411. Gets whether it is requested to cancel the operation.
  17412. </summary>
  17413. <value>
  17414. True if cancel is requested; False Otherwise
  17415. </value>
  17416. </member>
  17417. <member name="P:Cognex.VisionPro3D.Cog3DFeaturesExtractedEventArgs.Features">
  17418. <summary>
  17419. Gets the features that have been extracted.
  17420. </summary>
  17421. <value>
  17422. The features that have been extracted.
  17423. </value>
  17424. <remarks>
  17425. The features are NOT deep copy from the feature extraction, and modifying
  17426. them may result in unexpected behavior.
  17427. </remarks>
  17428. </member>
  17429. <member name="P:Cognex.VisionPro3D.Cog3DFeaturesExtractedEventArgs.CameraIndex">
  17430. <summary>
  17431. Gets the camera index of the image whose calibration features have been extracted.
  17432. </summary>
  17433. <value>
  17434. The camera index of the image whose calibration features have been extracted.
  17435. </value>
  17436. </member>
  17437. <member name="P:Cognex.VisionPro3D.Cog3DFeaturesExtractedEventArgs.PoseIndex">
  17438. <summary>
  17439. Gets the calibration plate pose index of the image whose calibration features have been extracted.
  17440. </summary>
  17441. <value>
  17442. The calibration plate pose index of the image whose calibration features have been extracted.
  17443. </value>
  17444. </member>
  17445. <member name="M:Cognex.VisionPro3D.Cog3DFeaturesExtractedEventArgs.Finalize">
  17446. <inheritdoc cref="!:ICog3DBase::FinalizerForThisClass" />
  17447. </member>
  17448. <member name="M:Cognex.VisionPro3D.Cog3DFeaturesExtractedEventArgs.Dispose">
  17449. <inheritdoc cref="!:ICog3DBase::DestructorForThisClass" />
  17450. </member>
  17451. <member name="M:Cognex.VisionPro3D.Cog3DFeaturesExtractedEventArgs.#ctor(System.Int32,System.Int32,Cognex.VisionPro3D.Cog3DCrspFeaturesCollection)">
  17452. <summary>
  17453. Construct this Cog3DFeaturesExtractedEventArgs using the providing
  17454. information for an image whose calibration features have been extracted.
  17455. </summary>
  17456. <param name="platePoseIndex">
  17457. The calibration plate pose index for the processed image.
  17458. </param>
  17459. <param name="camIndex">
  17460. The camera index for the processed image.
  17461. </param>
  17462. <param name="features">
  17463. The collection of feature correspondences for the processed image.
  17464. Property Features will return <paramref name="features" /></param>
  17465. </member>
  17466. <member name="T:Cognex.VisionPro3D.Cog3DFeaturesExtractedEventArgs">
  17467. <summary>
  17468. This class holds data provided by Cog3DCalibrationFeatureExtractorBase.FeaturesExtracted event.
  17469. FeaturesExtracted event fires each time processing of an image has finished.
  17470. </summary>
  17471. </member>
  17472. <member name="P:Cognex.VisionPro3D.ICog3DCalibrationFeatureExtractor.IsThreadSafe">
  17473. <summary>
  17474. Gets whether the implementation of the Execute(ICogImage) method is thread-safe.
  17475. thread-safety is required to allow multithreading within implementations
  17476. of the
  17477. Execute(List&lt; List&lt; ICogImage &gt; &gt;) method.
  17478. </summary>
  17479. <value>
  17480. Whether the implementation of the Execute(ICogImage) method is thread-safe.
  17481. </value>
  17482. </member>
  17483. <member name="M:Cognex.VisionPro3D.ICog3DCalibrationFeatureExtractor.Execute(System.Collections.Generic.List`1{System.Collections.Generic.List`1{Cognex.VisionPro.ICogImage}})">
  17484. <summary>
  17485. Extract features from a set of calibration images, acquired
  17486. from one or multiple cameras over different calibration plate poses.
  17487. The images are organized in a List, indexed by calibration plate pose.
  17488. Each item in the list is a List of images, indexed by camera.
  17489. It is expected that the fiducial defining the calibration plate's
  17490. origin is within the field of view.
  17491. The feature extraction is done by calling the Execute( ICogImage )
  17492. method for each calibration image.
  17493. The Execute( ICogImage ) method will be invoked on multiple threads
  17494. if the IsThreadSafe property is true.
  17495. </summary>
  17496. <param name="images">
  17497. A doubly indexed list of the calibration images, indexed first by calibration plate pose,
  17498. then by camera.
  17499. </param>
  17500. <returns>
  17501. The extracted feature correspondences and their weights.
  17502. The feature correspondences are arranged the same way as the calibration images.
  17503. </returns>
  17504. <exception cref="T:System.ArgumentNullException">
  17505. If the input argument is null.
  17506. </exception>
  17507. </member>
  17508. <member name="M:Cognex.VisionPro3D.ICog3DCalibrationFeatureExtractor.Execute(Cognex.VisionPro.ICogImage)">
  17509. <summary>
  17510. Extract features from a calibration image.
  17511. </summary>
  17512. <param name="image">
  17513. The calibration image to extract features from.
  17514. </param>
  17515. <returns>
  17516. The extracted feature correspondences and their weights.
  17517. </returns>
  17518. <exception cref="T:System.ArgumentNullException">
  17519. If the input argument is null.
  17520. </exception>
  17521. </member>
  17522. <member name="T:Cognex.VisionPro3D.ICog3DCalibrationFeatureExtractor">
  17523. <summary>
  17524. This is the interface class for 3D calibration feature extractors.
  17525. This interface class is used in several Cog3DCameraCalibrator.Execute() overloads.
  17526. </summary>
  17527. </member>
  17528. <member name="M:Cognex.VisionPro3D.Cog3DCrspFeaturesCollection.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  17529. <inheritdoc cref="!:ICog3DBase::GetObjectData" />
  17530. </member>
  17531. <member name="M:Cognex.VisionPro3D.Cog3DCrspFeaturesCollection.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  17532. <inheritdoc cref="!:ICog3DBase::SerializationConstructor" />
  17533. </member>
  17534. <member name="P:Cognex.VisionPro3D.Cog3DCrspFeaturesCollection.Weights">
  17535. <summary>
  17536. Gets/sets the collection of weights.
  17537. </summary>
  17538. <value>
  17539. A collection of weights.
  17540. </value>
  17541. <remarks>
  17542. Null value means that all the points have equal weight of 1.0.
  17543. </remarks>
  17544. </member>
  17545. <member name="P:Cognex.VisionPro3D.Cog3DCrspFeaturesCollection.PointsRaw2D">
  17546. <summary>
  17547. Gets/sets the collection of 2D feature points.
  17548. </summary>
  17549. <value>
  17550. A collection of 2D feature points.
  17551. </value>
  17552. <exception cref="T:System.ArgumentNullException">
  17553. If the input argument of the setter is null.
  17554. </exception>
  17555. </member>
  17556. <member name="P:Cognex.VisionPro3D.Cog3DCrspFeaturesCollection.PointsModel3D">
  17557. <summary>
  17558. Gets/sets the collection of 3D model points.
  17559. </summary>
  17560. <value>
  17561. A collection of 3D model points.
  17562. </value>
  17563. <exception cref="T:System.ArgumentNullException">
  17564. If the input argument of the setter is null.
  17565. </exception>
  17566. </member>
  17567. <member name="M:Cognex.VisionPro3D.Cog3DCrspFeaturesCollection.Finalize">
  17568. <inheritdoc cref="!:ICog3DBase::FinalizerForThisClass" />
  17569. </member>
  17570. <member name="M:Cognex.VisionPro3D.Cog3DCrspFeaturesCollection.Dispose">
  17571. <inheritdoc cref="!:ICog3DBase::DestructorForThisClass" />
  17572. </member>
  17573. <member name="M:Cognex.VisionPro3D.Cog3DCrspFeaturesCollection.#ctor(Cognex.VisionPro3D.Cog3DCrspFeaturesCollection)">
  17574. <inheritdoc cref="!:ICog3DBase::DeepCopyConstructorForThisClass" />
  17575. </member>
  17576. <member name="M:Cognex.VisionPro3D.Cog3DCrspFeaturesCollection.#ctor(Cognex.VisionPro3D.Cog3DVect3Collection,Cognex.VisionPro3D.Cog3DVect2Collection,Cognex.VisionPro3D.Cog3DScalarCollection)">
  17577. <summary>
  17578. Construct this Cog3DCrspFeaturesCollection with the supplied components.
  17579. </summary>
  17580. <param name="pointsModel3D">
  17581. The collection of 3D model points. May not be null.
  17582. </param>
  17583. <param name="pointsRaw2D">
  17584. The collection of 2D feature points. May not be null.
  17585. </param>
  17586. <param name="weights">
  17587. The collection of weights. Note that if <paramref name="weights" /> is null,
  17588. it means that all the points have equal weight of 1.0.
  17589. </param>
  17590. <exception cref="T:System.ArgumentNullException">
  17591. If <paramref name="pointsModel3D" /> or <paramref name="pointsRaw2D" /> is null.
  17592. </exception>
  17593. </member>
  17594. <member name="M:Cognex.VisionPro3D.Cog3DCrspFeaturesCollection.#ctor">
  17595. <summary>
  17596. Construct this default (empty) Cog3DCrspFeaturesCollection.
  17597. The PointsModel3D collection is empty.
  17598. The PointsRaw2D collection is empty.
  17599. The Weights collection is null.
  17600. </summary>
  17601. </member>
  17602. <member name="T:Cognex.VisionPro3D.Cog3DCrspFeaturesCollection">
  17603. <summary>
  17604. This class holds 3 collections: a collection of 3D model points,
  17605. a collection of 2D image feature points, and a collection of weights.
  17606. The elements of the 3 collections are corresponded. This means the
  17607. jth element of the 3D model point collection, corresponds to the
  17608. jth element of the 2D image feature point collection, which in turn corresponds to the
  17609. jth element of the weights collection.
  17610. <para>
  17611. Note that many functions that accept a Cog3DCrspFeaturesCollection as an argument,
  17612. allow the weights collection to be null.
  17613. </para></summary>
  17614. </member>
  17615. </members>
  17616. </doc>