From dc7279c35c83d1303dda2df4f92246a03bed8e22 Mon Sep 17 00:00:00 2001 From: "Documenter.jl" Date: Tue, 13 Aug 2024 03:19:07 +0000 Subject: [PATCH] build based on 660b595 --- dev/.documenter-siteinfo.json | 2 +- dev/index.html | 18 +++++++++--------- dev/objects.inv | Bin 354 -> 354 bytes 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json index 2bb7cd5..c05b78d 100644 --- a/dev/.documenter-siteinfo.json +++ b/dev/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-08-13T03:11:35","documenter_version":"1.5.0"}} \ No newline at end of file +{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-08-13T03:19:03","documenter_version":"1.5.0"}} \ No newline at end of file diff --git a/dev/index.html b/dev/index.html index c2c1aff..7dfcfe7 100644 --- a/dev/index.html +++ b/dev/index.html @@ -1,21 +1,21 @@ Home · SeisMakie.jl
GitHub

SeisMakie

Documentation for SeisMakie.

SeisMakie.seisDifference — Method
SeisDifference(d1, d2; <keyword arguments>)

Plot time-space, 2D seismic data d1, d2, and their difference (d1 - d2) with color, wiggles or overlay. The plots are arranged horizontally by default.

Arguments:

  • d1::Matrix{<:AbstractFloat}: the measured seismic traces. Number of columns corresponds to number of traces whereas number of rows corresponds to the number of times amplitude was measured for each trace
  • d2::Matrix{<:AbstractFloat}: same description as d1.

Keyword Arguments:

  • fig=nothing: the figure we want to plot on. If not supplied, one will be created and returned.

  • gx::Vector{<:Real}=nothing: the real coordinates of the seismometers corresponding to the traces in d

  • ox=0: first point of x-axis.

  • dx=1: increment of x-axis.

  • oy=0: first point of y-axis.

  • dy=1: increment of y-axis.

  • pclip=98: percentile for determining clip.

  • vmin=nothing: minimum value used in colormapping data.

  • vmax=nothing: maximum value used in colormapping data.

  • wiggle_fill_color=:black: color for filling the positive wiggles.

  • wiggle_line_color=:black: color for wiggles' lines.

  • wiggle_trace_increment=1: increment for wiggle traces.

  • xcur=1.2: wiggle excursion in traces corresponding to clip.

  • cmap=:viridis: the colormap to be used for color and overlay plots.

  • style: determines the type of plot. Can be either "wiggle"/"wiggles", "color", "overlay".

  • horizontal=true: if set to false, d1, d2, and their difference are arranged vertically.

Return the figure and 3 axes corresponding to d1, d2, d1-d2.

Example

julia> d1 = SeisLinearEvents(); d2 = SeisLinearEvents();
-julia> f, ax1, ax2, ax_diff = SeisDifference(d1, d2);

Author: Firas Al Chalabi (2024)

source
SeisMakie.seisPlotAmplitude — Method
SeisPlotAmplitude(d,fmax,dy ; <keyword arguments>)

Plot amplitude-frequency 2D seismic data d

Arguments

  • d::Array{Real,2}: 2D data to plot.

Keyword arguments

  • fig=nothing: the figure we want to plot on. If not supplied, one will be created and returned.

  • ax=nothing: the axis we want to plot on. If not supplied, one will be created and returned.

  • fmax=100: maximum frequency.

  • dy=0.004: time sample interval.

  • normalize=false: whether or not to normalize the data

  • color=:red: color of the plot.

  • label="": plot label to be included in legend

Example

julia> d = SeisLinearEvents();
-julia> f, ax = SeisPlotAmplitude(d,100,0.004);

Author: Firas Al Chalabi (2024)

source
SeisMakie.seisPlotFK — Method
SeisPlotFK(d; <keyword arguments>)

Plot frequency-wavenumber 2D seismic data d.

Arguments

  • d::Matrix{<:AbstractFloat}: 2D data to plot.

Keyword arguments:

  • fig=nothing: the figure we want to plot on. If not supplied, one will be created and returned.

  • pclip=99.9: percentile for determining clip.

  • vmin=nothing: minimum value used in colormapping data.

  • vmax=nothing: maximum value used in colormapping data.

  • fmax=100: maximum frequency for "FK" or "Amplitude" plot.

  • dx=1: increment of x-axis.

  • dy=1: increment of y-axis.

  • cmap=:PuOr: colormap

