org.openimaj.tools.clusterquantiser

Class AbstractClusterQuantiserOptions

java.lang.Object

org.openimaj.tools.clusterquantiser.AbstractClusterQuantiserOptions

Direct Known Subclasses:

ClusterQuantiserOptions, HadoopClusterQuantiserOptions

public abstract class AbstractClusterQuantiserOptions
extends Object

Options for clustering/quantising tool

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk), Sina Samangooei (ss@ecs.soton.ac.uk)

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	exactQuant
protected String	extension
static String	EXTRA_USAGE_INFO Usage info
protected FileType	fileType
protected boolean	info_mode
protected String	infoFile
protected List<File>	inputFiles
protected String	otherInfoFile
protected boolean	quant_mode
protected String	quantLocation

Constructor Summary

Constructors

Constructor and Description
AbstractClusterQuantiserOptions(String[] args) Construct with arguments

Method Summary

Modifier and Type	Method and Description
abstract Class<? extends SpatialClusters<?>>	getClusterClass()
abstract ClusterType.ClusterTypeOp	getClusterType()
int	getConcurrency()
boolean	getCountMode()
String	getExtension()
FileType	getFileType()
abstract String	getInputFileString()
abstract Class<? extends SpatialClusters<?>>	getOtherInfoClass()
String	getOtherInfoFile()
abstract ClusterType.ClusterTypeOp	getOtherInfoType()
abstract String	getOutputFileString()
long	getRandomSeed()
String	getTreeFile()
int	getVerbosity()
boolean	isInfoMode()
boolean	isQuantMode()
void	prepare() Prepare options by parsing arguments
void	setFileType(FileType fileType) Set the file type
abstract void	validate() Validate the options

Methods inherited from class java.lang.Object

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

Field Detail

EXTRA_USAGE_INFO

public static String EXTRA_USAGE_INFO

Usage info

infoFile

protected String infoFile

info_mode

protected boolean info_mode

otherInfoFile

protected String otherInfoFile

quantLocation

protected String quantLocation

quant_mode

protected boolean quant_mode

fileType

protected FileType fileType

extension

protected String extension

exactQuant

protected boolean exactQuant

inputFiles

protected List<File> inputFiles

Constructor Detail

AbstractClusterQuantiserOptions

public AbstractClusterQuantiserOptions(String[] args)

Construct with arguments

Parameters:

args -

Method Detail

prepare

public void prepare()
             throws org.kohsuke.args4j.CmdLineException

Prepare options by parsing arguments

Throws:

org.kohsuke.args4j.CmdLineException

getTreeFile

public String getTreeFile()
                   throws IOException

Returns:

the file

Throws:

IOException

getOtherInfoFile

public String getOtherInfoFile()

Returns:

otherInfoFile

isInfoMode

public boolean isInfoMode()

Returns:

true if in info mode

isQuantMode

public boolean isQuantMode()

Returns:

true if in quant mode

getVerbosity

public int getVerbosity()

Returns:

the verbosity

getFileType

public FileType getFileType()

Returns:

the file type

getConcurrency

public int getConcurrency()

Returns:

the number of threads to use

getExtension

public String getExtension()

Returns:

the file extension

getCountMode

public boolean getCountMode()

Returns:

true if in count mode

getRandomSeed

public long getRandomSeed()

Returns:

the random seed

getInputFileString

public abstract String getInputFileString()

Returns:

the input file

getOutputFileString

public abstract String getOutputFileString()

Returns:

the output file

validate

public abstract void validate()
                       throws org.kohsuke.args4j.CmdLineException

Validate the options

Throws:

org.kohsuke.args4j.CmdLineException

getClusterType

public abstract ClusterType.ClusterTypeOp getClusterType()

Returns:

the cluster type

getOtherInfoType

public abstract ClusterType.ClusterTypeOp getOtherInfoType()

Returns:

the other-info type

getClusterClass

public abstract Class<? extends SpatialClusters<?>> getClusterClass()

Returns:

the java class representing the clusters

getOtherInfoClass

public abstract Class<? extends SpatialClusters<?>> getOtherInfoClass()

Returns:

the java class representing the clusters

setFileType

public void setFileType(FileType fileType)

Set the file type

Parameters:

fileType -