weka.knowledgeflow.steps.ImageViewer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of weka-dev Show documentation
The Waikato Environment for Knowledge Analysis (WEKA), a machine learning workbench. This version represents the developer version, the "bleeding edge" of development, you could say. New functionality gets added to this version.
There is a newer version: 3.9.6
Show newest version
/*
 *   This program is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation, either version 3 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program.  If not, see .
 */

/*
 *    ImageViewer.java
 *    Copyright (C) 2015 University of Waikato, Hamilton, New Zealand
 *
 */

package weka.knowledgeflow.steps;

import weka.core.WekaException;
import weka.gui.knowledgeflow.KFGUIConsts;
import weka.knowledgeflow.Data;
import weka.knowledgeflow.StepManager;

import javax.imageio.ImageIO;
import java.awt.image.BufferedImage;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Date;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;

/**
 * A step for collecting and viewing image data
 *
 * @author Mark Hall (mhall{[at]}pentaho{[dot]}com)
 * @version $Revision: $
 */
@KFStep(name = "ImageViewer", category = "Visualization",
  toolTipText = "View images", iconPath = KFGUIConsts.BASE_ICON_PATH
    + "StripChart.gif")
public class ImageViewer extends BaseStep implements DataCollector {

  private static final long serialVersionUID = -4055716444227948343L;

  /** Holds the received images */
  protected Map m_images =
    new LinkedHashMap();

  /**
   * Initialize the step. Nothing to do in the case of this step
   */
  @Override
  public void stepInit() {
    // nothing to do
  }

  /**
   * Get a list of acceptable incoming connections - only StepManager.CON_IMAGE
   * in this case
   * 
   * @return a list of acceptable incoming connections
   */
  @Override
  public List getIncomingConnectionTypes() {
    return Arrays.asList(StepManager.CON_IMAGE);
  }

  /**
   * Get a list of outgoing connections that can be generated given the current
   * state of the step - will produce StepManager.CON_IMAGE data if we have at
   * least one incoming image connection connection
   * 
   * @return a list of outgoing connections
   */
  @Override
  public List getOutgoingConnectionTypes() {
    return getStepManager().numIncomingConnectionsOfType(StepManager.CON_IMAGE) > 0 ? Arrays
      .asList(StepManager.CON_IMAGE) : new ArrayList();
  }

  /**
   * Process incoming image data
   *
   * @param data the data to process
   * @throws WekaException if a problem occurs
   */
  @Override
  public synchronized void processIncoming(Data data) throws WekaException {
    getStepManager().processing();
    String imageTitle =
      data.getPayloadElement(StepManager.CON_AUX_DATA_TEXT_TITLE);
    BufferedImage image = data.getPrimaryPayload();

    if (image == null) {
      throw new WekaException("Data does not seem to contain an image!");
    }

    String date = (new SimpleDateFormat("HH:mm:ss.SSS - ")).format(new Date());
    if (imageTitle != null) {
      imageTitle = date + imageTitle;
    } else {
      imageTitle = date + "Untitled";
    }

    m_images.put(imageTitle, image);

    getStepManager().logDetailed("Storing image: " + imageTitle);

    // pass on downstream
    getStepManager().outputData(data);
    getStepManager().finished();
  }

  /**
   * Get a map of named images that this step has collected
   *
   * @return a map of named images
   */
  public Map getImages() {
    return m_images;
  }

  /**
   * Gets a list of classes of viewers that can be popped up in the GUI
   * Knowledge Flow from this step, given that we have received and stored some
   * image data.
   *
   * @return a list of viewer classes
   */
  @Override
  public Map getInteractiveViewers() {
    Map views = new LinkedHashMap();

    if (m_images.size() > 0) {
      views.put("Show images",
        "weka.gui.knowledgeflow.steps.ImageViewerInteractiveView");
    }

    return views;
  }

  /**
   * Retrieve the data stored in this step. This is a map of png image data (as
   * raw bytes), keyed by image name.
   *
   * @return the data stored in this step
   */
  @Override
  public Object retrieveData() {
    // As BufferedImage is not serializable, we need to store raw
    // png bytes in a map.
    return bufferedImageMapToSerializableByteMap(m_images);
  }

  /**
   * Restore data for this step. Argument is expected to be a map of png image
   * data (as raw bytes) keyed by image name
   *
   * @param data the data to set
   * @throws WekaException if a problem occurs
   */
  @SuppressWarnings("unchecked")
  @Override
  public void restoreData(Object data) throws WekaException {
    if (!(data instanceof Map)) {
      throw new IllegalArgumentException("Argument for restoring data must "
        + "be a map");
    }

    try {
      m_images = byteArrayImageMapToBufferedImageMap((Map) data);
    } catch (IOException e) {
      throw new WekaException(e);
    }
  }

  /**
   * Utility method to convert a map of {@code byte[]} png image data to
   * a map of {@code BufferedImage}
   *
   * @param dataMap the map containing raw png byte arrays
   * @return a map of {@code BufferedImage}s
   * @throws IOException if a problem occurs
   */
  public static Map byteArrayImageMapToBufferedImageMap(
    Map dataMap) throws IOException {
    Map restored =
      new LinkedHashMap();
    // need to restore from map of raw png byte data
    Map serializableMap = (Map) dataMap;
    for (Map.Entry e : serializableMap.entrySet()) {
      String title = e.getKey();
      byte[] png = e.getValue();
      ByteArrayInputStream bais = new ByteArrayInputStream(png);

      BufferedImage bi = ImageIO.read(bais);
      if (bi != null) {
        restored.put(title, bi);
      }
    }
    return restored;
  }

  /**
   * Utility method to convert a map of {@code BufferedImage} to a map of byte
   * arrays (that hold each image as png bytes)
   *
   * @param images the map of {@code BufferedImage}s to convert
   * @return a map of png byte arrays
   */
  public static Map bufferedImageMapToSerializableByteMap(
    Map images) {
    Map serializableMap = new LinkedHashMap();
    for (Map.Entry e : images.entrySet()) {
      String title = e.getKey();
      BufferedImage b = e.getValue();
      ByteArrayOutputStream baos = new ByteArrayOutputStream();
      try {
        ImageIO.write(b, "png", baos);
        serializableMap.put(title, baos.toByteArray());
      } catch (IOException ex) {
        ex.printStackTrace();
      }
    }

    return serializableMap;
  }
}