virgil.plotting

Grid result with one axis per coordinate key of grid (every key but the flux), from virgil.grid_fit or virgil.limits; a full likelihood_grid is reduced to its maximum over flux. One coordinate gives a line plot.

The grid axes used to compute values.

What values holds; sets the default colour map, scale and labels.

For kind="flux" and "limit": flux ratios, contrasts or magnitude differences.

Confidence of a kind="limit" map, for its title.

Confidence of a kind="limit" map, for its title.

Coordinates to mark with a cross (truth) or circle (best fit).

Coordinates to mark with a cross (truth) or circle (best fit).

Mark the primary at the origin of sky maps (default True).

Key of the flux axis, if it is not the one key ending in flux.

Axes to draw on (default: a new figure of this size).

Axes to draw on (default: a new figure of this size).

Override the defaults for kind.

Override the defaults for kind.

Override the defaults for kind.

Override the defaults for kind.

(fig, ax); dra is x and ddec y whatever their order in grid.

A limit map (companion/primary flux ratios, one axis per coordinate key of grid, as from absil_limits or ruffio_upperlimit), or a radial_profile of one.

The grid axes of a limit map; must contain dra and ddec.

Magnitude differences (default), contrasts or flux ratios. Deeper limits are always drawn lower down.

Legend label; by default built from sigma or percentile.

Legend label; by default built from sigma or percentile.

Legend label; by default built from sigma or percentile.

Shade the 16-84 percentile range of each annulus (default True).

(dra, ddec, flux) of a detected companion to mark.

Annuli, passed to radial_profile.

Annuli, passed to radial_profile.

Annuli, passed to radial_profile.

Axes to draw on, e.g. to overlay several curves (default: a new figure of this size).

Axes to draw on, e.g. to overlay several curves (default: a new figure of this size).

Line and band colour.

(fig, ax).

Simulated searches, from injection_recovery.

"delta_chi2" (default), "log_bayes_factor" or "max_snr".

The statistic of the real data: a vertical line, with its false-alarm probability and 95% interval.

A false-alarm probability to draw as a horizontal line, with the threshold that reaches it.

Draw the single-position reference curve (default True; none for log_bayes_factor).

Title (default: statistic and number of draws), axes, and size of a new figure.

Title (default: statistic and number of draws), axes, and size of a new figure.

Title (default: statistic and number of draws), axes, and size of a new figure.

(fig, ax).

Simulated searches, from injection_recovery.

"delta_chi2", "log_bayes_factor" or "max_snr", or several.

Only injections of this flux or in this range, as for DetectionMC.roc; a list gives one curve per entry.

Only injections with separation in [lo, hi) (mas); a list gives one curve per bin.

Logarithmic false-positive axis.

Local significances at which to mark the single-position false-alarm probability and its threshold on each curve (the gap is the look-elsewhere effect); () marks nothing.

Title (default: what the curves share), axes, and size of a new figure.

Title (default: what the curves share), axes, and size of a new figure.

Title (default: what the curves share), axes, and size of a new figure.

(fig, ax).

Simulated searches with injections, from injection_recovery.

The detection statistic, e.g. "delta_chi2".

False-alarm probability of the threshold, e.g. 1.35e-3 (3σ).

The y-axis, as in plot_contrast_curve (delta_mag is 2.5 log10(primary/companion)).

Completeness levels to draw as lines (default 50% and 90%).

Bin edges (mas, and flux); by default every injected value is a cell.

Bin edges (mas, and flux); by default every injected value is a cell.

Colour map of the completeness, from 0 to 1.

Add a colour bar.

Title (default: statistic and FAP), axes, and size of a new figure.

Title (default: statistic and FAP), axes, and size of a new figure.

Title (default: statistic and FAP), axes, and size of a new figure.

(fig, ax).

One orbit, or many as one KeplerOrbit whose elements are 1-D arrays of equal length.

Measured positions to overlay, with n_sigma error ellipses.

A reference orbit, drawn as a thicker contrasting line.

Points along each orbit.

Size of the error ellipses, in standard deviations.

Colours of the ensemble and of the reference orbit.

Colours of the ensemble and of the reference orbit.

Opacity of each line; by default it falls with the number of orbits.

Colour map for the epochs' times.

Axes to draw on.

Size of a new figure.

(fig, ax).

Alone, prior draws from key; with latents, posterior draws. A MultipoleDisk needs a RadialGP profile; latents are drawn at its hyperparameters.

