Update changelog, efX-SDK, and logging path

Author: tparkerd

HISTORY.rst

@@ -2,6 +2,25 @@
 History
 =======
 
+0.2.0 (2021-01-04)
+------------------
+
+* Added efX-SDK library
+* Added module to export/convert `nsihdr` files to uint `raw` files using the efX-SDK (Windows only)
+* Tentatively implemented a GUI for the nsihdr2raw export tool
+* Tweaked logging path for log files generated relative to input data for `nsihdr2raw`
+
+0.1.4 (2020-10-27)
+------------------
+
+* Code clean up, remove unnecessary transposing of data, improved debug statements and logging
+
+0.1.3 (2020-10-26)
+------------------
+
+* Fixed font file missing when installing via pip
+
+
 0.1.2 (2020-09-25)
 ------------------
 
@@ -10,4 +29,4 @@ History
 0.1.0 (2020-06-19)
 ------------------
 
-* First release on PyPI.
+* Initial version

rawtools/cli.py

@@ -62,13 +62,13 @@ def raw_generate():
     generate.main(args)
 
 def raw_nsihdr():
-    description = "This tool converts a NSI project from 32-bit float to 16-bit unsigned integer format, and it extracts the midslice and generates a side-view projection of the volume."
+    description = "This tool converts a NSI project from 32-bit float to 16-bit unsigned integer format."
 
     parser = argparse.ArgumentParser(description=description, formatter_class=argparse.ArgumentDefaultsHelpFormatter)
     parser.add_argument("-V", "--version", action="version", version=f'%(prog)s {__version__}')
     parser.add_argument("-v", "--verbose", action="store_true", help="Increase output verbosity")
     parser.add_argument("-f", "--force", action="store_true", default=False, help="Force file creation. Overwrite any existing files.")
-    parser.add_argument("--gui", action="store_true", default=False, help="Enable GUI")
+    parser.add_argument("--gui", action="store_true", default=False, help="(Experimental) Enable GUI")
     parser.add_argument('path', metavar='PATH', type=str, nargs="+", help='List of .nsihdr files')
     args = parser.parse_args()
 

rawtools/gui/nsihdr.py

@@ -13,11 +13,6 @@
 
 __version__ = version('rawtools')
 
-class GuiState(Enum):
-	IDLE = 1
-	PROCESSING = 2
-	ERROR = 3
-
 def center(root, toplevel):
 	toplevel.update_idletasks()
 
@@ -37,13 +32,12 @@ def center(root, toplevel):
 
 class App():
 	def __init__(self, args):
-		self.source = 'C:/Users/Tim Parker/Datasets/topp/xrt/development/batch-export'
+		self.source = 'C:/Users/Tim Parker/Datasets/topp/xrt/development/batch2'
 		self.args = args
 		# Source: https://www.elegantthemes.com/blog/freebie-of-the-week/beautiful-flat-icons-for-free
 		self.icon_fp = "rawtools\\assets\\tools.ico"
 		self.icon_caution_fp = "rawtools\\assets\\caution.ico"
-		self.state = GuiState.IDLE
-
+		self.state = 'idle'
 
 		self.root = ThemedTk(theme='arc')
 		root = self.root
@@ -209,11 +203,11 @@ def export(self):
 			self.prompt.title(prompt_title)
 			self.prompt.iconbitmap(self.icon_fp)
 			self.prompt.resizable(False, False)
-			self.prompt_frame = ttk.Frame(self.prompt, padding="16 16")
-			self.prompt_frame.grid(column=0, row=0, sticky=(N, S, E, W))
-			self.prompt_message = ttk.Label(self.prompt_frame, text=prompt_message).grid(row = 0, column = 0, columnspan=4, pady="0 32")
-			self.prompt_button = ttk.Button(self.prompt_frame, text="Ok", command=self.dismiss).grid(row = 1, column = 1, columnspan=1)
-			self.prompt_button = ttk.Button(self.prompt_frame, text="Cancel", command=self.cancel_export).grid(row = 1, column = 2, columnspan=1)
+			prompt_frame = ttk.Frame(self.prompt, padding="16 16")
+			prompt_frame.grid(column=0, row=0, sticky=(N, S, E, W))
+			self.prompt_message = ttk.Label(prompt_frame, text=prompt_message).grid(row = 0, column = 0, columnspan=4, pady="0 32")
+			self.prompt_button = ttk.Button(prompt_frame, text="Ok", command=self.dismiss).grid(row = 1, column = 1, columnspan=1)
+			self.prompt_button = ttk.Button(prompt_frame, text="Cancel", command=self.cancel_export).grid(row = 1, column = 2, columnspan=1)
 
 			# Orient window on screen
 			center(self.root, self.prompt)
