weka.core.converters

Class ImageDirectoryLoader

java.lang.Object

weka.core.converters.AbstractLoader

weka.core.converters.ImageDirectoryLoader

All Implemented Interfaces:

java.io.Serializable, weka.core.CommandlineRunnable, weka.core.converters.BatchConverter, weka.core.converters.IncrementalConverter, weka.core.converters.Loader, weka.core.OptionHandler, weka.core.RevisionHandler

public class ImageDirectoryLoader
extends weka.core.converters.AbstractLoader
implements weka.core.converters.BatchConverter, weka.core.converters.IncrementalConverter, weka.core.CommandlineRunnable, weka.core.OptionHandler

Loader for image datasets that are in a folder-organized fashion i.e., image class for an instance is inferred from the folder name it resides in. This format cannot be natively imported into WEKA, so this loader creates the appropriate Instances object which points to the images * Valid options are:

* *

 -i <directory>
 *  Top level directory of the image dataset

* *

 -name <filename> (default: output.arff)
 *  Output meta .arff filename

*

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface weka.core.converters.Loader

weka.core.converters.Loader.StructureNotReadyException

Field Summary

Fields inherited from interface weka.core.converters.Loader

BATCH, INCREMENTAL, NONE

Constructor Summary

Constructors

Constructor and Description
ImageDirectoryLoader()

Method Summary

Modifier and Type	Method and Description
weka.core.Instances	createDataset() Main entrypoint.
java.lang.String[]	fileListForFolder(java.io.File folder) Appends the folder that the image is in, to the image path.
weka.core.Instances	getDataSet()
java.io.File	getInputDirectory()
weka.core.Instance	getNextInstance(weka.core.Instances structure)
java.lang.String[]	getOptions() Gets the current settings of the Classifier.
java.lang.String	getOutputFileName()
java.lang.String	getRevision()
weka.core.Instances	getStructure()
boolean	isImage(java.lang.String fullImgPath) Check whether the supplied path is a valid image.
java.util.Enumeration<weka.core.Option>	listOptions() Returns an enumeration describing the available options.
static void	main(java.lang.String[] args) Main entrypoint if invoking class independently
void	postExecution()
void	preExecution()
void	run(java.lang.Object toRun, java.lang.String[] options)
void	setInputDirectory(java.io.File inputDirectory)
void	setOptions(java.lang.String[] options) Parses a given list of options.
void	setOutputFileName(java.lang.String outputFileName)
void	setSource(java.io.File dir)

Methods inherited from class weka.core.converters.AbstractLoader

reset, setRetrieval, setSource

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface weka.core.OptionHandler

makeCopy

Constructor Detail

ImageDirectoryLoader

public ImageDirectoryLoader()

Method Detail

getInputDirectory

@ProgrammaticProperty
 @OptionMetadata(displayName="Input directory",
                description="Top level directory of the image dataset",
                commandLineParamName="i",
                commandLineParamSynopsis="-i <directory>",
                displayOrder=1)
public java.io.File getInputDirectory()

setInputDirectory

public void setInputDirectory(java.io.File inputDirectory)

getOutputFileName

@ProgrammaticProperty
 @OptionMetadata(displayName="Output File",
                description="Output meta .arff filename",
                commandLineParamName="name",
                commandLineParamSynopsis="-name <filename> (default: output.arff)",
                displayOrder=2)
public java.lang.String getOutputFileName()

setOutputFileName

public void setOutputFileName(java.lang.String outputFileName)

isImage

public boolean isImage(java.lang.String fullImgPath)

Check whether the supplied path is a valid image.

Parameters:

fullImgPath - Image path.

Returns:

True if file is an image, false otherwise.

fileListForFolder

public java.lang.String[] fileListForFolder(java.io.File folder)

Appends the folder that the image is in, to the image path.

Parameters:

folder - Folder to search.

Returns:

Image names (including the folder they're in)

createDataset

public weka.core.Instances createDataset()

Main entrypoint.

Returns:

List of instances from directory.

preExecution

public void preExecution()

Specified by:

preExecution in interface weka.core.CommandlineRunnable

run

public void run(java.lang.Object toRun,
                java.lang.String[] options)
         throws java.lang.IllegalArgumentException

Specified by:

run in interface weka.core.CommandlineRunnable

Throws:

java.lang.IllegalArgumentException

postExecution

public void postExecution()

Specified by:

postExecution in interface weka.core.CommandlineRunnable

getStructure

public weka.core.Instances getStructure()

Specified by:

getStructure in interface weka.core.converters.Loader

Specified by:

getStructure in class weka.core.converters.AbstractLoader

getDataSet

public weka.core.Instances getDataSet()

Specified by:

getDataSet in interface weka.core.converters.Loader

Specified by:

getDataSet in class weka.core.converters.AbstractLoader

getNextInstance

public weka.core.Instance getNextInstance(weka.core.Instances structure)

Specified by:

getNextInstance in interface weka.core.converters.Loader

Specified by:

getNextInstance in class weka.core.converters.AbstractLoader

setSource

public void setSource(java.io.File dir)
               throws java.io.IOException

Specified by:

setSource in interface weka.core.converters.Loader

Overrides:

setSource in class weka.core.converters.AbstractLoader

Throws:

java.io.IOException

getRevision

public java.lang.String getRevision()

Specified by:

getRevision in interface weka.core.RevisionHandler

listOptions

public java.util.Enumeration<weka.core.Option> listOptions()

Returns an enumeration describing the available options.

Specified by:

listOptions in interface weka.core.OptionHandler

Returns:

an enumeration of all the available options.

getOptions

public java.lang.String[] getOptions()

Gets the current settings of the Classifier.

Specified by:

getOptions in interface weka.core.OptionHandler

Returns:

an array of strings suitable for passing to setOptions

setOptions

public void setOptions(java.lang.String[] options)
                throws java.lang.Exception

Parses a given list of options.

Specified by:

setOptions in interface weka.core.OptionHandler

Parameters:

options - the list of options as an array of strings

Throws:

java.lang.Exception - if an option is not supported

main

public static void main(java.lang.String[] args)

Main entrypoint if invoking class independently

Parameters:

args - Args