modusa 0.4.29__py3-none-any.whl → 0.4.31__py3-none-any.whl

modusa/generators/t_ax.py

@@ -1,64 +0,0 @@
-#!/usr/bin/env python3
-
-
-from modusa import excp
-from modusa.decorators import validate_args_type
-from modusa.generators.base import ModusaGenerator
-from modusa.models.t_ax import TAx
-import numpy as np
-
-class TAxGen(ModusaGenerator):
-	"""
-	Provides user friendly APIs to generate time
-	axis for signals (instances of `TAx`).
-	"""
-	
-	#--------Meta Information----------
-	_name = "TimeAxisGenerator"
-	_description = "APIs to generate time axis for signals."
-	_author_name = "Ankit Anand"
-	_author_email = "ankit0.anand0@gmail.com"
-	_created_at = "2025-07-26"
-	#----------------------------------
-		
-	@classmethod
-	def linear(cls, n_points: int, sr: int | float = 1.0, t0: int | float = 0.0, label: str = "Time (sec)") -> TAx:
-		"""
-		Create a linearly spaced time axis.
-		
-		.. code-block:: python
-
-			import modusa as ms
-			t = ms.tax.linear(n_points=100, sr=2, start=10, label="Time (sec)")
-			print(t)
-			t.print_info()
-		
-		Parameters
-		----------
-		n_points: int
-			- Number of data points for the time axis.
-		sr: int | float
-			- Sampling rate for the time axis.
-		start: int | float
-			- Start value.
-		label: str
-			- Label for the time axis.
-		
-		Returns
-		-------
-		TAx
-			An instance of TAx.
-		"""
-		
-		assert isinstance(n_points, int)
-		assert isinstance(sr, (int, float))
-		assert isinstance(t0, (int, float))
-		assert isinstance(label, str)
-		
-		sr = float(sr)
-		t0 = float(t0)
-		
-		time_ax = TAx(n_points=n_points, sr=sr, t0=t0, label=label)
-		
-		return time_ax
-	

modusa/generators/tds.py