@@ -224,11 +218,14 @@ def export(self):
 			self.prompt.grab_set()
 			self.prompt.wait_window()
 
+			self.prompt_frame.grid_forget()
+			self.prompt = None
+
 		# Process data
 		if not self.cancelled:
 			# Do processing
 			logging.debug(self.args)
-			self.args.gui_window = self.root
+			self.args.app = self
 			nsihdr.main(self.args)
 		else:
 			logging.debug(f"Cancelled export")
@@ -254,3 +251,8 @@ def cancel_export(self):
 	def dismiss(self):
 		self.prompt.grab_release()
 		self.prompt.destroy()
+
+	def dismiss_progress_prompt(self):
+		self.progress_bar_prompt.grab_release()
+		self.progress_bar_prompt.destroy()
+

rawtools/lib/win32/efX-SDK-Static.lib

@@ -22,7 +22,15 @@ def configure(args):
 	# Set project-level logging
 	if args.module_name is not None:
 		logfile_basename = f"{dt.today().strftime('%Y-%m-%d_%H-%M-%S')}_{args.module_name}.log"
-	lfp = os.path.join(os.path.realpath(os.path.dirname(args.path[0])), logfile_basename) # base log file path
+	rpath = os.path.realpath(args.path[0])
+	logging.info(f"{rpath=}")
+	if os.path.isdir(rpath):
+		dname = rpath
+	else:
+		dname = os.path.dirname(rpath)
+	logging.info(f"{dname=}")
+	lfp = os.path.join(dname, logfile_basename) # base log file path
+	logging.info(f"{lfp=}")
 	fileHandler = logging.FileHandler(lfp)
 	fileHandler.setFormatter(logFormatter)
 	fileHandler.setLevel(logging.DEBUG) # always show debug statements in log file

rawtools/lib/win32/efX-SDK.dll

@@ -3,17 +3,20 @@
 """NSIHDR to RAW Batch Converter"""
 import logging
 import os
-import re
 import sys
+import tkinter as tk
 from multiprocessing import Pool, cpu_count
 from pprint import pformat
 from time import time
-
+from tkinter import (E, N, S, StringVar, Toplevel, W, filedialog, messagebox,
+                     ttk)
+import threading
 import numpy as np
 from tqdm import tqdm
 
 from rawtools import dat
 from rawtools.convert import scale
+from rawtools.gui import nsihdr
 
 # Load in NSI SDK
 currentdir = os.path.dirname(os.path.realpath(__file__))
@@ -22,6 +25,34 @@
 sys.path.append(includesdir)
 from rawtools import nsiefx
 
+# def check_progress(amount):
+# 	logging.info(amount)
+# 	# progress_text.set(str(round(total_slices_processed / args.total_slice_count * 100.0, 1)))
+# 	progress_text.set(str(total_slices_processed))
+# 	progress['value'] = total_slices_processed
+# 	logging.info(f"{progress_text.get()=}")
+
+
+def update_progress(increment):
+	logging.debug(f"{increment=}")
+
+def start_progress_thread(event, pbar, root):
+	global progress_thread
+	progress_thread = threading.Thread(target=update_progress, args=(1,))
+	progress_thread.daemon = True
+	# pbar.start()
+	progress_thread.start()
+	root.after(20, check_progress_thread(pbar, root))
+
+def check_progress_thread(pbar, root):
+	if progress_thread.is_alive():
+		logging.info("Pbar is alive")
+		root.after(20, check_progress_thread)
+	else:
+		logging.info("Pbar is done")
+		pbar.stop()
+
+
 def process(args, fp, export_path):
 	"""Converts NSIHDR files to a single .RAW + .DAT
 
@@ -32,6 +63,9 @@ def process(args, fp, export_path):
 		export_path (str): filepath to output .RAW file
 	"""
 	logging.debug(f'{fp=}')
