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

extracts cells where scalar value in cell satisfies threshold criterion More...

#include <vtkThreshold.h>

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

Public Types

typedef vtkUnstructuredGridAlgorithm Superclass
 
- Public Types inherited from vtkUnstructuredGridAlgorithm
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...
 
vtkThresholdNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void ThresholdByLower (double lower)
 Criterion is cells whose scalars are less or equal to lower threshold. More...
 
void ThresholdByUpper (double upper)
 Criterion is cells whose scalars are greater or equal to upper threshold. More...
 
void ThresholdBetween (double lower, double upper)
 Criterion is cells whose scalars are between lower and upper thresholds (inclusive of the end values). More...
 
virtual double GetUpperThreshold ()
 Get the Upper and Lower thresholds. More...
 
virtual double GetLowerThreshold ()
 
virtual void SetAttributeMode (int)
 Control how the filter works with scalar point data and cell attribute data. More...
 
virtual int GetAttributeMode ()
 
void SetAttributeModeToDefault ()
 
void SetAttributeModeToUsePointData ()
 
void SetAttributeModeToUseCellData ()
 
const char * GetAttributeModeAsString ()
 
virtual void SetComponentMode (int)
 Control how the decision of in / out is made with multi-component data. More...
 
virtual int GetComponentMode ()
 
void SetComponentModeToUseSelected ()
 
void SetComponentModeToUseAll ()
 
void SetComponentModeToUseAny ()
 
const char * GetComponentModeAsString ()
 
virtual void SetSelectedComponent (int)
 When the component mode is UseSelected, this ivar indicated the selected component. More...
 
virtual int GetSelectedComponent ()
 
virtual void SetAllScalars (vtkTypeBool)
 If using scalars from point data, all scalars for all points in a cell must satisfy the threshold criterion if AllScalars is set. More...
 
virtual vtkTypeBool GetAllScalars ()
 
virtual void AllScalarsOn ()
 
virtual void AllScalarsOff ()
 
virtual void SetUseContinuousCellRange (vtkTypeBool)
 If this is on (default is off), we will use the continuous interval [minimum cell scalar, maxmimum cell scalar] to intersect the threshold bound , rather than the set of discrete scalar values from the vertices WARNING: For higher order cells, the scalar range of the cell is not the same as the vertex scalar interval used here, so the result will not be accurate. More...
 
virtual vtkTypeBool GetUseContinuousCellRange ()
 
virtual void UseContinuousCellRangeOn ()
 
virtual void UseContinuousCellRangeOff ()
 
void SetPointsDataTypeToDouble ()
 Set the data type of the output points (See the data types defined in vtkType.h). More...
 
void SetPointsDataTypeToFloat ()
 
void SetPointsDataType (int type)
 
int GetPointsDataType ()
 
virtual void SetInvert (bool)
 Invert the threshold results. More...
 
virtual bool GetInvert ()
 
virtual void InvertOn ()
 
virtual void InvertOff ()
 
void SetOutputPointsPrecision (int precision)
 Set/get the desired precision for the output types. More...
 
int GetOutputPointsPrecision () const
 
int Lower (double s) const
 Methods used for thresholding. More...
 
int Upper (double s) const
 
int Between (double s) const
 
- Public Member Functions inherited from vtkUnstructuredGridAlgorithm
vtkUnstructuredGridAlgorithmNewInstance () const
 
vtkUnstructuredGridGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkUnstructuredGridGetOutput (int)
 
virtual void SetOutput (vtkDataObject *d)
 
vtkTypeBool ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 see vtkAlgorithm for details More...
 
vtkDataObjectGetInput (int port)
 
vtkDataObjectGetInput ()
 
vtkUnstructuredGridGetUnstructuredGridInput (int port)
 
void SetInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataObject *)
 
void AddInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void AddInputData (int, vtkDataObject *)
 
