
Plot scatterer geometry, stored model results, or stored TMM scattering views
Source:R/scatterer_plot.R
plot.Scatterer.RdS3 plotting method for Scatterer objects. Depending on type, the method
draws the target geometry, one or more stored model curves, or a stored
single-target TMM scattering slice / map when the object was computed with
retained T-matrix state.
Usage
# S3 method for class 'Scatterer'
plot(
x,
y = NULL,
type = "shape",
nudge_y = 1.1,
nudge_x = 1.05,
aspect_ratio = "manual",
x_units = "frequency",
y_units = "TS",
...
)Arguments
- x
Scatterer-class object.
- y
Ignored (required for the base
plot()method signature).- type
Plot mode. Use
"shape"for the stored geometry,"model"for the currently stored model output, or"scattering"for storedTMMangular products.- nudge_y
Multiplicative vertical padding applied to automatically derived y-axis limits.
- nudge_x
Multiplicative horizontal padding applied to automatically derived x-axis limits.
- aspect_ratio
Aspect-ratio control for supported shape plots. Use
"manual"to honornudge_x/nudge_y, or"auto"to let the plotting helper derive the aspect ratio directly.- x_units
Horizontal-axis convention for
type = "model". Supported values depend on the stored model family and typically include"frequency"and geometry-scaled wavenumber variants such as"ka".- y_units
Stored response quantity for
type = "model"ortype = "scattering". Typical values include"TS"and"sigma_bs".- ...
Additional arguments passed through to the class-specific plotting helpers. For stored
TMMscattering plots, this includes controls such asfrequency,vary,polar, andheatmap.
Details
This method dispatches to the relevant scatterer-class plotting helper:
cal_plot(), ess_plot(), sbf_plot(), bbf_plot(), fls_plot(), or
gas_plot(). The supported type values therefore depend on what has been
stored on the object. For example, type = "model" requires the object to
already contain model output, and type = "scattering" currently applies
only to stored TMM results.