VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkBivariateLinearTableThreshold Class Reference

performs line-based thresholding for vtkTable data. More...

#include <vtkBivariateLinearTableThreshold.h>

Inheritance diagram for vtkBivariateLinearTableThreshold:
[legend]
Collaboration diagram for vtkBivariateLinearTableThreshold:
[legend]

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 Types inherited from vtkTableAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
enum  DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
 Values used for setting the desired output precision for various algorithms. More...
 
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkBivariateLinearTableThresholdNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetInclusive (int)
 Include the line in the threshold. More...
 
virtual int GetInclusive ()
 
void AddColumnToThreshold (vtkIdType column, vtkIdType component)
 Add a numeric column to the pair of columns to be thresholded. More...
 
int GetNumberOfColumnsToThreshold ()
 Return how many columns have been added. More...
 
void GetColumnToThreshold (vtkIdType idx, vtkIdType &column, vtkIdType &component)
 Return the column number from the input table for the idx'th added column. More...
 
void ClearColumnsToThreshold ()
 Reset the columns to be thresholded. More...
 
vtkIdTypeArrayGetSelectedRowIds (int selection=0)
 Get the output as a table of row ids. More...
 
void Initialize ()
 Reset the columns to threshold, column ranges, etc. More...
 
void AddLineEquation (double *p1, double *p2)
 Add a line for thresholding from two x,y points. More...
 
void AddLineEquation (double *p, double slope)
 Add a line for thresholding in point-slope form. More...
 
void AddLineEquation (double a, double b, double c)
 Add a line for thresholding in implicit form (ax + by + c = 0) More...
 
void ClearLineEquations ()
 Reset the list of line equations. More...
 
virtual int GetLinearThresholdType ()
 Set the threshold type. More...
 
virtual void SetLinearThresholdType (int)
 
void SetLinearThresholdTypeToAbove ()
 
void SetLinearThresholdTypeToBelow ()
 
void SetLinearThresholdTypeToNear ()
 
void SetLinearThresholdTypeToBetween ()
 
virtual void SetColumnRanges (double, double)
 Manually access the maximum/minimum x,y values. More...
 
void SetColumnRanges (double[2])
 
virtual double * GetColumnRanges ()
 
virtual void GetColumnRanges (double &, double &)
 
virtual void GetColumnRanges (double[2])
 
virtual void SetDistanceThreshold (double)
 The Cartesian distance within which a point will pass the near threshold. More...
 
virtual double GetDistanceThreshold ()
 
virtual void SetUseNormalizedDistance (vtkTypeBool)
 Renormalize the space of the data such that the X and Y axes are "square" over the specified ColumnRanges. More...
 
virtual vtkTypeBool GetUseNormalizedDistance ()
 
virtual void UseNormalizedDistanceOn ()
 
virtual void UseNormalizedDistanceOff ()
 
- Public Member Functions inherited from vtkTableAlgorithm
vtkTableAlgorithmNewInstance () const
 
vtkTypeBool ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 see vtkAlgorithm for details More...
 
vtkTableGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkTableGetOutput (int index)
 
void SetInputData (vtkDataObject *obj)
 Assign a data object as input. More...
 
void SetInputData (int index, vtkDataObject *obj)
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 A special version of ProcessRequest meant specifically for the pipeline modified time request. More...
 
virtual int ModifyRequest (vtkInformation *request, int when)
 This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm. More...
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Decrease the reference count (release by another object). More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressShift ()
 
virtual double GetProgressScale ()
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 
virtual vtkTypeBool Update (int port, vtkInformationVector *requests)
 This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date). More...
 
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
int * GetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
int * GetUpdateExtent (int port)
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int extent[6])
 
void GetUpdateExtent (int port, int extent[6])
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkBivariateLinearTableThresholdNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkBivariateLinearTableThresholdSafeDownCast (vtkObjectBase *o)
 
static void ComputeImplicitLineFunction (double *p1, double *p2, double *abc)
 Convert the two-point line formula to implicit form. More...
 
