modusa 0.3.21__tar.gz → 0.3.23__tar.gz

{modusa-0.3.21 → modusa-0.3.23}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: modusa
-Version: 0.3.21
+Version: 0.3.23
 Summary: A modular signal analysis python library.
 Author-Email: Ankit Anand <ankit0.anand0@gmail.com>
 License: MIT

{modusa-0.3.21 → modusa-0.3.23}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "modusa"
-version = "0.3.21"
+version = "0.3.23"
 description = "A modular signal analysis python library."
 authors = [
     { name = "Ankit Anand", email = "ankit0.anand0@gmail.com" },

{modusa-0.3.21 → modusa-0.3.23}/src/modusa/__init__.py

@@ -1,8 +1,9 @@
 from modusa.utils import excp, config
 
 #=====Giving access to plot functions to plot multiple signals.=====
-from modusa.tools import plot1d, plot2d
+from modusa.tools import plot1d, plot2d, plot_dist
+#=====
+
 from modusa.tools import play, convert
 from modusa.tools import download
-from modusa.tools import load
-#=====
+from modusa.tools import load, load_ann

{modusa-0.3.21 → modusa-0.3.23}/src/modusa/devtools/generate_docs_source.py

@@ -9,17 +9,15 @@ from collections import defaultdict
 # === Configuration ===
 BASE_MODULES = [
     'modusa.tools',
-    'modusa.models',
-    'modusa.generators',
-    'modusa.plugins',
-#   'modusa.io'
+#   'modusa.models',
+#   'modusa.generators',
+#   'modusa.plugins',
 ]
 OUTPUT_DIRS = [
     Path('docs/source/tools'),
-    Path('docs/source/models'),
-    Path('docs/source/generators'),
-    Path('docs/source/plugins'),
-#   Path('docs/source/io')
+#   Path('docs/source/models'),
+#   Path('docs/source/generators'),
+#   Path('docs/source/plugins'),
 ]
 
 # Ensure output directories exist
@@ -89,8 +87,6 @@ def generate_docs_source():
             write_module_rst_file(module_path, class_list, output_dir)
     
         section_name = base_module.split('.')[-1].capitalize()
-        if section_name == "Io":
-            section_name = "IO"
     
         write_index_rst_file(module_class_map, output_dir, section_name=section_name)
         print(f"✅ Documentation generated for {base_module} in {output_dir}")

{modusa-0.3.21 → modusa-0.3.23}/src/modusa/tools/__init__.py

@@ -1,7 +1,8 @@
 #!/usr/bin/env python3
 
-from .plotter import plot1d, plot2d
+from .plotter import plot1d, plot2d, plot_dist
 from .audio_player import play
 from .audio_converter import convert
 from .youtube_downloader import download
-from .audio_loader import load
+from .audio_loader import load
+from .ann_loader import load_ann

modusa-0.3.23/src/modusa/tools/ann_loader.py

@@ -0,0 +1,38 @@
+#!/usr/bin/env python3
+
+#---------------------------------
+# Author: Ankit Anand
+# Date: 12/08/25
+# Email: ankit0.anand0@gmail.com
+#---------------------------------
+
+from pathlib import Path
+
+def load_ann(path):
+	"""
+	Load annotation from audatity label text file.
+
+	Parameters
+	----------
+	path: str
+		label text file path.
+
+	Returns
+	-------
+	list[tuple, ...]
+		- annotation data structure
+		- [(start, end, tag), ...]
+	"""
+	
+	if isinstance(path, (str, Path)):
+		raise ValueError(f"`path` must be one of (str, Path), got {type(path)}")
+	
+	ann = []
+	with open(str(path), "r") as f:
+		lines = [line.rstrip("\n") for line in f]
+		for line in lines:
+			start, end, tag = line.split("\t")
+			start, end = float(start), float(end)
+			ann.append((start, end, tag))
+			
+	return ann

{modusa-0.3.21 → modusa-0.3.23}/src/modusa/tools/plotter.py

@@ -59,7 +59,7 @@ def plot1d(*args, ann=None, events=None, xlim=None, ylim=None, xlabel=None, ylab
 		plt.Figure
 			Matplolib figure.
 		"""
-	
+
 		for arg in args:
 			if len(arg) not in [1, 2]: # 1 if it just provides values, 2 if it provided axis as well
 				raise ValueError(f"1D signal needs to have max 2 arrays (y, x) or simply (y, )")
@@ -115,9 +115,16 @@ def plot1d(*args, ann=None, events=None, xlim=None, ylim=None, xlabel=None, ylab
 				width = end - start
 				rect = Rectangle((start, 0), width, 1, color=color, alpha=0.7)
 				annotation_ax.add_patch(rect)
-				annotation_ax.text((start + end) / 2, 0.5, tag,
-									ha='center', va='center',
-									fontsize=10, color='white', fontweight='bold', zorder=10)
+				
+				text_obj = annotation_ax.text(
+					(start + end) / 2, 0.5, tag,
+					ha='center', va='center',
+					fontsize=10, color='white', fontweight='bold', zorder=10, clip_on=True
+				)
+				
+				text_obj.set_clip_path(rect)
+				
+				
 		# Add vlines
 		if events is not None:
 			for xpos in events:
@@ -140,7 +147,7 @@ def plot1d(*args, ann=None, events=None, xlim=None, ylim=None, xlabel=None, ylab
 		if ylabel is not None:
 			signal_ax.set_ylabel(ylabel)
 		
-		# Decorating annotation axis thicker
+		# Remove the boundaries and ticks from an axis
 		if ann is not None:
 			annotation_ax.tick_params(left=False, bottom=False, labelleft=False, labelbottom=False)
 		else:
@@ -296,9 +303,14 @@ def plot2d(*args, ann=None, events=None, xlim=None, ylim=None, origin="lower", M
 			width = end - start
 			rect = Rectangle((start, 0), width, 1, color=color, alpha=0.7)
 			annotation_ax.add_patch(rect)
-			annotation_ax.text((start + end) / 2, 0.5, tag,
-								ha='center', va='center',
-								fontsize=10, color='white', fontweight='bold', zorder=10)
+			text_obj = annotation_ax.text(
+				(start + end) / 2, 0.5, tag,
+				ha='center', va='center',
+				fontsize=10, color='white', fontweight='bold', zorder=10, clip_on=True
+			)
+			
+			text_obj.set_clip_path(rect)
+			
 	# Add vlines
 	if events is not None:
 		for xpos in events:
@@ -350,4 +362,142 @@ def plot2d(*args, ann=None, events=None, xlim=None, ylim=None, origin="lower", M
 
 	fig.subplots_adjust(hspace=0.01, wspace=0.05)
 	plt.close()
-	return fig
+	return fig
+
+#======== Plot distribution ===========
+def plot_dist(*args, ann=None, xlim=None, ylim=None, ylabel=None, xlabel=None, title=None, legend=None, show_hist=True, npoints=200):
+		"""
+		Plot distribution.
+
+		.. code-block:: python
+			
+			import modusa as ms
+			import numpy as np
+			np.random.seed(42)
+			data = np.random.normal(loc=1, scale=1, size=1000)
+			ms.plot_dist(data, data+5, data-10, ann=[(0, 1, "A")], legend=("D1", "D2", "D3"), ylim=(0, 1), xlabel="X", ylabel="Counts", title="Distribution")
+
+		Parameters
+		----------
+		*args: ndarray
+			- Data arrays for which distribution needs to be plotted.
+			- Arrays will be flattened.
+		ann : list[tuple[Number, Number, str] | None
+			- A list of annotations to mark specific points. Each tuple should be of the form (start, end, label).
+			- Default: None => No annotation.
+		events : list[Number] | None
+			- A list of x-values where vertical lines (event markers) will be drawn.
+			- Default: None
+		xlim : tuple[Number, Number] | None
+			- Limits for the x-axis as (xmin, xmax).
+			- Default: None
+		ylim : tuple[Number, Number] | None
+			- Limits for the y-axis as (ymin, ymax).
+			- Default: None
+		xlabel : str | None
+			- Label for the x-axis.
+			- - Default: None
+		ylabel : str | None
+			- Label for the y-axis.
+			- Default: None
+		title : str | None
+			- Title of the plot.
+			- Default: None
+		legend : list[str] | None
+			- List of legend labels corresponding to each signal if plotting multiple distributions.
+			- Default: None
+		show_hist: bool
+			- Want to show histogram as well.
+		npoints: int
+			- Number of points for which gaussian needs to be computed between min and max.
+			- Higher value means more points are evaluated with the fitted gaussian, thereby higher resolution.
+
+		Returns
+		-------
+		plt.Figure
+			- Matplotlib figure.
+		"""
+		from scipy.stats import gaussian_kde
+	
+		if isinstance(legend, str):
+				legend = (legend, )
+			
+		if legend is not None:
+				if len(legend) < len(args):
+						raise ValueError(f"Legend should be provided for each signal.")
+					
+		# Create figure
+		fig = plt.figure(figsize=(16, 4))
+		gs = gridspec.GridSpec(2, 1, height_ratios=[0.1, 1])
+	
+		colors = plt.get_cmap('tab10').colors
+	
+		dist_ax = fig.add_subplot(gs[1, 0])
+		annotation_ax = fig.add_subplot(gs[0, 0], sharex=dist_ax)
+	
+		# Set limits
+		if xlim is not None:
+				dist_ax.set_xlim(xlim)
+			
+		if ylim is not None:
+				dist_ax.set_ylim(ylim)
+			
+		# Add plot
+		for i, data in enumerate(args):
+				# Fit gaussian to the data
+				kde = gaussian_kde(data)
+			
+				# Create points to evaluate KDE
+				x_vals = np.linspace(min(data), max(data), npoints)
+				y_vals = kde(x_vals)
+			
+				if legend is not None:
+						dist_ax.plot(x_vals, y_vals, color=colors[i], label=legend[i])
+						if show_hist is True:
+								dist_ax.hist(data, bins=30, density=True, alpha=0.3, facecolor=colors[i], edgecolor='black', label=legend[i])
+				else:
+						dist_ax.plot(x_vals, y_vals, color=colors[i])
+						if show_hist is True:
+								dist_ax.hist(data, bins=30, density=True, alpha=0.3, facecolor=colors[i], edgecolor='black', label=legeng[i])
+							
+		# Add annotations
+		if ann is not None:
+				annotation_ax.set_ylim(0, 1)
+				for i, (start, end, tag) in enumerate(ann):
+						if xlim is not None:
+								if end < xlim[0] or start > xlim[1]:
+										continue  # Skip out-of-view regions
+								# Clip boundaries to xlim
+								start = max(start, xlim[0])
+								end = min(end, xlim[1])
+							
+						color = colors[i % len(colors)]
+						width = end - start
+						rect = Rectangle((start, 0), width, 1, color=color, alpha=0.7)
+						annotation_ax.add_patch(rect)
+					
+						text_obj = annotation_ax.text((start + end) / 2, 0.5, tag, ha='center', va='center', fontsize=10, color='white', fontweight='bold', zorder=10, clip_on=True)
+						text_obj.set_clip_path(rect)
+					
+		# Add legend
+		if legend is not None:
+				handles, labels = dist_ax.get_legend_handles_labels()
+				fig.legend(handles, labels, loc='upper right', bbox_to_anchor=(0.9, 1.1), ncol=len(legend), frameon=True)
+			
+		# Set title, labels
+		if title is not None:
+				annotation_ax.set_title(title, pad=10, size=11)
+		if xlabel is not None:
+				dist_ax.set_xlabel(xlabel)
+		if ylabel is not None:
+				dist_ax.set_ylabel(ylabel)
+			
+		# Remove the boundaries and ticks from annotation axis
+		if ann is not None:
+				annotation_ax.tick_params(left=False, bottom=False, labelleft=False, labelbottom=False)
+		else:
+				annotation_ax.axis("off")
+			
+		fig.subplots_adjust(hspace=0.01, wspace=0.05)
+		plt.close()
+		return fig

modusa-0.3.21/src/modusa/main.py

@@ -1,3 +0,0 @@
-#!/usr/bin/env python3
-
-

modusa-0.3.21/src/modusa/tmp.py

@@ -1,98 +0,0 @@
-#def autocorr(self) -> Self:
-#	"""
-#	
-#	"""
-#	raise NotImplementedError
-#	r = np.correlate(self.data, self.data, mode="full")
-#	r = r[self.data.shape[0] - 1:]
-#	r_signal = self.__class__(data=r, sr=self.sr, t0=self.t0, title=self.title + " [Autocorr]")
-#	return r_signal
-
-#	#----------------------------
-#	# To different signals
-#	#----------------------------
-#	def to_audio_signal(self) -> "AudioSignal":
-#		"""
-#		Moves TimeDomainSignal to AudioSignal
-#		"""
-#		raise NotImplementedError
-#		from modusa.signals.audio_signal import AudioSignal
-#		
-#		return AudioSignal(data=self.data, sr=self.sr, t0=self.t0, title=self.title)
-#	
-#	def to_spectrogram(
-#		self,
-#		n_fft: int = 2048,
-#		hop_length: int = 512,
-#		win_length: int | None = None,
-#		window: str = "hann"
-#	) -> "Spectrogram":
-#		"""
-#		Compute the Short-Time Fourier Transform (STFT) and return a Spectrogram object.
-#		
-#		Parameters
-#		----------
-#		n_fft : int
-#			FFT size.
-#		win_length : int or None
-#			Window length. Defaults to `n_fft` if None.
-#		hop_length : int
-#			Hop length between frames.
-#		window : str
-#			Type of window function to use (e.g., 'hann', 'hamming').
-#		
-#		Returns
-#		-------
-#		Spectrogram
-#			Spectrogram object containing S (complex STFT), t (time bins), and f (frequency bins).
-#		"""
-#		raise NotImplementedError
-#		import warnings
-#		warnings.filterwarnings("ignore", category=UserWarning, module="librosa.core.intervals")
-#		
-#		from modusa.signals.feature_time_domain_signal import FeatureTimeDomainSignal
-#		import librosa
-#		
-#		S = librosa.stft(self.data, n_fft=n_fft, win_length=win_length, hop_length=hop_length, window=window)
-#		f = librosa.fft_frequencies(sr=self.sr, n_fft=n_fft)
-#		t = librosa.frames_to_time(np.arange(S.shape[1]), sr=self.sr, hop_length=hop_length)
-#		frame_rate = self.sr / hop_length
-#		spec = FeatureTimeDomainSignal(data=S, feature=f, feature_label="Freq (Hz)", frame_rate=frame_rate, t0=self.t0, time_label="Time (sec)", title=self.title)
-#		if self.title != self._name: # Means title of the audio was reset so we pass that info to spec
-#			spec = spec.set_meta_info(title=self.title)
-#		
-#		return spec
-#	#=====================================
-	
-	#=====================================
-	
-	#--------------------------
-	# Other signal ops
-	#--------------------------
-	
-#	def interpolate(self, to: TimeDomainSignal, kind: str = "linear", fill_value: str | float = "extrapolate") -> TimeDomainSignal:
-#		"""
-#		Interpolate the current signal to match the time axis of `to`.
-#	
-#		Parameters:
-#			to (TimeDomainSignal): The signal whose time axis will be used.
-#			kind (str): Interpolation method ('linear', 'nearest', etc.)
-#			fill_value (str or float): Value used to fill out-of-bounds.
-#	
-#		Returns:
-#			TimeDomainSignal: A new signal with values interpolated at `to.t`.
-#		"""
-#		assert self.y.ndim == 1, "Only 1D signals supported for interpolation"
-#		
-#		interpolator = interp1d(
-#			self.t,
-#			self.y,
-#			kind=kind,
-#			fill_value=fill_value,
-#			bounds_error=False,
-#			assume_sorted=True
-#		)
-#		
-#		y_interp = interpolator(to.y)
-	
-#		return self.__class__(y=y_interp, sr=to.sr, t0=to.t0, title=f"{self.title} → interpolated")