Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: Added how to override silx.opencl.sift parameters #4107

Merged
merged 2 commits into from
Apr 12, 2024
Merged

Documentation: Added how to override silx.opencl.sift parameters #4107

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1cc4586
add documentation on how to override the sift parameters
ChannyClaus Apr 10, 2024
2091b45
typo fix
ChannyClaus Apr 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion doc/source/description/sift.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,16 @@ The file ``param.py`` in the source folder contains SIFT default parameters,
recommended by David Lowe in his paper_ or by the authors of the C++ version in ASIFT_.
The user should not modify these values unless one is an advanced SIFT-user.
Some parameters require the understanding of several aspects of the algorithm,
explained in Lowe's original paper.
explained in Lowe's original paper. For advanced users who wish to override these
parameters, you can do it by overwriting the values of the parameter dictionary
as follows:

.. code-block:: python

import silx.opencl.sift.param

silx.opencl.sift.param.par["MatchRatio"] = 0.5


.. _ASIFT: http://www.ipol.im/pub/art/2011/my-asift

Expand Down
Loading