insardev 2025.2.20.dev0__tar.gz

insardev-2025.2.20.dev0/LICENSE.txt

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2025, Alexey Pechnikov, https://orcid.org/0000-0001-9626-8615 (ORCID)
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

insardev-2025.2.20.dev0/PKG-INFO

@@ -0,0 +1,151 @@
+Metadata-Version: 2.2
+Name: insardev
+Version: 2025.2.20.dev0
+Summary: InSAR.dev (Python InSAR): Satellite Interferometry Framework
+Home-page: https://github.com/AlexeyPechnikov/pygmtsar
+Author: Alexey Pechnikov
+Author-email: alexey@pechnikov.dev
+License: BSD-3-Clause
+Keywords: satellite interferometry,InSAR,remote sensing,geospatial analysis,Sentinel-1,SBAS,PSI
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Natural Language :: English
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: insardev_toolkit
+Requires-Dist: xarray
+Requires-Dist: numpy
+Requires-Dist: numba
+Requires-Dist: pandas
+Requires-Dist: geopandas
+Requires-Dist: distributed
+Requires-Dist: dask[complete]
+Requires-Dist: scipy
+Requires-Dist: xgboost
+Requires-Dist: cffi
+Requires-Dist: scikit-learn
+Requires-Dist: statsmodels>=0.14.0
+Requires-Dist: matplotlib
+Requires-Dist: adjustText
+Requires-Dist: seaborn
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+[![View on GitHub](https://img.shields.io/badge/GitHub-View%20on%20GitHub-blue)](https://github.com/AlexeyPechnikov/pygmtsar)
+[![Available on pypi](https://img.shields.io/pypi/v/pygmtsar.svg)](https://pypi.python.org/pypi/pygmtsar/)
+[![Docker](https://badgen.net/badge/icon/docker?icon=docker&label)](https://hub.docker.com/r/pechnikov/pygmtsar)
+[![DOI](https://zenodo.org/badge/398018212.svg)](https://zenodo.org/badge/latestdoi/398018212)
+[![Support on Patreon](https://img.shields.io/badge/Patreon-Support-orange.svg)](https://www.patreon.com/pechnikov)
+[![ChatGPT Assistant](https://img.shields.io/badge/ChatGPT-Assistant-green?logo=openai)](https://insar.dev/ai)
+
+## PyGMTSAR (Python InSAR): Powerful, Accessible Satellite Interferometry
+
+<img src="assets/logo.jpg" width="15%" />
+
+PyGMTSAR (Python InSAR) is designed for both occasional users and experts working with Sentinel-1 satellite interferometry. It supports a wide range of features, including SBAS, PSI, PSI-SBAS, and more. In addition to the examples below, you’ll find more Jupyter notebook use cases on [Patreon](https://www.patreon.com/pechnikov) and updates on [LinkedIn](https://www.linkedin.com/in/alexey-pechnikov/).
+
+## About PyGMTSAR
+
+PyGMTSAR offers reproducible, high-performance Sentinel-1 interferometry accessible to everyone—whether you prefer Google Colab, cloud servers, or local processing. It automatically retrieves Sentinel-1 SLC scenes and bursts, DEMs, and orbits; computes interferograms and correlations; performs time-series analysis; and provides 3D visualization. This single library enables users to build a fully integrated InSAR project with minimal hassle. Whether you need a single interferogram or a multi-year analysis involving thousands of datasets, PyGMTSAR can handle the task efficiently, even on standard commodity hardware.
+
+## PyGMTSAR Live Examples on Google Colab
+
+Google Colab is a free service that lets you run interactive notebooks directly in your browser—no powerful computer, extensive disk space, or special installations needed. You can even do InSAR processing from a smartphone. These notebooks automate every step: installing PyGMTSAR library and its dependencies on a Colab host (Ubuntu 22, Python 3.10), downloading Sentinel-1 SLCs, orbit files, SRTM DEM data (automatically converted to ellipsoidal heights via EGM96), land mask data, and then performing complete interferometry with final mapping. You can also modify scene  or bursts names to analyze your own area of interest, and each notebook includes instant interactive 3D maps.
+
+[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1TARVTB7z8goZyEVDRWyTAKJpyuqZxzW2?usp=sharing) **Central Türkiye Earthquakes (2023).** The area is large, covering two consecutive Sentinel-1 scenes or a total of 56 bursts.
+
+<img src="assets/turkie_2023a.jpg" width="40%" /><img src="assets/turkie_2023b.jpg" width="40%" />
+
+[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1dDFG8BoF4WfB6tOF5sAi5mjdBKRbhxHo?usp=sharing) **Pico do Fogo Volcano Eruption, Fogo Island, Cape Verde (2014).** The interferogram for this event is compared to the study *The 2014–2015 eruption of Fogo volcano: Geodetic modeling of Sentinel-1 TOPS interferometry* (*Geophysical Research Letters*, DOI: [10.1002/2015GL066003](https://doi.org/10.1002/2015GL066003)).
+
+<img src="assets/pico_2014a.jpg" width="40%" /><img src="assets/pico_2014b.jpg" width="40%" />
+
+[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1d9RcqBmWIKQDEwJYo8Dh6M4tMjJtvseC?usp=sharing) **La Cumbre Volcano Eruption, Ecuador (2020).** The results compare with the report from Instituto Geofísico, Escuela Politécnica Nacional (IG-EPN) (InSAR software unspecified).
+
+<img src="assets/la_cumbre_2020a.jpg" width="40%" /><img src="assets/la_cumbre_2020b.jpg" width="40%" />
+
+[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1shNGvUlUiXeyV7IcTmDbWaEM6XrB0014?usp=sharing) **Iran–Iraq Earthquake (2017).** The event has been well investigated, and the results compared to outputs from GMTSAR, SNAP, and GAMMA software.
+
+<img src="assets/iran_iraq_2017a.jpg" width="40%" /><img src="assets/iran_iraq_2017b.jpg" width="40%" />
+
+[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1h4XxJZwFfm7EC8NUzl34cCkOVUG2uJr4?usp=sharing) **Imperial Valley Subsidence, CA USA (2015).**  This example is provided in the [GMTSAR project](https://topex.ucsd.edu/gmtsar/downloads/) in the archive file [S1A_Stack_CPGF_T173.tar.gz](http://topex.ucsd.edu/gmtsar/tar/S1A_Stack_CPGF_T173.tar.gz), titled 'Sentinel-1 TOPS Time Series'.
+
+The resulting InSAR velocity map is available as a self-contained web page at: [Imperial_Valley_2015.html](https://insar.dev/ui/Imperial_Valley_2015.html)
+
+<img src="assets/imperial_valley_2015a.jpg" width="40%" /> <img src="assets/imperial_valley_2015b.jpg" width="40%" />
+
+[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1aqAr9KWKzGx9XpVie1M000C3vUxzNDxu?usp=sharing) **Kalkarindji Flooding, NT Australia (2024).** Correlation loss serves to identify flooded areas.
+
+<img src="assets/kalkarindji_2024.jpg" width="80%" />
+
+[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1ipiQGbvUF8duzjZER8v-_R48DSpSmgvQ?usp=sharing) **Golden Valley Subsidence, CA USA (2021).** This example demonstrates the case study 'Antelope Valley Freeway in Santa Clarita, CA,' as detailed in [SAR Technical Series Part 4 Sentinel-1 global velocity layer: Using global InSAR at scale](https://blog.descarteslabs.com/using-global-insar-at-scale) and [Sentinel-1 Technical Series Part 5 Targeted Analysis](https://blog.descarteslabs.com/sentinel-1-targeted-analysis) with a significant subsidence rate 'exceeding 5cm/year in places'.
+
+<img src="assets/golden_valley_2021.jpg" width="80%" />
+
+[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1O3aZtZsTrQIldvCqlVRel13wJRLhmTJt?usp=sharing) **Lake Sarez Landslides, Tajikistan (2017).** The example reproduces the findings shared in the following paper: [Integration of satellite SAR and optical acquisitions for the characterization of the Lake Sarez landslides in Tajikistan](https://www.google.com/url?q=https%3A%2F%2Fwww.researchgate.net%2Fpublication%2F378176884_Integration_of_satellite_SAR_and_optical_acquisitions_for_the_characterization_of_the_Lake_Sarez_landslides_in_Tajikistan).
+
+<img src="assets/lake_sarez_2017.jpg" width="80%" />
+
+[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/19PLuebOZ4gaYX5ym1H7SwUbJKfl23qPr?usp=sharing) **Erzincan Elevation, Türkiye (2019).** This example reproduces 29-page ESA document [DEM generation with Sentinel-1 IW](https://step.esa.int/docs/tutorials/S1TBX%20DEM%20generation%20with%20Sentinel-1%20IW%20Tutorial.pdf).
+
+<img src="assets/erzincan_2019.jpg" width="80%" />
+
+## More PyGMTSAR Live Examples on Google Colab
+
+[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1yuuA1ES2ly4QG3hyPg8YYT0nnpGDiQDw?usp=sharing) **Mexico City Subsidence, Mexico (2016).** This example replicates the 29-page ESA manual [TRAINING KIT – HAZA03. LAND SUBSIDENCE WITH SENTINEL-1 using SNAP](https://eo4society.esa.int/wp-content/uploads/2022/01/HAZA03_Land-Subsidence_Mexico-city.pdf).
+
+## PyGMTSAR Live Examples on Google Colab Pro
+
+I share additional InSAR projects on Google Colab Pro through my [Patreon page](https://www.patreon.com/pechnikov). These are ideal for InSAR learners, researchers, and industry professionals tackling challenging projects with large areas, big stacks of interferograms, low-coherence regions, or significant atmospheric delays. You can run these privately shared notebooks online with Colab Pro or locally/on remote servers.
+
+## Projects and Publications Using PyGMTSAR
+
+See the [Projects and Publications](/pubs/README.md) page for real-world projects and academic research applying PyGMTSAR. This is not an exhaustive list—contact me if you’d like your project or publication included.
+
+## Resources
+
+**PyGMTSAR projects and e-books**
+Available on [Patreon](https://www.patreon.com/c/pechnikov/shop). Preview versions can be found in this GitHub repo:
+
+- [PyGMTSAR Introduction Preview](https://github.com/AlexeyPechnikov/pygmtsar/blob/pygmtsar2/book/PyGMTSAR_preview.pdf)  
+- [PyGMTSAR Gaussian Filtering Preview](https://github.com/AlexeyPechnikov/pygmtsar/blob/pygmtsar2/book/Gaussian_preview.pdf)
+
+<img src="assets/listing.jpg" width="40%" />
+
+**Video Lessons and Notebooks**
+Find PyGMTSAR (Python InSAR) video lessons and educational notebooks on [Patreon](https://www.patreon.com/collection/12458) and [YouTube](https://www.youtube.com/channel/UCSEeXKAn9f_bDiTjT6l87Lg).
+
+**PyGMTSAR AI Assistant**
+The [PyGMTSAR AI Assistant](https://insar.dev/ai), powered by OpenAI ChatGPT, can explain InSAR theory, guide you through examples, help build an InSAR processing pipeline, and troubleshoot.
+
+<img width="40%" alt="PyGMTSAR AI Assistant" src="assets/ai.jpg" />
+
+**PyGMTSAR on DockerHub**
+Run InSAR processing on macOS, Linux, or Windows via [Docker images](https://hub.docker.com/r/pechnikov/pygmtsar).
+
+**PyGMTSAR on PyPI**
+Install the library from [PyPI](https://pypi.python.org/pypi/pygmtsar).
+
+**PyGMTSAR Previous Versions**
+2023 releases are still on GitHub, PyPI, DockerHub, and Google Colab. Compare PyGMTSAR InSAR with other software by checking out the [PyGMTSAR 2023 Repository](https://github.com/AlexeyPechnikov/pygmtsar/tree/pygmtsar).
+
+© Alexey Pechnikov, 2025

insardev-2025.2.20.dev0/insardev/Stack.py

@@ -0,0 +1,106 @@
+# ----------------------------------------------------------------------------
+# PyGMTSAR
+# 
+# This file is part of the PyGMTSAR project: https://github.com/mobigroup/gmtsar
+# 
+# Copyright (c) 2025, Alexey Pechnikov
+# 
+# Licensed under the BSD 3-Clause License (see LICENSE for details)
+# ----------------------------------------------------------------------------
+from .Stack_export import Stack_export
+
+class Stack(Stack_export):
+
+    def __repr__(self):
+        return 'Object %s %d bursts %d dates' % (self.__class__.__name__, len(self.ds), len(self.ds[0].date))
+
+    def to_dataset(self):
+        import numpy as np
+        import xarray as xr
+        data = xr.concat(xr.align(*self.ds, join='outer'), dim='stack_dim').mean('stack_dim')
+        return data
+
+    def __init__(self, basedir, pattern_burst='*_*_?W?', pattern_date = '????????.nc', scale = 2.5e-07):
+        """
+        Initialize an instance of the Stack class.
+        """
+        import numpy as np
+        import xarray as xr
+        import glob
+        import os
+
+        self.basedir = basedir
+        
+        bursts = glob.glob(pattern_burst, root_dir=self.basedir)
+        datas = []
+        for burst in bursts:
+            data = xr.open_mfdataset(
+                os.path.join(self.basedir, burst, pattern_date),
+                engine=self.netcdf_engine_read,
+                format=self.netcdf_format,
+                parallel=True,
+                concat_dim='date',
+                chunks={'date': 1, 'y': self.chunksize, 'x': self.chunksize},
+                combine='nested',
+            )
+            #print (data)
+            # zero in np.int16 type means NODATA
+            data = self.spatial_ref(
+                scale*(data.re.astype(np.float32) + 1j*data.im.astype(np.float32)).where(data.re != 0).rename('data'),
+                data
+            )\
+            .to_dataset(name='data')\
+            .assign({v: data[v] for v in data.data_vars if v not in ['im', 're']})\
+            .assign_attrs({'burst': burst})
+            datas.append(data)
+            del data
+    
+        self.ds = datas
+
+    def baseline_table(self):
+        import xarray as xr
+        return xr.concat([ds.BPR for ds in self.ds], dim='burst').mean('burst').to_dataframe()[['BPR']]
+
+    def baseline_pairs(self, days=None, meters=None, invert=False):
+        """
+        Generates a sorted list of baseline pairs.
+        Returns
+        -------
+        pandas.DataFrame
+            A DataFrame containing the sorted list of baseline pairs with reference and repeat dates,
+            timelines, and baselines.
+    
+        """
+        import numpy as np
+        import pandas as pd
+        
+        if days is None:
+            # use large number for unlimited time interval in days
+            days = 1e6
+    
+        tbl = self.baseline_table()
+        data = []
+        for line1 in tbl.itertuples():
+            counter = 0
+            for line2 in tbl.itertuples():
+                #print (line1, line2)
+                if not (line1.Index < line2.Index and (line2.Index - line1.Index).days < days + 1):
+                    continue
+                if meters is not None and not (abs(line1.BPR - line2.BPR)< meters + 1):
+                    continue
+    
+                counter += 1
+                if not invert:
+                    data.append({'ref':line1.Index, 'rep': line2.Index,
+                                 'ref_baseline': np.round(line1.BPR, 2),
+                                 'rep_baseline': np.round(line2.BPR, 2)})
+                else:
+                    data.append({'ref':line2.Index, 'rep': line1.Index,
+                                 'ref_baseline': np.round(line2.BPR, 2),
+                                 'rep_baseline': np.round(line1.BPR, 2)})
+    
+        df = pd.DataFrame(data).sort_values(['ref', 'rep'])
+        return df.assign(pair=[f'{ref} {rep}' for ref, rep in zip(df['ref'].dt.date, df['rep'].dt.date)],
+                         baseline=df.rep_baseline - df.ref_baseline,
+                         duration=(df['rep'] - df['ref']).dt.days,
+                         rel=np.datetime64('nat'))

insardev-2025.2.20.dev0/insardev/Stack_base.py

@@ -0,0 +1,149 @@
+# ----------------------------------------------------------------------------
+# InSAR.dev
+# 
+# This file is part of the InSAR.dev project: https://InSAR.dev
+# 
+# Copyright (c) 2025, Alexey Pechnikov
+# 
+# Licensed under the BSD 3-Clause License (see LICENSE for details)
+# ----------------------------------------------------------------------------
+from insardev_toolkit import tqdm_joblib, tqdm_dask
+from .dataset import dataset
+
+class Stack_base(tqdm_joblib, dataset):
+
+    def get_pairs(self, pairs, dates=False):
+        """
+        Get pairs as DataFrame and optionally dates array.
+
+        Parameters
+        ----------
+        pairs : np.ndarray, optional
+            An array of pairs. If None, all pairs are considered. Default is None.
+        dates : bool, optional
+            Whether to return dates array. Default is False.
+        name : str, optional
+            The name of the phase filter. Default is 'phasefilt'.
+
+        Returns
+        -------
+        pd.DataFrame or tuple
+            A DataFrame of pairs. If dates is True, also returns an array of dates.
+        """
+        import xarray as xr
+        import pandas as pd
+        import numpy as np
+        from glob import glob
+
+        if isinstance(pairs, pd.DataFrame):
+            # workaround for baseline_pairs() output
+            pairs = pairs.rename(columns={'ref_date': 'ref', 'rep_date': 'rep'})
+        elif isinstance(pairs, (xr.DataArray, xr.Dataset)):
+            # pairs = pd.DataFrame({
+#                 'ref': pairs.coords['ref'].values,
+#                 'rep': pairs.coords['rep'].values
+#             })
+            refs = pairs.coords['ref'].values
+            reps = pairs.coords['rep'].values
+            pairs = pd.DataFrame({
+                'ref': refs if isinstance(refs, np.ndarray) else [refs],
+                'rep': reps if isinstance(reps, np.ndarray) else [reps]
+            })
+        else:
+            # Convert numpy array to DataFrame
+            # in case of 1d array with 2 items convert to a single pair
+            pairs_2d = [pairs] if np.asarray(pairs).shape == (2,) else pairs
+            pairs = pd.DataFrame(pairs_2d, columns=['ref', 'rep'])
+
+        # Convert ref and rep columns to datetime format
+        pairs['ref'] = pd.to_datetime(pairs['ref'])
+        pairs['rep'] = pd.to_datetime(pairs['rep'])
+        pairs['pair'] = [f'{ref} {rep}' for ref, rep in zip(pairs['ref'].dt.date, pairs['rep'].dt.date)]
+        # Calculate the duration in days and add it as a new column
+        #pairs['duration'] = (pairs['rep'] - pairs['ref']).dt.days
+
+        if dates:
+            # pairs is DataFrame
+            dates = np.unique(pairs[['ref', 'rep']].astype(str).values.flatten())
+            return (pairs, dates)
+        return pairs
+
+    def get_pairs_matrix(self, pairs):
+        """
+        Create a matrix based on interferogram dates and pairs.
+
+        Parameters
+        ----------
+        pairs : pandas.DataFrame or xarray.DataArray or xarray.Dataset
+            DataFrame or DataArray containing interferogram date pairs.
+        
+        Returns
+        -------
+        numpy.ndarray
+            A matrix with one row for every interferogram and one column for every date.
+            Each element in the matrix is a float, with 1 indicating the start date,
+            -1 indicating the end date, 0 if the date is covered by the corresponding 
+            interferogram timeline, and NaN otherwise.
+
+        """
+        import numpy as np
+        import pandas as pd
+
+        # also define image capture dates from interferogram date pairs
+        pairs, dates = self.get_pairs(pairs, dates=True)
+        pairs = pairs[['ref', 'rep']].astype(str).values
+
+        # here are one row for every interferogram and one column for every date
+        matrix = []
+        for pair in pairs:
+            #mrow = [date>=pair[0] and date<=pair[1] for date in dates]
+            mrow = [(-1 if date==pair[0] else (1 if date==pair[1] else (0 if date>pair[0] and date<pair[1] else np.nan))) for date in dates]
+            matrix.append(mrow)
+        matrix = np.stack(matrix).astype(np.float32)
+        return matrix
+
+    @staticmethod
+    def phase_to_positive_range(phase):
+        """
+        Convert phase from the range [-pi, pi] to [0, 2pi].
+    
+        Parameters
+        ----------
+        phase : array_like
+            Input phase values in the range [-pi, pi].
+    
+        Returns
+        -------
+        ndarray
+            Phase values converted to the range [0, 2pi].
+        
+        Examples
+        --------
+        >>> phase_to_positive_range(np.array([-np.pi, -np.pi/2, np.pi, 2*-np.pi-1e-6, 2*-np.pi]))
+        array([3.14159265, 4.71238898, 3.14159265, 6.28318431, 0.        ])
+        """
+        import numpy as np
+        return (phase + 2 * np.pi) % (2 * np.pi)
+    
+    @staticmethod
+    def phase_to_symmetric_range(phase):
+        """
+        Convert phase from the range [0, 2pi] to [-pi, pi].
+    
+        Parameters
+        ----------
+        phase : array_like
+            Input phase values in the range [0, 2pi].
+    
+        Returns
+        -------
+        ndarray
+            Phase values converted to the range [-pi, pi].
+        
+        Examples
+        --------
+        >>> phase_to_symmetric_range(np.array([0, np.pi, 3*np.pi/2, 2*np.pi]))
+        array([ 0.        ,  3.14159265, -1.57079633,  0.        ])
+        """
+        import numpy as np
+        return (phase + np.pi) % (2 * np.pi) - np.pi