vtkBivariateLinearTableThreshold Class Reference

#include <vtkBivariateLinearTableThreshold.h>

Inheritance diagram for vtkBivariateLinearTableThreshold:

[legend]

Collaboration diagram for vtkBivariateLinearTableThreshold:

[legend]

List of all members.

Detailed Description

performs line-based thresholding for vtkTable data.

Class for filtering the rows of a two numeric columns of a vtkTable. The columns are treated as the two variables of a line. This filter will then iterate through the rows of the table determining if X,Y values pairs are above/below/between/near one or more lines.

The "between" mode checks to see if a row is contained within the convex hull of all of the specified lines. The "near" mode checks if a row is within a distance threshold two one of the specified lines. This class is used in conjunction with various plotting classes, so it is useful to rescale the X,Y axes to a particular range of values. Distance comparisons can be performed in the scaled space by setting the CustomRanges ivar and enabling UseNormalizedDistance.

Definition at line 50 of file vtkBivariateLinearTableThreshold.h.


Public Types
enum	OutputPorts { OUTPUT_ROW_IDS = 0, OUTPUT_ROW_DATA }
enum	LinearThresholdType { BLT_ABOVE = 0, BLT_BELOW, BLT_NEAR, BLT_BETWEEN }
typedef vtkTableAlgorithm	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	AddColumnToThreshold (vtkIdType column, vtkIdType component)
int	GetNumberOfColumnsToThreshold ()
void	GetColumnToThreshold (vtkIdType idx, vtkIdType &column, vtkIdType &component)
void	ClearColumnsToThreshold ()
vtkIdTypeArray *	GetSelectedRowIds (int selection=0)
void	Initialize ()
void	AddLineEquation (double p1, double p2)
void	AddLineEquation (double *p, double slope)
void	AddLineEquation (double a, double b, double c)
void	ClearLineEquations ()

virtual void	SetInclusive (int)
virtual int	GetInclusive ()

virtual int	GetLinearThresholdType ()
virtual void	SetLinearThresholdType (int)
void	SetLinearThresholdTypeToAbove ()
void	SetLinearThresholdTypeToBelow ()
void	SetLinearThresholdTypeToNear ()
void	SetLinearThresholdTypeToBetween ()

virtual void	SetColumnRanges (double, double)
void	SetColumnRanges (double[2])
virtual double *	GetColumnRanges ()
virtual void	GetColumnRanges (double &, double &)
virtual void	GetColumnRanges (double[2])

virtual void	SetDistanceThreshold (double)
virtual double	GetDistanceThreshold ()

virtual void	SetUseNormalizedDistance (int)
virtual int	GetUseNormalizedDistance ()
virtual void	UseNormalizedDistanceOn ()
virtual void	UseNormalizedDistanceOff ()
Static Public Member Functions
static vtkBivariateLinearTableThreshold *	New ()
static int	IsTypeOf (const char *type)
static vtkBivariateLinearTableThreshold *	SafeDownCast (vtkObject *o)
static void	ComputeImplicitLineFunction (double p1, double p2, double *abc)
static void	ComputeImplicitLineFunction (double p, double slope, double abc)
Protected Member Functions
	vtkBivariateLinearTableThreshold ()
virtual	~vtkBivariateLinearTableThreshold ()
virtual int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )
virtual int	FillInputPortInformation (int port, vtkInformation *info)
virtual int	FillOutputPortInformation (int port, vtkInformation *info)
virtual int	ApplyThreshold (vtkTable tableToThreshold, vtkIdTypeArray acceptedIds)
int	ThresholdAbove (double x, double y)
int	ThresholdBelow (double x, double y)
int	ThresholdNear (double x, double y)
int	ThresholdBetween (double x, double y)
Protected Attributes
double	ColumnRanges [2]
double	DistanceThreshold
int	Inclusive
int	LinearThresholdType
int	NumberOfLineEquations
int	UseNormalizedDistance
vtkSmartPointer< vtkDoubleArray >	LineEquations
Internals *	Implementation

Member Typedef Documentation

typedef vtkTableAlgorithm vtkBivariateLinearTableThreshold::Superclass

