Skip to content
Snippets Groups Projects
Commit b353da96 authored by Wolfgang Kastaun's avatar Wolfgang Kastaun
Browse files

Fix error in docstrings (wrong shift sign definition)

parent 7d1014df
No related branches found
No related tags found
No related merge requests found
......@@ -29,7 +29,7 @@ class DynamicShiftDask:
This allows to interpolate samples in a dask array to locations specified
by a shift given by another dask array of same size. The shift is specified in
units of the array index, i.e. there is no separate coordinate array.
A negative shift refers to values left of a given sample, positive shifts
A positive shift refers to values left of a given sample, negative shifts
to values on the right.
The boundary treatment can be specified for each boundary in terms of
......@@ -80,8 +80,8 @@ class DynamicShiftDask:
The shift and sample arrays need to have the same size, and each shift provides
the interpolation location relative to the sample with the same index.
Shifts are floating point values.A shift of +1 refers to the sample on the right,
-1 the sample on the left, etc. All arrays have to be 1D.
Shifts are floating point values. A shift of +1 refers to the sample on the left,
-1 the sample on the right, etc. All arrays have to be 1D.
Arguments:
samples: 1D dask array with data samples
......
......@@ -281,6 +281,8 @@ class RegularInterpolator:
"""User-facing class for interpolation of regularly spaced data
The interpolation method is not fixed but given by an interpolation engine.
The main purpose of this class is to provide the parameter checks common
to all interpolation methods.
"""
def __init__(self, core: RegularInterpCore):
......@@ -446,7 +448,7 @@ class DynamicShiftNumpy:
This allows to interpolate samples in a numpy array to locations specified
by a shift given by another numpy array of same size. The shift is specified in
units of the array index, i.e. there is no separate coordinate array.
A negative shift refers to values left of a given sample, positive shifts
A positive shift refers to values left of a given sample, negative shifts
to values on the right.
The boundary treatment can be specified for each boundary in terms of
......@@ -496,8 +498,8 @@ class DynamicShiftNumpy:
The shift and sample arrays need to have the same size, and each shift provides
the interpolation location relative to the sample with the same index.
Shifts are floating point values.A shift of +1 refers to the sample on the right,
-1 the sample on the left, etc. All arrays have to be 1D.
Shifts are floating point values.A shift of +1 refers to the sample on the left,
-1 the sample on the right, etc. All arrays have to be 1D.
Arguments:
samples: 1D numpy array with data samples
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment