Incorporate getters and setters for points and add docs #6
Conversation
|
Also, @jywarren I've compared this branch with the |
|
That's awesome @rexagod I'm so pleased!!! |
README.md
Outdated
| {"x":84,"y":331}, ...] | ||
| ``` | ||
|
|
||
| `matching` is done with the `findMatchedPoints` function, passes a `matchesArray` to the global `utils` object's `getMatchedPoints` object property with the following format: |
There was a problem hiding this comment.
This is a little hard to follow, could you add a code example showing the function in use? Thanks!!!
There was a problem hiding this comment.
Cool! I've added code links to those functions since they were kind of lengthy. But let me know if you want me to copy them into the docs. Thanks!
There was a problem hiding this comment.
Just an example of findMatchedPoints being run and the parameters for it would be great.
|
@jywarren Up for your review. 😄 |
|
Just one request then this should be good to go! |
|
Hi, are there any updates on this? Thank you! |
|
@jywarren Have a look! |
README.md
Outdated
| ``` | ||
| It runs slower than the point `finding` step due to the added computational overhead of comparing both of the images for matches. | ||
|
|
||
| The [`findMatchedPoints`](/src/orb.core.js#L241) function depends upon the values served back into its lexical scope by the [`findPoints`](/src/orb.core.js#) function, which in turn depends upon the `params` argument (see below) supplied by the user, and is solely responsible for the generation of the [`cornersArray`](/src/orb.core.js#233), which is used to instantiate the [`matchesArray`](/src/orb.core.js#L269). The [`findMatchesPoints`](/src/orb.core.js#L241), is [called here](/src/orb.core.js#L302) and the appropriate values are set [in the cache](/src/orb.core.js#L316). |
There was a problem hiding this comment.
Oops maybe a typo on findmatchespoints here?
Also I really do think a full example here would be ideal in addition to the linked code. It just helps explain each parameter. Thanks!
There was a problem hiding this comment.
Line 244 in c3a5b8a
@jywarren The findMatchedPoints function doesn't take any values explicity, those are served to it owing to the findPoints method. The function, however, depends specifically on args.browser that's initialized all the way at the top. Do you want me to highlight this?
Line 14 in c3a5b8a
Also, every parameter has been explained in the codeflow section, along with their line addresses as well.
So do you want me to highlight the fact and maybe link a few lines about the working of findMatchedPoints (other than the text above) or modify something else? Sorry for taking your time on this PR, just wanted to be sure we are on the same page here!
Thank you!
There was a problem hiding this comment.
The findMatchedPoints function doesn't take any values explicity, those are served to it owing to the findPoints method.
Hm, why doesn't it accept two points parameters, between which it finds matches? Wouldn't that make more sense to a user? Like, it would take two points collections as inputs, and output those which are matched between? If this would take extra changes, let's do that in a follow-up PR. Can you open an issue and copy these notes in? Thanks!
The function, however, depends specifically on args.browser that's initialized all the way at the top. Do you want me to highlight this?
Yes, that doesn't seem so clear to me so it may need explaining.
So, Below is a summary of each component of the orbify instance doesn't clearly spell out that these are parameters that can be submitted in the constructor. I think it's very important to literally show verbatim how to use each of the constructors, as in this example:
That'll make it much easier for people to start using this library, or to use it in unexpected ways!
Thank you, @rexagod -- much appreciated!
Addresses #3 #4 and (in a bit) #2
cc @jywarren