Return the figure and axis corresponding to d.

Example

julia> d = SeisLinearEvents();
-julia> f, ax = SeisPlotFK(d);

Author: Firas Al Chalabi (2024)

source
SeisMakie.seisPlotTX — Method
SeisPlotTX(d; <keyword arguments>)

Plot time-space, 2D seismic data d with image, wiggles or overlay.

Arguments:

  • d::Matrix{<:AbstractFloat}: the measured seismic traces. Number of columns corresponds to number of traces whereas number of rows corresponds to the number of times amplitude was measured for each trace

Keyword Arguments:

  • fig=nothing: the figure we want to plot on. If not supplied, one will be created and returned.

  • gx::Vector{<:Real}=nothing: the real coordinates of the seismometers corresponding to the traces in d. Only supported with style="wiggles"

  • ox=0: first point of x-axis.

  • dx=1: increment of x-axis.

  • oy=0: first point of y-axis.

  • dy=1: increment of y-axis.

  • pclip=98: percentile for determining clip.

  • vmin=nothing: minimum value used in colormapping data.

  • vmax=nothing: maximum value used in colormapping data.

  • wiggle_fill_color=:black: color for filling the positive wiggles.

  • wiggle_line_color=:black: color for wiggles' lines.

  • wiggle_trace_increment=1: increment for wiggle traces.

  • xcur=1.2: wiggle excursion in traces corresponding to clip.

  • cmap=:seismic: the colormap to be used for image and overlay plots.

  • style: determines the type of plot. Can be either "wiggle"/"wiggles", "image", "overlay".

Return the figure and axis corresponding to d.

Example

julia> d = SeisLinearEvents();
-julia> f, ax = SeisPlotTX(d);

Author: Firas Al Chalabi (2024)

source
SeisMakie.seisamplitudeplot — Method
seisamplitude(d; <keyword arguments>)
+julia> f, ax1, ax2, ax_diff = SeisDifference(d1, d2);

Author: Firas Al Chalabi (2024)

source
SeisMakie.seisPlotAmplitude — Method
SeisPlotAmplitude(d,fmax,dy ; <keyword arguments>)

Plot amplitude-frequency 2D seismic data d

Arguments

  • d::Array{Real,2}: 2D data to plot.

Keyword arguments

  • fig=nothing: the figure we want to plot on. If not supplied, one will be created and returned.

  • ax=nothing: the axis we want to plot on. If not supplied, one will be created and returned.

  • fmax=100: maximum frequency.

  • dy=0.004: time sample interval.

  • normalize=false: whether or not to normalize the data

  • color=:red: color of the plot.

  • label="": plot label to be included in legend

Example

julia> d = SeisLinearEvents();
+julia> f, ax = SeisPlotAmplitude(d,100,0.004);

Author: Firas Al Chalabi (2024)

source
SeisMakie.seisPlotFK — Method
SeisPlotFK(d; <keyword arguments>)

Plot frequency-wavenumber 2D seismic data d.

Arguments

  • d::Matrix{<:AbstractFloat}: 2D data to plot.

Keyword arguments:

  • fig=nothing: the figure we want to plot on. If not supplied, one will be created and returned.

  • pclip=99.9: percentile for determining clip.

  • vmin=nothing: minimum value used in colormapping data.

  • vmax=nothing: maximum value used in colormapping data.

  • fmax=100: maximum frequency for "FK" or "Amplitude" plot.

  • dx=1: increment of x-axis.

  • dy=1: increment of y-axis.

  • cmap=:PuOr: colormap

Return the figure and axis corresponding to d.

Example

julia> d = SeisLinearEvents();
+julia> f, ax = SeisPlotFK(d);

Author: Firas Al Chalabi (2024)

source
SeisMakie.seisPlotTX — Method
SeisPlotTX(d; <keyword arguments>)

Plot time-space, 2D seismic data d with image, wiggles or overlay.

Arguments:

  • d::Matrix{<:AbstractFloat}: the measured seismic traces. Number of columns corresponds to number of traces whereas number of rows corresponds to the number of times amplitude was measured for each trace

Keyword Arguments:

  • fig=nothing: the figure we want to plot on. If not supplied, one will be created and returned.

  • gx::Vector{<:Real}=nothing: the real coordinates of the seismometers corresponding to the traces in d. Only supported with style="wiggles"

  • ox=0: first point of x-axis.

  • dx=1: increment of x-axis.

  • oy=0: first point of y-axis.

  • dy=1: increment of y-axis.

  • pclip=98: percentile for determining clip.

  • vmin=nothing: minimum value used in colormapping data.

  • vmax=nothing: maximum value used in colormapping data.

  • wiggle_fill_color=:black: color for filling the positive wiggles.

  • wiggle_line_color=:black: color for wiggles' lines.

  • wiggle_trace_increment=1: increment for wiggle traces.

  • xcur=1.2: wiggle excursion in traces corresponding to clip.

  • cmap=:seismic: the colormap to be used for image and overlay plots.

  • style: determines the type of plot. Can be either "wiggle"/"wiggles", "image", "overlay".

Return the figure and axis corresponding to d.

Example

julia> d = SeisLinearEvents();
+julia> f, ax = SeisPlotTX(d);

Author: Firas Al Chalabi (2024)

source
SeisMakie.seisamplitudeplot — Method
seisamplitude(d; <keyword arguments>)
 seisamplitude!(ax, d; <keyword arguments>)

Plot amplitude-frequency 2D seismic data d.

Arguments

  • d::Array{Real,2}: 2D data to plot.

Keyword arguments

  • fmax=100: maximum frequency.

  • dy=0.004: time sample interval.

  • normalize=false: whether or not to normalize the data

  • color=:black: color of the plot.

  • label="": plot label to be included in legend

Examples

julia> d = SeisLinearEvents();
 julia> f, ax, amp = seisamplitude(d)
julia> d = SeisLinearEvents(); f = Figure(); ax = Axis(f)
-julia> amp = seisamplitude!(ax, d)

Author: Firas Al Chalabi (2024) Credits: Aaron Stanton (2015)

  • Most of the code in this file is taken from SeisPlot.jl written by Aaron Stanton.
source
SeisMakie.seisfkplot — Method
seisfk(d; <keyword arguments>)
+julia> amp = seisamplitude!(ax, d)

Author: Firas Al Chalabi (2024) Credits: Aaron Stanton (2015)

  • Most of the code in this file is taken from SeisPlot.jl written by Aaron Stanton.
source
SeisMakie.seisfkplot — Method
seisfk(d; <keyword arguments>)
 seisfk!(ax, d; <keyword arguments>)

Plot frequency-wavenumber 2D seismic data d.

Arguments

  • d::Matrix{<:AbstractFloat}: 2D data to plot.

Keyword arguments:

  • fig=nothing: the figure we want to plot on. If not supplied, one will be created and returned.

  • pclip=99.9: percentile for determining clip.

  • vmin=nothing: minimum value used in colormapping data.

  • vmax=nothing: maximum value used in colormapping data.

  • fmax=100: maximum frequency for "FK" or "Amplitude" plot.

  • dx=1: increment of x-axis.

  • dy=1: increment of y-axis.

  • cmap=:PuOr: colormap

Return the figure and axis corresponding to d.

Examples

julia> d = SeisLinearEvents();
 julia> f, ax, fk = seisfk(d)
julia> d = SeisLinearEvents(); f = Figure(); ax = Axis(f)
-julia> fk = seisfk!(ax, d)

Author: Firas Al Chalabi (2024) Credits: Aaron Stanton (2015)

  • Most of the code in this file is taken from SeisPlot.jl written by Aaron Stanton.
source
SeisMakie.seisimageplot — Method
seisimage(d; <keyword arguments>);
+julia> fk = seisfk!(ax, d)

Author: Firas Al Chalabi (2024) Credits: Aaron Stanton (2015)

  • Most of the code in this file is taken from SeisPlot.jl written by Aaron Stanton.
source
SeisMakie.seisimageplot — Method
seisimage(d; <keyword arguments>);
 seisimage!(ax, d; <keyword arguments>);

Recipe to plot time-space, color plot of 2D seismic data d.

Arguments:

  • d::Matrix{<:AbstractFloat}: 2D seismic data to be plotted.

