org.openimaj.experiment.dataset.sampling

Class UniformRandomisedSampler<INSTANCE>

java.lang.Object

org.openimaj.experiment.dataset.sampling.UniformRandomisedSampler<INSTANCE>

Type Parameters:

INSTANCE - Type of instances

All Implemented Interfaces:

Sampler<ListDataset<INSTANCE>>

public class UniformRandomisedSampler<INSTANCE>
extends Object
implements Sampler<ListDataset<INSTANCE>>

A uniformly random sampling scheme for ListDatasets. Both sampling with and without replacement are supported. The sampler returns a "view" on top of the input dataset that selects a predefined fraction of the data.

Author:

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

Constructor Summary

Constructors

Constructor and Description
UniformRandomisedSampler(double percentage) Construct a UniformRandomisedSampler with the given percentage of instances to select.
UniformRandomisedSampler(double percentage, boolean withReplacement) Construct a UniformRandomisedSampler with the given percentage of instances to select, using with with-replacement or without-replacement sampling.
UniformRandomisedSampler(int number) Construct a UniformRandomisedSampler with the given number of instances to select.
UniformRandomisedSampler(int number, boolean withReplacement) Construct a UniformRandomisedSampler with the given number of instances to select, using with with-replacement or without-replacement sampling.

Method Summary

Modifier and Type	Method and Description
ListDataset<INSTANCE>	sample(ListDataset<INSTANCE> dataset) Perform the sampling operation on the given data and return the sampled dataset.

Methods inherited from class java.lang.Object

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

Constructor Detail

UniformRandomisedSampler

public UniformRandomisedSampler(double percentage)

Construct a UniformRandomisedSampler with the given percentage of instances to select. By default, the sampling is without replacement (i.e. an instance can only be selected once).

Parameters:

percentage - percentage of instances to select

UniformRandomisedSampler

public UniformRandomisedSampler(double percentage,
                                boolean withReplacement)

Construct a UniformRandomisedSampler with the given percentage of instances to select, using with with-replacement or without-replacement sampling.

Parameters:

percentage - percentage of instances to select

withReplacement - should the sampling be performed with replacement (true); or without replacement (false).

UniformRandomisedSampler

public UniformRandomisedSampler(int number)

Construct a UniformRandomisedSampler with the given number of instances to select. By default, the sampling is without replacement (i.e. an instance can only be selected once).

Parameters:

number - number of instances to select

UniformRandomisedSampler

public UniformRandomisedSampler(int number,
                                boolean withReplacement)

Construct a UniformRandomisedSampler with the given number of instances to select, using with with-replacement or without-replacement sampling.

Parameters:

number - number of instances to select

withReplacement - should the sampling be performed with replacement (true); or without replacement (false).

Method Detail

sample

public ListDataset<INSTANCE> sample(ListDataset<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<ListDataset<INSTANCE>>

Parameters:

dataset - the dataset to sample

Returns:

the sampled dataset