Rename kargs to kwargs

Author: gb119

Stoner/Image/attrs.py

@@ -21,9 +21,9 @@ def _draw_apaptor(func):
     """Adapt methods for DrawProxy class to bind :py:mod:`skimage.draw` functions."""
 
     @wraps(func)
-    def _proxy(self, *args, **kargs):
-        value = kargs.pop("value", np.ones(1, dtype=self._img.dtype)[0])
-        coords = func(*args, **kargs)
+    def _proxy(self, *args, **kwargs):
+        value = kwargs.pop("value", np.ones(1, dtype=self._img.dtype)[0])
+        coords = func(*args, **kwargs)
         if len(coords) == 3:
             rr, cc, vv = coords
             if len(rr) == len(cc):
@@ -58,7 +58,7 @@ class DrawProxy:
     is saved.
     """
 
-    def __init__(self, *args, **kargs):  # pylint: disable=unused-argument
+    def __init__(self, *args, **kwargs):  # pylint: disable=unused-argument
         """Grab the parent image from the constructor."""
         self._img = args[0]
         self._parent = args[1]
@@ -300,8 +300,8 @@ def __getattr__(self, name):
             raise AttributeError(f"{name} not a callable mask method.")
 
         @wraps(func)
-        def _proxy_call(*args, **kargs):
-            retval = func(self._mask.astype(float).view(type(self._imagearray)) * 1000, *args, **kargs)
+        def _proxy_call(*args, **kwargs):
+            retval = func(self._mask.astype(float).view(type(self._imagearray)) * 1000, *args, **kwargs)
             if isinstance(retval, np.ndarray) and retval.shape == self._imagearray.shape:
                 retval.normalise()
                 self._imagearray.mask = retval > 0
@@ -356,7 +356,7 @@ def invert(self):
         """Invert the mask."""
         self._imagearray.mask = ~self._imagearray.mask
 
-    def select(self, **kargs):
+    def select(self, **kwargs):
         """Interactive selection mode.
 
         This method allows the user to interactively choose a mask region on the image. It will require the
@@ -382,7 +382,7 @@ def select(self, **kargs):
 
         This method directly sets the mask and then returns a copy of the parent :py:class:`Stoner.ImageFile`.
         """
-        selection = kargs.get("_selection", [])
+        selection = kwargs.get("_selection", [])
         if len(selection) == 0:
             selector = ShapeSelect()
             self._imagearray.mask = selector(self._imagearray)

Stoner/Image/core.py

@@ -19,32 +19,32 @@
 from .core import ImageArray
 
 
-def _prep_figure(self, kargs):
-    plts = kargs.pop("plots_per_page", getattr(self, "plots_per_page", len(self)))
+def _prep_figure(self, kwargs):
+    plts = kwargs.pop("plots_per_page", getattr(self, "plots_per_page", len(self)))
     self.plots_per_page = plts
     plts = min(plts, len(self))
 
-    fig_num = kargs.pop("figure", getattr(self, "_figure", None))
+    fig_num = kwargs.pop("figure", getattr(self, "_figure", None))
     if isinstance(fig_num, Figure):
-        kargs.setdefault("figsize", tuple(fig_num.get_size_inches()))
-        kargs.setdefault("facecolor", fig_num.get_facecolor())
-        kargs.setdefault("edgecolor", fig_num.get_edgecolor())
-        kargs.setdefault("frameon", fig_num.get_frameon())
-        kargs.setdefault("FigureClass", fig_num.__class__)
+        kwargs.setdefault("figsize", tuple(fig_num.get_size_inches()))
+        kwargs.setdefault("facecolor", fig_num.get_facecolor())
+        kwargs.setdefault("edgecolor", fig_num.get_edgecolor())
+        kwargs.setdefault("frameon", fig_num.get_frameon())
+        kwargs.setdefault("FigureClass", fig_num.__class__)
         fig_num = fig_num.number
 
     fig_args = getattr(self, "_fig_args", [])
-    fig_kargs = getattr(self, "_fig_kargs", {"layout": "constrained"})
+    fig_kwargs = getattr(self, "_fig_kwargs", {"layout": "constrained"})
     for arg in ("figsize", "dpi", "facecolor", "edgecolor", "frameon", "FigureClass"):
-        if arg in kargs:
-            fig_kargs[arg] = kargs.pop(arg)
+        if arg in kwargs:
+            fig_kwargs[arg] = kwargs.pop(arg)
     if fig_num is None:
-        fig = figure(*fig_args, **fig_kargs)
+        fig = figure(*fig_args, **fig_kwargs)
     elif fig_num in get_fignums():
         fig = figure(fig_num)
     else:
-        fig = figure(fig_num, **fig_kargs)
-    kargs["figure"] = fig_num
+        fig = figure(fig_num, **fig_kwargs)
+    kwargs["figure"] = fig_num
     return fig, plts
 
 
@@ -138,7 +138,7 @@ def __getter__(self, name, instantiate=True):
             ret._title = name
         return ret
 
-    def align(self, *args, **kargs):
+    def align(self, *args, **kwargs):
         """Align each image in the folder to the reference image.
 
         Args:
