modusa 0.3.52__py3-none-any.whl → 0.3.53__py3-none-any.whl

modusa/__init__.py

@@ -1,7 +1,7 @@
 from modusa.utils import excp, config
 
 #=====Giving access to plot functions to plot multiple signals.=====
-from modusa.tools import fig1d, fig2d, plot_dist, fig
+from modusa.tools import plot_dist, fig
 #=====
 
 from modusa.tools import play, convert, record

modusa/tools/__init__.py

@@ -7,7 +7,5 @@ from .audio_loader import load
 from .ann_loader import load_ann
 from .audio_recorder import record
 
-from .plotter import Figure1D as fig1d
-from .plotter import Figure2D as fig2d
 from .plotter import Fig as fig
 from .plotter import plot_dist

modusa/tools/plotter.py

@@ -36,887 +36,15 @@ def _load_devanagari_font():
 _load_devanagari_font()
 #==============
 
-#--------------------------
-# Figuure 1D
-#--------------------------
-class Figure1D:
-	"""
-	A utility class that provides easy-to-use API
-	for plotting 1D signals along with clean
-	representations of annotations, events.
-
-	
-
-	Parameters
-	----------
-	n_aux_subplots: int
-		- Total number of auxiliary subplots
-		- These include annotations and events subplots.
-		- Default: 0
-	title: str
-		- Title of the figure.
-		- Default: Title
-	xlim: tuple[number, number]
-		- xlim for the figure.
-		- All subplots will be automatically adjusted.
-		- Default: None
-	ylim: tuple[number, number]
-		- ylim for the signal.
-		- Default: None
-	"""
-	
-	def __init__(self, n_aux_subplots=0, xlim=None, ylim=None, sharex=None):
-		self._n_aux_subplots: int = n_aux_subplots
-		self._active_subplot_idx: int = 1 # Any addition will happen on this subplot (0 is reserved for reference axis)
-		if sharex is not None:
-			xlim = sharex._xlim
-		self._xlim = xlim # Many add functions depend on this, so we fix it while instantiating the class
-		self._ylim = ylim
-		self._subplots, self._fig = self._generate_subplots() # Will contain all the subplots (list, fig)
-	
-	def _get_active_subplot(self):
-		"""
-		Get the active subplot where you can add
-		either annotations or events.
-		"""
-		active_subplot = self._subplots[self._active_subplot_idx]
-		self._active_subplot_idx += 1
-		
-		return active_subplot
-		
-	def _generate_subplots(self):
-		"""
-		Generate subplots based on the configuration.
-		"""
-		
-		n_aux_subplots = self._n_aux_subplots
-		
-		# Fixed heights per subplot type
-		ref_height = 0.0
-		aux_height = 0.4
-		signal_height = 2.0
-		
-		# Total number of subplots
-		n_subplots = 1 + n_aux_subplots + 1
-		
-		# Compute total fig height
-		fig_height = ref_height + n_aux_subplots * aux_height + signal_height
-		
-		# Define height ratios
-		height_ratios = [ref_height] + [aux_height] * n_aux_subplots + [signal_height]
-		
-		# Create figure and grid
-		fig = plt.figure(figsize=(16, fig_height))
-		gs = gridspec.GridSpec(n_subplots, 1, height_ratios=height_ratios)
-		
-		# Add subplots
-		subplots_list = []
-		
-		ref_subplot = fig.add_subplot(gs[0, 0])
-		ref_subplot.axis("off")
-		subplots_list.append(ref_subplot)
-		
-		for i in range(1, n_subplots):
-			subplots_list.append(fig.add_subplot(gs[i, 0], sharex=ref_subplot))
-		
-		for i in range(n_subplots - 1):
-			subplots_list[i].tick_params(left=False, bottom=False, labelleft=False, labelbottom=False)
-		
-		
-		# Set xlim
-		if self._xlim is not None: # xlim should be applied on reference subplot, rest all sharex
-			ref_subplot.set_xlim(self._xlim)
-			
-		# Set ylim
-		if self._ylim is not None: # ylim should be applied on the signal subplot
-			subplots_list[-1].set_ylim(self._ylim)
-									
-		fig.subplots_adjust(hspace=0.01, wspace=0.05)
-			
-		return subplots_list, fig
-	
-		
-	def add_events(self, events, c="k", ls="-", lw=1.5, label="Event Label"):
-		"""
-		Add events to the figure.
-		
-		Parameters
-		----------
-		events: np.ndarray
-			- All the event marker values.
-		c: str
-			- Color of the event marker.
-			- Default: "k"
-		ls: str
-			- Line style.
-			- Default: "-"
-		lw: float
-			- Linewidth.
-			- Default: 1.5
-		label: str
-			- Label for the event type.
-			- This will appear in the legend.
-			- Default: "Event label"
-
-		Returns
-		-------
-		None
-		"""
-		event_subplot = self._get_active_subplot()
-		xlim = self._xlim
-		
-		for i, event in enumerate(events):
-			if xlim is not None:
-				if xlim[0] <= event <= xlim[1]:
-					if i == 0: # Label should be set only once for all the events
-						event_subplot.axvline(x=event, color=c, linestyle=ls, linewidth=lw, label=label)
-					else:
-						event_subplot.axvline(x=event, color=c, linestyle=ls, linewidth=lw)
-			else:
-				if i == 0: # Label should be set only once for all the events
-					event_subplot.axvline(x=event, color=c, linestyle=ls, linewidth=lw, label=label)
-				else:
-					event_subplot.axvline(x=event, color=c, linestyle=ls, linewidth=lw)
-		
-	def add_annotation(self, ann):
-		"""
-		Add annotation to the figure.
-		
-		Parameters
-		----------
-		ann : list[tuple[Number, Number, str]] | None
-			- A list of annotation spans. Each tuple should be (start, end, label).
-			- Default: None (no annotations).
-		
-		Returns
-		-------
-		None
-		"""
-		
-		ann_subplot = self._get_active_subplot()
-		xlim = self._xlim
-		
-		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 xlim is not None:
-				if start >= xlim[1] or end <= xlim[0]:
-					continue
-				
-				# Clip boundaries to xlim
-				start = max(start, xlim[0])
-				end = min(end, xlim[1])
-				
-				box_colors = ["gray", "lightgray"] # Alternates color between two
-				box_color = box_colors[i % 2]
-				
-				width = end - start
-				rect = Rectangle((start, 0), width, 1, facecolor=box_color, edgecolor="black", alpha=0.7)
-				ann_subplot.add_patch(rect)
-				
-				text_obj = ann_subplot.text(
-					(start + end) / 2, 0.5, tag,
-					ha='center', va='center',
-					fontsize=10, color="black", fontweight='bold', zorder=10, clip_on=True
-				)
-				
-				text_obj.set_clip_path(rect)
-			else:
-				box_colors = ["gray", "lightgray"] # Alternates color between two
-				box_color = box_colors[i % 2]
-				
-				width = end - start
-				rect = Rectangle((start, 0), width, 1, facecolor=box_color, edgecolor="black", alpha=0.7)
-				ann_subplot.add_patch(rect)
-				
-				text_obj = ann_subplot.text(
-					(start + end) / 2, 0.5, tag,
-					ha='center', va='center',
-					fontsize=10, color="black", fontweight='bold', zorder=10, clip_on=True
-				)
-				
-				text_obj.set_clip_path(rect)
-	
-	def add_signal(self, y, x=None, c=None, ls="-", lw=1.5, m=None, ms=3, label="Signal"):
-		"""
-		Add signal to the figure.
-			
-		Parameters
-		----------
-		y: np.ndarray
-			- Signal y values.
-		x: np.ndarray | None
-			- Signal x values.
-			- Default: None (indices will be used)
-		c: str
-			- Color of the line.
-			- Default: None
-		ls: str
-			- Linestyle
-			- Default: "-"
-		lw: Number
-			- Linewidth
-			- Default: 1
-		m: str
-			- Marker
-			- Default: None
-		ms: number
-			- Markersize
-			- Default: 5
-		label: str
-			- Label for the plot.
-			- Legend will use this.
-			- Default: "Signal"
-
-		Returns
-		-------
-		None
-		"""
-		if x is None:
-			x = np.arange(y.size)
-		signal_subplot = self._subplots[-1]
-		signal_subplot.plot(x, y, color=c, linestyle=ls, linewidth=lw, marker=m, markersize=ms, label=label)
-		
-	def add_legend(self, ypos=1.3):
-		"""
-		Add legend to the figure.
-
-		Parameters
-		----------
-		ypos: float
-			- y position from the top.
-			- > 1 to push it higher, < 1 to push it lower
-			- Default: 1.3
-		
-		Returns
-		-------
-		None
-		"""
-		subplots: list = self._subplots
-		fig = self._fig
-		
-		all_handles, all_labels = [], []
-		
-		for subplot in subplots:
-			handles, labels = subplot.get_legend_handles_labels()
-			all_handles.extend(handles)
-			all_labels.extend(labels)
-			
-		# remove duplicates if needed
-		fig.legend(all_handles, all_labels, loc='upper right', bbox_to_anchor=(0.9, ypos), ncol=2, frameon=True, bbox_transform=fig.transFigure)
-		
-	def add_meta_info(self, title=None, ylabel=None, xlabel=None, ts=13, ls=11):
-		"""
-		Add meta info to the figure.
-
-		Parameters
-		----------
-		title: str
-			- Title of the figure.
-			- Default: None
-		ylabel: str
-			- y label of the signal.
-			- It will only appear in the signal subplot.
-			- Default: None
-		xlabel: str
-			- x label of the signal.
-			- It will only appear in the signal subplot.
-			- Default: None
-		ts: Number
-			- Title size
-			- Default: 10
-		ls: Number
-			- Label size.
-			- Default: 10
-		Returns
-		-------
-		None
-		"""
-		subplots: list = self._subplots
-		fig = self._fig
-		
-		ref_subplot = subplots[0]
-		signal_subplot = subplots[-1]
-		
-		if title is not None:
-			ref_subplot.set_title(title, pad=10, size=ts)
-		if ylabel is not None:
-			signal_subplot.set_ylabel(ylabel, size=ls)
-		if xlabel is not None:
-			signal_subplot.set_xlabel(xlabel, size=ls)
-		
-		
-	def save(self, path="./figure.png"):
-		"""
-		Save the figure.
-
-		Parameters
-		----------
-		path: str
-			- Path to the output file.
-
-		Returns
-		-------
-		None
-		"""
-		fig = self._fig
-		fig.savefig(path, bbox_inches="tight")
-		
-
-#--------------------------
-# Figuure 2D
-#--------------------------
-class Figure2D:
-	"""
-	A utility class that provides easy-to-use API
-	for plotting 2D signals along with clean
-	representations of annotations, events.
-
-	
-
-	Parameters
-	----------
-	n_aux_subplots: int
-		- Total number of auxiliary subplots
-		- These include annotations and events subplots.
-		- Default: 0
-	title: str
-		- Title of the figure.
-		- Default: Title
-	xlim: tuple[number, number]
-		- xlim for the figure.
-		- All subplots will be automatically adjusted.
-		- Default: None
-	ylim: tuple[number, number]
-		- ylim for the signal.
-		- Default: None
-	"""
-	
-	def __init__(self, n_aux_subplots=0, xlim=None, ylim=None, sharex=None):
-		self._n_aux_subplots: int = n_aux_subplots
-		self._active_subplot_idx: int = 1 # Any addition will happen on this subplot (0 is reserved for reference axis)
-		if sharex is not None:
-			xlim = sharex._xlim
-		self._xlim = xlim # Many add functions depend on this, so we fix it while instantiating the class
-		self._ylim = ylim
-		self._subplots, self._fig = self._generate_subplots() # Will contain all the subplots (list, fig)
-		self._im = None # Useful while creating colorbar for the image
-		
-	def _get_active_subplot(self):
-		"""
-		Get the active subplot where you can add
-		either annotations or events.
-		"""
-		active_subplot = self._subplots[self._active_subplot_idx]
-		self._active_subplot_idx += 1
-		
-		return active_subplot
-	
-	def _calculate_extent(self, 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]
-	
-	def _add_colorbar(self, im, label=None, width="20%", height="35%"):
-		from mpl_toolkits.axes_grid1.inset_locator import inset_axes
-		
-		ref_subplot = self._subplots[0]
-		
-		# Assume ref_subplot is your reference axes, im is the image
-		cax = inset_axes(
-			ref_subplot,
-			width=width,        # width of colorbar
-			height=height,        # height of colorbar
-			loc='right',
-			bbox_to_anchor=(0, 1, 1, 1),  # move 0.9 right, 1.2 up from the subplot
-			bbox_transform=ref_subplot.transAxes,  # important: use subplot coords
-			borderpad=0
-		)
-		
-		cbar = plt.colorbar(im, cax=cax, orientation='horizontal')
-		cbar.ax.xaxis.set_ticks_position('top')
-		cbar.set_label(label, labelpad=5)
-			
-	
-		
-	def _generate_subplots(self):
-		"""
-		Generate subplots based on the configuration.
-		"""
-		
-		n_aux_subplots = self._n_aux_subplots
-		
-		# Fixed heights per subplot type
-		ref_height = 0.4
-		aux_height = 0.4
-		signal_height = 4.0
-		
-		# Total number of subplots
-		n_subplots = 1 + n_aux_subplots + 1
-		
-		# Compute total fig height
-		fig_height = ref_height + n_aux_subplots * aux_height + signal_height
-		
-		# Define height ratios
-		height_ratios = [ref_height] + [aux_height] * n_aux_subplots + [signal_height]
-		
-		# Create figure and grid
-		fig = plt.figure(figsize=(16, fig_height))
-		gs = gridspec.GridSpec(n_subplots, 1, height_ratios=height_ratios)
-		
-		# Add subplots
-		subplots_list = []
-		ref_subplot = fig.add_subplot(gs[0, 0])
-		ref_subplot.axis("off")
-		subplots_list.append(ref_subplot)
-
-		
-		for i in range(1, n_subplots):
-			subplots_list.append(fig.add_subplot(gs[i, 0], sharex=ref_subplot))
-			
-		for i in range(n_subplots - 1):
-			subplots_list[i].tick_params(left=False, bottom=False, labelleft=False, labelbottom=False)
-			
-		# Set xlim
-		if self._xlim is not None: # xlim should be applied on reference subplot, rest all sharex
-			ref_subplot.set_xlim(self._xlim)
-		
-		# Set ylim
-		if self._ylim is not None: # ylim should be applied on the signal subplot
-			subplots_list[-1].set_ylim(self._ylim)
-		
-		fig.subplots_adjust(hspace=0.01, wspace=0.05)
-		
-		return subplots_list, fig
-	
-	
-	def add_events(self, events, c="k", ls="-", lw=1.5, label="Event Label"):
-		"""
-		Add events to the figure.
-		
-		Parameters
-		----------
-		events: np.ndarray
-			- All the event marker values.
-		c: str
-			- Color of the event marker.
-			- Default: "k"
-		ls: str
-			- Line style.
-			- Default: "-"
-		lw: float
-			- Linewidth.
-			- Default: 1.5
-		label: str
-			- Label for the event type.
-			- This will appear in the legend.
-			- Default: "Event label"
-
-		Returns
-		-------
-		None
-		"""
-		event_subplot = self._get_active_subplot()
-		xlim = self._xlim
-		
-		for i, event in enumerate(events):
-			if xlim is not None:
-				if xlim[0] <= event <= xlim[1]:
-					if i == 0: # Label should be set only once for all the events
-						event_subplot.axvline(x=event, color=c, linestyle=ls, linewidth=lw, label=label)
-					else:
-						event_subplot.axvline(x=event, color=c, linestyle=ls, linewidth=lw)
-			else:
-				if i == 0: # Label should be set only once for all the events
-					event_subplot.axvline(x=event, color=c, linestyle=ls, linewidth=lw, label=label)
-				else:
-					event_subplot.axvline(x=event, color=c, linestyle=ls, linewidth=lw)
-					
-	def add_annotation(self, ann):
-		"""
-		Add annotation to the figure.
-		
-		Parameters
-		----------
-		ann : list[tuple[Number, Number, str]] | None
-			- A list of annotation spans. Each tuple should be (start, end, label).
-			- Default: None (no annotations).
-		
-		Returns
-		-------
-		None
-		"""
-		ann_subplot = self._get_active_subplot()
-		xlim = self._xlim
-		
-		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 xlim is not None:
-				if start >= xlim[1] or end <= xlim[0]:
-					continue
-				
-				# Clip boundaries to xlim
-				start = max(start, xlim[0])
-				end = min(end, xlim[1])
-					
-				box_colors = ["gray", "lightgray"] # Alternates color between two
-				box_color = box_colors[i % 2]
-				
-				width = end - start
-				rect = Rectangle((start, 0), width, 1, facecolor=box_color, edgecolor="black", alpha=0.7)
-				ann_subplot.add_patch(rect)
-				
-				text_obj = ann_subplot.text(
-					(start + end) / 2, 0.5, tag,
-					ha='center', va='center',
-					fontsize=10, color="black", fontweight='bold', zorder=10, clip_on=True
-				)
-				
-				text_obj.set_clip_path(rect)
-			else:
-				box_colors = ["gray", "lightgray"] # Alternates color between two
-				box_color = box_colors[i % 2]
-				
-				width = end - start
-				rect = Rectangle((start, 0), width, 1, facecolor=box_color, edgecolor="black", alpha=0.7)
-				ann_subplot.add_patch(rect)
-				
-				text_obj = ann_subplot.text(
-					(start + end) / 2, 0.5, tag,
-					ha='center', va='center',
-					fontsize=10, color="black", fontweight='bold', zorder=10, clip_on=True
-				)
-				
-				text_obj.set_clip_path(rect)
-				
-	def add_matrix(self, M, y=None, x=None, c="gray_r", o="lower", label="Matrix"):
-		"""
-		Add matrix to the figure.
-			
-		Parameters
-		----------
-		M: np.ndarray
-			- Matrix (2D) array
-		y: np.ndarray | None
-			- y axis values.
-		x: np.ndarray | None (indices will be used)
-			- x axis values.
-			- Default: None (indices will be used)
-		c: str
-			- cmap for the matrix.
-			- Default: None
-		o: str
-			- origin
-			- Default: "lower"
-		label: str
-			- Label for the plot.
-			- Legend will use this.
-			- Default: "Signal"
-		
-		Returns
-		-------
-		None
-		"""
-		if x is None: x = np.arange(M.shape[1])
-		if y is None: y = np.arange(M.shape[0])
-			
-		matrix_subplot = self._subplots[-1]
-		extent = self._calculate_extent(x, y)
-		im = matrix_subplot.imshow(M, aspect="auto", origin=o, cmap=c, extent=extent)
-		
-		self._add_colorbar(im=im, label=label)
-	
-	def add_signal(self, y, x=None, c=None, ls="-", lw=1.5, m="o", ms=3, label="Signal"):
-		"""
-		Add signal on the matrix.
-			
-		Parameters
-		----------
-		y: np.ndarray
-			- Signal y values.
-		x: np.ndarray | None
-			- Signal x values.
-			- Default: None (indices will be used)
-		c: str
-			- Color of the line.
-			- Default: None
-		ls: str
-			- Linestyle
-			- Default: "-"
-		lw: Number
-			- Linewidth
-			- Default: 1
-		m: str
-			- Marker
-			- Default: None
-		ms: number
-			- Markersize
-			- Default: 5
-		label: str
-			- Label for the plot.
-			- Legend will use this.
-			- Default: "Signal"
-		
-		Returns
-		-------
-		None
-		"""
-		if x is None:
-			x = np.arange(y.size)
-		matrix_subplot = self._subplots[-1]
-		matrix_subplot.plot(x, y, color=c, linestyle=ls, linewidth=lw, marker=m, markersize=ms, label=label)
-		
-	
-			
-	def add_legend(self, ypos=1.1):
-		"""
-		Add legend to the figure.
-
-		Parameters
-		----------
-		ypos: float
-			- y position from the top.
-			- > 1 to push it higher, < 1 to push it lower
-			- Default: 1.3
-		
-		Returns
-		-------
-		None
-		"""
-		subplots: list = self._subplots
-		fig = self._fig
-		
-		all_handles, all_labels = [], []
-		
-		for subplot in subplots:
-			handles, labels = subplot.get_legend_handles_labels()
-			all_handles.extend(handles)
-			all_labels.extend(labels)
-			
-		# remove duplicates if needed
-		fig.legend(all_handles, all_labels, loc='upper right', bbox_to_anchor=(0.9, ypos), ncol=2, frameon=True, bbox_transform=fig.transFigure)
-		
-	def add_meta_info(self, title=None, ylabel=None, xlabel=None, ts=13, ls=11):
-		"""
-		Add meta info to the figure.
-		
-		Parameters
-		----------
-		title: str
-			- Title of the figure.
-			- Default: None
-		ylabel: str
-			- y label of the signal.
-			- It will only appear in the signal subplot.
-			- Default: None
-		xlabel: str
-			- x label of the signal.
-			- It will only appear in the signal subplot.
-			- Default: None
-		ts: Number
-			- Title size
-			- Default: 10
-		ls: Number
-			- Label size.
-			- Default: 10
-		
-		Returns
-		-------
-		None
-		"""
-		subplots: list = self._subplots
-		fig = self._fig
-		
-		ref_subplot = subplots[0]
-		signal_subplot = subplots[-1]
-		
-		if title is not None:
-			ref_subplot.set_title(title, pad=10, size=ts)
-		if ylabel is not None:
-			signal_subplot.set_ylabel(ylabel, size=ls)
-		if xlabel is not None:
-			signal_subplot.set_xlabel(xlabel, size=ls)
-		
-	def save(self, path="./figure.png"):
-		"""
-		Save the figure.
-
-		Parameters
-		----------
-		path: str
-			- Path to the output file.
-
-		Returns
-		-------
-		None
-		"""
-		fig = self._fig
-		fig.savefig(path, bbox_inches="tight")
-		
-
-
-#======== 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, bins=30):
-		"""
-		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.
-		bins: int
-			- The number of bins for histogram.
-			- This is used only to plot the histogram.
-
-		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 = np.linspace(np.min(data), np.max(data), npoints)
-			y = kde(x)
-			
-			if legend is not None:
-				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, 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 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)
-				
-				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
-	
-
 class Fig:
 	"""
