modusa 0.1.0__py3-none-any.whl → 0.2.1__py3-none-any.whl

modusa/signals/uniform_time_domain_signal.py

@@ -1,212 +0,0 @@
-#!/usr/bin/env python3
-
-
-from modusa import excp
-from modusa.decorators import immutable_property, validate_args_type
-from modusa.signals.base import ModusaSignal
-from typing import Self, Any
-import numpy as np
-import matplotlib.pyplot as plt
-
-
-class UniformTimeDomainSignal(ModusaSignal):
-	"""
-
-	"""
-	
-	#--------Meta Information----------
-	name = "Uniform Time Domain Signal"
-	description = ""
-	author_name = "Ankit Anand"
-	author_email = "ankit0.anand0@gmail.com"
-	created_at = "2025-07-02"
-	#----------------------------------
-	
-	@validate_args_type()
-	def __init__(self, y: np.ndarray, t: np.ndarray | None = None):
-		if y.ndim != 1:
-			raise excp.InputValueError(f"`y` must have 1 dimension not {y.ndim}.")
-		if y.shape[0] < 1:
-			raise excp.InputValueError(f"`y` must have atleast 1 element.")
-		
-		if t is None:
-			t = np.arange(y.shape[0])
-		else:
-			if t.ndim != 1:
-				raise excp.InputValueError(f"`t` must have 1 dimension not {t.ndim}.")
-			if t.shape[0] != y.shape[0]:
-				raise excp.InputValueError(f"`t` and `y` must have same shape.")
-			
-		super().__init__(data=y, data_idx=t) # Instantiating `ModusaSignal` class
-		
-		self._y_unit = ""
-		self._t_unit = "index"
-		
-		self._title = "aa"
-		self._y_label = ""
-		self._t_label = "Time"
-	
-	def _with_data(self, new_data: np.ndarray, new_data_idx: np.ndarray) -> Self:
-		"""Subclasses must override this to return a copy with new data."""
-		Ts = new_data_idx[1] - new_data_idx[0]
-		new_signal = self.__class__(y=new_data, Ts=self.Ts)
-		new_signal.set_units(y_unit=self.y_unit, t_unit=self.t_unit)
-		new_signal.set_plot_labels(title=self.title, y_label=self.y_label, t_label=self.t_label)
-		
-		return new_signal
-	
-	#----------------------
-	# From methods
-	#----------------------
-	@classmethod
-	@validate_args_type()
-	def from_array(cls, y: np.ndarray, t: np.ndarray | None = None, t_unit: str | None = None) -> Self:
-		
-		signal: Self = cls(y=y, t=t)
-		
-		if t_unit is not None:
-			signal.set_units(t_unit=t_unit)
-		
-		return signal
-	
-	@classmethod
-	@validate_args_type()
-	def from_array_with_Ts(cls, y: np.ndarray, Ts: float | None = None, t_unit: str | None = None) -> Self:
-		
-		t = np.arange(y.shape[0]) * Ts
-		signal: Self = cls(y=y, t=t)
-		
-		if t_unit is not None:
-			signal.set_units(t_unit=t_unit)
-			
-		return signal
-	
-	#----------------------
-	# Setters
-	#----------------------
-	
-	@validate_args_type()
-	def set_units(
-		self,
-		y_unit: str | None = None,
-		t_unit: str | None = None,
-	) -> Self:
-		if y_unit is not None:
-			self._y_unit = y_unit
-		if t_unit is not None:
-			self._t_unit = t_unit
-			
-		return self
-	
-	@validate_args_type()
-	def set_plot_labels(
-		self,
-		title: str | None = None,
-		y_label: str | None = None,
-		t_label: str | None = None
-	) -> Self:
-		""""""
-		if title is not None:
-			self._title = title
-		if y_label is not None:
-			self._y_label = y_label
-		if t_label is not None:
-			self._t_label = t_label
-			
-		return self
-	
-	
-	
-	#----------------------
-	# Properties
-	#----------------------
-	
-	@immutable_property("Create a new object instead.")
-	def y(self) -> np.ndarray:
-		return self.data
-	
-	@immutable_property("Create a new object instead.")
-	def t(self) -> np.ndarray:
-		return self.data_idx
-	
-	@immutable_property("Use `.set_t` instead.")
-	def y_unit(self) -> str:
-		return self._y_unit
-	
-	@immutable_property("Use `.set_t` instead.")
-	def t_unit(self) -> str:
-		return self._t_unit
-	
-	@immutable_property("Use `.labels` instead.")
-	def title(self) -> str:
-		return self._title
-	
-	@immutable_property("Use `.set_t` instead.")
-	def y_label(self) -> str:
-		return self._y_label
-	
-	@immutable_property("Use `.set_t` instead.")
-	def t_label(self) -> str:
-		return self._t_label
-	
-	@immutable_property("Use `.resample` instead.")
-	def Ts(self) -> float:
-		"""Sampling period of the signal."""
-		return self.t[1] - self.t[0]
-	
-	@immutable_property("Use `.resample` instead.")
-	def sr(self) -> float:
-		"""
-		Sampling rate of the signal.
-		"""
-		return 1.0 / self.Ts
-	
-	@immutable_property(error_msg="Use `.set_labels` instead.")
-	def labels(self) -> tuple[str, str, str]:
-		"""Labels in a format appropriate for the plots."""
-		return (self.title, f"{self.y_label} ({self.y_unit})", f"{self.t_label} ({self.t_unit})")
-	
-	#----------------------
-	# Plugins Access
-	#----------------------
-	@validate_args_type()
-	def plot(
-		self,
-		scale_y: tuple[float, float] | None = None,
-		scale_t: tuple[float, float] | None = None,
-		ax: plt.Axes | None = None,
-		color: str = "b",
-		marker: str | None = None,
-		linestyle: str | None = None,
-		stem: bool | None = None,
-		labels: tuple[str, str, str] | None = None,
-		legend_loc: str | None = None,
-		zoom: tuple[float, float] | None = None,
-		highlight: list[tuple[float, float]] | None = None,
-	) -> plt.Figure:
-		"""
-		Applies `modusa.plugins.PlotTimeDomainSignal` Plugin.
-		"""
-		
-		from modusa.plugins import PlotTimeDomainSignalPlugin
-		
-		labels = labels or self.labels
-		stem = stem or False
-		
-		fig: plt.Figure | None = PlotTimeDomainSignalPlugin().apply(
-			signal=self,
-			scale_y=scale_y,
-			scale_t=scale_t,
-			ax=ax,
-			color=color,
-			marker=marker,
-			linestyle=linestyle,
-			stem=stem,
-			labels=labels,
-			legend_loc=legend_loc,
-			zoom=zoom,
-			highlight=highlight
-		)
-		
-		return fig
-	

