org.openimaj.experiment.dataset.sampling

Class NamedGroupSampler<KEY,INSTANCE>

java.lang.Object

org.openimaj.experiment.dataset.sampling.NamedGroupSampler<KEY,INSTANCE>

Type Parameters:

KEY - Type of groups

INSTANCE - Type of instances

All Implemented Interfaces:

Sampler<GroupedDataset<KEY,? extends ListDataset<INSTANCE>,INSTANCE>>

public class NamedGroupSampler<KEY,INSTANCE>
extends Object
implements Sampler<GroupedDataset<KEY,? extends ListDataset<INSTANCE>,INSTANCE>>

Sampler that samples whole groups from a GroupedDataset. Groups are chosen by selecting pre-determined keys.

Author:

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

Constructor Summary

Constructors

Constructor and Description
NamedGroupSampler(Collection<KEY> keys) Construct the sample to extract the given groups.

Method Summary

Methods

Modifier and Type	Method and Description
GroupedDataset<KEY,ListDataset<INSTANCE>,INSTANCE>	sample(GroupedDataset<KEY,? extends ListDataset<INSTANCE>,INSTANCE> dataset) Perform the sampling operation on the given data and return the sampled dataset.
static <KEY,INSTANCE> GroupedDataset<KEY,ListDataset<INSTANCE>,INSTANCE>	sample(GroupedDataset<KEY,? extends ListDataset<INSTANCE>,INSTANCE> dataset, Collection<KEY> keys) Sample a dataset by selecting only the given group keys.

Methods inherited from class java.lang.Object

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

Constructor Detail

NamedGroupSampler

public NamedGroupSampler(Collection<KEY> keys)

Construct the sample to extract the given groups.

Parameters:

keys - the group keys to sample.

Method Detail

sample

public GroupedDataset<KEY,ListDataset<INSTANCE>,INSTANCE> sample(GroupedDataset<KEY,? extends ListDataset<INSTANCE>,INSTANCE> dataset)

Description copied from interface: Sampler

Perform the sampling operation on the given data and return the sampled dataset.

Specified by:

sample in interface Sampler<GroupedDataset<KEY,? extends ListDataset<INSTANCE>,INSTANCE>>

Parameters:

dataset - the dataset to sample

Returns:

the sampled dataset

sample

public static <KEY,INSTANCE> GroupedDataset<KEY,ListDataset<INSTANCE>,INSTANCE> sample(GroupedDataset<KEY,? extends ListDataset<INSTANCE>,INSTANCE> dataset,
                                                                       Collection<KEY> keys)

Sample a dataset by selecting only the given group keys.

Parameters:

dataset - the dataset to sample

keys - the group keys to sample.

Returns:

the sampled dataset