org.openimaj.tools.clusterquantiser

Class ClusterQuantiserOptions

java.lang.Object

org.openimaj.tools.clusterquantiser.AbstractClusterQuantiserOptions

org.openimaj.tools.clusterquantiser.ClusterQuantiserOptions

public class ClusterQuantiserOptions
extends AbstractClusterQuantiserOptions

Options for ClusterQuantiser tool.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Field Summary

Fields

Modifier and Type	Field and Description
protected Class<? extends SpatialClusters<?>>	clusterClass
protected ClusterType.ClusterTypeOp	clusterTypeOp
protected File	input_file
protected Class<? extends SpatialClusters<?>>	otherClusterClass
protected File	samplesFile
protected boolean	samplesFileMode

Fields inherited from class org.openimaj.tools.clusterquantiser.AbstractClusterQuantiserOptions

exactQuant, extension, EXTRA_USAGE_INFO, fileType, info_mode, infoFile, inputFiles, otherInfoFile, quant_mode, quantLocation

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Class<? extends SpatialClusters<?>>	getClusterClass()
ClusterType.ClusterTypeOp	getClusterType()
String	getInputFileCommonRoot()
List<File>	getInputFiles()
String	getInputFileString()
Class<? extends SpatialClusters<?>>	getOtherInfoClass()
String	getOtherInfoFile()
ClusterType.ClusterTypeOp	getOtherInfoType()
File	getOutputFile()
String	getOutputFileString()
byte[][]	getSampleKeypoints()
int	getSamples()
File	getSamplesFile()
String	getTreeFile()
boolean	isBatchedSampleMode()
boolean	isCreateMode()
boolean	isSamplesFileMode()
void	loadSamplesFile() load the samples file
boolean	printTiming()
void	setClusterType(ClusterType clusterType) Set the cluster type
void	setClusterTypeOp(ClusterType.ClusterTypeOp clusterTypeOp) Set the clusterTypeOp
void	setInputFiles(List<File> files) Set the input files
void	setSamples(int nsamples) Set the number of samples
void	validate() Validate the options

Methods inherited from class org.openimaj.tools.clusterquantiser.AbstractClusterQuantiserOptions

getConcurrency, getCountMode, getExtension, getFileType, getRandomSeed, getVerbosity, isInfoMode, isQuantMode, prepare, setFileType

Methods inherited from class java.lang.Object

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

Field Detail

clusterTypeOp

protected ClusterType.ClusterTypeOp clusterTypeOp

clusterClass

protected Class<? extends SpatialClusters<?>> clusterClass

otherClusterClass

protected Class<? extends SpatialClusters<?>> otherClusterClass

samplesFile

protected File samplesFile

samplesFileMode

protected boolean samplesFileMode

input_file

protected File input_file

Constructor Detail

ClusterQuantiserOptions

public ClusterQuantiserOptions(String[] args)

Construct with arguments

Parameters:

args -

ClusterQuantiserOptions

public ClusterQuantiserOptions()

Construct with defaults

Method Detail

isSamplesFileMode

public boolean isSamplesFileMode()

Returns:

true if using a samples file

getSampleKeypoints

public byte[][] getSampleKeypoints()

Returns:

the sample points

getSamples

public int getSamples()

Returns:

number of samples

getSamplesFile

public File getSamplesFile()

Returns:

the samples file

getClusterType

public ClusterType.ClusterTypeOp getClusterType()

Specified by:

getClusterType in class AbstractClusterQuantiserOptions

Returns:

the cluster type

loadSamplesFile

public void loadSamplesFile()

load the samples file

validate

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

Description copied from class: AbstractClusterQuantiserOptions

Validate the options

Specified by:

validate in class AbstractClusterQuantiserOptions

Throws:

org.kohsuke.args4j.CmdLineException

getTreeFile

public String getTreeFile()
                   throws IOException

Overrides:

getTreeFile in class AbstractClusterQuantiserOptions

Returns:

the file

Throws:

IOException

isCreateMode

public boolean isCreateMode()

Returns:

true if in create mode

isBatchedSampleMode

public boolean isBatchedSampleMode()

Returns:

true if using batched samples

getInputFiles

public List<File> getInputFiles()
                         throws IOException

Returns:

the input files

Throws:

IOException

getOutputFile

public File getOutputFile()
                   throws IOException

Returns:

the output file

Throws:

IOException

getInputFileString

public String getInputFileString()

Specified by:

getInputFileString in class AbstractClusterQuantiserOptions

Returns:

the input file

getOutputFileString

public String getOutputFileString()

Specified by:

getOutputFileString in class AbstractClusterQuantiserOptions

Returns:

the output file

getOtherInfoFile

public String getOtherInfoFile()

Overrides:

getOtherInfoFile in class AbstractClusterQuantiserOptions

Returns:

otherInfoFile

getOtherInfoType

public ClusterType.ClusterTypeOp getOtherInfoType()

Specified by:

getOtherInfoType in class AbstractClusterQuantiserOptions

Returns:

the other-info type

getClusterClass

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

Specified by:

getClusterClass in class AbstractClusterQuantiserOptions

Returns:

the java class representing the clusters

getOtherInfoClass

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

Specified by:

getOtherInfoClass in class AbstractClusterQuantiserOptions

Returns:

the java class representing the clusters

setInputFiles

public void setInputFiles(List<File> files)

Set the input files

Parameters:

files -

setClusterType

public void setClusterType(ClusterType clusterType)

Set the cluster type

Parameters:

clusterType -

setClusterTypeOp

public void setClusterTypeOp(ClusterType.ClusterTypeOp clusterTypeOp)

Set the clusterTypeOp

Parameters:

clusterTypeOp -

getInputFileCommonRoot

public String getInputFileCommonRoot()
                              throws IOException

Returns:

set the root directory

Throws:

IOException

printTiming

public boolean printTiming()

Returns:

true if timing info should be printed

setSamples

public void setSamples(int nsamples)

Set the number of samples

Parameters:

nsamples - the number of samples