diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json index 84f2423..e08b8dd 100644 --- a/dev/.documenter-siteinfo.json +++ b/dev/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.10.2","generation_timestamp":"2024-03-08T00:33:13","documenter_version":"1.3.0"}} \ No newline at end of file +{"documenter":{"julia_version":"1.10.2","generation_timestamp":"2024-03-15T07:53:20","documenter_version":"1.3.0"}} \ No newline at end of file diff --git a/dev/index.html b/dev/index.html index 4e1b8fc..175204e 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);
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);
source
SeisMakie.SeisPlotFK — Method
SeisPlotFK(d; <keyword arguments>)

Plot time-space, frequency-wavenumber or amplitude-frequency 2D seismic data d with color, wiggles or overlay.

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 for "color" or "overlay" style.

Return the figure and axis corresponding to d.

Example

julia> d = SeisLinearEvents(); 
-julia> f, ax = SeisPlotFK(d);
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);
source
SeisMakie.seisamplitude — Method
seisamplitude(d; <keyword arguments>)
+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.seisamplitude — 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)
source
SeisMakie.seisfk — Method
seisfk(d; <keyword arguments>)
-seisfk!(ax, d; <keyword arguments>)
Plot time-space, frequency-wavenumber or amplitude-frequency 2D seismic data d with color, wiggles or overlay.
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 for  "color" or "overlay" style.
Return the figure and axis corresponding to d.
Examples
julia> d = SeisLinearEvents();
+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.seisfk — 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)
source
SeisMakie.seisimage — 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.seisimage — 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)
source
SeisMakie.seisoverlay — 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.seisoverlay — 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.seiswiggle — 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)
source