static void ComputeImplicitLineFunction (double *p, double slope, double *abc)
 Convert the point-slope line formula to implicit form. More...
 
- Static Public Member Functions inherited from vtkTableAlgorithm
static vtkTableAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkTableAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements. More...
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkBivariateLinearTableThreshold ()
 
 ~vtkBivariateLinearTableThreshold () override
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called by the superclass. More...
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm. More...
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm. More...
 
virtual int ApplyThreshold (vtkTable *tableToThreshold, vtkIdTypeArray *acceptedIds)
 Apply the current threshold to a vtkTable. More...
 
int ThresholdAbove (double x, double y)
 Determine if x,y is above all specified lines. More...
 
int ThresholdBelow (double x, double y)
 Determine if x,y is below all specified lines. More...
 
int ThresholdNear (double x, double y)
 Determine if x,y is near ONE specified line (not all). More...
 
int ThresholdBetween (double x, double y)
 Determine if x,y is between ANY TWO of the specified lines. More...
 
- Protected Member Functions inherited from vtkTableAlgorithm
 vtkTableAlgorithm ()
 
 ~vtkTableAlgorithm () override
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass. More...
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port. More...
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port. More...
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input. More...
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

double ColumnRanges [2]
 
double DistanceThreshold
 
int Inclusive
 
int LinearThresholdType
 
int NumberOfLineEquations
 
vtkTypeBool UseNormalizedDistance
 
vtkSmartPointer< vtkDoubleArrayLineEquations
 
Internals * Implementation
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
unsigned long ErrorCode
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
vtkTypeBool AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

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 52 of file vtkBivariateLinearTableThreshold.h.

Member Typedef Documentation

◆ Superclass

Definition at line 56 of file vtkBivariateLinearTableThreshold.h.

Member Enumeration Documentation

◆ OutputPorts

Enumerator
OUTPUT_ROW_IDS 
OUTPUT_ROW_DATA 

Definition at line 93 of file vtkBivariateLinearTableThreshold.h.

◆ LinearThresholdType

Enumerator
BLT_ABOVE 
BLT_BELOW 
BLT_NEAR 
BLT_BETWEEN 

Definition at line 98 of file vtkBivariateLinearTableThreshold.h.

Constructor & Destructor Documentation

◆ vtkBivariateLinearTableThreshold()

vtkBivariateLinearTableThreshold::vtkBivariateLinearTableThreshold ( )
protected

◆ ~vtkBivariateLinearTableThreshold()

vtkBivariateLinearTableThreshold::~vtkBivariateLinearTableThreshold ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkBivariateLinearTableThreshold* vtkBivariateLinearTableThreshold::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkBivariateLinearTableThreshold::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool 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.

◆ SafeDownCast()

static vtkBivariateLinearTableThreshold* vtkBivariateLinearTableThreshold::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkBivariateLinearTableThreshold::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkTableAlgorithm.

Reimplemented in vtkPBivariateLinearTableThreshold.

◆ NewInstance()

vtkBivariateLinearTableThreshold* vtkBivariateLinearTableThreshold::NewInstance ( ) const

◆ PrintSelf()

void vtkBivariateLinearTableThreshold::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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.

◆ SetInclusive()

virtual void vtkBivariateLinearTableThreshold::SetInclusive ( int  )
virtual

Include the line in the threshold.

Essentially whether the threshold operation uses > versus >=.

◆ GetInclusive()

virtual int vtkBivariateLinearTableThreshold::GetInclusive ( )
virtual

◆ AddColumnToThreshold()

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

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

Call twice.

◆ GetNumberOfColumnsToThreshold()

int vtkBivariateLinearTableThreshold::GetNumberOfColumnsToThreshold ( )

Return how many columns have been added.

Hopefully 2.

◆ GetColumnToThreshold()

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

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

◆ ClearColumnsToThreshold()

