modusa 0.3.27__tar.gz → 0.3.29__tar.gz

{modusa-0.3.27 → modusa-0.3.29}/PKG-INFO

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

{modusa-0.3.27 → modusa-0.3.29}/pyproject.toml

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

{modusa-0.3.27 → modusa-0.3.29}/src/modusa/tools/plotter.py

@@ -7,8 +7,27 @@ import matplotlib.gridspec as gridspec
 from matplotlib.patches import Rectangle
 from mpl_toolkits.axes_grid1.inset_locator import inset_axes
 
+# Helper for 2D plot
+def _calculate_extent(x, y):
+	# Handle spacing safely
+	if len(x) > 1:
+		dx = x[1] - x[0]
+	else:
+		dx = 1  # Default spacing for single value
+	if len(y) > 1:
+		dy = y[1] - y[0]
+	else:
+		dy = 1  # Default spacing for single value
+		
+	return [
+		x[0] - dx / 2,
+		x[-1] + dx / 2,
+		y[0] - dy / 2,
+		y[-1] + dy / 2
+	]
+
 #======== 1D ===========
-def plot1d(*args, ann=None, events=None, xlim=None, ylim=None, xlabel=None, ylabel=None, title=None, legend=None):
+def plot1d(*args, ann=None, events=None, xlim=None, ylim=None, xlabel=None, ylabel=None, title=None, legend=None, show_grid=False):
 		"""
 		Plots a 1D signal using matplotlib.
 
@@ -53,6 +72,9 @@ def plot1d(*args, ann=None, events=None, xlim=None, ylim=None, xlabel=None, ylab
 		legend : list[str] | None
 			- List of legend labels corresponding to each signal if plotting multiple lines.
 			- Default: None
+		show_grid: bool
+			- If you want to show the grid.
+			- Default: False
 	
 		Returns
 		-------
@@ -63,6 +85,7 @@ def plot1d(*args, ann=None, events=None, xlim=None, ylim=None, xlabel=None, ylab
 		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, )")
+			
 		if isinstance(legend, str): legend = (legend, )
 		
 		if legend is not None:
@@ -89,10 +112,11 @@ def plot1d(*args, ann=None, events=None, xlim=None, ylim=None, xlabel=None, ylab
 		for i, signal in enumerate(args):
 			if len(signal) == 1:
 				y = signal[0]
+				x = np.arange(y.size)
 				if legend is not None:
-					signal_ax.plot(y, label=legend[i])
+					signal_ax.plot(x, y, label=legend[i])
 				else:
-					signal_ax.plot(y)
+					signal_ax.plot(x, y)
 			elif len(signal) == 2:
 				y, x = signal[0], signal[1]
 				if legend is not None:
@@ -102,14 +126,19 @@ def plot1d(*args, ann=None, events=None, xlim=None, ylim=None, xlabel=None, ylab
 		
 		# Add annotations
 		if ann is not None:
-			annotation_ax.set_ylim(0, 1)
+			annotation_ax.set_ylim(0, 1) # For consistent layout
+			# Determine visible x-range
+			x_view_min = xlim[0] if xlim is not None else np.min(x)
+			x_view_max = xlim[1] if xlim is not None else np.max(x)
+			
 			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])
+				# We make sure that we only plot annotation that are within the x range of the current view
+				if start >= x_view_max or end <= x_view_min:
+					continue
+				
+				# Clip boundaries to xlim
+				start = max(start, x_view_min)
+				end = min(end, x_view_max)
 					
 				color = colors[i % len(colors)]
 				width = end - start
@@ -146,6 +175,10 @@ def plot1d(*args, ann=None, events=None, xlim=None, ylim=None, xlabel=None, ylab
 			signal_ax.set_xlabel(xlabel)
 		if ylabel is not None:
 			signal_ax.set_ylabel(ylabel)
+			
+		# Add grid to the plot
+		if show_grid is True:
+			signal_ax.grid(True, linestyle=':', linewidth=0.7, color='gray', alpha=0.7)
 		
 		# Remove the boundaries and ticks from an axis
 		if ann is not None:
@@ -159,7 +192,7 @@ def plot1d(*args, ann=None, events=None, xlim=None, ylim=None, xlabel=None, ylab
 		return fig
 
 #======== 2D ===========
-def plot2d(*args, ann=None, events=None, xlim=None, ylim=None, origin="lower", Mlabel=None, xlabel=None, ylabel=None, title=None, legend=None, lm=False):
+def plot2d(*args, ann=None, events=None, xlim=None, ylim=None, origin="lower", Mlabel=None, xlabel=None, ylabel=None, title=None, legend=None, lm=False, show_grid=False):
 	"""
 	Plots a 2D matrix (e.g., spectrogram or heatmap) with optional annotations and events.
 