@@ -184,7 +184,7 @@ def align(self, *args, **kargs):
             except (TypeError, ValueError) as err:
                 raise TypeError(f"Cannot interpret {type(ref)} as reference image data.") from err
         # Call align on each object
-        self.each.align(ref_data, **kargs)
+        self.each.align(ref_data, **kwargs)
         limits = self.metadata.slice("translation_limits", output="array")
         stack_limits = np.zeros(4)
         stack_limits[::2] = limits.max(axis=0)[::2]
@@ -195,7 +195,7 @@ def align(self, *args, **kargs):
         self.metadata["align_box"] = tuple(stack_limits.astype(int))
         return self
 
-    def apply_all(self, func, *args, **kargs):
+    def apply_all(self, func, *args, **kwargs):
         """Apply function to all images in the stack.
 
         Args:
@@ -205,10 +205,10 @@ def apply_all(self, func, *args, **kargs):
                 if False print '.' for every iteration
 
         Note:
-            Further args, kargs are passed through to the function
+            Further args, kwargs are passed through to the function
         """
         warn("apply_all is deprecated and will be removed in a future version. Use ImageFolder.each() instead")
-        return self.each(func, *args, **kargs)
+        return self.each(func, *args, **kwargs)
 
     def average(self, weights=None, _box=False, _metadata="first"):
         """Get an array of average pixel values for the stack.
@@ -256,9 +256,9 @@ def as_stack(self):
         return k
 
     @classmethod
-    def from_tiff(cls, filename, **kargs):
+    def from_tiff(cls, filename, **kwargs):
         """Create a new ImageArray from a tiff file."""
-        self = cls(**kargs)
+        self = cls(**kwargs)
         with Image.open(filename, "r") as img:
             tags = img.tag_v2
             if 270 in tags:
@@ -321,12 +321,12 @@ def mean(self, _box=False, _metadata="first"):
         """
         return self.average(_box=_box, _metadata=_metadata)
 
-    def montage(self, *args, **kargs):
+    def montage(self, *args, **kwargs):
         """Call the plot method for each metadataObject, but switching to a subplot each time.
 
         Args:
             args: Positional arguments to pass through to the :py:meth:`Stoner.plot.PlotMixin.plot` call.
-            kargs: Keyword arguments to pass through to the :py:meth:`Stoner.plot.PlotMixin.plot` call.
+            kwargs: Keyword arguments to pass through to the :py:meth:`Stoner.plot.PlotMixin.plot` call.
 
         Keyword Arguments:
             plot_extra (callable(i,j,d)):
@@ -355,36 +355,36 @@ def montage(self, *args, **kargs):
             Each plot is generated as sub-plot on a page. The number of rows and columns of subplots is computed
             from the aspect ratio of the figure and the number of files in the :py:class:`PlotFolder`.
         """
-        fig, plts = _prep_figure(self, kargs)
+        fig, plts = _prep_figure(self, kwargs)
 
-        plot_extra = kargs.pop("plot_extra", lambda i, j, d: None)
+        plot_extra = kwargs.pop("plot_extra", lambda i, j, d: None)
 
         w, h = fig.get_size_inches()
         plt_x = int(np.floor(np.sqrt(plts) * w / h))
         plt_y = int(np.ceil(plts / plt_x))
 
-        kargs["figure"] = fig
+        kwargs["figure"] = fig
         ret = []
         j = 0
         fignum = fig.number
         for i, d in enumerate(self):
-            plt_kargs = copy(kargs)
+            plt_kwargs = copy(kwargs)
             if i % plts == 0 and i != 0:
-                fig, _ = _prep_figure(self, kargs)
+                fig, _ = _prep_figure(self, kwargs)
                 fignum = fig.number
                 j = 1
             else:
                 j += 1
             fig = figure(fignum)
             ax = subplot(plt_y, plt_x, j)
-            plt_kargs["figure"] = fig
-            plt_kargs["ax"] = ax
-            if "title" in kargs:
-                if isinstance(kargs["title"], str):
-                    plt_kargs["title"] = kargs["title"].format(**d)
-                elif callable(kargs["title"]):
-                    plt_kargs["title"] = kargs["title"](d)
-            ret.append(d.imshow(*args, **plt_kargs))
+            plt_kwargs["figure"] = fig
+            plt_kwargs["ax"] = ax
+            if "title" in kwargs:
+                if isinstance(kwargs["title"], str):
+                    plt_kwargs["title"] = kwargs["title"].format(**d)
+                elif callable(kwargs["title"]):
+                    plt_kwargs["title"] = kwargs["title"](d)
+            ret.append(d.imshow(*args, **plt_kwargs))
             plot_extra(i, j, d)
         return ret
 