void vtkBivariateLinearTableThreshold::ClearColumnsToThreshold ( )

Reset the columns to be thresholded.

◆ GetSelectedRowIds()

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

Get the output as a table of row ids.

◆ Initialize()

void vtkBivariateLinearTableThreshold::Initialize ( )

Reset the columns to threshold, column ranges, etc.

◆ AddLineEquation() [1/3]

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

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

◆ AddLineEquation() [2/3]

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

Add a line for thresholding in point-slope form.

◆ AddLineEquation() [3/3]

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

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

◆ ClearLineEquations()

void vtkBivariateLinearTableThreshold::ClearLineEquations ( )

Reset the list of line equations.

◆ GetLinearThresholdType()

virtual int vtkBivariateLinearTableThreshold::GetLinearThresholdType ( )
virtual

Set the threshold type.

Above: find all rows that are above the specified lines. Below: find all rows that are below the specified lines. Near: find all rows that are near the specified lines. Between: find all rows that are between the specified lines.

◆ SetLinearThresholdType()

virtual void vtkBivariateLinearTableThreshold::SetLinearThresholdType ( int  )
virtual

◆ SetLinearThresholdTypeToAbove()

void vtkBivariateLinearTableThreshold::SetLinearThresholdTypeToAbove ( )
inline

Definition at line 140 of file vtkBivariateLinearTableThreshold.h.

◆ SetLinearThresholdTypeToBelow()

void vtkBivariateLinearTableThreshold::SetLinearThresholdTypeToBelow ( )
inline

Definition at line 144 of file vtkBivariateLinearTableThreshold.h.

◆ SetLinearThresholdTypeToNear()

void vtkBivariateLinearTableThreshold::SetLinearThresholdTypeToNear ( )
inline

Definition at line 148 of file vtkBivariateLinearTableThreshold.h.

◆ SetLinearThresholdTypeToBetween()

void vtkBivariateLinearTableThreshold::SetLinearThresholdTypeToBetween ( )
inline

Definition at line 152 of file vtkBivariateLinearTableThreshold.h.

◆ SetColumnRanges() [1/2]

virtual void vtkBivariateLinearTableThreshold::SetColumnRanges ( double  ,
double   
)
virtual

Manually access the maximum/minimum x,y values.

This is used in conjunction with UseNormalizedDistance when determining if a row passes the threshold.

◆ SetColumnRanges() [2/2]

void vtkBivariateLinearTableThreshold::SetColumnRanges ( double  [2])

◆ GetColumnRanges() [1/3]

virtual double* vtkBivariateLinearTableThreshold::GetColumnRanges ( )
virtual

◆ GetColumnRanges() [2/3]

virtual void vtkBivariateLinearTableThreshold::GetColumnRanges ( double &  ,
double &   
)
virtual

◆ GetColumnRanges() [3/3]

virtual void vtkBivariateLinearTableThreshold::GetColumnRanges ( double  [2])
virtual

◆ SetDistanceThreshold()

virtual void vtkBivariateLinearTableThreshold::SetDistanceThreshold ( double  )
virtual

The Cartesian distance within which a point will pass the near threshold.

◆ GetDistanceThreshold()

virtual double vtkBivariateLinearTableThreshold::GetDistanceThreshold ( )
virtual

◆ SetUseNormalizedDistance()

virtual void vtkBivariateLinearTableThreshold::SetUseNormalizedDistance ( vtkTypeBool  )
virtual

Renormalize the space of the data such that the X and Y axes are "square" over the specified ColumnRanges.

This essentially scales the data space so that ColumnRanges[1]-ColumnRanges[0] = 1.0 and ColumnRanges[3]-ColumnRanges[2] = 1.0. Used for scatter plot distance calculations. Be sure to set DistanceThreshold accordingly, when used.

◆ GetUseNormalizedDistance()

virtual vtkTypeBool vtkBivariateLinearTableThreshold::GetUseNormalizedDistance ( )
virtual

◆ UseNormalizedDistanceOn()