Reimplemented from vtkTableAlgorithm.

Reimplemented in vtkPBivariateLinearTableThreshold.

Definition at line 54 of file vtkBivariateLinearTableThreshold.h.

Member Enumeration Documentation

enum vtkBivariateLinearTableThreshold::OutputPorts

Enumerator:

OUTPUT_ROW_IDS
OUTPUT_ROW_DATA

Definition at line 82 of file vtkBivariateLinearTableThreshold.h.

enum vtkBivariateLinearTableThreshold::LinearThresholdType

Enumerator:

BLT_ABOVE
BLT_BELOW
BLT_NEAR
BLT_BETWEEN

Definition at line 87 of file vtkBivariateLinearTableThreshold.h.

Constructor & Destructor Documentation

vtkBivariateLinearTableThreshold::vtkBivariateLinearTableThreshold ( ) [protected]

virtual vtkBivariateLinearTableThreshold::~vtkBivariateLinearTableThreshold ( ) [protected, virtual]

Member Function Documentation

static vtkBivariateLinearTableThreshold* vtkBivariateLinearTableThreshold::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkTableAlgorithm.

Reimplemented in vtkPBivariateLinearTableThreshold.

virtual const char* vtkBivariateLinearTableThreshold::GetClassName ( ) [virtual]

Reimplemented from vtkTableAlgorithm.

Reimplemented in vtkPBivariateLinearTableThreshold.

static int vtkBivariateLinearTableThreshold::IsTypeOf ( const char * name ) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkTableAlgorithm.

Reimplemented in vtkPBivariateLinearTableThreshold.

virtual int vtkBivariateLinearTableThreshold::IsA ( const char * name ) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkTableAlgorithm.

Reimplemented in vtkPBivariateLinearTableThreshold.

static vtkBivariateLinearTableThreshold* vtkBivariateLinearTableThreshold::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkTableAlgorithm.

Reimplemented in vtkPBivariateLinearTableThreshold.

void vtkBivariateLinearTableThreshold::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			`[virtual]`

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkTableAlgorithm.

Reimplemented in vtkPBivariateLinearTableThreshold.

virtual void vtkBivariateLinearTableThreshold::SetInclusive ( int ) [virtual]

Include the line in the threshold. Essentially whether the threshold operation uses > versus >=.

virtual int vtkBivariateLinearTableThreshold::GetInclusive ( ) [virtual]

Include the line in the threshold. Essentially whether the threshold operation uses > versus >=.

void vtkBivariateLinearTableThreshold::AddColumnToThreshold	(	vtkIdType	column,
		vtkIdType	component
	)

Add a numeric column to the pair of columns to be thresholded. Call twice.

int vtkBivariateLinearTableThreshold::GetNumberOfColumnsToThreshold ( )

Return how many columns have been added. Hopefully 2.

void vtkBivariateLinearTableThreshold::GetColumnToThreshold	(	vtkIdType	idx,
		vtkIdType &	column,
		vtkIdType &	component
	)

Return the column number from the input table for the idx'th added column.

void vtkBivariateLinearTableThreshold::ClearColumnsToThreshold ( )

Reset the columns to be thresholded.

vtkIdTypeArray* vtkBivariateLinearTableThreshold::GetSelectedRowIds ( int selection = 0 )

Get the output as a table of row ids.

void vtkBivariateLinearTableThreshold::Initialize ( )

Reset the columns to threshold, column ranges, etc.

void vtkBivariateLinearTableThreshold::AddLineEquation	(	double *	p1,
		double *	p2
	)

Add a line for thresholding from two x,y points.

void vtkBivariateLinearTableThreshold::AddLineEquation	(	double *	p,
		double	slope
	)

Add a line for thresholding in point-slope form.

void vtkBivariateLinearTableThreshold::AddLineEquation	(	double	a,
		double	b,
		double	c
	)

Add a line for thresholding in implicit form (ax + by + c = 0)

void vtkBivariateLinearTableThreshold::ClearLineEquations ( )

Reset the list of line equations.

virtual int vtkBivariateLinearTableThreshold::GetLinearThresholdType ( ) [virtual]