- 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 vtkThresholdNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkThresholdSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkUnstructuredGridAlgorithm
static vtkUnstructuredGridAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkUnstructuredGridAlgorithmSafeDownCast (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
 
 vtkThreshold ()
 
 ~vtkThreshold () 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 EvaluateComponents (vtkDataArray *scalars, vtkIdType id)
 
int EvaluateCell (vtkDataArray *scalars, vtkIdList *cellPts, int numCellPts)
 
int EvaluateCell (vtkDataArray *scalars, int c, vtkIdList *cellPts, int numCellPts)
 
- Protected Member Functions inherited from vtkUnstructuredGridAlgorithm
 vtkUnstructuredGridAlgorithm ()
 
 ~vtkUnstructuredGridAlgorithm () override
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass. More...
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm. 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

vtkTypeBool AllScalars
 
double LowerThreshold
 
double UpperThreshold
 
int AttributeMode
 
int ComponentMode
 
int SelectedComponent
 
int OutputPointsPrecision
 
vtkTypeBool UseContinuousCellRange
 
bool Invert
 
int(vtkThreshold::* ThresholdFunction )(double s) const
 
- 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

extracts cells where scalar value in cell satisfies threshold criterion

vtkThreshold is a filter that extracts cells from any dataset type that satisfy a threshold criterion. A cell satisfies the criterion if the scalar value of (every or any) point satisfies the criterion. The criterion can take three forms: 1) greater than a particular value; 2) less than a particular value; or 3) between two values. The output of this filter is an unstructured grid.

Note that scalar values are available from the point and cell attribute data. By default, point data is used to obtain scalars, but you can control this behavior. See the AttributeMode ivar below.

By default only the first scalar value is used in the decision. Use the ComponentMode and SelectedComponent ivars to control this behavior.

See also
vtkThresholdPoints vtkThresholdTextureCoords

Definition at line 55 of file vtkThreshold.h.

Member Typedef Documentation

◆ Superclass

Definition at line 59 of file vtkThreshold.h.

Constructor & Destructor Documentation

◆ vtkThreshold()

vtkThreshold::vtkThreshold ( )
protected

◆ ~vtkThreshold()

vtkThreshold::~vtkThreshold ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkThreshold* vtkThreshold::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkThreshold::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 vtkUnstructuredGridAlgorithm.

Reimplemented in vtkmThreshold.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkThreshold::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkUnstructuredGridAlgorithm.

Reimplemented in vtkmThreshold.

◆ NewInstance()

vtkThreshold* vtkThreshold::NewInstance ( ) const

◆ PrintSelf()

void vtkThreshold::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 vtkUnstructuredGridAlgorithm.

◆ ThresholdByLower()

void vtkThreshold::ThresholdByLower ( double  lower)

Criterion is cells whose scalars are less or equal to lower threshold.

◆ ThresholdByUpper()

void vtkThreshold::ThresholdByUpper ( double  upper)

Criterion is cells whose scalars are greater or equal to upper threshold.

◆ ThresholdBetween()

void vtkThreshold::ThresholdBetween ( double  lower,
double  upper 
)

Criterion is cells whose scalars are between lower and upper thresholds (inclusive of the end values).

◆ GetUpperThreshold()

virtual double vtkThreshold::GetUpperThreshold ( )
virtual

Get the Upper and Lower thresholds.

◆ GetLowerThreshold()

virtual double vtkThreshold::GetLowerThreshold ( )
virtual

◆ SetAttributeMode()

virtual void vtkThreshold::SetAttributeMode ( int  )
virtual

Control how the filter works with scalar point data and cell attribute data.

By default (AttributeModeToDefault), the filter will use point data, and if no point data is available, then cell data is used. Alternatively you can explicitly set the filter to use point data (AttributeModeToUsePointData) or cell data (AttributeModeToUseCellData).

◆ GetAttributeMode()

virtual int vtkThreshold::GetAttributeMode ( )
virtual

◆ SetAttributeModeToDefault()

void vtkThreshold::SetAttributeModeToDefault ( )
inline

Definition at line 96 of file vtkThreshold.h.

