theoryviz.py¶
TheoryViz
¶
TheoryViz(model: Any, plot_parameters: Any, rsm: RichterSlopeModel, *args, **kwargs)
flowchart TD
erosionfront.visualization.theoryviz.TheoryViz[TheoryViz]
erosionfront.visualization.base.GraphingBase[GraphingBase]
erosionfront.visualization.base.GraphingBase --> erosionfront.visualization.theoryviz.TheoryViz
click erosionfront.visualization.theoryviz.TheoryViz href "" "erosionfront.visualization.theoryviz.TheoryViz"
click erosionfront.visualization.base.GraphingBase href "" "erosionfront.visualization.base.GraphingBase"
XXXX
Parameters¶
XXX
Attributes¶
TBD
Returns¶
XXX
Subclasses :class:gmplib.plot.GraphingBase.
Parameters:
-
–kwargs¶arguments to pass to :class:
gmplib.plot.GraphingBaseconstructor
Methods:
-
create_figure–Initialize a :mod:
Pyplot <matplotlib.pyplot>figure. -
get_aspect–Get aspect ratio of graph.
-
get_fonts–Fetch the names of all the font families available on the system.
-
naturalize–Adjust graph aspect ratio into 'natural' ratio.
-
plot_erosionrate_vs_surfaceangle–XXXX
-
plot_initial_profile–XXXX
-
plot_normalslowness_figuratrix–XXXX
-
plot_normalspeed_figuratrix–XXXX
-
plot_normalspeedxy_figuratrix–XXXX
-
plot_ray_indicatrix–XXXX
-
set_markers–XXXX
-
stretch–Stretch graph axes by respective factors.
Source code in erosionfront/visualization/theoryviz.py
create_figure
¶
create_figure(
fig_name: str, fig_size: tuple[float, float] | None = None, dpi: int | None = None
) -> Figure
Initialize a :mod:Pyplot <matplotlib.pyplot> figure.
Set its size and dpi, set the font size, choose the Arial font family if possible, and append it to the figures dictionary.
Parameters¶
fig_name: name of figure; used as key in figures dictionary fig_size: optional width and height of figure in inches dpi: rasterization resolution
Returns¶
:obj:Pyplot figure <matplotlib.figure.Figure>:
reference to :mod:MatPlotLib/Pyplot <matplotlib.pyplot>
figure
Source code in erosionfront/visualization/base.py
get_aspect
¶
get_aspect(axes: Axes) -> float
Get aspect ratio of graph.
Parameters¶
axes:
the axes object of the figure
Returns¶
float: aspect ratio
Source code in erosionfront/visualization/base.py
get_fonts
¶
Fetch the names of all the font families available on the system.
Source code in erosionfront/visualization/base.py
naturalize
¶
Adjust graph aspect ratio into 'natural' ratio.
Source code in erosionfront/visualization/base.py
plot_erosionrate_vs_surfaceangle
¶
plot_erosionrate_vs_surfaceangle(
fig_name: str,
rsm: RichterSlopeModel,
arrays: Arrays,
model: Any,
aspect: float | None = None,
fig_size: tuple[float, float] = (8, 5),
) -> None
XXXX
Parameters¶
XXX
Attributes¶
TBD
Returns¶
XXX
Source code in erosionfront/visualization/theoryviz.py
plot_initial_profile
¶
plot_initial_profile(
fig_name: str,
rsm: RichterSlopeModel,
surface: (
StraightLineSurface
| ErrorFunctionSurface
| SemiCircularArcSurface
| QuarterCircularArcSurface
),
model: Any,
aspect: float | None = None,
Δt: float = 0.15,
fig_size: tuple[float, float] = (6, 6),
limits: tuple[tuple[float, float], tuple[float, float]] = (
(0.7, 1.5),
(-0.03, 1.26),
),
do_zoom: bool = False,
) -> None
XXXX
Parameters¶
XXX
Attributes¶
TBD
Returns¶
XXX
Source code in erosionfront/visualization/theoryviz.py
549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 | |
plot_normalslowness_figuratrix
¶
plot_normalslowness_figuratrix(
fig_name: str,
rsm: RichterSlopeModel,
arrays: Arrays,
model: Any,
plot_parameters: Any,
aspect: float | None = 1,
fig_size: tuple[float, float] = (6, 6),
) -> None
XXXX
Parameters¶
XXX
Attributes¶
TBD
Returns¶
XXX
Source code in erosionfront/visualization/theoryviz.py
plot_normalspeed_figuratrix
¶
plot_normalspeed_figuratrix(
fig_name: str,
rsm: RichterSlopeModel,
arrays: Arrays,
model: Any,
aspect: float | None = 1,
fig_size: tuple[float, float] = (6, 6),
) -> None
XXXX
Parameters¶
XXX
Attributes¶
TBD
Returns¶
XXX
Source code in erosionfront/visualization/theoryviz.py
plot_normalspeedxy_figuratrix
¶
plot_normalspeedxy_figuratrix(
fig_name: str,
rsm: RichterSlopeModel,
arrays: Arrays,
model: Any,
aspect: float | None = 1,
fig_size: tuple[float, float] = (6, 6),
) -> None
XXXX
Parameters¶
XXX
Attributes¶
TBD
Returns¶
XXX
Source code in erosionfront/visualization/theoryviz.py
plot_ray_indicatrix
¶
plot_ray_indicatrix(
fig_name: str,
rsm: RichterSlopeModel,
arrays: Arrays,
model: Any,
aspect: float | None = 1,
fig_size: tuple[float, float] = (6, 6),
) -> None
XXXX
Parameters¶
XXX
Attributes¶
TBD
Returns¶
XXX
Source code in erosionfront/visualization/theoryviz.py
set_markers
¶
set_markers(model: Any, plot_parameters: Any, rsm: RichterSlopeModel) -> None
XXXX
Parameters¶
XXX
Attributes¶
TBD
Returns¶
XXX
Source code in erosionfront/visualization/theoryviz.py
stretch
¶
stretch(
fig: Figure,
xs: tuple[float, float] | None = None,
ys: tuple[float, float] | None = None,
) -> None
Stretch graph axes by respective factors.
Source code in erosionfront/visualization/base.py
mark_angles
¶
mark_angles(
x_lambda: Callable | None,
z_lambda: Callable | None,
idtx_fgtx_markers: list | None,
p_or_v: int = 0,
do_skip_β0: bool = False,
) -> None
XXXX
Parameters¶
XXX
Attributes¶
TBD
Returns¶
XXX
Source code in erosionfront/visualization/theoryviz.py
plot_segments
¶
plot_segments(
rsm: RichterSlopeModel,
x: NDArray,
y: NDArray,
β: NDArray,
label_fn: Callable[[str], str] = lambda x: f"{x}",
do_v: bool = False,
) -> None
XXXX
Parameters¶
XXX
Attributes¶
TBD
Returns¶
XXX
Source code in erosionfront/visualization/theoryviz.py
patch_idtx_fgtx_markers
¶
XXXX
Parameters¶
XXX
Attributes¶
TBD
Returns¶
XXX