modusa 0.3.26__tar.gz → 0.3.28__tar.gz

{modusa-0.3.26 → modusa-0.3.28}/PKG-INFO

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

{modusa-0.3.26 → modusa-0.3.28}/pyproject.toml

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

{modusa-0.3.26 → modusa-0.3.28}/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
 		-------
@@ -146,6 +168,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 +185,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 +239,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,16 +305,12 @@ 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
@@ -352,7 +377,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:
@@ -365,7 +393,7 @@ def plot2d(*args, ann=None, events=None, xlim=None, ylim=None, origin="lower", M
 	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):
+def plot_dist(*args, ann=None, xlim=None, ylim=None, ylabel=None, xlabel=None, title=None, legend=None, show_hist=True, npoints=200, bins=30):
 		"""
 		Plot distribution.
 
@@ -411,6 +439,9 @@ def plot_dist(*args, ann=None, xlim=None, ylim=None, ylabel=None, xlabel=None, t
 		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.
+		bins: int
+			- The number of bins for histogram.
+			- This is used only to plot the histogram.
 
 		Returns
 		-------
@@ -454,11 +485,11 @@ def plot_dist(*args, ann=None, xlim=None, ylim=None, ylabel=None, xlabel=None, t
 				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])
+								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])
 						if show_hist is True:
-								dist_ax.hist(data, bins=30, density=True, alpha=0.3, facecolor=colors[i], edgecolor='black')
+								dist_ax.hist(data, bins=bins, density=True, alpha=0.3, facecolor=colors[i], edgecolor='black')
 							
 		# Add annotations
 		if ann is not None: