com.rapidminer.operator.preprocessing.sampling
Class SimpleSampling

java.lang.Object
  com.rapidminer.operator.Operator
      com.rapidminer.operator.AbstractExampleSetProcessing
          com.rapidminer.operator.preprocessing.AbstractDataProcessing
              com.rapidminer.operator.preprocessing.sampling.AbstractSamplingOperator
                  com.rapidminer.operator.preprocessing.sampling.SimpleSampling

All Implemented Interfaces:

ConfigurationListener, PreviewListener, ParameterHandler, LoggingHandler

public class SimpleSampling
extends AbstractSamplingOperator

Simple sampling operator. This operator performs a random sampling of a given fraction. For example, if the input example set contains 5000 examples and the sample ratio is set to 0.1, the result will have approximately 500 examples.

Author:

Ingo Mierswa

Field Summary

static java.lang.String	PARAMETER_LOCAL_RANDOM_SEED The parameter name for "Use the given random seed instead of global random numbers (-1: use global).
static java.lang.String	PARAMETER_SAMPLE_RATIO The parameter name for "The fraction of examples which should be sampled"
static java.lang.String	PARAMETER_USE_LOCAL_RANDOM_SEED

Constructor Summary

SimpleSampling(OperatorDescription description)

Method Summary

protected boolean	accept(Example example, RandomGenerator random)
ExampleSet	apply(ExampleSet exampleSet) Delegate for the apply method.
java.util.List<ParameterType>	getParameterTypes() Returns a list of ParameterTypes describing the parameters of this operator.

Methods inherited from class com.rapidminer.operator.AbstractExampleSetProcessing

apply, getInputClasses, getOutputClasses

Methods inherited from class com.rapidminer.operator.Operator

addError, addValue, addWarning, apply, checkDeprecations, checkForStop, checkIO, checkProperties, clearErrorList, cloneOperator, createExperimentTree, createExperimentTree, createFromXML, createMarkedExperimentTree, createMarkedProcessTree, createProcessTree, createProcessTree, getAddOnlyAdditionalOutput, getApplyCount, getDeliveredOutputClasses, getDeprecationInfo, getDesiredInputClasses, getEncoding, getErrorList, getExperiment, getInnerOperatorsXML, getInput, getInput, getInput, getInputDescription, getIOContainerForInApplyLoopBreakpoint, getIODescription, getLog, getName, getOperatorClassName, getOperatorDescription, getParameter, getParameterAsBoolean, getParameterAsColor, getParameterAsDouble, getParameterAsFile, getParameterAsFile, getParameterAsInputStream, getParameterAsInt, getParameterAsMatrix, getParameterAsString, getParameterList, getParameters, getParameterType, getParent, getProcess, getStartTime, getStatus, getUserDescription, getValue, getValues, getXML, hasBreakpoint, hasBreakpoint, hasInput, inApplyLoop, isDebugMode, isEnabled, isExpanded, isParallel, isParameterSet, log, logError, logNote, logWarning, performAdditionalChecks, processFinished, processStarts, register, registerOperator, remove, rename, resume, setApplyCount, setBreakpoint, setEnabled, setExpanded, setInput, setListParameter, setOperatorParameters, setParameter, setParameters, setParent, setUserDescription, toString, unregisterOperator, writeXML

Methods inherited from class java.lang.Object

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

Field Detail

PARAMETER_SAMPLE_RATIO

public static final java.lang.String PARAMETER_SAMPLE_RATIO

The parameter name for "The fraction of examples which should be sampled"

See Also:

Constant Field Values

PARAMETER_LOCAL_RANDOM_SEED

public static final java.lang.String PARAMETER_LOCAL_RANDOM_SEED

The parameter name for "Use the given random seed instead of global random numbers (-1: use global)."

See Also:

Constant Field Values

PARAMETER_USE_LOCAL_RANDOM_SEED

public static final java.lang.String PARAMETER_USE_LOCAL_RANDOM_SEED

See Also:

Constant Field Values

Constructor Detail

SimpleSampling

public SimpleSampling(OperatorDescription description)

Method Detail

apply

public ExampleSet apply(ExampleSet exampleSet)
                 throws OperatorException

Description copied from class: AbstractExampleSetProcessing

Delegate for the apply method. In most cases, the returned example set will be the same as the example set or a modified clone.

Specified by:

apply in class AbstractExampleSetProcessing

Throws:

OperatorException

accept

protected boolean accept(Example example,
                         RandomGenerator random)
                  throws UndefinedParameterError

Throws:

UndefinedParameterError

getParameterTypes

public java.util.List<ParameterType> getParameterTypes()

Description copied from class: Operator

Returns a list of ParameterTypes describing the parameters of this operator. The default implementation returns an empty list if no input objects can be retained and special parameters for those input objects which can be prevented from being consumed.

Specified by:

getParameterTypes in interface ParameterHandler

Overrides:

getParameterTypes in class Operator