-	
+	A utility class that provides easy-to-use API for 
+	plotting 1D/2D signals along with clean representations 
+	of annotations, events.
 	"""
 	
 	def __init__(self, arrangement="asm", xlim=None):
-
+		
 		self._xlim = xlim
 		self._curr_row_idx = 1 # Starting from 1 because row 0 is reserved for reference subplot
 		self._curr_color_idx = 0 # So that we have different color across all the subplots to avoid legend confusion
@@ -924,7 +52,7 @@ class Fig:
 		# Subplot setup
 		self._fig, self._axs = self._generate_subplots(arrangement) # This will fill in the all the above variables
 		
-	
+		
 	def _get_curr_row(self):
 		"""
 		Get the active row where you can add
@@ -957,7 +85,7 @@ class Fig:
 			
 		return [x[0] - dx / 2, x[-1] + dx / 2, y[0] - dy / 2, y[-1] + dy / 2]
 	
-		
+	
 	def _generate_subplots(self, arrangement):
 		"""
 		Generate subplots based on the configuration.
@@ -983,7 +111,7 @@ class Fig:
 		# Calculate height ratios list based on the arrangement
 		for char in arrangement:
 			height_ratios = [height[char] for char in arrangement]
-		
+			
 		# Calculate total fig height
 		fig_height = height["r"] + (n_aux_sp * height["a"]) + (n_signal_sp * height["s"]) + (n_matrix_sp * height["m"])
 		
@@ -1005,17 +133,17 @@ class Fig:
 			elif char == "m":
 				axs[i, 0].grid(True, linestyle=':', linewidth=0.7, color='gray', alpha=0.7)
 				axs[i, 0].tick_params(bottom=False, labelbottom=False)
-			
+				
 			axs[i, 0].sharex(axs[0, 0])
-			
+		
 		axs[-1, 0].tick_params(bottom=True, labelbottom=True)
 		
 		# xlim should be applied on reference subplot, rest all subplots will automatically adjust
 		if xlim is not None:
 			axs[0, 0].set_xlim(xlim)
-					
+			
 		fig.subplots_adjust(hspace=0.2, wspace=0.05)
-
+		
 		return fig, axs
 	
 	def add_signal(self, y, x=None, c=None, ls=None, lw=None, m=None, ms=3, label=None, ylabel=None, ylim=None, ax=None):
@@ -1068,7 +196,7 @@ class Fig:
 		if x is None: x = np.arange(y.size)
 		
 		if c is None: c = self._get_new_color()
-
+		
 		curr_row[0].plot(x, y, color=c, linestyle=ls, linewidth=lw, marker=m, markersize=ms, label=label)
 		
 		if ylabel is not None: curr_row[0].set_ylabel(ylabel)
@@ -1117,7 +245,7 @@ class Fig:
 		"""
 		if x is None: x = np.arange(M.shape[1])
 		if y is None: y = np.arange(M.shape[0])
