Gets or sets the Filter associated with the current variable.

Namespace: Extreme.Statistics
Assembly: Extreme.Numerics (Extreme.Numerics)

Syntax

Visual Basic (Declaration)
Public Property Filter As Filter
C#
public Filter Filter { get; set; }
C++
public:
Filter^ Filter {
	Filter^ get ();
	void set (Filter^ value);
}

Remarks

Use the Filter property to restrict calculations to those observations that match certain criteria. All operations, including descriptive statistics and regression analysis and the creation of statistical models, use only the filtered observations.

Most variables have a Filters property that provides easy access to methods that create filters based on simple criteria. Any filter whose length equals the number of observations of the variable can be used. Filter objects can be constructed from scratch, or combined with other filters.

A filter always operates on the entire set of observations. Setting the Filter property of a variable that had its Filter property set previously, replaces the current filter with the new value.

A filter can only be set for variables that are not a member of a VariableCollection. For variables that are contained in a collection, the filter should be applied to the collection as a whole.

Exceptions

ExceptionCondition
InvalidOperationException The property is set while the variable is a member of a VariableCollection.
DimensionMismatchException The length of the filter does not equal the number of observations of the variable.