Merge branch 'feat/182-improve-example-files-handling-in-examples-scr…

…ipts' of https://github.com/ansys/pyansys-sound into feat/182-improve-example-files-handling-in-examples-scripts

doc/changelog.d/184.added.md

@@ -0,0 +1 @@
+feat: source harmonics for sound composer

doc/changelog.d/186.added.md

@@ -0,0 +1 @@
+feat: source harmonics 2 parameters for sound composer

doc/changelog.d/190.added.md

@@ -0,0 +1 @@
+feat: filter class for sound composer (and other things)

doc/changelog.d/191.added.md

@@ -0,0 +1 @@
+feat: Sound Composer track

doc/changelog.d/192.dependencies.md

@@ -0,0 +1 @@
+build: bump matplotlib from 3.9.3 to 3.10.0

doc/source/api/index.rst

@@ -9,6 +9,7 @@ This section describes how to use Python to interact programmatically with PyAns
     :maxdepth: 2
 
     signal_utilities
+    signal_processing
     spectral_processing
     spectrogram_processing
     sound_composer

doc/source/api/signal_processing.rst

@@ -0,0 +1,9 @@
+Signal processing
+-----------------
+
+.. module:: ansys.sound.core.signal_processing
+
+.. autosummary::
+    :toctree: _autosummary
+
+    Filter

doc/source/api/sound_composer.rst

@@ -6,9 +6,12 @@ Sound composer
 .. autosummary::
     :toctree: _autosummary
 
+    Track
     SourceSpectrum
     SourceBroadbandNoise
     SourceBroadbandNoiseTwoParameters
+    SourceHarmonics
+    SourceHarmonicsTwoParameters
     SourceAudio
     SourceControlSpectrum
     SourceControlTime

pyproject.toml

@@ -30,7 +30,7 @@ dependencies = [
 [project.optional-dependencies]
 tests = [
     "ansys-dpf-core==0.13.3",
-    "matplotlib==3.9.3",
+    "matplotlib==3.10.0",
 
     "pytest==8.3.4",
     "pytest-cov==6.0.0",

src/ansys/sound/core/signal_processing/__init__.py

@@ -0,0 +1,30 @@
+# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+"""Signal processing classes.
+
+Helper functions related to signal processing.
+"""
+from ._signal_processing_parent import SignalProcessingParent
+from .filter import Filter
+
+__all__ = ("SignalProcessingParent", "Filter")

src/ansys/sound/core/signal_processing/_signal_processing_parent.py

@@ -0,0 +1,32 @@
+# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+"""SignalProcessingParent."""
+from .._pyansys_sound import PyAnsysSound
+
+
+class SignalProcessingParent(PyAnsysSound):
+    """
+    Provides the base class for signal processing classes.
+
+    This is the base class of all signal processing classes and should not be used directly.
+    """