org.openimaj.tools.clusterquantiser

Enum FileType

java.lang.Object

java.lang.Enum<FileType>

org.openimaj.tools.clusterquantiser.FileType

All Implemented Interfaces:

Serializable, Comparable<FileType>

public enum FileType
extends Enum<FileType>

Different file formats containing local features.

Author:

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASIFTENRICHED OpenIMAJ ASIFTENRICHED format
ASIFTENRICHED_ASCII OpenIMAJ ASIFTENRICHED ascii format
ASIFTENRICHED_BINARY OpenIMAJ ASIFTENRICHED binary format
BINARY_KEYPOINT OpenIMAJ binary list of keypoints format
ELLIPSE_ASCII Ellipse format used by Oxford tools
KOEN1_ASCII KOEN1 ascii format used by Koen van der Sande's colour sift tools.
LOWE_KEYPOINT Auto-guess between Lowe's ASCII keypoints format or the OpenIMAJ binary format.
LOWE_KEYPOINT_ASCII Format defined by Lowe's "keypoints" binary

Method Summary

Modifier and Type	Method and Description
abstract FeatureFile	read(File file) Read a file
abstract FeatureFile	read(InputStream source) Read a file
byte[][]	readFeatures(File file) Read all the features from the file.
byte[][]	readFeatures(File file, int... index) Read features at given indices from the file.
byte[][]	readFeatures(InputStream stream) Read all the features from the file.
byte[][]	readFeatures(InputStream stream, int... index) Read features at given indices from an input stream.
Header	readHeader(File file) Read the header (num features and dimensionality of features) from given file.
Header	readHeader(InputStream stream) Read the header (num features and dimensionality of features) from given file.
static FileType	valueOf(String name) Returns the enum constant of this type with the specified name.
static FileType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LOWE_KEYPOINT

public static final FileType LOWE_KEYPOINT

Auto-guess between Lowe's ASCII keypoints format or the OpenIMAJ binary format.

BINARY_KEYPOINT

public static final FileType BINARY_KEYPOINT

OpenIMAJ binary list of keypoints format

LOWE_KEYPOINT_ASCII

public static final FileType LOWE_KEYPOINT_ASCII

Format defined by Lowe's "keypoints" binary

ELLIPSE_ASCII

public static final FileType ELLIPSE_ASCII

Ellipse format used by Oxford tools

KOEN1_ASCII

public static final FileType KOEN1_ASCII

KOEN1 ascii format used by Koen van der Sande's colour sift tools.

ASIFTENRICHED

public static final FileType ASIFTENRICHED

OpenIMAJ ASIFTENRICHED format

ASIFTENRICHED_BINARY

public static final FileType ASIFTENRICHED_BINARY

OpenIMAJ ASIFTENRICHED binary format

ASIFTENRICHED_ASCII

public static final FileType ASIFTENRICHED_ASCII

OpenIMAJ ASIFTENRICHED ascii format

Method Detail

values

public static FileType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FileType c : FileType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FileType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

readHeader

public Header readHeader(File file)
                  throws IOException

Read the header (num features and dimensionality of features) from given file. Override for performance.

Parameters:

file -

Returns:

header

Throws:

IOException

readHeader

public Header readHeader(InputStream stream)
                  throws IOException

Read the header (num features and dimensionality of features) from given file. Override for performance.

Parameters:

stream -

Returns:

header

Throws:

IOException

readFeatures

public byte[][] readFeatures(File file,
                             int... index)
                      throws IOException

Read features at given indices from the file. Override for performance.

Parameters:

file -

index -

Returns:

the feature data

Throws:

IOException

readFeatures

public byte[][] readFeatures(InputStream stream,
                             int... index)
                      throws IOException

Read features at given indices from an input stream. Override for performance.

Parameters:

stream -

index -

Returns:

the feature data

Throws:

IOException

readFeatures

public byte[][] readFeatures(File file)
                      throws IOException

Read all the features from the file. Override for performance.

Parameters:

file -

Returns:

the feature data

Throws:

IOException

readFeatures

public byte[][] readFeatures(InputStream stream)
                      throws IOException

Read all the features from the file. Override for performance.

Parameters:

stream -

Returns:

the feature data

Throws:

IOException

read

public abstract FeatureFile read(File file)
                          throws IOException

Read a file

Parameters:

file -

Returns:

the features

Throws:

IOException

read

public abstract FeatureFile read(InputStream source)
                          throws IOException

Read a file

Parameters:

source -

Returns:

the features

Throws:

IOException