VTK  9.3.20240221
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkExtractCells Class Reference

subset a vtkDataSet to create a vtkUnstructuredGrid More...

#include <vtkExtractCells.h>

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

Public Member Functions

void SetCellList (vtkIdList *l)
 Set the list of cell IDs that the output vtkUnstructuredGrid will be composed of. More...
 
void AddCellList (vtkIdList *l)
 Add the supplied list of cell IDs to those that will be included in the output vtkUnstructuredGrid. More...
 
void AddCellRange (vtkIdType from, vtkIdType to)
 Add this range of cell IDs to those that will be included in the output vtkUnstructuredGrid. More...
 
void SetCellIds (const vtkIdType *ptr, vtkIdType numValues)
 Another way to provide ids using a pointer to vtkIdType array. More...
 
void AddCellIds (const vtkIdType *ptr, vtkIdType numValues)
 Another way to provide ids using a pointer to vtkIdType array. More...
 
virtual void SetExtractAllCells (bool)
 If all cells are being extracted, this filter can use fast path to speed up the extraction. More...
 
virtual bool GetExtractAllCells ()
 If all cells are being extracted, this filter can use fast path to speed up the extraction. More...
 
virtual void ExtractAllCellsOn ()
 If all cells are being extracted, this filter can use fast path to speed up the extraction. More...
 
virtual void ExtractAllCellsOff ()
 If all cells are being extracted, this filter can use fast path to speed up the extraction. More...
 
virtual void SetAssumeSortedAndUniqueIds (bool)
 If the cell ids specified are already sorted and unique, then set this to true to avoid the filter from doing time-consuming sorts and uniquification operations. More...
 
virtual bool GetAssumeSortedAndUniqueIds ()
 If the cell ids specified are already sorted and unique, then set this to true to avoid the filter from doing time-consuming sorts and uniquification operations. More...
 
virtual void AssumeSortedAndUniqueIdsOn ()
 If the cell ids specified are already sorted and unique, then set this to true to avoid the filter from doing time-consuming sorts and uniquification operations. More...
 
virtual void AssumeSortedAndUniqueIdsOff ()
 If the cell ids specified are already sorted and unique, then set this to true to avoid the filter from doing time-consuming sorts and uniquification operations. More...
 
virtual void SetPassThroughCellIds (bool)
 If on, the output dataset will have a celldata array that holds the cell index of the original 3D cell that produced each output cell. More...
 
virtual bool GetPassThroughCellIds ()
 If on, the output dataset will have a celldata array that holds the cell index of the original 3D cell that produced each output cell. More...
 
virtual void PassThroughCellIdsOn ()
 If on, the output dataset will have a celldata array that holds the cell index of the original 3D cell that produced each output cell. More...
 
virtual void PassThroughCellIdsOff ()
 If on, the output dataset will have a celldata array that holds the cell index of the original 3D cell that produced each output cell. More...
 
virtual void SetOutputPointsPrecision (int)
 Set/get the desired precision for the output types. More...
 
virtual int GetOutputPointsPrecision ()
 Set/get the desired precision for the output types. More...
 
virtual void SetBatchSize (unsigned int)
 Specify the number of input cells in a batch, where a batch defines a subset of the input cells operated on during threaded execution. More...
 
virtual unsigned int GetBatchSize ()
 Specify the number of input cells in a batch, where a batch defines a subset of the input cells operated on during threaded execution. More...
 
- Public Member Functions inherited from vtkUnstructuredGridAlgorithm
vtkUnstructuredGridAlgorithmNewInstance () const
 
vtkTypeBool ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 see vtkAlgorithm for details More...
 
vtkDataObjectGetInput (int port)
 
vtkDataObjectGetInput ()
 
vtkUnstructuredGridGetUnstructuredGridInput (int port)
 
vtkUnstructuredGridGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkUnstructuredGridGetOutput (int)
 Get the output data object for a port on this algorithm. More...
 
virtual void SetOutput (vtkDataObject *d)
 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...
 
void AddInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void AddInputData (int, vtkDataObject *)
 Assign a data object as input. More...
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
vtkTypeBool 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...
 
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 SetAbortExecuteAndUpdateTime ()
 Set AbortExecute Flag and update LastAbortTime. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
bool CheckAbort ()
 Checks to see if this filter should abort. More...
 
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 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 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...
 
void RemoveNoPriorTemporalAccessInformationKey ()
 Removes any information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS() to all output ports of this vtkAlgorithm. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this algorithm. More...
 
bool UsesGarbageCollector () const 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 SetContainerAlgorithm (vtkAlgorithm *containerAlg)
 Set/get a Container algorithm for this algorithm. More...
 
vtkAlgorithmGetContainerAlgorithm ()
 Set/get a Container algorithm for this algorithm. More...
 
virtual void SetAbortOutput (bool)
 Set/Get an internal variable used to communicate between the algorithm and executive. More...
 
virtual bool GetAbortOutput ()
 Set/Get an internal variable used to communicate between the algorithm and executive. 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 (vtkTypeBool)
 Turn release data flag on or off for all output ports. More...
 
virtual vtkTypeBool 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 vtkProgressObserverGetProgressObserver ()
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
void SetNoPriorTemporalAccessInformationKey (int key)
 Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS(). More...
 
void SetNoPriorTemporalAccessInformationKey ()
 Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS(). 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 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)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output. 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)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (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...
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes. More...
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. 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...
 
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...
 

Protected Member Functions

 vtkExtractCells ()
 
 ~vtkExtractCells () 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...
 
bool Copy (vtkDataSet *input, vtkUnstructuredGrid *output)
 
- 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...
 
virtual int RequestUpdateTime (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
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
 
bool CheckUpstreamAbort ()
 Checks to see if an upstream filter has been aborted. 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 association of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
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...
 
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...
 
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)
 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, 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)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
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)
 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, 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)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (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 ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkSmartPointer< vtkExtractCellsIdList > CellList
 
bool ExtractAllCells = false
 
bool AssumeSortedAndUniqueIds = false
 
bool PassThroughCellIds = true
 
int OutputPointsPrecision = DEFAULT_PRECISION
 
unsigned int BatchSize = 1000
 
- Protected Attributes inherited from vtkAlgorithm
vtkTimeStamp LastAbortCheckTime
 
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
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
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
typedef vtkUnstructuredGridAlgorithm Superclass
 Standard methods for construction, type info, and printing. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 Standard methods for construction, type info, and printing. More...
 
static vtkExtractCellsSafeDownCast (vtkObjectBase *o)
 Standard methods for construction, type info, and printing. More...
 
static vtkExtractCellsNew ()
 Standard methods for construction, type info, and printing. More...
 
virtual vtkTypeBool IsA (const char *type)
 Standard methods for construction, type info, and printing. More...
 
vtkExtractCellsNewInstance () const
 Standard methods for construction, type info, and printing. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard methods for construction, type info, and printing. More...
 
virtual vtkObjectBaseNewInstanceInternal () const
 Standard methods for construction, type info, and printing. More...
 

Additional Inherited Members

- 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
 
- 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 vtkInformationIntegerKeyABORTED ()
 
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 (vtkTypeBool 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 vtkTypeBool 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 vtkObjectBaseNew ()
 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...
 
- Public Attributes inherited from vtkAlgorithm
std::atomic< vtkTypeBoolAbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_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 vtkTimeStamp LastAbortTime
 
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

subset a vtkDataSet to create a vtkUnstructuredGrid

Given a vtkDataSet and a list of cell ids, create a vtkUnstructuredGrid composed of these cells. If the cell list is empty when vtkExtractCells executes, it will set up the ugrid, point and cell arrays, with no points, cells or data.

Warning
This class is templated. It may run slower than serial execution if the code is not optimized during compilation. Build in Release or ReleaseWithDebugInfo.
This class has been threaded with vtkSMPTools. Using TBB or other non-sequential type (set in the CMake variable VTK_SMP_IMPLEMENTATION_TYPE) may improve performance significantly.
Online Examples:

Tests:
vtkExtractCells (Tests)

Definition at line 67 of file vtkExtractCells.h.

Member Typedef Documentation

◆ Superclass

Standard methods for construction, type info, and printing.

Definition at line 74 of file vtkExtractCells.h.

Constructor & Destructor Documentation

◆ vtkExtractCells()

vtkExtractCells::vtkExtractCells ( )
protected

◆ ~vtkExtractCells()

vtkExtractCells::~vtkExtractCells ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

Standard methods for construction, type info, and printing.

◆ IsA()

virtual vtkTypeBool vtkExtractCells::IsA ( const char *  type)
virtual

Standard methods for construction, type info, and printing.

Reimplemented from vtkUnstructuredGridAlgorithm.

◆ SafeDownCast()

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

Standard methods for construction, type info, and printing.

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkExtractCells::NewInstanceInternal ( ) const
protectedvirtual

Standard methods for construction, type info, and printing.

Reimplemented from vtkUnstructuredGridAlgorithm.

◆ NewInstance()

vtkExtractCells* vtkExtractCells::NewInstance ( ) const

Standard methods for construction, type info, and printing.

◆ PrintSelf()

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

Standard methods for construction, type info, and printing.

Reimplemented from vtkUnstructuredGridAlgorithm.

◆ New()

static vtkExtractCells* vtkExtractCells::New ( )
static

Standard methods for construction, type info, and printing.

◆ SetCellList()

void vtkExtractCells::SetCellList ( vtkIdList l)

Set the list of cell IDs that the output vtkUnstructuredGrid will be composed of.

Replaces any other cell ID list supplied so far. (Set to nullptr to free memory used by cell list.) The cell ids should be >=0.

◆ AddCellList()

void vtkExtractCells::AddCellList ( vtkIdList l)

Add the supplied list of cell IDs to those that will be included in the output vtkUnstructuredGrid.

The cell ids should be >=0.

◆ AddCellRange()

void vtkExtractCells::AddCellRange ( vtkIdType  from,
vtkIdType  to 
)

Add this range of cell IDs to those that will be included in the output vtkUnstructuredGrid.

Note that (from < to), and (from >= 0).

◆ SetCellIds()

void vtkExtractCells::SetCellIds ( const vtkIdType ptr,
vtkIdType  numValues 
)

Another way to provide ids using a pointer to vtkIdType array.

◆ AddCellIds()

void vtkExtractCells::AddCellIds ( const vtkIdType ptr,
vtkIdType  numValues 
)

Another way to provide ids using a pointer to vtkIdType array.

◆ SetExtractAllCells()

virtual void vtkExtractCells::SetExtractAllCells ( bool  )
virtual

If all cells are being extracted, this filter can use fast path to speed up the extraction.

In that case, one can set this flag to true. When set to true, cell ids added via the various methods are simply ignored. Defaults to false.

◆ GetExtractAllCells()

virtual bool vtkExtractCells::GetExtractAllCells ( )
virtual

If all cells are being extracted, this filter can use fast path to speed up the extraction.

In that case, one can set this flag to true. When set to true, cell ids added via the various methods are simply ignored. Defaults to false.

◆ ExtractAllCellsOn()

virtual void vtkExtractCells::ExtractAllCellsOn ( )
virtual

If all cells are being extracted, this filter can use fast path to speed up the extraction.

In that case, one can set this flag to true. When set to true, cell ids added via the various methods are simply ignored. Defaults to false.

◆ ExtractAllCellsOff()

virtual void vtkExtractCells::ExtractAllCellsOff ( )
virtual

If all cells are being extracted, this filter can use fast path to speed up the extraction.

In that case, one can set this flag to true. When set to true, cell ids added via the various methods are simply ignored. Defaults to false.

◆ SetAssumeSortedAndUniqueIds()

virtual void vtkExtractCells::SetAssumeSortedAndUniqueIds ( bool  )
virtual

If the cell ids specified are already sorted and unique, then set this to true to avoid the filter from doing time-consuming sorts and uniquification operations.

Defaults to false.

◆ GetAssumeSortedAndUniqueIds()

virtual bool vtkExtractCells::GetAssumeSortedAndUniqueIds ( )
virtual

If the cell ids specified are already sorted and unique, then set this to true to avoid the filter from doing time-consuming sorts and uniquification operations.

Defaults to false.

◆ AssumeSortedAndUniqueIdsOn()

virtual void vtkExtractCells::AssumeSortedAndUniqueIdsOn ( )
virtual

If the cell ids specified are already sorted and unique, then set this to true to avoid the filter from doing time-consuming sorts and uniquification operations.

Defaults to false.

◆ AssumeSortedAndUniqueIdsOff()

virtual void vtkExtractCells::AssumeSortedAndUniqueIdsOff ( )
virtual

If the cell ids specified are already sorted and unique, then set this to true to avoid the filter from doing time-consuming sorts and uniquification operations.

Defaults to false.

◆ SetPassThroughCellIds()

virtual void vtkExtractCells::SetPassThroughCellIds ( bool  )
virtual

If on, the output dataset will have a celldata array that holds the cell index of the original 3D cell that produced each output cell.

The default is on

◆ GetPassThroughCellIds()

virtual bool vtkExtractCells::GetPassThroughCellIds ( )
virtual

If on, the output dataset will have a celldata array that holds the cell index of the original 3D cell that produced each output cell.

The default is on

◆ PassThroughCellIdsOn()

virtual void vtkExtractCells::PassThroughCellIdsOn ( )
virtual

If on, the output dataset will have a celldata array that holds the cell index of the original 3D cell that produced each output cell.

The default is on

◆ PassThroughCellIdsOff()

virtual void vtkExtractCells::PassThroughCellIdsOff ( )
virtual

If on, the output dataset will have a celldata array that holds the cell index of the original 3D cell that produced each output cell.

The default is on

◆ SetOutputPointsPrecision()

virtual void vtkExtractCells::SetOutputPointsPrecision ( int  )
virtual

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()

virtual int vtkExtractCells::GetOutputPointsPrecision ( )
virtual

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.

◆ SetBatchSize()

virtual void vtkExtractCells::SetBatchSize ( unsigned int  )
virtual

Specify the number of input cells in a batch, where a batch defines a subset of the input cells operated on during threaded execution.

Generally this is only used for debugging or performance studies (since batch size affects the thread workload).

Default is 1000.

◆ GetBatchSize()

virtual unsigned int vtkExtractCells::GetBatchSize ( )
virtual

Specify the number of input cells in a batch, where a batch defines a subset of the input cells operated on during threaded execution.

Generally this is only used for debugging or performance studies (since batch size affects the thread workload).

Default is 1000.

◆ RequestData()

int vtkExtractCells::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 vtkExtractCells::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.

◆ Copy()

bool vtkExtractCells::Copy ( vtkDataSet input,
vtkUnstructuredGrid output 
)
protected

Member Data Documentation

◆ CellList

vtkSmartPointer<vtkExtractCellsIdList> vtkExtractCells::CellList
protected

Definition at line 170 of file vtkExtractCells.h.

◆ ExtractAllCells

bool vtkExtractCells::ExtractAllCells = false
protected

Definition at line 171 of file vtkExtractCells.h.

◆ AssumeSortedAndUniqueIds

bool vtkExtractCells::AssumeSortedAndUniqueIds = false
protected

Definition at line 172 of file vtkExtractCells.h.

◆ PassThroughCellIds

bool vtkExtractCells::PassThroughCellIds = true
protected

Definition at line 173 of file vtkExtractCells.h.

◆ OutputPointsPrecision

int vtkExtractCells::OutputPointsPrecision = DEFAULT_PRECISION
protected

Definition at line 174 of file vtkExtractCells.h.

◆ BatchSize

unsigned int vtkExtractCells::BatchSize = 1000
protected

Definition at line 175 of file vtkExtractCells.h.


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