boofcv.gui.image.ShowImages Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of boofcv-swing Show documentation
BoofCV is an open source Java library for real-time computer vision and robotics applications.
There is a newer version: 1.1.7
/*
 * Copyright (c) 2022, Peter Abeles. All Rights Reserved.
 *
 * This file is part of BoofCV (http://boofcv.org).
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package boofcv.gui.image;

import boofcv.alg.misc.GImageStatistics;
import boofcv.gui.BoofSwingUtil;
import boofcv.io.image.ConvertBufferedImage;
import boofcv.misc.BoofMiscOps;
import boofcv.struct.image.ImageBase;
import boofcv.struct.image.ImageGray;

import javax.swing.*;
import java.awt.*;
import java.awt.image.BufferedImage;

/**
 * Displays images in a new window.
 *
 * @author Peter Abeles
 */
public class ShowImages {

	/**
	 * Creates a dialog window showing the specified image. The function will not
	 * exit until the user clicks ok
	 */
	public static void showDialog( BufferedImage img ) {
		ImageIcon icon = new ImageIcon();
		icon.setImage(img);
		JOptionPane.showMessageDialog(null, icon);
	}

	/**
	 * Shows a set of images in a grid pattern.
	 *
	 * @param numColumns How many columns are in the grid
	 * @param title Number of the window
	 * @param images List of images to show
	 * @return Display panel
	 */
	public static ImageGridPanel showGrid( int numColumns, String title, BufferedImage... images ) {
		JFrame frame = new JFrame(title);

		int numRows = images.length/numColumns + images.length%numColumns;
		ImageGridPanel panel = new ImageGridPanel(numRows, numColumns, images);

		frame.add(panel, BorderLayout.CENTER);

		frame.pack();
		frame.setVisible(true);

		return panel;
	}

	/**
	 * Creates a window showing the specified image.
	 */
	public static ImagePanel showWindow( BufferedImage img, String title ) {
		return showWindow(img, title, false);
	}

	/**
	 * Creates a window showing the specified image.
	 */
	public static ImagePanel showWindow( BufferedImage img, String title, boolean closeOnExit ) {
		JFrame frame = new JFrame(title);

		ImagePanel panel = new ImagePanel(img);
		panel.setScaling(ScaleOptions.DOWN);

		// If the window will be too large to be displayed on the monitor set the bounds to something that can be
		// shown. The default behavior will just change one axis leaving it to have an awkward appearance
		Rectangle monitorBounds = frame.getGraphicsConfiguration().getBounds();
		if (monitorBounds.width < img.getWidth() || monitorBounds.height < img.getHeight()) {
			double scale = Math.min(monitorBounds.width/(double)img.getWidth(), monitorBounds.height/(double)img.getHeight());
			int width = (int)(scale*img.getWidth());
			int height = (int)(scale*img.getHeight());
			panel.setPreferredSize(new Dimension(width, height));
		}

		frame.add(panel, BorderLayout.CENTER);
		frame.pack();
		setFrameLocation(frame);
		frame.setVisible(true);
		if (closeOnExit)
			frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);

		return panel;
	}

	public static ImagePanel showWindow( ImageBase img, String title ) {
		BufferedImage buff = ConvertBufferedImage.convertTo(img, null, true);
		return showWindow(buff, title);
	}

	/**
	 * Show a window for a set amount of time. Blocks until that time has elapsed
	 */
	public static void showBlocking( ImageBase img, String title, long milliseconds ) {
		showBlocking(img, title, milliseconds, false);
	}

	public static void showBlocking( ImageBase img, String title, long milliseconds, final boolean closeOnExit) {
		BufferedImage buff = ConvertBufferedImage.convertTo(img, null, true);
		ImagePanel panel = showWindow(buff, title, closeOnExit);
		BoofMiscOps.sleep(milliseconds);
		// close the window
		SwingUtilities.invokeLater(() -> {
			JFrame topFrame = (JFrame)SwingUtilities.getWindowAncestor(panel);
			topFrame.setVisible(false);
			topFrame.dispose();
		});
	}

	public static void showBlocking( JComponent component, String title, long milliseconds ) {
		JFrame frame = showWindow(component, title);
		BoofMiscOps.sleep(milliseconds);
		// close the window
		SwingUtilities.invokeLater(() -> {
			frame.setVisible(false);
			frame.dispose();
		});
	}

	public static JFrame showWindow( final JComponent component, String title ) {
		return showWindow(component, title, false);
	}

	public static JFrame showWindow( final JComponent component, String title, final boolean closeOnExit ) {
		final var frame = new JFrame(title);
		frame.add(component, BorderLayout.CENTER);

		SwingUtilities.invokeLater(() -> {
			Dimension screenSize = Toolkit.getDefaultToolkit().getScreenSize();

			frame.pack();
			setFrameLocation(frame);

			// prevent it from creating a window larger than the screen
			int width = frame.getWidth();
			int height = frame.getHeight();
			if (width > screenSize.width || height > screenSize.height) {
				width = Math.min(width, screenSize.width);
				height = Math.min(height, screenSize.height);
				frame.setSize(width, height);
			}

			frame.setVisible(true);
			if (closeOnExit)
				frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
		});

		return frame;
	}

	/**
	 * Sets up the window but doesn't show it. Must be called in a GUI thread
	 */
	public static JFrame setupWindow( final JComponent component, String title, final boolean closeOnExit ) {
		BoofSwingUtil.checkGuiThread();

		final JFrame frame = new JFrame(title);
		frame.add(component, BorderLayout.CENTER);

		frame.pack();
		setFrameLocation(frame);
		if (closeOnExit)
			frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);

		return frame;
	}

	/**
	 * Set location using a single function call to make sure all operations follow the same standard
	 */
	private static void setFrameLocation( JFrame frame ) {
		frame.setLocationByPlatform(true);
	}

	public static ImagePanel showWindow( ImageGray img, Colorization type, String title, boolean closeOnExit ) {
		double max = GImageStatistics.maxAbs(img);
		BufferedImage buff = switch (type) {
			case MAGNITUDE -> VisualizeImageData.grayMagnitude(img, null, max);
			case SIGN -> VisualizeImageData.colorizeSign(img, null, max);
			default -> throw new IllegalArgumentException("Unknown type. " + type);
		};

		return showWindow(buff, title, closeOnExit);
	}

	public enum Colorization {
		MAGNITUDE,
		SIGN
	}
}