-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Documenter.jl
committed
Aug 31, 2023
1 parent
d62bc5d
commit 636ac2f
Showing
20 changed files
with
15,941 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| v0.1.5 | ||
| v0.1.6 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| v0.1.5 | ||
| v0.1.6 |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>About · Slim Plotting toolbox</title><link href="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.0/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.0/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.0/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.11.1/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit">Slim Plotting toolbox</span></div><form class="docs-search" action="../search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li class="is-active"><a class="tocitem" href>About</a><ul class="internal"><li><a class="tocitem" href="#Disclaimer"><span>Disclaimer</span></a></li><li><a class="tocitem" href="#Functionalities"><span>Functionalities</span></a></li><li><a class="tocitem" href="#Color-maps"><span>Color maps</span></a></li><li class="toplevel"><a class="tocitem" href="#Authors"><span>Authors</span></a></li></ul></li><li><a class="tocitem" href="../examples/">Examples</a></li><li><a class="tocitem" href="../API/">API reference</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>About</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>About</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/slimgroup/SlimPlotting.jl/blob/master/docs/src/README.md" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><p><a href="https://slimgroup.github.io/SlimPlotting.jl/dev/"><img src="https://img.shields.io/badge/docs-dev-blue.svg" alt/></a> <a href="https://slimgroup.github.io/SlimPlotting.jl/stable/"><img src="https://img.shields.io/badge/docs-stable-blue.svg" alt/></a></p><h1 id="SlimPlotting"><a class="docs-heading-anchor" href="#SlimPlotting">SlimPlotting</a><a id="SlimPlotting-1"></a><a class="docs-heading-anchor-permalink" href="#SlimPlotting" title="Permalink"></a></h1><p>Utility function to plot physically gridded (seismic) data in the time and frequency domain and model parameters and perturbations. The functions currently only supports 2D data.</p><h2 id="Disclaimer"><a class="docs-heading-anchor" href="#Disclaimer">Disclaimer</a><a id="Disclaimer-1"></a><a class="docs-heading-anchor-permalink" href="#Disclaimer" title="Permalink"></a></h2><p>This is a small package that I started to make my life easier visualizing data and results easily. Not all functionalities are tested and some of the features may need additional options for better images. This package is under development and welcomes contributions through <a href="https://github.com/slimgroup/SlimPlotting.jl/issues">Issues</a>, <a href="https://github.com/slimgroup/SlimPlotting.jl/pulls">Pull Requests</a> or <a href="https://github.com/slimgroup/SlimPlotting.jl/discussions">Discussions</a></p><h2 id="Functionalities"><a class="docs-heading-anchor" href="#Functionalities">Functionalities</a><a id="Functionalities-1"></a><a class="docs-heading-anchor-permalink" href="#Functionalities" title="Permalink"></a></h2><p>This package implement four main functions that rely on a base <code>_plot_with_units</code> internal function.</p><ul><li><code>plot_simage</code> to plot a 2D seismic image (i.e RTM)</li><li><code>plot_sdata</code> to plot 2D seismic data such as a shot record</li><li><code>plot_fslice</code> to plot a 2D frequency slice of seismic data.</li><li><code>plot_velocity</code> to plot a 2D velocity model.</li><li><code>wiggle_plot</code> to make a 2D wiggle plot of a seismic data.</li></ul><p>The functions <code>plot_simage, plot_sdata</code> and <code>plot_velocity</code> support abstract object with meta-data containing the grid spacing. For example, you can plot a 2D <a href="https://github.com/slimgroup/JUDI.jl">JUDI</a> <code>PhysicalParameter</code> either via <code>plot_velocity(p.data, p.d)</code> or directly via <code>plot_velocity(p)</code> that will extract the data and spacing automatically. While this supports <a href="https://github.com/slimgroup/JUDI.jl">JUDI</a> since we are using it extensively, this package does not depend on it and only expect a Julia structure as an input (when the spacing is not specified) containing a <code>.d</code> attribute with the grid spacing. We show in the simple example how to setup such a simple structure.</p><p>The expected inputs are:</p><ul><li><code>plot_simage(array, tuple; kw...)</code> or <code>plot_simage(structure)</code> with <code>strucutre.d</code></li></ul><p>containing the grid spacing and <code>structure.data</code> containing the 2D array.</p><ul><li><code>plot_velocity(array, tuple; kw...)</code> or <code>plot_velocity(structure)</code> with <code>strucutre.d</code></li></ul><p>containing the grid spacing and <code>structure.data</code> containing the 2D array.</p><ul><li><code>plot_sdata(array, tuple; kw...)</code> or <code>plot_sdata(structure)</code> with <code>strucutre.dt</code></li></ul><p>containing the time sampling rate and <code>structure.d</code> containing the receiver spacing (uniform sampling is assumed at the time) and <code>structure.data</code> containing the 2D array.</p><ul><li><code>wiggle_plot(array, xrec, time_axis; kw...)</code>. In this case, <code>xrec, time_axis</code> are optional and wil default to <code>1:size(array, 2)</code>, <code>1:size(array, 1)</code> respectively.</li></ul><p>and you can check the docstring (julia <code>?</code>) for additional information on the optional keyword arguments.</p><h2 id="Color-maps"><a class="docs-heading-anchor" href="#Color-maps">Color maps</a><a id="Color-maps-1"></a><a class="docs-heading-anchor-permalink" href="#Color-maps" title="Permalink"></a></h2><p>The colormap support is extensive as this uses three sources:</p><ul><li><code>matplotlib</code> standard colormaps.</li><li><a href="https://juliagraphics.github.io/ColorSchemes.jl/stable/">ColorShemes.jl</a> that implements a variery of colormaps from different packages including Matplotlib, Seaborn, GNUPlot, colorcet(Collection of perceptually accurate colormaps). You can provide the chosen colormap as a kewyword , i.e <code>plot_simage(array, tuple; cmap=:jet)</code>.</li><li><a href="https://colorcet.holoviz.org/index.html">colorcet</a> perceptually accurate colormaps that are available through their colorcet names (i.e <code>cet_rainbow4</code> for a perceptually accurate <code>jet</code> colormap).</li><li><a href="https://github.com/lijunzh/SeisCM/tree/master">seismc</a> a set of seismic colormap usable via <code>seiscm(name)</code> where <code>name</code> is one of the four supported maps <code>seismic, bwr, frequency, phase</code></li></ul><p>All functionality, with the exeption of <code>wiggle_plot</code> accept the keyword argument cmap, i.e <code>plot_velocity(array, spacing; cmap=:vik)</code>.</p><h1 id="Authors"><a class="docs-heading-anchor" href="#Authors">Authors</a><a id="Authors-1"></a><a class="docs-heading-anchor-permalink" href="#Authors" title="Permalink"></a></h1><p>This package is developed and maintained by Mathias Louboutin<[email protected]> and the ML4Seismic Lab at Georgia Institute of Technology.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../examples/">Examples »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> on <span class="colophon-date" title="Thursday 31 August 2023 21:19">Thursday 31 August 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.