weka.dl4j.iterators.instance

Class ImageInstanceIterator

java.lang.Object

weka.dl4j.iterators.instance.AbstractInstanceIterator

weka.dl4j.iterators.instance.ImageInstanceIterator

All Implemented Interfaces:

java.io.Serializable, weka.core.OptionHandler, ConvolutionalIterator

Direct Known Subclasses:

ResizeImageInstanceIterator

public class ImageInstanceIterator
extends AbstractInstanceIterator
implements ConvolutionalIterator

An iterator that loads images.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ImageInstanceIterator()

Method Summary

Modifier and Type	Method and Description
void	enforceZooModelSize(AbstractZooModel tmpZooModel) Enforces the input image size if using a zoo model.
boolean	getChannelsLast()
org.nd4j.linalg.dataset.api.iterator.DataSetIterator	getDataSetIterator(weka.core.Instances data, int seed, int batchSize) This method returns the iterator.
int	getHeight()
java.io.File	getImagesLocation()
int	getNumChannels()
java.lang.String[]	getOptions() Gets the current settings of the Classifier.
int	getWidth()
java.lang.String	globalInfo() Return the global info for this class.
static boolean	isMetaArff(weka.core.Instances data) Are the input instances from a 'meta' arff (just points to the image location)
java.util.Enumeration<weka.core.Option>	listOptions() Returns an enumeration describing the available options.
void	setChannelsLast(boolean channelsLast)
void	setHeight(int height)
void	setImagesLocation(java.io.File imagesLocation)
void	setNumChannels(int numChannels)
void	setOptions(java.lang.String[] options) Parses a given list of options.
void	setWidth(int width)
void	validate(weka.core.Instances data) Validates the input dataset.

Methods inherited from class weka.dl4j.iterators.instance.AbstractInstanceIterator

getDataSetIterator, getTrainBatchSize, initialize, setTrainBatchSize

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

ImageInstanceIterator

public ImageInstanceIterator()

Method Detail

getImagesLocation

@FilePropertyMetadata(fileChooserDialogType=1,
                      directoriesOnly=true)
 @OptionMetadata(displayName="directory of images",
                description="The directory containing the images (default = user home).",
                commandLineParamName="imagesLocation",
                commandLineParamSynopsis="-imagesLocation <string>",
                displayOrder=1)
public java.io.File getImagesLocation()

setImagesLocation

public void setImagesLocation(java.io.File imagesLocation)

getWidth

@OptionMetadata(displayName="desired width",
                description="The desired width of the images (default = 28).",
                commandLineParamName="width",
                commandLineParamSynopsis="-width <int>",
                displayOrder=2)
public int getWidth()

Specified by:

getWidth in interface ConvolutionalIterator

setWidth

public void setWidth(int width)

getHeight

@OptionMetadata(displayName="desired height",
                description="The desired height of the images (default = 28).",
                commandLineParamName="height",
                commandLineParamSynopsis="-height <int>",
                displayOrder=3)
public int getHeight()

Specified by:

getHeight in interface ConvolutionalIterator

setHeight

public void setHeight(int height)

getNumChannels

@OptionMetadata(displayName="desired number of channels",
                description="The desired number of channels (default = 1).",
                commandLineParamName="numChannels",
                commandLineParamSynopsis="-numChannels <int>",
                displayOrder=4)
public int getNumChannels()

Specified by:

getNumChannels in interface ConvolutionalIterator

setNumChannels

public void setNumChannels(int numChannels)

getChannelsLast

@OptionMetadata(displayName="Image channels last",
                description="Set to true to supply image channels last. The default value will usually be correct, so as an end user you shouldn\'t need to change this setting. If you do be aware that it may break the model.",
                commandLineParamName="channelsLast",
                commandLineParamSynopsis="-channelsLast <boolean>")
public boolean getChannelsLast()

setChannelsLast

public void setChannelsLast(boolean channelsLast)

enforceZooModelSize

public void enforceZooModelSize(AbstractZooModel tmpZooModel)

Enforces the input image size if using a zoo model.

Parameters:

tmpZooModel - Zoo model to constrain input size to

validate

public void validate(weka.core.Instances data)
              throws InvalidInputDataException

Validates the input dataset.

Specified by:

validate in class AbstractInstanceIterator

Parameters:

data - the input dataset

Throws:

InvalidInputDataException - if validation is unsuccessful

isMetaArff

public static boolean isMetaArff(weka.core.Instances data)

Are the input instances from a 'meta' arff (just points to the image location)

Parameters:

data - Instances to verify

Returns:

true if Instances are meta

getDataSetIterator

public org.nd4j.linalg.dataset.api.iterator.DataSetIterator getDataSetIterator(weka.core.Instances data,
                                                                               int seed,
                                                                               int batchSize)
                                                                        throws java.lang.Exception

This method returns the iterator. Scales all intensity values: it divides them by 255.

Specified by:

getDataSetIterator in class AbstractInstanceIterator

Parameters:

data - the dataset to use

seed - the seed for the random number generator

batchSize - the batch size to use

Returns:

the iterator

Throws:

java.lang.Exception - if the constructor cannot be constructed successfully

globalInfo

public java.lang.String globalInfo()

Return the global info for this class.

Returns:

Global info

listOptions

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

Returns an enumeration describing the available options.

Specified by:

listOptions in interface weka.core.OptionHandler

Overrides:

listOptions in class AbstractInstanceIterator

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

Overrides:

getOptions in class AbstractInstanceIterator

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

Overrides:

setOptions in class AbstractInstanceIterator

Parameters:

options - the list of options as an array of strings

Throws:

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