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

generate isosurfaces/isolines from scalar values More...

#include <vtkContourFilter.h>

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

Public Types

typedef vtkPolyDataAlgorithm Superclass
 
- Public Types inherited from vtkPolyDataAlgorithm
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 int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkContourFilterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
vtkMTimeType GetMTime () override
 Modified GetMTime Because we delegate to vtkContourValues. More...
 
void CreateDefaultLocator ()
 Create default locator. More...
 
void SetValue (int i, double value)
 Methods to set / get contour values. More...
 
double GetValue (int i)
 Get the ith contour value. More...
 
doubleGetValues ()
 Get a pointer to an array of contour values. More...
 
void GetValues (double *contourValues)
 Fill a supplied list with contour values. More...
 
void SetNumberOfContours (int number)
 Set the number of contours to place into the list. More...
 
int GetNumberOfContours ()
 Get the number of contours in the list of contour values. More...
 
void GenerateValues (int numContours, double range[2])
 Generate numContours equally spaced contour values between specified range. More...
 
void GenerateValues (int numContours, double rangeStart, double rangeEnd)
 Generate numContours equally spaced contour values between specified range. More...
 
virtual void SetComputeNormals (int)
 Set/Get the computation of normals. More...
 
virtual int GetComputeNormals ()
 Set/Get the computation of normals. More...
 
virtual void ComputeNormalsOn ()
 Set/Get the computation of normals. More...
 
virtual void ComputeNormalsOff ()
 Set/Get the computation of normals. More...
 
virtual void SetComputeGradients (int)
 Set/Get the computation of gradients. More...
 
virtual int GetComputeGradients ()
 Set/Get the computation of gradients. More...
 
virtual void ComputeGradientsOn ()
 Set/Get the computation of gradients. More...
 
virtual void ComputeGradientsOff ()
 Set/Get the computation of gradients. More...
 
virtual void SetComputeScalars (int)
 Set/Get the computation of scalars. More...
 
virtual int GetComputeScalars ()
 Set/Get the computation of scalars. More...
 
virtual void ComputeScalarsOn ()
 Set/Get the computation of scalars. More...
 
virtual void ComputeScalarsOff ()
 Set/Get the computation of scalars. More...
 
virtual void SetUseScalarTree (int)
 Enable the use of a scalar tree to accelerate contour extraction. More...
 
virtual int GetUseScalarTree ()
 Enable the use of a scalar tree to accelerate contour extraction. More...
 
virtual void UseScalarTreeOn ()
 Enable the use of a scalar tree to accelerate contour extraction. More...
 
virtual void UseScalarTreeOff ()
 Enable the use of a scalar tree to accelerate contour extraction. More...
 
virtual void SetScalarTree (vtkScalarTree *)
 Enable the use of a scalar tree to accelerate contour extraction. More...
 
virtual vtkScalarTreeGetScalarTree ()
 Enable the use of a scalar tree to accelerate contour extraction. More...
 
void SetLocator (vtkIncrementalPointLocator *locator)
 Set / get a spatial locator for merging points. More...
 
virtual vtkIncrementalPointLocatorGetLocator ()
 Set / get a spatial locator for merging points. More...
 
void SetArrayComponent (int)
 Set/get which component of the scalar array to contour on; defaults to 0. More...
 
int GetArrayComponent ()
 Set/get which component of the scalar array to contour on; defaults to 0. More...
 
virtual void SetGenerateTriangles (int)
 If this is enabled (by default), the output will be triangles otherwise, the output will be the intersection polygon WARNING: if the contour surface is not planar, the output polygon will not be planar, which might be nice to look at but hard to compute with downstream. More...
 
virtual int GetGenerateTriangles ()
 If this is enabled (by default), the output will be triangles otherwise, the output will be the intersection polygon WARNING: if the contour surface is not planar, the output polygon will not be planar, which might be nice to look at but hard to compute with downstream. More...
 
virtual void GenerateTrianglesOn ()
 If this is enabled (by default), the output will be triangles otherwise, the output will be the intersection polygon WARNING: if the contour surface is not planar, the output polygon will not be planar, which might be nice to look at but hard to compute with downstream. More...
 