@@ -1,267 +0,0 @@
-#!/usr/bin/env python3
-
-
-from modusa import excp
-from modusa.decorators import validate_args_type
-from .base import ModusaGenerator
-from modusa.models.tds import TDS
-from modusa.models.t_ax import TAx
-from modusa.models.data import Data
-import numpy as np
-
-class TDSGen(ModusaGenerator):
-	"""
-	Provides user friendly APIs to generate instances of different 
-	`TDS` instances.
-	"""
-	
-	#--------Meta Information----------
-	_name = "TDSGenerator"
-	_description = ""
-	_author_name = "Ankit Anand"
-	_author_email = "ankit0.anand0@gmail.com"
-	_created_at = "2025-07-27"
-	#----------------------------------
-	
-	@staticmethod
-	def from_array(
-		y: np.ndarray | list | float | int | np.generic,
-		sr: float | int = 1.0,
-		t0: float | int = 0.0,
-		y_label: str = "Y",
-		t_label: str = "Time (sec)",
-		title: str = "Time Domain Signal"
-	) -> TDS:
-		"""
-		Create `TDS` instance from basic data structures.
-
-		.. code-block:: python
-
-			import modusa as ms
-			t = ms.tds.from_array([1, 2, 3])
-			print(t)
-			t.print_info()
-		
-		Parameters
-		----------
-		y: np.ndarray | list | float | int | np.generic
-			- Data values.
-		sr: float | int
-			- Sampling rate.
-		t0: float | int
-			- Start timestamp.
-		y_label: str
-			- Y label for the signal.
-			- Default: "Y"
-		t_label: str
-			- T label for the signal.
-			- Default: "Time (sec)"
-		title: str
-			- Title for the signal.
-			- Default: "1D Signal"
-		Returns
-		-------
-		TDS
-			An instance of TDS.
-		"""
-		assert isinstance(y, (np.ndarray, list, float, int, np.generic))
-		assert isinstance(sr, (int, float)) and isinstance(t0, (int, float))
-		assert isinstance(y_label, str) and isinstance(t_label, str) and isinstance(title, str)
-		
-		if isinstance(y, (float, int, np.generic)): y = [y] # Convert to list of 1 element
-		y = np.asarray(y)
-		assert y.ndim == 1
-		
-		sr = float(sr)
-		t0 = float(t0)
-		
-		y = Data(values=y, label=y_label)
-		t = TAx(n_points=y.shape[0], sr=sr, t0=t0, label=t_label) # Creating a signal axis instance
-		
-		return TDS(y=y, t=t, title=title)
-	
-	@classmethod
-	def zeros(cls, shape, sr=1.0, t0=0.0) -> TDS:
-		"""
-		Create `TDS` instance with all zeros.
-
-		.. code-block:: python
-
-			import modusa as ms
-			y = ms.tds.zeros(10, sr=10)
-			print(y)
-			y.print_info()
-		
-		Parameters
-		----------
-		shape: int | tuple[int]
-			- Shape of the signal with zeros.
-			- Must be 1 dimensional
-			- E.g. 10 or (10, )
-		sr: float | int
-			- Sampling rate.
-		t0: float | int
-			- Start timestamp.
-		Returns
-		-------
-		TDS
-			An instance of TDS.
-		"""
-		assert isinstance(shape, (int, tuple))
-		y = np.zeros(shape)
-		
-		return cls.from_array(y=y, sr=sr, t0=t0, title="Zeros")
-	
-	@classmethod
-	def zeros_like(cls, signal, shape=None) -> TDS:
-		"""
-		Create `TDS` instance similar to `signal`
-		but with all entries being zeros.
-
-		.. code-block:: python
-
-			import modusa as ms
-			signal = ms.tds.from_array([1, 2, 3])
-			y = ms.tds.zeros_like(signal)
-			print(y)
-			x.print_info()
-		
-		Parameters
-		----------
-		signal: TDS
-			- Reference signal to create zeros like that.
-		Returns
-		-------
-		TDS
-			An instance of TDS.
-		"""
-		
-		assert isinstance(signal, TDS)
-		
-		shape = signal.shape if shape is None else shape
-		
-		return cls.from_array(y=np.zeros(shape), sr=signal.t.sr, t0=signal.t.t0, y_label=signal.y.label, t_label=signal.t.label, title=signal.title)
-	
-	
-	@classmethod
-	def ones(cls, shape, sr=1.0, t0=0.0) -> TDS:
-		"""
-		Create `TDS` instance with all ones.
-
-		.. code-block:: python
-
-			import modusa as ms
-			y = ms.tds.ones(10)
-			print(y)
-			y.print_info()
-		
-		Parameters
-		----------
-		shape: int | tuple[int]
-			- Shape of the signal with ones.
-			- Must be 1 dimensional
-			- E.g. 10 or (10, )
-		sr: float | int
-			- Sampling rate.
-		t0: float | int
-			- Start timestamp.
-		Returns
-		-------
-		TDS
-			An instance of TDS.
-		"""
-		assert isinstance(shape, (int, tuple))
-		y = np.ones(shape)
-		
-		return cls.from_array(y=y, sr=sr, t0=t0, title="Ones")
-	
-	@classmethod
-	def ones_like(cls, signal, shape=None) -> TDS:
-		"""
-		Create `TDS` instance similar to `signal`
-		but with all entries being ones.
-		
-		.. code-block:: python
-
-			import modusa as ms
-			signal = ms.tds.from_array([1, 2, 3])
-			y = ms.tds.ones_like(signal)
-			print(y)
-			y.print_info()
-		
-		Parameters
-		----------
-		signal: TDS
-			- Reference signal to create ones like that.
-		Returns
-		-------
-		TDS
-			An instance of TDS.
-		"""
-		assert isinstance(signal, TDS)
-		
-		shape = signal.shape if shape is None else shape
-		
-		return cls.from_array(y=np.ones(shape), sr=signal.t.sr, t0=signal.t.t0, y_label=signal.y.label, t_label=signal.t.label, title=signal.title)
-	
-	@classmethod
-	def random(cls, shape, sr=1.0, t0=0.0) -> TDS:
-		"""
-		Create `TDS` instance with random entries.
-
-		.. code-block:: python
-
-			import modusa as ms
-			x = ms.tds.random(10)
-			print(x)
-			x.print_info()
-		
-		Parameters
-		----------
-		shape: int | tuple[int]
-			- Shape of the signal.
-			- Must be 1 dimensional
-			- E.g. 10 or (10, )
-		sr: float | int
-			- Sampling rate.
-		t0: float | int
-			- Start timestamp.
-		Returns
-		-------
-		TDS
-			An instance of TDS with random values.
-		"""
-		assert isinstance(shape, (int, tuple))
-		y = np.random.random(shape)
-		
-		return cls.from_array(y=y, sr=sr, t0=t0, title="Random")
-	
-	@classmethod
-	def random_like(cls, signal, shape=None) -> TDS:
-		"""
-		Create `TDS` instance similar to `signal`
-		but with all entries being ones.
-
-		.. code-block:: python
-
-			import modusa as ms
-			signal = ms.tds.from_array([1, 2, 3])
-			y = ms.tds.random_like(signal)
-			print(y)
-			y.print_info()
-		
-		Parameters
-		----------
-		signal: TDS
-			- Reference signal to create one with random entries.
-		Returns
-		-------
-		TDS
-			An instance of TDS with random values.
-		"""
-		assert isinstance(signal, TDS)
-		
-		shape = signal.shape if shape is None else shape
-		
-		return cls.from_array(y=np.random.random(shape), sr=signal.t.sr, t0=signal.t.t0, y_label=signal.y.label, t_label=signal.t.label, title=signal.title)
-	

modusa/models/__init__.py

@@ -1,14 +0,0 @@
-#!/usr/bin/env python3
-
-from .base import ModusaSignalData, ModusaSignalAxis, ModusaSignal
-
-from .data import Data
-from .s_ax import SAx
-from .t_ax import TAx
-
-from .s1d import S1D
-from .tds import TDS
-from .audio import Audio
-
-from .s2d import S2D
-from .ftds import FTDS

modusa/models/audio.py

@@ -1,90 +0,0 @@
-#!/usr/bin/env python3
-
-from modusa import excp
-from modusa.decorators import immutable_property, validate_args_type
-from .tds import TDS
-from .data import Data
-from .t_ax import TAx
-from modusa.tools.math_ops import MathOps
-from typing import Self, Any
-import numpy as np
-import matplotlib.pyplot as plt
-from pathlib import Path
-
-class Audio(TDS):
-	"""
-	Represents a 1D audio signal within modusa framework.
-
-	Note
-	----
-	- Use :class:`~modusa.generators.audio.AudioGen` to instantiate this class.
-	- Audio must be mono (1D numpy array).
-
-	Parameters
-	----------
-	y: Data
-		- Data object holding the main audio data.
-	t: TAx
-		- Time axis for the audio.
-	title: str
-		- Title for the signal.
-		- Default: None => ''
-		- e.g. "MySignal"
-		- This is used as the title while plotting.
-	"""
-
-	#--------Meta Information----------
-	_name = "Audio Signal"
-	_nickname = "Audio"
-	_description = ""
-	_author_name = "Ankit Anand"
-	_author_email = "ankit0.anand0@gmail.com"
-	_created_at = "2025-07-04"
-	#----------------------------------
-	
-	@validate_args_type()
-	def __init__(self, y, t, title = None):
-
-		super().__init__(y=y, t=t, title=title) # Instantiating `TimeDomainSignal` class
-	
-	#----------------------------------
-	# Utility Tools
-	#----------------------------------
-			
-	def play(self, regions = None, title = None):
-		"""
-		Play the audio signal inside a Jupyter Notebook.
-	
-		.. code-block:: python
-	
-			import modusa as ms
-			audio = ms.audio.from_youtube("https://www.youtube.com/watch?v=lIpw9-Y_N0g")
-			audio.play(regions=[(10, 30, "1")])
-	
-		Parameters
-		----------
-		regions : list[tuple[float, float, str], ...] | None
-			- [(start_time, end_time, 'tag'), ...] pairs in seconds specifying the regions to play.
-			- e.g. [(1, 10, "Segement 1"), (20, 25, "Segment 2")]
-			- Default to None for which the entire signal is played.
-		title : str | None
-			- Title for the player interface. 
-			- Defaults to None, which means that the signal’s internal title is used.
-	
-		Returns
-		-------
-		IPython.display.Audio
-			An interactive audio player widget for Jupyter environments.
-
-		See Also
-		--------
-		:class:`~modusa.tools.audio_player.AudioPlayer`
-		"""
-		
-		from modusa.tools.audio_player import AudioPlayer
-
-		title = title if title is not None else self.title
-
-		audio_player = AudioPlayer.play(y=self.y.values, sr=self.t.sr, t0=self.t.t0, regions=regions, title=title)
-		
-		return audio_player

modusa/models/base.py

@@ -1,70 +0,0 @@
-#!/usr/bin/env python3
-
-
-from abc import ABC, abstractmethod
-
-class ModusaSignal(ABC):
-	"""
-	Base class for any signal in the modusa framework.
-	
-	Note
-	----
-	- Intended to be subclassed.
-	"""
-	
-	#--------Meta Information----------
-	_name = "Modusa Signal"
-	_nickname = "MS" # This is to be used in repr/str methods
-	_description = "Base class for any signal types in the Modusa framework."
-	_author_name = "Ankit Anand"
-	_author_email = "ankit0.anand0@gmail.com"
-	_created_at = "2025-06-23"
-	#----------------------------------
-	
-	def __init__(self):
-		pass
-		
-
-class ModusaSignalAxis(ABC):
-	"""
-	Base class for any modusa signal axis in the modusa framework.
-	
-	Note
-	----
-	- Intended to be subclassed.
-	"""
-	
-	#--------Meta Information----------
-	_name = "Modusa Signal Axis"
-	_nickname = "MSAx" # This is to be used in repr/str methods
-	_description = "Base class for any modusa signal axis in the modusa framework."
-	_author_name = "Ankit Anand"
-	_author_email = "ankit0.anand0@gmail.com"
-	_created_at = "2025-07-25"
-	#----------------------------------
-	
-	def __init__(self):
-		pass
-	
-class ModusaSignalData(ABC):
-	"""
-	Base class for any modusa signal data in the modusa framework.
-	
-	Note
-	----
-	- Intended to be subclassed.
-	"""
-	
-	#--------Meta Information----------
-	_name = "Modusa Signal Data"
-	_nickname = "MSData" # This is to be used in repr/str methods
-	_description = "Base class for any modusa signal data in the modusa framework."
-	_author_name = "Ankit Anand"
-	_author_email = "ankit0.anand0@gmail.com"
-	_created_at = "2025-07-27"
-	#----------------------------------
-	
-	def __init__(self):
-		pass
-
-