modusa-0.1.0.dist-info/RECORD

@@ -1,41 +0,0 @@
-modusa-0.1.0.dist-info/METADATA,sha256=gJkbRke4vQ91d1kGiOAEOZxTABmPRHUsK8DFF979Abc,2026
-modusa-0.1.0.dist-info/WHEEL,sha256=9P2ygRxDrTJz3gsagc0Z96ukrxjr-LFBGOgv3AuKlCA,90
-modusa-0.1.0.dist-info/entry_points.txt,sha256=fmKpleVXj6CdaBVL14WoEy6xx7JQCs85jvzwTi3lePM,73
-modusa-0.1.0.dist-info/licenses/LICENSE.md,sha256=JTaXAjx5awk76VArKCx5dUW8vmLEWsL_ZlR7-umaHbA,1078
-modusa/.DS_Store,sha256=XmYb59Z5I9QAhS9vvksVzCbsHT2q9D4A3oZtrgkDWsA,8196
-modusa/__init__.py,sha256=bfQKVSpAXlKmKvMRIU6WSRQW2qoJsaZsdNJ8E69ghn0,37
-modusa/config.py,sha256=bTqK4t00FZqERVITrxW_q284aDDJAa9aMSfFknfR-oU,280
-modusa/decorators.py,sha256=r2r411sXHjl29zFVwoCvcQ5Pb8war-drSuDinHfPYq4,5905
-modusa/devtools/generate_template.py,sha256=X_9VC87LBrd9x4_GNkisJ6S9bimp8AdNmv7esdd4Ad0,2567
-modusa/devtools/list_authors.py,sha256=FWBQKOLznVthvMYMASrx2Gw5lqKHEOccQpBisDZ53Dw,24
-modusa/devtools/list_plugins.py,sha256=g-R5hoaCzHfClY_Sfa788IQ9CAKzQGTfyqmthXDZQqw,1729
-modusa/devtools/main.py,sha256=L9KpdX4ob1CW7KNCULgVes7LIfHUn25Wo5Jp5mMgX5g,1704
-modusa/devtools/templates/engines.py,sha256=ut3-jyRI5TmwJlni3nu4HQ7t0do_VtQuTS1sdkCePxI,512
-modusa/devtools/templates/generators.py,sha256=qXvsxJ6tTj6LLlUYpXnKsDfXT2dz3wDrBzv5ZhPO1do,457
-modusa/devtools/templates/plugins.py,sha256=n451iIlTOuQtpHywI8c_teyGMSMd3QCLYDUyLmg0v8Y,839
-modusa/devtools/templates/signals.py,sha256=Sv0D5Irhvgnn7Q0kWKF9ryTgPmNie9kvUxOnjZCgUTQ,1210
-modusa/engines/__init__.py,sha256=cKVTJjAwhlLF2x5tpvYAmxIR9B6CFOGeYsVKKJoUm2I,115
-modusa/engines/base.py,sha256=gHeGTbvcPhTxwUwt16OLpepMkbG40rv19vs8tN8xqgA,297
-modusa/engines/plot_1dsignal.py,sha256=0qaRuMDP5ZLnxrE53v1D-0aHu2hcpH-dMfPRRKAUVhY,3589
-modusa/engines/plot_2dmatrix.py,sha256=q_k08170ras9lBjI37SYArrDkQjlKd2wicVc_iykvsU,4393
-modusa/generators/__init__.py,sha256=0tr-StwA50XArEfz7jDASyQhd7Au-d4RuNhzooAYuhQ,74
-modusa/generators/base.py,sha256=F0xUu97A6LJ3AIZ3VcxRw-oMMpjK13zotHprM0_WJa8,1185
-modusa/generators/basic_waveform.py,sha256=FtglesHsLGflIJ2ROO1mYoDTgouXoDE_896qB9J1_2Y,4540
-modusa/main.py,sha256=X3uq5nfHt89_EsnyRHNMkX-j5dxSuaTMF3EPu6XPr48,665
-modusa/plugins/__init__.py,sha256=bGPEyqRaNR2uhrRbX0n_FWK4IqjlZ42akUNIbe_WUe8,211
-modusa/plugins/base.py,sha256=Bh_1Bja7fOymFsCgwhXDbV6ys3D8muNrPwrfDrG_G_A,2382
-modusa/plugins/plot_1dsignal.py,sha256=_Annn_4QgVTAlWanY2nctw0MIQyoEhR8u8gx8WAMd5c,1885
-modusa/plugins/plot_2dmatrix.py,sha256=FXmQvUhod66Q4-jWIKb6IrP8aVmC67V7urxMSV4LJSg,2135
-modusa/plugins/plot_time_domain_signal.py,sha256=fiyFQZ4VS_uvaVOm8LBryqxuWd57sf4vvKB25YqriPU,1804
-modusa/signals/__init__.py,sha256=QjJUuEjbJR9UHbPPYXJVZ7oZP1YnDy1DPRl1HWqEP50,220
-modusa/signals/audio_signal.py,sha256=8QaXt-LdTc_yVDLXXExlWCzzqgR-MxgwPEk30CXuanQ,5576
-modusa/signals/base.py,sha256=fXPYPsaTcvZ323hkzjigKR1EZfNw6ZTxOUonbuzACnA,8362
-modusa/signals/signal1d.py,sha256=sjUuRO4BEhhfJFdA3rJfIBYQxSwR_9u0Ym1_RZQQvRI,7711
-modusa/signals/signal2d.py,sha256=7GvmsYEgavoMTSyacbQHva9eyc2aSII3aqOcbKzOG7A,5677
-modusa/signals/uniform_time_domain_signal.py,sha256=lws6n3eYOg5Bwgb-iwZwUgvN6kbxKE4n15rCqOODguA,5250
-modusa/utils/.DS_Store,sha256=nLXMwF7QJNuglLI_Gk74F7vl5Dyus2Wd74Mgowijmdo,6148
-modusa/utils/__init__.py,sha256=1oLL20yLB1GL9IbFiZD8OReDqiCpFr-yetIR6x1cNkI,23
-modusa/utils/config.py,sha256=cuGbqbovx5WDQq5rw3hIKcv3CnE5NttjacSOWnP1yu4,576
-modusa/utils/excp.py,sha256=3HkCyyvwE035hAq5-0srb-82AYSI-_8vszKU6Fe3O3k,1189
-modusa/utils/logger.py,sha256=K0rsnObeNKCxlNeSnVnJeRhgfmob6riB2uyU7h3dDmA,571
-modusa-0.1.0.dist-info/RECORD,,