Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
XRD
darfix
Commits
b3f9a797
Commit
b3f9a797
authored
Jul 05, 2021
by
Julia Garriga Ferrer
Browse files
[core][imageregistration] Change docstring for improve_linear_shift
parent
8283ae8c
Changes
1
Hide whitespace changes
Inline
Side-by-side
darfix/core/imageRegistration.py
View file @
b3f9a797
...
...
@@ -171,16 +171,13 @@ def normalize(x):
def
improve_linear_shift
(
data
,
v
,
h
,
epsilon
,
steps
,
nimages
=
None
,
shift_approach
=
"linear"
):
"""
Function to find the best shift between the images. It loops ``
h_max * h_
step`` times,
Function to find the best shift between the images. It loops ``step
s
`` times,
applying a different shift each, and trying to find the one that has the best result.
:param array_like data: The stack of images.
:param 2-dimensional array_like v: The vector with the direction of the shift.
:param number h_max: The maximum value that h can achieve, being h the shift between
images divided by the vector v (i.e the coordinates of the shift in base v).
:param number h_step: Spacing between the ``h`` tried. For any `` shift = h * v * idx``,
where ``idx`` is the index of the image to apply the shift to, this is the distance
between two adjacent values of h.
:param float epsilon: Maximum value of h
:param int steps: Number of different tries of h.
:param int nimages: The number of images to be used to find the best shift. It has to
be smaller or equal as the length of the data. If it is smaller, the images used
are chosen using `numpy.random.choice`, without replacement.
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment