modusa 0.3.48__py3-none-any.whl → 0.3.51__py3-none-any.whl

modusa/tools/plotter.py

@@ -915,14 +915,14 @@ class Fig:
 	
 	"""
 	
-	def __init__(self, arrangement="asm", title="Untitled", xlabel="Time (sec)", xlim=None):
+	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
 		
 		# Subplot setup
-		self._fig, self._axs = self._generate_subplots(arrangement, title, xlabel) # This will fill in the all the above variables
+		self._fig, self._axs = self._generate_subplots(arrangement) # This will fill in the all the above variables
 		
 	
 	def _get_curr_row(self):
@@ -958,7 +958,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, title, xlabel):
+	def _generate_subplots(self, arrangement):
 		"""
 		Generate subplots based on the configuration.
 		"""
@@ -1013,12 +1013,6 @@ class Fig:
 		# xlim should be applied on reference subplot, rest all subplots will automatically adjust
 		if xlim is not None:
 			axs[0, 0].set_xlim(xlim)
-			
-		# Set title and label
-		if title is not None:
-			axs[0, 0].set_title(title)
-		if xlabel is not None:
-			axs[-1, 0].set_xlabel(xlabel)
 					
 		fig.subplots_adjust(hspace=0.2, wspace=0.05)
 
@@ -1103,7 +1097,7 @@ class Fig:
 		label: str
 			- Label for the plot.
 			- Legend will use this.
-			- Default: "Signal"
+			- Default: None
 		ylabel: str
 			- y-label for the plot.
 			- Default: None
@@ -1159,7 +1153,7 @@ class Fig:
 		label: str
 			- Label for the event type.
 			- This will appear in the legend.
-			- Default: "Event label"
+			- Default: None
 		ax: int
 			- Which specific axis to plot (1, 2, 3, ...)
 			- None
@@ -1188,7 +1182,7 @@ class Fig:
 				else:
 					curr_row[0].axvline(x=event, color=c, linestyle=ls, linewidth=lw)
 					
-	def add_annotation(self, ann, ax=None):
+	def add_annotation(self, ann, label=None, ax=None):
 		"""
 		Add annotation to the figure.
 		
@@ -1197,6 +1191,10 @@ class Fig:
 		ann : list[tuple[Number, Number, str]] | None
 			- A list of annotation spans. Each tuple should be (start, end, label).
 			- Default: None (no annotations).
+		label: str
+			- Label for the annotation type.
+			- This will appear to the right of the aux plot.
+			- Default: None
 		ax: int
 			- Which specific axis to plot (1, 2, 3, ...)
 			- None
@@ -1248,6 +1246,11 @@ class Fig:
 				
 				text_obj.set_clip_path(rect)
 				
+		if label is not None:
+			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.
@@ -1276,6 +1279,47 @@ class Fig:
 		# remove duplicates if needed
 		fig.legend(all_handles, all_labels, loc='upper right', bbox_to_anchor=(0.95, ypos), ncol=2, frameon=True, bbox_transform=fig.transFigure)
 		
+	def add_title(self, title=None, s=13):
+		"""
+		Add title to the figure.
+
+		Parameters
+		----------
+		title: str | None
+			- Title of the figure.
+			- Default: None
+		s: Number
+			- Font size.
+			- Default: None
+		"""
+		axs = self._axs
+		ref_ax = axs[0, 0] # Title is added to the top subplot (ref subplot)
+		
+		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.
+
+		Parameters
+		----------
+		xlabel: str | None
+			- xlabel for the figure.
+			- Default: None
+		s: Number
+			- Font size.
+			- Default: None
+		"""
+		axs = self._axs
+		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`")
+		
 	def save(self, path="./figure.png"):
 		"""
 		Save the figure.

{modusa-0.3.48.dist-info → modusa-0.3.51.dist-info}/METADATA

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

{modusa-0.3.48.dist-info → modusa-0.3.51.dist-info}/RECORD

@@ -1,7 +1,7 @@
-modusa-0.3.48.dist-info/METADATA,sha256=DSekUaJ0SlHH0mQVGSiFaMP6dKPX6AT2JwNdwdZtLD0,1436
-modusa-0.3.48.dist-info/WHEEL,sha256=9P2ygRxDrTJz3gsagc0Z96ukrxjr-LFBGOgv3AuKlCA,90
-modusa-0.3.48.dist-info/entry_points.txt,sha256=fmKpleVXj6CdaBVL14WoEy6xx7JQCs85jvzwTi3lePM,73
-modusa-0.3.48.dist-info/licenses/LICENSE.md,sha256=JTaXAjx5awk76VArKCx5dUW8vmLEWsL_ZlR7-umaHbA,1078
+modusa-0.3.51.dist-info/METADATA,sha256=Z_j4qx-H1R16_hDhBJDu-fv8WBFcHfUsQGzN9zOanC4,1436
+modusa-0.3.51.dist-info/WHEEL,sha256=9P2ygRxDrTJz3gsagc0Z96ukrxjr-LFBGOgv3AuKlCA,90
+modusa-0.3.51.dist-info/entry_points.txt,sha256=fmKpleVXj6CdaBVL14WoEy6xx7JQCs85jvzwTi3lePM,73
+modusa-0.3.51.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/config.py,sha256=bTqK4t00FZqERVITrxW_q284aDDJAa9aMSfFknfR-oU,280
@@ -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=Yt85kVt5kiWmmExQmupI1RpqTI6NiK0_vsDI22J9u9I,34040
+modusa/tools/plotter.py,sha256=KD15NHcOU-vA-12VTk5qYYXuiSdhCpwd2QFjkx76I4E,35040
 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.48.dist-info/RECORD,,
+modusa-0.3.51.dist-info/RECORD,,