BOSlib 0.0.3__py3-none-any.whl → 0.0.4__py3-none-any.whl

BOSlib/__init__.py

@@ -6,4 +6,4 @@ from .reconstruction_utils import *
 from .culculate_refractiveindex import *
 from .evaluation  import *
 
-__version__ = '0.0.3'
+__version__ = '0.0.4'

BOSlib/shift.py

@@ -129,25 +129,38 @@ def SP_BOS(ref_array : np.ndarray, exp_array : np.ndarray, binarization : str ="
 
     return diff_comp
 
-def S_BOS(ref_array: np.ndarray, exp_array: np.ndarray,freq_sample_area):
+def S_BOS(ref_array: np.ndarray, exp_array: np.ndarray,freq_sample_row : int = 0):
     """
-    Compute the phase difference and corresponding displacement (delta_h) 
-    between reference and experimental signal arrays using a 1D Background 
-    Oriented Schlieren (BOS) process.
+    Compute a 1D BOS displacement field by estimating phase differences
+    between reference and experimental stripe signals.
 
-    Parameters:
-    -----------
-    ref_array : np.ndarray
-        2D numpy array containing reference signals, where each column is a distinct signal.
-    exp_array : np.ndarray
-        2D numpy array containing experimental signals, matching the dimensions of ref_array.
+    This function first identifies the dominant stripe frequency via FFT
+    from a representative row (`freq_sample_area`) of `ref_array`. Then for
+    each column signal it:
+      1. Bandpass-filters around the base frequency.
+      2. Normalizes amplitude and applies a sine-based phase correction.
+      3. Calculates the local phase difference via lowpass filtered
+         sine/cosine products.
+      4. Converts phase shifts to physical displacement values.
+
+    Parameters
+    ----------
+    ref_array : np.ndarray, shape (M, N)
+        Reference image signals, with M samples (rows) and N separate
+        stripe‐signal columns.
+    exp_array : np.ndarray, shape (M, N)
+        Experimental image signals matching the dimensions of `ref_array`.
+    freq_sample_row : int
+        Row index in `ref_array` used to detect the dominant stripe frequency
+        for filtering and phase calculation.
 
-    Returns:
-    --------
-    delta_h : np.ndarray
-        2D numpy array representing the displacement computed from the phase differences.
+    Returns
+    -------
+    delta_h : np.ndarray, shape (M, N)
+        Displacement field (Δh) computed from the phase differences between
+        each column of `ref_array` and `exp_array`. Units are cycles/(2π·f),
+        where f is the dominant stripe frequency.
     """
-    
     def freq_finder(sig):
         """
         Identify the dominant frequency in the signal using the FFT.
@@ -338,7 +351,7 @@ def S_BOS(ref_array: np.ndarray, exp_array: np.ndarray,freq_sample_area):
         return phase_calculate(separate_sig_ref, separate_sig_exp, f1)
 
     # Determine the dominant frequency from a representative column (column 100) of the reference array
-    f1 = freq_finder(ref_array[freq_sample_area])
+    f1 = freq_finder(ref_array[:,freq_sample_row])
     # Initialize a 2D array to store phase differences for each column
     phi_2D = np.zeros([ref_array.shape[0], ref_array.shape[1]]).astype("float64")
     

{BOSlib-0.0.3.dist-info → BOSlib-0.0.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: BOSlib
-Version: 0.0.3
+Version: 0.0.4
 Summary: the library of Background Oriented Schlieren
 Home-page: https://github.com/ogayuuki0202/BOSlib
 Download-URL: https://github.com/ogayuuki0202/BOSlib

{BOSlib-0.0.3.dist-info → BOSlib-0.0.4.dist-info}/RECORD

@@ -1,13 +1,13 @@
-BOSlib/__init__.py,sha256=hAIN1H3r752cYHCyBxi1Ttl0ucNgzuSfjnPSeoHIc34,225
+BOSlib/__init__.py,sha256=00N8-Ti4_R4lmLuqi08jwokhPvlvudBQXpHRZveEtds,225
 BOSlib/culculate_refractiveindex.py,sha256=v-yIZEtsJchOjO7RFIR3XU4mCYdmbGxKjar03OC5MsA,3421
 BOSlib/evaluation.py,sha256=Ipf5TUXFRuVlwILucJRyqZRazS02Wb7QQ6okXw-P4Vs,12809
 BOSlib/reconstruction.py,sha256=qBxid-wJfsyTfKK1EWa6NejxJ7lHA1HEeIRV6743k98,6545
 BOSlib/reconstruction_utils.py,sha256=hoJQ9crumwdLvmOkIpWasADi2H3-3272P3QPhTrcWu8,1809
-BOSlib/shift.py,sha256=SZj_yUMdjy9M8L_NZvu9JWvRuxpmRBRSEn8qoI8Yl_M,14174
+BOSlib/shift.py,sha256=fa0QxJXuBUELOmLLT2dB_uNaWMU5oxeTI0ZScZx5c5c,14877
 BOSlib/shift_utils.py,sha256=XZ7cwKWV6gkPBcWDkhgU34fRNt1nxAFJNZqC42NIqbk,9397
 BOSlib/utils.py,sha256=ceuHxQmvIsx6z2iudQC9j3SVpQ0m9myTBXuWf6C1eMs,6934
-BOSlib-0.0.3.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-BOSlib-0.0.3.dist-info/METADATA,sha256=Fl1RW0mepo2P4DoQFa3T3QexAQB8QKrYJXJI_fOJG9o,3458
-BOSlib-0.0.3.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
-BOSlib-0.0.3.dist-info/top_level.txt,sha256=ZLqE8iduIk6Ng-LYGvz_faKu-yW4JJwjJpOsXDfBo14,7
-BOSlib-0.0.3.dist-info/RECORD,,
+BOSlib-0.0.4.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+BOSlib-0.0.4.dist-info/METADATA,sha256=beniVbiXOpdcT5iQgI4Lh6l9Xe6wFH46-2hLDq6ffYI,3458
+BOSlib-0.0.4.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
+BOSlib-0.0.4.dist-info/top_level.txt,sha256=ZLqE8iduIk6Ng-LYGvz_faKu-yW4JJwjJpOsXDfBo14,7
+BOSlib-0.0.4.dist-info/RECORD,,