virtual void GenerateTrianglesOff ()
 If this is enabled (by default), the output will be triangles otherwise, the output will be the intersection polygon WARNING: if the contour surface is not planar, the output polygon will not be planar, which might be nice to look at but hard to compute with downstream. More...
 
void SetOutputPointsPrecision (int precision)
 Set/get the desired precision for the output types. More...
 
int GetOutputPointsPrecision () const
 Set/get the desired precision for the output types. More...
 
- Public Member Functions inherited from vtkPolyDataAlgorithm
vtkPolyDataAlgorithmNewInstance () const
 
int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 see vtkAlgorithm for details More...
 
vtkDataObjectGetInput ()
 
vtkDataObjectGetInput (int port)
 
vtkPolyDataGetPolyDataInput (int port)
 
vtkPolyDataGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkPolyDataGetOutput (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
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
int 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 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...
 
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 int 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 int 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 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...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
virtual void SetAbortExecute (int)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual int 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 void SetProgress (double)
 Set/Get the execution progress of a process object. More...
 
virtual double GetProgress ()
 Set/Get the execution progress of a process object. 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...
 
intGetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
intGetUpdateExtent (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...
 
- 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...
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int 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...
 
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...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int 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 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...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. 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 int IsTypeOf (const char *type)
 
static vtkContourFilterSafeDownCast (vtkObjectBase *o)
 
static vtkContourFilterNew ()
 Construct object with initial range (0,1) and single contour value of 0.0. More...
 
- Static Public Member Functions inherited from vtkPolyDataAlgorithm
static vtkPolyDataAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPolyDataAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements. More...
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkContourFilter ()
 
 ~vtkContourFilter () override
 
void ReportReferences (vtkGarbageCollector *) override
 
int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 This is called by the superclass. More...
 
int RequestUpdateExtent (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...
 
- Protected Member Functions inherited from vtkPolyDataAlgorithm
 vtkPolyDataAlgorithm ()
 
 ~vtkPolyDataAlgorithm () override
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm. More...
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive. More...
 
virtual void 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 ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Static Protected Member Functions

static void InternalProgressCallbackFunction (vtkObject *caller, unsigned long eid, void *clientData, void *callData)
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 

Protected Attributes

vtkContourValuesContourValues
 
int ComputeNormals
 
int ComputeGradients
 
int ComputeScalars
 
vtkIncrementalPointLocatorLocator
 
int UseScalarTree
 
vtkScalarTreeScalarTree
 
int OutputPointsPrecision
 
int GenerateTriangles
 
vtkSynchronizedTemplates2DSynchronizedTemplates2D
 
vtkSynchronizedTemplates3DSynchronizedTemplates3D
 
vtkGridSynchronizedTemplates3DGridSynchronizedTemplates
 
vtkRectilinearSynchronizedTemplatesRectilinearSynchronizedTemplates
 
vtkCallbackCommandInternalProgressCallbackCommand
 
- Protected Attributes inherited from vtkAlgorithm
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
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

generate isosurfaces/isolines from scalar values

vtkContourFilter is a filter that takes as input any dataset and generates on output isosurfaces and/or isolines. The exact form of the output depends upon the dimensionality of the input data. Data consisting of 3D cells will generate isosurfaces, data consisting of 2D cells will generate isolines, and data with 1D or 0D cells will generate isopoints. Combinations of output type are possible if the input dimension is mixed.

To use this filter you must specify one or more contour values. You can either use the method SetValue() to specify each contour value, or use GenerateValues() to generate a series of evenly spaced contours. It is also possible to accelerate the operation of this filter (at the cost of extra memory) by using a vtkScalarTree. A scalar tree is used to quickly locate cells that contain a contour surface. This is especially effective if multiple contours are being extracted. If you want to use a scalar tree, invoke the method UseScalarTreeOn().

Warning
For unstructured data or structured grids, normals and gradients are not computed. Use vtkPolyDataNormals to compute the surface normals.
See also
vtkMarchingContourFilter vtkMarchingCubes vtkSliceCubes vtkMarchingSquares vtkImageMarchingCubes
Examples:
vtkContourFilter (Examples)
Tests:
vtkContourFilter (Tests)

Definition at line 69 of file vtkContourFilter.h.

Member Typedef Documentation

Definition at line 72 of file vtkContourFilter.h.

Constructor & Destructor Documentation

vtkContourFilter::vtkContourFilter ( )
protected
vtkContourFilter::~vtkContourFilter ( )
overrideprotected

Member Function Documentation

static int vtkContourFilter::IsTypeOf ( const char *  type)
static
virtual int vtkContourFilter::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented in vtkmContour.

static vtkContourFilter* vtkContourFilter::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkContourFilter::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented in vtkmContour.

vtkContourFilter* vtkContourFilter::NewInstance ( ) const
void vtkContourFilter::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkPolyDataAlgorithm.

static vtkContourFilter* vtkContourFilter::New ( )
static

Construct object with initial range (0,1) and single contour value of 0.0.

void vtkContourFilter::SetValue ( int  i,
double  value 
)
inline

Methods to set / get contour values.

Set a particular contour value at contour number i.

The index i ranges between 0<=i<NumberOfContours.

Definition at line 248 of file vtkContourFilter.h.

double vtkContourFilter::GetValue ( int  i)
inline

Get the ith contour value.

Definition at line 254 of file vtkContourFilter.h.

double * vtkContourFilter::GetValues ( )
inline

Get a pointer to an array of contour values.

There will be GetNumberOfContours() values in the list.

Definition at line 261 of file vtkContourFilter.h.

void vtkContourFilter::GetValues ( double contourValues)
inline

Fill a supplied list with contour values.

There will be GetNumberOfContours() values in the list. Make sure you allocate enough memory to hold the list.

Definition at line 269 of file vtkContourFilter.h.

void vtkContourFilter::SetNumberOfContours ( int  number)
inline

Set the number of contours to place into the list.

You only really need to use this method to reduce list size. The method SetValue() will automatically increase list size as needed.

Definition at line 277 of file vtkContourFilter.h.

int vtkContourFilter::GetNumberOfContours ( )
inline

Get the number of contours in the list of contour values.

Definition at line 283 of file vtkContourFilter.h.

void vtkContourFilter::GenerateValues ( int  numContours,
double  range[2] 
)
inline

Generate numContours equally spaced contour values between specified range.

Contour values will include min/max range values.

Definition at line 290 of file vtkContourFilter.h.

void vtkContourFilter::GenerateValues ( int  numContours,
double  rangeStart,
double  rangeEnd 
)
inline

Generate numContours equally spaced contour values between specified range.

Contour values will include min/max range values.

Definition at line 297 of file vtkContourFilter.h.

vtkMTimeType vtkContourFilter::GetMTime ( )
overridevirtual

Modified GetMTime Because we delegate to vtkContourValues.

Reimplemented from vtkObject.

virtual void vtkContourFilter::SetComputeNormals ( int  )
virtual

Set/Get the computation of normals.

Normal computation is fairly expensive in both time and storage. If the output data will be processed by filters that modify topology or geometry, it may be wise to turn Normals and Gradients off. This setting defaults to On for vtkImageData, vtkRectilinearGrid, vtkStructuredGrid, and vtkUnstructuredGrid inputs, and Off for all others. This default behavior is to preserve the behavior of an older version of this filter, which would ignore this setting for certain inputs.

virtual int vtkContourFilter::GetComputeNormals ( )
virtual

Set/Get the computation of normals.

Normal computation is fairly expensive in both time and storage. If the output data will be processed by filters that modify topology or geometry, it may be wise to turn Normals and Gradients off. This setting defaults to On for vtkImageData, vtkRectilinearGrid, vtkStructuredGrid, and vtkUnstructuredGrid inputs, and Off for all others. This default behavior is to preserve the behavior of an older version of this filter, which would ignore this setting for certain inputs.

virtual void vtkContourFilter::ComputeNormalsOn ( )
virtual

Set/Get the computation of normals.

Normal computation is fairly expensive in both time and storage. If the output data will be processed by filters that modify topology or geometry, it may be wise to turn Normals and Gradients off. This setting defaults to On for vtkImageData, vtkRectilinearGrid, vtkStructuredGrid, and vtkUnstructuredGrid inputs, and Off for all others. This default behavior is to preserve the behavior of an older version of this filter, which would ignore this setting for certain inputs.

virtual void vtkContourFilter::ComputeNormalsOff ( )
virtual

Set/Get the computation of normals.

Normal computation is fairly expensive in both time and storage. If the output data will be processed by filters that modify topology or geometry, it may be wise to turn Normals and Gradients off. This setting defaults to On for vtkImageData, vtkRectilinearGrid, vtkStructuredGrid, and vtkUnstructuredGrid inputs, and Off for all others. This default behavior is to preserve the behavior of an older version of this filter, which would ignore this setting for certain inputs.

virtual void vtkContourFilter::SetComputeGradients ( int  )
virtual

Set/Get the computation of gradients.

Gradient computation is fairly expensive in both time and storage. Note that if ComputeNormals is on, gradients will have to be calculated, but will not be stored in the output dataset. If the output data will be processed by filters that modify topology or geometry, it may be wise to turn Normals and Gradients off.

virtual int vtkContourFilter::GetComputeGradients ( )
virtual

Set/Get the computation of gradients.

Gradient computation is fairly expensive in both time and storage. Note that if ComputeNormals is on, gradients will have to be calculated, but will not be stored in the output dataset. If the output data will be processed by filters that modify topology or geometry, it may be wise to turn Normals and Gradients off.

virtual void vtkContourFilter::ComputeGradientsOn ( )
virtual

Set/Get the computation of gradients.

Gradient computation is fairly expensive in both time and storage. Note that if ComputeNormals is on, gradients will have to be calculated, but will not be stored in the output dataset. If the output data will be processed by filters that modify topology or geometry, it may be wise to turn Normals and Gradients off.

virtual void vtkContourFilter::ComputeGradientsOff ( )
virtual

Set/Get the computation of gradients.

Gradient computation is fairly expensive in both time and storage. Note that if ComputeNormals is on, gradients will have to be calculated, but will not be stored in the output dataset. If the output data will be processed by filters that modify topology or geometry, it may be wise to turn Normals and Gradients off.

virtual void vtkContourFilter::SetComputeScalars ( int  )
virtual

Set/Get the computation of scalars.

virtual int vtkContourFilter::GetComputeScalars ( )
virtual

Set/Get the computation of scalars.

virtual void vtkContourFilter::ComputeScalarsOn ( )
virtual

Set/Get the computation of scalars.

virtual void vtkContourFilter::ComputeScalarsOff ( )
virtual

Set/Get the computation of scalars.

virtual void vtkContourFilter::SetUseScalarTree ( int  )
virtual

Enable the use of a scalar tree to accelerate contour extraction.

virtual int vtkContourFilter::GetUseScalarTree ( )
virtual

Enable the use of a scalar tree to accelerate contour extraction.

virtual void vtkContourFilter::UseScalarTreeOn ( )
virtual

Enable the use of a scalar tree to accelerate contour extraction.

virtual void vtkContourFilter::UseScalarTreeOff ( )
virtual

Enable the use of a scalar tree to accelerate contour extraction.

virtual void vtkContourFilter::SetScalarTree ( vtkScalarTree )
virtual

Enable the use of a scalar tree to accelerate contour extraction.

virtual vtkScalarTree* vtkContourFilter::GetScalarTree ( )
virtual

Enable the use of a scalar tree to accelerate contour extraction.

void vtkContourFilter::SetLocator ( vtkIncrementalPointLocator locator)

Set / get a spatial locator for merging points.

By default, an instance of vtkMergePoints is used.

virtual vtkIncrementalPointLocator* vtkContourFilter::GetLocator ( )
virtual

Set / get a spatial locator for merging points.

By default, an instance of vtkMergePoints is used.

void vtkContourFilter::CreateDefaultLocator ( )

Create default locator.

Used to create one when none is specified. The locator is used to merge coincident points.

void vtkContourFilter::SetArrayComponent ( int  )

Set/get which component of the scalar array to contour on; defaults to 0.

Currently this feature only works if the input is a vtkImageData.

int vtkContourFilter::GetArrayComponent ( )

Set/get which component of the scalar array to contour on; defaults to 0.

Currently this feature only works if the input is a vtkImageData.

virtual void vtkContourFilter::SetGenerateTriangles ( int  )
virtual

If this is enabled (by default), the output will be triangles otherwise, the output will be the intersection polygon WARNING: if the contour surface is not planar, the output polygon will not be planar, which might be nice to look at but hard to compute with downstream.

virtual int vtkContourFilter::GetGenerateTriangles ( )
virtual

If this is enabled (by default), the output will be triangles otherwise, the output will be the intersection polygon WARNING: if the contour surface is not planar, the output polygon will not be planar, which might be nice to look at but hard to compute with downstream.

virtual void vtkContourFilter::GenerateTrianglesOn ( )
virtual

If this is enabled (by default), the output will be triangles otherwise, the output will be the intersection polygon WARNING: if the contour surface is not planar, the output polygon will not be planar, which might be nice to look at but hard to compute with downstream.

virtual void vtkContourFilter::GenerateTrianglesOff ( )
virtual

If this is enabled (by default), the output will be triangles otherwise, the output will be the intersection polygon WARNING: if the contour surface is not planar, the output polygon will not be planar, which might be nice to look at but hard to compute with downstream.

void vtkContourFilter::SetOutputPointsPrecision ( int  precision)

Set/get the desired precision for the output types.

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

int vtkContourFilter::GetOutputPointsPrecision ( ) const

Set/get the desired precision for the output types.

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

void vtkContourFilter::ReportReferences ( vtkGarbageCollector )
overrideprotectedvirtual

Reimplemented from vtkAlgorithm.

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

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.

int vtkContourFilter::RequestUpdateExtent ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.

int vtkContourFilter::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 vtkPolyDataAlgorithm.

static void vtkContourFilter::InternalProgressCallbackFunction ( vtkObject caller,
unsigned long  eid,
void *  clientData,
void *  callData 
)
staticprotected

Member Data Documentation

vtkContourValues* vtkContourFilter::ContourValues
protected

Definition at line 218 of file vtkContourFilter.h.

int vtkContourFilter::ComputeNormals
protected

Definition at line 219 of file vtkContourFilter.h.

int vtkContourFilter::ComputeGradients
protected

Definition at line 220 of file vtkContourFilter.h.

int vtkContourFilter::ComputeScalars
protected

Definition at line 221 of file vtkContourFilter.h.

vtkIncrementalPointLocator* vtkContourFilter::Locator
protected

Definition at line 222 of file vtkContourFilter.h.

int vtkContourFilter::UseScalarTree
protected

Definition at line 223 of file vtkContourFilter.h.

vtkScalarTree* vtkContourFilter::ScalarTree
protected

Definition at line 224 of file vtkContourFilter.h.

int vtkContourFilter::OutputPointsPrecision
protected

Definition at line 225 of file vtkContourFilter.h.

int vtkContourFilter::GenerateTriangles
protected

Definition at line 226 of file vtkContourFilter.h.

vtkSynchronizedTemplates2D* vtkContourFilter::SynchronizedTemplates2D
protected

Definition at line 228 of file vtkContourFilter.h.

vtkSynchronizedTemplates3D* vtkContourFilter::SynchronizedTemplates3D
protected

Definition at line 229 of file vtkContourFilter.h.

vtkGridSynchronizedTemplates3D* vtkContourFilter::GridSynchronizedTemplates
protected

Definition at line 230 of file vtkContourFilter.h.

vtkRectilinearSynchronizedTemplates* vtkContourFilter::RectilinearSynchronizedTemplates
protected

Definition at line 231 of file vtkContourFilter.h.

vtkCallbackCommand* vtkContourFilter::InternalProgressCallbackCommand
protected

Definition at line 232 of file vtkContourFilter.h.


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