org.openimaj.data.dataset

Interface GroupedDataset<KEY,DATASET extends Dataset<INSTANCE>,INSTANCE>

Type Parameters:

KEY - Type of dataset class key

DATASET - Type of sub-datasets.

INSTANCE - Type of instances in the dataset

All Superinterfaces:

Dataset<INSTANCE>, Iterable<INSTANCE>, Map<KEY,DATASET>

All Known Implementing Classes:

ATandTDataset, ClusterEvalDataset, MapBackedDataset, MusicSpeechDataset, ReadableGroupDataset, TextFileDataset, UKBenchGroupDataset, VFSGroupDataset, WineDataset

public interface GroupedDataset<KEY,DATASET extends Dataset<INSTANCE>,INSTANCE>
extends Dataset<INSTANCE>, Map<KEY,DATASET>

A Dataset that is grouped into separate classes or groups. Each group is represented by a key, and each key corresponds to a sub-dataset.

Sub-datasets can be any kind of Dataset, including GroupedDatasets, so it is possible to build tree structures.

Author:

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

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
Set<KEY>	getGroups() Get the set of all defined group keys.
DATASET	getInstances(KEY key) Get sub-dataset corresponding to the given group key
INSTANCE	getRandomInstance(KEY key) Get a random instance from the sub-dataset corresponding to a specific group.

Methods inherited from interface org.openimaj.data.dataset.Dataset

getRandomInstance, numInstances

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Method Detail

getInstances

DATASET getInstances(KEY key)

Get sub-dataset corresponding to the given group key

Parameters:

key - the key.

Returns:

the sub dataset, or null if the key was unknown

getGroups

Set<KEY> getGroups()

Get the set of all defined group keys.

Returns:

the the set of all defined group keys.

getRandomInstance

INSTANCE getRandomInstance(KEY key)

Get a random instance from the sub-dataset corresponding to a specific group.

Parameters:

key - the group key

Returns:

a random item from the group.