DOC: interpolation

- list different methods
- be explicit about when it's applied

Author: christianbrodbeck

surfer/viz.py

@@ -1549,10 +1549,13 @@ def set_data_time_index(self, time_idx, interpolation='quadratic'):
         Parameters
         ----------
         time_idx : int | float
-            Time index. Floats will cause samples to be interpolated.
+            Time index. Non-integer values will be displayed using interpolation
+            between samples.
         interpolation : str
             Interpolation method (``scipy.interpolate.interp1d`` parameter,
-            default 'quadratic').
+            one of 'linear' | 'nearest' | 'zero' | 'slinear' | 'quadratic' |
+            'cubic', default 'quadratic'). Interpolation is only used for
+            non-integer indexes.
         """
         if self.n_times is None:
             raise RuntimeError('cannot set time index with no time data')
@@ -1956,7 +1959,8 @@ def save_image_sequence(self, time_idx, fname_pattern, use_abs_idx=True,
         Parameters
         ----------
         time_idx : array-like
-            Time indices to save.
+            Time indices to save. Non-integer values will be displayed using
+            interpolation between samples.
         fname_pattern : str
             Filename pattern, e.g. 'movie-frame_%0.4d.png'.
         use_abs_idx : boolean
@@ -1982,7 +1986,9 @@ def save_image_sequence(self, time_idx, fname_pattern, use_abs_idx=True,
             views. For ``None``, no colorbar is shown.
        interpolation : str
             Interpolation method (``scipy.interpolate.interp1d`` parameter,
-            default 'quadratic').
+            one of 'linear' | 'nearest' | 'zero' | 'slinear' | 'quadratic' |
+            'cubic', default 'quadratic'). Interpolation is only used for
+            non-integer indexes.
 
         Returns
         -------
@@ -2112,7 +2118,8 @@ def save_movie(self, fname, time_dilation=4., tmin=None, tmax=None,
             Framerate of the movie (frames per second, default 25).
         interpolation : str
             Interpolation method (``scipy.interpolate.interp1d`` parameter,
-            default 'quadratic').
+            one of 'linear' | 'nearest' | 'zero' | 'slinear' | 'quadratic' |
+            'cubic', default 'quadratic').
         codec : str
             Codec to use with ffmpeg (default 'mpeg4').