modusa 0.3.27__py3-none-any.whl → 0.3.28__py3-none-any.whl

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:

{modusa-0.3.27.dist-info → modusa-0.3.28.dist-info}/METADATA

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

{modusa-0.3.27.dist-info → modusa-0.3.28.dist-info}/RECORD

@@ -1,7 +1,7 @@
-modusa-0.3.27.dist-info/METADATA,sha256=YE2Sxy3pyXXbzkIjB5wqMme9ENn6-ZkqsbRiOn8Tfbw,1369
-modusa-0.3.27.dist-info/WHEEL,sha256=9P2ygRxDrTJz3gsagc0Z96ukrxjr-LFBGOgv3AuKlCA,90
-modusa-0.3.27.dist-info/entry_points.txt,sha256=fmKpleVXj6CdaBVL14WoEy6xx7JQCs85jvzwTi3lePM,73
-modusa-0.3.27.dist-info/licenses/LICENSE.md,sha256=JTaXAjx5awk76VArKCx5dUW8vmLEWsL_ZlR7-umaHbA,1078
+modusa-0.3.28.dist-info/METADATA,sha256=wNR4dM9jMye2V4s7H9zhtD6k9w6B8kUdlzGQdxbINvc,1369
+modusa-0.3.28.dist-info/WHEEL,sha256=9P2ygRxDrTJz3gsagc0Z96ukrxjr-LFBGOgv3AuKlCA,90
+modusa-0.3.28.dist-info/entry_points.txt,sha256=fmKpleVXj6CdaBVL14WoEy6xx7JQCs85jvzwTi3lePM,73
+modusa-0.3.28.dist-info/licenses/LICENSE.md,sha256=JTaXAjx5awk76VArKCx5dUW8vmLEWsL_ZlR7-umaHbA,1078
 modusa/.DS_Store,sha256=_gm6qJREwfMi8dE7n5S89_RG46u5t3xHyD-smNhtNoM,6148
 modusa/__init__.py,sha256=uq6kORFFAODiCMGmOLWO0shE8-dVFWf5gmV8wxekmnk,280
 modusa/config.py,sha256=bTqK4t00FZqERVITrxW_q284aDDJAa9aMSfFknfR-oU,280
@@ -47,7 +47,7 @@ modusa/tools/audio_loader.py,sha256=DrCzq0pdiQrUDIG-deLJGcu8EaylO5yRtwT4lr8WSf8,
 modusa/tools/audio_player.py,sha256=GP04TWW4jBwQBjANkfR_cJtEy7cIhvbu8RTwnf9hD6E,2817
 modusa/tools/base.py,sha256=C0ESJ0mIfjjRlAkRbSetNtMoOfS6IrHBjexRp3l_Mh4,1293
 modusa/tools/math_ops.py,sha256=ZZ7U4DgqT7cOeE7_Lzi_Qq-48WYfwR9_osbZwTmE9eg,8690
-modusa/tools/plotter.py,sha256=Aacg-ezlMFdx_BK8yTOdsBBRQIGSwmWBmTwANr5TtHs,15388
+modusa/tools/plotter.py,sha256=Pfj24jl-WHgdfPI-f4J_XLpMyed6OHkwAvtuIBKoAEw,16016
 modusa/tools/youtube_downloader.py,sha256=hB_X8-7nOHXOlxg6vv3wyhBLoAsWyomrULP6_uCQL7s,1698
 modusa/utils/.DS_Store,sha256=nLXMwF7QJNuglLI_Gk74F7vl5Dyus2Wd74Mgowijmdo,6148
 modusa/utils/__init__.py,sha256=1oLL20yLB1GL9IbFiZD8OReDqiCpFr-yetIR6x1cNkI,23
@@ -56,4 +56,4 @@ modusa/utils/excp.py,sha256=L9vhaGjKpv9viJYdmC9n5ndmk2GVbUBuFyZyhAQZmWY,906
 modusa/utils/logger.py,sha256=K0rsnObeNKCxlNeSnVnJeRhgfmob6riB2uyU7h3dDmA,571
 modusa/utils/np_func_cat.py,sha256=TyIFgRc6bARRMDnZxlVURO5Z0I-GWhxRONYyIv-Vwxs,1007
 modusa/utils/plot.py,sha256=s_vNdxvKfwxEngvJPgrF1PcmxZNnNaaXPViHWjyjJ-c,5335
-modusa-0.3.27.dist-info/RECORD,,
+modusa-0.3.28.dist-info/RECORD,,