+julia> wp = seiswiggle!(ax, d)

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
diff --git a/dev/objects.inv b/dev/objects.inv index 68df3ed..07263e1 100644 --- a/dev/objects.inv +++ b/dev/objects.inv @@ -2,6 +2,6 @@ # Project: SeisMakie.jl # Version: 1.0.0-DEV # The remainder of this file is compressed using zlib. -xAk@ uoMzB/"BJ롷0Nҩ$k Ѯ^v`PXʨPDwBtW/H?#7d7`?|d -z(>8Ѽk%/2M}NM(M"6Q&ϧF`,}'F?'&:ܷ)ngޞ%z[`0r5} -xx֚wUqR"C/n5+9PYџX2lN \ No newline at end of file +xQ +@5@XAQ-NզNBfI6ኀÍD\!d*}@Dsvm Yo+ZF?Pg|B }P{I*<+joAcBKrc'7>ECm 菿(ϙ +-K`(m̱w7=&#NDNfD~kg^ E' \ No newline at end of file diff --git a/dev/search_index.js b/dev/search_index.js index d9e7396..0c02c20 100644 --- a/dev/search_index.js +++ b/dev/search_index.js @@ -1,3 +1,3 @@ var documenterSearchIndex = {"docs": -[{"location":"","page":"Home","title":"Home","text":"CurrentModule = SeisMakie","category":"page"},{"location":"#SeisMakie","page":"Home","title":"SeisMakie","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Documentation for SeisMakie.","category":"page"},{"location":"","page":"Home","title":"Home","text":"","category":"page"},{"location":"","page":"Home","title":"Home","text":"Modules = [SeisMakie]","category":"page"},{"location":"#SeisMakie.SeisDifference-Tuple{Any, Any}","page":"Home","title":"SeisMakie.SeisDifference","text":"SeisDifference(d1, d2; )\n\nPlot time-space, 2D seismic data d1, d2, and their difference (d1 - d2) with color, wiggles or overlay. The plots are arranged horizontally by default.\n\nArguments:\n\nd1::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\nd2::Matrix{<:AbstractFloat}: same description as d1.\n\nKeyword Arguments:\n\nfig=nothing: the figure we want to plot on. If not supplied, one will be created and returned.\ngx::Vector{<:Real}=nothing: the real coordinates of the seismometers corresponding to the traces in d\nox=0: first point of x-axis.\ndx=1: increment of x-axis.\noy=0: first point of y-axis.\ndy=1: increment of y-axis.\npclip=98: percentile for determining clip.\nvmin=nothing: minimum value used in colormapping data.\nvmax=nothing: maximum value used in colormapping data.\nwiggle_fill_color=:black: color for filling the positive wiggles.\nwiggle_line_color=:black: color for wiggles' lines.\nwiggle_trace_increment=1: increment for wiggle traces.\nxcur=1.2: wiggle excursion in traces corresponding to clip.\ncmap=:viridis: the colormap to be used for color and overlay plots.\nstyle: determines the type of plot. Can be either \"wiggle\"/\"wiggles\", \"color\", \"overlay\".\nhorizontal=true: if set to false, d1, d2, and their difference are arranged vertically.\n\nReturn the figure and 3 axes corresponding to d1, d2, d1-d2.\n\nExample\n\njulia> d1 = SeisLinearEvents(); d2 = SeisLinearEvents();\njulia> f, ax1, ax2, ax_diff = SeisDifference(d1, d2);\n\n\n\n\n\n","category":"method"},{"location":"#SeisMakie.SeisPlotAmplitude-Tuple{Matrix{<:Real}}","page":"Home","title":"SeisMakie.SeisPlotAmplitude","text":"SeisPlotAmplitude(d,fmax,dy ; )\n\nPlot amplitude-frequency 2D seismic data d\n\nArguments\n\nd::Array{Real,2}: 2D data to plot.\n\nKeyword arguments\n\nfig=nothing: the figure we want to plot on. If not supplied, one will be created and returned.\nax=nothing: the axis we want to plot on. If not supplied, one will be created and returned.\nfmax=100: maximum frequency.\ndy=0.004: time sample interval.\nnormalize=false: whether or not to normalize the data\ncolor=:red: color of the plot.\nlabel=\"\": plot label to be included in legend\n\nExample\n\njulia> d = SeisLinearEvents();\njulia> f, ax = SeisPlotAmplitude(d,100,0.004);\n\n\n\n\n\n","category":"method"},{"location":"#SeisMakie.SeisPlotFK-Tuple{Any}","page":"Home","title":"SeisMakie.SeisPlotFK","text":"SeisPlotFK(d; )\n\nPlot time-space, frequency-wavenumber or amplitude-frequency 2D seismic data d with color, wiggles or overlay.\n\nArguments\n\nd::Matrix{<:AbstractFloat}: 2D data to plot.\n\nKeyword arguments:\n\nfig=nothing: the figure we want to plot on. If not supplied, one will be created and returned.\npclip=99.9: percentile for determining clip.\nvmin=nothing: minimum value used in colormapping data.\nvmax=nothing: maximum value used in colormapping data.\nfmax=100: maximum frequency for \"FK\" or \"Amplitude\" plot.\ndx=1: increment of x-axis.\ndy=1: increment of y-axis.\ncmap=:PuOr: colormap for \"color\" or \"overlay\" style.\n\nReturn the figure and axis corresponding to d.\n\nExample\n\njulia> d = SeisLinearEvents(); \njulia> f, ax = SeisPlotFK(d);\n\n\n\n\n\n","category":"method"},{"location":"#SeisMakie.SeisPlotTX-Tuple{Any}","page":"Home","title":"SeisMakie.SeisPlotTX","text":"SeisPlotTX(d; )\n\nPlot time-space, 2D seismic data d with image, wiggles or overlay.\n\nArguments:\n\nd::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\n\nKeyword Arguments:\n\nfig=nothing: the figure we want to plot on. If not supplied, one will be created and returned.\ngx::Vector{<:Real}=nothing: the real coordinates of the seismometers corresponding to the traces in d. Only supported with style=\"wiggles\"\nox=0: first point of x-axis.\ndx=1: increment of x-axis.\noy=0: first point of y-axis.\ndy=1: increment of y-axis.\npclip=98: percentile for determining clip.\nvmin=nothing: minimum value used in colormapping data.\nvmax=nothing: maximum value used in colormapping data.\nwiggle_fill_color=:black: color for filling the positive wiggles.\nwiggle_line_color=:black: color for wiggles' lines.\nwiggle_trace_increment=1: increment for wiggle traces.\nxcur=1.2: wiggle excursion in traces corresponding to clip.\ncmap=:seismic: the colormap to be used for image and overlay plots.\nstyle: determines the type of plot. Can be either \"wiggle\"/\"wiggles\", \"image\", \"overlay\".\n\nReturn the figure and axis corresponding to d.\n\nExample\n\njulia> d = SeisLinearEvents();\njulia> f, ax = SeisPlotTX(d);\n\n\n\n\n\n","category":"method"},{"location":"#SeisMakie.__create_axis-Tuple{Any}","page":"Home","title":"SeisMakie.__create_axis","text":"Creates an Axis object to be used by SeisColor, SeisOverlay, SeisWiggle.\n\n\n\n\n\n","category":"method"},{"location":"#SeisMakie.seisamplitude-Tuple","page":"Home","title":"SeisMakie.seisamplitude","text":"seisamplitude(d; )\nseisamplitude!(ax, d; )\n\nPlot amplitude-frequency 2D seismic data d.\n\nArguments\n\nd::Array{Real,2}: 2D data to plot.\n\nKeyword arguments\n\nfmax=100: maximum frequency.\ndy=0.004: time sample interval.\nnormalize=false: whether or not to normalize the data\ncolor=:black: color of the plot.\nlabel=\"\": plot label to be included in legend\n\nExamples\n\njulia> d = SeisLinearEvents();\njulia> f, ax, amp = seisamplitude(d)\n\njulia> d = SeisLinearEvents(); f = Figure(); ax = Axis(f)\njulia> amp = seisamplitude!(ax, d)\n\n\n\n\n\n","category":"method"},{"location":"#SeisMakie.seisfk-Tuple","page":"Home","title":"SeisMakie.seisfk","text":"seisfk(d; )\nseisfk!(ax, d; )\n\nPlot time-space, frequency-wavenumber or amplitude-frequency 2D seismic data d with color, wiggles or overlay.\n\nArguments\n\nd::Matrix{<:AbstractFloat}: 2D data to plot.\n\nKeyword arguments:\n\nfig=nothing: the figure we want to plot on. If not supplied, one will be created and returned.\npclip=99.9: percentile for determining clip.\nvmin=nothing: minimum value used in colormapping data.\nvmax=nothing: maximum value used in colormapping data.\nfmax=100: maximum frequency for \"FK\" or \"Amplitude\" plot.\ndx=1: increment of x-axis.\ndy=1: increment of y-axis.\ncmap=:PuOr: colormap for \"color\" or \"overlay\" style.\n\nReturn the figure and axis corresponding to d.\n\nExamples\n\njulia> d = SeisLinearEvents();\njulia> f, ax, fk = seisfk(d)\n\njulia> d = SeisLinearEvents(); f = Figure(); ax = Axis(f)\njulia> fk = seisfk!(ax, d)\n\n\n\n\n\n","category":"method"},{"location":"#SeisMakie.seisimage-Tuple","page":"Home","title":"SeisMakie.seisimage","text":"seisimage(d; );\nseisimage!(ax, d; );\n\nRecipe to plot time-space, color plot of 2D seismic data d.\n\nArguments:\n\nd::Matrix{<:AbstractFloat}: 2D seismic data to be plotted.\n\nKeyword Arguments:\n\nox=0: first point of x-axis.\ndx=1: increment of x-axis.\noy=0: first point of y-axis.\ndy=1: increment of y-axis.\npclip=98: percentile for determining clip.\nvmin=nothing: minimum value used in colormapping data.\nvmax=nothing: maximum value used in colormapping data.\ncmap=:seismic: the colormap to be used.\n\nExamples\n\njulia> d = SeisLinearEvents();\njulia> f, ax, img = seisimage(d)\n\njulia> d = SeisLinearEvents(); f = Figure(); ax = Axis(f)\njulia> img = seisimage!(ax, d)\n\n\n\n\n\n","category":"method"},{"location":"#SeisMakie.seisoverlay-Tuple","page":"Home","title":"SeisMakie.seisoverlay","text":"seisoverlay(d; )\nseisoverlay!(ax, d; )\n\nRecipe to plot time-space, overlay plot of 2D seismic data d.\n\nArguments:\n\nd::Matrix{<:AbstractFloat}: 2D seismic data to be plotted.\n\nKeyword Arguments:\n\nox=0: first point of x-axis.\ndx=1: increment of x-axis.\noy=0: first point of y-axis.\ndy=1: increment of y-axis.\npclip=98: percentile for determining clip.\nvmin=nothing: minimum value used in colormapping data.\nvmax=nothing: maximum value used in colormapping data.\nwiggle_fill_color=:black: color for filling the positive wiggles.\nwiggle_line_color=:black: color for wiggles' lines.\nwiggle_trace_increment=1: increment for wiggle traces.\nxcur=1.2: wiggle excursion in traces corresponding to clip.\ncmap=:seismic: the colormap to be used.\n\nExamples\n\njulia> d = SeisLinearEvents();\njulia> f, ax, ov = seisoverlay(d)\n\njulia> d = SeisLinearEvents(); f = Figure(); ax = Axis(f)\njulia> ov = seisoverlay!(ax, d)\n\n\n\n\n\n","category":"method"},{"location":"#SeisMakie.seiswiggle-Tuple","page":"Home","title":"SeisMakie.seiswiggle","text":"seiswiggle(d; )\nseiswiggle!(ax, d; )\n\nRecipe to plot time-space, wiggle plot of 2D seismic data d.\n\nArguments:\n\nd::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\n\nKeyword Arguments:\n\ngx::Vector{<:Real}=nothing: the real coordinates of the seismometers corresponding to the traces in d\nox=0: first point of x-axis.\ndx=1: increment of x-axis.\noy=0: first point of y-axis.\ndy=1: increment of y-axis.\nwiggle_fill_color=:black: color for filling the positive wiggles.\nwiggle_line_color=:black: color for wiggles' lines.\nwiggle_trace_increment=1: increment for wiggle traces.\nxcur=1.2: wiggle excursion in traces.\n\nExamples\n\njulia> d = SeisLinearEvents();\njulia> f, ax, wp = seiswiggle(d)\n\njulia> d = SeisLinearEvents(); f = Figure(); ax = Axis(f)\njulia> wp = seiswiggle!(ax, d)\n\n\n\n\n\n","category":"method"}] +[{"location":"","page":"Home","title":"Home","text":"CurrentModule = SeisMakie","category":"page"},{"location":"#SeisMakie","page":"Home","title":"SeisMakie","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Documentation for SeisMakie.","category":"page"},{"location":"","page":"Home","title":"Home","text":"","category":"page"},{"location":"","page":"Home","title":"Home","text":"Modules = [SeisMakie]","category":"page"},{"location":"#SeisMakie.SeisDifference-Tuple{Any, Any}","page":"Home","title":"SeisMakie.SeisDifference","text":"SeisDifference(d1, d2; )\n\nPlot time-space, 2D seismic data d1, d2, and their difference (d1 - d2) with color, wiggles or overlay. The plots are arranged horizontally by default.\n\nArguments:\n\nd1::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\nd2::Matrix{<:AbstractFloat}: same description as d1.\n\nKeyword Arguments:\n\nfig=nothing: the figure we want to plot on. If not supplied, one will be created and returned.\ngx::Vector{<:Real}=nothing: the real coordinates of the seismometers corresponding to the traces in d\nox=0: first point of x-axis.\ndx=1: increment of x-axis.\noy=0: first point of y-axis.\ndy=1: increment of y-axis.\npclip=98: percentile for determining clip.\nvmin=nothing: minimum value used in colormapping data.\nvmax=nothing: maximum value used in colormapping data.\nwiggle_fill_color=:black: color for filling the positive wiggles.\nwiggle_line_color=:black: color for wiggles' lines.\nwiggle_trace_increment=1: increment for wiggle traces.\nxcur=1.2: wiggle excursion in traces corresponding to clip.\ncmap=:viridis: the colormap to be used for color and overlay plots.\nstyle: determines the type of plot. Can be either \"wiggle\"/\"wiggles\", \"color\", \"overlay\".\nhorizontal=true: if set to false, d1, d2, and their difference are arranged vertically.\n\nReturn the figure and 3 axes corresponding to d1, d2, d1-d2.\n\nExample\n\njulia> d1 = SeisLinearEvents(); d2 = SeisLinearEvents();\njulia> f, ax1, ax2, ax_diff = SeisDifference(d1, d2);\n\nAuthor: Firas Al Chalabi (2024)\n\n\n\n\n\n","category":"method"},{"location":"#SeisMakie.SeisPlotAmplitude-Tuple{Matrix{<:Real}}","page":"Home","title":"SeisMakie.SeisPlotAmplitude","text":"SeisPlotAmplitude(d,fmax,dy ; )\n\nPlot amplitude-frequency 2D seismic data d\n\nArguments\n\nd::Array{Real,2}: 2D data to plot.\n\nKeyword arguments\n\nfig=nothing: the figure we want to plot on. If not supplied, one will be created and returned.\nax=nothing: the axis we want to plot on. If not supplied, one will be created and returned.\nfmax=100: maximum frequency.\ndy=0.004: time sample interval.\nnormalize=false: whether or not to normalize the data\ncolor=:red: color of the plot.\nlabel=\"\": plot label to be included in legend\n\nExample\n\njulia> d = SeisLinearEvents();\njulia> f, ax = SeisPlotAmplitude(d,100,0.004);\n\nAuthor: Firas Al Chalabi (2024)\n\n\n\n\n\n","category":"method"},{"location":"#SeisMakie.SeisPlotFK-Tuple{Any}","page":"Home","title":"SeisMakie.SeisPlotFK","text":"SeisPlotFK(d; )\n\nPlot frequency-wavenumber 2D seismic data d.\n\nArguments\n\nd::Matrix{<:AbstractFloat}: 2D data to plot.\n\nKeyword arguments:\n\nfig=nothing: the figure we want to plot on. If not supplied, one will be created and returned.\npclip=99.9: percentile for determining clip.\nvmin=nothing: minimum value used in colormapping data.\nvmax=nothing: maximum value used in colormapping data.\nfmax=100: maximum frequency for \"FK\" or \"Amplitude\" plot.\ndx=1: increment of x-axis.\ndy=1: increment of y-axis.\ncmap=:PuOr: colormap\n\nReturn the figure and axis corresponding to d.\n\nExample\n\njulia> d = SeisLinearEvents(); \njulia> f, ax = SeisPlotFK(d);\n\nAuthor: Firas Al Chalabi (2024)\n\n\n\n\n\n","category":"method"},{"location":"#SeisMakie.SeisPlotTX-Tuple{Any}","page":"Home","title":"SeisMakie.SeisPlotTX","text":"SeisPlotTX(d; )\n\nPlot time-space, 2D seismic data d with image, wiggles or overlay.\n\nArguments:\n\nd::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\n\nKeyword Arguments:\n\nfig=nothing: the figure we want to plot on. If not supplied, one will be created and returned.\ngx::Vector{<:Real}=nothing: the real coordinates of the seismometers corresponding to the traces in d. Only supported with style=\"wiggles\"\nox=0: first point of x-axis.\ndx=1: increment of x-axis.\noy=0: first point of y-axis.\ndy=1: increment of y-axis.\npclip=98: percentile for determining clip.\nvmin=nothing: minimum value used in colormapping data.\nvmax=nothing: maximum value used in colormapping data.\nwiggle_fill_color=:black: color for filling the positive wiggles.\nwiggle_line_color=:black: color for wiggles' lines.\nwiggle_trace_increment=1: increment for wiggle traces.\nxcur=1.2: wiggle excursion in traces corresponding to clip.\ncmap=:seismic: the colormap to be used for image and overlay plots.\nstyle: determines the type of plot. Can be either \"wiggle\"/\"wiggles\", \"image\", \"overlay\".\n\nReturn the figure and axis corresponding to d.\n\nExample\n\njulia> d = SeisLinearEvents();\njulia> f, ax = SeisPlotTX(d);\n\nAuthor: Firas Al Chalabi (2024)\n\n\n\n\n\n","category":"method"},{"location":"#SeisMakie.seisamplitude-Tuple","page":"Home","title":"SeisMakie.seisamplitude","text":"seisamplitude(d; )\nseisamplitude!(ax, d; )\n\nPlot amplitude-frequency 2D seismic data d.\n\nArguments\n\nd::Array{Real,2}: 2D data to plot.\n\nKeyword arguments\n\nfmax=100: maximum frequency.\ndy=0.004: time sample interval.\nnormalize=false: whether or not to normalize the data\ncolor=:black: color of the plot.\nlabel=\"\": plot label to be included in legend\n\nExamples\n\njulia> d = SeisLinearEvents();\njulia> f, ax, amp = seisamplitude(d)\n\njulia> d = SeisLinearEvents(); f = Figure(); ax = Axis(f)\njulia> amp = seisamplitude!(ax, d)\n\nAuthor: Firas Al Chalabi (2024) Credits: Aaron Stanton (2015)\n\nMost of the code in this file is taken from SeisPlot.jl written by Aaron Stanton.\n\n\n\n\n\n","category":"method"},{"location":"#SeisMakie.seisfk-Tuple","page":"Home","title":"SeisMakie.seisfk","text":"seisfk(d; )\nseisfk!(ax, d; )\n\nPlot frequency-wavenumber 2D seismic data d.\n\nArguments\n\nd::Matrix{<:AbstractFloat}: 2D data to plot.\n\nKeyword arguments:\n\nfig=nothing: the figure we want to plot on. If not supplied, one will be created and returned.\npclip=99.9: percentile for determining clip.\nvmin=nothing: minimum value used in colormapping data.\nvmax=nothing: maximum value used in colormapping data.\nfmax=100: maximum frequency for \"FK\" or \"Amplitude\" plot.\ndx=1: increment of x-axis.\ndy=1: increment of y-axis.\ncmap=:PuOr: colormap\n\nReturn the figure and axis corresponding to d.\n\nExamples\n\njulia> d = SeisLinearEvents();\njulia> f, ax, fk = seisfk(d)\n\njulia> d = SeisLinearEvents(); f = Figure(); ax = Axis(f)\njulia> fk = seisfk!(ax, d)\n\nAuthor: Firas Al Chalabi (2024) Credits: Aaron Stanton (2015)\n\nMost of the code in this file is taken from SeisPlot.jl written by Aaron Stanton.\n\n\n\n\n\n","category":"method"},{"location":"#SeisMakie.seisimage-Tuple","page":"Home","title":"SeisMakie.seisimage","text":"seisimage(d; );\nseisimage!(ax, d; );\n\nRecipe to plot time-space, color plot of 2D seismic data d.\n\nArguments:\n\nd::Matrix{<:AbstractFloat}: 2D seismic data to be plotted.\n\nKeyword Arguments:\n\nox=0: first point of x-axis.\ndx=1: increment of x-axis.\noy=0: first point of y-axis.\ndy=1: increment of y-axis.\npclip=98: percentile for determining clip.\nvmin=nothing: minimum value used in colormapping data.\nvmax=nothing: maximum value used in colormapping data.\ncmap=:seismic: the colormap to be used.\n\nExamples\n\njulia> d = SeisLinearEvents();\njulia> f, ax, img = seisimage(d)\n\njulia> d = SeisLinearEvents(); f = Figure(); ax = Axis(f)\njulia> img = seisimage!(ax, d)\n\nAuthor: Firas Al Chalabi (2024) Credits: Aaron Stanton (2015)\n\nMost of the code in this file is taken from SeisPlot.jl written by Aaron Stanton.\n\n\n\n\n\n","category":"method"},{"location":"#SeisMakie.seisoverlay-Tuple","page":"Home","title":"SeisMakie.seisoverlay","text":"seisoverlay(d; )\nseisoverlay!(ax, d; )\n\nRecipe to plot time-space, overlay plot of 2D seismic data d.\n\nArguments:\n\nd::Matrix{<:AbstractFloat}: 2D seismic data to be plotted.\n\nKeyword Arguments:\n\nox=0: first point of x-axis.\ndx=1: increment of x-axis.\noy=0: first point of y-axis.\ndy=1: increment of y-axis.\npclip=98: percentile for determining clip.\nvmin=nothing: minimum value used in colormapping data.\nvmax=nothing: maximum value used in colormapping data.\nwiggle_fill_color=:black: color for filling the positive wiggles.\nwiggle_line_color=:black: color for wiggles' lines.\nwiggle_trace_increment=1: increment for wiggle traces.\nxcur=1.2: wiggle excursion in traces corresponding to clip.\ncmap=:seismic: the colormap to be used.\n\nExamples\n\njulia> d = SeisLinearEvents();\njulia> f, ax, ov = seisoverlay(d)\n\njulia> d = SeisLinearEvents(); f = Figure(); ax = Axis(f)\njulia> ov = seisoverlay!(ax, d)\n\n\n\n\n\n","category":"method"},{"location":"#SeisMakie.seiswiggle-Tuple","page":"Home","title":"SeisMakie.seiswiggle","text":"seiswiggle(d; )\nseiswiggle!(ax, d; )\n\nRecipe to plot time-space, wiggle plot of 2D seismic data d.\n\nArguments:\n\nd::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\n\nKeyword Arguments:\n\ngx::Vector{<:Real}=nothing: the real coordinates of the seismometers corresponding to the traces in d\nox=0: first point of x-axis.\ndx=1: increment of x-axis.\noy=0: first point of y-axis.\ndy=1: increment of y-axis.\nwiggle_fill_color=:black: color for filling the positive wiggles.\nwiggle_line_color=:black: color for wiggles' lines.\nwiggle_trace_increment=1: increment for wiggle traces.\nxcur=1.2: wiggle excursion in traces.\n\nExamples\n\njulia> d = SeisLinearEvents();\njulia> f, ax, wp = seiswiggle(d)\n\njulia> d = SeisLinearEvents(); f = Figure(); ax = Axis(f)\njulia> wp = seiswiggle!(ax, d)\n\nAuthor: Firas Al Chalabi (2024) Credits: Aaron Stanton (2015) \n\nThe code in this file was inspired by some of Aaron Stanton's in SeisPlot.jl.\n\n\n\n\n\n","category":"method"}] }