org.openimaj.experiment.dataset.sampling

Class GroupSampler<KEY,INSTANCE>

java.lang.Object

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

Type Parameters:

KEY - Type of groups

INSTANCE - Type of instances

All Implemented Interfaces:

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

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

Sampler that samples whole groups from a GroupedDataset. Groups are either selected randomly or from the first ones returned by the iterator over the dataset keys.

Author:

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

Constructor Summary

Constructors

Constructor and Description
GroupSampler(int numGroups, boolean random) Construct the sample to extract the given number of groups, either randomly or by taking them in the order provided by the iterator of groups.

Method Summary

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, int numGroups, boolean random) Sample a dataset with the given number of groups to select.

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupSampler

public GroupSampler(int numGroups,
                    boolean random)

Construct the sample to extract the given number of groups, either randomly or by taking them in the order provided by the iterator of groups.

Parameters:

numGroups - the number of groups

random - should the sample groups be chosen randomly?

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,
                                                                                       int numGroups,
                                                                                       boolean random)

Sample a dataset with the given number of groups to select. Groups are either selected randomly or from the first ones returned by the iterator over the dataset keys.

Parameters:

dataset - the dataset to sample

numGroups - the number of groups

random - should the sample groups be chosen randomly?

Returns:

the sampled dataset