Metadata-Version: 2.1
Name: IslandOfMisfitToys
Version: 0.3.0
Summary: A suite of misfit functions to test FWI
Home-page: https://github.com/tmasthay/IslandOfMisfitToys
Author: Tyler Masthay and Yiran Shen
Author-email: tyler@ices.utexas.edu
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: deepwave >=0.0.19
Requires-Dist: numpy >=1.19
Requires-Dist: scipy
Requires-Dist: pytest
Requires-Dist: masthay-helpers >=0.2.16
Requires-Dist: imageio
Requires-Dist: tqdm
Requires-Dist: torchsummary
Requires-Dist: obspy
Requires-Dist: requests
Requires-Dist: rich

# Island of Misfit Toys

![Island of Misfit Toys Banner](IslandOfMisfitToys.jpg)

Welcome to the **Island of Misfit Toys**! See [Rudolph the Red-nosed Reindeer](https://en.wikipedia.org/wiki/Rudolph_the_Red-Nosed_Reindeer_(TV_special)) if you are confused by the logo.

This repository contains implementations of various misfit functions found in seismic literature. 
Our goal is to create a comprehensive collection of these functions to aid researchers and practitioners of seismic inverse problems.

If you have interest in adding features, please add a pull request or contact me directly at tyler@oden.utexas.edu.

If you have any trouble with our code or find bugs, please let us know by filling out an issue!

## Table of Contents

- [Getting Started](#getting-started)
- [Misfit Functions (currently supported)](#misfit-functions)
- [Misfit Functions (roadmap for future)](#roadmap)

## Getting Started

To begin using the misfit functions in this repository, clone it to your local machine:

```bash
git clone https://github.com/tmasthay/IslandOfMisfitToys.git
cd IslandOfMisfitToys
```

## Misfit Functions (currently supported)

(1) One-dimensional $W_1$ and $W_2$ (trace-by-trace) 
  - [Yang et al. 2018](https://scholar.google.com/scholar?hl=en&as_sdt=0%2C44&q=Application+of+optimal+transport+and+the+quadratic+Wasserstein+metric+to+full-waveform+inversion&btnG=)

(2) Huber
  - [Guitton and Symes 2003](https://scholar.google.com/scholar?hl=en&as_sdt=0%2C44&q=Guitton%2C+A.%2C+and+W.+W.+Symes%2C+2003%2C+Robust+inversion+of+seismic+data+using+the+Huber+norm%3A+Geophysics&btnG=)

(3) $L^1$-$L^2$ hybrid
  - [Bube and Langan](https://scholar.google.com/scholar?hl=en&as_sdt=0%2C44&q=Hybrid+l1%E2%88%95l2+minimization+with+applications+to+tomography&btnG=)

(4) Normalized and unnormalized Sobolev norms

  - [Zhu et al. 2021](https://scholar.google.com/scholar?hl=en&as_sdt=0%2C44&q=Implicit+regularization+effects+of+the+Sobolev+norms+in+image+processing&btnG=)

## Misfit Functions (roadmap for future)

(1) Fisher-Rao metric

  - [Zhou et al. 2018](https://scholar.google.com/scholar?hl=en&as_sdt=0%2C44&q=The+Wasserstein-Fisher-Rao+metric+for+waveform+based+earthquake+location&btnG=)

(2) Graph-space OT

  - [Metivier et al. 2018](https://scholar.google.com/scholar?hl=en&as_sdt=0%2C44&q=Optimal+transport+for+mitigating+cycle+skipping+in+full-waveform+inversion%3A+A+graph-space+transform+approach&btnG=)

(3) Entropic regularization OT

  - [Cuturi 2013](https://scholar.google.com/scholar?hl=en&as_sdt=0%2C44&q=Sinkhorn+distances%3A+Lightspeed+computation+of+optimal+transport&btnG=)

(4) Misfits based on reduced-order models

  - [Borcea et al. 2023](https://scholar.google.com/scholar?hl=en&as_sdt=0%2C44&q=Waveform+inversion+via+reduced+order+modeling+borcea&btnG=)