-
+		
 		curr_row = self._get_curr_row() if ax is None else self._axs[ax]
 		
 		extent = self._calculate_extent(x, y)
@@ -1131,8 +259,8 @@ class Fig:
 			cbar = plt.colorbar(im, cax=curr_row[1])
 			if label is not None:
 				cbar.set_label(label, labelpad=5)
-		
-		
+				
+				
 	def add_events(self, events, c=None, ls=None, lw=None, label=None, ax=None):
 		"""
 		Add events to the figure.
@@ -1164,9 +292,9 @@ class Fig:
 		"""
 		
 		curr_row = self._get_curr_row() if ax is None else self._axs[ax]
-			
+		
 		if c is None: c = self._get_new_color()
-			
+		
 		xlim = self._xlim
 		
 		for i, event in enumerate(events):
@@ -1203,7 +331,7 @@ class Fig:
 		None
 		"""
 		curr_row = self._get_curr_row() if ax is None else self._axs[ax]
-			
+		
 		xlim = self._xlim
 		
 		for i, (start, end, tag) in enumerate(ann):
@@ -1250,7 +378,7 @@ class Fig:
 			curr_row[0].set_ylabel(label, rotation=0, ha="center", va="center")
 			curr_row[0].yaxis.set_label_position("right")
 			curr_row[0].yaxis.set_label_coords(1.05, 0.75)
-				
+			
 	def add_legend(self, ypos=1.0):
 		"""
 		Add legend to the figure.