Pixel scale, mas.

PRNG key (prior).

Posterior latents, e.g. from laplace_samples. For a MultipoleDisk, a dict of disk paths, {"profile.z": ..., "harmonics.z": ...}, each (n, *shape); others keep their values.

Rendered images instead of a field (not for "multipole" cuts).

Prior draws (default 100).

Panel d. "principal": central row and column of a GaussianField. "axes": lines through the centre at axes_pa. "multipole": cosine amplitudes a_m(r) of η = Σ a_m cos mθ + b_m sin mθ (the residual without mean; a_0 is the azimuthal mean), one offset track per m = 0..mmax; for a MultipoleDisk, ln I₀ - μ and the coefficients c_m(r) of I/I₀. Default: "multipole" for a MultipoleField or disk, "principal" for a GaussianField, "axes" for images.

(PA in degrees, label), North through East, per "axes" cut.

Image side in pixels for a disk (default 64).

True image (posterior only): dashed in the cuts; the reference peak.

Posterior only. Panel c: mean over standard deviation of each pixel (grey where no spread); per-pixel S/N, not a detection significance.

Drawn on the map panels, as in plot_model.

S/N scale ("linear"/"log"), its top (default 99th percentile), faint cuts (100), title, size.

S/N scale ("linear"/"log"), its top (default 99th percentile), faint cuts (100), title, size.

S/N scale ("linear"/"log"), its top (default 99th percentile), faint cuts (100), title, size.

S/N scale ("linear"/"log"), its top (default 99th percentile), faint cuts (100), title, size.

S/N scale ("linear"/"log"), its top (default 99th percentile), faint cuts (100), title, size.

(fig, axes), axes a dict keyed "a" to "d". Prior cuts show η; others log10 brightness over the reference peak.

Model to render.

Width of the field of view in milliarcseconds.

Number of pixels on a side.

Axes to draw on; a new figure is made if omitted.

Axes title.

Quantile (e.g. 0.99) at which to saturate the colour scale.

Matplotlib colour map.

The data's resolution, from imaging.beam, drawn as a shaded FWHM ellipse in the lower-left corner.

Show the image convolved with beam (see imaging.convolve_beam).

The axes drawn on.

E.g. reconstruction.render(npix, fov) - truth.render(npix, fov), in the orientation of render.

Width of the field of view in milliarcseconds.

Uncertainty of the residual, per pixel or overall; if given, the map shows z-scores.

Axes to draw on; a new figure is made if omitted.

Axes title.

A diverging Matplotlib colour map.

The axes drawn on (with a colour bar).

Data to show. Flagged samples are drawn too: the coverage is that of the observation.

Axes to draw on; a new figure is made if omitted.

Colour map of the wavelength, used when the data have more than one wavelength (one colour otherwise).

Size of a new figure.

(fig, ax).

Data to show. Flagged samples are left out. Projected observables (vis_mat/phi_mat) have no baseline and are not shown against it.

Figure size.

(fig, (ax_uv, ax_vis, ax_phi)).

Observed data container.

Mapping label -> prediction summary where each summary contains vis_mean, vis_std, phi_mean, phi_std arrays.

Matplotlib color list. If omitted, cycle C0, C1, ...

Figure size.

Title for the phase panel.

If True, enforce square panel boxes for both subplots.

Axis label for the visibility observable. By default it follows oidata.vis_mode: V² and amplitudes are shown in percent, log-amplitudes and projected (e.g. DISCO) observables as plain values.

(fig, (ax1, ax2)) for visibility and phase axes. Data with no phase observables (e.g. AMIGO DISCOs, which hold every observable in vis) leave the phase axis hidden and give the visibility panel the whole figure.

Mapping label -> pandas.DataFrame containing chain samples.

Columns used for contour/corner plotting.

Truth mapping for columns displayed. When omitted, no truth overlay is drawn.

Per-chain colors.

Columns to show in walk plots. Defaults to columns.

(consumer, corner_fig, walks_fig): the configured ChainConsumer instance and the two figures it drew.

Mapping of sample arrays.

Key for right-ascension offsets.

Key for declination offsets.

Key for flux or log10-flux samples.

If True, exponentiate flux_key values as base-10.

Table with dra, ddec, flux, sep, and pa columns.

Mapping with dra, ddec, and flux values.

Cartesian and polar truth dictionaries.