Package adams.data.io.input

Class ImageClassificationSpreadSheetReportReader

  • All Implemented Interfaces:
    CleanUpHandler, Destroyable, GlobalInfoSupporter, FileFormatHandler, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<AbstractReportReader>, SizeOfHandler, Stoppable, StoppableWithFeedback, ReportReader<Report>, Serializable, Comparable
    public class ImageClassificationSpreadSheetReportReader
extends AbstractReportReader<Report>
    Retrieves the label with the highest score from the spreadsheet and stores them in a report. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -input <adams.core.io.PlaceholderFile> (property: input)
    The file to read and turn into a report.
    default: ${CWD}
 
    -reader <adams.data.io.input.SpreadSheetReader> (property: reader)
    The spreadsheet reader to use.
    default: adams.data.io.input.CsvSpreadSheetReader -data-row-type adams.data.spreadsheet.DenseDataRow -spreadsheet-type adams.data.spreadsheet.DefaultSpreadSheet
 
    -column-label <adams.data.spreadsheet.SpreadSheetColumnIndex> (property: columnLabel)
    The spreadsheet column containing the label.
    default: first
    example: An index is a number starting with 1; column names (case-sensitive) as well as the following placeholders can be used: first, second, third, last_2, last_1, last; numeric indices can be enforced by preceding them with '#' (eg '#12'); column names can be surrounded by double quotes.
 
    -column-score <adams.data.spreadsheet.SpreadSheetColumnIndex> (property: columnScore)
    The spreadsheet column containing the score.
    default: second
    example: An index is a number starting with 1; column names (case-sensitive) as well as the following placeholders can be used: first, second, third, last_2, last_1, last; numeric indices can be enforced by preceding them with '#' (eg '#12'); column names can be surrounded by double quotes.
 
    -field-label <adams.data.report.Field> (property: fieldLabel)
    The field to store the label under.
    default: Classification[S]
 
    -field-score <adams.data.report.Field> (property: fieldScore)
    The field to store the score under.
    default: Score[N]
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_FieldLabel

        protected Field m_FieldLabel
        the report field to store the label under.

      • m_FieldScore

        protected Field m_FieldScore
        the report file to store the score under.

    • Constructor Detail

      • ImageClassificationSpreadSheetReportReader

        public ImageClassificationSpreadSheetReportReader()

    • Method Detail

      • setReader

        public void setReader​(SpreadSheetReader value)
        Sets the spreadsheet reader to use.
        Parameters:
        value - the reader

      • getReader

        public SpreadSheetReader getReader()
        Returns the spreadsheet reader to use.
        Returns:
        the reader

      • readerTipText

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

      • setColumnLabel

        public void setColumnLabel​(SpreadSheetColumnIndex value)
        Sets the column containing the label.
        Parameters:
        value - the column

      • getColumnLabel

        public SpreadSheetColumnIndex getColumnLabel()
        Returns the column containing the label.
        Returns:
        the column

      • columnLabelTipText

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

      • setColumnScore

        public void setColumnScore​(SpreadSheetColumnIndex value)
        Sets the column containing the score.
        Parameters:
        value - the column

      • getColumnScore

        public SpreadSheetColumnIndex getColumnScore()
        Returns the column containing the score.
        Returns:
        the column

      • columnScoreTipText

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

      • setFieldLabel

        public void setFieldLabel​(Field value)
        Sets the field for the label.
        Parameters:
        value - the field

      • getFieldLabel

        public Field getFieldLabel()
        Returns the field for the label.
        Returns:
        the field

      • fieldLabelTipText

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

      • setFieldScore

        public void setFieldScore​(Field value)
        Sets the field for the score.
        Parameters:
        value - the field

      • getFieldScore

        public Field getFieldScore()
        Returns the field for the score.
        Returns:
        the field

      • fieldScoreTipText

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

      • determineParentID

        protected int determineParentID​(Report report)
        Tries to determine the parent ID for the current report.
        Specified by:
        determineParentID in class AbstractReportReader<Report>
        Parameters:
        report - the report to determine the ID for
        Returns:
        the parent database ID, -1 if it cannot be determined