More refactoring

Author: corrooli

common/parameters.py

@@ -29,25 +29,25 @@ def __init__(
             Uppermost frequency of simulation. Can be dialed in lower to enhance performance.
         T : float
             Simulation time [s].
-        spatial_samples_per_wave_length : int
-            Number of spatial samples per wave length. Usually 2 to 4. Lower values decrease 
+        spatial_samples_per_wave_length : int, optional
+            Number of spatial samples per wave length. Usually 2 to 6. Lower values decrease 
             resolution but enhances performance.
-        c : float
+        c : float, optional
             Speed of sound [m/s]. Depends on air temperature, pressure and humidity. 
-        Fs : int
+        Fs : int, optional
             Sampling rate. The higher, the more fidelity and higher maximum frequency but at the expense of performance.
-        normalization_constant : float
+        normalization_constant : float, optional
             Normalization multiplier to equalize amplitude across entire domain.
-        auralize : ndarray
+        auralize : ndarray, optional
             Auralizes the room (= makes hearable) by creating an impulse response (IR).
             Format is a list with mic positions. If microphone array is empty, no auralization is being made.
-        verbose : bool
+        verbose : bool, optional
             Prints information on the terminal for debugging and status purposes.
-        visualize : bool
+        visualize : bool, optional
             Visualizes wave propagation in the plot.
-        visualize_source : bool
+        visualize_source : bool, optional
             Visualizes impulse source in the plot.
-        benchmark : bool
+        benchmark : bool, optional
             Enables performance benchmarking for comparing different accuracies.
         '''
 

example_2D.py

@@ -53,16 +53,16 @@
 # Also, you may provide impulse in the partition(s) of your choosing.
 partitions.append(AirPartition2D(np.array([[4.0], [4.0]]), sim_param, impulse=impulse))
 partitions.append(PMLPartition2D(np.array([[1.0], [4.0]]), sim_param, dp))
-#partitions.append(PMLPartition2D(np.array([[1.0], [4.0]]), sim_param, dp))
-#partitions.append(PMLPartition2D(np.array([[4.0], [1.0]]), sim_param, dp))
-#partitions.append(PMLPartition2D(np.array([[4.0], [1.0]]), sim_param, dp))
+partitions.append(PMLPartition2D(np.array([[1.0], [4.0]]), sim_param, dp))
+partitions.append(PMLPartition2D(np.array([[4.0], [1.0]]), sim_param, dp))
+partitions.append(PMLPartition2D(np.array([[4.0], [1.0]]), sim_param, dp))
 
 # Interfaces of the room. Interfaces connect the partitions together
 interfaces = []
 interfaces.append(InterfaceData2D(1, 0, Direction2D.X))
-#interfaces.append(InterfaceData2D(2, 0, Direction2D.X))
-#interfaces.append(InterfaceData2D(3, 0, Direction2D.Y))
-#interfaces.append(InterfaceData2D(4, 0, Direction2D.Y))
+interfaces.append(InterfaceData2D(2, 0, Direction2D.X))
+interfaces.append(InterfaceData2D(3, 0, Direction2D.Y))
+interfaces.append(InterfaceData2D(4, 0, Direction2D.Y))
 
 # Microphones. Add and remove microphones here by copying or deleting mic objects.
 # Only gets used if the auralization option is enabled.

example_3D.py

@@ -9,6 +9,8 @@
 from common.microphone import Microphone as Mic
 
 import numpy as np
+from datetime import date, datetime
+
 
 # Room parameters
 duration = 1 # seconds

pytARD_3D/partition.py

@@ -91,24 +91,6 @@ def calculate_h_x_y_z(sim_param):
         return h_z, h_y, h_x
 
 
-class PMLType(Enum):
-    '''
-    TODO: Is this needed?
-    '''
-    LEFT = {  # for kx
-        "Min": 0.2, "Max": 0.0
-    }
-    RIGHT = {  # for kx
-        "Min": 0.0, "Max": 0.2
-    }
-    TOP = {  # for ky
-        "Min": 0.2, "Max": 0.0
-    }
-    BOTTOM = {  # for ky
-        "Min": 0.0, "Max": 0.2
-    }
-
-
 class DampingProfile:
     '''
     Damping profile. Determines how intense the reflections of the PML partition are, or how much sound energy is absorbed.
@@ -181,7 +163,6 @@ def __init__(
         self,
         dimensions: np.ndarray,
         sim_param: SimulationParameters,
-        pml_type: PMLType,
         damping_profile: DampingProfile
     ):
         '''
@@ -193,8 +174,6 @@ def __init__(
             Size of the partition (room) in meters.
         sim_param : SimulationParameters
             Instance of simulation parameter class.
-        pml_type : PMLType
-            Type (direction) of PML partition.
         damping_profile : DampingProfile
             Damping profile of the PML partition, determines the intensity of wave absorption.
         '''

utility_call_graph.py

@@ -3,143 +3,44 @@
 from pytARD_2D.interface import InterfaceData2D, Direction2D
 
 from common.parameters import SimulationParameters
-from common.impulse import Gaussian, Unit, WaveFile
-from common.serializer import Serializer
-from common.plotter import Plotter
-from common.microphone import Microphone as Mic
+from common.impulse import Unit
 
 import numpy as np
-from datetime import date, datetime
 from pycallgraph import PyCallGraph
 from pycallgraph.output import GraphvizOutput
 from pycallgraph import GlobbingFilter
 from pycallgraph import Config
 
-
-# Simulation parameters
-duration = 1  #  seconds
-Fs = 8000  # sample rate
-upper_frequency_limit = 200  # Hz
-c = 342  # m/s
-spatial_samples_per_wave_length = 6
-
-# Procedure parameters
-verbose = True
-auralize = True
-visualize = True
-write_to_file = False
-
-# Compilation of room parameters into parameter class
+'''
+Utility script to create call graphs with PyCallGraph.
+'''
+c = 342
 sim_param = SimulationParameters(
-    upper_frequency_limit,
-    duration,
+    200,
+    1,
     c=c,
-    Fs=Fs,
-    spatial_samples_per_wave_length=spatial_samples_per_wave_length,
-    verbose=verbose,
-    visualize=visualize
+    Fs=8000,
+    spatial_samples_per_wave_length=6,
+    verbose=False,
+    visualize=False
 )
 
-# Location of impulse that gets emitted into the room.
-impulse_location = np.array([[2], [2]])
-
-# Define impulse that gets emitted into the room. Uncomment which kind of impulse you want.
-#impulse = Gaussian(sim_param, impulse_location, 10000)
-impulse = Unit(sim_param, impulse_location, 1, 100)
-#impulse = WaveFile(sim_param, impulse_location, 'clap_48000.wav', 1000)
-
-# Damping profile with according Zetta value (how much is absorbed)
-dp = DampingProfile(4, c, 1e-8)
-
-partitions = []
-# Paritions of the room. Can be 1..n. Add or remove partitions here.
-# This example is a square room surrounded by absorbing PML partitions.
-# Also, you may provide impulse in the partition(s) of your choosing.
-partitions.append(AirPartition2D(np.array([[4.0], [4.0]]), sim_param, impulse=impulse))
-partitions.append(PMLPartition2D(np.array([[1.0], [4.0]]), sim_param, dp))
-#partitions.append(PMLPartition2D(np.array([[1.0], [4.0]]), sim_param, dp))
-#partitions.append(PMLPartition2D(np.array([[4.0], [1.0]]), sim_param, dp))
-#partitions.append(PMLPartition2D(np.array([[4.0], [1.0]]), sim_param, dp))
-
-# Interfaces of the room. Interfaces connect the partitions together
-interfaces = []
-interfaces.append(InterfaceData2D(1, 0, Direction2D.X))
-#interfaces.append(InterfaceData2D(2, 0, Direction2D.X))
-#interfaces.append(InterfaceData2D(3, 0, Direction2D.Y))
-#interfaces.append(InterfaceData2D(4, 0, Direction2D.Y))
-
-# Microphones. Add and remove microphones here by copying or deleting mic objects.
-# Only gets used if the auralization option is enabled.
-if auralize:
-    mics = []
-    mics.append(Mic(
-        0,  # Parition number
-        # Position
-        [
-            int(partitions[0].dimensions[0] / 1.5),
-            int(partitions[0].dimensions[1] / 1.5)
-        ],
-        sim_param,
-        # Name of resulting wave file
-        f"pytARD_2D_{date.today()}_{datetime.now().time()}"
-    ))
+partitions = [
+    AirPartition2D(np.array([[4.0], [4.0]]), sim_param, impulse=Unit(sim_param, np.array([[2], [2]]), 1, 100)),
+    PMLPartition2D(np.array([[1.0], [4.0]]), sim_param, DampingProfile(4, c, 1e-8))
+]
 
-# Instantiation serializer for reading and writing simulation state data
-serializer = Serializer()
+interfaces = [
+    InterfaceData2D(1, 0, Direction2D.X)
+]
 
 # Instantiating and executing simulation
 config = Config()
 config.trace_filter = GlobbingFilter(exclude=[
-    'tqdm.*',
-    '*.tqdm',
-    'tqdm',
-    'pycallgraph.*',
-    '*.secret_function',
-    'multiprocessing',
-    '*.multiprocessing',
-    'multiprocessing.*'
+    'tqdm.*', '*.tqdm', 'tqdm', 'pycallgraph.*', '*.secret_function', 'multiprocessing', '*.multiprocessing', 'multiprocessing.*'
 ])
 
 with PyCallGraph(output=GraphvizOutput(), config=config):
-
-    sim = ARDSimulator2D(sim_param, partitions, 1, interfaces, mics)
+    sim = ARDSimulator2D(sim_param, partitions, 1, interfaces)
     sim.preprocessing()
     sim.simulation()
-
-# Find best peak to normalize mic signal and write mic signal to file
-if auralize:
-    def find_best_peak(mics):
-        peaks = []
-        for i in range(len(mics)):
-            peaks.append(np.max(mics[i].signal))
-        return np.max(peaks)
-
-    all_mic_peaks = []
-    all_mic_peaks.append(find_best_peak(mics))
-    best_peak = np.max(all_mic_peaks)
-
-    def write_mic_files(mics, peak):
-        for i in range(len(mics)):
-            mics[i].write_to_file(peak, upper_frequency_limit)
-
-    write_mic_files(mics, best_peak)
-
-# Structure of plot graph. Optional, only for visualization.
-plot_structure = [
-    # Structure: [Width of domain, height of domain, index of partition to plot on the graph (min: 1, max: width*height)]
-    [3, 3, 5],
-    [3, 3, 4],
-    [3, 3, 6],
-    [3, 3, 2],
-    [3, 3, 8]
-]
-
-# Write partitions and state data to disk
-if write_to_file:
-    serializer.dump(sim_param, partitions, mics, plot_structure)
-
-# Plotting waveform
-if visualize:
-    plotter = Plotter()
-    plotter.set_data_from_simulation(sim_param, partitions, mics, plot_structure)
-    plotter.plot(enable_colorbar=True)