Class TensorToSpreadSheet

  • 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 TensorToSpreadSheet
    extends adams.data.conversion.AbstractConversion
    Turns a Tensor data structure into a spreadsheet.
    - 1D: single row
    - 2D: matrix
    - 3D: three index columns (X,Y,Z) and data column

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
        The logging level for outputting errors and debugging output.
        default: WARNING
     
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form
    • Field Summary

      • 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 adams.data.spreadsheet.SpreadSheet convert​(double[] data)
      Converts the 1-D tensor data.
      protected adams.data.spreadsheet.SpreadSheet convert​(double[][] data)
      Converts the 2-D tensor data.
      protected adams.data.spreadsheet.SpreadSheet convert​(double[][][] data)
      Converts the 3-D tensor data.
      protected Object doConvert()
      Performs the actual conversion.
      Class generates()
      Returns the class that is generated as output.
      String globalInfo()
      Returns a string describing the object.
      • Methods inherited from class adams.data.conversion.AbstractConversion

        checkData, cleanUp, convert, getAdditionalInformation, getInput, getInput, getOutput, getOutput, getOwner, getQuickInfo, reset, setInput, setOwner, shallowCopy, shallowCopy, stopExecution
      • Methods inherited from class adams.core.option.AbstractOptionHandler

        cleanUpOptions, defineOptions, 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
    • Constructor Detail

      • TensorToSpreadSheet

        public TensorToSpreadSheet()
    • 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
      • 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
      • convert

        protected adams.data.spreadsheet.SpreadSheet convert​(double[] data)
        Converts the 1-D tensor data.
        Parameters:
        data - the tensor data
        Returns:
        the generated spreadsheet (single row)
      • convert

        protected adams.data.spreadsheet.SpreadSheet convert​(double[][] data)
        Converts the 2-D tensor data.
        Parameters:
        data - the tensor data
        Returns:
        the generated spreadsheet (matrix)
      • convert

        protected adams.data.spreadsheet.SpreadSheet convert​(double[][][] data)
        Converts the 3-D tensor data.
        Parameters:
        data - the tensor data
        Returns:
        the generated spreadsheet (three index cols (XYZ) and a data col)
      • 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