virtual void vtkBivariateLinearTableThreshold::UseNormalizedDistanceOn ( )
virtual

◆ UseNormalizedDistanceOff()

virtual void vtkBivariateLinearTableThreshold::UseNormalizedDistanceOff ( )
virtual

◆ ComputeImplicitLineFunction() [1/2]

static void vtkBivariateLinearTableThreshold::ComputeImplicitLineFunction ( double *  p1,
double *  p2,
double *  abc 
)
static

Convert the two-point line formula to implicit form.

◆ ComputeImplicitLineFunction() [2/2]

static void vtkBivariateLinearTableThreshold::ComputeImplicitLineFunction ( double *  p,
double  slope,
double *  abc 
)
static

Convert the point-slope line formula to implicit form.

◆ RequestData()

int vtkBivariateLinearTableThreshold::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkTableAlgorithm.

◆ FillInputPortInformation()

int vtkBivariateLinearTableThreshold::FillInputPortInformation ( int  port,
vtkInformation info 
)
overrideprotectedvirtual

Fill the input port information objects for this algorithm.

This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkTableAlgorithm.

◆ FillOutputPortInformation()

int vtkBivariateLinearTableThreshold::FillOutputPortInformation ( int  port,
vtkInformation info 
)
overrideprotectedvirtual

Fill the output port information objects for this algorithm.

This is invoked by the first call to GetOutputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkTableAlgorithm.

◆ ApplyThreshold()

virtual int vtkBivariateLinearTableThreshold::ApplyThreshold ( vtkTable tableToThreshold,
vtkIdTypeArray acceptedIds 
)
protectedvirtual

Apply the current threshold to a vtkTable.

Fills acceptedIds on success.

◆ ThresholdAbove()

int vtkBivariateLinearTableThreshold::ThresholdAbove ( double  x,
double  y 
)
protected

Determine if x,y is above all specified lines.

◆ ThresholdBelow()

int vtkBivariateLinearTableThreshold::ThresholdBelow ( double  x,
double  y 
)
protected

Determine if x,y is below all specified lines.

◆ ThresholdNear()

int vtkBivariateLinearTableThreshold::ThresholdNear ( double  x,
double  y 
)
protected

Determine if x,y is near ONE specified line (not all).

◆ ThresholdBetween()

int vtkBivariateLinearTableThreshold::ThresholdBetween ( double  x,
double  y 
)
protected

Determine if x,y is between ANY TWO of the specified lines.

Member Data Documentation

◆ ColumnRanges

double vtkBivariateLinearTableThreshold::ColumnRanges[2]
protected

Definition at line 203 of file vtkBivariateLinearTableThreshold.h.

◆ DistanceThreshold

double vtkBivariateLinearTableThreshold::DistanceThreshold
protected

Definition at line 204 of file vtkBivariateLinearTableThreshold.h.

◆ Inclusive

int vtkBivariateLinearTableThreshold::Inclusive
protected

Definition at line 205 of file vtkBivariateLinearTableThreshold.h.

◆ LinearThresholdType

Definition at line 206 of file vtkBivariateLinearTableThreshold.h.

◆ NumberOfLineEquations

int vtkBivariateLinearTableThreshold::NumberOfLineEquations
protected

Definition at line 207 of file vtkBivariateLinearTableThreshold.h.

◆ UseNormalizedDistance

vtkTypeBool vtkBivariateLinearTableThreshold::UseNormalizedDistance
protected

Definition at line 208 of file vtkBivariateLinearTableThreshold.h.

◆ LineEquations

vtkSmartPointer<vtkDoubleArray> vtkBivariateLinearTableThreshold::LineEquations
protected

Definition at line 210 of file vtkBivariateLinearTableThreshold.h.

◆ Implementation

Internals* vtkBivariateLinearTableThreshold::Implementation
protected

Definition at line 211 of file vtkBivariateLinearTableThreshold.h.


The documentation for this class was generated from the following file: