[Home] DMelt member access. Java source code: weka.filters.supervised.instance.Resample
/*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see .
*/
/*
* Resample.java
* Copyright (C) 2002-2012 University of Waikato, Hamilton, New Zealand
*
*/
package weka.filters.supervised.instance;
import java.util.Collections;
import java.util.Enumeration;
import java.util.Random;
import java.util.Vector;
import weka.core.*;
import weka.core.Capabilities.Capability;
import weka.filters.Filter;
import weka.filters.SupervisedFilter;
import weka.gui.ProgrammaticProperty;
/**
* Produces a random subsample of a dataset using
* either sampling with replacement or without replacement.
* The original dataset must fit entirely in memory. The number of instances in
* the generated dataset may be specified. The dataset must have a nominal class
* attribute. If not, use the unsupervised version. The filter can be made to
* maintain the class distribution in the subsample, or to bias the class
* distribution toward a uniform distribution. When used in batch mode (i.e. in
* the FilteredClassifier), subsequent batches are NOT resampled.
*
*
*
* Valid options are:
*
*
*
* -S <num>
* Specify the random number seed (default 1)
*
*
*
* -Z <num>
* The size of the output dataset, as a percentage of
* the input dataset (default 100)
*
*
*
* -B <num>
* Bias factor towards uniform class distribution.
* 0 = distribution in input data -- 1 = uniform distribution.
* (default 0)
*
*
*
* -no-replacement
* Disables replacement of instances
* (default: with replacement)
*
*
*
* -V
* Inverts the selection - only available with '-no-replacement'.
*
*
*
*
* @author Len Trigg (len@reeltwo.com)
* @author FracPete (fracpete at waikato dot ac dot nz)
* @author Eibe Frank
* @version $Revision: 14508 $
*/
public class Resample extends Filter
implements SupervisedFilter, OptionHandler, Randomizable, WeightedAttributesHandler {
/** for serialization. */
static final long serialVersionUID = 7079064953548300681L;
/** The subsample size, percent of original set, default 100%. */
protected double m_SampleSizePercent = 100;
/** The random number generator seed. */
protected int m_RandomSeed = 1;
/** The degree of bias towards uniform (nominal) class distribution. */
protected double m_BiasToUniformClass = 0;
/** Whether to perform sampling with replacement or without. */
protected boolean m_NoReplacement = false;
/**
* Whether to invert the selection (only if instances are drawn WITHOUT
* replacement).
*
* @see #m_NoReplacement
*/
protected boolean m_InvertSelection = false;
/**
* Returns a string describing this filter.
*
* @return a description of the filter suitable for displaying in the
* explorer/experimenter gui
*/
public String globalInfo() {
return "Produces a random subsample of a dataset using either sampling "
+ "with replacement or without replacement.\n"
+ "The original dataset must "
+ "fit entirely in memory. The number of instances in the generated "
+ "dataset may be specified. The dataset must have a nominal class "
+ "attribute. If not, use the unsupervised version. The filter can be "
+ "made to maintain the class distribution in the subsample, or to bias "
+ "the class distribution toward a uniform distribution. When used in batch "
+ "mode (i.e. in the FilteredClassifier), subsequent batches are NOT resampled.";
}
/**
* Returns an enumeration describing the available options.
*
* @return an enumeration of all the available options.
*/
@Override
public Enumeration