plenoptic.plot.mad_imshow_all#

plenoptic.plot.mad_imshow_all(mad_metric1_min, mad_metric2_min, mad_metric1_max, mad_metric2_max, metric1_name=None, metric2_name=None, zoom=1, **kwargs)[source]#

Display all MAD Competition images.

To generate a full set of MAD Competition images, you need four instances: one for minimizing and maximizing each metric. This helper function creates a figure to display the full set of images.

In addition to the four MAD Competition images, this also plots the initial image from mad_metric1_min, for comparison.

Parameters:

  • mad_metric1_min (MADCompetition) – MADCompetition object that minimized the first metric.

  • mad_metric2_min (MADCompetition) – MADCompetition object that minimized the second metric.

  • mad_metric1_max (MADCompetition) – MADCompetition object that maximized the first metric.

  • mad_metric2_max (MADCompetition) – MADCompetition object that maximized the second metric.

  • metric1_name (str | None (default: None)) – Name of the first metric. If None, we use the name of the optimized_metric function from mad_metric1_min.

  • metric2_name (str | None (default: None)) – Name of the second metric. If None, we use the name of the optimized_metric function from mad_metric2_min.

  • zoom (int | float (default: 1)) – Ratio of display pixels to image pixels. See synthesis_imshow for details.

  • **kwargs (Any) – Passed to synthesis_imshow.

Return type:

Figure

Returns:

fig – Figure containing the images.

Raises:

ValueError – If the four MADCompetition instances do not have the same image attribute.

See also

synthesis_imshow

Display the image from a single MADCompetition instance.

synthesis_status

Create a composite plot showing synthesis status of a single MADCompetition instance.

Examples

See the MAD Competition tutorial notebooks in the User Guide of documentation for examples.