Keyword Arguments:

  • ox=0: first point of x-axis.

  • dx=1: increment of x-axis.

  • oy=0: first point of y-axis.

  • dy=1: increment of y-axis.

  • pclip=98: percentile for determining clip.

  • vmin=nothing: minimum value used in colormapping data.

  • vmax=nothing: maximum value used in colormapping data.

  • cmap=:seismic: the colormap to be used.

Examples

julia> d = SeisLinearEvents();
 julia> f, ax, img = seisimage(d)
julia> d = SeisLinearEvents(); f = Figure(); ax = Axis(f)
-julia> img = seisimage!(ax, d)

Author: Firas Al Chalabi (2024) Credits: Aaron Stanton (2015)

  • Most of the code in this file is taken from SeisPlot.jl written by Aaron Stanton.
source
SeisMakie.seisoverlayplot — Method
seisoverlay(d; <keyword arguments>)
+julia> img = seisimage!(ax, d)

Author: Firas Al Chalabi (2024) Credits: Aaron Stanton (2015)

  • Most of the code in this file is taken from SeisPlot.jl written by Aaron Stanton.
source
SeisMakie.seisoverlayplot — Method
seisoverlay(d; <keyword arguments>)
 seisoverlay!(ax, d; <keyword arguments>)

Recipe to plot time-space, overlay plot of 2D seismic data d.

Arguments:

  • d::Matrix{<:AbstractFloat}: 2D seismic data to be plotted.

Keyword Arguments:

  • ox=0: first point of x-axis.

  • dx=1: increment of x-axis.

  • oy=0: first point of y-axis.

  • dy=1: increment of y-axis.

  • pclip=98: percentile for determining clip.

  • vmin=nothing: minimum value used in colormapping data.

  • vmax=nothing: maximum value used in colormapping data.

  • wiggle_fill_color=:black: color for filling the positive wiggles.

  • wiggle_line_color=:black: color for wiggles' lines.

  • wiggle_trace_increment=1: increment for wiggle traces.

  • xcur=1.2: wiggle excursion in traces corresponding to clip.

  • cmap=:seismic: the colormap to be used.

Examples

julia> d = SeisLinearEvents();
 julia> f, ax, ov = seisoverlay(d)
julia> d = SeisLinearEvents(); f = Figure(); ax = Axis(f)
-julia> ov = seisoverlay!(ax, d)
source
SeisMakie.seiswiggleplot — Method
seiswiggle(d; <keyword arguments>)
 seiswiggle!(ax, d; <keyword arguments>)

Recipe to plot time-space, wiggle plot of 2D seismic data d.

Arguments:

  • d::Matrix{<:AbstractFloat}: the measured seismic traces. Number of columns corresponds to number of traces whereas number of rows corresponds to the number of times amplitude was measured for each trace

Keyword Arguments:

  • gx::Vector{<:Real}=nothing: the real coordinates of the seismometers corresponding to the traces in d

  • ox=0: first point of x-axis.

  • dx=1: increment of x-axis.

  • oy=0: first point of y-axis.

  • dy=1: increment of y-axis.

  • wiggle_fill_color=:black: color for filling the positive wiggles.

  • wiggle_line_color=:black: color for wiggles' lines.

  • wiggle_trace_increment=1: increment for wiggle traces.

  • xcur=1.2: wiggle excursion in traces.

Examples

julia> d = SeisLinearEvents();
 julia> f, ax, wp = seiswiggle(d)
julia> d = SeisLinearEvents(); f = Figure(); ax = Axis(f)
-julia> wp = seiswiggle!(ax, d)

Note: animations only work with this recipe if you update the observable d with a matrix of the same size.

Author: Firas Al Chalabi (2024) Credits: Aaron Stanton (2015)

  • The code in this file was inspired by some of Aaron Stanton's in SeisPlot.jl.
source
+julia> wp = seiswiggle!(ax, d)

Note: animations only work with this recipe if you update the observable d with a matrix of the same size.

Author: Firas Al Chalabi (2024) Credits: Aaron Stanton (2015)

source diff --git a/dev/objects.inv b/dev/objects.inv index aaa22bdfcf168d2384b2305cd3f1bc35ccd22c66..059434b13141c97fc09b37087476580152639df7 100644 GIT binary patch delta 14 VcmaFF^oVJK6SI+?!A4hEMgS&k1VR7+ delta 14 VcmaFF^oVJK6SJY7@kUo!MgS&s1VjJ;