Finalise README

README.md

@@ -0,0 +1,39 @@
+# Ionization Probe Analysis Code
+
+> Written by Cal Wing (<c.wing@uq.net.au> - 45811953) in 2024 for his Thesis
+
+## Installation
+
+Run `pip install -r requirements.txt` or equivilient for your envoroment.
+
+## Running
+
+Run `main.py` it will then generate all the output graphs and put them in (a git untracked) folder called `./images`.
+
+By default all data graphs will be generated - you need to change the functions called at the end in the `if '__name__ == '__main__':` section.
+
+## `./data` Explanation
+
+I like YAML files to store information. All the data shot folders have a file call `_info.yaml` this file contained all the info about the shot so that when it would load & be graphed it would be correct.
+
+I hope the values are self explanatory but they may not - sorry
+
+## Changes to [canny_shock_finder.py](./canny_shock_finder.py)
+
+Basically I hacked in an extra argument `print_func`, that is used to override the `print` function in the file. It assumes its either a callable reference (like print, the default) or None (it then uses a no-operation function to silence all output)
+
+I also removed the error catching around lines ~497 so the function blindly continues if it can't graph.
+
+I also enabled grid lines on the graphs.
+
+The UQ colours being used on the graphs is due to some funky ~~abuse~~ *utlitly* I built into my [`makeGraph`](#makegraph) library.
+
+## MakeGraph
+
+> This refers to the [makeGraph.py](./makeGraph.py) file/version *in this code base*, I would not trust the exact specifics for versions found elsewhere, but the general gist is the same.
+
+A *long* time ago I wrote a wrapper for matplotlib that has expanded into a formatting tool. The crux of it is that I can throw a dictionary at the `makeGraph` function and it will do all the hard work for me.
+
+There are a few fun things that loading the lib will do - like overriding the default colour cyclers to use only the UQ colours - so if your going to liberate / adapt it be wary.
+
+All the graphing done in the [`main.py`](./main.py) uses makeGraph, its not the most scary thing in the world as its basically ~~AI~~ *a big if conditional*.

canny_shock_finder.py

@@ -15,7 +15,7 @@ Chris James (c.james4@uq.edu.au) - 04/07/17
 
 # Amened by Cal Wing to make the function not print
 
-VERSION_STRING = "17-Oct-2024"
+VERSION_STRING = "20-Oct-2024"
 
 def canny_shock_finder(time_list, pressure_list, sigma = 4, derivative_threshold = 0.001, auto_derivative = False, post_suppression_threshold = 0.05,
                        post_shock_pressure = None, start_time = None, find_second_peak = None, plot = True, plot_scale_factor = None,
@@ -116,6 +116,8 @@ def canny_shock_finder(time_list, pressure_list, sigma = 4, derivative_threshold
     :param plot_time_scale: See plot_time_unit above. These two inputs allow the results plot to be in a different
         time unit to the original data. The user must specify this scale to connect the original and plotted
         time units. Defaults to 1.0 (so no change if time units are seconds).
+    :param print_func: Callable Reference to call when print is called in this function. Defaults to 'print' but if 'None' 
+        is passed it uses a no-operation function to silence all output.     
     """
 
     # Make the function silent / have print overridable 

data/x2s5824/_info.yaml

@@ -56,7 +56,7 @@ probe-info:
     - 2
   locations: # In order of pulse
     - "st2"
-    - "st3"
+  #  - "st3"
 
   data-records:
     - type: "scope"

main.py

@@ -29,22 +29,6 @@ CANNY_TIME_OFFSET = 50 #us
 with open(TUNNEL_INFO_FILE, 'r') as file:
     TUNNEL_INFO = yaml.safe_load(file)
 
-data_to_load = [
-    "x2s5823",
-    "x2s5824",
-    "x2s5827",
-    "x2s5829",
-    "x2s5830",
-    "x2s5831",
-    "x2s5832"
-]
-
-ref_data_to_load = [
-    "x2s5820",
-    "x2s5821",
-    "x2s5822"
-]
-
 # ==== Uncerts ====
 # Taken from  DOI: 10.1007/s00193-017-0763-3 (Implementation of a state-to-state analytical framework for the calculation of expansion tube flow properties)
 
@@ -319,7 +303,7 @@ def load_data(data_path: str, data={}) -> dict:
     for i, probe in enumerate(dataInfo["probe-info"]["locations"]):
         # Get the canny-args
         cArgs = dataInfo["canny-args"]
-        doCannyPlot = x2_shot == "x2s5829" and probe == "st2" and False
+        doCannyPlot = False # x2_shot == "x2s5829" and probe == "st2" # This condition was used to generate some graphs
         plotValues = {
             "plot_title": f"Canny Shock Finding Result for {x2_shot} - ST2 Gauge 1",
             "plot_time_unit": "$\\mu$s",
@@ -1082,7 +1066,7 @@ def genX2CompGraphs(gData: dict, showPlot: bool = True):
             graphData["plots"].append({
                 "type": "axvLine",
                 "x": gData["shock-point"]["x2"][f"{probe}-g1"][1],#[i],
-                "label": f"{probe}-Gauge 1 - X2 DAQ - Shock Point {gData['shock-point'][f'{probe}-g1'][1]:.2f}$\\mu$s",
+                "label": f"{probe}-Gauge 1 - X2 DAQ - Shock Point {gData['shock-point']["x2"][f'{probe}-g1'][1]:.2f}$\\mu$s",
                 "colour": UQC["dark_grey"],
                 "args":{"zorder":2, "linestyle":"--", "alpha":0.5}
             })
@@ -1092,7 +1076,7 @@ def genX2CompGraphs(gData: dict, showPlot: bool = True):
             graphData["plots"].append({
                 "type": "axvLine",
                 "x": gData["shock-point"]["x2"][f"{probe}-g2"][1],#[i],
-                "label": f"{probe}-Gauge 2 - X2 DAQ - Shock Point {gData['shock-point'][f'{probe}-g2'][1]:.2f}$\\mu$s",
+                "label": f"{probe}-Gauge 2 - X2 DAQ - Shock Point {gData['shock-point']["x2"][f'{probe}-g2'][1]:.2f}$\\mu$s",
                 "colour": UQC["dark_grey"],
                 "args":{"zorder":2, "linestyle":":", "alpha":0.5}
             })
@@ -1116,52 +1100,67 @@ def genX2CompGraphs(gData: dict, showPlot: bool = True):
 
     pass
 
-print("Loading Data")
+if __name__ == "__main__":
+    data_to_load = [
+        "x2s5823",
+        "x2s5824",
+        "x2s5827",
+        "x2s5829",
+        "x2s5830",
+        "x2s5831",
+        "x2s5832"
+    ]
 
-# My Shot Data
-data = {}
-for dp in data_to_load:
+    ref_data_to_load = [
+        "x2s5820",
+        "x2s5821",
+        "x2s5822"
+    ]
+
+    print("Loading Data")
+
+    # My Shot Data
+    data = {}
+    for dp in data_to_load:
         pdp = f"{DATA_PATH}/{dp}/"
         load_data(pdp, data)
 
-loaded_data = tuple(data.keys())
+    loaded_data = tuple(data.keys())
 
-# Reference Data from Mragank
-ref_data = {}
-for refShot in ref_data_to_load:
+    # Reference Data from Mragank
+    ref_data = {}
+    for refShot in ref_data_to_load:
         load_ref_data(refShot, f"./data/referance/{refShot}/{refShot}.tdms", ref_data)
 
-print("Loaded Data")
+    print("Loaded Data")
 
+    print("Graphing Data")
 
-
-print("Graphing Data")
-
-# General Shot Graphing
-for shot in loaded_data:
+    # General Shot Graphing
+    for shot in loaded_data:
         #print(data[shot]['info']['long_name'].rsplit("\n", 1)[-1])
         genGraph(data[shot], showPlot=False, addShockInfo=False)
         genGraph(data[shot], showPlot=False, forcePlots=True)
 
-combo_data = data.copy()
-combo_data.pop(loaded_data[-2])
-combo_data.pop(loaded_data[-1])
+    combo_data = data.copy()
+    combo_data.pop(loaded_data[-2])
+    combo_data.pop(loaded_data[-1])
 
-genComboDataGraph(combo_data, doShockLabels=True)
+    genComboDataGraph(combo_data, doShockLabels=True)
 
 
-genX2CompGraphs(data["x2s5831"], showPlot=False)
-genX2CompGraphs(data["x2s5832"], showPlot=False)
+    genX2CompGraphs(data["x2s5831"], showPlot=False)
+    genX2CompGraphs(data["x2s5832"], showPlot=False)
 
-# Reference Data
-for shot in ref_data:
+    # Reference Data
+    for shot in ref_data:
         genRefGraph(ref_data[shot], showPlot=False, addShockInfo=False)
         genRefGraph(ref_data[shot], showPlot=False, forcePlots=True)
 
-genComboRefGraph(ref_data, doShockLabels=True)
-genComboRefGraph(ref_data, ref_data[ref_data_to_load[0]]["info"]["pcb-refs"], addShockInfo=True)
+    genComboRefGraph(ref_data, doShockLabels=True)
+    genComboRefGraph(ref_data, ref_data[ref_data_to_load[0]]["info"]["pcb-refs"], addShockInfo=True)
 
 
-# This forces matplotlib to hang until I tell it to close all windows
-pltKeyClose()
-print("Done")
+    # This forces matplotlib to hang until I tell it to close all windows
+    pltKeyClose()
+    print("Done")