VTK
9.1.0
|
Threshold cells within multiple intervals. More...
#include <vtkMultiThreshold.h>
Classes | |
class | BooleanSet |
A subset of a mesh represented as a boolean set operation. More... | |
class | Interval |
A subset of a mesh represented by a range of acceptable attribute values. More... | |
class | NormKey |
A class with comparison operator used to index input array norms used in threshold rules. More... | |
class | Set |
A base class for representing threshold sets. More... | |
Public Types | |
enum | Closure { OPEN = 0 , CLOSED = 1 } |
Whether the endpoint value of an interval should be included or excluded. More... | |
enum | Norm { LINFINITY_NORM = -3 , L2_NORM = -2 , L1_NORM = -1 } |
Norms that can be used to threshold vector attributes. More... | |
enum | SetOperation { AND , OR , XOR , WOR , NAND } |
Operations that can be performed on sets to generate another set. More... | |
typedef vtkMultiBlockDataSetAlgorithm | Superclass |
typedef double(* | TupleNorm) (vtkDataArray *arr, vtkIdType tuple, int component) |
A pointer to a function that returns a norm (or a single component) of a tuple with 1 or more components. More... | |
Public Types inherited from vtkMultiBlockDataSetAlgorithm | |
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... | |
vtkMultiThreshold * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. More... | |
int | AddBooleanSet (int operation, int numInputs, int *inputs) |
Create a new mesh subset using boolean operations on pre-existing sets. More... | |
int | OutputSet (int setId) |
Create an output mesh containing a boolean or interval subset of the input mesh. More... | |
void | Reset () |
Remove all the intervals currently defined. More... | |
int | AddIntervalSet (double xmin, double xmax, int omin, int omax, int assoc, const char *arrayName, int component, int allScalars) |
Add a mesh subset to be computed by thresholding an attribute of the input mesh. More... | |
int | AddIntervalSet (double xmin, double xmax, int omin, int omax, int assoc, int attribType, int component, int allScalars) |
Add a mesh subset to be computed by thresholding an attribute of the input mesh. More... | |
int | AddLowpassIntervalSet (double xmax, int assoc, const char *arrayName, int component, int allScalars) |
These convenience members make it easy to insert closed intervals. More... | |
int | AddHighpassIntervalSet (double xmin, int assoc, const char *arrayName, int component, int allScalars) |
These convenience members make it easy to insert closed intervals. More... | |
int | AddBandpassIntervalSet (double xmin, double xmax, int assoc, const char *arrayName, int component, int allScalars) |
These convenience members make it easy to insert closed intervals. More... | |
int | AddNotchIntervalSet (double xlo, double xhi, int assoc, const char *arrayName, int component, int allScalars) |
These convenience members make it easy to insert closed intervals. More... | |
Public Member Functions inherited from vtkMultiBlockDataSetAlgorithm | |
virtual vtkTypeBool | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. More... | |
vtkMultiBlockDataSetAlgorithm * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. More... | |
vtkTypeBool | ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override |
see vtkAlgorithm for details More... | |
vtkMultiBlockDataSet * | GetOutput () |
Get the output data object for a port on this algorithm. More... | |
vtkMultiBlockDataSet * | GetOutput (int) |
Get the output data object for a port on this algorithm. More... | |
void | SetInputData (vtkDataObject *) |
Assign a data object as input. More... | |
void | SetInputData (int, vtkDataObject *) |
Assign a data object as input. More... | |
Public Member Functions inherited from vtkAlgorithm | |
virtual vtkTypeBool | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. More... | |
vtkAlgorithm * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. More... | |
int | HasExecutive () |
Check whether this algorithm has an assigned executive. More... | |
vtkExecutive * | GetExecutive () |
Get this algorithm's executive. More... | |
virtual void | SetExecutive (vtkExecutive *executive) |
Set this algorithm's executive. More... | |
virtual vtkTypeBool | ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo) |
Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality. 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... | |
vtkInformation * | GetInputPortInformation (int port) |
Get the information object associated with an input port. More... | |
vtkInformation * | GetOutputPortInformation (int port) |
Get the information object associated with an output port. More... | |
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 | SetProgress (double) |
SetProgress is deprecated. More... | |
void | UpdateProgress (double amount) |
Update the progress of the process object. More... | |
virtual void | SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName) |
String based versions of SetInputArrayToProcess(). More... | |
vtkInformation * | GetInputArrayInformation (int idx) |
Get the info object for the specified input array to this algorithm. More... | |
void | RemoveAllInputs () |
Remove all the input data. More... | |
vtkDataObject * | GetOutputDataObject (int port) |
Get the data object that will contain the algorithm output for the given port. More... | |
vtkDataObject * | GetInputDataObject (int port, int connection) |
Get the data object that will contain the algorithm input for the given port and given connection. More... | |
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) |
vtkAlgorithmOutput * | GetOutputPort (int index) |
Get a proxy object corresponding to the given output port of this algorithm. More... | |
vtkAlgorithmOutput * | GetOutputPort () |
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... | |
vtkAlgorithmOutput * | GetInputConnection (int port, int index) |
Get the algorithm output port connected to an input port. More... | |
vtkAlgorithm * | GetInputAlgorithm (int port, int index, int &algPort) |
Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More... | |
vtkAlgorithm * | GetInputAlgorithm (int port, int index) |
Returns the algorithm connected to a port-index pair. More... | |
vtkAlgorithm * | GetInputAlgorithm () |
Equivalent to GetInputAlgorithm(0, 0). More... | |
vtkExecutive * | GetInputExecutive (int port, int index) |
Returns the executive associated with a particular input connection. More... | |
vtkExecutive * | GetInputExecutive () |
Equivalent to GetInputExecutive(0, 0) More... | |
vtkInformation * | GetInputInformation (int port, int index) |
Return the information object that is associated with a particular input connection. More... | |
vtkInformation * | GetInputInformation () |
Equivalent to GetInputInformation(0, 0) More... | |
vtkInformation * | GetOutputInformation (int port) |
Return the information object that is associated with a particular output port. More... | |
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 vtkInformation * | GetInformation () |
Set/Get the information object associated with this algorithm. More... | |
virtual void | SetInformation (vtkInformation *) |
Set/Get the information object associated with this algorithm. More... | |
void | Register (vtkObjectBase *o) override |
Participate in garbage collection. More... | |
void | UnRegister (vtkObjectBase *o) override |
Participate in garbage collection. More... | |
virtual void | SetAbortExecute (vtkTypeBool) |
Set/Get the AbortExecute flag for the process object. More... | |
virtual vtkTypeBool | GetAbortExecute () |
Set/Get the AbortExecute flag for the process object. More... | |
virtual void | AbortExecuteOn () |
Set/Get the AbortExecute flag for the process object. More... | |
virtual void | AbortExecuteOff () |
Set/Get the AbortExecute flag for the process object. More... | |
virtual double | GetProgress () |
Get the execution progress of a 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 () |
Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More... | |
virtual double | GetProgressScale () |
Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More... | |
void | SetProgressText (const char *ptext) |
Set the current text message associated with the progress state. More... | |
virtual char * | GetProgressText () |
Set the current text message associated with the progress state. More... | |
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) |
Set the input data arrays that this algorithm will process. More... | |
virtual void | SetInputArrayToProcess (int idx, vtkInformation *info) |
Set the input data arrays that this algorithm will process. More... | |
virtual void | SetInputConnection (int port, vtkAlgorithmOutput *input) |
Set the connection for the given input port index. More... | |
virtual void | SetInputConnection (vtkAlgorithmOutput *input) |
Set the connection for the given input port index. More... | |
virtual void | AddInputConnection (int port, vtkAlgorithmOutput *input) |
Add a connection to the given input port index. More... | |
virtual void | AddInputConnection (vtkAlgorithmOutput *input) |
Add a connection to the given input port index. More... | |
virtual void | Update (int port) |
Bring this algorithm's outputs up-to-date. More... | |
virtual void | Update () |
Bring this algorithm's outputs up-to-date. More... | |
virtual void | SetReleaseDataFlag (int) |
Turn release data flag on or off for all output ports. More... | |
virtual int | GetReleaseDataFlag () |
Turn release data flag on or off for all output ports. More... | |
void | ReleaseDataFlagOn () |
Turn release data flag on or off for all output ports. More... | |
void | ReleaseDataFlagOff () |
Turn release data flag on or off for all output ports. More... | |
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) |
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 * | GetUpdateExtent () |
These functions return the update extent for output ports that use 3D extents. More... | |
int * | GetUpdateExtent (int port) |
These functions return the update extent for output ports that use 3D extents. More... | |
void | GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1) |
These functions return the update extent for output ports that use 3D extents. More... | |
void | GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1) |
These functions return the update extent for output ports that use 3D extents. More... | |
void | GetUpdateExtent (int extent[6]) |
These functions return the update extent for output ports that use 3D extents. More... | |
void | GetUpdateExtent (int port, int extent[6]) |
These functions return the update extent for output ports that use 3D extents. More... | |
int | GetUpdatePiece () |
These functions return the update extent for output ports that use piece extents. More... | |
int | GetUpdatePiece (int port) |
These functions return the update extent for output ports that use piece extents. More... | |
int | GetUpdateNumberOfPieces () |
These functions return the update extent for output ports that use piece extents. More... | |
int | GetUpdateNumberOfPieces (int port) |
These functions return the update extent for output ports that use piece extents. More... | |
int | GetUpdateGhostLevel () |
These functions return the update extent for output ports that use piece extents. More... | |
int | GetUpdateGhostLevel (int port) |
These functions return the update extent for output ports that use piece extents. More... | |
void | SetProgressObserver (vtkProgressObserver *) |
If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More... | |
virtual vtkProgressObserver * | GetProgressObserver () |
If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More... | |
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... | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. More... | |
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) |
int | InvokeEvent (unsigned long event) |
int | InvokeEvent (const char *event) |
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) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
vtkCommand * | GetCommand (unsigned long tag) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
void | RemoveObserver (vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
void | RemoveObservers (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
void | RemoveObservers (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
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) |
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, 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) |
This method invokes an event and return whether the event was aborted or not. More... | |
Public Member Functions inherited from vtkObjectBase | |
const char * | GetClassName () const |
Return the class name as a string. More... | |
virtual vtkTypeBool | IsA (const char *name) |
Return 1 if this class is the same type of (or a subclass of) the named class. More... | |
virtual vtkIdType | GetNumberOfGenerationsFromBase (const char *name) |
Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). 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 | Register (vtkObjectBase *o) |
Increase the reference count (mark as used by another object). More... | |
virtual void | UnRegister (vtkObjectBase *o) |
Decrease the reference count (release by another object). More... | |
int | GetReferenceCount () |
Return the current reference count of this object. More... | |
void | SetReferenceCount (int) |
Sets the reference count. More... | |
bool | GetIsInMemkind () const |
A local state flag that remembers whether this object lives in the normal or extended memory space. More... | |
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. More... | |
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. More... | |
Static Public Member Functions | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkMultiThreshold * | SafeDownCast (vtkObjectBase *o) |
static vtkMultiThreshold * | New () |
Static Public Member Functions inherited from vtkMultiBlockDataSetAlgorithm | |
static vtkMultiBlockDataSetAlgorithm * | New () |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkMultiBlockDataSetAlgorithm * | SafeDownCast (vtkObjectBase *o) |
Static Public Member Functions inherited from vtkAlgorithm | |
static vtkAlgorithm * | New () |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkAlgorithm * | SafeDownCast (vtkObjectBase *o) |
static vtkInformationIntegerKey * | INPUT_IS_OPTIONAL () |
Keys used to specify input port requirements. More... | |
static vtkInformationIntegerKey * | INPUT_IS_REPEATABLE () |
static vtkInformationInformationVectorKey * | INPUT_REQUIRED_FIELDS () |
static vtkInformationStringVectorKey * | INPUT_REQUIRED_DATA_TYPE () |
static vtkInformationInformationVectorKey * | INPUT_ARRAYS_TO_PROCESS () |
static vtkInformationIntegerKey * | INPUT_PORT () |
static vtkInformationIntegerKey * | INPUT_CONNECTION () |
static vtkInformationIntegerKey * | CAN_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 vtkInformationIntegerKey * | CAN_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 vtkObject * | New () |
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 () |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
static void | GlobalWarningDisplayOff () |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
static int | GetGlobalWarningDisplay () |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
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 vtkIdType | GetNumberOfGenerationsFromBaseType (const char *name) |
Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More... | |
static vtkObjectBase * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
static void | SetMemkindDirectory (const char *directoryname) |
The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More... | |
static bool | GetUsingMemkind () |
A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More... | |
Protected Types | |
enum | Ruling { INCONCLUSIVE = -1 , INCLUDE = -2 , EXCLUDE = -3 } |
When an interval is evaluated, its value is used to update a truth table. More... | |
typedef std::vector< Interval * > | IntervalList |
A list of pointers to IntervalSets. More... | |
typedef std::map< NormKey, IntervalList > | RuleMap |
A map describing the IntervalSets that share a common attribute and norm. More... | |
typedef std::vector< int > | TruthTreeValues |
typedef std::vector< TruthTreeValues > | TruthTree |
Protected Member Functions | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkMultiThreshold () | |
~vtkMultiThreshold () override | |
int | RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override |
This function performs the actual thresholding. More... | |
int | FillInputPortInformation (int port, vtkInformation *info) override |
We accept any mesh that is descended from vtkPointSet. More... | |
void | UpdateDependents (int id, std::set< int > &unresolvedOutputs, TruthTreeValues &setStates, vtkCellData *inCellData, vtkIdType inCell, vtkGenericCell *cell, std::vector< vtkUnstructuredGrid * > &outv) |
Recursively update the setStates and unresolvedOutputs vectors based on this->DependentSets. More... | |
int | AddIntervalSet (NormKey &nk, double xmin, double xmax, int omin, int omax) |
A utility method called by the public AddInterval members. More... | |
void | PrintGraph (ostream &os) |
Print out a graphviz-formatted text description of all the sets. More... | |
vtkMultiThreshold (const vtkMultiThreshold &)=delete | |
void | operator= (const vtkMultiThreshold &)=delete |
Protected Member Functions inherited from vtkMultiBlockDataSetAlgorithm | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkMultiBlockDataSetAlgorithm () | |
~vtkMultiBlockDataSetAlgorithm () override=default | |
virtual int | RequestDataObject (vtkInformation *, vtkInformationVector **, vtkInformationVector *) |
This is called by the superclass. More... | |
virtual int | RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *) |
This is called by the superclass. More... | |
virtual int | RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) |
This is called by the superclass. More... | |
vtkExecutive * | CreateDefaultExecutive () override |
Create a default executive. More... | |
int | FillOutputPortInformation (int port, vtkInformation *info) override |
Fill the output port information objects for this algorithm. More... | |
int | FillInputPortInformation (int port, vtkInformation *info) override |
Fill the input port information objects for this algorithm. More... | |
vtkDataObject * | GetInput (int port) |
virtual int | RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *) |
This is called by the superclass. More... | |
Protected Member Functions inherited from vtkAlgorithm | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkAlgorithm () | |
~vtkAlgorithm () override | |
virtual int | FillInputPortInformation (int port, vtkInformation *info) |
Fill the input port information objects for this algorithm. More... | |
virtual int | FillOutputPortInformation (int port, vtkInformation *info) |
Fill the output port information objects for this algorithm. More... | |
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... | |
vtkInformation * | GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector) |
This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More... | |
virtual vtkExecutive * | CreateDefaultExecutive () |
Create a default executive. 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) |
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) |
Filters that have multiple connections on one port can use this signature. More... | |
vtkDataArray * | GetInputArrayToProcess (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... | |
vtkDataArray * | GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association) |
Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More... | |
vtkDataArray * | GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector) |
Filters that have multiple connections on one port can use this signature. More... | |
vtkDataArray * | GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association) |
Filters that have multiple connections on one port can use this signature. More... | |
vtkDataArray * | GetInputArrayToProcess (int idx, vtkDataObject *input) |
Filters that have multiple connections on one port can use this signature. More... | |
vtkDataArray * | GetInputArrayToProcess (int idx, vtkDataObject *input, int &association) |
Filters that have multiple connections on one port can use this signature. More... | |
vtkAbstractArray * | GetInputAbstractArrayToProcess (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... | |
vtkAbstractArray * | GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association) |
Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More... | |
vtkAbstractArray * | GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector) |
Filters that have multiple connections on one port can use this signature. More... | |
vtkAbstractArray * | GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association) |
Filters that have multiple connections on one port can use this signature. More... | |
vtkAbstractArray * | GetInputAbstractArrayToProcess (int idx, vtkDataObject *input) |
Filters that have multiple connections on one port can use this signature. More... | |
vtkAbstractArray * | GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association) |
Filters that have multiple connections on one port can use this signature. More... | |
virtual void | SetErrorCode (unsigned long) |
The error code contains a possible error that occurred while reading or writing the file. More... | |
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 () |
These methods allow a command to exclusively grab all events. More... | |
Protected Member Functions inherited from vtkObjectBase | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | ReportReferences (vtkGarbageCollector *) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Protected Attributes | |
int | NextArrayIndex |
A variable used to store the next index to use when calling SetInputArrayToProcess. More... | |
int | NumberOfOutputs |
The number of output datasets. More... | |
RuleMap | IntervalRules |
A set of threshold rules sorted by the attribute+norm to which they are applied. More... | |
std::vector< Set * > | Sets |
A list of rules keyed by their unique integer ID. More... | |
TruthTree | DependentSets |
A list of boolean sets whose values depend on the given set. More... | |
Protected Attributes inherited from vtkAlgorithm | |
vtkInformation * | Information |
double | Progress |
char * | ProgressText |
vtkProgressObserver * | ProgressObserver |
unsigned long | ErrorCode |
The error code contains a possible error that occurred while reading or writing the file. More... | |
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 vtkInformationIntegerKey * | PORT_REQUIREMENTS_FILLED () |
Static Protected Member Functions inherited from vtkObjectBase | |
static vtkMallocingFunction | GetCurrentMallocFunction () |
static vtkReallocingFunction | GetCurrentReallocFunction () |
static vtkFreeingFunction | GetCurrentFreeFunction () |
static vtkFreeingFunction | GetAlternateFreeFunction () |
Static Protected Attributes inherited from vtkAlgorithm | |
static vtkExecutive * | DefaultExecutivePrototype |
Threshold cells within multiple intervals.
This filter can be substituted for a chain of several vtkThreshold filters and can also perform more sophisticated subsetting operations. It generates a vtkMultiBlockDataSet as its output. This multiblock dataset contains a vtkUnstructuredGrid for each thresholded subset you request. A thresholded subset can be a set defined by an interval over a point or cell attribute of the mesh; these subsets are called IntervalSets. A thresholded subset can also be a boolean combination of one or more IntervalSets; these subsets are called BooleanSets. BooleanSets allow complex logic since their output can depend on multiple intervals over multiple variables defined on the input mesh. This is useful because it eliminates the need for thresholding several times and then appending the results, as can be required with vtkThreshold when one wants to remove some range of values (e.g., a notch filter). Cells are not repeated when they belong to more than one interval unless those intervals have different output grids.
Another advantage this filter provides over vtkThreshold is the ability to threshold on non-scalar (i.e., vector, tensor, etc.) attributes without first computing an array containing some norm of the desired attribute. vtkMultiThreshold provides , , and norms.
This filter makes a distinction between intermediate subsets and subsets that will be output to a grid. Each intermediate subset you create with AddIntervalSet or AddBooleanSet is given a unique integer identifier (via the return values of these member functions). If you wish for a given set to be output, you must call OutputSet and pass it one of these identifiers. The return of OutputSet is the integer index of the output set in the multiblock dataset created by this filter.
For example, if an input mesh defined three attributes T, P, and s, one might wish to find cells that satisfy "T < 320 [K] && ( P > 101 [kPa] || s < 0.1 [kJ/kg/K] )". To accomplish this with a vtkMultiThreshold filter,
vtkMultiThreshold* thr; int intervalSets[3]; intervalSets[0] = thr->AddIntervalSet( vtkMath::NegInf(), 320., vtkMultiThreshold::CLOSED, vtkMultiThreshold::OPEN, vtkDataObject::FIELD_ASSOCIATION_POINTS, "T", 0, 1 ); intervalSets[1] = thr->AddIntervalSet( 101., vtkMath::Inf(), vtkMultiThreshold::OPEN, vtkMultiThreshold::CLOSED, vtkDataObject::FIELD_ASSOCIATION_CELLS, "P", 0, 1 ); intervalSets[2] = thr->AddIntervalSet( vtkMath::NegInf(), 0.1, vtkMultiThreshold::CLOSED, vtkMultiThreshold::OPEN, vtkDataObject::FIELD_ASSOCIATION_POINTS, "s", 0, 1 ); int intermediate = thr->AddBooleanSet( vtkMultiThreshold::OR, 2, &intervalSets[1] ); int intersection[2]; intersection[0] = intervalSets[0]; intersection[1] = intermediate; int outputSet = thr->AddBooleanSet( vtkMultiThreshold::AND, 2, intersection ); int outputGridIndex = thr->OutputSet( outputSet ); thr->Update();
The result of this filter will be a multiblock dataset that contains a single child with the desired cells. If we had also called thr->OutputSet( intervalSets[0] );
, there would be two child meshes and one would contain all cells with T < 320 [K]. In that case, the output can be represented by this graph
The filled rectangles represent sets that are output.
Definition at line 151 of file vtkMultiThreshold.h.
Definition at line 154 of file vtkMultiThreshold.h.
typedef double(* vtkMultiThreshold::TupleNorm) (vtkDataArray *arr, vtkIdType tuple, int component) |
A pointer to a function that returns a norm (or a single component) of a tuple with 1 or more components.
Definition at line 276 of file vtkMultiThreshold.h.
|
protected |
A list of pointers to IntervalSets.
Definition at line 459 of file vtkMultiThreshold.h.
|
protected |
A map describing the IntervalSets that share a common attribute and norm.
Definition at line 461 of file vtkMultiThreshold.h.
|
protected |
Definition at line 463 of file vtkMultiThreshold.h.
|
protected |
Definition at line 464 of file vtkMultiThreshold.h.
Whether the endpoint value of an interval should be included or excluded.
Enumerator | |
---|---|
OPEN | Specify an open interval. |
CLOSED | Specify a closed interval. |
Definition at line 159 of file vtkMultiThreshold.h.
Norms that can be used to threshold vector attributes.
Enumerator | |
---|---|
LINFINITY_NORM | Use the norm for the specified array threshold. |
L2_NORM | Use the norm for the specified array threshold. |
L1_NORM | Use the norm for the specified array threshold. |
Definition at line 165 of file vtkMultiThreshold.h.
Operations that can be performed on sets to generate another set.
Most of these operators take 2 or more input sets.
Definition at line 173 of file vtkMultiThreshold.h.
|
protected |
When an interval is evaluated, its value is used to update a truth table.
If its value allows the output of the truth table to be determined, then either INCLUDE or EXCLUDE is returned. Otherwise, INCONCLUSIVE is returned and more intervals must be evaluated.
As an example, consider the ruleset {A>10} & ( {6<B<8} | {C==12} ). We first evaluate A. Say A is 100. This makes the first rule true, but the value of the rule set is still indeterminate. INCONCLUSIVE is returned. Next we consider B. If B is 7, then INCLUDE will be returned and there is no need to examine C. If B is 0, then INCONCLUSIVE is returned again and we must examine C. If C is 12, then INCLUDE is returned, otherwise EXCLUDE is returned.
Enumerator | |
---|---|
INCONCLUSIVE | |
INCLUDE | |
EXCLUDE |
Definition at line 427 of file vtkMultiThreshold.h.
|
protected |
|
overrideprotected |
|
protecteddelete |
|
static |
|
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 vtkMultiBlockDataSetAlgorithm.
|
static |
|
protectedvirtual |
Reimplemented from vtkMultiBlockDataSetAlgorithm.
vtkMultiThreshold * vtkMultiThreshold::NewInstance | ( | ) | const |
|
static |
|
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 vtkMultiBlockDataSetAlgorithm.
int vtkMultiThreshold::AddIntervalSet | ( | double | xmin, |
double | xmax, | ||
int | omin, | ||
int | omax, | ||
int | assoc, | ||
const char * | arrayName, | ||
int | component, | ||
int | allScalars | ||
) |
Add a mesh subset to be computed by thresholding an attribute of the input mesh.
The subset can then be added to an output mesh with OutputSet() or combined with other sets using AddBooleanSet. If you wish to include all cells with values below some number a, call with xmin set to vtkMath::NegInf() and xmax set to a. Similarly, if you wish to include all cells with values above some number a, call with xmin set to a and xmax set to vtkMath::Inf(). When specifying Inf() or NegInf() for an endpoint, it does not matter whether you specify and open or closed endpoint.
When creating intervals, any integers can be used for the IDs of output meshes. All that matters is that the same ID be used if intervals should output to the same mesh. The outputs are ordered with ascending IDs in output block 0.
It is possible to specify an invalid interval, in which case these routines will return -1. Invalid intervals occur when
xmin | The minimum attribute value |
xmax | The maximum attribute value |
omin | Whether the interval should be open or closed at xmin. Use vtkMultiThreshold::OPEN or vtkMultiThreshold::CLOSED. |
omax | Whether the interval should be open or closed at xmax. Use vtkMultiThreshold::OPEN or vtkMultiThreshold::CLOSED. |
assoc | One of vtkDataObject::FIELD_ASSOCIATION_CELLS or vtkDataObject::FIELD_ASSOCIATION_POINTS indicating whether a point or cell array should be used. |
arrayName | The name of the array to use for thresholding |
attribType | The attribute to use for thresholding. One of vtkDataSetAttributes::SCALARS, VECTORS, TENSORS, NORMALS, TCOORDS, or GLOBALIDS. |
component | The number of the component to threshold on or one of the following enumerants for norms: LINFINITY_NORM, L2_NORM, L1_NORM. |
allScalars | When center is vtkDataObject::FIELD_ASSOCIATION_POINTS, must all scalars be in the interval for the cell to be passed to the output, or just a single point's scalar? |
int vtkMultiThreshold::AddIntervalSet | ( | double | xmin, |
double | xmax, | ||
int | omin, | ||
int | omax, | ||
int | assoc, | ||
int | attribType, | ||
int | component, | ||
int | allScalars | ||
) |
Add a mesh subset to be computed by thresholding an attribute of the input mesh.
The subset can then be added to an output mesh with OutputSet() or combined with other sets using AddBooleanSet. If you wish to include all cells with values below some number a, call with xmin set to vtkMath::NegInf() and xmax set to a. Similarly, if you wish to include all cells with values above some number a, call with xmin set to a and xmax set to vtkMath::Inf(). When specifying Inf() or NegInf() for an endpoint, it does not matter whether you specify and open or closed endpoint.
When creating intervals, any integers can be used for the IDs of output meshes. All that matters is that the same ID be used if intervals should output to the same mesh. The outputs are ordered with ascending IDs in output block 0.
It is possible to specify an invalid interval, in which case these routines will return -1. Invalid intervals occur when
xmin | The minimum attribute value |
xmax | The maximum attribute value |
omin | Whether the interval should be open or closed at xmin. Use vtkMultiThreshold::OPEN or vtkMultiThreshold::CLOSED. |
omax | Whether the interval should be open or closed at xmax. Use vtkMultiThreshold::OPEN or vtkMultiThreshold::CLOSED. |
assoc | One of vtkDataObject::FIELD_ASSOCIATION_CELLS or vtkDataObject::FIELD_ASSOCIATION_POINTS indicating whether a point or cell array should be used. |
arrayName | The name of the array to use for thresholding |
attribType | The attribute to use for thresholding. One of vtkDataSetAttributes::SCALARS, VECTORS, TENSORS, NORMALS, TCOORDS, or GLOBALIDS. |
component | The number of the component to threshold on or one of the following enumerants for norms: LINFINITY_NORM, L2_NORM, L1_NORM. |
allScalars | When center is vtkDataObject::FIELD_ASSOCIATION_POINTS, must all scalars be in the interval for the cell to be passed to the output, or just a single point's scalar? |
|
inline |
These convenience members make it easy to insert closed intervals.
The "notch" interval is accomplished by creating a bandpass interval and applying a NAND operation. In this case, the set ID returned in the NAND operation set ID. Note that you can pass xmin == xmax when creating a bandpass threshold to retrieve elements matching exactly one value (since the intervals created by these routines are closed).
Definition at line 507 of file vtkMultiThreshold.h.
|
inline |
These convenience members make it easy to insert closed intervals.
The "notch" interval is accomplished by creating a bandpass interval and applying a NAND operation. In this case, the set ID returned in the NAND operation set ID. Note that you can pass xmin == xmax when creating a bandpass threshold to retrieve elements matching exactly one value (since the intervals created by these routines are closed).
Definition at line 514 of file vtkMultiThreshold.h.
|
inline |
These convenience members make it easy to insert closed intervals.
The "notch" interval is accomplished by creating a bandpass interval and applying a NAND operation. In this case, the set ID returned in the NAND operation set ID. Note that you can pass xmin == xmax when creating a bandpass threshold to retrieve elements matching exactly one value (since the intervals created by these routines are closed).
Definition at line 521 of file vtkMultiThreshold.h.
|
inline |
These convenience members make it easy to insert closed intervals.
The "notch" interval is accomplished by creating a bandpass interval and applying a NAND operation. In this case, the set ID returned in the NAND operation set ID. Note that you can pass xmin == xmax when creating a bandpass threshold to retrieve elements matching exactly one value (since the intervals created by these routines are closed).
Definition at line 527 of file vtkMultiThreshold.h.
int vtkMultiThreshold::AddBooleanSet | ( | int | operation, |
int | numInputs, | ||
int * | inputs | ||
) |
Create a new mesh subset using boolean operations on pre-existing sets.
int vtkMultiThreshold::OutputSet | ( | int | setId | ) |
Create an output mesh containing a boolean or interval subset of the input mesh.
void vtkMultiThreshold::Reset | ( | ) |
Remove all the intervals currently defined.
|
overrideprotectedvirtual |
This function performs the actual thresholding.
Reimplemented from vtkMultiBlockDataSetAlgorithm.
|
overrideprotectedvirtual |
We accept any mesh that is descended from vtkPointSet.
In the future, it is possible to accept more types but this would require us to generate a new vtkPoints object for each output mesh.
Reimplemented from vtkMultiBlockDataSetAlgorithm.
|
protected |
Recursively update the setStates and unresolvedOutputs vectors based on this->DependentSets.
|
protected |
A utility method called by the public AddInterval members.
|
protected |
Print out a graphviz-formatted text description of all the sets.
|
protecteddelete |
|
protected |
A variable used to store the next index to use when calling SetInputArrayToProcess.
Its value is stored in an interval's ArrayIndex member and used during RequestData to retrieve a pointer to the actual array.
Definition at line 451 of file vtkMultiThreshold.h.
|
protected |
The number of output datasets.
Definition at line 456 of file vtkMultiThreshold.h.
|
protected |
A set of threshold rules sorted by the attribute+norm to which they are applied.
Definition at line 469 of file vtkMultiThreshold.h.
|
protected |
A list of rules keyed by their unique integer ID.
This list is used to quickly determine whether interval membership implies membership in a given output mesh.
Definition at line 476 of file vtkMultiThreshold.h.
|
protected |
A list of boolean sets whose values depend on the given set.
Each time an interval is evaluated for a cell, the list of dependent boolean sets contained here is updated. Any boolean operations whose truth values are decided are then marked and their dependent sets are examined.
Definition at line 484 of file vtkMultiThreshold.h.