◆ SetAttributeModeToUsePointData()

void vtkThreshold::SetAttributeModeToUsePointData ( )
inline

Definition at line 97 of file vtkThreshold.h.

◆ SetAttributeModeToUseCellData()

void vtkThreshold::SetAttributeModeToUseCellData ( )
inline

Definition at line 101 of file vtkThreshold.h.

◆ GetAttributeModeAsString()

const char* vtkThreshold::GetAttributeModeAsString ( )

◆ SetComponentMode()

virtual void vtkThreshold::SetComponentMode ( int  )
virtual

Control how the decision of in / out is made with multi-component data.

The choices are to use the selected component (specified in the SelectedComponent ivar), or to look at all components. When looking at all components, the evaluation can pass if all the components satisfy the rule (UseAll) or if any satisfy is (UseAny). The default value is UseSelected.

◆ GetComponentMode()

virtual int vtkThreshold::GetComponentMode ( )
virtual

◆ SetComponentModeToUseSelected()

void vtkThreshold::SetComponentModeToUseSelected ( )
inline

Definition at line 116 of file vtkThreshold.h.

◆ SetComponentModeToUseAll()

void vtkThreshold::SetComponentModeToUseAll ( )
inline

Definition at line 117 of file vtkThreshold.h.

◆ SetComponentModeToUseAny()

void vtkThreshold::SetComponentModeToUseAny ( )
inline

Definition at line 118 of file vtkThreshold.h.

◆ GetComponentModeAsString()

const char* vtkThreshold::GetComponentModeAsString ( )

◆ SetSelectedComponent()

virtual void vtkThreshold::SetSelectedComponent ( int  )
virtual

When the component mode is UseSelected, this ivar indicated the selected component.

The default value is 0.

◆ GetSelectedComponent()

virtual int vtkThreshold::GetSelectedComponent ( )
virtual

◆ SetAllScalars()

virtual void vtkThreshold::SetAllScalars ( vtkTypeBool  )
virtual

If using scalars from point data, all scalars for all points in a cell must satisfy the threshold criterion if AllScalars is set.

Otherwise, just a single scalar value satisfying the threshold criterion enables will extract the cell.

◆ GetAllScalars()

virtual vtkTypeBool vtkThreshold::GetAllScalars ( )
virtual

◆ AllScalarsOn()

virtual void vtkThreshold::AllScalarsOn ( )
virtual

◆ AllScalarsOff()

virtual void vtkThreshold::AllScalarsOff ( )
virtual

◆ SetUseContinuousCellRange()

virtual void vtkThreshold::SetUseContinuousCellRange ( vtkTypeBool  )
virtual

If this is on (default is off), we will use the continuous interval [minimum cell scalar, maxmimum cell scalar] to intersect the threshold bound , rather than the set of discrete scalar values from the vertices WARNING: For higher order cells, the scalar range of the cell is not the same as the vertex scalar interval used here, so the result will not be accurate.

◆ GetUseContinuousCellRange()

virtual vtkTypeBool vtkThreshold::GetUseContinuousCellRange ( )
virtual

◆ UseContinuousCellRangeOn()

virtual void vtkThreshold::UseContinuousCellRangeOn ( )
virtual

◆ UseContinuousCellRangeOff()

virtual void vtkThreshold::UseContinuousCellRangeOff ( )
virtual

◆ SetPointsDataTypeToDouble()

void vtkThreshold::SetPointsDataTypeToDouble ( )
inline

Set the data type of the output points (See the data types defined in vtkType.h).

The default data type is float.

These methods are deprecated. Please use the SetOutputPointsPrecision() and GetOutputPointsPrecision() methods instead.

Definition at line 165 of file vtkThreshold.h.

◆ SetPointsDataTypeToFloat()

void vtkThreshold::SetPointsDataTypeToFloat ( )
inline

Definition at line 166 of file vtkThreshold.h.

◆ SetPointsDataType()

void vtkThreshold::SetPointsDataType ( int  type)

