Package adams.data.io.output

Class SimpleImageHeatmapWriter

  • All Implemented Interfaces:
    adams.core.AdditionalInformationHandler, adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.io.FileFormatHandler, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.ShallowCopySupporter<adams.data.io.output.AbstractDataContainerWriter>, adams.core.SizeOfHandler, Serializable, Comparable
    public class SimpleImageHeatmapWriter
extends AbstractHeatmapWriter
    Turns the heatmap into an image and uses the specified image writer for saving it to a file. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -output <adams.core.io.PlaceholderFile> (property: output)
    The file to write the container to.
    default: ${TMP}/out.tmp
 
    -conversion <adams.data.conversion.HeatmapToBufferedImage> (property: conversion)
    The conversion for turning the heatmap into an image before writing it to 
    a file.
    default: adams.data.conversion.HeatmapToBufferedImage -generator adams.gui.visualization.core.BiColorGenerator
 
    -writer <adams.data.io.output.AbstractImageWriter> (property: writer)
    The image writer to use.
    default: adams.data.io.output.JAIImageWriter
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected HeatmapToBufferedImage m_Conversion
      for converting the heatmap into an image.
      protected adams.data.io.output.ImageWriter m_Writer
      the writer to use.

      • Fields inherited from class adams.data.io.output.AbstractDataContainerWriter

        m_Output, m_OutputIsFile

      • Fields inherited from class adams.core.option.AbstractOptionHandler

        m_OptionManager

      • Fields inherited from class adams.core.logging.LoggingObject

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String conversionTipText()
      Returns the tip text for this property.
      void defineOptions()
      Adds options to the internal list of options.
      HeatmapToBufferedImage getConversion()
      Returns the conversion to use for converting the heatmap into an image for the image writer.
      String getFormatDescription()
      Returns a string describing the format (used in the file chooser).
      String[] getFormatExtensions()
      Returns the extension(s) of the format.
      adams.data.io.output.ImageWriter getWriter()
      Returns the image writer to use.
      String globalInfo()
      Returns a string describing the object.
      protected void initialize()
      Initializes the members.
      void setConversion​(HeatmapToBufferedImage value)
      Sets the conversion for converting the heatmap into an image for the image writer.
      void setWriter​(adams.data.io.output.ImageWriter value)
      Sets the image writer to use.
      protected boolean writeData​(List<Heatmap> data)
      Performs the actual writing.
      String writerTipText()
      Returns the tip text for this property.

      • Methods inherited from class adams.data.io.output.AbstractDataContainerWriter

        cleanUp, compareTo, destroy, equals, forCommandLine, forName, getAdditionalInformation, getDefaultFormatExtension, getOutput, isOutputFile, outputTipText, reset, setOutput, shallowCopy, shallowCopy, write, write

      • Methods inherited from class adams.core.option.AbstractOptionHandler

        cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

      • Methods inherited from class adams.core.logging.LoggingObject

        configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

      • Methods inherited from interface adams.core.logging.LoggingLevelHandler

        getLoggingLevel

    • Field Detail

      • m_Writer

        protected adams.data.io.output.ImageWriter m_Writer
        the writer to use.

    • Constructor Detail

      • SimpleImageHeatmapWriter

        public SimpleImageHeatmapWriter()

    • Method Detail

      • globalInfo

        public String globalInfo()
        Returns a string describing the object.
        Specified by:
        globalInfo in interface adams.core.GlobalInfoSupporter
        Specified by:
        globalInfo in class adams.core.option.AbstractOptionHandler
        Returns:
        a description suitable for displaying in the gui

      • defineOptions

        public void defineOptions()
        Adds options to the internal list of options.
        Specified by:
        defineOptions in interface adams.core.option.OptionHandler
        Overrides:
        defineOptions in class adams.data.io.output.AbstractDataContainerWriter<Heatmap>

      • initialize

        protected void initialize()
        Initializes the members.
        Overrides:
        initialize in class adams.core.option.AbstractOptionHandler

      • getFormatDescription

        public String getFormatDescription()
        Returns a string describing the format (used in the file chooser).
        Specified by:
        getFormatDescription in interface adams.core.io.FileFormatHandler
        Specified by:
        getFormatDescription in class adams.data.io.output.AbstractDataContainerWriter<Heatmap>
        Returns:
        a description suitable for displaying in the file chooser

      • getFormatExtensions

        public String[] getFormatExtensions()
        Returns the extension(s) of the format.
        Specified by:
        getFormatExtensions in interface adams.core.io.FileFormatHandler
        Specified by:
        getFormatExtensions in class adams.data.io.output.AbstractDataContainerWriter<Heatmap>
        Returns:
        the extension(s) (without the dot!)

      • setConversion

        public void setConversion​(HeatmapToBufferedImage value)
        Sets the conversion for converting the heatmap into an image for the image writer.
        Parameters:
        value - the conversion

      • getConversion

        public HeatmapToBufferedImage getConversion()
        Returns the conversion to use for converting the heatmap into an image for the image writer.
        Returns:
        the conversion

      • conversionTipText

        public String conversionTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setWriter

        public void setWriter​(adams.data.io.output.ImageWriter value)
        Sets the image writer to use.
        Parameters:
        value - the writer

      • getWriter

        public adams.data.io.output.ImageWriter getWriter()
        Returns the image writer to use.
        Returns:
        the writer

      • writerTipText

        public String writerTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • writeData

        protected boolean writeData​(List<Heatmap> data)
        Performs the actual writing.
        Specified by:
        writeData in class adams.data.io.output.AbstractDataContainerWriter<Heatmap>
        Parameters:
        data - the data to write
        Returns:
        true if successfully written