Stoner/Image/folders.py

@@ -52,19 +52,17 @@
 import sys
 import warnings
 
+import numpy as np
 from matplotlib import cm
 from matplotlib import pyplot as plt
 from matplotlib.colors import to_rgba
-import numpy as np
 from PIL import Image, PngImagePlugin
 from PIL.TiffImagePlugin import ImageFileDirectory_v2
 from scipy import signal
 from scipy.interpolate import griddata, interp1d
 from scipy.ndimage import gaussian_filter
 from skimage import filters, measure, transform
 
-from ..tools import isiterable, istuple, make_Data
-
 from ..compat import (  # Some things to help with Python2 and Python3 compatibility
     get_filedialog,
     string_types,
@@ -73,6 +71,7 @@
 # from .core import ImageArray
 from ..core.base import metadataObject
 from ..plot.utils import auto_fit_fontsize
+from ..tools import isiterable, istuple, make_Data
 from ..tools.decorators import changes_size, keep_return_type
 from .util import _dtype, _dtype2
 from .util import _scale as im_scale

Stoner/Image/imagefuncs.py

@@ -18,18 +18,18 @@
 AN_IM_SIZE = (554, 672)  # Kerr image with annotation not cropped
 
 
-def _load_ImageArray(f, **kargs):
+def _load_ImageArray(f, **kwargs):
     """Create and image array."""
-    kargs.pop("Img_num", None)  # REemove img_num if it exists
-    return ImageArray(f, **kargs)
+    kwargs.pop("Img_num", None)  # REemove img_num if it exists
+    return ImageArray(f, **kwargs)
 
 
 class ImageStackMixin:
     """Implement an interface for a BaseFolder to store images in a 3D numpy array for faster access."""
 
     _defaults = {"type": ImageFile}
 
-    def __init__(self, *args, **kargs):
+    def __init__(self, *args, **kwargs):
         """Initialise an ImageStack's pricate data and provide a type argument."""
         self._stack = np.ma.atleast_3d(ImageArray([])).reshape((0, 0, 0)).view(ImageArray)
         self._metadata = RegexpDict()
@@ -38,21 +38,21 @@ def __init__(self, *args, **kargs):
         self._sizes = np.array([], dtype=int).reshape(0, 2)
 
         if not args:
-            super().__init__(**kargs)
+            super().__init__(**kwargs)
             return
         other = args[0]
         if isinstance(other, ImageStackMixin):
-            super().__init__(*args[1:], **kargs)
+            super().__init__(*args[1:], **kwargs)
             self._stack = other._stack
             self._metadata = other._metadata
             self._names = other._names
             self._sizes = other._sizes
         elif isinstance(other, ImageFolder):  # ImageFolder can already init from itself
-            super().__init__(*args, **kargs)
+            super().__init__(*args, **kwargs)
         elif (
             isinstance(other, np.ndarray) and other.ndim == 3
         ):  # Initialise with 3D numpy array, first coordinate is number of images
-            super().__init__(*args[1:], **kargs)
+            super().__init__(*args[1:], **kwargs)
             self.imarray = other
             self._sizes = np.ones((other.shape[0], 2), dtype=int) * other.shape[1:]
             self._names = [f"Untitled-{d}" for d in range(other.shape[0])]
@@ -63,12 +63,12 @@ def __init__(self, *args, **kargs):
                 other = [ImageFile(i) for i in other]
             except (TypeError, ValueError, RuntimeError) as err:
                 raise ValueError("Failed to initialise ImageStack with list input") from err
-            super().__init__(*args[1:], **kargs)
+            super().__init__(*args[1:], **kwargs)
             for ot in other:
                 self.append(ot)
 
         else:
-            super().__init__(*args, **kargs)
+            super().__init__(*args, **kwargs)
 
     def __lookup__(self, name):
         """Stub for other classes to implement.
@@ -387,7 +387,7 @@ def convert(self, dtype, force_copy=False, uniform=False, normalise=True):
         self._stack.mask = mask
         return self
 
-    def asfloat(self, normalise=True, clip=False, clip_negative=False, **kargs):
+    def asfloat(self, normalise=True, clip=False, clip_negative=False, **kwargs):
         """Convert stack to floating point type.
 
         Keyword Arguments:
@@ -411,12 +411,12 @@ def asfloat(self, normalise=True, clip=False, clip_negative=False, **kargs):
             pass
         else:
             self.convert(dtype=np.float64, normalise=normalise)
-        if "clip_neg" in kargs:
+        if "clip_neg" in kwargs:
             warnings.warn(
                 "clip_neg argument renamed to clip_negative in ImageStack. This will cause an error in future"
                 + "versions of the Stoner Package."
             )
-            clip_negative = kargs.pop("clip_neg")
+            clip_negative = kwargs.pop("clip_neg")
         if clip or clip_negative:
             self.each.clip_intensity(clip_negative=clip_negative)
         return self