◆ GetPointsDataType()

int vtkThreshold::GetPointsDataType ( )

◆ SetInvert()

virtual void vtkThreshold::SetInvert ( bool  )
virtual

Invert the threshold results.

That is, cells that would have been in the output with this option off are excluded, while cells that would have been excluded from the output are included.

◆ GetInvert()

virtual bool vtkThreshold::GetInvert ( )
virtual

◆ InvertOn()

virtual void vtkThreshold::InvertOn ( )
virtual

◆ InvertOff()

virtual void vtkThreshold::InvertOff ( )
virtual

◆ SetOutputPointsPrecision()

void vtkThreshold::SetOutputPointsPrecision ( int  precision)

Set/get the desired precision for the output types.

See the documentation for the vtkAlgorithm::DesiredOutputPrecision enum for an explanation of the available precision settings.

◆ GetOutputPointsPrecision()

int vtkThreshold::GetOutputPointsPrecision ( ) const

◆ Lower()

int vtkThreshold::Lower ( double  s) const

Methods used for thresholding.

vtkThreshold::Lower returns true if s is lower than threshold, vtkThreshold::Upper returns true if s is upper than treshold, and vtkThreshold::Between returns true if s is between two threshold.

Warning
vtkThreshold::Lower and vtkThreshold::Upper use different thresholds which are set using the methods vtkThreshold::ThresholdByLower and vtkThreshold::ThresholdByUpper respectively. vtkThreshold::ThresholdBetween sets both thresholds. Do not use those methods without priorly setting the corresponding threshold.
Note
They are not protected member for inheritance purposes. The addresses of those methods is stored in one of this class attributes to figure out which version of the threshold to apply, which are inaccessible if protected.

◆ Upper()

int vtkThreshold::Upper ( double  s) const

◆ Between()

int vtkThreshold::Between ( double  s) const

◆ RequestData()

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

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkUnstructuredGridAlgorithm.

◆ FillInputPortInformation()

int vtkThreshold::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 vtkUnstructuredGridAlgorithm.

◆ EvaluateComponents()

int vtkThreshold::EvaluateComponents ( vtkDataArray scalars,
vtkIdType  id 
)
protected

◆ EvaluateCell() [1/2]

int vtkThreshold::EvaluateCell ( vtkDataArray scalars,
vtkIdList cellPts,
int  numCellPts 
)
protected

◆ EvaluateCell() [2/2]

int vtkThreshold::EvaluateCell ( vtkDataArray scalars,
int  c,
vtkIdList cellPts,
int  numCellPts 
)
protected

Member Data Documentation

◆ AllScalars

vtkTypeBool vtkThreshold::AllScalars
protected

Definition at line 220 of file vtkThreshold.h.

◆ LowerThreshold

double vtkThreshold::LowerThreshold
protected

Definition at line 221 of file vtkThreshold.h.

◆ UpperThreshold

double vtkThreshold::UpperThreshold
protected

Definition at line 222 of file vtkThreshold.h.

◆ AttributeMode

int vtkThreshold::AttributeMode
protected

Definition at line 223 of file vtkThreshold.h.

◆ ComponentMode

int vtkThreshold::ComponentMode
protected

Definition at line 224 of file vtkThreshold.h.

◆ SelectedComponent

int vtkThreshold::SelectedComponent
protected

Definition at line 225 of file vtkThreshold.h.

◆ OutputPointsPrecision

int vtkThreshold::OutputPointsPrecision
protected

Definition at line 226 of file vtkThreshold.h.

◆ UseContinuousCellRange

vtkTypeBool vtkThreshold::UseContinuousCellRange
protected

Definition at line 227 of file vtkThreshold.h.

◆ Invert

bool vtkThreshold::Invert
protected

Definition at line 228 of file vtkThreshold.h.

◆ ThresholdFunction

int(vtkThreshold::* vtkThreshold::ThresholdFunction) (double s) const
protected

Definition at line 230 of file vtkThreshold.h.


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