Package adams.data.conversion

Class ThreeWayDataToHeatmap

  • All Implemented Interfaces:
    adams.core.AdditionalInformationHandler, adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.ShallowCopySupporter<adams.data.conversion.AbstractConversion>, adams.core.SizeOfHandler, adams.core.Stoppable, adams.data.conversion.Conversion, Serializable
    public class ThreeWayDataToHeatmap
extends adams.data.conversion.AbstractConversion
    Turns a adams.data.threeway.ThreeWayData data structure into a heatmap.
    Sums up the data values of the Z layers that fall into the specified min/max. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -min-z <double> (property: minZ)
    The minimum Z layer to include.
    default: 0.0
 
    -max-z <double> (property: maxZ)
    The maximum Z layer to include.
    default: 0.0
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected double m_MaxX
      the maximum x to use.
      protected double m_MinX
      the minimum x to use.

      • Fields inherited from class adams.data.conversion.AbstractConversion

        m_Input, m_Output, m_Owner, m_Stopped

      • 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
      Class accepts()
      Returns the class that is accepted as input.
      protected String checkData()
      Checks whether the data can be processed.
      void defineOptions()
      Adds options to the internal list of options.
      protected Object doConvert()
      Performs the actual conversion.
      Class generates()
      Returns the class that is generated as output.
      double getMaxX()
      Returns the maximum X layer to use.
      double getMinX()
      Returns the minimum X layer to use.
      String globalInfo()
      Returns a string describing the object.
      String maxXTipText()
      Returns the tip text for this property.
      String minXTipText()
      Returns the tip text for this property.
      void setMaxX​(double value)
      Sets the maximum X layer to use.
      void setMinX​(double value)
      Sets the minimum X layer to use.

      • Methods inherited from class adams.data.conversion.AbstractConversion

        cleanUp, convert, getAdditionalInformation, getInput, getInput, getOutput, getOutput, getOwner, getQuickInfo, reset, setInput, setOwner, shallowCopy, shallowCopy, stopExecution

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

        cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, 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_MinX

        protected double m_MinX
        the minimum x to use.

      • m_MaxX

        protected double m_MaxX
        the maximum x to use.

    • Constructor Detail

      • ThreeWayDataToHeatmap

        public ThreeWayDataToHeatmap()

    • 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.core.option.AbstractOptionHandler

      • setMinX

        public void setMinX​(double value)
        Sets the minimum X layer to use.
        Parameters:
        value - the minimum X

      • getMinX

        public double getMinX()
        Returns the minimum X layer to use.
        Returns:
        the minimum X

      • minXTipText

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

      • setMaxX

        public void setMaxX​(double value)
        Sets the maximum X layer to use.
        Parameters:
        value - the maximum X

      • getMaxX

        public double getMaxX()
        Returns the maximum X layer to use.
        Returns:
        the maximum X

      • maxXTipText

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

      • accepts

        public Class accepts()
        Returns the class that is accepted as input.
        Specified by:
        accepts in interface adams.data.conversion.Conversion
        Specified by:
        accepts in class adams.data.conversion.AbstractConversion
        Returns:
        the class

      • generates

        public Class generates()
        Returns the class that is generated as output.
        Specified by:
        generates in interface adams.data.conversion.Conversion
        Specified by:
        generates in class adams.data.conversion.AbstractConversion
        Returns:
        the class

      • checkData

        protected String checkData()
        Checks whether the data can be processed.
        Overrides:
        checkData in class adams.data.conversion.AbstractConversion
        Returns:
        null if checks passed, otherwise error message

      • doConvert

        protected Object doConvert()
                    throws Exception
        Performs the actual conversion.
        Specified by:
        doConvert in class adams.data.conversion.AbstractConversion
        Returns:
        the converted data
        Throws:
        Exception - if something goes wrong with the conversion