@@ -213,6 +246,9 @@ def plot2d(*args, ann=None, events=None, xlim=None, ylim=None, origin="lower", M
 		- Adds a circular marker for the line.
 		- Default: False
 		- Useful to show the data points.
+	show_grid: bool
+		- If you want to show the grid.
+		- Default: False
 
 	Returns
 	-------
@@ -276,28 +312,29 @@ def plot2d(*args, ann=None, events=None, xlim=None, ylim=None, origin="lower", M
 			if len(signal) == 1: # It means that the axes were not passed
 				y = np.arange(M.shape[0])
 				x = np.arange(M.shape[1])
-				dx = x[1] - x[0]
-				dy = y[1] - y[0]
-				extent=[x[0] - dx/2, x[-1] + dx/2, y[0] - dy/2, y[-1] + dy/2]
+				extent = _calculate_extent(x, y)
 				im = signal_ax.imshow(M, aspect="auto", origin=origin, cmap="gray_r", extent=extent)
 				
 			elif len(signal) == 3: # It means that the axes were passed
 				M, y, x = signal[0], signal[1], signal[2]
-				dx = x[1] - x[0]
-				dy = y[1] - y[0]
-				extent=[x[0] - dx/2, x[-1] + dx/2, y[0] - dy/2, y[-1] + dy/2]
+				extent = _calculate_extent(x, y)
 				im = signal_ax.imshow(M, aspect="auto", origin=origin, cmap="gray_r", extent=extent)
 	
 	# Add annotations
 	if ann is not None:
-		annotation_ax.set_ylim(0, 1)
+		annotation_ax.set_ylim(0, 1) # For consistent layout
+		# Determine visible x-range
+		x_view_min = xlim[0] if xlim is not None else np.min(x)
+		x_view_max = xlim[1] if xlim is not None else np.max(x)
+		
 		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])
+			# We make sure that we only plot annotation that are within the x range of the current view
+			if start >= x_view_max or end <= x_view_min:
+				continue
+			
+			# Clip boundaries to xlim
+			start = max(start, x_view_min)
+			end = min(end, x_view_max)
 				
 			color = colors[i % len(colors)]
 			width = end - start
@@ -352,7 +389,10 @@ def plot2d(*args, ann=None, events=None, xlim=None, ylim=None, origin="lower", M
 		signal_ax.set_xlabel(xlabel)
 	if ylabel is not None:
 		signal_ax.set_ylabel(ylabel)
-	
+		
+	# Add grid to the plot
+	if show_grid is True:
+		signal_ax.grid(True, linestyle=':', linewidth=0.7, color='gray', alpha=0.7)
 	
 	# Making annotation axis spines thicker
 	if ann is not None:
@@ -451,36 +491,40 @@ def plot_dist(*args, ann=None, xlim=None, ylim=None, ylabel=None, xlabel=None, t
 				kde = gaussian_kde(data)
 			
 				# Create points to evaluate KDE
-				x_vals = np.linspace(min(data), max(data), npoints)
-				y_vals = kde(x_vals)
+				x = np.linspace(min(data), max(data), npoints)
+				y = kde(x)
 			
 				if legend is not None:
-						dist_ax.plot(x_vals, y_vals, color=colors[i], label=legend[i])
+						dist_ax.plot(x, y, color=colors[i], label=legend[i])
 						if show_hist is True:
 								dist_ax.hist(data, bins=bins, density=True, alpha=0.3, facecolor=colors[i], edgecolor='black', label=legend[i])
 				else:
-						dist_ax.plot(x_vals, y_vals, color=colors[i])
+						dist_ax.plot(x, y, color=colors[i])
 						if show_hist is True:
 								dist_ax.hist(data, bins=bins, density=True, alpha=0.3, facecolor=colors[i], edgecolor='black')
 							
 		# 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)
+			annotation_ax.set_ylim(0, 1) # For consistent layout
+			# Determine visible x-range
+			x_view_min = xlim[0] if xlim is not None else np.min(x)
+			x_view_max = xlim[1] if xlim is not None else np.max(x)
+			for i, (start, end, tag) in enumerate(ann):
+				# We make sure that we only plot annotation that are within the x range of the current view
+				if start >= x_view_max or end <= x_view_min:
+					continue
+				
+				# Clip boundaries to xlim
+				start = max(start, x_view_min)
+				end = min(end, x_view_max)
 					
-						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)
+				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: