Package adams.data.io.input

Class ImageClassificationJsonReportReader

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.io.input.AbstractReportReader<Report>

adams.data.io.input.ImageClassificationJsonReportReader

All Implemented Interfaces:

CleanUpHandler, Destroyable, GlobalInfoSupporter, FileFormatHandler, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<AbstractReportReader>, SizeOfHandler, Stoppable, StoppableWithFeedback, ReportReader<Report>, Serializable, Comparable

public class ImageClassificationJsonReportReader
extends AbstractReportReader<Report>

Retrieves the label with the highest score from the JSON file and stores them in a report.
JSON file format: { LABEL1: SCORE1; LABEL2: SCORE2; }

-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}
 

-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 Summary

Fields

Modifier and Type	Field	Description
protected Field	m_FieldLabel	the report field to store the label under.
protected Field	m_FieldScore	the report file to store the score under.

Fields inherited from class adams.data.io.input.AbstractReportReader

m_Input, 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

Constructor Summary

Constructors

Constructor	Description
ImageClassificationJsonReportReader()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected int	determineParentID(Report report)	Tries to determine the parent ID for the current report.
String	fieldLabelTipText()	Returns the tip text for this property.
String	fieldScoreTipText()	Returns the tip text for this property.
Field	getFieldLabel()	Returns the field for the label.
Field	getFieldScore()	Returns the field for the score.
String	getFormatDescription()	Returns a string describing the format (used in the file chooser).
String[]	getFormatExtensions()	Returns the extension(s) of the format.
String	globalInfo()	Returns a string describing the object.
Report	newInstance()	Returns a new instance of the report class in use.
protected List<Report>	readData()	Performs the actual reading.
void	setFieldLabel(Field value)	Sets the field for the label.
void	setFieldScore(Field value)	Sets the field for the score.

Methods inherited from class adams.data.io.input.AbstractReportReader

checkData, cleanUp, compareTo, destroy, equals, forCommandLine, forName, getDefaultFormatExtension, getInput, getReaders, inputTipText, isStopped, postRead, read, reset, setInput, shallowCopy, shallowCopy, stopExecution

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, 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 class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

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

ImageClassificationJsonReportReader

public ImageClassificationJsonReportReader()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class 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 OptionHandler

Overrides:

defineOptions in class AbstractReportReader<Report>

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.

getFormatDescription

public String getFormatDescription()

Returns a string describing the format (used in the file chooser).

Specified by:

getFormatDescription in interface FileFormatHandler

Specified by:

getFormatDescription in class AbstractReportReader<Report>

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 FileFormatHandler

Specified by:

getFormatExtensions in class AbstractReportReader<Report>

Returns:

the extension(s) (without the dot!)

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

newInstance

public Report newInstance()

Returns a new instance of the report class in use.

Specified by:

newInstance in class AbstractReportReader<Report>

Returns:

the new (empty) report

readData

protected List<Report> readData()

Performs the actual reading.

Specified by:

readData in class AbstractReportReader<Report>

Returns:

the reports that were read