@@ -1297,8 +425,8 @@ class Fig:
 		
 		if title is not None:
 			ref_ax.set_title(title, pad=10, size=s)
-	
-		
+			
+			
 	def add_xlabel(self, xlabel=None, s=None):
 		"""
 		Add shared x-label to the figure.
@@ -1316,7 +444,7 @@ class Fig:
 		ref_ax = axs[-1, 0] # X-label is added to the last subplot
 		if xlabel is not None:
 			ref_ax.set_xlabel(xlabel, size=s)
-	
+			
 	def add_xticks():
 		raise NotImplementedError("Please raise a github issue `https://github.com/meluron-toolbox/modusa/issues`")
 		
@@ -1335,6 +463,155 @@ class Fig:
 		"""
 		fig = self._fig
 		fig.savefig(path, bbox_inches="tight")
+		
+
+
+#======== 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, bins=30):
+		"""
+		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.
+		bins: int
+			- The number of bins for histogram.
+			- This is used only to plot the histogram.
+
+		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 = np.linspace(np.min(data), np.max(data), npoints)
+			y = kde(x)
+			
+			if legend is not None:
+				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, 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 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)
+				
+				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.52.dist-info → modusa-0.3.53.dist-info}/METADATA

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

{modusa-0.3.52.dist-info → modusa-0.3.53.dist-info}/RECORD

@@ -1,9 +1,9 @@
-modusa-0.3.52.dist-info/METADATA,sha256=8HFh6KCZ9E82bUa9vvfoW3gmGauYsciPJcgmW8L1jCg,1436
-modusa-0.3.52.dist-info/WHEEL,sha256=9P2ygRxDrTJz3gsagc0Z96ukrxjr-LFBGOgv3AuKlCA,90
-modusa-0.3.52.dist-info/entry_points.txt,sha256=fmKpleVXj6CdaBVL14WoEy6xx7JQCs85jvzwTi3lePM,73
-modusa-0.3.52.dist-info/licenses/LICENSE.md,sha256=JTaXAjx5awk76VArKCx5dUW8vmLEWsL_ZlR7-umaHbA,1078
+modusa-0.3.53.dist-info/METADATA,sha256=hiJs3x9W5XEj9aBYaje0gwt5imC6tnc54MKBd221MFo,1436
+modusa-0.3.53.dist-info/WHEEL,sha256=9P2ygRxDrTJz3gsagc0Z96ukrxjr-LFBGOgv3AuKlCA,90
+modusa-0.3.53.dist-info/entry_points.txt,sha256=fmKpleVXj6CdaBVL14WoEy6xx7JQCs85jvzwTi3lePM,73
+modusa-0.3.53.dist-info/licenses/LICENSE.md,sha256=JTaXAjx5awk76VArKCx5dUW8vmLEWsL_ZlR7-umaHbA,1078
 modusa/.DS_Store,sha256=_gm6qJREwfMi8dE7n5S89_RG46u5t3xHyD-smNhtNoM,6148
-modusa/__init__.py,sha256=_Fk3GxsI0GT-uhsZaHgs6p5YcIkqPGb3s78_dzFy1lE,291
+modusa/__init__.py,sha256=RMIKAZZ27w1oh2UFMJvZQtQ-SluIQsac_3mSK_LaM30,277
 modusa/config.py,sha256=bTqK4t00FZqERVITrxW_q284aDDJAa9aMSfFknfR-oU,280
 modusa/decorators.py,sha256=8zeNX_wE37O6Vp0ysR4-WCZaEL8mq8dyCF_I5DHOzks,5905
 modusa/devtools/generate_docs_source.py,sha256=UDflHsk-Yh9-3YJTVBzKL32y8hcxiRgAlFEBTMiDqwM,3301
@@ -41,7 +41,7 @@ modusa/models/t_ax.py,sha256=ZUhvZPUW1TkdZYuUd6Ucm-vsv0JqtZ9yEe3ab67Ma6w,8022
 modusa/models/tds.py,sha256=FAGfibjyyE_lkEuQp-vSCuqQnopOjmy_IXqUjRlg9kc,11677
 modusa/plugins/__init__.py,sha256=r1Bf5mnrVKRIwxboutY1iGzDy4EPQhqpk1kSW7iJj_Q,54
 modusa/plugins/base.py,sha256=Bh_1Bja7fOymFsCgwhXDbV6ys3D8muNrPwrfDrG_G_A,2382
-modusa/tools/__init__.py,sha256=s3Yfr4FbfZCXwfyy4uPHDfZ4lqf8XZqgH5KlKUVwQpM,373
+modusa/tools/__init__.py,sha256=TfIlnbSRVEk8C9YY6H5y0qiaKttFV_X3m6nI2qPYUH0,295
 modusa/tools/_plotter_old.py,sha256=KGow7mihA2H1WNq7s5bpivhCgGo2qVIeDaO6iabpsrg,19294
 modusa/tools/ann_loader.py,sha256=RePlwD4qG6gGrD4mOJ3RDR9q_gUscCY90_R9lgFU9lM,780
 modusa/tools/audio_converter.py,sha256=415qBoPm2sBIuBSI7m1XBKm0AbmVmPydIPPr-uO8D3c,1778
@@ -50,7 +50,7 @@ modusa/tools/audio_player.py,sha256=GP04TWW4jBwQBjANkfR_cJtEy7cIhvbu8RTwnf9hD6E,
 modusa/tools/audio_recorder.py,sha256=d2fVt0Sd2tlBdb2WlUs60K4N23zuxM3KUpQqX0ifPi8,2769
 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=a9C8yh7RoX0XyubflYflKupN5EllvCwl7ZYYL6ENwWM,35040
+modusa/tools/plotter.py,sha256=sMJ0PfiRwfw_dUVTLtH1Oed4lOiwR06foAlDljhh3QA,16911
 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
@@ -59,4 +59,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.52.dist-info/RECORD,,
+modusa-0.3.53.dist-info/RECORD,,