+	total_slices_processed = 0
+	progress = None
+	check_progress = None
 
 	with nsiefx.open(fp) as volume:
 		v = volume # for shorthand laziness
@@ -52,7 +86,6 @@ def process(args, fp, export_path):
 		bname = os.path.basename(os.path.splitext(fp)[0])
 		dat_path = os.path.join(dname, f'{bname}.dat')
 
-
 		if os.path.exists(export_path) and args.force == True:
 			os.remove(export_path)
 			logging.warning(f"Removed old '{export_path}'")
@@ -63,6 +96,7 @@ def process(args, fp, export_path):
 		dat.write(dat_path, dimensions = (width, height, depth), thickness = voxel_size)
 		logging.debug(f"Generated '{dat_path}'")
 
+		pbar = None
 		with open(export_path, 'ab') as raw_ofp:
 			if not args.verbose:
 				pbar = tqdm(total= depth, desc=f"Exporting {bname}")
@@ -72,8 +106,11 @@ def process(args, fp, export_path):
 				cross_section = scale(cross_section, data_min, data_max, 0, 65535).astype(np.uint16)
 				cross_section.tofile(raw_ofp)
 
+				total_slices_processed += 1
+
 				if not args.verbose:
 					pbar.update()
+				# logging.debug(f"Processed {total_slices_processed}")
 			if not args.verbose:
 				pbar.close()
 
@@ -141,9 +178,54 @@ def main(args):
 		logging.error(err)
 		raise err
 	else:
+
+		# GUI Implementation
+		if args.gui:
+			# Determine the number of slices in advance
+			args.total_slice_count = 0
+			for fp in args.files:
+				with nsiefx.open(fp) as volume:
+					args.total_slice_count += volume.num_slices()
+			
+			# Initialize progress bar
+			progress_bar_prompt_title = "Placeholder Progress Bar"
+			app = args.app
+			root = app.root
+			icon_fp = app.icon_fp
+			progress_bar_prompt = Toplevel(root)
+			progress_bar_prompt.title(progress_bar_prompt_title)
+			progress_bar_prompt.iconbitmap(icon_fp)
+			progress_bar_prompt.resizable(False, False)
+			progress_bar_prompt_frame = ttk.Frame(progress_bar_prompt, padding="16 16")
+			progress_bar_prompt_frame.grid(column=0, row=0, sticky=(N, S, E, W))
+
+			progress = ttk.Progressbar(progress_bar_prompt_frame, orient='horizontal', mode='indeterminate', length=200, max=args.total_slice_count)
+			progress.grid(row=0, column=0, columnspan=2, pady="0 16", sticky=(E,W))
+			progress_text = tk.StringVar()
+			progress_text_label = ttk.Label(progress_bar_prompt_frame, textvariable=progress_text, width=7)
+			progress_text_label.grid(row=0, column=3, columnspan=1, pady="0 16", sticky=E, padx="8 0")
+			progress_text.set('0%')
+
+			def dismiss_progress_prompt():
+				progress_bar_prompt.grab_release()
+				progress_bar_prompt.destroy()
+
+			# Orient window on screen
+			nsihdr.center(root, progress_bar_prompt)
+			# Disable interaction with parent window
+			progress_bar_prompt.protocol("WM_DELETE_WINDOW", dismiss_progress_prompt)
+			progress_bar_prompt.transient(root)
+			progress_bar_prompt.wait_visibility()
+			progress_bar_prompt.grab_set()
+			progress_bar_prompt.wait_window()
+			start_progress_thread(None, progress, root)
+			
+		# CLI Implementation
 		# For each provided volume...
+		pbar = None
 		if not args.verbose:
 			pbar = tqdm(total = len(args.files), desc=f"Overall progress")
+
 		for fp in args.files:
 			logging.debug(f"Processing '{fp}'")
 			dname = os.path.dirname(fp)