Package adams.flow.transformer

Class ArrayStatistic

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class ArrayStatistic
extends AbstractTransformer
    Generates statistics from a double array or matrix. In case of an array, the data-type and location are ignored.

    Input/output:
    - accepts:
       java.lang.Double[]
       [Ljava.lang.Double;[]
    - generates:
       adams.core.io.SpreadSheet


    Valid options are: 

    -D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to
    the console (0 = off).
    default: 0
    minimum: 0
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: ArrayStatistic
 
    -annotation <adams.core.base.BaseText> (property: annotations)
    The annotations to attach to this actor.
    default:
 
    -skip (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded
    as it is.
 
    -stop-flow-on-error (property: stopFlowOnError)
    If set to true, the flow gets stopped in case this actor encounters an error;
     useful for critical actors.
 
    -type <ROW_BY_INDEX|COLUMN_BY_INDEX> (property: dataType)
    In case of a double matrix, whether to retrieve rows or columns; ignored
    in case of simple double arrays.
    default: COLUMN_BY_INDEX
 
    -location <adams.core.base.BaseString> [-location ...] (property: locations)
    The locations of the data; An index is a number starting with 1; the following
    placeholders can be used as well: first, second, third, last_2, last_1,
    last
    default:
 
    -statistic <adams.data.statistics.AbstractArrayStatistic> (property: statistic)
    The statistic to generate from the data.
    default: adams.data.statistics.ArrayMean
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_DataType

        protected ArrayStatisticDataType m_DataType
        the type of data to get from the double matrix (rows or columns).

      • m_Locations

        protected BaseString[] m_Locations
        the array of indices expressions.

    • Constructor Detail

      • ArrayStatistic

        public ArrayStatistic()

    • Method Detail

      • setDataType

        public void setDataType​(ArrayStatisticDataType value)
        Sets what type of data to retrieve from the Instances object.
        Parameters:
        value - the type of conversion

      • getDataType

        public ArrayStatisticDataType getDataType()
        Returns what type of data to retrieve from the Instances object.
        Returns:
        the type of conversion

      • dataTypeTipText

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

      • setLocations

        public void setLocations​(BaseString[] value)
        Sets the locations of the data (indices/regular expressions on attribute name).
        Parameters:
        value - the locations of the data

      • getLocations

        public BaseString[] getLocations()
        Returns the locations of the data (indices/regular expressions on attribute name).
        Returns:
        the locations of the data

      • locationsTipText

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

      • setStatistic

        public void setStatistic​(AbstractArrayStatistic value)
        Sets the statistic to use.
        Parameters:
        value - the statistic

      • getStatistic

        public AbstractArrayStatistic getStatistic()
        Returns the statistic in use.
        Returns:
        the statistic

      • statisticTipText

        public String statisticTipText()
        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 the consumer accepts.
        Returns:
        java.lang.Double[].class, [Ljava.lang.Double;[].class

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Returns:
        adams.core.io.SpreadSheet.class

      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class AbstractActor
        Returns:
        null if everything is fine, otherwise error message