From 6c57fc33ad8fe18bbb342eabfa99baa4f20ed51a Mon Sep 17 00:00:00 2001 From: mrava87 Date: Sat, 18 May 2024 20:59:39 +0300 Subject: [PATCH] minor: added versionadded to docstrings --- pylops/signalprocessing/patch2d.py | 2 ++ pylops/signalprocessing/patch3d.py | 2 ++ pylops/signalprocessing/sliding1d.py | 2 ++ pylops/signalprocessing/sliding2d.py | 2 ++ pylops/signalprocessing/sliding3d.py | 2 ++ 5 files changed, 10 insertions(+) diff --git a/pylops/signalprocessing/patch2d.py b/pylops/signalprocessing/patch2d.py index e60fd807..1a352303 100644 --- a/pylops/signalprocessing/patch2d.py +++ b/pylops/signalprocessing/patch2d.py @@ -142,6 +142,8 @@ class Patch2D(LinearOperator): tapertype : :obj:`str`, optional Type of taper (``hanning``, ``cosine``, ``cosinesquare`` or ``None``) savetaper: :obj:`bool`, optional + .. versionadded:: 2.3.0 + Save all tapers and apply them in one go (``True``) or save unique tapers and apply them one by one (``False``). The first option is more computationally efficient, whilst the second is more memory efficient. scalings : :obj:`tuple` or :obj:`list`, optional diff --git a/pylops/signalprocessing/patch3d.py b/pylops/signalprocessing/patch3d.py index 7a893b54..7b969984 100644 --- a/pylops/signalprocessing/patch3d.py +++ b/pylops/signalprocessing/patch3d.py @@ -157,6 +157,8 @@ class Patch3D(LinearOperator): tapertype : :obj:`str`, optional Type of taper (``hanning``, ``cosine``, ``cosinesquare`` or ``None``) savetaper: :obj:`bool`, optional + .. versionadded:: 2.3.0 + Save all tapers and apply them in one go (``True``) or save unique tapers and apply them one by one (``False``). The first option is more computationally efficient, whilst the second is more memory efficient. scalings : :obj:`tuple` or :obj:`list`, optional diff --git a/pylops/signalprocessing/sliding1d.py b/pylops/signalprocessing/sliding1d.py index 6e0fb26b..767045d1 100644 --- a/pylops/signalprocessing/sliding1d.py +++ b/pylops/signalprocessing/sliding1d.py @@ -128,6 +128,8 @@ class Sliding1D(LinearOperator): tapertype : :obj:`str`, optional Type of taper (``hanning``, ``cosine``, ``cosinesquare`` or ``None``) savetaper: :obj:`bool`, optional + .. versionadded:: 2.3.0 + Save all tapers and apply them in one go (``True``) or save unique tapers and apply them one by one (``False``). The first option is more computationally efficient, whilst the second is more memory efficient. name : :obj:`str`, optional diff --git a/pylops/signalprocessing/sliding2d.py b/pylops/signalprocessing/sliding2d.py index fa930662..f3b3cfb3 100644 --- a/pylops/signalprocessing/sliding2d.py +++ b/pylops/signalprocessing/sliding2d.py @@ -164,6 +164,8 @@ class Sliding2D(LinearOperator): tapertype : :obj:`str`, optional Type of taper (``hanning``, ``cosine``, ``cosinesquare`` or ``None``) savetaper: :obj:`bool`, optional + .. versionadded:: 2.3.0 + Save all tapers and apply them in one go (``True``) or save unique tapers and apply them one by one (``False``). The first option is more computationally efficient, whilst the second is more memory efficient. name : :obj:`str`, optional diff --git a/pylops/signalprocessing/sliding3d.py b/pylops/signalprocessing/sliding3d.py index 846a678e..9dc7e255 100644 --- a/pylops/signalprocessing/sliding3d.py +++ b/pylops/signalprocessing/sliding3d.py @@ -150,6 +150,8 @@ class Sliding3D(LinearOperator): tapertype : :obj:`str`, optional Type of taper (``hanning``, ``cosine``, ``cosinesquare`` or ``None``) savetaper: :obj:`bool`, optional + .. versionadded:: 2.3.0 + Save all tapers and apply them in one go (``True``) or save unique tapers and apply them one by one (``False``). The first option is more computationally efficient, whilst the second is more memory efficient. nproc : :obj:`int`, optional